Tool Calling
Connect LLMs to external data and systems.
npm i @xsai/toolExamples
tool
accepts a StandardSchemaV1, automatically infers the type.
For convenience, we use valibot as an example.
But this package uses xsschema internally, so it supports any schema library that xsschema supports: e.g. zod, valibot, arktype, etc.
See xsschema for more information.
These below examples require you to install a standard schema to json schema parser (a separate package). As they are not provided by zod or valibot natively.
Read more about them here
import { generateText } from '@xsai/generate-text'
import { tool } from '@xsai/tool'
import { env } from 'node:process'
import * as v from 'valibot'
const weather = await tool({
description: 'Get the weather in a location',
execute: ({ location }) => JSON.stringify({
location,
temperature: 42,
}),
name: 'weather',
parameters: v.object({
location: v.pipe(
v.string(),
v.description('The location to get the weather for'),
),
}),
})
const { text } = await generateText({
apiKey: env.OPENAI_API_KEY!,
baseURL: 'https://api.openai.com/v1/',
maxSteps: 2,
messages: [
{
content: 'You are a helpful assistant.',
role: 'system',
},
{
content: 'What is the weather in San Francisco?',
role: 'user',
},
],
model: 'gpt-4o',
tools: [weather],
})rawTool
accepts a JsonSchema, execute params type to be defined manually.
import { generateText } from '@xsai/generate-text'
import { rawTool } from '@xsai/tool'
import { env } from 'node:process'
const weather = rawTool<{ location: string }>({
description: 'Get the weather in a location',
execute: ({ location }) => JSON.stringify({
location,
temperature: 42,
}),
name: 'weather',
parameters: {
additionalProperties: false,
properties: {
location: {
description: 'The location to get the weather for',
type: 'string',
},
},
required: [
'location',
],
type: 'object',
},
})
const { text } = await generateText({
apiKey: env.OPENAI_API_KEY!,
baseURL: 'https://api.openai.com/v1/',
maxSteps: 2,
messages: [
{
content: 'You are a helpful assistant.',
role: 'system',
},
{
content: 'What is the weather in San Francisco?',
role: 'user',
},
],
model: 'gpt-4o',
tools: [weather],
})Object
You can also pass an object directly without installing @xsai/tool.
import type { Tool } from '@xsai/shared-chat'
import { generateText } from '@xsai/generate-text'
import { env } from 'node:process'
const weather = {
execute: (({ location }) => JSON.stringify({
location,
temperature: 42,
})) as Tool['execute'],
function: {
description: 'Get the weather in a location',
name: 'weather',
parameters: {
additionalProperties: false,
properties: {
location: {
description: 'The location to get the weather for',
type: 'string',
},
},
required: [
'location',
],
type: 'object',
},
strict: true,
},
type: 'function',
} satisfies Tool
const { text } = await generateText({
apiKey: env.OPENAI_API_KEY!,
baseURL: 'https://api.openai.com/v1/',
maxSteps: 2,
messages: [
{
content: 'You are a helpful assistant.',
role: 'system',
},
{
content: 'What is the weather in San Francisco?',
role: 'user',
},
],
model: 'gpt-4o',
tools: [weather],
})Edit on GitHub
Last updated on