• Preparing search index...
  • The search index is not available
LangChain.js
  • LangChain.js
  • @langchain/core
  • utils/function_calling
  • convertToOpenAIFunction

Function convertToOpenAIFunction

  • convertToOpenAIFunction(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, the output will be converted into a JSON schema, which is then used as the parameters for the OpenAI tool.

    Parameters

    • tool: StructuredToolParams | StructuredToolInterface<ToolSchemaBase, any, any> | RunnableToolLike<InteropZodType, unknown>

      The tool to convert to an OpenAI function.

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

    Returns FunctionDefinition

    The inputted tool in OpenAI function format.

    • Defined in langchain-core/src/utils/function_calling.ts:28

Settings

Member Visibility
LangChain.js
  • Loading...

Generated using TypeDoc