Function formatToOpenAIFunction

  • formatToOpenAIFunction(tool, fields?): FunctionDefinition

  • Formats a StructuredTool or RunnableToolLike instance into a format that is compatible with OpenAI function 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 function.

    Parameters

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

      The tool to convert to an OpenAI function.

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

    Returns FunctionDefinition

    The inputted tool in OpenAI function format.

Settings

Member Visibility