Function formatToOpenAITool

  • formatToOpenAITool(tool, fields?): ToolDefinition

  • Formats a StructuredTool or RunnableToolLike instance into a format that is compatible with OpenAI tool calling. If StructuredTool or RunnableToolLike has a zod schema, it uses the zodToJsonSchema function to convert the schema of the StructuredTool or RunnableToolLike into a JSON schema, which is then used as the parameters for the OpenAI tool.

    Parameters

    • tool: Record<string, any> | StructuredToolInterface<ToolInputSchemaBase, any, any> | RunnableToolLike<ZodType<any, ZodTypeDef, any>, unknown>

      The tool to convert to an OpenAI tool.

    • Optionalfields: number | {
          strict?: boolean;
      }

    Returns ToolDefinition

    The inputted tool in OpenAI tool format.

Settings

Member Visibility