Skip to content

feat: readme ai sdk #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattzcarey merged 1 commit into from
Mar 4, 2025
Merged

feat: readme ai sdk #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 32 additions & 56 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,82 +86,58 @@ import { StackOneToolSet } from "@stackone/ai";
import * as path from "path";

// Initialize with API key and account ID
const toolset = new StackOneToolSet(
process.env.STACKONE_API_KEY,
process.env.STACKONE_ACCOUNT_ID
);
const toolset = new StackOneToolSet();
const tools = toolset.getTools("documents_*");
const uploadTool = tools.getTool("documents_upload_file");

// Upload a file using the file_path parameter
const result = await uploadTool.execute({
file_path: path.join(__dirname, "document.pdf"), // Path to the file
file_path: "/path/to/document.pdf", // Path to the file
});

The name, file format, and content of the file are automatically extracted from the path.
```

### Using with OpenAI or AI SDK
## Integrations

When using file upload tools with OpenAI or AI SDK, the parameters are automatically simplified to a single `file_path` parameter:
### OpenAI

```typescript
import { OpenAI } from "openai";
import { StackOneToolSet } from "@stackone/ai";
import OpenAI from "openai";

// Initialize with API key and account ID
const toolset = new StackOneToolSet(
process.env.STACKONE_API_KEY,
process.env.STACKONE_ACCOUNT_ID
);
const tools = toolset.getTools("documents_*");
const openai = new OpenAI();
const toolset = new StackOneToolSet();

// Convert to OpenAI functions
const openAITools = tools.toOpenAI();

// The file upload tool will have a simplified schema with just a file_path parameter
// {
// "type": "function",
// "function": {
// "name": "documents_upload_file",
// "description": "Upload a document file",
// "parameters": {
// "type": "object",
// "properties": {
// "file_path": {
// "type": "string",
// "description": "Path to the file to upload. The filename will be extracted from the path."
// }
// },
// "required": ["file_path"]
// }
// }
// }

// Use with OpenAI
const openai = new OpenAI({
apiKey: process.env.OPENAI_API_KEY,
});
const tools = toolset.getTools("hris_*");
const tool = tools.getTool("hris_list_employees");

const response = await openai.chat.completions.create({
const result = await completionTool.execute({
model: "gpt-4o-mini",
messages: [
{ role: "system", content: "You are a helpful assistant." },
{ role: "user", content: "Upload this document: /path/to/document.pdf" },
],
tools: openAITools,
prompt: "What are the names of the employees?",
tools: [tool.toOpenAI()],
});

// When OpenAI calls the tool with the file_path parameter
// The SDK automatically handles:
// 1. Extracting the filename from the path
// 2. Determining the file format from the extension
// 3. Reading and encoding the file
// 4. Sending it to the API with the correct parameters
```

## Integrations
### AI SDK by Vercel

### OpenAI
```typescript
import { openai } from "@ai-sdk/openai";
import { generateText } from "ai";
import { StackOneToolSet } from "@stackone/ai";

```
// Initialize StackOne
const toolset = new StackOneToolSet();
const tools = toolset.getTools("hris_*", "your-account-id");

// Convert to AI SDK tools
const aiSdkTools = tools.toAISDKTools();

// Use with AI SDK
const { text } = await generateText({
model: openai("gpt-4o-mini"),
tools: aiSdkTools,
prompt: "Get employee details for John Doe",
maxSteps: 3, // Automatically calls tools when needed
});
```