API 参考
工具调用相关的 API 参考文档。
tool() 参数
namerequiredstring
descriptionrequiredstring
schemarequiredz.ZodObject
executerequired(args: z.infer<T>) => ToolResult | Promise<ToolResult>
strictboolean
falsestrict 值——不允许混用。也可以使用 createModel({ strict: true }) 全局启用严格模式。SDK 会自动切换到 Beta 端点并向 API 传递 strict: true。服务端会校验 JSON Schema，确保模型严格遵循定义的参数结构。 requiredboolean
falsetimeoutnumber
60000retriesnumber
0compactboolean | ToolCompactConfig
undefinedtrue 时，超过阈值的工具结果会通过 LLM 压缩以节省上下文窗口空间。传入对象 { threshold?: number, model?: Model } 可自定义设置。 Tool 类型
ToolReturnType<typeof tool>
tool() 函数的返回类型。包含原始配置属性和经过处理的 parameters（JSON Schema）与 execute（包装后的执行函数）。 StrictToolStrictTool
strict: true 的工具。此工具定义的所有属性必须设置 strict: true。 NonStrictToolNonStrictTool
strict: false 或未定义的工具。未启用严格模式时的默认工具类型。 ConsistentToolsStrictTool[] | NonStrictTool[]
generateText 和智能体方法使用的联合类型。确保数组中的所有工具具有一致的严格模式设置——要么全部严格，要么全部非严格。 工具结果类型
ToolSuccess{ success: true, data: T }
data 字段包含 execute 函数的返回值。 ToolFailure{ success: false, error: string }
error 字段包含错误描述信息。 ToolChoice 类型
autostring
nonestring
requiredstring
{ type: 'function', function: { name: string } }object
required: true 时自动使用此模式。