@langchain/openai 1.1.1 → 1.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (107) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/dist/azure/chat_models/common.cjs +4 -9
  3. package/dist/azure/chat_models/common.cjs.map +1 -1
  4. package/dist/azure/chat_models/common.d.ts +1 -0
  5. package/dist/azure/chat_models/common.js +6 -11
  6. package/dist/azure/chat_models/common.js.map +1 -1
  7. package/dist/azure/embeddings.cjs +4 -7
  8. package/dist/azure/embeddings.cjs.map +1 -1
  9. package/dist/azure/embeddings.js +5 -8
  10. package/dist/azure/embeddings.js.map +1 -1
  11. package/dist/azure/llms.cjs +4 -7
  12. package/dist/azure/llms.cjs.map +1 -1
  13. package/dist/azure/llms.js +5 -8
  14. package/dist/azure/llms.js.map +1 -1
  15. package/dist/chat_models/base.cjs +2 -1
  16. package/dist/chat_models/base.cjs.map +1 -1
  17. package/dist/chat_models/base.d.cts +2 -2
  18. package/dist/chat_models/base.d.ts +2 -2
  19. package/dist/chat_models/base.js +3 -2
  20. package/dist/chat_models/base.js.map +1 -1
  21. package/dist/converters/index.d.ts +2 -0
  22. package/dist/embeddings.cjs +2 -0
  23. package/dist/embeddings.cjs.map +1 -1
  24. package/dist/embeddings.d.cts +4 -2
  25. package/dist/embeddings.d.ts +4 -2
  26. package/dist/embeddings.js +3 -1
  27. package/dist/embeddings.js.map +1 -1
  28. package/dist/index.cjs +2 -0
  29. package/dist/index.d.cts +3 -3
  30. package/dist/index.d.ts +5 -3
  31. package/dist/index.js +2 -2
  32. package/dist/langchain-core/dist/documents/transformers.d.ts +2 -0
  33. package/dist/langchain-core/dist/language_models/base.d.ts +2 -0
  34. package/dist/langchain-core/dist/language_models/chat_models.d.ts +3 -0
  35. package/dist/langchain-core/dist/messages/index.d.ts +1 -0
  36. package/dist/langchain-core/dist/messages/transformers.d.ts +3 -0
  37. package/dist/langchain-core/dist/runnables/config.d.ts +2 -0
  38. package/dist/langchain-core/dist/tools/index.d.ts +8 -0
  39. package/dist/langchain-core/dist/tools/types.d.ts +2 -0
  40. package/dist/langchain-core/dist/tracers/event_stream.d.ts +2 -1
  41. package/dist/langchain-core/dist/utils/json_schema.d.ts +1 -0
  42. package/dist/llms.cjs +1 -0
  43. package/dist/llms.cjs.map +1 -1
  44. package/dist/llms.d.cts +3 -3
  45. package/dist/llms.d.ts +3 -3
  46. package/dist/llms.js +2 -1
  47. package/dist/llms.js.map +1 -1
  48. package/dist/tools/index.d.ts +1 -0
  49. package/dist/types.d.cts +5 -5
  50. package/dist/types.d.ts +5 -5
  51. package/dist/utils/azure.cjs +18 -0
  52. package/dist/utils/azure.cjs.map +1 -1
  53. package/dist/utils/azure.d.cts +5 -1
  54. package/dist/utils/azure.d.ts +5 -1
  55. package/dist/utils/azure.js +16 -1
  56. package/dist/utils/azure.js.map +1 -1
  57. package/package.json +13 -12
  58. package/dist/azure/chat_models/common.d.cts.map +0 -1
  59. package/dist/azure/chat_models/common.d.ts.map +0 -1
  60. package/dist/azure/chat_models/completions.d.cts.map +0 -1
  61. package/dist/azure/chat_models/completions.d.ts.map +0 -1
  62. package/dist/azure/chat_models/index.d.cts.map +0 -1
  63. package/dist/azure/chat_models/index.d.ts.map +0 -1
  64. package/dist/azure/chat_models/responses.d.cts.map +0 -1
  65. package/dist/azure/chat_models/responses.d.ts.map +0 -1
  66. package/dist/azure/embeddings.d.cts.map +0 -1
  67. package/dist/azure/embeddings.d.ts.map +0 -1
  68. package/dist/azure/llms.d.cts.map +0 -1
  69. package/dist/azure/llms.d.ts.map +0 -1
  70. package/dist/chat_models/base.d.cts.map +0 -1
  71. package/dist/chat_models/base.d.ts.map +0 -1
  72. package/dist/chat_models/completions.d.cts.map +0 -1
  73. package/dist/chat_models/completions.d.ts.map +0 -1
  74. package/dist/chat_models/index.d.cts.map +0 -1
  75. package/dist/chat_models/index.d.ts.map +0 -1
  76. package/dist/chat_models/responses.d.cts.map +0 -1
  77. package/dist/chat_models/responses.d.ts.map +0 -1
  78. package/dist/converters/completions.d.cts.map +0 -1
  79. package/dist/converters/completions.d.ts.map +0 -1
  80. package/dist/converters/responses.d.cts.map +0 -1
  81. package/dist/converters/responses.d.ts.map +0 -1
  82. package/dist/embeddings.d.cts.map +0 -1
  83. package/dist/embeddings.d.ts.map +0 -1
  84. package/dist/langchain-core/dist/language_models/chat_models.d.cts.map +0 -1
  85. package/dist/langchain-core/dist/language_models/chat_models.d.ts.map +0 -1
  86. package/dist/langchain-core/dist/types/_internal.d.cts.map +0 -1
  87. package/dist/langchain-core/dist/types/_internal.d.ts.map +0 -1
  88. package/dist/langchain-core/dist/utils/stream.d.cts.map +0 -1
  89. package/dist/langchain-core/dist/utils/stream.d.ts.map +0 -1
  90. package/dist/llms.d.cts.map +0 -1
  91. package/dist/llms.d.ts.map +0 -1
  92. package/dist/tools/custom.d.cts.map +0 -1
  93. package/dist/tools/custom.d.ts.map +0 -1
  94. package/dist/tools/dalle.d.cts.map +0 -1
  95. package/dist/tools/dalle.d.ts.map +0 -1
  96. package/dist/types.d.cts.map +0 -1
  97. package/dist/types.d.ts.map +0 -1
  98. package/dist/utils/azure.d.cts.map +0 -1
  99. package/dist/utils/azure.d.ts.map +0 -1
  100. package/dist/utils/client.d.cts.map +0 -1
  101. package/dist/utils/client.d.ts.map +0 -1
  102. package/dist/utils/misc.d.cts.map +0 -1
  103. package/dist/utils/misc.d.ts.map +0 -1
  104. package/dist/utils/prompts.d.cts.map +0 -1
  105. package/dist/utils/prompts.d.ts.map +0 -1
  106. package/dist/utils/tools.d.cts.map +0 -1
  107. package/dist/utils/tools.d.ts.map +0 -1
@@ -1 +1 @@
1
- {"version":3,"file":"base.cjs","names":["BaseChatModel","options: this[\"ParsedCallOptions\"]","fields?: BaseChatOpenAIFields","options?: this[\"ParsedCallOptions\"]","isReasoningModel","reasoning: OpenAIClient.Reasoning | undefined","resFormat?: CallOptions[\"response_format\"]","interopZodResponseFormat","additionalOptions?: this[\"ParsedCallOptions\"]","options: OpenAICoreRequestOptions | undefined","openAIEndpointConfig: OpenAIEndpointConfig","getEndpoint","OpenAIClient","tool: ChatOpenAIToolType","fields?: { strict?: boolean }","isCustomTool","convertResponsesCustomTool","_convertToOpenAITool","tools: ChatOpenAIToolType[]","kwargs?: Partial<CallOptions>","strict: boolean | undefined","isBuiltInTool","input: BaseLanguageModelInput","options?: CallOptions","messages: BaseMessage[]","messageToOpenAIRole","generations: ChatGeneration[]","functions?: OpenAIClient.Chat.ChatCompletionCreateParams.Function[]","function_call?:\n | \"none\"\n | \"auto\"\n | OpenAIClient.Chat.ChatCompletionFunctionCallOption","formatFunctionDefinitions","PROFILES","config: StructuredOutputMethodOptions<boolean>","outputSchema: InteropZodType<RunOutput> | Record<string, unknown>","config?: StructuredOutputMethodOptions<boolean>","llm: Runnable<BaseLanguageModelInput>","outputParser: Runnable<AIMessageChunk, RunOutput>","getStructuredOutputMethod","StructuredOutputParser","JsonOutputParser","RunnableLambda","aiMessage: AIMessageChunk","JsonOutputKeyToolsParser","openAIFunctionDefinition: FunctionDefinition","RunnablePassthrough","input: any","config","RunnableSequence"],"sources":["../../src/chat_models/base.ts"],"sourcesContent":["import { type ClientOptions, OpenAI as OpenAIClient } from \"openai\";\nimport { AIMessageChunk, type BaseMessage } from \"@langchain/core/messages\";\nimport { type ChatGeneration } from \"@langchain/core/outputs\";\nimport { getEnvironmentVariable } from \"@langchain/core/utils/env\";\nimport {\n BaseChatModel,\n type LangSmithParams,\n type BaseChatModelParams,\n BaseChatModelCallOptions,\n} from \"@langchain/core/language_models/chat_models\";\nimport {\n isOpenAITool as isOpenAIFunctionTool,\n type BaseFunctionCallOptions,\n type BaseLanguageModelInput,\n type FunctionDefinition,\n type StructuredOutputMethodOptions,\n} from \"@langchain/core/language_models/base\";\nimport { ModelProfile } from \"@langchain/core/language_models/profile\";\nimport {\n Runnable,\n RunnableLambda,\n RunnablePassthrough,\n RunnableSequence,\n} from \"@langchain/core/runnables\";\nimport {\n JsonOutputParser,\n StructuredOutputParser,\n} from \"@langchain/core/output_parsers\";\nimport { JsonOutputKeyToolsParser } from \"@langchain/core/output_parsers/openai_tools\";\nimport {\n getSchemaDescription,\n InteropZodType,\n isInteropZodSchema,\n} from \"@langchain/core/utils/types\";\nimport { toJsonSchema } from \"@langchain/core/utils/json_schema\";\nimport {\n type OpenAICallOptions,\n type OpenAIChatInput,\n type OpenAICoreRequestOptions,\n type ChatOpenAIResponseFormat,\n ResponseFormatConfiguration,\n OpenAIVerbosityParam,\n} from \"../types.js\";\nimport { type OpenAIEndpointConfig, getEndpoint } from \"../utils/azure.js\";\nimport {\n type FunctionDef,\n formatFunctionDefinitions,\n OpenAIToolChoice,\n _convertToOpenAITool,\n ChatOpenAIToolType,\n convertResponsesCustomTool,\n isBuiltInTool,\n isCustomTool,\n ResponsesToolChoice,\n} from \"../utils/tools.js\";\nimport {\n getStructuredOutputMethod,\n interopZodResponseFormat,\n _convertOpenAIResponsesUsageToLangChainUsage,\n} from \"../utils/output.js\";\nimport { isReasoningModel, messageToOpenAIRole } from \"../utils/misc.js\";\nimport PROFILES from \"./profiles.js\";\n\ninterface OpenAILLMOutput {\n tokenUsage: {\n completionTokens?: number;\n promptTokens?: number;\n totalTokens?: number;\n };\n}\n\nexport type { OpenAICallOptions, OpenAIChatInput };\n\nexport interface BaseChatOpenAICallOptions\n extends BaseChatModelCallOptions,\n BaseFunctionCallOptions {\n /**\n * Additional options to pass to the underlying axios request.\n */\n options?: OpenAICoreRequestOptions;\n\n /**\n * A list of tools that the model may use to generate responses.\n * Each tool can be a function, a built-in tool, or a custom tool definition.\n * If not provided, the model will not use any tools.\n */\n tools?: ChatOpenAIToolType[];\n\n /**\n * Specifies which tool the model should use to respond.\n * Can be an {@link OpenAIToolChoice} or a {@link ResponsesToolChoice}.\n * If not set, the model will decide which tool to use automatically.\n */\n // TODO: break OpenAIToolChoice and ResponsesToolChoice into options sub classes\n tool_choice?: OpenAIToolChoice | ResponsesToolChoice;\n\n /**\n * Adds a prompt index to prompts passed to the model to track\n * what prompt is being used for a given generation.\n */\n promptIndex?: number;\n\n /**\n * An object specifying the format that the model must output.\n */\n response_format?: ChatOpenAIResponseFormat;\n\n /**\n * When provided, the completions API will make a best effort to sample\n * deterministically, such that repeated requests with the same `seed`\n * and parameters should return the same result.\n */\n seed?: number;\n\n /**\n * Additional options to pass to streamed completions.\n * If provided, this takes precedence over \"streamUsage\" set at\n * initialization time.\n */\n stream_options?: OpenAIClient.Chat.ChatCompletionStreamOptions;\n\n /**\n * The model may choose to call multiple functions in a single turn. You can\n * set parallel_tool_calls to false which ensures only one tool is called at most.\n * [Learn more](https://platform.openai.com/docs/guides/function-calling#parallel-function-calling)\n */\n parallel_tool_calls?: boolean;\n\n /**\n * If `true`, model output is guaranteed to exactly match the JSON Schema\n * provided in the tool definition. If `true`, the input schema will also be\n * validated according to\n * https://platform.openai.com/docs/guides/structured-outputs/supported-schemas.\n *\n * If `false`, input schema will not be validated and model output will not\n * be validated.\n *\n * If `undefined`, `strict` argument will not be passed to the model.\n */\n strict?: boolean;\n\n /**\n * Output types that you would like the model to generate for this request. Most\n * models are capable of generating text, which is the default:\n *\n * `[\"text\"]`\n *\n * The `gpt-4o-audio-preview` model can also be used to\n * [generate audio](https://platform.openai.com/docs/guides/audio). To request that\n * this model generate both text and audio responses, you can use:\n *\n * `[\"text\", \"audio\"]`\n */\n modalities?: Array<OpenAIClient.Chat.ChatCompletionModality>;\n\n /**\n * Parameters for audio output. Required when audio output is requested with\n * `modalities: [\"audio\"]`.\n * [Learn more](https://platform.openai.com/docs/guides/audio).\n */\n audio?: OpenAIClient.Chat.ChatCompletionAudioParam;\n\n /**\n * Static predicted output content, such as the content of a text file that is being regenerated.\n * [Learn more](https://platform.openai.com/docs/guides/latency-optimization#use-predicted-outputs).\n */\n prediction?: OpenAIClient.ChatCompletionPredictionContent;\n\n /**\n * Options for reasoning models.\n *\n * Note that some options, like reasoning summaries, are only available when using the responses\n * API. If these options are set, the responses API will be used to fulfill the request.\n *\n * These options will be ignored when not using a reasoning model.\n */\n reasoning?: OpenAIClient.Reasoning;\n\n /**\n * Service tier to use for this request. Can be \"auto\", \"default\", or \"flex\"\n * Specifies the service tier for prioritization and latency optimization.\n */\n service_tier?: OpenAIClient.Chat.ChatCompletionCreateParams[\"service_tier\"];\n\n /**\n * Used by OpenAI to cache responses for similar requests to optimize your cache\n * hit rates. Replaces the `user` field.\n * [Learn more](https://platform.openai.com/docs/guides/prompt-caching).\n */\n promptCacheKey?: string;\n\n /**\n * The verbosity of the model's response.\n */\n verbosity?: OpenAIVerbosityParam;\n}\n\nexport interface BaseChatOpenAIFields\n extends Partial<OpenAIChatInput>,\n BaseChatModelParams {\n /**\n * Optional configuration options for the OpenAI client.\n */\n configuration?: ClientOptions;\n}\n\n/** @internal */\nexport abstract class BaseChatOpenAI<\n CallOptions extends BaseChatOpenAICallOptions\n >\n extends BaseChatModel<CallOptions, AIMessageChunk>\n implements Partial<OpenAIChatInput>\n{\n temperature?: number;\n\n topP?: number;\n\n frequencyPenalty?: number;\n\n presencePenalty?: number;\n\n n?: number;\n\n logitBias?: Record<string, number>;\n\n model = \"gpt-3.5-turbo\";\n\n modelKwargs?: OpenAIChatInput[\"modelKwargs\"];\n\n stop?: string[];\n\n stopSequences?: string[];\n\n user?: string;\n\n timeout?: number;\n\n streaming = false;\n\n streamUsage = true;\n\n maxTokens?: number;\n\n logprobs?: boolean;\n\n topLogprobs?: number;\n\n apiKey?: string;\n\n organization?: string;\n\n __includeRawResponse?: boolean;\n\n /** @internal */\n client: OpenAIClient;\n\n /** @internal */\n clientConfig: ClientOptions;\n\n /**\n * Whether the model supports the `strict` argument when passing in tools.\n * If `undefined` the `strict` argument will not be passed to OpenAI.\n */\n supportsStrictToolCalling?: boolean;\n\n audio?: OpenAIClient.Chat.ChatCompletionAudioParam;\n\n modalities?: Array<OpenAIClient.Chat.ChatCompletionModality>;\n\n reasoning?: OpenAIClient.Reasoning;\n\n /**\n * Must be set to `true` in tenancies with Zero Data Retention. Setting to `true` will disable\n * output storage in the Responses API, but this DOES NOT enable Zero Data Retention in your\n * OpenAI organization or project. This must be configured directly with OpenAI.\n *\n * See:\n * https://platform.openai.com/docs/guides/your-data\n * https://platform.openai.com/docs/api-reference/responses/create#responses-create-store\n *\n * @default false\n */\n zdrEnabled?: boolean | undefined;\n\n /**\n * Service tier to use for this request. Can be \"auto\", \"default\", or \"flex\" or \"priority\".\n * Specifies the service tier for prioritization and latency optimization.\n */\n service_tier?: OpenAIClient.Chat.ChatCompletionCreateParams[\"service_tier\"];\n\n /**\n * Used by OpenAI to cache responses for similar requests to optimize your cache\n * hit rates.\n * [Learn more](https://platform.openai.com/docs/guides/prompt-caching).\n */\n promptCacheKey: string;\n\n /**\n * The verbosity of the model's response.\n */\n verbosity?: OpenAIVerbosityParam;\n\n protected defaultOptions: CallOptions;\n\n _llmType() {\n return \"openai\";\n }\n\n static lc_name() {\n return \"ChatOpenAI\";\n }\n\n get callKeys() {\n return [\n ...super.callKeys,\n \"options\",\n \"function_call\",\n \"functions\",\n \"tools\",\n \"tool_choice\",\n \"promptIndex\",\n \"response_format\",\n \"seed\",\n \"reasoning\",\n \"service_tier\",\n ];\n }\n\n lc_serializable = true;\n\n get lc_secrets(): { [key: string]: string } | undefined {\n return {\n apiKey: \"OPENAI_API_KEY\",\n organization: \"OPENAI_ORGANIZATION\",\n };\n }\n\n get lc_aliases(): Record<string, string> {\n return {\n apiKey: \"openai_api_key\",\n modelName: \"model\",\n };\n }\n\n get lc_serializable_keys(): string[] {\n return [\n \"configuration\",\n \"logprobs\",\n \"topLogprobs\",\n \"prefixMessages\",\n \"supportsStrictToolCalling\",\n \"modalities\",\n \"audio\",\n \"temperature\",\n \"maxTokens\",\n \"topP\",\n \"frequencyPenalty\",\n \"presencePenalty\",\n \"n\",\n \"logitBias\",\n \"user\",\n \"streaming\",\n \"streamUsage\",\n \"model\",\n \"modelName\",\n \"modelKwargs\",\n \"stop\",\n \"stopSequences\",\n \"timeout\",\n \"apiKey\",\n \"cache\",\n \"maxConcurrency\",\n \"maxRetries\",\n \"verbose\",\n \"callbacks\",\n \"tags\",\n \"metadata\",\n \"disableStreaming\",\n \"zdrEnabled\",\n \"reasoning\",\n \"promptCacheKey\",\n \"verbosity\",\n ];\n }\n\n getLsParams(options: this[\"ParsedCallOptions\"]): LangSmithParams {\n const params = this.invocationParams(options);\n return {\n ls_provider: \"openai\",\n ls_model_name: this.model,\n ls_model_type: \"chat\",\n ls_temperature: params.temperature ?? undefined,\n ls_max_tokens: params.max_tokens ?? undefined,\n ls_stop: options.stop,\n };\n }\n\n /** @ignore */\n _identifyingParams(): Omit<\n OpenAIClient.Chat.ChatCompletionCreateParams,\n \"messages\"\n > & {\n model_name: string;\n } & ClientOptions {\n return {\n model_name: this.model,\n ...this.invocationParams(),\n ...this.clientConfig,\n };\n }\n\n /**\n * Get the identifying parameters for the model\n */\n identifyingParams() {\n return this._identifyingParams();\n }\n\n constructor(fields?: BaseChatOpenAIFields) {\n super(fields ?? {});\n\n const configApiKey =\n typeof fields?.configuration?.apiKey === \"string\"\n ? fields?.configuration?.apiKey\n : undefined;\n this.apiKey =\n fields?.apiKey ??\n configApiKey ??\n getEnvironmentVariable(\"OPENAI_API_KEY\");\n this.organization =\n fields?.configuration?.organization ??\n getEnvironmentVariable(\"OPENAI_ORGANIZATION\");\n\n this.model = fields?.model ?? fields?.modelName ?? this.model;\n this.modelKwargs = fields?.modelKwargs ?? {};\n this.timeout = fields?.timeout;\n\n this.temperature = fields?.temperature ?? this.temperature;\n this.topP = fields?.topP ?? this.topP;\n this.frequencyPenalty = fields?.frequencyPenalty ?? this.frequencyPenalty;\n this.presencePenalty = fields?.presencePenalty ?? this.presencePenalty;\n this.logprobs = fields?.logprobs;\n this.topLogprobs = fields?.topLogprobs;\n this.n = fields?.n ?? this.n;\n this.logitBias = fields?.logitBias;\n this.stop = fields?.stopSequences ?? fields?.stop;\n this.stopSequences = this.stop;\n this.user = fields?.user;\n this.__includeRawResponse = fields?.__includeRawResponse;\n this.audio = fields?.audio;\n this.modalities = fields?.modalities;\n this.reasoning = fields?.reasoning;\n this.maxTokens = fields?.maxCompletionTokens ?? fields?.maxTokens;\n this.promptCacheKey = fields?.promptCacheKey ?? this.promptCacheKey;\n this.verbosity = fields?.verbosity ?? this.verbosity;\n\n this.disableStreaming = fields?.disableStreaming === true;\n this.streaming = fields?.streaming === true;\n if (this.disableStreaming) this.streaming = false;\n // disable streaming in BaseChatModel if explicitly disabled\n if (fields?.streaming === false) this.disableStreaming = true;\n\n this.streamUsage = fields?.streamUsage ?? this.streamUsage;\n if (this.disableStreaming) this.streamUsage = false;\n\n this.clientConfig = {\n apiKey: this.apiKey,\n organization: this.organization,\n dangerouslyAllowBrowser: true,\n ...fields?.configuration,\n };\n\n // If `supportsStrictToolCalling` is explicitly set, use that value.\n // Else leave undefined so it's not passed to OpenAI.\n if (fields?.supportsStrictToolCalling !== undefined) {\n this.supportsStrictToolCalling = fields.supportsStrictToolCalling;\n }\n\n if (fields?.service_tier !== undefined) {\n this.service_tier = fields.service_tier;\n }\n\n this.zdrEnabled = fields?.zdrEnabled ?? false;\n }\n\n /**\n * Returns backwards compatible reasoning parameters from constructor params and call options\n * @internal\n */\n protected _getReasoningParams(\n options?: this[\"ParsedCallOptions\"]\n ): OpenAIClient.Reasoning | undefined {\n if (!isReasoningModel(this.model)) {\n return;\n }\n\n // apply options in reverse order of importance -- newer options supersede older options\n let reasoning: OpenAIClient.Reasoning | undefined;\n if (this.reasoning !== undefined) {\n reasoning = {\n ...reasoning,\n ...this.reasoning,\n };\n }\n if (options?.reasoning !== undefined) {\n reasoning = {\n ...reasoning,\n ...options.reasoning,\n };\n }\n\n return reasoning;\n }\n\n /**\n * Returns an openai compatible response format from a set of options\n * @internal\n */\n protected _getResponseFormat(\n resFormat?: CallOptions[\"response_format\"]\n ): ResponseFormatConfiguration | undefined {\n if (\n resFormat &&\n resFormat.type === \"json_schema\" &&\n resFormat.json_schema.schema &&\n isInteropZodSchema(resFormat.json_schema.schema)\n ) {\n return interopZodResponseFormat(\n resFormat.json_schema.schema,\n resFormat.json_schema.name,\n {\n description: resFormat.json_schema.description,\n }\n );\n }\n return resFormat as ResponseFormatConfiguration | undefined;\n }\n\n protected _combineCallOptions(\n additionalOptions?: this[\"ParsedCallOptions\"]\n ): this[\"ParsedCallOptions\"] {\n return {\n ...this.defaultOptions,\n ...(additionalOptions ?? {}),\n };\n }\n\n /** @internal */\n _getClientOptions(\n options: OpenAICoreRequestOptions | undefined\n ): OpenAICoreRequestOptions {\n if (!this.client) {\n const openAIEndpointConfig: OpenAIEndpointConfig = {\n baseURL: this.clientConfig.baseURL,\n };\n\n const endpoint = getEndpoint(openAIEndpointConfig);\n const params = {\n ...this.clientConfig,\n baseURL: endpoint,\n timeout: this.timeout,\n maxRetries: 0,\n };\n if (!params.baseURL) {\n delete params.baseURL;\n }\n\n this.client = new OpenAIClient(params);\n }\n const requestOptions = {\n ...this.clientConfig,\n ...options,\n } as OpenAICoreRequestOptions;\n return requestOptions;\n }\n\n // TODO: move to completions class\n protected _convertChatOpenAIToolToCompletionsTool(\n tool: ChatOpenAIToolType,\n fields?: { strict?: boolean }\n ): OpenAIClient.ChatCompletionTool {\n if (isCustomTool(tool)) {\n return convertResponsesCustomTool(tool.metadata.customTool);\n }\n if (isOpenAIFunctionTool(tool)) {\n if (fields?.strict !== undefined) {\n return {\n ...tool,\n function: {\n ...tool.function,\n strict: fields.strict,\n },\n };\n }\n\n return tool;\n }\n return _convertToOpenAITool(tool, fields);\n }\n\n override bindTools(\n tools: ChatOpenAIToolType[],\n kwargs?: Partial<CallOptions>\n ): Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions> {\n let strict: boolean | undefined;\n if (kwargs?.strict !== undefined) {\n strict = kwargs.strict;\n } else if (this.supportsStrictToolCalling !== undefined) {\n strict = this.supportsStrictToolCalling;\n }\n return this.withConfig({\n tools: tools.map((tool) =>\n isBuiltInTool(tool) || isCustomTool(tool)\n ? tool\n : this._convertChatOpenAIToolToCompletionsTool(tool, { strict })\n ),\n ...kwargs,\n } as Partial<CallOptions>);\n }\n\n override async stream(input: BaseLanguageModelInput, options?: CallOptions) {\n return super.stream(\n input,\n this._combineCallOptions(options) as CallOptions\n );\n }\n\n override async invoke(input: BaseLanguageModelInput, options?: CallOptions) {\n return super.invoke(\n input,\n this._combineCallOptions(options) as CallOptions\n );\n }\n\n /** @ignore */\n _combineLLMOutput(...llmOutputs: OpenAILLMOutput[]): OpenAILLMOutput {\n return llmOutputs.reduce<{\n [key in keyof OpenAILLMOutput]: Required<OpenAILLMOutput[key]>;\n }>(\n (acc, llmOutput) => {\n if (llmOutput && llmOutput.tokenUsage) {\n acc.tokenUsage.completionTokens +=\n llmOutput.tokenUsage.completionTokens ?? 0;\n acc.tokenUsage.promptTokens += llmOutput.tokenUsage.promptTokens ?? 0;\n acc.tokenUsage.totalTokens += llmOutput.tokenUsage.totalTokens ?? 0;\n }\n return acc;\n },\n {\n tokenUsage: {\n completionTokens: 0,\n promptTokens: 0,\n totalTokens: 0,\n },\n }\n );\n }\n\n async getNumTokensFromMessages(messages: BaseMessage[]) {\n let totalCount = 0;\n let tokensPerMessage = 0;\n let tokensPerName = 0;\n\n // From: https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb\n if (this.model === \"gpt-3.5-turbo-0301\") {\n tokensPerMessage = 4;\n tokensPerName = -1;\n } else {\n tokensPerMessage = 3;\n tokensPerName = 1;\n }\n\n const countPerMessage = await Promise.all(\n messages.map(async (message) => {\n const textCount = await this.getNumTokens(message.content);\n const roleCount = await this.getNumTokens(messageToOpenAIRole(message));\n const nameCount =\n message.name !== undefined\n ? tokensPerName + (await this.getNumTokens(message.name))\n : 0;\n let count = textCount + tokensPerMessage + roleCount + nameCount;\n\n // From: https://github.com/hmarr/openai-chat-tokens/blob/main/src/index.ts messageTokenEstimate\n const openAIMessage = message;\n if (openAIMessage._getType() === \"function\") {\n count -= 2;\n }\n if (openAIMessage.additional_kwargs?.function_call) {\n count += 3;\n }\n if (openAIMessage?.additional_kwargs.function_call?.name) {\n count += await this.getNumTokens(\n openAIMessage.additional_kwargs.function_call?.name\n );\n }\n if (openAIMessage.additional_kwargs.function_call?.arguments) {\n try {\n count += await this.getNumTokens(\n // Remove newlines and spaces\n JSON.stringify(\n JSON.parse(\n openAIMessage.additional_kwargs.function_call?.arguments\n )\n )\n );\n } catch (error) {\n console.error(\n \"Error parsing function arguments\",\n error,\n JSON.stringify(openAIMessage.additional_kwargs.function_call)\n );\n count += await this.getNumTokens(\n openAIMessage.additional_kwargs.function_call?.arguments\n );\n }\n }\n\n totalCount += count;\n return count;\n })\n );\n\n totalCount += 3; // every reply is primed with <|start|>assistant<|message|>\n\n return { totalCount, countPerMessage };\n }\n\n /** @internal */\n protected async _getNumTokensFromGenerations(generations: ChatGeneration[]) {\n const generationUsages = await Promise.all(\n generations.map(async (generation) => {\n if (generation.message.additional_kwargs?.function_call) {\n return (await this.getNumTokensFromMessages([generation.message]))\n .countPerMessage[0];\n } else {\n return await this.getNumTokens(generation.message.content);\n }\n })\n );\n\n return generationUsages.reduce((a, b) => a + b, 0);\n }\n\n /** @internal */\n protected async _getEstimatedTokenCountFromPrompt(\n messages: BaseMessage[],\n functions?: OpenAIClient.Chat.ChatCompletionCreateParams.Function[],\n function_call?:\n | \"none\"\n | \"auto\"\n | OpenAIClient.Chat.ChatCompletionFunctionCallOption\n ): Promise<number> {\n // It appears that if functions are present, the first system message is padded with a trailing newline. This\n // was inferred by trying lots of combinations of messages and functions and seeing what the token counts were.\n\n let tokens = (await this.getNumTokensFromMessages(messages)).totalCount;\n\n // If there are functions, add the function definitions as they count towards token usage\n if (functions && function_call !== \"auto\") {\n const promptDefinitions = formatFunctionDefinitions(\n functions as unknown as FunctionDef[]\n );\n tokens += await this.getNumTokens(promptDefinitions);\n tokens += 9; // Add nine per completion\n }\n\n // If there's a system message _and_ functions are present, subtract four tokens. I assume this is because\n // functions typically add a system message, but reuse the first one if it's already there. This offsets\n // the extra 9 tokens added by the function definitions.\n if (functions && messages.find((m) => m._getType() === \"system\")) {\n tokens -= 4;\n }\n\n // If function_call is 'none', add one token.\n // If it's a FunctionCall object, add 4 + the number of tokens in the function name.\n // If it's undefined or 'auto', don't add anything.\n if (function_call === \"none\") {\n tokens += 1;\n } else if (typeof function_call === \"object\") {\n tokens += (await this.getNumTokens(function_call.name)) + 4;\n }\n\n return tokens;\n }\n\n /**\n * Return profiling information for the model.\n *\n * Provides information about the model's capabilities and constraints,\n * including token limits, multimodal support, and advanced features like\n * tool calling and structured output.\n *\n * @returns {ModelProfile} An object describing the model's capabilities and constraints\n *\n * @example\n * ```typescript\n * const model = new ChatOpenAI({ model: \"gpt-4o\" });\n * const profile = model.profile;\n * console.log(profile.maxInputTokens); // 128000\n * console.log(profile.imageInputs); // true\n * ```\n */\n get profile(): ModelProfile {\n return PROFILES[this.model] ?? {};\n }\n\n /** @internal */\n protected _getStructuredOutputMethod(\n config: StructuredOutputMethodOptions<boolean>\n ) {\n const ensuredConfig = { ...config };\n if (\n !this.model.startsWith(\"gpt-3\") &&\n !this.model.startsWith(\"gpt-4-\") &&\n this.model !== \"gpt-4\"\n ) {\n if (ensuredConfig?.method === undefined) {\n return \"jsonSchema\";\n }\n } else if (ensuredConfig.method === \"jsonSchema\") {\n console.warn(\n `[WARNING]: JSON Schema is not supported for model \"${this.model}\". Falling back to tool calling.`\n );\n }\n return ensuredConfig.method;\n }\n\n withStructuredOutput<\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n RunOutput extends Record<string, any> = Record<string, any>\n >(\n outputSchema:\n | InteropZodType<RunOutput>\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n | Record<string, any>,\n config?: StructuredOutputMethodOptions<false>\n ): Runnable<BaseLanguageModelInput, RunOutput>;\n\n withStructuredOutput<\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n RunOutput extends Record<string, any> = Record<string, any>\n >(\n outputSchema:\n | InteropZodType<RunOutput>\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n | Record<string, any>,\n config?: StructuredOutputMethodOptions<true>\n ): Runnable<BaseLanguageModelInput, { raw: BaseMessage; parsed: RunOutput }>;\n\n withStructuredOutput<\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n RunOutput extends Record<string, any> = Record<string, any>\n >(\n outputSchema:\n | InteropZodType<RunOutput>\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n | Record<string, any>,\n config?: StructuredOutputMethodOptions<boolean>\n ):\n | Runnable<BaseLanguageModelInput, RunOutput>\n | Runnable<BaseLanguageModelInput, { raw: BaseMessage; parsed: RunOutput }>;\n\n /**\n * Add structured output to the model.\n *\n * The OpenAI model family supports the following structured output methods:\n * - `jsonSchema`: Use the `response_format` field in the response to return a JSON schema. Only supported with the `gpt-4o-mini`,\n * `gpt-4o-mini-2024-07-18`, and `gpt-4o-2024-08-06` model snapshots and later.\n * - `functionCalling`: Function calling is useful when you are building an application that bridges the models and functionality\n * of your application.\n * - `jsonMode`: JSON mode is a more basic version of the Structured Outputs feature. While JSON mode ensures that model\n * output is valid JSON, Structured Outputs reliably matches the model's output to the schema you specify.\n * We recommend you use `functionCalling` or `jsonSchema` if it is supported for your use case.\n *\n * The default method is `functionCalling`.\n *\n * @see https://platform.openai.com/docs/guides/structured-outputs\n * @param outputSchema - The schema to use for structured output.\n * @param config - The structured output method options.\n * @returns The model with structured output.\n */\n withStructuredOutput<\n RunOutput extends Record<string, unknown> = Record<string, unknown>\n >(\n outputSchema: InteropZodType<RunOutput> | Record<string, unknown>,\n config?: StructuredOutputMethodOptions<boolean>\n ) {\n let llm: Runnable<BaseLanguageModelInput>;\n let outputParser: Runnable<AIMessageChunk, RunOutput>;\n\n const { schema, name, includeRaw } = {\n ...config,\n schema: outputSchema,\n };\n\n if (config?.strict !== undefined && config.method === \"jsonMode\") {\n throw new Error(\n \"Argument `strict` is only supported for `method` = 'function_calling'\"\n );\n }\n\n const method = getStructuredOutputMethod(this.model, config?.method);\n\n if (method === \"jsonMode\") {\n if (isInteropZodSchema(schema)) {\n outputParser = StructuredOutputParser.fromZodSchema(schema);\n } else {\n outputParser = new JsonOutputParser<RunOutput>();\n }\n const asJsonSchema = toJsonSchema(schema);\n llm = this.withConfig({\n outputVersion: \"v0\",\n response_format: { type: \"json_object\" },\n ls_structured_output_format: {\n kwargs: { method: \"json_mode\" },\n schema: { title: name ?? \"extract\", ...asJsonSchema },\n },\n } as Partial<CallOptions>);\n } else if (method === \"jsonSchema\") {\n const openaiJsonSchemaParams = {\n name: name ?? \"extract\",\n description: getSchemaDescription(schema),\n schema,\n strict: config?.strict,\n };\n const asJsonSchema = toJsonSchema(openaiJsonSchemaParams.schema);\n llm = this.withConfig({\n outputVersion: \"v0\",\n response_format: {\n type: \"json_schema\",\n json_schema: openaiJsonSchemaParams,\n },\n ls_structured_output_format: {\n kwargs: { method: \"json_schema\" },\n schema: {\n title: openaiJsonSchemaParams.name,\n description: openaiJsonSchemaParams.description,\n ...asJsonSchema,\n },\n },\n } as Partial<CallOptions>);\n if (isInteropZodSchema(schema)) {\n const altParser = StructuredOutputParser.fromZodSchema(schema);\n outputParser = RunnableLambda.from<AIMessageChunk, RunOutput>(\n (aiMessage: AIMessageChunk) => {\n if (\"parsed\" in aiMessage.additional_kwargs) {\n return aiMessage.additional_kwargs.parsed as RunOutput;\n }\n return altParser;\n }\n );\n } else {\n outputParser = new JsonOutputParser<RunOutput>();\n }\n } else {\n let functionName = name ?? \"extract\";\n // Is function calling\n if (isInteropZodSchema(schema)) {\n const asJsonSchema = toJsonSchema(schema);\n llm = this.withConfig({\n outputVersion: \"v0\",\n tools: [\n {\n type: \"function\" as const,\n function: {\n name: functionName,\n description: asJsonSchema.description,\n parameters: asJsonSchema,\n },\n },\n ],\n tool_choice: {\n type: \"function\" as const,\n function: {\n name: functionName,\n },\n },\n ls_structured_output_format: {\n kwargs: { method: \"function_calling\" },\n schema: { title: functionName, ...asJsonSchema },\n },\n // Do not pass `strict` argument to OpenAI if `config.strict` is undefined\n ...(config?.strict !== undefined ? { strict: config.strict } : {}),\n } as Partial<CallOptions>);\n outputParser = new JsonOutputKeyToolsParser({\n returnSingle: true,\n keyName: functionName,\n zodSchema: schema,\n });\n } else {\n let openAIFunctionDefinition: FunctionDefinition;\n if (\n typeof schema.name === \"string\" &&\n typeof schema.parameters === \"object\" &&\n schema.parameters != null\n ) {\n openAIFunctionDefinition = schema as unknown as FunctionDefinition;\n functionName = schema.name;\n } else {\n functionName = (schema.title as string) ?? functionName;\n openAIFunctionDefinition = {\n name: functionName,\n description: (schema.description as string) ?? \"\",\n parameters: schema,\n };\n }\n const asJsonSchema = toJsonSchema(schema);\n llm = this.withConfig({\n outputVersion: \"v0\",\n tools: [\n {\n type: \"function\" as const,\n function: openAIFunctionDefinition,\n },\n ],\n tool_choice: {\n type: \"function\" as const,\n function: {\n name: functionName,\n },\n },\n ls_structured_output_format: {\n kwargs: { method: \"function_calling\" },\n schema: { title: functionName, ...asJsonSchema },\n },\n // Do not pass `strict` argument to OpenAI if `config.strict` is undefined\n ...(config?.strict !== undefined ? { strict: config.strict } : {}),\n } as Partial<CallOptions>);\n outputParser = new JsonOutputKeyToolsParser<RunOutput>({\n returnSingle: true,\n keyName: functionName,\n });\n }\n }\n\n if (!includeRaw) {\n return llm.pipe(outputParser) as Runnable<\n BaseLanguageModelInput,\n RunOutput\n >;\n }\n\n const parserAssign = RunnablePassthrough.assign({\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n parsed: (input: any, config) => outputParser.invoke(input.raw, config),\n });\n const parserNone = RunnablePassthrough.assign({\n parsed: () => null,\n });\n const parsedWithFallback = parserAssign.withFallbacks({\n fallbacks: [parserNone],\n });\n return RunnableSequence.from<\n BaseLanguageModelInput,\n { raw: BaseMessage; parsed: RunOutput }\n >([{ raw: llm }, parsedWithFallback]);\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AA+MA,IAAsB,iBAAtB,cAGUA,2DAEV;CACE;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA,QAAQ;CAER;CAEA;CAEA;CAEA;CAEA;CAEA,YAAY;CAEZ,cAAc;CAEd;CAEA;CAEA;CAEA;CAEA;CAEA;;CAGA;;CAGA;;;;;CAMA;CAEA;CAEA;CAEA;;;;;;;;;;;;CAaA;;;;;CAMA;;;;;;CAOA;;;;CAKA;CAEA,AAAU;CAEV,WAAW;AACT,SAAO;CACR;CAED,OAAO,UAAU;AACf,SAAO;CACR;CAED,IAAI,WAAW;AACb,SAAO;GACL,GAAG,MAAM;GACT;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;EACD;CACF;CAED,kBAAkB;CAElB,IAAI,aAAoD;AACtD,SAAO;GACL,QAAQ;GACR,cAAc;EACf;CACF;CAED,IAAI,aAAqC;AACvC,SAAO;GACL,QAAQ;GACR,WAAW;EACZ;CACF;CAED,IAAI,uBAAiC;AACnC,SAAO;GACL;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;EACD;CACF;CAED,YAAYC,SAAqD;EAC/D,MAAM,SAAS,KAAK,iBAAiB,QAAQ;AAC7C,SAAO;GACL,aAAa;GACb,eAAe,KAAK;GACpB,eAAe;GACf,gBAAgB,OAAO,eAAe;GACtC,eAAe,OAAO,cAAc;GACpC,SAAS,QAAQ;EAClB;CACF;;CAGD,qBAKkB;AAChB,SAAO;GACL,YAAY,KAAK;GACjB,GAAG,KAAK,kBAAkB;GAC1B,GAAG,KAAK;EACT;CACF;;;;CAKD,oBAAoB;AAClB,SAAO,KAAK,oBAAoB;CACjC;CAED,YAAYC,QAA+B;EACzC,MAAM,UAAU,CAAE,EAAC;EAEnB,MAAM,eACJ,OAAO,QAAQ,eAAe,WAAW,WACrC,QAAQ,eAAe,SACvB;EACN,KAAK,SACH,QAAQ,UACR,uEACuB,iBAAiB;EAC1C,KAAK,eACH,QAAQ,eAAe,uEACA,sBAAsB;EAE/C,KAAK,QAAQ,QAAQ,SAAS,QAAQ,aAAa,KAAK;EACxD,KAAK,cAAc,QAAQ,eAAe,CAAE;EAC5C,KAAK,UAAU,QAAQ;EAEvB,KAAK,cAAc,QAAQ,eAAe,KAAK;EAC/C,KAAK,OAAO,QAAQ,QAAQ,KAAK;EACjC,KAAK,mBAAmB,QAAQ,oBAAoB,KAAK;EACzD,KAAK,kBAAkB,QAAQ,mBAAmB,KAAK;EACvD,KAAK,WAAW,QAAQ;EACxB,KAAK,cAAc,QAAQ;EAC3B,KAAK,IAAI,QAAQ,KAAK,KAAK;EAC3B,KAAK,YAAY,QAAQ;EACzB,KAAK,OAAO,QAAQ,iBAAiB,QAAQ;EAC7C,KAAK,gBAAgB,KAAK;EAC1B,KAAK,OAAO,QAAQ;EACpB,KAAK,uBAAuB,QAAQ;EACpC,KAAK,QAAQ,QAAQ;EACrB,KAAK,aAAa,QAAQ;EAC1B,KAAK,YAAY,QAAQ;EACzB,KAAK,YAAY,QAAQ,uBAAuB,QAAQ;EACxD,KAAK,iBAAiB,QAAQ,kBAAkB,KAAK;EACrD,KAAK,YAAY,QAAQ,aAAa,KAAK;EAE3C,KAAK,mBAAmB,QAAQ,qBAAqB;EACrD,KAAK,YAAY,QAAQ,cAAc;AACvC,MAAI,KAAK,kBAAkB,KAAK,YAAY;AAE5C,MAAI,QAAQ,cAAc,OAAO,KAAK,mBAAmB;EAEzD,KAAK,cAAc,QAAQ,eAAe,KAAK;AAC/C,MAAI,KAAK,kBAAkB,KAAK,cAAc;EAE9C,KAAK,eAAe;GAClB,QAAQ,KAAK;GACb,cAAc,KAAK;GACnB,yBAAyB;GACzB,GAAG,QAAQ;EACZ;AAID,MAAI,QAAQ,8BAA8B,QACxC,KAAK,4BAA4B,OAAO;AAG1C,MAAI,QAAQ,iBAAiB,QAC3B,KAAK,eAAe,OAAO;EAG7B,KAAK,aAAa,QAAQ,cAAc;CACzC;;;;;CAMD,AAAU,oBACRC,SACoC;AACpC,MAAI,CAACC,8BAAiB,KAAK,MAAM,CAC/B;EAIF,IAAIC;AACJ,MAAI,KAAK,cAAc,QACrB,YAAY;GACV,GAAG;GACH,GAAG,KAAK;EACT;AAEH,MAAI,SAAS,cAAc,QACzB,YAAY;GACV,GAAG;GACH,GAAG,QAAQ;EACZ;AAGH,SAAO;CACR;;;;;CAMD,AAAU,mBACRC,WACyC;AACzC,MACE,aACA,UAAU,SAAS,iBACnB,UAAU,YAAY,+DACH,UAAU,YAAY,OAAO,CAEhD,QAAOC,wCACL,UAAU,YAAY,QACtB,UAAU,YAAY,MACtB,EACE,aAAa,UAAU,YAAY,YACpC,EACF;AAEH,SAAO;CACR;CAED,AAAU,oBACRC,mBAC2B;AAC3B,SAAO;GACL,GAAG,KAAK;GACR,GAAI,qBAAqB,CAAE;EAC5B;CACF;;CAGD,kBACEC,SAC0B;AAC1B,MAAI,CAAC,KAAK,QAAQ;GAChB,MAAMC,uBAA6C,EACjD,SAAS,KAAK,aAAa,QAC5B;GAED,MAAM,WAAWC,0BAAY,qBAAqB;GAClD,MAAM,SAAS;IACb,GAAG,KAAK;IACR,SAAS;IACT,SAAS,KAAK;IACd,YAAY;GACb;AACD,OAAI,CAAC,OAAO,SACV,OAAO,OAAO;GAGhB,KAAK,SAAS,IAAIC,cAAa;EAChC;EACD,MAAM,iBAAiB;GACrB,GAAG,KAAK;GACR,GAAG;EACJ;AACD,SAAO;CACR;CAGD,AAAU,wCACRC,MACAC,QACiC;AACjC,MAAIC,2BAAa,KAAK,CACpB,QAAOC,yCAA2B,KAAK,SAAS,WAAW;AAE7D,8DAAyB,KAAK,EAAE;AAC9B,OAAI,QAAQ,WAAW,OACrB,QAAO;IACL,GAAG;IACH,UAAU;KACR,GAAG,KAAK;KACR,QAAQ,OAAO;IAChB;GACF;AAGH,UAAO;EACR;AACD,SAAOC,mCAAqB,MAAM,OAAO;CAC1C;CAED,AAAS,UACPC,OACAC,QAC+D;EAC/D,IAAIC;AACJ,MAAI,QAAQ,WAAW,QACrB,SAAS,OAAO;WACP,KAAK,8BAA8B,QAC5C,SAAS,KAAK;AAEhB,SAAO,KAAK,WAAW;GACrB,OAAO,MAAM,IAAI,CAAC,SAChBC,4BAAc,KAAK,IAAIN,2BAAa,KAAK,GACrC,OACA,KAAK,wCAAwC,MAAM,EAAE,OAAQ,EAAC,CACnE;GACD,GAAG;EACJ,EAAyB;CAC3B;CAED,MAAe,OAAOO,OAA+BC,SAAuB;AAC1E,SAAO,MAAM,OACX,OACA,KAAK,oBAAoB,QAAQ,CAClC;CACF;CAED,MAAe,OAAOD,OAA+BC,SAAuB;AAC1E,SAAO,MAAM,OACX,OACA,KAAK,oBAAoB,QAAQ,CAClC;CACF;;CAGD,kBAAkB,GAAG,YAAgD;AACnE,SAAO,WAAW,OAGhB,CAAC,KAAK,cAAc;AAClB,OAAI,aAAa,UAAU,YAAY;IACrC,IAAI,WAAW,oBACb,UAAU,WAAW,oBAAoB;IAC3C,IAAI,WAAW,gBAAgB,UAAU,WAAW,gBAAgB;IACpE,IAAI,WAAW,eAAe,UAAU,WAAW,eAAe;GACnE;AACD,UAAO;EACR,GACD,EACE,YAAY;GACV,kBAAkB;GAClB,cAAc;GACd,aAAa;EACd,EACF,EACF;CACF;CAED,MAAM,yBAAyBC,UAAyB;EACtD,IAAI,aAAa;EACjB,IAAI,mBAAmB;EACvB,IAAI,gBAAgB;AAGpB,MAAI,KAAK,UAAU,sBAAsB;GACvC,mBAAmB;GACnB,gBAAgB;EACjB,OAAM;GACL,mBAAmB;GACnB,gBAAgB;EACjB;EAED,MAAM,kBAAkB,MAAM,QAAQ,IACpC,SAAS,IAAI,OAAO,YAAY;GAC9B,MAAM,YAAY,MAAM,KAAK,aAAa,QAAQ,QAAQ;GAC1D,MAAM,YAAY,MAAM,KAAK,aAAaC,iCAAoB,QAAQ,CAAC;GACvE,MAAM,YACJ,QAAQ,SAAS,SACb,gBAAiB,MAAM,KAAK,aAAa,QAAQ,KAAK,GACtD;GACN,IAAI,QAAQ,YAAY,mBAAmB,YAAY;GAGvD,MAAM,gBAAgB;AACtB,OAAI,cAAc,UAAU,KAAK,YAC/B,SAAS;AAEX,OAAI,cAAc,mBAAmB,eACnC,SAAS;AAEX,OAAI,eAAe,kBAAkB,eAAe,MAClD,SAAS,MAAM,KAAK,aAClB,cAAc,kBAAkB,eAAe,KAChD;AAEH,OAAI,cAAc,kBAAkB,eAAe,UACjD,KAAI;IACF,SAAS,MAAM,KAAK,aAElB,KAAK,UACH,KAAK,MACH,cAAc,kBAAkB,eAAe,UAChD,CACF,CACF;GACF,SAAQ,OAAO;IACd,QAAQ,MACN,oCACA,OACA,KAAK,UAAU,cAAc,kBAAkB,cAAc,CAC9D;IACD,SAAS,MAAM,KAAK,aAClB,cAAc,kBAAkB,eAAe,UAChD;GACF;GAGH,cAAc;AACd,UAAO;EACR,EAAC,CACH;EAED,cAAc;AAEd,SAAO;GAAE;GAAY;EAAiB;CACvC;;CAGD,MAAgB,6BAA6BC,aAA+B;EAC1E,MAAM,mBAAmB,MAAM,QAAQ,IACrC,YAAY,IAAI,OAAO,eAAe;AACpC,OAAI,WAAW,QAAQ,mBAAmB,cACxC,SAAQ,MAAM,KAAK,yBAAyB,CAAC,WAAW,OAAQ,EAAC,EAC9D,gBAAgB;OAEnB,QAAO,MAAM,KAAK,aAAa,WAAW,QAAQ,QAAQ;EAE7D,EAAC,CACH;AAED,SAAO,iBAAiB,OAAO,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE;CACnD;;CAGD,MAAgB,kCACdF,UACAG,WACAC,eAIiB;EAIjB,IAAI,UAAU,MAAM,KAAK,yBAAyB,SAAS,EAAE;AAG7D,MAAI,aAAa,kBAAkB,QAAQ;GACzC,MAAM,oBAAoBC,wCACxB,UACD;GACD,UAAU,MAAM,KAAK,aAAa,kBAAkB;GACpD,UAAU;EACX;AAKD,MAAI,aAAa,SAAS,KAAK,CAAC,MAAM,EAAE,UAAU,KAAK,SAAS,EAC9D,UAAU;AAMZ,MAAI,kBAAkB,QACpB,UAAU;WACD,OAAO,kBAAkB,UAClC,UAAW,MAAM,KAAK,aAAa,cAAc,KAAK,GAAI;AAG5D,SAAO;CACR;;;;;;;;;;;;;;;;;;CAmBD,IAAI,UAAwB;AAC1B,SAAOC,yBAAS,KAAK,UAAU,CAAE;CAClC;;CAGD,AAAU,2BACRC,QACA;EACA,MAAM,gBAAgB,EAAE,GAAG,OAAQ;AACnC,MACE,CAAC,KAAK,MAAM,WAAW,QAAQ,IAC/B,CAAC,KAAK,MAAM,WAAW,SAAS,IAChC,KAAK,UAAU,SAEf;OAAI,eAAe,WAAW,OAC5B,QAAO;EACR,WACQ,cAAc,WAAW,cAClC,QAAQ,KACN,CAAC,mDAAmD,EAAE,KAAK,MAAM,gCAAgC,CAAC,CACnG;AAEH,SAAO,cAAc;CACtB;;;;;;;;;;;;;;;;;;;;CAwDD,qBAGEC,cACAC,QACA;EACA,IAAIC;EACJ,IAAIC;EAEJ,MAAM,EAAE,QAAQ,MAAM,YAAY,GAAG;GACnC,GAAG;GACH,QAAQ;EACT;AAED,MAAI,QAAQ,WAAW,UAAa,OAAO,WAAW,WACpD,OAAM,IAAI,MACR;EAIJ,MAAM,SAASC,yCAA0B,KAAK,OAAO,QAAQ,OAAO;AAEpE,MAAI,WAAW,YAAY;AACzB,4DAAuB,OAAO,EAC5B,eAAeC,uDAAuB,cAAc,OAAO;QAE3D,eAAe,IAAIC;GAErB,MAAM,oEAA4B,OAAO;GACzC,MAAM,KAAK,WAAW;IACpB,eAAe;IACf,iBAAiB,EAAE,MAAM,cAAe;IACxC,6BAA6B;KAC3B,QAAQ,EAAE,QAAQ,YAAa;KAC/B,QAAQ;MAAE,OAAO,QAAQ;MAAW,GAAG;KAAc;IACtD;GACF,EAAyB;EAC3B,WAAU,WAAW,cAAc;GAClC,MAAM,yBAAyB;IAC7B,MAAM,QAAQ;IACd,oEAAkC,OAAO;IACzC;IACA,QAAQ,QAAQ;GACjB;GACD,MAAM,oEAA4B,uBAAuB,OAAO;GAChE,MAAM,KAAK,WAAW;IACpB,eAAe;IACf,iBAAiB;KACf,MAAM;KACN,aAAa;IACd;IACD,6BAA6B;KAC3B,QAAQ,EAAE,QAAQ,cAAe;KACjC,QAAQ;MACN,OAAO,uBAAuB;MAC9B,aAAa,uBAAuB;MACpC,GAAG;KACJ;IACF;GACF,EAAyB;AAC1B,4DAAuB,OAAO,EAAE;IAC9B,MAAM,YAAYD,uDAAuB,cAAc,OAAO;IAC9D,eAAeE,0CAAe,KAC5B,CAACC,cAA8B;AAC7B,SAAI,YAAY,UAAU,kBACxB,QAAO,UAAU,kBAAkB;AAErC,YAAO;IACR,EACF;GACF,OACC,eAAe,IAAIF;EAEtB,OAAM;GACL,IAAI,eAAe,QAAQ;AAE3B,4DAAuB,OAAO,EAAE;IAC9B,MAAM,oEAA4B,OAAO;IACzC,MAAM,KAAK,WAAW;KACpB,eAAe;KACf,OAAO,CACL;MACE,MAAM;MACN,UAAU;OACR,MAAM;OACN,aAAa,aAAa;OAC1B,YAAY;MACb;KACF,CACF;KACD,aAAa;MACX,MAAM;MACN,UAAU,EACR,MAAM,aACP;KACF;KACD,6BAA6B;MAC3B,QAAQ,EAAE,QAAQ,mBAAoB;MACtC,QAAQ;OAAE,OAAO;OAAc,GAAG;MAAc;KACjD;KAED,GAAI,QAAQ,WAAW,SAAY,EAAE,QAAQ,OAAO,OAAQ,IAAG,CAAE;IAClE,EAAyB;IAC1B,eAAe,IAAIG,sEAAyB;KAC1C,cAAc;KACd,SAAS;KACT,WAAW;IACZ;GACF,OAAM;IACL,IAAIC;AACJ,QACE,OAAO,OAAO,SAAS,YACvB,OAAO,OAAO,eAAe,YAC7B,OAAO,cAAc,MACrB;KACA,2BAA2B;KAC3B,eAAe,OAAO;IACvB,OAAM;KACL,eAAgB,OAAO,SAAoB;KAC3C,2BAA2B;MACzB,MAAM;MACN,aAAc,OAAO,eAA0B;MAC/C,YAAY;KACb;IACF;IACD,MAAM,oEAA4B,OAAO;IACzC,MAAM,KAAK,WAAW;KACpB,eAAe;KACf,OAAO,CACL;MACE,MAAM;MACN,UAAU;KACX,CACF;KACD,aAAa;MACX,MAAM;MACN,UAAU,EACR,MAAM,aACP;KACF;KACD,6BAA6B;MAC3B,QAAQ,EAAE,QAAQ,mBAAoB;MACtC,QAAQ;OAAE,OAAO;OAAc,GAAG;MAAc;KACjD;KAED,GAAI,QAAQ,WAAW,SAAY,EAAE,QAAQ,OAAO,OAAQ,IAAG,CAAE;IAClE,EAAyB;IAC1B,eAAe,IAAID,sEAAoC;KACrD,cAAc;KACd,SAAS;IACV;GACF;EACF;AAED,MAAI,CAAC,WACH,QAAO,IAAI,KAAK,aAAa;EAM/B,MAAM,eAAeE,+CAAoB,OAAO,EAE9C,QAAQ,CAACC,OAAYC,aAAW,aAAa,OAAO,MAAM,KAAKA,SAAO,CACvE,EAAC;EACF,MAAM,aAAaF,+CAAoB,OAAO,EAC5C,QAAQ,MAAM,KACf,EAAC;EACF,MAAM,qBAAqB,aAAa,cAAc,EACpD,WAAW,CAAC,UAAW,EACxB,EAAC;AACF,SAAOG,4CAAiB,KAGtB,CAAC,EAAE,KAAK,IAAK,GAAE,kBAAmB,EAAC;CACtC;AACF"}
1
+ {"version":3,"file":"base.cjs","names":["BaseChatModel","options: this[\"ParsedCallOptions\"]","fields?: BaseChatOpenAIFields","options?: this[\"ParsedCallOptions\"]","isReasoningModel","reasoning: OpenAIClient.Reasoning | undefined","resFormat?: CallOptions[\"response_format\"]","interopZodResponseFormat","additionalOptions?: this[\"ParsedCallOptions\"]","options: OpenAICoreRequestOptions | undefined","openAIEndpointConfig: OpenAIEndpointConfig","getEndpoint","getHeadersWithUserAgent","OpenAIClient","tool: ChatOpenAIToolType","fields?: { strict?: boolean }","isCustomTool","convertResponsesCustomTool","_convertToOpenAITool","tools: ChatOpenAIToolType[]","kwargs?: Partial<CallOptions>","strict: boolean | undefined","isBuiltInTool","input: BaseLanguageModelInput","options?: CallOptions","messages: BaseMessage[]","messageToOpenAIRole","generations: ChatGeneration[]","functions?: OpenAIClient.Chat.ChatCompletionCreateParams.Function[]","function_call?:\n | \"none\"\n | \"auto\"\n | OpenAIClient.Chat.ChatCompletionFunctionCallOption","formatFunctionDefinitions","PROFILES","config: StructuredOutputMethodOptions<boolean>","outputSchema: InteropZodType<RunOutput> | Record<string, unknown>","config?: StructuredOutputMethodOptions<boolean>","llm: Runnable<BaseLanguageModelInput>","outputParser: Runnable<AIMessageChunk, RunOutput>","getStructuredOutputMethod","StructuredOutputParser","JsonOutputParser","RunnableLambda","aiMessage: AIMessageChunk","JsonOutputKeyToolsParser","openAIFunctionDefinition: FunctionDefinition","RunnablePassthrough","input: any","config","RunnableSequence"],"sources":["../../src/chat_models/base.ts"],"sourcesContent":["import { type ClientOptions, OpenAI as OpenAIClient } from \"openai\";\nimport { AIMessageChunk, type BaseMessage } from \"@langchain/core/messages\";\nimport { type ChatGeneration } from \"@langchain/core/outputs\";\nimport { getEnvironmentVariable } from \"@langchain/core/utils/env\";\nimport {\n BaseChatModel,\n type LangSmithParams,\n type BaseChatModelParams,\n BaseChatModelCallOptions,\n} from \"@langchain/core/language_models/chat_models\";\nimport {\n isOpenAITool as isOpenAIFunctionTool,\n type BaseFunctionCallOptions,\n type BaseLanguageModelInput,\n type FunctionDefinition,\n type StructuredOutputMethodOptions,\n} from \"@langchain/core/language_models/base\";\nimport { ModelProfile } from \"@langchain/core/language_models/profile\";\nimport {\n Runnable,\n RunnableLambda,\n RunnablePassthrough,\n RunnableSequence,\n} from \"@langchain/core/runnables\";\nimport {\n JsonOutputParser,\n StructuredOutputParser,\n} from \"@langchain/core/output_parsers\";\nimport { JsonOutputKeyToolsParser } from \"@langchain/core/output_parsers/openai_tools\";\nimport {\n getSchemaDescription,\n InteropZodType,\n isInteropZodSchema,\n} from \"@langchain/core/utils/types\";\nimport { toJsonSchema } from \"@langchain/core/utils/json_schema\";\nimport {\n type OpenAICallOptions,\n type OpenAIChatInput,\n type OpenAICoreRequestOptions,\n type ChatOpenAIResponseFormat,\n ResponseFormatConfiguration,\n OpenAIVerbosityParam,\n type OpenAIApiKey,\n} from \"../types.js\";\nimport {\n type OpenAIEndpointConfig,\n getEndpoint,\n getHeadersWithUserAgent,\n} from \"../utils/azure.js\";\nimport {\n type FunctionDef,\n formatFunctionDefinitions,\n OpenAIToolChoice,\n _convertToOpenAITool,\n ChatOpenAIToolType,\n convertResponsesCustomTool,\n isBuiltInTool,\n isCustomTool,\n ResponsesToolChoice,\n} from \"../utils/tools.js\";\nimport {\n getStructuredOutputMethod,\n interopZodResponseFormat,\n _convertOpenAIResponsesUsageToLangChainUsage,\n} from \"../utils/output.js\";\nimport { isReasoningModel, messageToOpenAIRole } from \"../utils/misc.js\";\nimport PROFILES from \"./profiles.js\";\n\ninterface OpenAILLMOutput {\n tokenUsage: {\n completionTokens?: number;\n promptTokens?: number;\n totalTokens?: number;\n };\n}\n\nexport type { OpenAICallOptions, OpenAIChatInput };\n\nexport interface BaseChatOpenAICallOptions\n extends BaseChatModelCallOptions,\n BaseFunctionCallOptions {\n /**\n * Additional options to pass to the underlying axios request.\n */\n options?: OpenAICoreRequestOptions;\n\n /**\n * A list of tools that the model may use to generate responses.\n * Each tool can be a function, a built-in tool, or a custom tool definition.\n * If not provided, the model will not use any tools.\n */\n tools?: ChatOpenAIToolType[];\n\n /**\n * Specifies which tool the model should use to respond.\n * Can be an {@link OpenAIToolChoice} or a {@link ResponsesToolChoice}.\n * If not set, the model will decide which tool to use automatically.\n */\n // TODO: break OpenAIToolChoice and ResponsesToolChoice into options sub classes\n tool_choice?: OpenAIToolChoice | ResponsesToolChoice;\n\n /**\n * Adds a prompt index to prompts passed to the model to track\n * what prompt is being used for a given generation.\n */\n promptIndex?: number;\n\n /**\n * An object specifying the format that the model must output.\n */\n response_format?: ChatOpenAIResponseFormat;\n\n /**\n * When provided, the completions API will make a best effort to sample\n * deterministically, such that repeated requests with the same `seed`\n * and parameters should return the same result.\n */\n seed?: number;\n\n /**\n * Additional options to pass to streamed completions.\n * If provided, this takes precedence over \"streamUsage\" set at\n * initialization time.\n */\n stream_options?: OpenAIClient.Chat.ChatCompletionStreamOptions;\n\n /**\n * The model may choose to call multiple functions in a single turn. You can\n * set parallel_tool_calls to false which ensures only one tool is called at most.\n * [Learn more](https://platform.openai.com/docs/guides/function-calling#parallel-function-calling)\n */\n parallel_tool_calls?: boolean;\n\n /**\n * If `true`, model output is guaranteed to exactly match the JSON Schema\n * provided in the tool definition. If `true`, the input schema will also be\n * validated according to\n * https://platform.openai.com/docs/guides/structured-outputs/supported-schemas.\n *\n * If `false`, input schema will not be validated and model output will not\n * be validated.\n *\n * If `undefined`, `strict` argument will not be passed to the model.\n */\n strict?: boolean;\n\n /**\n * Output types that you would like the model to generate for this request. Most\n * models are capable of generating text, which is the default:\n *\n * `[\"text\"]`\n *\n * The `gpt-4o-audio-preview` model can also be used to\n * [generate audio](https://platform.openai.com/docs/guides/audio). To request that\n * this model generate both text and audio responses, you can use:\n *\n * `[\"text\", \"audio\"]`\n */\n modalities?: Array<OpenAIClient.Chat.ChatCompletionModality>;\n\n /**\n * Parameters for audio output. Required when audio output is requested with\n * `modalities: [\"audio\"]`.\n * [Learn more](https://platform.openai.com/docs/guides/audio).\n */\n audio?: OpenAIClient.Chat.ChatCompletionAudioParam;\n\n /**\n * Static predicted output content, such as the content of a text file that is being regenerated.\n * [Learn more](https://platform.openai.com/docs/guides/latency-optimization#use-predicted-outputs).\n */\n prediction?: OpenAIClient.ChatCompletionPredictionContent;\n\n /**\n * Options for reasoning models.\n *\n * Note that some options, like reasoning summaries, are only available when using the responses\n * API. If these options are set, the responses API will be used to fulfill the request.\n *\n * These options will be ignored when not using a reasoning model.\n */\n reasoning?: OpenAIClient.Reasoning;\n\n /**\n * Service tier to use for this request. Can be \"auto\", \"default\", or \"flex\"\n * Specifies the service tier for prioritization and latency optimization.\n */\n service_tier?: OpenAIClient.Chat.ChatCompletionCreateParams[\"service_tier\"];\n\n /**\n * Used by OpenAI to cache responses for similar requests to optimize your cache\n * hit rates. Replaces the `user` field.\n * [Learn more](https://platform.openai.com/docs/guides/prompt-caching).\n */\n promptCacheKey?: string;\n\n /**\n * The verbosity of the model's response.\n */\n verbosity?: OpenAIVerbosityParam;\n}\n\nexport interface BaseChatOpenAIFields\n extends Partial<OpenAIChatInput>,\n BaseChatModelParams {\n /**\n * Optional configuration options for the OpenAI client.\n */\n configuration?: ClientOptions;\n}\n\n/** @internal */\nexport abstract class BaseChatOpenAI<\n CallOptions extends BaseChatOpenAICallOptions\n >\n extends BaseChatModel<CallOptions, AIMessageChunk>\n implements Partial<OpenAIChatInput>\n{\n temperature?: number;\n\n topP?: number;\n\n frequencyPenalty?: number;\n\n presencePenalty?: number;\n\n n?: number;\n\n logitBias?: Record<string, number>;\n\n model = \"gpt-3.5-turbo\";\n\n modelKwargs?: OpenAIChatInput[\"modelKwargs\"];\n\n stop?: string[];\n\n stopSequences?: string[];\n\n user?: string;\n\n timeout?: number;\n\n streaming = false;\n\n streamUsage = true;\n\n maxTokens?: number;\n\n logprobs?: boolean;\n\n topLogprobs?: number;\n\n apiKey?: OpenAIApiKey;\n\n organization?: string;\n\n __includeRawResponse?: boolean;\n\n /** @internal */\n client: OpenAIClient;\n\n /** @internal */\n clientConfig: ClientOptions;\n\n /**\n * Whether the model supports the `strict` argument when passing in tools.\n * If `undefined` the `strict` argument will not be passed to OpenAI.\n */\n supportsStrictToolCalling?: boolean;\n\n audio?: OpenAIClient.Chat.ChatCompletionAudioParam;\n\n modalities?: Array<OpenAIClient.Chat.ChatCompletionModality>;\n\n reasoning?: OpenAIClient.Reasoning;\n\n /**\n * Must be set to `true` in tenancies with Zero Data Retention. Setting to `true` will disable\n * output storage in the Responses API, but this DOES NOT enable Zero Data Retention in your\n * OpenAI organization or project. This must be configured directly with OpenAI.\n *\n * See:\n * https://platform.openai.com/docs/guides/your-data\n * https://platform.openai.com/docs/api-reference/responses/create#responses-create-store\n *\n * @default false\n */\n zdrEnabled?: boolean | undefined;\n\n /**\n * Service tier to use for this request. Can be \"auto\", \"default\", or \"flex\" or \"priority\".\n * Specifies the service tier for prioritization and latency optimization.\n */\n service_tier?: OpenAIClient.Chat.ChatCompletionCreateParams[\"service_tier\"];\n\n /**\n * Used by OpenAI to cache responses for similar requests to optimize your cache\n * hit rates.\n * [Learn more](https://platform.openai.com/docs/guides/prompt-caching).\n */\n promptCacheKey: string;\n\n /**\n * The verbosity of the model's response.\n */\n verbosity?: OpenAIVerbosityParam;\n\n protected defaultOptions: CallOptions;\n\n _llmType() {\n return \"openai\";\n }\n\n static lc_name() {\n return \"ChatOpenAI\";\n }\n\n get callKeys() {\n return [\n ...super.callKeys,\n \"options\",\n \"function_call\",\n \"functions\",\n \"tools\",\n \"tool_choice\",\n \"promptIndex\",\n \"response_format\",\n \"seed\",\n \"reasoning\",\n \"service_tier\",\n ];\n }\n\n lc_serializable = true;\n\n get lc_secrets(): { [key: string]: string } | undefined {\n return {\n apiKey: \"OPENAI_API_KEY\",\n organization: \"OPENAI_ORGANIZATION\",\n };\n }\n\n get lc_aliases(): Record<string, string> {\n return {\n apiKey: \"openai_api_key\",\n modelName: \"model\",\n };\n }\n\n get lc_serializable_keys(): string[] {\n return [\n \"configuration\",\n \"logprobs\",\n \"topLogprobs\",\n \"prefixMessages\",\n \"supportsStrictToolCalling\",\n \"modalities\",\n \"audio\",\n \"temperature\",\n \"maxTokens\",\n \"topP\",\n \"frequencyPenalty\",\n \"presencePenalty\",\n \"n\",\n \"logitBias\",\n \"user\",\n \"streaming\",\n \"streamUsage\",\n \"model\",\n \"modelName\",\n \"modelKwargs\",\n \"stop\",\n \"stopSequences\",\n \"timeout\",\n \"apiKey\",\n \"cache\",\n \"maxConcurrency\",\n \"maxRetries\",\n \"verbose\",\n \"callbacks\",\n \"tags\",\n \"metadata\",\n \"disableStreaming\",\n \"zdrEnabled\",\n \"reasoning\",\n \"promptCacheKey\",\n \"verbosity\",\n ];\n }\n\n getLsParams(options: this[\"ParsedCallOptions\"]): LangSmithParams {\n const params = this.invocationParams(options);\n return {\n ls_provider: \"openai\",\n ls_model_name: this.model,\n ls_model_type: \"chat\",\n ls_temperature: params.temperature ?? undefined,\n ls_max_tokens: params.max_tokens ?? undefined,\n ls_stop: options.stop,\n };\n }\n\n /** @ignore */\n _identifyingParams(): Omit<\n OpenAIClient.Chat.ChatCompletionCreateParams,\n \"messages\"\n > & {\n model_name: string;\n } & ClientOptions {\n return {\n model_name: this.model,\n ...this.invocationParams(),\n ...this.clientConfig,\n };\n }\n\n /**\n * Get the identifying parameters for the model\n */\n identifyingParams() {\n return this._identifyingParams();\n }\n\n constructor(fields?: BaseChatOpenAIFields) {\n super(fields ?? {});\n\n const configApiKey =\n typeof fields?.configuration?.apiKey === \"string\" ||\n typeof fields?.configuration?.apiKey === \"function\"\n ? fields?.configuration?.apiKey\n : undefined;\n this.apiKey =\n fields?.apiKey ??\n configApiKey ??\n getEnvironmentVariable(\"OPENAI_API_KEY\");\n this.organization =\n fields?.configuration?.organization ??\n getEnvironmentVariable(\"OPENAI_ORGANIZATION\");\n\n this.model = fields?.model ?? fields?.modelName ?? this.model;\n this.modelKwargs = fields?.modelKwargs ?? {};\n this.timeout = fields?.timeout;\n\n this.temperature = fields?.temperature ?? this.temperature;\n this.topP = fields?.topP ?? this.topP;\n this.frequencyPenalty = fields?.frequencyPenalty ?? this.frequencyPenalty;\n this.presencePenalty = fields?.presencePenalty ?? this.presencePenalty;\n this.logprobs = fields?.logprobs;\n this.topLogprobs = fields?.topLogprobs;\n this.n = fields?.n ?? this.n;\n this.logitBias = fields?.logitBias;\n this.stop = fields?.stopSequences ?? fields?.stop;\n this.stopSequences = this.stop;\n this.user = fields?.user;\n this.__includeRawResponse = fields?.__includeRawResponse;\n this.audio = fields?.audio;\n this.modalities = fields?.modalities;\n this.reasoning = fields?.reasoning;\n this.maxTokens = fields?.maxCompletionTokens ?? fields?.maxTokens;\n this.promptCacheKey = fields?.promptCacheKey ?? this.promptCacheKey;\n this.verbosity = fields?.verbosity ?? this.verbosity;\n\n this.disableStreaming = fields?.disableStreaming === true;\n this.streaming = fields?.streaming === true;\n if (this.disableStreaming) this.streaming = false;\n // disable streaming in BaseChatModel if explicitly disabled\n if (fields?.streaming === false) this.disableStreaming = true;\n\n this.streamUsage = fields?.streamUsage ?? this.streamUsage;\n if (this.disableStreaming) this.streamUsage = false;\n\n this.clientConfig = {\n apiKey: this.apiKey,\n organization: this.organization,\n dangerouslyAllowBrowser: true,\n ...fields?.configuration,\n };\n\n // If `supportsStrictToolCalling` is explicitly set, use that value.\n // Else leave undefined so it's not passed to OpenAI.\n if (fields?.supportsStrictToolCalling !== undefined) {\n this.supportsStrictToolCalling = fields.supportsStrictToolCalling;\n }\n\n if (fields?.service_tier !== undefined) {\n this.service_tier = fields.service_tier;\n }\n\n this.zdrEnabled = fields?.zdrEnabled ?? false;\n }\n\n /**\n * Returns backwards compatible reasoning parameters from constructor params and call options\n * @internal\n */\n protected _getReasoningParams(\n options?: this[\"ParsedCallOptions\"]\n ): OpenAIClient.Reasoning | undefined {\n if (!isReasoningModel(this.model)) {\n return;\n }\n\n // apply options in reverse order of importance -- newer options supersede older options\n let reasoning: OpenAIClient.Reasoning | undefined;\n if (this.reasoning !== undefined) {\n reasoning = {\n ...reasoning,\n ...this.reasoning,\n };\n }\n if (options?.reasoning !== undefined) {\n reasoning = {\n ...reasoning,\n ...options.reasoning,\n };\n }\n\n return reasoning;\n }\n\n /**\n * Returns an openai compatible response format from a set of options\n * @internal\n */\n protected _getResponseFormat(\n resFormat?: CallOptions[\"response_format\"]\n ): ResponseFormatConfiguration | undefined {\n if (\n resFormat &&\n resFormat.type === \"json_schema\" &&\n resFormat.json_schema.schema &&\n isInteropZodSchema(resFormat.json_schema.schema)\n ) {\n return interopZodResponseFormat(\n resFormat.json_schema.schema,\n resFormat.json_schema.name,\n {\n description: resFormat.json_schema.description,\n }\n );\n }\n return resFormat as ResponseFormatConfiguration | undefined;\n }\n\n protected _combineCallOptions(\n additionalOptions?: this[\"ParsedCallOptions\"]\n ): this[\"ParsedCallOptions\"] {\n return {\n ...this.defaultOptions,\n ...(additionalOptions ?? {}),\n };\n }\n\n /** @internal */\n _getClientOptions(\n options: OpenAICoreRequestOptions | undefined\n ): OpenAICoreRequestOptions {\n if (!this.client) {\n const openAIEndpointConfig: OpenAIEndpointConfig = {\n baseURL: this.clientConfig.baseURL,\n };\n\n const endpoint = getEndpoint(openAIEndpointConfig);\n const params = {\n ...this.clientConfig,\n baseURL: endpoint,\n timeout: this.timeout,\n maxRetries: 0,\n };\n if (!params.baseURL) {\n delete params.baseURL;\n }\n\n params.defaultHeaders = getHeadersWithUserAgent(params.defaultHeaders);\n\n this.client = new OpenAIClient(params);\n }\n const requestOptions = {\n ...this.clientConfig,\n ...options,\n } as OpenAICoreRequestOptions;\n return requestOptions;\n }\n\n // TODO: move to completions class\n protected _convertChatOpenAIToolToCompletionsTool(\n tool: ChatOpenAIToolType,\n fields?: { strict?: boolean }\n ): OpenAIClient.ChatCompletionTool {\n if (isCustomTool(tool)) {\n return convertResponsesCustomTool(tool.metadata.customTool);\n }\n if (isOpenAIFunctionTool(tool)) {\n if (fields?.strict !== undefined) {\n return {\n ...tool,\n function: {\n ...tool.function,\n strict: fields.strict,\n },\n };\n }\n\n return tool;\n }\n return _convertToOpenAITool(tool, fields);\n }\n\n override bindTools(\n tools: ChatOpenAIToolType[],\n kwargs?: Partial<CallOptions>\n ): Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions> {\n let strict: boolean | undefined;\n if (kwargs?.strict !== undefined) {\n strict = kwargs.strict;\n } else if (this.supportsStrictToolCalling !== undefined) {\n strict = this.supportsStrictToolCalling;\n }\n return this.withConfig({\n tools: tools.map((tool) =>\n isBuiltInTool(tool) || isCustomTool(tool)\n ? tool\n : this._convertChatOpenAIToolToCompletionsTool(tool, { strict })\n ),\n ...kwargs,\n } as Partial<CallOptions>);\n }\n\n override async stream(input: BaseLanguageModelInput, options?: CallOptions) {\n return super.stream(\n input,\n this._combineCallOptions(options) as CallOptions\n );\n }\n\n override async invoke(input: BaseLanguageModelInput, options?: CallOptions) {\n return super.invoke(\n input,\n this._combineCallOptions(options) as CallOptions\n );\n }\n\n /** @ignore */\n _combineLLMOutput(...llmOutputs: OpenAILLMOutput[]): OpenAILLMOutput {\n return llmOutputs.reduce<{\n [key in keyof OpenAILLMOutput]: Required<OpenAILLMOutput[key]>;\n }>(\n (acc, llmOutput) => {\n if (llmOutput && llmOutput.tokenUsage) {\n acc.tokenUsage.completionTokens +=\n llmOutput.tokenUsage.completionTokens ?? 0;\n acc.tokenUsage.promptTokens += llmOutput.tokenUsage.promptTokens ?? 0;\n acc.tokenUsage.totalTokens += llmOutput.tokenUsage.totalTokens ?? 0;\n }\n return acc;\n },\n {\n tokenUsage: {\n completionTokens: 0,\n promptTokens: 0,\n totalTokens: 0,\n },\n }\n );\n }\n\n async getNumTokensFromMessages(messages: BaseMessage[]) {\n let totalCount = 0;\n let tokensPerMessage = 0;\n let tokensPerName = 0;\n\n // From: https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb\n if (this.model === \"gpt-3.5-turbo-0301\") {\n tokensPerMessage = 4;\n tokensPerName = -1;\n } else {\n tokensPerMessage = 3;\n tokensPerName = 1;\n }\n\n const countPerMessage = await Promise.all(\n messages.map(async (message) => {\n const textCount = await this.getNumTokens(message.content);\n const roleCount = await this.getNumTokens(messageToOpenAIRole(message));\n const nameCount =\n message.name !== undefined\n ? tokensPerName + (await this.getNumTokens(message.name))\n : 0;\n let count = textCount + tokensPerMessage + roleCount + nameCount;\n\n // From: https://github.com/hmarr/openai-chat-tokens/blob/main/src/index.ts messageTokenEstimate\n const openAIMessage = message;\n if (openAIMessage._getType() === \"function\") {\n count -= 2;\n }\n if (openAIMessage.additional_kwargs?.function_call) {\n count += 3;\n }\n if (openAIMessage?.additional_kwargs.function_call?.name) {\n count += await this.getNumTokens(\n openAIMessage.additional_kwargs.function_call?.name\n );\n }\n if (openAIMessage.additional_kwargs.function_call?.arguments) {\n try {\n count += await this.getNumTokens(\n // Remove newlines and spaces\n JSON.stringify(\n JSON.parse(\n openAIMessage.additional_kwargs.function_call?.arguments\n )\n )\n );\n } catch (error) {\n console.error(\n \"Error parsing function arguments\",\n error,\n JSON.stringify(openAIMessage.additional_kwargs.function_call)\n );\n count += await this.getNumTokens(\n openAIMessage.additional_kwargs.function_call?.arguments\n );\n }\n }\n\n totalCount += count;\n return count;\n })\n );\n\n totalCount += 3; // every reply is primed with <|start|>assistant<|message|>\n\n return { totalCount, countPerMessage };\n }\n\n /** @internal */\n protected async _getNumTokensFromGenerations(generations: ChatGeneration[]) {\n const generationUsages = await Promise.all(\n generations.map(async (generation) => {\n if (generation.message.additional_kwargs?.function_call) {\n return (await this.getNumTokensFromMessages([generation.message]))\n .countPerMessage[0];\n } else {\n return await this.getNumTokens(generation.message.content);\n }\n })\n );\n\n return generationUsages.reduce((a, b) => a + b, 0);\n }\n\n /** @internal */\n protected async _getEstimatedTokenCountFromPrompt(\n messages: BaseMessage[],\n functions?: OpenAIClient.Chat.ChatCompletionCreateParams.Function[],\n function_call?:\n | \"none\"\n | \"auto\"\n | OpenAIClient.Chat.ChatCompletionFunctionCallOption\n ): Promise<number> {\n // It appears that if functions are present, the first system message is padded with a trailing newline. This\n // was inferred by trying lots of combinations of messages and functions and seeing what the token counts were.\n\n let tokens = (await this.getNumTokensFromMessages(messages)).totalCount;\n\n // If there are functions, add the function definitions as they count towards token usage\n if (functions && function_call !== \"auto\") {\n const promptDefinitions = formatFunctionDefinitions(\n functions as unknown as FunctionDef[]\n );\n tokens += await this.getNumTokens(promptDefinitions);\n tokens += 9; // Add nine per completion\n }\n\n // If there's a system message _and_ functions are present, subtract four tokens. I assume this is because\n // functions typically add a system message, but reuse the first one if it's already there. This offsets\n // the extra 9 tokens added by the function definitions.\n if (functions && messages.find((m) => m._getType() === \"system\")) {\n tokens -= 4;\n }\n\n // If function_call is 'none', add one token.\n // If it's a FunctionCall object, add 4 + the number of tokens in the function name.\n // If it's undefined or 'auto', don't add anything.\n if (function_call === \"none\") {\n tokens += 1;\n } else if (typeof function_call === \"object\") {\n tokens += (await this.getNumTokens(function_call.name)) + 4;\n }\n\n return tokens;\n }\n\n /**\n * Return profiling information for the model.\n *\n * Provides information about the model's capabilities and constraints,\n * including token limits, multimodal support, and advanced features like\n * tool calling and structured output.\n *\n * @returns {ModelProfile} An object describing the model's capabilities and constraints\n *\n * @example\n * ```typescript\n * const model = new ChatOpenAI({ model: \"gpt-4o\" });\n * const profile = model.profile;\n * console.log(profile.maxInputTokens); // 128000\n * console.log(profile.imageInputs); // true\n * ```\n */\n get profile(): ModelProfile {\n return PROFILES[this.model] ?? {};\n }\n\n /** @internal */\n protected _getStructuredOutputMethod(\n config: StructuredOutputMethodOptions<boolean>\n ) {\n const ensuredConfig = { ...config };\n if (\n !this.model.startsWith(\"gpt-3\") &&\n !this.model.startsWith(\"gpt-4-\") &&\n this.model !== \"gpt-4\"\n ) {\n if (ensuredConfig?.method === undefined) {\n return \"jsonSchema\";\n }\n } else if (ensuredConfig.method === \"jsonSchema\") {\n console.warn(\n `[WARNING]: JSON Schema is not supported for model \"${this.model}\". Falling back to tool calling.`\n );\n }\n return ensuredConfig.method;\n }\n\n withStructuredOutput<\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n RunOutput extends Record<string, any> = Record<string, any>\n >(\n outputSchema:\n | InteropZodType<RunOutput>\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n | Record<string, any>,\n config?: StructuredOutputMethodOptions<false>\n ): Runnable<BaseLanguageModelInput, RunOutput>;\n\n withStructuredOutput<\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n RunOutput extends Record<string, any> = Record<string, any>\n >(\n outputSchema:\n | InteropZodType<RunOutput>\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n | Record<string, any>,\n config?: StructuredOutputMethodOptions<true>\n ): Runnable<BaseLanguageModelInput, { raw: BaseMessage; parsed: RunOutput }>;\n\n withStructuredOutput<\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n RunOutput extends Record<string, any> = Record<string, any>\n >(\n outputSchema:\n | InteropZodType<RunOutput>\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n | Record<string, any>,\n config?: StructuredOutputMethodOptions<boolean>\n ):\n | Runnable<BaseLanguageModelInput, RunOutput>\n | Runnable<BaseLanguageModelInput, { raw: BaseMessage; parsed: RunOutput }>;\n\n /**\n * Add structured output to the model.\n *\n * The OpenAI model family supports the following structured output methods:\n * - `jsonSchema`: Use the `response_format` field in the response to return a JSON schema. Only supported with the `gpt-4o-mini`,\n * `gpt-4o-mini-2024-07-18`, and `gpt-4o-2024-08-06` model snapshots and later.\n * - `functionCalling`: Function calling is useful when you are building an application that bridges the models and functionality\n * of your application.\n * - `jsonMode`: JSON mode is a more basic version of the Structured Outputs feature. While JSON mode ensures that model\n * output is valid JSON, Structured Outputs reliably matches the model's output to the schema you specify.\n * We recommend you use `functionCalling` or `jsonSchema` if it is supported for your use case.\n *\n * The default method is `functionCalling`.\n *\n * @see https://platform.openai.com/docs/guides/structured-outputs\n * @param outputSchema - The schema to use for structured output.\n * @param config - The structured output method options.\n * @returns The model with structured output.\n */\n withStructuredOutput<\n RunOutput extends Record<string, unknown> = Record<string, unknown>\n >(\n outputSchema: InteropZodType<RunOutput> | Record<string, unknown>,\n config?: StructuredOutputMethodOptions<boolean>\n ) {\n let llm: Runnable<BaseLanguageModelInput>;\n let outputParser: Runnable<AIMessageChunk, RunOutput>;\n\n const { schema, name, includeRaw } = {\n ...config,\n schema: outputSchema,\n };\n\n if (config?.strict !== undefined && config.method === \"jsonMode\") {\n throw new Error(\n \"Argument `strict` is only supported for `method` = 'function_calling'\"\n );\n }\n\n const method = getStructuredOutputMethod(this.model, config?.method);\n\n if (method === \"jsonMode\") {\n if (isInteropZodSchema(schema)) {\n outputParser = StructuredOutputParser.fromZodSchema(schema);\n } else {\n outputParser = new JsonOutputParser<RunOutput>();\n }\n const asJsonSchema = toJsonSchema(schema);\n llm = this.withConfig({\n outputVersion: \"v0\",\n response_format: { type: \"json_object\" },\n ls_structured_output_format: {\n kwargs: { method: \"json_mode\" },\n schema: { title: name ?? \"extract\", ...asJsonSchema },\n },\n } as Partial<CallOptions>);\n } else if (method === \"jsonSchema\") {\n const openaiJsonSchemaParams = {\n name: name ?? \"extract\",\n description: getSchemaDescription(schema),\n schema,\n strict: config?.strict,\n };\n const asJsonSchema = toJsonSchema(openaiJsonSchemaParams.schema);\n llm = this.withConfig({\n outputVersion: \"v0\",\n response_format: {\n type: \"json_schema\",\n json_schema: openaiJsonSchemaParams,\n },\n ls_structured_output_format: {\n kwargs: { method: \"json_schema\" },\n schema: {\n title: openaiJsonSchemaParams.name,\n description: openaiJsonSchemaParams.description,\n ...asJsonSchema,\n },\n },\n } as Partial<CallOptions>);\n if (isInteropZodSchema(schema)) {\n const altParser = StructuredOutputParser.fromZodSchema(schema);\n outputParser = RunnableLambda.from<AIMessageChunk, RunOutput>(\n (aiMessage: AIMessageChunk) => {\n if (\"parsed\" in aiMessage.additional_kwargs) {\n return aiMessage.additional_kwargs.parsed as RunOutput;\n }\n return altParser;\n }\n );\n } else {\n outputParser = new JsonOutputParser<RunOutput>();\n }\n } else {\n let functionName = name ?? \"extract\";\n // Is function calling\n if (isInteropZodSchema(schema)) {\n const asJsonSchema = toJsonSchema(schema);\n llm = this.withConfig({\n outputVersion: \"v0\",\n tools: [\n {\n type: \"function\" as const,\n function: {\n name: functionName,\n description: asJsonSchema.description,\n parameters: asJsonSchema,\n },\n },\n ],\n tool_choice: {\n type: \"function\" as const,\n function: {\n name: functionName,\n },\n },\n ls_structured_output_format: {\n kwargs: { method: \"function_calling\" },\n schema: { title: functionName, ...asJsonSchema },\n },\n // Do not pass `strict` argument to OpenAI if `config.strict` is undefined\n ...(config?.strict !== undefined ? { strict: config.strict } : {}),\n } as Partial<CallOptions>);\n outputParser = new JsonOutputKeyToolsParser({\n returnSingle: true,\n keyName: functionName,\n zodSchema: schema,\n });\n } else {\n let openAIFunctionDefinition: FunctionDefinition;\n if (\n typeof schema.name === \"string\" &&\n typeof schema.parameters === \"object\" &&\n schema.parameters != null\n ) {\n openAIFunctionDefinition = schema as unknown as FunctionDefinition;\n functionName = schema.name;\n } else {\n functionName = (schema.title as string) ?? functionName;\n openAIFunctionDefinition = {\n name: functionName,\n description: (schema.description as string) ?? \"\",\n parameters: schema,\n };\n }\n const asJsonSchema = toJsonSchema(schema);\n llm = this.withConfig({\n outputVersion: \"v0\",\n tools: [\n {\n type: \"function\" as const,\n function: openAIFunctionDefinition,\n },\n ],\n tool_choice: {\n type: \"function\" as const,\n function: {\n name: functionName,\n },\n },\n ls_structured_output_format: {\n kwargs: { method: \"function_calling\" },\n schema: { title: functionName, ...asJsonSchema },\n },\n // Do not pass `strict` argument to OpenAI if `config.strict` is undefined\n ...(config?.strict !== undefined ? { strict: config.strict } : {}),\n } as Partial<CallOptions>);\n outputParser = new JsonOutputKeyToolsParser<RunOutput>({\n returnSingle: true,\n keyName: functionName,\n });\n }\n }\n\n if (!includeRaw) {\n return llm.pipe(outputParser) as Runnable<\n BaseLanguageModelInput,\n RunOutput\n >;\n }\n\n const parserAssign = RunnablePassthrough.assign({\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n parsed: (input: any, config) => outputParser.invoke(input.raw, config),\n });\n const parserNone = RunnablePassthrough.assign({\n parsed: () => null,\n });\n const parsedWithFallback = parserAssign.withFallbacks({\n fallbacks: [parserNone],\n });\n return RunnableSequence.from<\n BaseLanguageModelInput,\n { raw: BaseMessage; parsed: RunOutput }\n >([{ raw: llm }, parsedWithFallback]);\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAoNA,IAAsB,iBAAtB,cAGUA,2DAEV;CACE;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA,QAAQ;CAER;CAEA;CAEA;CAEA;CAEA;CAEA,YAAY;CAEZ,cAAc;CAEd;CAEA;CAEA;CAEA;CAEA;CAEA;;CAGA;;CAGA;;;;;CAMA;CAEA;CAEA;CAEA;;;;;;;;;;;;CAaA;;;;;CAMA;;;;;;CAOA;;;;CAKA;CAEA,AAAU;CAEV,WAAW;AACT,SAAO;CACR;CAED,OAAO,UAAU;AACf,SAAO;CACR;CAED,IAAI,WAAW;AACb,SAAO;GACL,GAAG,MAAM;GACT;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;EACD;CACF;CAED,kBAAkB;CAElB,IAAI,aAAoD;AACtD,SAAO;GACL,QAAQ;GACR,cAAc;EACf;CACF;CAED,IAAI,aAAqC;AACvC,SAAO;GACL,QAAQ;GACR,WAAW;EACZ;CACF;CAED,IAAI,uBAAiC;AACnC,SAAO;GACL;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;EACD;CACF;CAED,YAAYC,SAAqD;EAC/D,MAAM,SAAS,KAAK,iBAAiB,QAAQ;AAC7C,SAAO;GACL,aAAa;GACb,eAAe,KAAK;GACpB,eAAe;GACf,gBAAgB,OAAO,eAAe;GACtC,eAAe,OAAO,cAAc;GACpC,SAAS,QAAQ;EAClB;CACF;;CAGD,qBAKkB;AAChB,SAAO;GACL,YAAY,KAAK;GACjB,GAAG,KAAK,kBAAkB;GAC1B,GAAG,KAAK;EACT;CACF;;;;CAKD,oBAAoB;AAClB,SAAO,KAAK,oBAAoB;CACjC;CAED,YAAYC,QAA+B;EACzC,MAAM,UAAU,CAAE,EAAC;EAEnB,MAAM,eACJ,OAAO,QAAQ,eAAe,WAAW,YACzC,OAAO,QAAQ,eAAe,WAAW,aACrC,QAAQ,eAAe,SACvB;EACN,KAAK,SACH,QAAQ,UACR,uEACuB,iBAAiB;EAC1C,KAAK,eACH,QAAQ,eAAe,uEACA,sBAAsB;EAE/C,KAAK,QAAQ,QAAQ,SAAS,QAAQ,aAAa,KAAK;EACxD,KAAK,cAAc,QAAQ,eAAe,CAAE;EAC5C,KAAK,UAAU,QAAQ;EAEvB,KAAK,cAAc,QAAQ,eAAe,KAAK;EAC/C,KAAK,OAAO,QAAQ,QAAQ,KAAK;EACjC,KAAK,mBAAmB,QAAQ,oBAAoB,KAAK;EACzD,KAAK,kBAAkB,QAAQ,mBAAmB,KAAK;EACvD,KAAK,WAAW,QAAQ;EACxB,KAAK,cAAc,QAAQ;EAC3B,KAAK,IAAI,QAAQ,KAAK,KAAK;EAC3B,KAAK,YAAY,QAAQ;EACzB,KAAK,OAAO,QAAQ,iBAAiB,QAAQ;EAC7C,KAAK,gBAAgB,KAAK;EAC1B,KAAK,OAAO,QAAQ;EACpB,KAAK,uBAAuB,QAAQ;EACpC,KAAK,QAAQ,QAAQ;EACrB,KAAK,aAAa,QAAQ;EAC1B,KAAK,YAAY,QAAQ;EACzB,KAAK,YAAY,QAAQ,uBAAuB,QAAQ;EACxD,KAAK,iBAAiB,QAAQ,kBAAkB,KAAK;EACrD,KAAK,YAAY,QAAQ,aAAa,KAAK;EAE3C,KAAK,mBAAmB,QAAQ,qBAAqB;EACrD,KAAK,YAAY,QAAQ,cAAc;AACvC,MAAI,KAAK,kBAAkB,KAAK,YAAY;AAE5C,MAAI,QAAQ,cAAc,OAAO,KAAK,mBAAmB;EAEzD,KAAK,cAAc,QAAQ,eAAe,KAAK;AAC/C,MAAI,KAAK,kBAAkB,KAAK,cAAc;EAE9C,KAAK,eAAe;GAClB,QAAQ,KAAK;GACb,cAAc,KAAK;GACnB,yBAAyB;GACzB,GAAG,QAAQ;EACZ;AAID,MAAI,QAAQ,8BAA8B,QACxC,KAAK,4BAA4B,OAAO;AAG1C,MAAI,QAAQ,iBAAiB,QAC3B,KAAK,eAAe,OAAO;EAG7B,KAAK,aAAa,QAAQ,cAAc;CACzC;;;;;CAMD,AAAU,oBACRC,SACoC;AACpC,MAAI,CAACC,8BAAiB,KAAK,MAAM,CAC/B;EAIF,IAAIC;AACJ,MAAI,KAAK,cAAc,QACrB,YAAY;GACV,GAAG;GACH,GAAG,KAAK;EACT;AAEH,MAAI,SAAS,cAAc,QACzB,YAAY;GACV,GAAG;GACH,GAAG,QAAQ;EACZ;AAGH,SAAO;CACR;;;;;CAMD,AAAU,mBACRC,WACyC;AACzC,MACE,aACA,UAAU,SAAS,iBACnB,UAAU,YAAY,+DACH,UAAU,YAAY,OAAO,CAEhD,QAAOC,wCACL,UAAU,YAAY,QACtB,UAAU,YAAY,MACtB,EACE,aAAa,UAAU,YAAY,YACpC,EACF;AAEH,SAAO;CACR;CAED,AAAU,oBACRC,mBAC2B;AAC3B,SAAO;GACL,GAAG,KAAK;GACR,GAAI,qBAAqB,CAAE;EAC5B;CACF;;CAGD,kBACEC,SAC0B;AAC1B,MAAI,CAAC,KAAK,QAAQ;GAChB,MAAMC,uBAA6C,EACjD,SAAS,KAAK,aAAa,QAC5B;GAED,MAAM,WAAWC,0BAAY,qBAAqB;GAClD,MAAM,SAAS;IACb,GAAG,KAAK;IACR,SAAS;IACT,SAAS,KAAK;IACd,YAAY;GACb;AACD,OAAI,CAAC,OAAO,SACV,OAAO,OAAO;GAGhB,OAAO,iBAAiBC,sCAAwB,OAAO,eAAe;GAEtE,KAAK,SAAS,IAAIC,cAAa;EAChC;EACD,MAAM,iBAAiB;GACrB,GAAG,KAAK;GACR,GAAG;EACJ;AACD,SAAO;CACR;CAGD,AAAU,wCACRC,MACAC,QACiC;AACjC,MAAIC,2BAAa,KAAK,CACpB,QAAOC,yCAA2B,KAAK,SAAS,WAAW;AAE7D,8DAAyB,KAAK,EAAE;AAC9B,OAAI,QAAQ,WAAW,OACrB,QAAO;IACL,GAAG;IACH,UAAU;KACR,GAAG,KAAK;KACR,QAAQ,OAAO;IAChB;GACF;AAGH,UAAO;EACR;AACD,SAAOC,mCAAqB,MAAM,OAAO;CAC1C;CAED,AAAS,UACPC,OACAC,QAC+D;EAC/D,IAAIC;AACJ,MAAI,QAAQ,WAAW,QACrB,SAAS,OAAO;WACP,KAAK,8BAA8B,QAC5C,SAAS,KAAK;AAEhB,SAAO,KAAK,WAAW;GACrB,OAAO,MAAM,IAAI,CAAC,SAChBC,4BAAc,KAAK,IAAIN,2BAAa,KAAK,GACrC,OACA,KAAK,wCAAwC,MAAM,EAAE,OAAQ,EAAC,CACnE;GACD,GAAG;EACJ,EAAyB;CAC3B;CAED,MAAe,OAAOO,OAA+BC,SAAuB;AAC1E,SAAO,MAAM,OACX,OACA,KAAK,oBAAoB,QAAQ,CAClC;CACF;CAED,MAAe,OAAOD,OAA+BC,SAAuB;AAC1E,SAAO,MAAM,OACX,OACA,KAAK,oBAAoB,QAAQ,CAClC;CACF;;CAGD,kBAAkB,GAAG,YAAgD;AACnE,SAAO,WAAW,OAGhB,CAAC,KAAK,cAAc;AAClB,OAAI,aAAa,UAAU,YAAY;IACrC,IAAI,WAAW,oBACb,UAAU,WAAW,oBAAoB;IAC3C,IAAI,WAAW,gBAAgB,UAAU,WAAW,gBAAgB;IACpE,IAAI,WAAW,eAAe,UAAU,WAAW,eAAe;GACnE;AACD,UAAO;EACR,GACD,EACE,YAAY;GACV,kBAAkB;GAClB,cAAc;GACd,aAAa;EACd,EACF,EACF;CACF;CAED,MAAM,yBAAyBC,UAAyB;EACtD,IAAI,aAAa;EACjB,IAAI,mBAAmB;EACvB,IAAI,gBAAgB;AAGpB,MAAI,KAAK,UAAU,sBAAsB;GACvC,mBAAmB;GACnB,gBAAgB;EACjB,OAAM;GACL,mBAAmB;GACnB,gBAAgB;EACjB;EAED,MAAM,kBAAkB,MAAM,QAAQ,IACpC,SAAS,IAAI,OAAO,YAAY;GAC9B,MAAM,YAAY,MAAM,KAAK,aAAa,QAAQ,QAAQ;GAC1D,MAAM,YAAY,MAAM,KAAK,aAAaC,iCAAoB,QAAQ,CAAC;GACvE,MAAM,YACJ,QAAQ,SAAS,SACb,gBAAiB,MAAM,KAAK,aAAa,QAAQ,KAAK,GACtD;GACN,IAAI,QAAQ,YAAY,mBAAmB,YAAY;GAGvD,MAAM,gBAAgB;AACtB,OAAI,cAAc,UAAU,KAAK,YAC/B,SAAS;AAEX,OAAI,cAAc,mBAAmB,eACnC,SAAS;AAEX,OAAI,eAAe,kBAAkB,eAAe,MAClD,SAAS,MAAM,KAAK,aAClB,cAAc,kBAAkB,eAAe,KAChD;AAEH,OAAI,cAAc,kBAAkB,eAAe,UACjD,KAAI;IACF,SAAS,MAAM,KAAK,aAElB,KAAK,UACH,KAAK,MACH,cAAc,kBAAkB,eAAe,UAChD,CACF,CACF;GACF,SAAQ,OAAO;IACd,QAAQ,MACN,oCACA,OACA,KAAK,UAAU,cAAc,kBAAkB,cAAc,CAC9D;IACD,SAAS,MAAM,KAAK,aAClB,cAAc,kBAAkB,eAAe,UAChD;GACF;GAGH,cAAc;AACd,UAAO;EACR,EAAC,CACH;EAED,cAAc;AAEd,SAAO;GAAE;GAAY;EAAiB;CACvC;;CAGD,MAAgB,6BAA6BC,aAA+B;EAC1E,MAAM,mBAAmB,MAAM,QAAQ,IACrC,YAAY,IAAI,OAAO,eAAe;AACpC,OAAI,WAAW,QAAQ,mBAAmB,cACxC,SAAQ,MAAM,KAAK,yBAAyB,CAAC,WAAW,OAAQ,EAAC,EAC9D,gBAAgB;OAEnB,QAAO,MAAM,KAAK,aAAa,WAAW,QAAQ,QAAQ;EAE7D,EAAC,CACH;AAED,SAAO,iBAAiB,OAAO,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE;CACnD;;CAGD,MAAgB,kCACdF,UACAG,WACAC,eAIiB;EAIjB,IAAI,UAAU,MAAM,KAAK,yBAAyB,SAAS,EAAE;AAG7D,MAAI,aAAa,kBAAkB,QAAQ;GACzC,MAAM,oBAAoBC,wCACxB,UACD;GACD,UAAU,MAAM,KAAK,aAAa,kBAAkB;GACpD,UAAU;EACX;AAKD,MAAI,aAAa,SAAS,KAAK,CAAC,MAAM,EAAE,UAAU,KAAK,SAAS,EAC9D,UAAU;AAMZ,MAAI,kBAAkB,QACpB,UAAU;WACD,OAAO,kBAAkB,UAClC,UAAW,MAAM,KAAK,aAAa,cAAc,KAAK,GAAI;AAG5D,SAAO;CACR;;;;;;;;;;;;;;;;;;CAmBD,IAAI,UAAwB;AAC1B,SAAOC,yBAAS,KAAK,UAAU,CAAE;CAClC;;CAGD,AAAU,2BACRC,QACA;EACA,MAAM,gBAAgB,EAAE,GAAG,OAAQ;AACnC,MACE,CAAC,KAAK,MAAM,WAAW,QAAQ,IAC/B,CAAC,KAAK,MAAM,WAAW,SAAS,IAChC,KAAK,UAAU,SAEf;OAAI,eAAe,WAAW,OAC5B,QAAO;EACR,WACQ,cAAc,WAAW,cAClC,QAAQ,KACN,CAAC,mDAAmD,EAAE,KAAK,MAAM,gCAAgC,CAAC,CACnG;AAEH,SAAO,cAAc;CACtB;;;;;;;;;;;;;;;;;;;;CAwDD,qBAGEC,cACAC,QACA;EACA,IAAIC;EACJ,IAAIC;EAEJ,MAAM,EAAE,QAAQ,MAAM,YAAY,GAAG;GACnC,GAAG;GACH,QAAQ;EACT;AAED,MAAI,QAAQ,WAAW,UAAa,OAAO,WAAW,WACpD,OAAM,IAAI,MACR;EAIJ,MAAM,SAASC,yCAA0B,KAAK,OAAO,QAAQ,OAAO;AAEpE,MAAI,WAAW,YAAY;AACzB,4DAAuB,OAAO,EAC5B,eAAeC,uDAAuB,cAAc,OAAO;QAE3D,eAAe,IAAIC;GAErB,MAAM,oEAA4B,OAAO;GACzC,MAAM,KAAK,WAAW;IACpB,eAAe;IACf,iBAAiB,EAAE,MAAM,cAAe;IACxC,6BAA6B;KAC3B,QAAQ,EAAE,QAAQ,YAAa;KAC/B,QAAQ;MAAE,OAAO,QAAQ;MAAW,GAAG;KAAc;IACtD;GACF,EAAyB;EAC3B,WAAU,WAAW,cAAc;GAClC,MAAM,yBAAyB;IAC7B,MAAM,QAAQ;IACd,oEAAkC,OAAO;IACzC;IACA,QAAQ,QAAQ;GACjB;GACD,MAAM,oEAA4B,uBAAuB,OAAO;GAChE,MAAM,KAAK,WAAW;IACpB,eAAe;IACf,iBAAiB;KACf,MAAM;KACN,aAAa;IACd;IACD,6BAA6B;KAC3B,QAAQ,EAAE,QAAQ,cAAe;KACjC,QAAQ;MACN,OAAO,uBAAuB;MAC9B,aAAa,uBAAuB;MACpC,GAAG;KACJ;IACF;GACF,EAAyB;AAC1B,4DAAuB,OAAO,EAAE;IAC9B,MAAM,YAAYD,uDAAuB,cAAc,OAAO;IAC9D,eAAeE,0CAAe,KAC5B,CAACC,cAA8B;AAC7B,SAAI,YAAY,UAAU,kBACxB,QAAO,UAAU,kBAAkB;AAErC,YAAO;IACR,EACF;GACF,OACC,eAAe,IAAIF;EAEtB,OAAM;GACL,IAAI,eAAe,QAAQ;AAE3B,4DAAuB,OAAO,EAAE;IAC9B,MAAM,oEAA4B,OAAO;IACzC,MAAM,KAAK,WAAW;KACpB,eAAe;KACf,OAAO,CACL;MACE,MAAM;MACN,UAAU;OACR,MAAM;OACN,aAAa,aAAa;OAC1B,YAAY;MACb;KACF,CACF;KACD,aAAa;MACX,MAAM;MACN,UAAU,EACR,MAAM,aACP;KACF;KACD,6BAA6B;MAC3B,QAAQ,EAAE,QAAQ,mBAAoB;MACtC,QAAQ;OAAE,OAAO;OAAc,GAAG;MAAc;KACjD;KAED,GAAI,QAAQ,WAAW,SAAY,EAAE,QAAQ,OAAO,OAAQ,IAAG,CAAE;IAClE,EAAyB;IAC1B,eAAe,IAAIG,sEAAyB;KAC1C,cAAc;KACd,SAAS;KACT,WAAW;IACZ;GACF,OAAM;IACL,IAAIC;AACJ,QACE,OAAO,OAAO,SAAS,YACvB,OAAO,OAAO,eAAe,YAC7B,OAAO,cAAc,MACrB;KACA,2BAA2B;KAC3B,eAAe,OAAO;IACvB,OAAM;KACL,eAAgB,OAAO,SAAoB;KAC3C,2BAA2B;MACzB,MAAM;MACN,aAAc,OAAO,eAA0B;MAC/C,YAAY;KACb;IACF;IACD,MAAM,oEAA4B,OAAO;IACzC,MAAM,KAAK,WAAW;KACpB,eAAe;KACf,OAAO,CACL;MACE,MAAM;MACN,UAAU;KACX,CACF;KACD,aAAa;MACX,MAAM;MACN,UAAU,EACR,MAAM,aACP;KACF;KACD,6BAA6B;MAC3B,QAAQ,EAAE,QAAQ,mBAAoB;MACtC,QAAQ;OAAE,OAAO;OAAc,GAAG;MAAc;KACjD;KAED,GAAI,QAAQ,WAAW,SAAY,EAAE,QAAQ,OAAO,OAAQ,IAAG,CAAE;IAClE,EAAyB;IAC1B,eAAe,IAAID,sEAAoC;KACrD,cAAc;KACd,SAAS;IACV;GACF;EACF;AAED,MAAI,CAAC,WACH,QAAO,IAAI,KAAK,aAAa;EAM/B,MAAM,eAAeE,+CAAoB,OAAO,EAE9C,QAAQ,CAACC,OAAYC,aAAW,aAAa,OAAO,MAAM,KAAKA,SAAO,CACvE,EAAC;EACF,MAAM,aAAaF,+CAAoB,OAAO,EAC5C,QAAQ,MAAM,KACf,EAAC;EACF,MAAM,qBAAqB,aAAa,cAAc,EACpD,WAAW,CAAC,UAAW,EACxB,EAAC;AACF,SAAOG,4CAAiB,KAGtB,CAAC,EAAE,KAAK,IAAK,GAAE,kBAAmB,EAAC;CACtC;AACF"}
@@ -1,5 +1,5 @@
1
1
  import { IterableReadableStream } from "../langchain-core/dist/utils/stream.cjs";
2
- import { ChatOpenAIResponseFormat, OpenAICallOptions, OpenAIChatInput, OpenAICoreRequestOptions, OpenAIVerbosityParam, ResponseFormatConfiguration } from "../types.cjs";
2
+ import { ChatOpenAIResponseFormat, OpenAIApiKey, OpenAICallOptions, OpenAIChatInput, OpenAICoreRequestOptions, OpenAIVerbosityParam, ResponseFormatConfiguration } from "../types.cjs";
3
3
  import { ChatOpenAIToolType, OpenAIToolChoice, ResponsesToolChoice } from "../utils/tools.cjs";
4
4
  import { ClientOptions, OpenAI as OpenAI$1 } from "openai";
5
5
  import * as _langchain_core_messages0 from "@langchain/core/messages";
@@ -150,7 +150,7 @@ declare abstract class BaseChatOpenAI<CallOptions extends BaseChatOpenAICallOpti
150
150
  maxTokens?: number;
151
151
  logprobs?: boolean;
152
152
  topLogprobs?: number;
153
- apiKey?: string;
153
+ apiKey?: OpenAIApiKey;
154
154
  organization?: string;
155
155
  __includeRawResponse?: boolean;
156
156
  /** @internal */
@@ -1,5 +1,5 @@
1
1
  import { IterableReadableStream } from "../langchain-core/dist/utils/stream.js";
2
- import { ChatOpenAIResponseFormat, OpenAICallOptions, OpenAIChatInput, OpenAICoreRequestOptions, OpenAIVerbosityParam, ResponseFormatConfiguration } from "../types.js";
2
+ import { ChatOpenAIResponseFormat, OpenAIApiKey, OpenAICallOptions, OpenAIChatInput, OpenAICoreRequestOptions, OpenAIVerbosityParam, ResponseFormatConfiguration } from "../types.js";
3
3
  import { ChatOpenAIToolType, OpenAIToolChoice, ResponsesToolChoice } from "../utils/tools.js";
4
4
  import { ClientOptions, OpenAI as OpenAI$1 } from "openai";
5
5
  import * as _langchain_core_messages0 from "@langchain/core/messages";
@@ -150,7 +150,7 @@ declare abstract class BaseChatOpenAI<CallOptions extends BaseChatOpenAICallOpti
150
150
  maxTokens?: number;
151
151
  logprobs?: boolean;
152
152
  topLogprobs?: number;
153
- apiKey?: string;
153
+ apiKey?: OpenAIApiKey;
154
154
  organization?: string;
155
155
  __includeRawResponse?: boolean;
156
156
  /** @internal */
@@ -1,6 +1,6 @@
1
1
  import { _convertToOpenAITool, convertResponsesCustomTool, formatFunctionDefinitions, isBuiltInTool, isCustomTool } from "../utils/tools.js";
2
2
  import { isReasoningModel, messageToOpenAIRole } from "../utils/misc.js";
3
- import { getEndpoint } from "../utils/azure.js";
3
+ import { getEndpoint, getHeadersWithUserAgent } from "../utils/azure.js";
4
4
  import { getStructuredOutputMethod, interopZodResponseFormat } from "../utils/output.js";
5
5
  import profiles_default from "./profiles.js";
6
6
  import { OpenAI as OpenAI$1 } from "openai";
@@ -177,7 +177,7 @@ var BaseChatOpenAI = class extends BaseChatModel {
177
177
  }
178
178
  constructor(fields) {
179
179
  super(fields ?? {});
180
- const configApiKey = typeof fields?.configuration?.apiKey === "string" ? fields?.configuration?.apiKey : void 0;
180
+ const configApiKey = typeof fields?.configuration?.apiKey === "string" || typeof fields?.configuration?.apiKey === "function" ? fields?.configuration?.apiKey : void 0;
181
181
  this.apiKey = fields?.apiKey ?? configApiKey ?? getEnvironmentVariable("OPENAI_API_KEY");
182
182
  this.organization = fields?.configuration?.organization ?? getEnvironmentVariable("OPENAI_ORGANIZATION");
183
183
  this.model = fields?.model ?? fields?.modelName ?? this.model;
@@ -260,6 +260,7 @@ var BaseChatOpenAI = class extends BaseChatModel {
260
260
  maxRetries: 0
261
261
  };
262
262
  if (!params.baseURL) delete params.baseURL;
263
+ params.defaultHeaders = getHeadersWithUserAgent(params.defaultHeaders);
263
264
  this.client = new OpenAI$1(params);
264
265
  }
265
266
  const requestOptions = {
@@ -1 +1 @@
1
- {"version":3,"file":"base.js","names":["options: this[\"ParsedCallOptions\"]","fields?: BaseChatOpenAIFields","options?: this[\"ParsedCallOptions\"]","reasoning: OpenAIClient.Reasoning | undefined","resFormat?: CallOptions[\"response_format\"]","additionalOptions?: this[\"ParsedCallOptions\"]","options: OpenAICoreRequestOptions | undefined","openAIEndpointConfig: OpenAIEndpointConfig","OpenAIClient","tool: ChatOpenAIToolType","fields?: { strict?: boolean }","isOpenAIFunctionTool","tools: ChatOpenAIToolType[]","kwargs?: Partial<CallOptions>","strict: boolean | undefined","input: BaseLanguageModelInput","options?: CallOptions","messages: BaseMessage[]","generations: ChatGeneration[]","functions?: OpenAIClient.Chat.ChatCompletionCreateParams.Function[]","function_call?:\n | \"none\"\n | \"auto\"\n | OpenAIClient.Chat.ChatCompletionFunctionCallOption","PROFILES","config: StructuredOutputMethodOptions<boolean>","outputSchema: InteropZodType<RunOutput> | Record<string, unknown>","config?: StructuredOutputMethodOptions<boolean>","llm: Runnable<BaseLanguageModelInput>","outputParser: Runnable<AIMessageChunk, RunOutput>","aiMessage: AIMessageChunk","openAIFunctionDefinition: FunctionDefinition","input: any","config"],"sources":["../../src/chat_models/base.ts"],"sourcesContent":["import { type ClientOptions, OpenAI as OpenAIClient } from \"openai\";\nimport { AIMessageChunk, type BaseMessage } from \"@langchain/core/messages\";\nimport { type ChatGeneration } from \"@langchain/core/outputs\";\nimport { getEnvironmentVariable } from \"@langchain/core/utils/env\";\nimport {\n BaseChatModel,\n type LangSmithParams,\n type BaseChatModelParams,\n BaseChatModelCallOptions,\n} from \"@langchain/core/language_models/chat_models\";\nimport {\n isOpenAITool as isOpenAIFunctionTool,\n type BaseFunctionCallOptions,\n type BaseLanguageModelInput,\n type FunctionDefinition,\n type StructuredOutputMethodOptions,\n} from \"@langchain/core/language_models/base\";\nimport { ModelProfile } from \"@langchain/core/language_models/profile\";\nimport {\n Runnable,\n RunnableLambda,\n RunnablePassthrough,\n RunnableSequence,\n} from \"@langchain/core/runnables\";\nimport {\n JsonOutputParser,\n StructuredOutputParser,\n} from \"@langchain/core/output_parsers\";\nimport { JsonOutputKeyToolsParser } from \"@langchain/core/output_parsers/openai_tools\";\nimport {\n getSchemaDescription,\n InteropZodType,\n isInteropZodSchema,\n} from \"@langchain/core/utils/types\";\nimport { toJsonSchema } from \"@langchain/core/utils/json_schema\";\nimport {\n type OpenAICallOptions,\n type OpenAIChatInput,\n type OpenAICoreRequestOptions,\n type ChatOpenAIResponseFormat,\n ResponseFormatConfiguration,\n OpenAIVerbosityParam,\n} from \"../types.js\";\nimport { type OpenAIEndpointConfig, getEndpoint } from \"../utils/azure.js\";\nimport {\n type FunctionDef,\n formatFunctionDefinitions,\n OpenAIToolChoice,\n _convertToOpenAITool,\n ChatOpenAIToolType,\n convertResponsesCustomTool,\n isBuiltInTool,\n isCustomTool,\n ResponsesToolChoice,\n} from \"../utils/tools.js\";\nimport {\n getStructuredOutputMethod,\n interopZodResponseFormat,\n _convertOpenAIResponsesUsageToLangChainUsage,\n} from \"../utils/output.js\";\nimport { isReasoningModel, messageToOpenAIRole } from \"../utils/misc.js\";\nimport PROFILES from \"./profiles.js\";\n\ninterface OpenAILLMOutput {\n tokenUsage: {\n completionTokens?: number;\n promptTokens?: number;\n totalTokens?: number;\n };\n}\n\nexport type { OpenAICallOptions, OpenAIChatInput };\n\nexport interface BaseChatOpenAICallOptions\n extends BaseChatModelCallOptions,\n BaseFunctionCallOptions {\n /**\n * Additional options to pass to the underlying axios request.\n */\n options?: OpenAICoreRequestOptions;\n\n /**\n * A list of tools that the model may use to generate responses.\n * Each tool can be a function, a built-in tool, or a custom tool definition.\n * If not provided, the model will not use any tools.\n */\n tools?: ChatOpenAIToolType[];\n\n /**\n * Specifies which tool the model should use to respond.\n * Can be an {@link OpenAIToolChoice} or a {@link ResponsesToolChoice}.\n * If not set, the model will decide which tool to use automatically.\n */\n // TODO: break OpenAIToolChoice and ResponsesToolChoice into options sub classes\n tool_choice?: OpenAIToolChoice | ResponsesToolChoice;\n\n /**\n * Adds a prompt index to prompts passed to the model to track\n * what prompt is being used for a given generation.\n */\n promptIndex?: number;\n\n /**\n * An object specifying the format that the model must output.\n */\n response_format?: ChatOpenAIResponseFormat;\n\n /**\n * When provided, the completions API will make a best effort to sample\n * deterministically, such that repeated requests with the same `seed`\n * and parameters should return the same result.\n */\n seed?: number;\n\n /**\n * Additional options to pass to streamed completions.\n * If provided, this takes precedence over \"streamUsage\" set at\n * initialization time.\n */\n stream_options?: OpenAIClient.Chat.ChatCompletionStreamOptions;\n\n /**\n * The model may choose to call multiple functions in a single turn. You can\n * set parallel_tool_calls to false which ensures only one tool is called at most.\n * [Learn more](https://platform.openai.com/docs/guides/function-calling#parallel-function-calling)\n */\n parallel_tool_calls?: boolean;\n\n /**\n * If `true`, model output is guaranteed to exactly match the JSON Schema\n * provided in the tool definition. If `true`, the input schema will also be\n * validated according to\n * https://platform.openai.com/docs/guides/structured-outputs/supported-schemas.\n *\n * If `false`, input schema will not be validated and model output will not\n * be validated.\n *\n * If `undefined`, `strict` argument will not be passed to the model.\n */\n strict?: boolean;\n\n /**\n * Output types that you would like the model to generate for this request. Most\n * models are capable of generating text, which is the default:\n *\n * `[\"text\"]`\n *\n * The `gpt-4o-audio-preview` model can also be used to\n * [generate audio](https://platform.openai.com/docs/guides/audio). To request that\n * this model generate both text and audio responses, you can use:\n *\n * `[\"text\", \"audio\"]`\n */\n modalities?: Array<OpenAIClient.Chat.ChatCompletionModality>;\n\n /**\n * Parameters for audio output. Required when audio output is requested with\n * `modalities: [\"audio\"]`.\n * [Learn more](https://platform.openai.com/docs/guides/audio).\n */\n audio?: OpenAIClient.Chat.ChatCompletionAudioParam;\n\n /**\n * Static predicted output content, such as the content of a text file that is being regenerated.\n * [Learn more](https://platform.openai.com/docs/guides/latency-optimization#use-predicted-outputs).\n */\n prediction?: OpenAIClient.ChatCompletionPredictionContent;\n\n /**\n * Options for reasoning models.\n *\n * Note that some options, like reasoning summaries, are only available when using the responses\n * API. If these options are set, the responses API will be used to fulfill the request.\n *\n * These options will be ignored when not using a reasoning model.\n */\n reasoning?: OpenAIClient.Reasoning;\n\n /**\n * Service tier to use for this request. Can be \"auto\", \"default\", or \"flex\"\n * Specifies the service tier for prioritization and latency optimization.\n */\n service_tier?: OpenAIClient.Chat.ChatCompletionCreateParams[\"service_tier\"];\n\n /**\n * Used by OpenAI to cache responses for similar requests to optimize your cache\n * hit rates. Replaces the `user` field.\n * [Learn more](https://platform.openai.com/docs/guides/prompt-caching).\n */\n promptCacheKey?: string;\n\n /**\n * The verbosity of the model's response.\n */\n verbosity?: OpenAIVerbosityParam;\n}\n\nexport interface BaseChatOpenAIFields\n extends Partial<OpenAIChatInput>,\n BaseChatModelParams {\n /**\n * Optional configuration options for the OpenAI client.\n */\n configuration?: ClientOptions;\n}\n\n/** @internal */\nexport abstract class BaseChatOpenAI<\n CallOptions extends BaseChatOpenAICallOptions\n >\n extends BaseChatModel<CallOptions, AIMessageChunk>\n implements Partial<OpenAIChatInput>\n{\n temperature?: number;\n\n topP?: number;\n\n frequencyPenalty?: number;\n\n presencePenalty?: number;\n\n n?: number;\n\n logitBias?: Record<string, number>;\n\n model = \"gpt-3.5-turbo\";\n\n modelKwargs?: OpenAIChatInput[\"modelKwargs\"];\n\n stop?: string[];\n\n stopSequences?: string[];\n\n user?: string;\n\n timeout?: number;\n\n streaming = false;\n\n streamUsage = true;\n\n maxTokens?: number;\n\n logprobs?: boolean;\n\n topLogprobs?: number;\n\n apiKey?: string;\n\n organization?: string;\n\n __includeRawResponse?: boolean;\n\n /** @internal */\n client: OpenAIClient;\n\n /** @internal */\n clientConfig: ClientOptions;\n\n /**\n * Whether the model supports the `strict` argument when passing in tools.\n * If `undefined` the `strict` argument will not be passed to OpenAI.\n */\n supportsStrictToolCalling?: boolean;\n\n audio?: OpenAIClient.Chat.ChatCompletionAudioParam;\n\n modalities?: Array<OpenAIClient.Chat.ChatCompletionModality>;\n\n reasoning?: OpenAIClient.Reasoning;\n\n /**\n * Must be set to `true` in tenancies with Zero Data Retention. Setting to `true` will disable\n * output storage in the Responses API, but this DOES NOT enable Zero Data Retention in your\n * OpenAI organization or project. This must be configured directly with OpenAI.\n *\n * See:\n * https://platform.openai.com/docs/guides/your-data\n * https://platform.openai.com/docs/api-reference/responses/create#responses-create-store\n *\n * @default false\n */\n zdrEnabled?: boolean | undefined;\n\n /**\n * Service tier to use for this request. Can be \"auto\", \"default\", or \"flex\" or \"priority\".\n * Specifies the service tier for prioritization and latency optimization.\n */\n service_tier?: OpenAIClient.Chat.ChatCompletionCreateParams[\"service_tier\"];\n\n /**\n * Used by OpenAI to cache responses for similar requests to optimize your cache\n * hit rates.\n * [Learn more](https://platform.openai.com/docs/guides/prompt-caching).\n */\n promptCacheKey: string;\n\n /**\n * The verbosity of the model's response.\n */\n verbosity?: OpenAIVerbosityParam;\n\n protected defaultOptions: CallOptions;\n\n _llmType() {\n return \"openai\";\n }\n\n static lc_name() {\n return \"ChatOpenAI\";\n }\n\n get callKeys() {\n return [\n ...super.callKeys,\n \"options\",\n \"function_call\",\n \"functions\",\n \"tools\",\n \"tool_choice\",\n \"promptIndex\",\n \"response_format\",\n \"seed\",\n \"reasoning\",\n \"service_tier\",\n ];\n }\n\n lc_serializable = true;\n\n get lc_secrets(): { [key: string]: string } | undefined {\n return {\n apiKey: \"OPENAI_API_KEY\",\n organization: \"OPENAI_ORGANIZATION\",\n };\n }\n\n get lc_aliases(): Record<string, string> {\n return {\n apiKey: \"openai_api_key\",\n modelName: \"model\",\n };\n }\n\n get lc_serializable_keys(): string[] {\n return [\n \"configuration\",\n \"logprobs\",\n \"topLogprobs\",\n \"prefixMessages\",\n \"supportsStrictToolCalling\",\n \"modalities\",\n \"audio\",\n \"temperature\",\n \"maxTokens\",\n \"topP\",\n \"frequencyPenalty\",\n \"presencePenalty\",\n \"n\",\n \"logitBias\",\n \"user\",\n \"streaming\",\n \"streamUsage\",\n \"model\",\n \"modelName\",\n \"modelKwargs\",\n \"stop\",\n \"stopSequences\",\n \"timeout\",\n \"apiKey\",\n \"cache\",\n \"maxConcurrency\",\n \"maxRetries\",\n \"verbose\",\n \"callbacks\",\n \"tags\",\n \"metadata\",\n \"disableStreaming\",\n \"zdrEnabled\",\n \"reasoning\",\n \"promptCacheKey\",\n \"verbosity\",\n ];\n }\n\n getLsParams(options: this[\"ParsedCallOptions\"]): LangSmithParams {\n const params = this.invocationParams(options);\n return {\n ls_provider: \"openai\",\n ls_model_name: this.model,\n ls_model_type: \"chat\",\n ls_temperature: params.temperature ?? undefined,\n ls_max_tokens: params.max_tokens ?? undefined,\n ls_stop: options.stop,\n };\n }\n\n /** @ignore */\n _identifyingParams(): Omit<\n OpenAIClient.Chat.ChatCompletionCreateParams,\n \"messages\"\n > & {\n model_name: string;\n } & ClientOptions {\n return {\n model_name: this.model,\n ...this.invocationParams(),\n ...this.clientConfig,\n };\n }\n\n /**\n * Get the identifying parameters for the model\n */\n identifyingParams() {\n return this._identifyingParams();\n }\n\n constructor(fields?: BaseChatOpenAIFields) {\n super(fields ?? {});\n\n const configApiKey =\n typeof fields?.configuration?.apiKey === \"string\"\n ? fields?.configuration?.apiKey\n : undefined;\n this.apiKey =\n fields?.apiKey ??\n configApiKey ??\n getEnvironmentVariable(\"OPENAI_API_KEY\");\n this.organization =\n fields?.configuration?.organization ??\n getEnvironmentVariable(\"OPENAI_ORGANIZATION\");\n\n this.model = fields?.model ?? fields?.modelName ?? this.model;\n this.modelKwargs = fields?.modelKwargs ?? {};\n this.timeout = fields?.timeout;\n\n this.temperature = fields?.temperature ?? this.temperature;\n this.topP = fields?.topP ?? this.topP;\n this.frequencyPenalty = fields?.frequencyPenalty ?? this.frequencyPenalty;\n this.presencePenalty = fields?.presencePenalty ?? this.presencePenalty;\n this.logprobs = fields?.logprobs;\n this.topLogprobs = fields?.topLogprobs;\n this.n = fields?.n ?? this.n;\n this.logitBias = fields?.logitBias;\n this.stop = fields?.stopSequences ?? fields?.stop;\n this.stopSequences = this.stop;\n this.user = fields?.user;\n this.__includeRawResponse = fields?.__includeRawResponse;\n this.audio = fields?.audio;\n this.modalities = fields?.modalities;\n this.reasoning = fields?.reasoning;\n this.maxTokens = fields?.maxCompletionTokens ?? fields?.maxTokens;\n this.promptCacheKey = fields?.promptCacheKey ?? this.promptCacheKey;\n this.verbosity = fields?.verbosity ?? this.verbosity;\n\n this.disableStreaming = fields?.disableStreaming === true;\n this.streaming = fields?.streaming === true;\n if (this.disableStreaming) this.streaming = false;\n // disable streaming in BaseChatModel if explicitly disabled\n if (fields?.streaming === false) this.disableStreaming = true;\n\n this.streamUsage = fields?.streamUsage ?? this.streamUsage;\n if (this.disableStreaming) this.streamUsage = false;\n\n this.clientConfig = {\n apiKey: this.apiKey,\n organization: this.organization,\n dangerouslyAllowBrowser: true,\n ...fields?.configuration,\n };\n\n // If `supportsStrictToolCalling` is explicitly set, use that value.\n // Else leave undefined so it's not passed to OpenAI.\n if (fields?.supportsStrictToolCalling !== undefined) {\n this.supportsStrictToolCalling = fields.supportsStrictToolCalling;\n }\n\n if (fields?.service_tier !== undefined) {\n this.service_tier = fields.service_tier;\n }\n\n this.zdrEnabled = fields?.zdrEnabled ?? false;\n }\n\n /**\n * Returns backwards compatible reasoning parameters from constructor params and call options\n * @internal\n */\n protected _getReasoningParams(\n options?: this[\"ParsedCallOptions\"]\n ): OpenAIClient.Reasoning | undefined {\n if (!isReasoningModel(this.model)) {\n return;\n }\n\n // apply options in reverse order of importance -- newer options supersede older options\n let reasoning: OpenAIClient.Reasoning | undefined;\n if (this.reasoning !== undefined) {\n reasoning = {\n ...reasoning,\n ...this.reasoning,\n };\n }\n if (options?.reasoning !== undefined) {\n reasoning = {\n ...reasoning,\n ...options.reasoning,\n };\n }\n\n return reasoning;\n }\n\n /**\n * Returns an openai compatible response format from a set of options\n * @internal\n */\n protected _getResponseFormat(\n resFormat?: CallOptions[\"response_format\"]\n ): ResponseFormatConfiguration | undefined {\n if (\n resFormat &&\n resFormat.type === \"json_schema\" &&\n resFormat.json_schema.schema &&\n isInteropZodSchema(resFormat.json_schema.schema)\n ) {\n return interopZodResponseFormat(\n resFormat.json_schema.schema,\n resFormat.json_schema.name,\n {\n description: resFormat.json_schema.description,\n }\n );\n }\n return resFormat as ResponseFormatConfiguration | undefined;\n }\n\n protected _combineCallOptions(\n additionalOptions?: this[\"ParsedCallOptions\"]\n ): this[\"ParsedCallOptions\"] {\n return {\n ...this.defaultOptions,\n ...(additionalOptions ?? {}),\n };\n }\n\n /** @internal */\n _getClientOptions(\n options: OpenAICoreRequestOptions | undefined\n ): OpenAICoreRequestOptions {\n if (!this.client) {\n const openAIEndpointConfig: OpenAIEndpointConfig = {\n baseURL: this.clientConfig.baseURL,\n };\n\n const endpoint = getEndpoint(openAIEndpointConfig);\n const params = {\n ...this.clientConfig,\n baseURL: endpoint,\n timeout: this.timeout,\n maxRetries: 0,\n };\n if (!params.baseURL) {\n delete params.baseURL;\n }\n\n this.client = new OpenAIClient(params);\n }\n const requestOptions = {\n ...this.clientConfig,\n ...options,\n } as OpenAICoreRequestOptions;\n return requestOptions;\n }\n\n // TODO: move to completions class\n protected _convertChatOpenAIToolToCompletionsTool(\n tool: ChatOpenAIToolType,\n fields?: { strict?: boolean }\n ): OpenAIClient.ChatCompletionTool {\n if (isCustomTool(tool)) {\n return convertResponsesCustomTool(tool.metadata.customTool);\n }\n if (isOpenAIFunctionTool(tool)) {\n if (fields?.strict !== undefined) {\n return {\n ...tool,\n function: {\n ...tool.function,\n strict: fields.strict,\n },\n };\n }\n\n return tool;\n }\n return _convertToOpenAITool(tool, fields);\n }\n\n override bindTools(\n tools: ChatOpenAIToolType[],\n kwargs?: Partial<CallOptions>\n ): Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions> {\n let strict: boolean | undefined;\n if (kwargs?.strict !== undefined) {\n strict = kwargs.strict;\n } else if (this.supportsStrictToolCalling !== undefined) {\n strict = this.supportsStrictToolCalling;\n }\n return this.withConfig({\n tools: tools.map((tool) =>\n isBuiltInTool(tool) || isCustomTool(tool)\n ? tool\n : this._convertChatOpenAIToolToCompletionsTool(tool, { strict })\n ),\n ...kwargs,\n } as Partial<CallOptions>);\n }\n\n override async stream(input: BaseLanguageModelInput, options?: CallOptions) {\n return super.stream(\n input,\n this._combineCallOptions(options) as CallOptions\n );\n }\n\n override async invoke(input: BaseLanguageModelInput, options?: CallOptions) {\n return super.invoke(\n input,\n this._combineCallOptions(options) as CallOptions\n );\n }\n\n /** @ignore */\n _combineLLMOutput(...llmOutputs: OpenAILLMOutput[]): OpenAILLMOutput {\n return llmOutputs.reduce<{\n [key in keyof OpenAILLMOutput]: Required<OpenAILLMOutput[key]>;\n }>(\n (acc, llmOutput) => {\n if (llmOutput && llmOutput.tokenUsage) {\n acc.tokenUsage.completionTokens +=\n llmOutput.tokenUsage.completionTokens ?? 0;\n acc.tokenUsage.promptTokens += llmOutput.tokenUsage.promptTokens ?? 0;\n acc.tokenUsage.totalTokens += llmOutput.tokenUsage.totalTokens ?? 0;\n }\n return acc;\n },\n {\n tokenUsage: {\n completionTokens: 0,\n promptTokens: 0,\n totalTokens: 0,\n },\n }\n );\n }\n\n async getNumTokensFromMessages(messages: BaseMessage[]) {\n let totalCount = 0;\n let tokensPerMessage = 0;\n let tokensPerName = 0;\n\n // From: https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb\n if (this.model === \"gpt-3.5-turbo-0301\") {\n tokensPerMessage = 4;\n tokensPerName = -1;\n } else {\n tokensPerMessage = 3;\n tokensPerName = 1;\n }\n\n const countPerMessage = await Promise.all(\n messages.map(async (message) => {\n const textCount = await this.getNumTokens(message.content);\n const roleCount = await this.getNumTokens(messageToOpenAIRole(message));\n const nameCount =\n message.name !== undefined\n ? tokensPerName + (await this.getNumTokens(message.name))\n : 0;\n let count = textCount + tokensPerMessage + roleCount + nameCount;\n\n // From: https://github.com/hmarr/openai-chat-tokens/blob/main/src/index.ts messageTokenEstimate\n const openAIMessage = message;\n if (openAIMessage._getType() === \"function\") {\n count -= 2;\n }\n if (openAIMessage.additional_kwargs?.function_call) {\n count += 3;\n }\n if (openAIMessage?.additional_kwargs.function_call?.name) {\n count += await this.getNumTokens(\n openAIMessage.additional_kwargs.function_call?.name\n );\n }\n if (openAIMessage.additional_kwargs.function_call?.arguments) {\n try {\n count += await this.getNumTokens(\n // Remove newlines and spaces\n JSON.stringify(\n JSON.parse(\n openAIMessage.additional_kwargs.function_call?.arguments\n )\n )\n );\n } catch (error) {\n console.error(\n \"Error parsing function arguments\",\n error,\n JSON.stringify(openAIMessage.additional_kwargs.function_call)\n );\n count += await this.getNumTokens(\n openAIMessage.additional_kwargs.function_call?.arguments\n );\n }\n }\n\n totalCount += count;\n return count;\n })\n );\n\n totalCount += 3; // every reply is primed with <|start|>assistant<|message|>\n\n return { totalCount, countPerMessage };\n }\n\n /** @internal */\n protected async _getNumTokensFromGenerations(generations: ChatGeneration[]) {\n const generationUsages = await Promise.all(\n generations.map(async (generation) => {\n if (generation.message.additional_kwargs?.function_call) {\n return (await this.getNumTokensFromMessages([generation.message]))\n .countPerMessage[0];\n } else {\n return await this.getNumTokens(generation.message.content);\n }\n })\n );\n\n return generationUsages.reduce((a, b) => a + b, 0);\n }\n\n /** @internal */\n protected async _getEstimatedTokenCountFromPrompt(\n messages: BaseMessage[],\n functions?: OpenAIClient.Chat.ChatCompletionCreateParams.Function[],\n function_call?:\n | \"none\"\n | \"auto\"\n | OpenAIClient.Chat.ChatCompletionFunctionCallOption\n ): Promise<number> {\n // It appears that if functions are present, the first system message is padded with a trailing newline. This\n // was inferred by trying lots of combinations of messages and functions and seeing what the token counts were.\n\n let tokens = (await this.getNumTokensFromMessages(messages)).totalCount;\n\n // If there are functions, add the function definitions as they count towards token usage\n if (functions && function_call !== \"auto\") {\n const promptDefinitions = formatFunctionDefinitions(\n functions as unknown as FunctionDef[]\n );\n tokens += await this.getNumTokens(promptDefinitions);\n tokens += 9; // Add nine per completion\n }\n\n // If there's a system message _and_ functions are present, subtract four tokens. I assume this is because\n // functions typically add a system message, but reuse the first one if it's already there. This offsets\n // the extra 9 tokens added by the function definitions.\n if (functions && messages.find((m) => m._getType() === \"system\")) {\n tokens -= 4;\n }\n\n // If function_call is 'none', add one token.\n // If it's a FunctionCall object, add 4 + the number of tokens in the function name.\n // If it's undefined or 'auto', don't add anything.\n if (function_call === \"none\") {\n tokens += 1;\n } else if (typeof function_call === \"object\") {\n tokens += (await this.getNumTokens(function_call.name)) + 4;\n }\n\n return tokens;\n }\n\n /**\n * Return profiling information for the model.\n *\n * Provides information about the model's capabilities and constraints,\n * including token limits, multimodal support, and advanced features like\n * tool calling and structured output.\n *\n * @returns {ModelProfile} An object describing the model's capabilities and constraints\n *\n * @example\n * ```typescript\n * const model = new ChatOpenAI({ model: \"gpt-4o\" });\n * const profile = model.profile;\n * console.log(profile.maxInputTokens); // 128000\n * console.log(profile.imageInputs); // true\n * ```\n */\n get profile(): ModelProfile {\n return PROFILES[this.model] ?? {};\n }\n\n /** @internal */\n protected _getStructuredOutputMethod(\n config: StructuredOutputMethodOptions<boolean>\n ) {\n const ensuredConfig = { ...config };\n if (\n !this.model.startsWith(\"gpt-3\") &&\n !this.model.startsWith(\"gpt-4-\") &&\n this.model !== \"gpt-4\"\n ) {\n if (ensuredConfig?.method === undefined) {\n return \"jsonSchema\";\n }\n } else if (ensuredConfig.method === \"jsonSchema\") {\n console.warn(\n `[WARNING]: JSON Schema is not supported for model \"${this.model}\". Falling back to tool calling.`\n );\n }\n return ensuredConfig.method;\n }\n\n withStructuredOutput<\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n RunOutput extends Record<string, any> = Record<string, any>\n >(\n outputSchema:\n | InteropZodType<RunOutput>\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n | Record<string, any>,\n config?: StructuredOutputMethodOptions<false>\n ): Runnable<BaseLanguageModelInput, RunOutput>;\n\n withStructuredOutput<\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n RunOutput extends Record<string, any> = Record<string, any>\n >(\n outputSchema:\n | InteropZodType<RunOutput>\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n | Record<string, any>,\n config?: StructuredOutputMethodOptions<true>\n ): Runnable<BaseLanguageModelInput, { raw: BaseMessage; parsed: RunOutput }>;\n\n withStructuredOutput<\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n RunOutput extends Record<string, any> = Record<string, any>\n >(\n outputSchema:\n | InteropZodType<RunOutput>\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n | Record<string, any>,\n config?: StructuredOutputMethodOptions<boolean>\n ):\n | Runnable<BaseLanguageModelInput, RunOutput>\n | Runnable<BaseLanguageModelInput, { raw: BaseMessage; parsed: RunOutput }>;\n\n /**\n * Add structured output to the model.\n *\n * The OpenAI model family supports the following structured output methods:\n * - `jsonSchema`: Use the `response_format` field in the response to return a JSON schema. Only supported with the `gpt-4o-mini`,\n * `gpt-4o-mini-2024-07-18`, and `gpt-4o-2024-08-06` model snapshots and later.\n * - `functionCalling`: Function calling is useful when you are building an application that bridges the models and functionality\n * of your application.\n * - `jsonMode`: JSON mode is a more basic version of the Structured Outputs feature. While JSON mode ensures that model\n * output is valid JSON, Structured Outputs reliably matches the model's output to the schema you specify.\n * We recommend you use `functionCalling` or `jsonSchema` if it is supported for your use case.\n *\n * The default method is `functionCalling`.\n *\n * @see https://platform.openai.com/docs/guides/structured-outputs\n * @param outputSchema - The schema to use for structured output.\n * @param config - The structured output method options.\n * @returns The model with structured output.\n */\n withStructuredOutput<\n RunOutput extends Record<string, unknown> = Record<string, unknown>\n >(\n outputSchema: InteropZodType<RunOutput> | Record<string, unknown>,\n config?: StructuredOutputMethodOptions<boolean>\n ) {\n let llm: Runnable<BaseLanguageModelInput>;\n let outputParser: Runnable<AIMessageChunk, RunOutput>;\n\n const { schema, name, includeRaw } = {\n ...config,\n schema: outputSchema,\n };\n\n if (config?.strict !== undefined && config.method === \"jsonMode\") {\n throw new Error(\n \"Argument `strict` is only supported for `method` = 'function_calling'\"\n );\n }\n\n const method = getStructuredOutputMethod(this.model, config?.method);\n\n if (method === \"jsonMode\") {\n if (isInteropZodSchema(schema)) {\n outputParser = StructuredOutputParser.fromZodSchema(schema);\n } else {\n outputParser = new JsonOutputParser<RunOutput>();\n }\n const asJsonSchema = toJsonSchema(schema);\n llm = this.withConfig({\n outputVersion: \"v0\",\n response_format: { type: \"json_object\" },\n ls_structured_output_format: {\n kwargs: { method: \"json_mode\" },\n schema: { title: name ?? \"extract\", ...asJsonSchema },\n },\n } as Partial<CallOptions>);\n } else if (method === \"jsonSchema\") {\n const openaiJsonSchemaParams = {\n name: name ?? \"extract\",\n description: getSchemaDescription(schema),\n schema,\n strict: config?.strict,\n };\n const asJsonSchema = toJsonSchema(openaiJsonSchemaParams.schema);\n llm = this.withConfig({\n outputVersion: \"v0\",\n response_format: {\n type: \"json_schema\",\n json_schema: openaiJsonSchemaParams,\n },\n ls_structured_output_format: {\n kwargs: { method: \"json_schema\" },\n schema: {\n title: openaiJsonSchemaParams.name,\n description: openaiJsonSchemaParams.description,\n ...asJsonSchema,\n },\n },\n } as Partial<CallOptions>);\n if (isInteropZodSchema(schema)) {\n const altParser = StructuredOutputParser.fromZodSchema(schema);\n outputParser = RunnableLambda.from<AIMessageChunk, RunOutput>(\n (aiMessage: AIMessageChunk) => {\n if (\"parsed\" in aiMessage.additional_kwargs) {\n return aiMessage.additional_kwargs.parsed as RunOutput;\n }\n return altParser;\n }\n );\n } else {\n outputParser = new JsonOutputParser<RunOutput>();\n }\n } else {\n let functionName = name ?? \"extract\";\n // Is function calling\n if (isInteropZodSchema(schema)) {\n const asJsonSchema = toJsonSchema(schema);\n llm = this.withConfig({\n outputVersion: \"v0\",\n tools: [\n {\n type: \"function\" as const,\n function: {\n name: functionName,\n description: asJsonSchema.description,\n parameters: asJsonSchema,\n },\n },\n ],\n tool_choice: {\n type: \"function\" as const,\n function: {\n name: functionName,\n },\n },\n ls_structured_output_format: {\n kwargs: { method: \"function_calling\" },\n schema: { title: functionName, ...asJsonSchema },\n },\n // Do not pass `strict` argument to OpenAI if `config.strict` is undefined\n ...(config?.strict !== undefined ? { strict: config.strict } : {}),\n } as Partial<CallOptions>);\n outputParser = new JsonOutputKeyToolsParser({\n returnSingle: true,\n keyName: functionName,\n zodSchema: schema,\n });\n } else {\n let openAIFunctionDefinition: FunctionDefinition;\n if (\n typeof schema.name === \"string\" &&\n typeof schema.parameters === \"object\" &&\n schema.parameters != null\n ) {\n openAIFunctionDefinition = schema as unknown as FunctionDefinition;\n functionName = schema.name;\n } else {\n functionName = (schema.title as string) ?? functionName;\n openAIFunctionDefinition = {\n name: functionName,\n description: (schema.description as string) ?? \"\",\n parameters: schema,\n };\n }\n const asJsonSchema = toJsonSchema(schema);\n llm = this.withConfig({\n outputVersion: \"v0\",\n tools: [\n {\n type: \"function\" as const,\n function: openAIFunctionDefinition,\n },\n ],\n tool_choice: {\n type: \"function\" as const,\n function: {\n name: functionName,\n },\n },\n ls_structured_output_format: {\n kwargs: { method: \"function_calling\" },\n schema: { title: functionName, ...asJsonSchema },\n },\n // Do not pass `strict` argument to OpenAI if `config.strict` is undefined\n ...(config?.strict !== undefined ? { strict: config.strict } : {}),\n } as Partial<CallOptions>);\n outputParser = new JsonOutputKeyToolsParser<RunOutput>({\n returnSingle: true,\n keyName: functionName,\n });\n }\n }\n\n if (!includeRaw) {\n return llm.pipe(outputParser) as Runnable<\n BaseLanguageModelInput,\n RunOutput\n >;\n }\n\n const parserAssign = RunnablePassthrough.assign({\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n parsed: (input: any, config) => outputParser.invoke(input.raw, config),\n });\n const parserNone = RunnablePassthrough.assign({\n parsed: () => null,\n });\n const parsedWithFallback = parserAssign.withFallbacks({\n fallbacks: [parserNone],\n });\n return RunnableSequence.from<\n BaseLanguageModelInput,\n { raw: BaseMessage; parsed: RunOutput }\n >([{ raw: llm }, parsedWithFallback]);\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AA+MA,IAAsB,iBAAtB,cAGU,cAEV;CACE;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA,QAAQ;CAER;CAEA;CAEA;CAEA;CAEA;CAEA,YAAY;CAEZ,cAAc;CAEd;CAEA;CAEA;CAEA;CAEA;CAEA;;CAGA;;CAGA;;;;;CAMA;CAEA;CAEA;CAEA;;;;;;;;;;;;CAaA;;;;;CAMA;;;;;;CAOA;;;;CAKA;CAEA,AAAU;CAEV,WAAW;AACT,SAAO;CACR;CAED,OAAO,UAAU;AACf,SAAO;CACR;CAED,IAAI,WAAW;AACb,SAAO;GACL,GAAG,MAAM;GACT;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;EACD;CACF;CAED,kBAAkB;CAElB,IAAI,aAAoD;AACtD,SAAO;GACL,QAAQ;GACR,cAAc;EACf;CACF;CAED,IAAI,aAAqC;AACvC,SAAO;GACL,QAAQ;GACR,WAAW;EACZ;CACF;CAED,IAAI,uBAAiC;AACnC,SAAO;GACL;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;EACD;CACF;CAED,YAAYA,SAAqD;EAC/D,MAAM,SAAS,KAAK,iBAAiB,QAAQ;AAC7C,SAAO;GACL,aAAa;GACb,eAAe,KAAK;GACpB,eAAe;GACf,gBAAgB,OAAO,eAAe;GACtC,eAAe,OAAO,cAAc;GACpC,SAAS,QAAQ;EAClB;CACF;;CAGD,qBAKkB;AAChB,SAAO;GACL,YAAY,KAAK;GACjB,GAAG,KAAK,kBAAkB;GAC1B,GAAG,KAAK;EACT;CACF;;;;CAKD,oBAAoB;AAClB,SAAO,KAAK,oBAAoB;CACjC;CAED,YAAYC,QAA+B;EACzC,MAAM,UAAU,CAAE,EAAC;EAEnB,MAAM,eACJ,OAAO,QAAQ,eAAe,WAAW,WACrC,QAAQ,eAAe,SACvB;EACN,KAAK,SACH,QAAQ,UACR,gBACA,uBAAuB,iBAAiB;EAC1C,KAAK,eACH,QAAQ,eAAe,gBACvB,uBAAuB,sBAAsB;EAE/C,KAAK,QAAQ,QAAQ,SAAS,QAAQ,aAAa,KAAK;EACxD,KAAK,cAAc,QAAQ,eAAe,CAAE;EAC5C,KAAK,UAAU,QAAQ;EAEvB,KAAK,cAAc,QAAQ,eAAe,KAAK;EAC/C,KAAK,OAAO,QAAQ,QAAQ,KAAK;EACjC,KAAK,mBAAmB,QAAQ,oBAAoB,KAAK;EACzD,KAAK,kBAAkB,QAAQ,mBAAmB,KAAK;EACvD,KAAK,WAAW,QAAQ;EACxB,KAAK,cAAc,QAAQ;EAC3B,KAAK,IAAI,QAAQ,KAAK,KAAK;EAC3B,KAAK,YAAY,QAAQ;EACzB,KAAK,OAAO,QAAQ,iBAAiB,QAAQ;EAC7C,KAAK,gBAAgB,KAAK;EAC1B,KAAK,OAAO,QAAQ;EACpB,KAAK,uBAAuB,QAAQ;EACpC,KAAK,QAAQ,QAAQ;EACrB,KAAK,aAAa,QAAQ;EAC1B,KAAK,YAAY,QAAQ;EACzB,KAAK,YAAY,QAAQ,uBAAuB,QAAQ;EACxD,KAAK,iBAAiB,QAAQ,kBAAkB,KAAK;EACrD,KAAK,YAAY,QAAQ,aAAa,KAAK;EAE3C,KAAK,mBAAmB,QAAQ,qBAAqB;EACrD,KAAK,YAAY,QAAQ,cAAc;AACvC,MAAI,KAAK,kBAAkB,KAAK,YAAY;AAE5C,MAAI,QAAQ,cAAc,OAAO,KAAK,mBAAmB;EAEzD,KAAK,cAAc,QAAQ,eAAe,KAAK;AAC/C,MAAI,KAAK,kBAAkB,KAAK,cAAc;EAE9C,KAAK,eAAe;GAClB,QAAQ,KAAK;GACb,cAAc,KAAK;GACnB,yBAAyB;GACzB,GAAG,QAAQ;EACZ;AAID,MAAI,QAAQ,8BAA8B,QACxC,KAAK,4BAA4B,OAAO;AAG1C,MAAI,QAAQ,iBAAiB,QAC3B,KAAK,eAAe,OAAO;EAG7B,KAAK,aAAa,QAAQ,cAAc;CACzC;;;;;CAMD,AAAU,oBACRC,SACoC;AACpC,MAAI,CAAC,iBAAiB,KAAK,MAAM,CAC/B;EAIF,IAAIC;AACJ,MAAI,KAAK,cAAc,QACrB,YAAY;GACV,GAAG;GACH,GAAG,KAAK;EACT;AAEH,MAAI,SAAS,cAAc,QACzB,YAAY;GACV,GAAG;GACH,GAAG,QAAQ;EACZ;AAGH,SAAO;CACR;;;;;CAMD,AAAU,mBACRC,WACyC;AACzC,MACE,aACA,UAAU,SAAS,iBACnB,UAAU,YAAY,UACtB,mBAAmB,UAAU,YAAY,OAAO,CAEhD,QAAO,yBACL,UAAU,YAAY,QACtB,UAAU,YAAY,MACtB,EACE,aAAa,UAAU,YAAY,YACpC,EACF;AAEH,SAAO;CACR;CAED,AAAU,oBACRC,mBAC2B;AAC3B,SAAO;GACL,GAAG,KAAK;GACR,GAAI,qBAAqB,CAAE;EAC5B;CACF;;CAGD,kBACEC,SAC0B;AAC1B,MAAI,CAAC,KAAK,QAAQ;GAChB,MAAMC,uBAA6C,EACjD,SAAS,KAAK,aAAa,QAC5B;GAED,MAAM,WAAW,YAAY,qBAAqB;GAClD,MAAM,SAAS;IACb,GAAG,KAAK;IACR,SAAS;IACT,SAAS,KAAK;IACd,YAAY;GACb;AACD,OAAI,CAAC,OAAO,SACV,OAAO,OAAO;GAGhB,KAAK,SAAS,IAAIC,SAAa;EAChC;EACD,MAAM,iBAAiB;GACrB,GAAG,KAAK;GACR,GAAG;EACJ;AACD,SAAO;CACR;CAGD,AAAU,wCACRC,MACAC,QACiC;AACjC,MAAI,aAAa,KAAK,CACpB,QAAO,2BAA2B,KAAK,SAAS,WAAW;AAE7D,MAAIC,aAAqB,KAAK,EAAE;AAC9B,OAAI,QAAQ,WAAW,OACrB,QAAO;IACL,GAAG;IACH,UAAU;KACR,GAAG,KAAK;KACR,QAAQ,OAAO;IAChB;GACF;AAGH,UAAO;EACR;AACD,SAAO,qBAAqB,MAAM,OAAO;CAC1C;CAED,AAAS,UACPC,OACAC,QAC+D;EAC/D,IAAIC;AACJ,MAAI,QAAQ,WAAW,QACrB,SAAS,OAAO;WACP,KAAK,8BAA8B,QAC5C,SAAS,KAAK;AAEhB,SAAO,KAAK,WAAW;GACrB,OAAO,MAAM,IAAI,CAAC,SAChB,cAAc,KAAK,IAAI,aAAa,KAAK,GACrC,OACA,KAAK,wCAAwC,MAAM,EAAE,OAAQ,EAAC,CACnE;GACD,GAAG;EACJ,EAAyB;CAC3B;CAED,MAAe,OAAOC,OAA+BC,SAAuB;AAC1E,SAAO,MAAM,OACX,OACA,KAAK,oBAAoB,QAAQ,CAClC;CACF;CAED,MAAe,OAAOD,OAA+BC,SAAuB;AAC1E,SAAO,MAAM,OACX,OACA,KAAK,oBAAoB,QAAQ,CAClC;CACF;;CAGD,kBAAkB,GAAG,YAAgD;AACnE,SAAO,WAAW,OAGhB,CAAC,KAAK,cAAc;AAClB,OAAI,aAAa,UAAU,YAAY;IACrC,IAAI,WAAW,oBACb,UAAU,WAAW,oBAAoB;IAC3C,IAAI,WAAW,gBAAgB,UAAU,WAAW,gBAAgB;IACpE,IAAI,WAAW,eAAe,UAAU,WAAW,eAAe;GACnE;AACD,UAAO;EACR,GACD,EACE,YAAY;GACV,kBAAkB;GAClB,cAAc;GACd,aAAa;EACd,EACF,EACF;CACF;CAED,MAAM,yBAAyBC,UAAyB;EACtD,IAAI,aAAa;EACjB,IAAI,mBAAmB;EACvB,IAAI,gBAAgB;AAGpB,MAAI,KAAK,UAAU,sBAAsB;GACvC,mBAAmB;GACnB,gBAAgB;EACjB,OAAM;GACL,mBAAmB;GACnB,gBAAgB;EACjB;EAED,MAAM,kBAAkB,MAAM,QAAQ,IACpC,SAAS,IAAI,OAAO,YAAY;GAC9B,MAAM,YAAY,MAAM,KAAK,aAAa,QAAQ,QAAQ;GAC1D,MAAM,YAAY,MAAM,KAAK,aAAa,oBAAoB,QAAQ,CAAC;GACvE,MAAM,YACJ,QAAQ,SAAS,SACb,gBAAiB,MAAM,KAAK,aAAa,QAAQ,KAAK,GACtD;GACN,IAAI,QAAQ,YAAY,mBAAmB,YAAY;GAGvD,MAAM,gBAAgB;AACtB,OAAI,cAAc,UAAU,KAAK,YAC/B,SAAS;AAEX,OAAI,cAAc,mBAAmB,eACnC,SAAS;AAEX,OAAI,eAAe,kBAAkB,eAAe,MAClD,SAAS,MAAM,KAAK,aAClB,cAAc,kBAAkB,eAAe,KAChD;AAEH,OAAI,cAAc,kBAAkB,eAAe,UACjD,KAAI;IACF,SAAS,MAAM,KAAK,aAElB,KAAK,UACH,KAAK,MACH,cAAc,kBAAkB,eAAe,UAChD,CACF,CACF;GACF,SAAQ,OAAO;IACd,QAAQ,MACN,oCACA,OACA,KAAK,UAAU,cAAc,kBAAkB,cAAc,CAC9D;IACD,SAAS,MAAM,KAAK,aAClB,cAAc,kBAAkB,eAAe,UAChD;GACF;GAGH,cAAc;AACd,UAAO;EACR,EAAC,CACH;EAED,cAAc;AAEd,SAAO;GAAE;GAAY;EAAiB;CACvC;;CAGD,MAAgB,6BAA6BC,aAA+B;EAC1E,MAAM,mBAAmB,MAAM,QAAQ,IACrC,YAAY,IAAI,OAAO,eAAe;AACpC,OAAI,WAAW,QAAQ,mBAAmB,cACxC,SAAQ,MAAM,KAAK,yBAAyB,CAAC,WAAW,OAAQ,EAAC,EAC9D,gBAAgB;OAEnB,QAAO,MAAM,KAAK,aAAa,WAAW,QAAQ,QAAQ;EAE7D,EAAC,CACH;AAED,SAAO,iBAAiB,OAAO,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE;CACnD;;CAGD,MAAgB,kCACdD,UACAE,WACAC,eAIiB;EAIjB,IAAI,UAAU,MAAM,KAAK,yBAAyB,SAAS,EAAE;AAG7D,MAAI,aAAa,kBAAkB,QAAQ;GACzC,MAAM,oBAAoB,0BACxB,UACD;GACD,UAAU,MAAM,KAAK,aAAa,kBAAkB;GACpD,UAAU;EACX;AAKD,MAAI,aAAa,SAAS,KAAK,CAAC,MAAM,EAAE,UAAU,KAAK,SAAS,EAC9D,UAAU;AAMZ,MAAI,kBAAkB,QACpB,UAAU;WACD,OAAO,kBAAkB,UAClC,UAAW,MAAM,KAAK,aAAa,cAAc,KAAK,GAAI;AAG5D,SAAO;CACR;;;;;;;;;;;;;;;;;;CAmBD,IAAI,UAAwB;AAC1B,SAAOC,iBAAS,KAAK,UAAU,CAAE;CAClC;;CAGD,AAAU,2BACRC,QACA;EACA,MAAM,gBAAgB,EAAE,GAAG,OAAQ;AACnC,MACE,CAAC,KAAK,MAAM,WAAW,QAAQ,IAC/B,CAAC,KAAK,MAAM,WAAW,SAAS,IAChC,KAAK,UAAU,SAEf;OAAI,eAAe,WAAW,OAC5B,QAAO;EACR,WACQ,cAAc,WAAW,cAClC,QAAQ,KACN,CAAC,mDAAmD,EAAE,KAAK,MAAM,gCAAgC,CAAC,CACnG;AAEH,SAAO,cAAc;CACtB;;;;;;;;;;;;;;;;;;;;CAwDD,qBAGEC,cACAC,QACA;EACA,IAAIC;EACJ,IAAIC;EAEJ,MAAM,EAAE,QAAQ,MAAM,YAAY,GAAG;GACnC,GAAG;GACH,QAAQ;EACT;AAED,MAAI,QAAQ,WAAW,UAAa,OAAO,WAAW,WACpD,OAAM,IAAI,MACR;EAIJ,MAAM,SAAS,0BAA0B,KAAK,OAAO,QAAQ,OAAO;AAEpE,MAAI,WAAW,YAAY;AACzB,OAAI,mBAAmB,OAAO,EAC5B,eAAe,uBAAuB,cAAc,OAAO;QAE3D,eAAe,IAAI;GAErB,MAAM,eAAe,aAAa,OAAO;GACzC,MAAM,KAAK,WAAW;IACpB,eAAe;IACf,iBAAiB,EAAE,MAAM,cAAe;IACxC,6BAA6B;KAC3B,QAAQ,EAAE,QAAQ,YAAa;KAC/B,QAAQ;MAAE,OAAO,QAAQ;MAAW,GAAG;KAAc;IACtD;GACF,EAAyB;EAC3B,WAAU,WAAW,cAAc;GAClC,MAAM,yBAAyB;IAC7B,MAAM,QAAQ;IACd,aAAa,qBAAqB,OAAO;IACzC;IACA,QAAQ,QAAQ;GACjB;GACD,MAAM,eAAe,aAAa,uBAAuB,OAAO;GAChE,MAAM,KAAK,WAAW;IACpB,eAAe;IACf,iBAAiB;KACf,MAAM;KACN,aAAa;IACd;IACD,6BAA6B;KAC3B,QAAQ,EAAE,QAAQ,cAAe;KACjC,QAAQ;MACN,OAAO,uBAAuB;MAC9B,aAAa,uBAAuB;MACpC,GAAG;KACJ;IACF;GACF,EAAyB;AAC1B,OAAI,mBAAmB,OAAO,EAAE;IAC9B,MAAM,YAAY,uBAAuB,cAAc,OAAO;IAC9D,eAAe,eAAe,KAC5B,CAACC,cAA8B;AAC7B,SAAI,YAAY,UAAU,kBACxB,QAAO,UAAU,kBAAkB;AAErC,YAAO;IACR,EACF;GACF,OACC,eAAe,IAAI;EAEtB,OAAM;GACL,IAAI,eAAe,QAAQ;AAE3B,OAAI,mBAAmB,OAAO,EAAE;IAC9B,MAAM,eAAe,aAAa,OAAO;IACzC,MAAM,KAAK,WAAW;KACpB,eAAe;KACf,OAAO,CACL;MACE,MAAM;MACN,UAAU;OACR,MAAM;OACN,aAAa,aAAa;OAC1B,YAAY;MACb;KACF,CACF;KACD,aAAa;MACX,MAAM;MACN,UAAU,EACR,MAAM,aACP;KACF;KACD,6BAA6B;MAC3B,QAAQ,EAAE,QAAQ,mBAAoB;MACtC,QAAQ;OAAE,OAAO;OAAc,GAAG;MAAc;KACjD;KAED,GAAI,QAAQ,WAAW,SAAY,EAAE,QAAQ,OAAO,OAAQ,IAAG,CAAE;IAClE,EAAyB;IAC1B,eAAe,IAAI,yBAAyB;KAC1C,cAAc;KACd,SAAS;KACT,WAAW;IACZ;GACF,OAAM;IACL,IAAIC;AACJ,QACE,OAAO,OAAO,SAAS,YACvB,OAAO,OAAO,eAAe,YAC7B,OAAO,cAAc,MACrB;KACA,2BAA2B;KAC3B,eAAe,OAAO;IACvB,OAAM;KACL,eAAgB,OAAO,SAAoB;KAC3C,2BAA2B;MACzB,MAAM;MACN,aAAc,OAAO,eAA0B;MAC/C,YAAY;KACb;IACF;IACD,MAAM,eAAe,aAAa,OAAO;IACzC,MAAM,KAAK,WAAW;KACpB,eAAe;KACf,OAAO,CACL;MACE,MAAM;MACN,UAAU;KACX,CACF;KACD,aAAa;MACX,MAAM;MACN,UAAU,EACR,MAAM,aACP;KACF;KACD,6BAA6B;MAC3B,QAAQ,EAAE,QAAQ,mBAAoB;MACtC,QAAQ;OAAE,OAAO;OAAc,GAAG;MAAc;KACjD;KAED,GAAI,QAAQ,WAAW,SAAY,EAAE,QAAQ,OAAO,OAAQ,IAAG,CAAE;IAClE,EAAyB;IAC1B,eAAe,IAAI,yBAAoC;KACrD,cAAc;KACd,SAAS;IACV;GACF;EACF;AAED,MAAI,CAAC,WACH,QAAO,IAAI,KAAK,aAAa;EAM/B,MAAM,eAAe,oBAAoB,OAAO,EAE9C,QAAQ,CAACC,OAAYC,aAAW,aAAa,OAAO,MAAM,KAAKA,SAAO,CACvE,EAAC;EACF,MAAM,aAAa,oBAAoB,OAAO,EAC5C,QAAQ,MAAM,KACf,EAAC;EACF,MAAM,qBAAqB,aAAa,cAAc,EACpD,WAAW,CAAC,UAAW,EACxB,EAAC;AACF,SAAO,iBAAiB,KAGtB,CAAC,EAAE,KAAK,IAAK,GAAE,kBAAmB,EAAC;CACtC;AACF"}
1
+ {"version":3,"file":"base.js","names":["options: this[\"ParsedCallOptions\"]","fields?: BaseChatOpenAIFields","options?: this[\"ParsedCallOptions\"]","reasoning: OpenAIClient.Reasoning | undefined","resFormat?: CallOptions[\"response_format\"]","additionalOptions?: this[\"ParsedCallOptions\"]","options: OpenAICoreRequestOptions | undefined","openAIEndpointConfig: OpenAIEndpointConfig","OpenAIClient","tool: ChatOpenAIToolType","fields?: { strict?: boolean }","isOpenAIFunctionTool","tools: ChatOpenAIToolType[]","kwargs?: Partial<CallOptions>","strict: boolean | undefined","input: BaseLanguageModelInput","options?: CallOptions","messages: BaseMessage[]","generations: ChatGeneration[]","functions?: OpenAIClient.Chat.ChatCompletionCreateParams.Function[]","function_call?:\n | \"none\"\n | \"auto\"\n | OpenAIClient.Chat.ChatCompletionFunctionCallOption","PROFILES","config: StructuredOutputMethodOptions<boolean>","outputSchema: InteropZodType<RunOutput> | Record<string, unknown>","config?: StructuredOutputMethodOptions<boolean>","llm: Runnable<BaseLanguageModelInput>","outputParser: Runnable<AIMessageChunk, RunOutput>","aiMessage: AIMessageChunk","openAIFunctionDefinition: FunctionDefinition","input: any","config"],"sources":["../../src/chat_models/base.ts"],"sourcesContent":["import { type ClientOptions, OpenAI as OpenAIClient } from \"openai\";\nimport { AIMessageChunk, type BaseMessage } from \"@langchain/core/messages\";\nimport { type ChatGeneration } from \"@langchain/core/outputs\";\nimport { getEnvironmentVariable } from \"@langchain/core/utils/env\";\nimport {\n BaseChatModel,\n type LangSmithParams,\n type BaseChatModelParams,\n BaseChatModelCallOptions,\n} from \"@langchain/core/language_models/chat_models\";\nimport {\n isOpenAITool as isOpenAIFunctionTool,\n type BaseFunctionCallOptions,\n type BaseLanguageModelInput,\n type FunctionDefinition,\n type StructuredOutputMethodOptions,\n} from \"@langchain/core/language_models/base\";\nimport { ModelProfile } from \"@langchain/core/language_models/profile\";\nimport {\n Runnable,\n RunnableLambda,\n RunnablePassthrough,\n RunnableSequence,\n} from \"@langchain/core/runnables\";\nimport {\n JsonOutputParser,\n StructuredOutputParser,\n} from \"@langchain/core/output_parsers\";\nimport { JsonOutputKeyToolsParser } from \"@langchain/core/output_parsers/openai_tools\";\nimport {\n getSchemaDescription,\n InteropZodType,\n isInteropZodSchema,\n} from \"@langchain/core/utils/types\";\nimport { toJsonSchema } from \"@langchain/core/utils/json_schema\";\nimport {\n type OpenAICallOptions,\n type OpenAIChatInput,\n type OpenAICoreRequestOptions,\n type ChatOpenAIResponseFormat,\n ResponseFormatConfiguration,\n OpenAIVerbosityParam,\n type OpenAIApiKey,\n} from \"../types.js\";\nimport {\n type OpenAIEndpointConfig,\n getEndpoint,\n getHeadersWithUserAgent,\n} from \"../utils/azure.js\";\nimport {\n type FunctionDef,\n formatFunctionDefinitions,\n OpenAIToolChoice,\n _convertToOpenAITool,\n ChatOpenAIToolType,\n convertResponsesCustomTool,\n isBuiltInTool,\n isCustomTool,\n ResponsesToolChoice,\n} from \"../utils/tools.js\";\nimport {\n getStructuredOutputMethod,\n interopZodResponseFormat,\n _convertOpenAIResponsesUsageToLangChainUsage,\n} from \"../utils/output.js\";\nimport { isReasoningModel, messageToOpenAIRole } from \"../utils/misc.js\";\nimport PROFILES from \"./profiles.js\";\n\ninterface OpenAILLMOutput {\n tokenUsage: {\n completionTokens?: number;\n promptTokens?: number;\n totalTokens?: number;\n };\n}\n\nexport type { OpenAICallOptions, OpenAIChatInput };\n\nexport interface BaseChatOpenAICallOptions\n extends BaseChatModelCallOptions,\n BaseFunctionCallOptions {\n /**\n * Additional options to pass to the underlying axios request.\n */\n options?: OpenAICoreRequestOptions;\n\n /**\n * A list of tools that the model may use to generate responses.\n * Each tool can be a function, a built-in tool, or a custom tool definition.\n * If not provided, the model will not use any tools.\n */\n tools?: ChatOpenAIToolType[];\n\n /**\n * Specifies which tool the model should use to respond.\n * Can be an {@link OpenAIToolChoice} or a {@link ResponsesToolChoice}.\n * If not set, the model will decide which tool to use automatically.\n */\n // TODO: break OpenAIToolChoice and ResponsesToolChoice into options sub classes\n tool_choice?: OpenAIToolChoice | ResponsesToolChoice;\n\n /**\n * Adds a prompt index to prompts passed to the model to track\n * what prompt is being used for a given generation.\n */\n promptIndex?: number;\n\n /**\n * An object specifying the format that the model must output.\n */\n response_format?: ChatOpenAIResponseFormat;\n\n /**\n * When provided, the completions API will make a best effort to sample\n * deterministically, such that repeated requests with the same `seed`\n * and parameters should return the same result.\n */\n seed?: number;\n\n /**\n * Additional options to pass to streamed completions.\n * If provided, this takes precedence over \"streamUsage\" set at\n * initialization time.\n */\n stream_options?: OpenAIClient.Chat.ChatCompletionStreamOptions;\n\n /**\n * The model may choose to call multiple functions in a single turn. You can\n * set parallel_tool_calls to false which ensures only one tool is called at most.\n * [Learn more](https://platform.openai.com/docs/guides/function-calling#parallel-function-calling)\n */\n parallel_tool_calls?: boolean;\n\n /**\n * If `true`, model output is guaranteed to exactly match the JSON Schema\n * provided in the tool definition. If `true`, the input schema will also be\n * validated according to\n * https://platform.openai.com/docs/guides/structured-outputs/supported-schemas.\n *\n * If `false`, input schema will not be validated and model output will not\n * be validated.\n *\n * If `undefined`, `strict` argument will not be passed to the model.\n */\n strict?: boolean;\n\n /**\n * Output types that you would like the model to generate for this request. Most\n * models are capable of generating text, which is the default:\n *\n * `[\"text\"]`\n *\n * The `gpt-4o-audio-preview` model can also be used to\n * [generate audio](https://platform.openai.com/docs/guides/audio). To request that\n * this model generate both text and audio responses, you can use:\n *\n * `[\"text\", \"audio\"]`\n */\n modalities?: Array<OpenAIClient.Chat.ChatCompletionModality>;\n\n /**\n * Parameters for audio output. Required when audio output is requested with\n * `modalities: [\"audio\"]`.\n * [Learn more](https://platform.openai.com/docs/guides/audio).\n */\n audio?: OpenAIClient.Chat.ChatCompletionAudioParam;\n\n /**\n * Static predicted output content, such as the content of a text file that is being regenerated.\n * [Learn more](https://platform.openai.com/docs/guides/latency-optimization#use-predicted-outputs).\n */\n prediction?: OpenAIClient.ChatCompletionPredictionContent;\n\n /**\n * Options for reasoning models.\n *\n * Note that some options, like reasoning summaries, are only available when using the responses\n * API. If these options are set, the responses API will be used to fulfill the request.\n *\n * These options will be ignored when not using a reasoning model.\n */\n reasoning?: OpenAIClient.Reasoning;\n\n /**\n * Service tier to use for this request. Can be \"auto\", \"default\", or \"flex\"\n * Specifies the service tier for prioritization and latency optimization.\n */\n service_tier?: OpenAIClient.Chat.ChatCompletionCreateParams[\"service_tier\"];\n\n /**\n * Used by OpenAI to cache responses for similar requests to optimize your cache\n * hit rates. Replaces the `user` field.\n * [Learn more](https://platform.openai.com/docs/guides/prompt-caching).\n */\n promptCacheKey?: string;\n\n /**\n * The verbosity of the model's response.\n */\n verbosity?: OpenAIVerbosityParam;\n}\n\nexport interface BaseChatOpenAIFields\n extends Partial<OpenAIChatInput>,\n BaseChatModelParams {\n /**\n * Optional configuration options for the OpenAI client.\n */\n configuration?: ClientOptions;\n}\n\n/** @internal */\nexport abstract class BaseChatOpenAI<\n CallOptions extends BaseChatOpenAICallOptions\n >\n extends BaseChatModel<CallOptions, AIMessageChunk>\n implements Partial<OpenAIChatInput>\n{\n temperature?: number;\n\n topP?: number;\n\n frequencyPenalty?: number;\n\n presencePenalty?: number;\n\n n?: number;\n\n logitBias?: Record<string, number>;\n\n model = \"gpt-3.5-turbo\";\n\n modelKwargs?: OpenAIChatInput[\"modelKwargs\"];\n\n stop?: string[];\n\n stopSequences?: string[];\n\n user?: string;\n\n timeout?: number;\n\n streaming = false;\n\n streamUsage = true;\n\n maxTokens?: number;\n\n logprobs?: boolean;\n\n topLogprobs?: number;\n\n apiKey?: OpenAIApiKey;\n\n organization?: string;\n\n __includeRawResponse?: boolean;\n\n /** @internal */\n client: OpenAIClient;\n\n /** @internal */\n clientConfig: ClientOptions;\n\n /**\n * Whether the model supports the `strict` argument when passing in tools.\n * If `undefined` the `strict` argument will not be passed to OpenAI.\n */\n supportsStrictToolCalling?: boolean;\n\n audio?: OpenAIClient.Chat.ChatCompletionAudioParam;\n\n modalities?: Array<OpenAIClient.Chat.ChatCompletionModality>;\n\n reasoning?: OpenAIClient.Reasoning;\n\n /**\n * Must be set to `true` in tenancies with Zero Data Retention. Setting to `true` will disable\n * output storage in the Responses API, but this DOES NOT enable Zero Data Retention in your\n * OpenAI organization or project. This must be configured directly with OpenAI.\n *\n * See:\n * https://platform.openai.com/docs/guides/your-data\n * https://platform.openai.com/docs/api-reference/responses/create#responses-create-store\n *\n * @default false\n */\n zdrEnabled?: boolean | undefined;\n\n /**\n * Service tier to use for this request. Can be \"auto\", \"default\", or \"flex\" or \"priority\".\n * Specifies the service tier for prioritization and latency optimization.\n */\n service_tier?: OpenAIClient.Chat.ChatCompletionCreateParams[\"service_tier\"];\n\n /**\n * Used by OpenAI to cache responses for similar requests to optimize your cache\n * hit rates.\n * [Learn more](https://platform.openai.com/docs/guides/prompt-caching).\n */\n promptCacheKey: string;\n\n /**\n * The verbosity of the model's response.\n */\n verbosity?: OpenAIVerbosityParam;\n\n protected defaultOptions: CallOptions;\n\n _llmType() {\n return \"openai\";\n }\n\n static lc_name() {\n return \"ChatOpenAI\";\n }\n\n get callKeys() {\n return [\n ...super.callKeys,\n \"options\",\n \"function_call\",\n \"functions\",\n \"tools\",\n \"tool_choice\",\n \"promptIndex\",\n \"response_format\",\n \"seed\",\n \"reasoning\",\n \"service_tier\",\n ];\n }\n\n lc_serializable = true;\n\n get lc_secrets(): { [key: string]: string } | undefined {\n return {\n apiKey: \"OPENAI_API_KEY\",\n organization: \"OPENAI_ORGANIZATION\",\n };\n }\n\n get lc_aliases(): Record<string, string> {\n return {\n apiKey: \"openai_api_key\",\n modelName: \"model\",\n };\n }\n\n get lc_serializable_keys(): string[] {\n return [\n \"configuration\",\n \"logprobs\",\n \"topLogprobs\",\n \"prefixMessages\",\n \"supportsStrictToolCalling\",\n \"modalities\",\n \"audio\",\n \"temperature\",\n \"maxTokens\",\n \"topP\",\n \"frequencyPenalty\",\n \"presencePenalty\",\n \"n\",\n \"logitBias\",\n \"user\",\n \"streaming\",\n \"streamUsage\",\n \"model\",\n \"modelName\",\n \"modelKwargs\",\n \"stop\",\n \"stopSequences\",\n \"timeout\",\n \"apiKey\",\n \"cache\",\n \"maxConcurrency\",\n \"maxRetries\",\n \"verbose\",\n \"callbacks\",\n \"tags\",\n \"metadata\",\n \"disableStreaming\",\n \"zdrEnabled\",\n \"reasoning\",\n \"promptCacheKey\",\n \"verbosity\",\n ];\n }\n\n getLsParams(options: this[\"ParsedCallOptions\"]): LangSmithParams {\n const params = this.invocationParams(options);\n return {\n ls_provider: \"openai\",\n ls_model_name: this.model,\n ls_model_type: \"chat\",\n ls_temperature: params.temperature ?? undefined,\n ls_max_tokens: params.max_tokens ?? undefined,\n ls_stop: options.stop,\n };\n }\n\n /** @ignore */\n _identifyingParams(): Omit<\n OpenAIClient.Chat.ChatCompletionCreateParams,\n \"messages\"\n > & {\n model_name: string;\n } & ClientOptions {\n return {\n model_name: this.model,\n ...this.invocationParams(),\n ...this.clientConfig,\n };\n }\n\n /**\n * Get the identifying parameters for the model\n */\n identifyingParams() {\n return this._identifyingParams();\n }\n\n constructor(fields?: BaseChatOpenAIFields) {\n super(fields ?? {});\n\n const configApiKey =\n typeof fields?.configuration?.apiKey === \"string\" ||\n typeof fields?.configuration?.apiKey === \"function\"\n ? fields?.configuration?.apiKey\n : undefined;\n this.apiKey =\n fields?.apiKey ??\n configApiKey ??\n getEnvironmentVariable(\"OPENAI_API_KEY\");\n this.organization =\n fields?.configuration?.organization ??\n getEnvironmentVariable(\"OPENAI_ORGANIZATION\");\n\n this.model = fields?.model ?? fields?.modelName ?? this.model;\n this.modelKwargs = fields?.modelKwargs ?? {};\n this.timeout = fields?.timeout;\n\n this.temperature = fields?.temperature ?? this.temperature;\n this.topP = fields?.topP ?? this.topP;\n this.frequencyPenalty = fields?.frequencyPenalty ?? this.frequencyPenalty;\n this.presencePenalty = fields?.presencePenalty ?? this.presencePenalty;\n this.logprobs = fields?.logprobs;\n this.topLogprobs = fields?.topLogprobs;\n this.n = fields?.n ?? this.n;\n this.logitBias = fields?.logitBias;\n this.stop = fields?.stopSequences ?? fields?.stop;\n this.stopSequences = this.stop;\n this.user = fields?.user;\n this.__includeRawResponse = fields?.__includeRawResponse;\n this.audio = fields?.audio;\n this.modalities = fields?.modalities;\n this.reasoning = fields?.reasoning;\n this.maxTokens = fields?.maxCompletionTokens ?? fields?.maxTokens;\n this.promptCacheKey = fields?.promptCacheKey ?? this.promptCacheKey;\n this.verbosity = fields?.verbosity ?? this.verbosity;\n\n this.disableStreaming = fields?.disableStreaming === true;\n this.streaming = fields?.streaming === true;\n if (this.disableStreaming) this.streaming = false;\n // disable streaming in BaseChatModel if explicitly disabled\n if (fields?.streaming === false) this.disableStreaming = true;\n\n this.streamUsage = fields?.streamUsage ?? this.streamUsage;\n if (this.disableStreaming) this.streamUsage = false;\n\n this.clientConfig = {\n apiKey: this.apiKey,\n organization: this.organization,\n dangerouslyAllowBrowser: true,\n ...fields?.configuration,\n };\n\n // If `supportsStrictToolCalling` is explicitly set, use that value.\n // Else leave undefined so it's not passed to OpenAI.\n if (fields?.supportsStrictToolCalling !== undefined) {\n this.supportsStrictToolCalling = fields.supportsStrictToolCalling;\n }\n\n if (fields?.service_tier !== undefined) {\n this.service_tier = fields.service_tier;\n }\n\n this.zdrEnabled = fields?.zdrEnabled ?? false;\n }\n\n /**\n * Returns backwards compatible reasoning parameters from constructor params and call options\n * @internal\n */\n protected _getReasoningParams(\n options?: this[\"ParsedCallOptions\"]\n ): OpenAIClient.Reasoning | undefined {\n if (!isReasoningModel(this.model)) {\n return;\n }\n\n // apply options in reverse order of importance -- newer options supersede older options\n let reasoning: OpenAIClient.Reasoning | undefined;\n if (this.reasoning !== undefined) {\n reasoning = {\n ...reasoning,\n ...this.reasoning,\n };\n }\n if (options?.reasoning !== undefined) {\n reasoning = {\n ...reasoning,\n ...options.reasoning,\n };\n }\n\n return reasoning;\n }\n\n /**\n * Returns an openai compatible response format from a set of options\n * @internal\n */\n protected _getResponseFormat(\n resFormat?: CallOptions[\"response_format\"]\n ): ResponseFormatConfiguration | undefined {\n if (\n resFormat &&\n resFormat.type === \"json_schema\" &&\n resFormat.json_schema.schema &&\n isInteropZodSchema(resFormat.json_schema.schema)\n ) {\n return interopZodResponseFormat(\n resFormat.json_schema.schema,\n resFormat.json_schema.name,\n {\n description: resFormat.json_schema.description,\n }\n );\n }\n return resFormat as ResponseFormatConfiguration | undefined;\n }\n\n protected _combineCallOptions(\n additionalOptions?: this[\"ParsedCallOptions\"]\n ): this[\"ParsedCallOptions\"] {\n return {\n ...this.defaultOptions,\n ...(additionalOptions ?? {}),\n };\n }\n\n /** @internal */\n _getClientOptions(\n options: OpenAICoreRequestOptions | undefined\n ): OpenAICoreRequestOptions {\n if (!this.client) {\n const openAIEndpointConfig: OpenAIEndpointConfig = {\n baseURL: this.clientConfig.baseURL,\n };\n\n const endpoint = getEndpoint(openAIEndpointConfig);\n const params = {\n ...this.clientConfig,\n baseURL: endpoint,\n timeout: this.timeout,\n maxRetries: 0,\n };\n if (!params.baseURL) {\n delete params.baseURL;\n }\n\n params.defaultHeaders = getHeadersWithUserAgent(params.defaultHeaders);\n\n this.client = new OpenAIClient(params);\n }\n const requestOptions = {\n ...this.clientConfig,\n ...options,\n } as OpenAICoreRequestOptions;\n return requestOptions;\n }\n\n // TODO: move to completions class\n protected _convertChatOpenAIToolToCompletionsTool(\n tool: ChatOpenAIToolType,\n fields?: { strict?: boolean }\n ): OpenAIClient.ChatCompletionTool {\n if (isCustomTool(tool)) {\n return convertResponsesCustomTool(tool.metadata.customTool);\n }\n if (isOpenAIFunctionTool(tool)) {\n if (fields?.strict !== undefined) {\n return {\n ...tool,\n function: {\n ...tool.function,\n strict: fields.strict,\n },\n };\n }\n\n return tool;\n }\n return _convertToOpenAITool(tool, fields);\n }\n\n override bindTools(\n tools: ChatOpenAIToolType[],\n kwargs?: Partial<CallOptions>\n ): Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions> {\n let strict: boolean | undefined;\n if (kwargs?.strict !== undefined) {\n strict = kwargs.strict;\n } else if (this.supportsStrictToolCalling !== undefined) {\n strict = this.supportsStrictToolCalling;\n }\n return this.withConfig({\n tools: tools.map((tool) =>\n isBuiltInTool(tool) || isCustomTool(tool)\n ? tool\n : this._convertChatOpenAIToolToCompletionsTool(tool, { strict })\n ),\n ...kwargs,\n } as Partial<CallOptions>);\n }\n\n override async stream(input: BaseLanguageModelInput, options?: CallOptions) {\n return super.stream(\n input,\n this._combineCallOptions(options) as CallOptions\n );\n }\n\n override async invoke(input: BaseLanguageModelInput, options?: CallOptions) {\n return super.invoke(\n input,\n this._combineCallOptions(options) as CallOptions\n );\n }\n\n /** @ignore */\n _combineLLMOutput(...llmOutputs: OpenAILLMOutput[]): OpenAILLMOutput {\n return llmOutputs.reduce<{\n [key in keyof OpenAILLMOutput]: Required<OpenAILLMOutput[key]>;\n }>(\n (acc, llmOutput) => {\n if (llmOutput && llmOutput.tokenUsage) {\n acc.tokenUsage.completionTokens +=\n llmOutput.tokenUsage.completionTokens ?? 0;\n acc.tokenUsage.promptTokens += llmOutput.tokenUsage.promptTokens ?? 0;\n acc.tokenUsage.totalTokens += llmOutput.tokenUsage.totalTokens ?? 0;\n }\n return acc;\n },\n {\n tokenUsage: {\n completionTokens: 0,\n promptTokens: 0,\n totalTokens: 0,\n },\n }\n );\n }\n\n async getNumTokensFromMessages(messages: BaseMessage[]) {\n let totalCount = 0;\n let tokensPerMessage = 0;\n let tokensPerName = 0;\n\n // From: https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb\n if (this.model === \"gpt-3.5-turbo-0301\") {\n tokensPerMessage = 4;\n tokensPerName = -1;\n } else {\n tokensPerMessage = 3;\n tokensPerName = 1;\n }\n\n const countPerMessage = await Promise.all(\n messages.map(async (message) => {\n const textCount = await this.getNumTokens(message.content);\n const roleCount = await this.getNumTokens(messageToOpenAIRole(message));\n const nameCount =\n message.name !== undefined\n ? tokensPerName + (await this.getNumTokens(message.name))\n : 0;\n let count = textCount + tokensPerMessage + roleCount + nameCount;\n\n // From: https://github.com/hmarr/openai-chat-tokens/blob/main/src/index.ts messageTokenEstimate\n const openAIMessage = message;\n if (openAIMessage._getType() === \"function\") {\n count -= 2;\n }\n if (openAIMessage.additional_kwargs?.function_call) {\n count += 3;\n }\n if (openAIMessage?.additional_kwargs.function_call?.name) {\n count += await this.getNumTokens(\n openAIMessage.additional_kwargs.function_call?.name\n );\n }\n if (openAIMessage.additional_kwargs.function_call?.arguments) {\n try {\n count += await this.getNumTokens(\n // Remove newlines and spaces\n JSON.stringify(\n JSON.parse(\n openAIMessage.additional_kwargs.function_call?.arguments\n )\n )\n );\n } catch (error) {\n console.error(\n \"Error parsing function arguments\",\n error,\n JSON.stringify(openAIMessage.additional_kwargs.function_call)\n );\n count += await this.getNumTokens(\n openAIMessage.additional_kwargs.function_call?.arguments\n );\n }\n }\n\n totalCount += count;\n return count;\n })\n );\n\n totalCount += 3; // every reply is primed with <|start|>assistant<|message|>\n\n return { totalCount, countPerMessage };\n }\n\n /** @internal */\n protected async _getNumTokensFromGenerations(generations: ChatGeneration[]) {\n const generationUsages = await Promise.all(\n generations.map(async (generation) => {\n if (generation.message.additional_kwargs?.function_call) {\n return (await this.getNumTokensFromMessages([generation.message]))\n .countPerMessage[0];\n } else {\n return await this.getNumTokens(generation.message.content);\n }\n })\n );\n\n return generationUsages.reduce((a, b) => a + b, 0);\n }\n\n /** @internal */\n protected async _getEstimatedTokenCountFromPrompt(\n messages: BaseMessage[],\n functions?: OpenAIClient.Chat.ChatCompletionCreateParams.Function[],\n function_call?:\n | \"none\"\n | \"auto\"\n | OpenAIClient.Chat.ChatCompletionFunctionCallOption\n ): Promise<number> {\n // It appears that if functions are present, the first system message is padded with a trailing newline. This\n // was inferred by trying lots of combinations of messages and functions and seeing what the token counts were.\n\n let tokens = (await this.getNumTokensFromMessages(messages)).totalCount;\n\n // If there are functions, add the function definitions as they count towards token usage\n if (functions && function_call !== \"auto\") {\n const promptDefinitions = formatFunctionDefinitions(\n functions as unknown as FunctionDef[]\n );\n tokens += await this.getNumTokens(promptDefinitions);\n tokens += 9; // Add nine per completion\n }\n\n // If there's a system message _and_ functions are present, subtract four tokens. I assume this is because\n // functions typically add a system message, but reuse the first one if it's already there. This offsets\n // the extra 9 tokens added by the function definitions.\n if (functions && messages.find((m) => m._getType() === \"system\")) {\n tokens -= 4;\n }\n\n // If function_call is 'none', add one token.\n // If it's a FunctionCall object, add 4 + the number of tokens in the function name.\n // If it's undefined or 'auto', don't add anything.\n if (function_call === \"none\") {\n tokens += 1;\n } else if (typeof function_call === \"object\") {\n tokens += (await this.getNumTokens(function_call.name)) + 4;\n }\n\n return tokens;\n }\n\n /**\n * Return profiling information for the model.\n *\n * Provides information about the model's capabilities and constraints,\n * including token limits, multimodal support, and advanced features like\n * tool calling and structured output.\n *\n * @returns {ModelProfile} An object describing the model's capabilities and constraints\n *\n * @example\n * ```typescript\n * const model = new ChatOpenAI({ model: \"gpt-4o\" });\n * const profile = model.profile;\n * console.log(profile.maxInputTokens); // 128000\n * console.log(profile.imageInputs); // true\n * ```\n */\n get profile(): ModelProfile {\n return PROFILES[this.model] ?? {};\n }\n\n /** @internal */\n protected _getStructuredOutputMethod(\n config: StructuredOutputMethodOptions<boolean>\n ) {\n const ensuredConfig = { ...config };\n if (\n !this.model.startsWith(\"gpt-3\") &&\n !this.model.startsWith(\"gpt-4-\") &&\n this.model !== \"gpt-4\"\n ) {\n if (ensuredConfig?.method === undefined) {\n return \"jsonSchema\";\n }\n } else if (ensuredConfig.method === \"jsonSchema\") {\n console.warn(\n `[WARNING]: JSON Schema is not supported for model \"${this.model}\". Falling back to tool calling.`\n );\n }\n return ensuredConfig.method;\n }\n\n withStructuredOutput<\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n RunOutput extends Record<string, any> = Record<string, any>\n >(\n outputSchema:\n | InteropZodType<RunOutput>\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n | Record<string, any>,\n config?: StructuredOutputMethodOptions<false>\n ): Runnable<BaseLanguageModelInput, RunOutput>;\n\n withStructuredOutput<\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n RunOutput extends Record<string, any> = Record<string, any>\n >(\n outputSchema:\n | InteropZodType<RunOutput>\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n | Record<string, any>,\n config?: StructuredOutputMethodOptions<true>\n ): Runnable<BaseLanguageModelInput, { raw: BaseMessage; parsed: RunOutput }>;\n\n withStructuredOutput<\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n RunOutput extends Record<string, any> = Record<string, any>\n >(\n outputSchema:\n | InteropZodType<RunOutput>\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n | Record<string, any>,\n config?: StructuredOutputMethodOptions<boolean>\n ):\n | Runnable<BaseLanguageModelInput, RunOutput>\n | Runnable<BaseLanguageModelInput, { raw: BaseMessage; parsed: RunOutput }>;\n\n /**\n * Add structured output to the model.\n *\n * The OpenAI model family supports the following structured output methods:\n * - `jsonSchema`: Use the `response_format` field in the response to return a JSON schema. Only supported with the `gpt-4o-mini`,\n * `gpt-4o-mini-2024-07-18`, and `gpt-4o-2024-08-06` model snapshots and later.\n * - `functionCalling`: Function calling is useful when you are building an application that bridges the models and functionality\n * of your application.\n * - `jsonMode`: JSON mode is a more basic version of the Structured Outputs feature. While JSON mode ensures that model\n * output is valid JSON, Structured Outputs reliably matches the model's output to the schema you specify.\n * We recommend you use `functionCalling` or `jsonSchema` if it is supported for your use case.\n *\n * The default method is `functionCalling`.\n *\n * @see https://platform.openai.com/docs/guides/structured-outputs\n * @param outputSchema - The schema to use for structured output.\n * @param config - The structured output method options.\n * @returns The model with structured output.\n */\n withStructuredOutput<\n RunOutput extends Record<string, unknown> = Record<string, unknown>\n >(\n outputSchema: InteropZodType<RunOutput> | Record<string, unknown>,\n config?: StructuredOutputMethodOptions<boolean>\n ) {\n let llm: Runnable<BaseLanguageModelInput>;\n let outputParser: Runnable<AIMessageChunk, RunOutput>;\n\n const { schema, name, includeRaw } = {\n ...config,\n schema: outputSchema,\n };\n\n if (config?.strict !== undefined && config.method === \"jsonMode\") {\n throw new Error(\n \"Argument `strict` is only supported for `method` = 'function_calling'\"\n );\n }\n\n const method = getStructuredOutputMethod(this.model, config?.method);\n\n if (method === \"jsonMode\") {\n if (isInteropZodSchema(schema)) {\n outputParser = StructuredOutputParser.fromZodSchema(schema);\n } else {\n outputParser = new JsonOutputParser<RunOutput>();\n }\n const asJsonSchema = toJsonSchema(schema);\n llm = this.withConfig({\n outputVersion: \"v0\",\n response_format: { type: \"json_object\" },\n ls_structured_output_format: {\n kwargs: { method: \"json_mode\" },\n schema: { title: name ?? \"extract\", ...asJsonSchema },\n },\n } as Partial<CallOptions>);\n } else if (method === \"jsonSchema\") {\n const openaiJsonSchemaParams = {\n name: name ?? \"extract\",\n description: getSchemaDescription(schema),\n schema,\n strict: config?.strict,\n };\n const asJsonSchema = toJsonSchema(openaiJsonSchemaParams.schema);\n llm = this.withConfig({\n outputVersion: \"v0\",\n response_format: {\n type: \"json_schema\",\n json_schema: openaiJsonSchemaParams,\n },\n ls_structured_output_format: {\n kwargs: { method: \"json_schema\" },\n schema: {\n title: openaiJsonSchemaParams.name,\n description: openaiJsonSchemaParams.description,\n ...asJsonSchema,\n },\n },\n } as Partial<CallOptions>);\n if (isInteropZodSchema(schema)) {\n const altParser = StructuredOutputParser.fromZodSchema(schema);\n outputParser = RunnableLambda.from<AIMessageChunk, RunOutput>(\n (aiMessage: AIMessageChunk) => {\n if (\"parsed\" in aiMessage.additional_kwargs) {\n return aiMessage.additional_kwargs.parsed as RunOutput;\n }\n return altParser;\n }\n );\n } else {\n outputParser = new JsonOutputParser<RunOutput>();\n }\n } else {\n let functionName = name ?? \"extract\";\n // Is function calling\n if (isInteropZodSchema(schema)) {\n const asJsonSchema = toJsonSchema(schema);\n llm = this.withConfig({\n outputVersion: \"v0\",\n tools: [\n {\n type: \"function\" as const,\n function: {\n name: functionName,\n description: asJsonSchema.description,\n parameters: asJsonSchema,\n },\n },\n ],\n tool_choice: {\n type: \"function\" as const,\n function: {\n name: functionName,\n },\n },\n ls_structured_output_format: {\n kwargs: { method: \"function_calling\" },\n schema: { title: functionName, ...asJsonSchema },\n },\n // Do not pass `strict` argument to OpenAI if `config.strict` is undefined\n ...(config?.strict !== undefined ? { strict: config.strict } : {}),\n } as Partial<CallOptions>);\n outputParser = new JsonOutputKeyToolsParser({\n returnSingle: true,\n keyName: functionName,\n zodSchema: schema,\n });\n } else {\n let openAIFunctionDefinition: FunctionDefinition;\n if (\n typeof schema.name === \"string\" &&\n typeof schema.parameters === \"object\" &&\n schema.parameters != null\n ) {\n openAIFunctionDefinition = schema as unknown as FunctionDefinition;\n functionName = schema.name;\n } else {\n functionName = (schema.title as string) ?? functionName;\n openAIFunctionDefinition = {\n name: functionName,\n description: (schema.description as string) ?? \"\",\n parameters: schema,\n };\n }\n const asJsonSchema = toJsonSchema(schema);\n llm = this.withConfig({\n outputVersion: \"v0\",\n tools: [\n {\n type: \"function\" as const,\n function: openAIFunctionDefinition,\n },\n ],\n tool_choice: {\n type: \"function\" as const,\n function: {\n name: functionName,\n },\n },\n ls_structured_output_format: {\n kwargs: { method: \"function_calling\" },\n schema: { title: functionName, ...asJsonSchema },\n },\n // Do not pass `strict` argument to OpenAI if `config.strict` is undefined\n ...(config?.strict !== undefined ? { strict: config.strict } : {}),\n } as Partial<CallOptions>);\n outputParser = new JsonOutputKeyToolsParser<RunOutput>({\n returnSingle: true,\n keyName: functionName,\n });\n }\n }\n\n if (!includeRaw) {\n return llm.pipe(outputParser) as Runnable<\n BaseLanguageModelInput,\n RunOutput\n >;\n }\n\n const parserAssign = RunnablePassthrough.assign({\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n parsed: (input: any, config) => outputParser.invoke(input.raw, config),\n });\n const parserNone = RunnablePassthrough.assign({\n parsed: () => null,\n });\n const parsedWithFallback = parserAssign.withFallbacks({\n fallbacks: [parserNone],\n });\n return RunnableSequence.from<\n BaseLanguageModelInput,\n { raw: BaseMessage; parsed: RunOutput }\n >([{ raw: llm }, parsedWithFallback]);\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAoNA,IAAsB,iBAAtB,cAGU,cAEV;CACE;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA,QAAQ;CAER;CAEA;CAEA;CAEA;CAEA;CAEA,YAAY;CAEZ,cAAc;CAEd;CAEA;CAEA;CAEA;CAEA;CAEA;;CAGA;;CAGA;;;;;CAMA;CAEA;CAEA;CAEA;;;;;;;;;;;;CAaA;;;;;CAMA;;;;;;CAOA;;;;CAKA;CAEA,AAAU;CAEV,WAAW;AACT,SAAO;CACR;CAED,OAAO,UAAU;AACf,SAAO;CACR;CAED,IAAI,WAAW;AACb,SAAO;GACL,GAAG,MAAM;GACT;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;EACD;CACF;CAED,kBAAkB;CAElB,IAAI,aAAoD;AACtD,SAAO;GACL,QAAQ;GACR,cAAc;EACf;CACF;CAED,IAAI,aAAqC;AACvC,SAAO;GACL,QAAQ;GACR,WAAW;EACZ;CACF;CAED,IAAI,uBAAiC;AACnC,SAAO;GACL;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;EACD;CACF;CAED,YAAYA,SAAqD;EAC/D,MAAM,SAAS,KAAK,iBAAiB,QAAQ;AAC7C,SAAO;GACL,aAAa;GACb,eAAe,KAAK;GACpB,eAAe;GACf,gBAAgB,OAAO,eAAe;GACtC,eAAe,OAAO,cAAc;GACpC,SAAS,QAAQ;EAClB;CACF;;CAGD,qBAKkB;AAChB,SAAO;GACL,YAAY,KAAK;GACjB,GAAG,KAAK,kBAAkB;GAC1B,GAAG,KAAK;EACT;CACF;;;;CAKD,oBAAoB;AAClB,SAAO,KAAK,oBAAoB;CACjC;CAED,YAAYC,QAA+B;EACzC,MAAM,UAAU,CAAE,EAAC;EAEnB,MAAM,eACJ,OAAO,QAAQ,eAAe,WAAW,YACzC,OAAO,QAAQ,eAAe,WAAW,aACrC,QAAQ,eAAe,SACvB;EACN,KAAK,SACH,QAAQ,UACR,gBACA,uBAAuB,iBAAiB;EAC1C,KAAK,eACH,QAAQ,eAAe,gBACvB,uBAAuB,sBAAsB;EAE/C,KAAK,QAAQ,QAAQ,SAAS,QAAQ,aAAa,KAAK;EACxD,KAAK,cAAc,QAAQ,eAAe,CAAE;EAC5C,KAAK,UAAU,QAAQ;EAEvB,KAAK,cAAc,QAAQ,eAAe,KAAK;EAC/C,KAAK,OAAO,QAAQ,QAAQ,KAAK;EACjC,KAAK,mBAAmB,QAAQ,oBAAoB,KAAK;EACzD,KAAK,kBAAkB,QAAQ,mBAAmB,KAAK;EACvD,KAAK,WAAW,QAAQ;EACxB,KAAK,cAAc,QAAQ;EAC3B,KAAK,IAAI,QAAQ,KAAK,KAAK;EAC3B,KAAK,YAAY,QAAQ;EACzB,KAAK,OAAO,QAAQ,iBAAiB,QAAQ;EAC7C,KAAK,gBAAgB,KAAK;EAC1B,KAAK,OAAO,QAAQ;EACpB,KAAK,uBAAuB,QAAQ;EACpC,KAAK,QAAQ,QAAQ;EACrB,KAAK,aAAa,QAAQ;EAC1B,KAAK,YAAY,QAAQ;EACzB,KAAK,YAAY,QAAQ,uBAAuB,QAAQ;EACxD,KAAK,iBAAiB,QAAQ,kBAAkB,KAAK;EACrD,KAAK,YAAY,QAAQ,aAAa,KAAK;EAE3C,KAAK,mBAAmB,QAAQ,qBAAqB;EACrD,KAAK,YAAY,QAAQ,cAAc;AACvC,MAAI,KAAK,kBAAkB,KAAK,YAAY;AAE5C,MAAI,QAAQ,cAAc,OAAO,KAAK,mBAAmB;EAEzD,KAAK,cAAc,QAAQ,eAAe,KAAK;AAC/C,MAAI,KAAK,kBAAkB,KAAK,cAAc;EAE9C,KAAK,eAAe;GAClB,QAAQ,KAAK;GACb,cAAc,KAAK;GACnB,yBAAyB;GACzB,GAAG,QAAQ;EACZ;AAID,MAAI,QAAQ,8BAA8B,QACxC,KAAK,4BAA4B,OAAO;AAG1C,MAAI,QAAQ,iBAAiB,QAC3B,KAAK,eAAe,OAAO;EAG7B,KAAK,aAAa,QAAQ,cAAc;CACzC;;;;;CAMD,AAAU,oBACRC,SACoC;AACpC,MAAI,CAAC,iBAAiB,KAAK,MAAM,CAC/B;EAIF,IAAIC;AACJ,MAAI,KAAK,cAAc,QACrB,YAAY;GACV,GAAG;GACH,GAAG,KAAK;EACT;AAEH,MAAI,SAAS,cAAc,QACzB,YAAY;GACV,GAAG;GACH,GAAG,QAAQ;EACZ;AAGH,SAAO;CACR;;;;;CAMD,AAAU,mBACRC,WACyC;AACzC,MACE,aACA,UAAU,SAAS,iBACnB,UAAU,YAAY,UACtB,mBAAmB,UAAU,YAAY,OAAO,CAEhD,QAAO,yBACL,UAAU,YAAY,QACtB,UAAU,YAAY,MACtB,EACE,aAAa,UAAU,YAAY,YACpC,EACF;AAEH,SAAO;CACR;CAED,AAAU,oBACRC,mBAC2B;AAC3B,SAAO;GACL,GAAG,KAAK;GACR,GAAI,qBAAqB,CAAE;EAC5B;CACF;;CAGD,kBACEC,SAC0B;AAC1B,MAAI,CAAC,KAAK,QAAQ;GAChB,MAAMC,uBAA6C,EACjD,SAAS,KAAK,aAAa,QAC5B;GAED,MAAM,WAAW,YAAY,qBAAqB;GAClD,MAAM,SAAS;IACb,GAAG,KAAK;IACR,SAAS;IACT,SAAS,KAAK;IACd,YAAY;GACb;AACD,OAAI,CAAC,OAAO,SACV,OAAO,OAAO;GAGhB,OAAO,iBAAiB,wBAAwB,OAAO,eAAe;GAEtE,KAAK,SAAS,IAAIC,SAAa;EAChC;EACD,MAAM,iBAAiB;GACrB,GAAG,KAAK;GACR,GAAG;EACJ;AACD,SAAO;CACR;CAGD,AAAU,wCACRC,MACAC,QACiC;AACjC,MAAI,aAAa,KAAK,CACpB,QAAO,2BAA2B,KAAK,SAAS,WAAW;AAE7D,MAAIC,aAAqB,KAAK,EAAE;AAC9B,OAAI,QAAQ,WAAW,OACrB,QAAO;IACL,GAAG;IACH,UAAU;KACR,GAAG,KAAK;KACR,QAAQ,OAAO;IAChB;GACF;AAGH,UAAO;EACR;AACD,SAAO,qBAAqB,MAAM,OAAO;CAC1C;CAED,AAAS,UACPC,OACAC,QAC+D;EAC/D,IAAIC;AACJ,MAAI,QAAQ,WAAW,QACrB,SAAS,OAAO;WACP,KAAK,8BAA8B,QAC5C,SAAS,KAAK;AAEhB,SAAO,KAAK,WAAW;GACrB,OAAO,MAAM,IAAI,CAAC,SAChB,cAAc,KAAK,IAAI,aAAa,KAAK,GACrC,OACA,KAAK,wCAAwC,MAAM,EAAE,OAAQ,EAAC,CACnE;GACD,GAAG;EACJ,EAAyB;CAC3B;CAED,MAAe,OAAOC,OAA+BC,SAAuB;AAC1E,SAAO,MAAM,OACX,OACA,KAAK,oBAAoB,QAAQ,CAClC;CACF;CAED,MAAe,OAAOD,OAA+BC,SAAuB;AAC1E,SAAO,MAAM,OACX,OACA,KAAK,oBAAoB,QAAQ,CAClC;CACF;;CAGD,kBAAkB,GAAG,YAAgD;AACnE,SAAO,WAAW,OAGhB,CAAC,KAAK,cAAc;AAClB,OAAI,aAAa,UAAU,YAAY;IACrC,IAAI,WAAW,oBACb,UAAU,WAAW,oBAAoB;IAC3C,IAAI,WAAW,gBAAgB,UAAU,WAAW,gBAAgB;IACpE,IAAI,WAAW,eAAe,UAAU,WAAW,eAAe;GACnE;AACD,UAAO;EACR,GACD,EACE,YAAY;GACV,kBAAkB;GAClB,cAAc;GACd,aAAa;EACd,EACF,EACF;CACF;CAED,MAAM,yBAAyBC,UAAyB;EACtD,IAAI,aAAa;EACjB,IAAI,mBAAmB;EACvB,IAAI,gBAAgB;AAGpB,MAAI,KAAK,UAAU,sBAAsB;GACvC,mBAAmB;GACnB,gBAAgB;EACjB,OAAM;GACL,mBAAmB;GACnB,gBAAgB;EACjB;EAED,MAAM,kBAAkB,MAAM,QAAQ,IACpC,SAAS,IAAI,OAAO,YAAY;GAC9B,MAAM,YAAY,MAAM,KAAK,aAAa,QAAQ,QAAQ;GAC1D,MAAM,YAAY,MAAM,KAAK,aAAa,oBAAoB,QAAQ,CAAC;GACvE,MAAM,YACJ,QAAQ,SAAS,SACb,gBAAiB,MAAM,KAAK,aAAa,QAAQ,KAAK,GACtD;GACN,IAAI,QAAQ,YAAY,mBAAmB,YAAY;GAGvD,MAAM,gBAAgB;AACtB,OAAI,cAAc,UAAU,KAAK,YAC/B,SAAS;AAEX,OAAI,cAAc,mBAAmB,eACnC,SAAS;AAEX,OAAI,eAAe,kBAAkB,eAAe,MAClD,SAAS,MAAM,KAAK,aAClB,cAAc,kBAAkB,eAAe,KAChD;AAEH,OAAI,cAAc,kBAAkB,eAAe,UACjD,KAAI;IACF,SAAS,MAAM,KAAK,aAElB,KAAK,UACH,KAAK,MACH,cAAc,kBAAkB,eAAe,UAChD,CACF,CACF;GACF,SAAQ,OAAO;IACd,QAAQ,MACN,oCACA,OACA,KAAK,UAAU,cAAc,kBAAkB,cAAc,CAC9D;IACD,SAAS,MAAM,KAAK,aAClB,cAAc,kBAAkB,eAAe,UAChD;GACF;GAGH,cAAc;AACd,UAAO;EACR,EAAC,CACH;EAED,cAAc;AAEd,SAAO;GAAE;GAAY;EAAiB;CACvC;;CAGD,MAAgB,6BAA6BC,aAA+B;EAC1E,MAAM,mBAAmB,MAAM,QAAQ,IACrC,YAAY,IAAI,OAAO,eAAe;AACpC,OAAI,WAAW,QAAQ,mBAAmB,cACxC,SAAQ,MAAM,KAAK,yBAAyB,CAAC,WAAW,OAAQ,EAAC,EAC9D,gBAAgB;OAEnB,QAAO,MAAM,KAAK,aAAa,WAAW,QAAQ,QAAQ;EAE7D,EAAC,CACH;AAED,SAAO,iBAAiB,OAAO,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE;CACnD;;CAGD,MAAgB,kCACdD,UACAE,WACAC,eAIiB;EAIjB,IAAI,UAAU,MAAM,KAAK,yBAAyB,SAAS,EAAE;AAG7D,MAAI,aAAa,kBAAkB,QAAQ;GACzC,MAAM,oBAAoB,0BACxB,UACD;GACD,UAAU,MAAM,KAAK,aAAa,kBAAkB;GACpD,UAAU;EACX;AAKD,MAAI,aAAa,SAAS,KAAK,CAAC,MAAM,EAAE,UAAU,KAAK,SAAS,EAC9D,UAAU;AAMZ,MAAI,kBAAkB,QACpB,UAAU;WACD,OAAO,kBAAkB,UAClC,UAAW,MAAM,KAAK,aAAa,cAAc,KAAK,GAAI;AAG5D,SAAO;CACR;;;;;;;;;;;;;;;;;;CAmBD,IAAI,UAAwB;AAC1B,SAAOC,iBAAS,KAAK,UAAU,CAAE;CAClC;;CAGD,AAAU,2BACRC,QACA;EACA,MAAM,gBAAgB,EAAE,GAAG,OAAQ;AACnC,MACE,CAAC,KAAK,MAAM,WAAW,QAAQ,IAC/B,CAAC,KAAK,MAAM,WAAW,SAAS,IAChC,KAAK,UAAU,SAEf;OAAI,eAAe,WAAW,OAC5B,QAAO;EACR,WACQ,cAAc,WAAW,cAClC,QAAQ,KACN,CAAC,mDAAmD,EAAE,KAAK,MAAM,gCAAgC,CAAC,CACnG;AAEH,SAAO,cAAc;CACtB;;;;;;;;;;;;;;;;;;;;CAwDD,qBAGEC,cACAC,QACA;EACA,IAAIC;EACJ,IAAIC;EAEJ,MAAM,EAAE,QAAQ,MAAM,YAAY,GAAG;GACnC,GAAG;GACH,QAAQ;EACT;AAED,MAAI,QAAQ,WAAW,UAAa,OAAO,WAAW,WACpD,OAAM,IAAI,MACR;EAIJ,MAAM,SAAS,0BAA0B,KAAK,OAAO,QAAQ,OAAO;AAEpE,MAAI,WAAW,YAAY;AACzB,OAAI,mBAAmB,OAAO,EAC5B,eAAe,uBAAuB,cAAc,OAAO;QAE3D,eAAe,IAAI;GAErB,MAAM,eAAe,aAAa,OAAO;GACzC,MAAM,KAAK,WAAW;IACpB,eAAe;IACf,iBAAiB,EAAE,MAAM,cAAe;IACxC,6BAA6B;KAC3B,QAAQ,EAAE,QAAQ,YAAa;KAC/B,QAAQ;MAAE,OAAO,QAAQ;MAAW,GAAG;KAAc;IACtD;GACF,EAAyB;EAC3B,WAAU,WAAW,cAAc;GAClC,MAAM,yBAAyB;IAC7B,MAAM,QAAQ;IACd,aAAa,qBAAqB,OAAO;IACzC;IACA,QAAQ,QAAQ;GACjB;GACD,MAAM,eAAe,aAAa,uBAAuB,OAAO;GAChE,MAAM,KAAK,WAAW;IACpB,eAAe;IACf,iBAAiB;KACf,MAAM;KACN,aAAa;IACd;IACD,6BAA6B;KAC3B,QAAQ,EAAE,QAAQ,cAAe;KACjC,QAAQ;MACN,OAAO,uBAAuB;MAC9B,aAAa,uBAAuB;MACpC,GAAG;KACJ;IACF;GACF,EAAyB;AAC1B,OAAI,mBAAmB,OAAO,EAAE;IAC9B,MAAM,YAAY,uBAAuB,cAAc,OAAO;IAC9D,eAAe,eAAe,KAC5B,CAACC,cAA8B;AAC7B,SAAI,YAAY,UAAU,kBACxB,QAAO,UAAU,kBAAkB;AAErC,YAAO;IACR,EACF;GACF,OACC,eAAe,IAAI;EAEtB,OAAM;GACL,IAAI,eAAe,QAAQ;AAE3B,OAAI,mBAAmB,OAAO,EAAE;IAC9B,MAAM,eAAe,aAAa,OAAO;IACzC,MAAM,KAAK,WAAW;KACpB,eAAe;KACf,OAAO,CACL;MACE,MAAM;MACN,UAAU;OACR,MAAM;OACN,aAAa,aAAa;OAC1B,YAAY;MACb;KACF,CACF;KACD,aAAa;MACX,MAAM;MACN,UAAU,EACR,MAAM,aACP;KACF;KACD,6BAA6B;MAC3B,QAAQ,EAAE,QAAQ,mBAAoB;MACtC,QAAQ;OAAE,OAAO;OAAc,GAAG;MAAc;KACjD;KAED,GAAI,QAAQ,WAAW,SAAY,EAAE,QAAQ,OAAO,OAAQ,IAAG,CAAE;IAClE,EAAyB;IAC1B,eAAe,IAAI,yBAAyB;KAC1C,cAAc;KACd,SAAS;KACT,WAAW;IACZ;GACF,OAAM;IACL,IAAIC;AACJ,QACE,OAAO,OAAO,SAAS,YACvB,OAAO,OAAO,eAAe,YAC7B,OAAO,cAAc,MACrB;KACA,2BAA2B;KAC3B,eAAe,OAAO;IACvB,OAAM;KACL,eAAgB,OAAO,SAAoB;KAC3C,2BAA2B;MACzB,MAAM;MACN,aAAc,OAAO,eAA0B;MAC/C,YAAY;KACb;IACF;IACD,MAAM,eAAe,aAAa,OAAO;IACzC,MAAM,KAAK,WAAW;KACpB,eAAe;KACf,OAAO,CACL;MACE,MAAM;MACN,UAAU;KACX,CACF;KACD,aAAa;MACX,MAAM;MACN,UAAU,EACR,MAAM,aACP;KACF;KACD,6BAA6B;MAC3B,QAAQ,EAAE,QAAQ,mBAAoB;MACtC,QAAQ;OAAE,OAAO;OAAc,GAAG;MAAc;KACjD;KAED,GAAI,QAAQ,WAAW,SAAY,EAAE,QAAQ,OAAO,OAAQ,IAAG,CAAE;IAClE,EAAyB;IAC1B,eAAe,IAAI,yBAAoC;KACrD,cAAc;KACd,SAAS;IACV;GACF;EACF;AAED,MAAI,CAAC,WACH,QAAO,IAAI,KAAK,aAAa;EAM/B,MAAM,eAAe,oBAAoB,OAAO,EAE9C,QAAQ,CAACC,OAAYC,aAAW,aAAa,OAAO,MAAM,KAAKA,SAAO,CACvE,EAAC;EACF,MAAM,aAAa,oBAAoB,OAAO,EAC5C,QAAQ,MAAM,KACf,EAAC;EACF,MAAM,qBAAqB,aAAa,cAAc,EACpD,WAAW,CAAC,UAAW,EACxB,EAAC;AACF,SAAO,iBAAiB,KAGtB,CAAC,EAAE,KAAK,IAAK,GAAE,kBAAmB,EAAC;CACtC;AACF"}
@@ -0,0 +1,2 @@
1
+ import { completionsApiContentBlockConverter, convertCompletionsDeltaToBaseMessageChunk, convertCompletionsMessageToBaseMessage, convertMessagesToCompletionsMessageParams, convertStandardContentBlockToCompletionsContentPart, convertStandardContentMessageToCompletionsMessage } from "./completions.js";
2
+ import { ResponsesCreate, ResponsesCreateInvoke, ResponsesInputItem, ResponsesParse, ResponsesParseInvoke, convertMessagesToResponsesInput, convertReasoningSummaryToResponsesReasoningItem, convertResponsesDeltaToChatGenerationChunk, convertResponsesMessageToAIMessage, convertResponsesUsageToUsageMetadata, convertStandardContentMessageToResponsesInput } from "./responses.js";
@@ -39,6 +39,7 @@ var OpenAIEmbeddings = class extends __langchain_core_embeddings.Embeddings {
39
39
  encodingFormat;
40
40
  client;
41
41
  clientConfig;
42
+ apiKey;
42
43
  constructor(fields) {
43
44
  const fieldsWithDefaults = {
44
45
  maxConcurrency: 2,
@@ -122,6 +123,7 @@ var OpenAIEmbeddings = class extends __langchain_core_embeddings.Embeddings {
122
123
  maxRetries: 0
123
124
  };
124
125
  if (!params.baseURL) delete params.baseURL;
126
+ params.defaultHeaders = require_azure.getHeadersWithUserAgent(params.defaultHeaders);
125
127
  this.client = new openai.OpenAI(params);
126
128
  }
127
129
  const requestOptions = {};
@@ -1 +1 @@
1
- {"version":3,"file":"embeddings.cjs","names":["Embeddings","fields?: Partial<OpenAIEmbeddingsParams> & {\n verbose?: boolean;\n /**\n * The OpenAI API key to use.\n * Alias for `apiKey`.\n */\n openAIApiKey?: string;\n /** The OpenAI API key to use. */\n apiKey?: string;\n configuration?: ClientOptions;\n }","texts: string[]","params: OpenAIClient.EmbeddingCreateParams","embeddings: TOutput[]","text: string","request: OpenAIClient.EmbeddingCreateParams","openAIEndpointConfig: OpenAIEndpointConfig","getEndpoint","OpenAIClient","wrapOpenAIClientError"],"sources":["../src/embeddings.ts"],"sourcesContent":["import { type ClientOptions, OpenAI as OpenAIClient } from \"openai\";\nimport { getEnvironmentVariable } from \"@langchain/core/utils/env\";\nimport { Embeddings, type EmbeddingsParams } from \"@langchain/core/embeddings\";\nimport { chunkArray } from \"@langchain/core/utils/chunk_array\";\nimport { getEndpoint, OpenAIEndpointConfig } from \"./utils/azure.js\";\nimport { wrapOpenAIClientError } from \"./utils/client.js\";\n\n/**\n * @see https://platform.openai.com/docs/guides/embeddings#embedding-models\n */\nexport type OpenAIEmbeddingModelId =\n | OpenAIClient.EmbeddingModel\n | (string & NonNullable<unknown>);\n\n/**\n * Interface for OpenAIEmbeddings parameters. Extends EmbeddingsParams and\n * defines additional parameters specific to the OpenAIEmbeddings class.\n */\nexport interface OpenAIEmbeddingsParams extends EmbeddingsParams {\n /**\n * Model name to use\n * Alias for `model`\n * @deprecated Use \"model\" instead.\n */\n modelName: OpenAIEmbeddingModelId;\n /** Model name to use */\n model: OpenAIEmbeddingModelId;\n\n /**\n * The number of dimensions the resulting output embeddings should have.\n * Only supported in `text-embedding-3` and later models.\n */\n dimensions?: number;\n\n /**\n * Timeout to use when making requests to OpenAI.\n */\n timeout?: number;\n\n /**\n * The maximum number of documents to embed in a single request. This is\n * limited by the OpenAI API to a maximum of 2048.\n */\n batchSize?: number;\n\n /**\n * Whether to strip new lines from the input text. This is recommended by\n * OpenAI for older models, but may not be suitable for all use cases.\n * See: https://github.com/openai/openai-python/issues/418#issuecomment-1525939500\n */\n stripNewLines?: boolean;\n\n /**\n * The format to return the embeddings in. Can be either 'float' or 'base64'.\n */\n encodingFormat?: \"float\" | \"base64\";\n}\n\n/**\n * Class for generating embeddings using the OpenAI API.\n *\n * To use with Azure, import the `AzureOpenAIEmbeddings` class.\n *\n * @example\n * ```typescript\n * // Embed a query using OpenAIEmbeddings to generate embeddings for a given text\n * const model = new OpenAIEmbeddings();\n * const res = await model.embedQuery(\n * \"What would be a good company name for a company that makes colorful socks?\",\n * );\n * console.log({ res });\n *\n * ```\n */\nexport class OpenAIEmbeddings<TOutput = number[]>\n extends Embeddings<TOutput>\n implements Partial<OpenAIEmbeddingsParams>\n{\n model = \"text-embedding-ada-002\";\n\n /** @deprecated Use \"model\" instead */\n modelName: string;\n\n batchSize = 512;\n\n // TODO: Update to `false` on next minor release (see: https://github.com/langchain-ai/langchainjs/pull/3612)\n stripNewLines = true;\n\n /**\n * The number of dimensions the resulting output embeddings should have.\n * Only supported in `text-embedding-3` and later models.\n */\n dimensions?: number;\n\n timeout?: number;\n\n organization?: string;\n\n encodingFormat?: \"float\" | \"base64\";\n\n protected client: OpenAIClient;\n\n protected clientConfig: ClientOptions;\n\n constructor(\n fields?: Partial<OpenAIEmbeddingsParams> & {\n verbose?: boolean;\n /**\n * The OpenAI API key to use.\n * Alias for `apiKey`.\n */\n openAIApiKey?: string;\n /** The OpenAI API key to use. */\n apiKey?: string;\n configuration?: ClientOptions;\n }\n ) {\n const fieldsWithDefaults = { maxConcurrency: 2, ...fields };\n\n super(fieldsWithDefaults);\n\n const apiKey =\n fieldsWithDefaults?.apiKey ??\n fieldsWithDefaults?.openAIApiKey ??\n getEnvironmentVariable(\"OPENAI_API_KEY\");\n\n this.organization =\n fieldsWithDefaults?.configuration?.organization ??\n getEnvironmentVariable(\"OPENAI_ORGANIZATION\");\n\n this.model =\n fieldsWithDefaults?.model ?? fieldsWithDefaults?.modelName ?? this.model;\n this.modelName = this.model;\n this.batchSize = fieldsWithDefaults?.batchSize ?? this.batchSize;\n this.stripNewLines =\n fieldsWithDefaults?.stripNewLines ?? this.stripNewLines;\n this.timeout = fieldsWithDefaults?.timeout;\n this.dimensions = fieldsWithDefaults?.dimensions;\n this.encodingFormat = fieldsWithDefaults?.encodingFormat;\n\n this.clientConfig = {\n apiKey,\n organization: this.organization,\n dangerouslyAllowBrowser: true,\n ...fields?.configuration,\n };\n }\n\n /**\n * Method to generate embeddings for an array of documents. Splits the\n * documents into batches and makes requests to the OpenAI API to generate\n * embeddings.\n * @param texts Array of documents to generate embeddings for.\n * @returns Promise that resolves to a 2D array of embeddings for each document.\n */\n async embedDocuments(texts: string[]): Promise<TOutput[]> {\n const batches = chunkArray(\n this.stripNewLines ? texts.map((t) => t.replace(/\\n/g, \" \")) : texts,\n this.batchSize\n );\n\n const batchRequests = batches.map((batch) => {\n const params: OpenAIClient.EmbeddingCreateParams = {\n model: this.model,\n input: batch,\n };\n if (this.dimensions) {\n params.dimensions = this.dimensions;\n }\n if (this.encodingFormat) {\n params.encoding_format = this.encodingFormat;\n }\n return this.embeddingWithRetry(params);\n });\n const batchResponses = await Promise.all(batchRequests);\n\n const embeddings: TOutput[] = [];\n for (let i = 0; i < batchResponses.length; i += 1) {\n const batch = batches[i];\n const { data: batchResponse } = batchResponses[i];\n for (let j = 0; j < batch.length; j += 1) {\n embeddings.push(batchResponse[j].embedding as TOutput);\n }\n }\n return embeddings;\n }\n\n /**\n * Method to generate an embedding for a single document. Calls the\n * embeddingWithRetry method with the document as the input.\n * @param text Document to generate an embedding for.\n * @returns Promise that resolves to an embedding for the document.\n */\n async embedQuery(text: string): Promise<TOutput> {\n const params: OpenAIClient.EmbeddingCreateParams = {\n model: this.model,\n input: this.stripNewLines ? text.replace(/\\n/g, \" \") : text,\n };\n if (this.dimensions) {\n params.dimensions = this.dimensions;\n }\n if (this.encodingFormat) {\n params.encoding_format = this.encodingFormat;\n }\n const { data } = await this.embeddingWithRetry(params);\n return data[0].embedding as TOutput;\n }\n\n /**\n * Private method to make a request to the OpenAI API to generate\n * embeddings. Handles the retry logic and returns the response from the\n * API.\n * @param request Request to send to the OpenAI API.\n * @returns Promise that resolves to the response from the API.\n */\n protected async embeddingWithRetry(\n request: OpenAIClient.EmbeddingCreateParams\n ) {\n if (!this.client) {\n const openAIEndpointConfig: OpenAIEndpointConfig = {\n baseURL: this.clientConfig.baseURL,\n };\n\n const endpoint = getEndpoint(openAIEndpointConfig);\n\n const params = {\n ...this.clientConfig,\n baseURL: endpoint,\n timeout: this.timeout,\n maxRetries: 0,\n };\n\n if (!params.baseURL) {\n delete params.baseURL;\n }\n\n this.client = new OpenAIClient(params);\n }\n const requestOptions = {};\n\n return this.caller.call(async () => {\n try {\n const res = await this.client.embeddings.create(\n request,\n requestOptions\n );\n return res;\n } catch (e) {\n const error = wrapOpenAIClientError(e);\n throw error;\n }\n });\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AA0EA,IAAa,mBAAb,cACUA,uCAEV;CACE,QAAQ;;CAGR;CAEA,YAAY;CAGZ,gBAAgB;;;;;CAMhB;CAEA;CAEA;CAEA;CAEA,AAAU;CAEV,AAAU;CAEV,YACEC,QAWA;EACA,MAAM,qBAAqB;GAAE,gBAAgB;GAAG,GAAG;EAAQ;EAE3D,MAAM,mBAAmB;EAEzB,MAAM,SACJ,oBAAoB,UACpB,oBAAoB,uEACG,iBAAiB;EAE1C,KAAK,eACH,oBAAoB,eAAe,uEACZ,sBAAsB;EAE/C,KAAK,QACH,oBAAoB,SAAS,oBAAoB,aAAa,KAAK;EACrE,KAAK,YAAY,KAAK;EACtB,KAAK,YAAY,oBAAoB,aAAa,KAAK;EACvD,KAAK,gBACH,oBAAoB,iBAAiB,KAAK;EAC5C,KAAK,UAAU,oBAAoB;EACnC,KAAK,aAAa,oBAAoB;EACtC,KAAK,iBAAiB,oBAAoB;EAE1C,KAAK,eAAe;GAClB;GACA,cAAc,KAAK;GACnB,yBAAyB;GACzB,GAAG,QAAQ;EACZ;CACF;;;;;;;;CASD,MAAM,eAAeC,OAAqC;EACxD,MAAM,6DACJ,KAAK,gBAAgB,MAAM,IAAI,CAAC,MAAM,EAAE,QAAQ,OAAO,IAAI,CAAC,GAAG,OAC/D,KAAK,UACN;EAED,MAAM,gBAAgB,QAAQ,IAAI,CAAC,UAAU;GAC3C,MAAMC,SAA6C;IACjD,OAAO,KAAK;IACZ,OAAO;GACR;AACD,OAAI,KAAK,YACP,OAAO,aAAa,KAAK;AAE3B,OAAI,KAAK,gBACP,OAAO,kBAAkB,KAAK;AAEhC,UAAO,KAAK,mBAAmB,OAAO;EACvC,EAAC;EACF,MAAM,iBAAiB,MAAM,QAAQ,IAAI,cAAc;EAEvD,MAAMC,aAAwB,CAAE;AAChC,OAAK,IAAI,IAAI,GAAG,IAAI,eAAe,QAAQ,KAAK,GAAG;GACjD,MAAM,QAAQ,QAAQ;GACtB,MAAM,EAAE,MAAM,eAAe,GAAG,eAAe;AAC/C,QAAK,IAAI,IAAI,GAAG,IAAI,MAAM,QAAQ,KAAK,GACrC,WAAW,KAAK,cAAc,GAAG,UAAqB;EAEzD;AACD,SAAO;CACR;;;;;;;CAQD,MAAM,WAAWC,MAAgC;EAC/C,MAAMF,SAA6C;GACjD,OAAO,KAAK;GACZ,OAAO,KAAK,gBAAgB,KAAK,QAAQ,OAAO,IAAI,GAAG;EACxD;AACD,MAAI,KAAK,YACP,OAAO,aAAa,KAAK;AAE3B,MAAI,KAAK,gBACP,OAAO,kBAAkB,KAAK;EAEhC,MAAM,EAAE,MAAM,GAAG,MAAM,KAAK,mBAAmB,OAAO;AACtD,SAAO,KAAK,GAAG;CAChB;;;;;;;;CASD,MAAgB,mBACdG,SACA;AACA,MAAI,CAAC,KAAK,QAAQ;GAChB,MAAMC,uBAA6C,EACjD,SAAS,KAAK,aAAa,QAC5B;GAED,MAAM,WAAWC,0BAAY,qBAAqB;GAElD,MAAM,SAAS;IACb,GAAG,KAAK;IACR,SAAS;IACT,SAAS,KAAK;IACd,YAAY;GACb;AAED,OAAI,CAAC,OAAO,SACV,OAAO,OAAO;GAGhB,KAAK,SAAS,IAAIC,cAAa;EAChC;EACD,MAAM,iBAAiB,CAAE;AAEzB,SAAO,KAAK,OAAO,KAAK,YAAY;AAClC,OAAI;IACF,MAAM,MAAM,MAAM,KAAK,OAAO,WAAW,OACvC,SACA,eACD;AACD,WAAO;GACR,SAAQ,GAAG;IACV,MAAM,QAAQC,qCAAsB,EAAE;AACtC,UAAM;GACP;EACF,EAAC;CACH;AACF"}
1
+ {"version":3,"file":"embeddings.cjs","names":["Embeddings","fields?: Partial<OpenAIEmbeddingsParams> & {\n verbose?: boolean;\n /**\n * The OpenAI API key to use.\n * Alias for `apiKey`.\n */\n openAIApiKey?: OpenAIApiKey;\n /** The OpenAI API key to use. */\n apiKey?: OpenAIApiKey;\n configuration?: ClientOptions;\n }","texts: string[]","params: OpenAIClient.EmbeddingCreateParams","embeddings: TOutput[]","text: string","request: OpenAIClient.EmbeddingCreateParams","openAIEndpointConfig: OpenAIEndpointConfig","getEndpoint","getHeadersWithUserAgent","OpenAIClient","wrapOpenAIClientError"],"sources":["../src/embeddings.ts"],"sourcesContent":["import { type ClientOptions, OpenAI as OpenAIClient } from \"openai\";\nimport { getEnvironmentVariable } from \"@langchain/core/utils/env\";\nimport { Embeddings, type EmbeddingsParams } from \"@langchain/core/embeddings\";\nimport { chunkArray } from \"@langchain/core/utils/chunk_array\";\nimport type { OpenAIApiKey } from \"./types.js\";\nimport {\n getEndpoint,\n OpenAIEndpointConfig,\n getHeadersWithUserAgent,\n} from \"./utils/azure.js\";\nimport { wrapOpenAIClientError } from \"./utils/client.js\";\n\n/**\n * @see https://platform.openai.com/docs/guides/embeddings#embedding-models\n */\nexport type OpenAIEmbeddingModelId =\n | OpenAIClient.EmbeddingModel\n | (string & NonNullable<unknown>);\n\n/**\n * Interface for OpenAIEmbeddings parameters. Extends EmbeddingsParams and\n * defines additional parameters specific to the OpenAIEmbeddings class.\n */\nexport interface OpenAIEmbeddingsParams extends EmbeddingsParams {\n /**\n * Model name to use\n * Alias for `model`\n * @deprecated Use \"model\" instead.\n */\n modelName: OpenAIEmbeddingModelId;\n /** Model name to use */\n model: OpenAIEmbeddingModelId;\n\n /**\n * The number of dimensions the resulting output embeddings should have.\n * Only supported in `text-embedding-3` and later models.\n */\n dimensions?: number;\n\n /**\n * Timeout to use when making requests to OpenAI.\n */\n timeout?: number;\n\n /**\n * The maximum number of documents to embed in a single request. This is\n * limited by the OpenAI API to a maximum of 2048.\n */\n batchSize?: number;\n\n /**\n * Whether to strip new lines from the input text. This is recommended by\n * OpenAI for older models, but may not be suitable for all use cases.\n * See: https://github.com/openai/openai-python/issues/418#issuecomment-1525939500\n */\n stripNewLines?: boolean;\n\n /**\n * The format to return the embeddings in. Can be either 'float' or 'base64'.\n */\n encodingFormat?: \"float\" | \"base64\";\n}\n\n/**\n * Class for generating embeddings using the OpenAI API.\n *\n * To use with Azure, import the `AzureOpenAIEmbeddings` class.\n *\n * @example\n * ```typescript\n * // Embed a query using OpenAIEmbeddings to generate embeddings for a given text\n * const model = new OpenAIEmbeddings();\n * const res = await model.embedQuery(\n * \"What would be a good company name for a company that makes colorful socks?\",\n * );\n * console.log({ res });\n *\n * ```\n */\nexport class OpenAIEmbeddings<TOutput = number[]>\n extends Embeddings<TOutput>\n implements Partial<OpenAIEmbeddingsParams>\n{\n model = \"text-embedding-ada-002\";\n\n /** @deprecated Use \"model\" instead */\n modelName: string;\n\n batchSize = 512;\n\n // TODO: Update to `false` on next minor release (see: https://github.com/langchain-ai/langchainjs/pull/3612)\n stripNewLines = true;\n\n /**\n * The number of dimensions the resulting output embeddings should have.\n * Only supported in `text-embedding-3` and later models.\n */\n dimensions?: number;\n\n timeout?: number;\n\n organization?: string;\n\n encodingFormat?: \"float\" | \"base64\";\n\n protected client: OpenAIClient;\n\n protected clientConfig: ClientOptions;\n\n protected apiKey?: OpenAIApiKey;\n\n constructor(\n fields?: Partial<OpenAIEmbeddingsParams> & {\n verbose?: boolean;\n /**\n * The OpenAI API key to use.\n * Alias for `apiKey`.\n */\n openAIApiKey?: OpenAIApiKey;\n /** The OpenAI API key to use. */\n apiKey?: OpenAIApiKey;\n configuration?: ClientOptions;\n }\n ) {\n const fieldsWithDefaults = { maxConcurrency: 2, ...fields };\n\n super(fieldsWithDefaults);\n\n const apiKey =\n fieldsWithDefaults?.apiKey ??\n fieldsWithDefaults?.openAIApiKey ??\n getEnvironmentVariable(\"OPENAI_API_KEY\");\n\n this.organization =\n fieldsWithDefaults?.configuration?.organization ??\n getEnvironmentVariable(\"OPENAI_ORGANIZATION\");\n\n this.model =\n fieldsWithDefaults?.model ?? fieldsWithDefaults?.modelName ?? this.model;\n this.modelName = this.model;\n this.batchSize = fieldsWithDefaults?.batchSize ?? this.batchSize;\n this.stripNewLines =\n fieldsWithDefaults?.stripNewLines ?? this.stripNewLines;\n this.timeout = fieldsWithDefaults?.timeout;\n this.dimensions = fieldsWithDefaults?.dimensions;\n this.encodingFormat = fieldsWithDefaults?.encodingFormat;\n\n this.clientConfig = {\n apiKey,\n organization: this.organization,\n dangerouslyAllowBrowser: true,\n ...fields?.configuration,\n };\n }\n\n /**\n * Method to generate embeddings for an array of documents. Splits the\n * documents into batches and makes requests to the OpenAI API to generate\n * embeddings.\n * @param texts Array of documents to generate embeddings for.\n * @returns Promise that resolves to a 2D array of embeddings for each document.\n */\n async embedDocuments(texts: string[]): Promise<TOutput[]> {\n const batches = chunkArray(\n this.stripNewLines ? texts.map((t) => t.replace(/\\n/g, \" \")) : texts,\n this.batchSize\n );\n\n const batchRequests = batches.map((batch) => {\n const params: OpenAIClient.EmbeddingCreateParams = {\n model: this.model,\n input: batch,\n };\n if (this.dimensions) {\n params.dimensions = this.dimensions;\n }\n if (this.encodingFormat) {\n params.encoding_format = this.encodingFormat;\n }\n return this.embeddingWithRetry(params);\n });\n const batchResponses = await Promise.all(batchRequests);\n\n const embeddings: TOutput[] = [];\n for (let i = 0; i < batchResponses.length; i += 1) {\n const batch = batches[i];\n const { data: batchResponse } = batchResponses[i];\n for (let j = 0; j < batch.length; j += 1) {\n embeddings.push(batchResponse[j].embedding as TOutput);\n }\n }\n return embeddings;\n }\n\n /**\n * Method to generate an embedding for a single document. Calls the\n * embeddingWithRetry method with the document as the input.\n * @param text Document to generate an embedding for.\n * @returns Promise that resolves to an embedding for the document.\n */\n async embedQuery(text: string): Promise<TOutput> {\n const params: OpenAIClient.EmbeddingCreateParams = {\n model: this.model,\n input: this.stripNewLines ? text.replace(/\\n/g, \" \") : text,\n };\n if (this.dimensions) {\n params.dimensions = this.dimensions;\n }\n if (this.encodingFormat) {\n params.encoding_format = this.encodingFormat;\n }\n const { data } = await this.embeddingWithRetry(params);\n return data[0].embedding as TOutput;\n }\n\n /**\n * Private method to make a request to the OpenAI API to generate\n * embeddings. Handles the retry logic and returns the response from the\n * API.\n * @param request Request to send to the OpenAI API.\n * @returns Promise that resolves to the response from the API.\n */\n protected async embeddingWithRetry(\n request: OpenAIClient.EmbeddingCreateParams\n ) {\n if (!this.client) {\n const openAIEndpointConfig: OpenAIEndpointConfig = {\n baseURL: this.clientConfig.baseURL,\n };\n\n const endpoint = getEndpoint(openAIEndpointConfig);\n\n const params = {\n ...this.clientConfig,\n baseURL: endpoint,\n timeout: this.timeout,\n maxRetries: 0,\n };\n\n if (!params.baseURL) {\n delete params.baseURL;\n }\n\n params.defaultHeaders = getHeadersWithUserAgent(params.defaultHeaders);\n\n this.client = new OpenAIClient(params);\n }\n const requestOptions = {};\n\n return this.caller.call(async () => {\n try {\n const res = await this.client.embeddings.create(\n request,\n requestOptions\n );\n return res;\n } catch (e) {\n const error = wrapOpenAIClientError(e);\n throw error;\n }\n });\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AA+EA,IAAa,mBAAb,cACUA,uCAEV;CACE,QAAQ;;CAGR;CAEA,YAAY;CAGZ,gBAAgB;;;;;CAMhB;CAEA;CAEA;CAEA;CAEA,AAAU;CAEV,AAAU;CAEV,AAAU;CAEV,YACEC,QAWA;EACA,MAAM,qBAAqB;GAAE,gBAAgB;GAAG,GAAG;EAAQ;EAE3D,MAAM,mBAAmB;EAEzB,MAAM,SACJ,oBAAoB,UACpB,oBAAoB,uEACG,iBAAiB;EAE1C,KAAK,eACH,oBAAoB,eAAe,uEACZ,sBAAsB;EAE/C,KAAK,QACH,oBAAoB,SAAS,oBAAoB,aAAa,KAAK;EACrE,KAAK,YAAY,KAAK;EACtB,KAAK,YAAY,oBAAoB,aAAa,KAAK;EACvD,KAAK,gBACH,oBAAoB,iBAAiB,KAAK;EAC5C,KAAK,UAAU,oBAAoB;EACnC,KAAK,aAAa,oBAAoB;EACtC,KAAK,iBAAiB,oBAAoB;EAE1C,KAAK,eAAe;GAClB;GACA,cAAc,KAAK;GACnB,yBAAyB;GACzB,GAAG,QAAQ;EACZ;CACF;;;;;;;;CASD,MAAM,eAAeC,OAAqC;EACxD,MAAM,6DACJ,KAAK,gBAAgB,MAAM,IAAI,CAAC,MAAM,EAAE,QAAQ,OAAO,IAAI,CAAC,GAAG,OAC/D,KAAK,UACN;EAED,MAAM,gBAAgB,QAAQ,IAAI,CAAC,UAAU;GAC3C,MAAMC,SAA6C;IACjD,OAAO,KAAK;IACZ,OAAO;GACR;AACD,OAAI,KAAK,YACP,OAAO,aAAa,KAAK;AAE3B,OAAI,KAAK,gBACP,OAAO,kBAAkB,KAAK;AAEhC,UAAO,KAAK,mBAAmB,OAAO;EACvC,EAAC;EACF,MAAM,iBAAiB,MAAM,QAAQ,IAAI,cAAc;EAEvD,MAAMC,aAAwB,CAAE;AAChC,OAAK,IAAI,IAAI,GAAG,IAAI,eAAe,QAAQ,KAAK,GAAG;GACjD,MAAM,QAAQ,QAAQ;GACtB,MAAM,EAAE,MAAM,eAAe,GAAG,eAAe;AAC/C,QAAK,IAAI,IAAI,GAAG,IAAI,MAAM,QAAQ,KAAK,GACrC,WAAW,KAAK,cAAc,GAAG,UAAqB;EAEzD;AACD,SAAO;CACR;;;;;;;CAQD,MAAM,WAAWC,MAAgC;EAC/C,MAAMF,SAA6C;GACjD,OAAO,KAAK;GACZ,OAAO,KAAK,gBAAgB,KAAK,QAAQ,OAAO,IAAI,GAAG;EACxD;AACD,MAAI,KAAK,YACP,OAAO,aAAa,KAAK;AAE3B,MAAI,KAAK,gBACP,OAAO,kBAAkB,KAAK;EAEhC,MAAM,EAAE,MAAM,GAAG,MAAM,KAAK,mBAAmB,OAAO;AACtD,SAAO,KAAK,GAAG;CAChB;;;;;;;;CASD,MAAgB,mBACdG,SACA;AACA,MAAI,CAAC,KAAK,QAAQ;GAChB,MAAMC,uBAA6C,EACjD,SAAS,KAAK,aAAa,QAC5B;GAED,MAAM,WAAWC,0BAAY,qBAAqB;GAElD,MAAM,SAAS;IACb,GAAG,KAAK;IACR,SAAS;IACT,SAAS,KAAK;IACd,YAAY;GACb;AAED,OAAI,CAAC,OAAO,SACV,OAAO,OAAO;GAGhB,OAAO,iBAAiBC,sCAAwB,OAAO,eAAe;GAEtE,KAAK,SAAS,IAAIC,cAAa;EAChC;EACD,MAAM,iBAAiB,CAAE;AAEzB,SAAO,KAAK,OAAO,KAAK,YAAY;AAClC,OAAI;IACF,MAAM,MAAM,MAAM,KAAK,OAAO,WAAW,OACvC,SACA,eACD;AACD,WAAO;GACR,SAAQ,GAAG;IACV,MAAM,QAAQC,qCAAsB,EAAE;AACtC,UAAM;GACP;EACF,EAAC;CACH;AACF"}