@langchain/openai 1.5.9 → 1.5.11
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.
- package/CHANGELOG.md +14 -0
- package/dist/azure/chat_models/common.cjs.map +1 -1
- package/dist/azure/embeddings.cjs.map +1 -1
- package/dist/azure/llms.cjs.map +1 -1
- package/dist/chat_models/base.cjs +3 -2
- package/dist/chat_models/base.cjs.map +1 -1
- package/dist/chat_models/base.js +3 -2
- package/dist/chat_models/base.js.map +1 -1
- package/dist/chat_models/completions.cjs.map +1 -1
- package/dist/chat_models/responses.cjs.map +1 -1
- package/dist/chat_models/responses.js.map +1 -1
- package/dist/converters/completions.cjs +3 -1
- package/dist/converters/completions.cjs.map +1 -1
- package/dist/converters/completions.d.cts.map +1 -1
- package/dist/converters/completions.d.ts.map +1 -1
- package/dist/converters/completions.js +3 -1
- package/dist/converters/completions.js.map +1 -1
- package/dist/converters/responses.cjs +6 -4
- package/dist/converters/responses.cjs.map +1 -1
- package/dist/converters/responses.d.cts.map +1 -1
- package/dist/converters/responses.d.ts.map +1 -1
- package/dist/converters/responses.js +6 -4
- package/dist/converters/responses.js.map +1 -1
- package/dist/embeddings.cjs +2 -1
- package/dist/embeddings.cjs.map +1 -1
- package/dist/embeddings.js +2 -1
- package/dist/embeddings.js.map +1 -1
- package/dist/llms.cjs +3 -2
- package/dist/llms.cjs.map +1 -1
- package/dist/llms.js +3 -2
- package/dist/llms.js.map +1 -1
- package/dist/tools/applyPatch.cjs.map +1 -1
- package/dist/tools/computerUse.cjs.map +1 -1
- package/dist/tools/custom.cjs.map +1 -1
- package/dist/tools/dalle.cjs.map +1 -1
- package/dist/tools/localShell.cjs.map +1 -1
- package/dist/tools/shell.cjs.map +1 -1
- package/dist/utils/azure.cjs.map +1 -1
- package/dist/utils/client.cjs.map +1 -1
- package/dist/utils/output.cjs.map +1 -1
- package/dist/utils/prompts.cjs +2 -1
- package/dist/utils/prompts.cjs.map +1 -1
- package/dist/utils/prompts.js +2 -1
- package/dist/utils/prompts.js.map +1 -1
- package/dist/utils/responses_stream_events.cjs.map +1 -1
- package/dist/utils/tools.cjs.map +1 -1
- package/package.json +4 -4
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base.js","names":["OpenAIClient","isOpenAIFunctionTool"],"sources":["../../src/chat_models/base.ts"],"sourcesContent":["import OpenAI, { 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 { resolveLangSmithGatewayConfig } from \"@langchain/core/utils/gateway\";\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 { isLangChainTool } from \"@langchain/core/utils/function_calling\";\nimport { ModelProfile } from \"@langchain/core/language_models/profile\";\nimport { Runnable, RunnableLambda } from \"@langchain/core/runnables\";\nimport { JsonOutputParser } from \"@langchain/core/output_parsers\";\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 OpenAICacheRetentionParam,\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 hasProviderToolDefinition,\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 { wrapOpenAIClientError } from \"../utils/client.js\";\nimport PROFILES from \"./profiles.js\";\nimport {\n isSerializableSchema,\n SerializableSchema,\n} from \"@langchain/core/utils/standard_schema\";\nimport {\n assembleStructuredOutputPipeline,\n createContentParser,\n createFunctionCallingParser,\n} from \"@langchain/core/language_models/structured_output\";\n\nconst MCP_CREDENTIALS_REDACTED = \"**REDACTED**\";\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, 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 * Constrains effort on reasoning for reasoning models. Reduces reasoning in responses,\n * which can reduce latency and cost at the expense of quality.\n *\n * Accepts values: \"low\", \"medium\", or \"high\".\n *\n * @deprecated This is a convenience option that will be merged into the `reasoning` object.\n * Use `reasoning.effort` instead.\n */\n reasoningEffort?: OpenAIClient.Reasoning[\"effort\"];\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 * Used by OpenAI to set cache retention time\n */\n promptCacheRetention?: OpenAICacheRetentionParam;\n\n /**\n * The verbosity of the model's response.\n */\n verbosity?: OpenAIVerbosityParam;\n}\n\nexport interface BaseChatOpenAIFields\n extends Partial<OpenAIChatInput>, BaseChatModelParams {\n /**\n * Optional configuration options for the OpenAI client.\n */\n configuration?: ClientOptions;\n}\n\nexport function getChatOpenAIModelParams<TParams extends BaseChatOpenAIFields>(\n modelOrParams?: string | TParams,\n paramsArg?: Omit<TParams, \"model\">\n): TParams | undefined {\n if (typeof modelOrParams === \"string\") {\n return { model: modelOrParams, ...(paramsArg ?? {}) } as TParams;\n }\n if (modelOrParams == null) {\n return paramsArg as TParams | undefined;\n }\n return modelOrParams;\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 * Used by OpenAI to set cache retention time\n */\n promptCacheRetention?: OpenAICacheRetentionParam;\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 \"reasoning_effort\",\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 \"promptCacheRetention\",\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 protected override _getInvocationParamsForTracing(\n options?: this[\"ParsedCallOptions\"]\n ): ReturnType<this[\"invocationParams\"]> {\n const params = this.invocationParams(options);\n if (!Array.isArray(params.tools)) {\n return params;\n }\n return {\n ...params,\n tools: params.tools.map((tool) => {\n if (tool?.type !== \"mcp\") {\n return tool;\n }\n const redactedTool: Record<string, unknown> = { ...tool };\n if (\"headers\" in redactedTool) {\n redactedTool.headers = MCP_CREDENTIALS_REDACTED;\n }\n if (\"authorization\" in redactedTool) {\n redactedTool.authorization = MCP_CREDENTIALS_REDACTED;\n }\n return redactedTool;\n }),\n };\n }\n\n protected override _getCallOptionsForTracing(\n options: this[\"ParsedCallOptions\"],\n _invocationParams: ReturnType<this[\"invocationParams\"]>\n ): this[\"ParsedCallOptions\"] {\n if (!Array.isArray(options.tools)) {\n return options;\n }\n return {\n ...options,\n tools: options.tools.map((tool) => {\n if (\n typeof tool !== \"object\" ||\n tool === null ||\n !(\"type\" in tool) ||\n tool.type !== \"mcp\"\n ) {\n return tool;\n }\n const redactedTool = { ...tool };\n if (\"headers\" in redactedTool) {\n redactedTool.headers = MCP_CREDENTIALS_REDACTED;\n }\n if (\"authorization\" in redactedTool) {\n redactedTool.authorization = MCP_CREDENTIALS_REDACTED;\n }\n return redactedTool;\n }),\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 const gatewayConfig = resolveLangSmithGatewayConfig({\n baseURL:\n fields?.configuration?.baseURL ??\n (getEnvironmentVariable(\"OPENAI_API_BASE\") ||\n getEnvironmentVariable(\"OPENAI_BASE_URL\") ||\n undefined),\n providerPath: \"openai/v1\",\n });\n this.apiKey =\n fields?.apiKey ??\n configApiKey ??\n gatewayConfig.apiKey ??\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.promptCacheRetention =\n fields?.promptCacheRetention ?? this.promptCacheRetention;\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 baseURL: gatewayConfig.baseURL,\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 this._addVersion(\"@langchain/openai\", __PKG_VERSION__);\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 // Coalesce reasoningEffort into reasoning.effort if reasoning.effort is not already set\n if (\n options?.reasoningEffort !== undefined &&\n reasoning?.effort === undefined\n ) {\n reasoning = {\n ...reasoning,\n effort: options.reasoningEffort,\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 // Built-in tools and custom tools pass through as-is\n if (isBuiltInTool(tool) || isCustomTool(tool)) {\n return tool;\n }\n // Tools with providerToolDefinition (e.g., localShell, shell, computerUse, applyPatch)\n // should use their provider-specific definition\n if (hasProviderToolDefinition(tool)) {\n return tool.extras.providerToolDefinition;\n }\n // Regular tools get converted to OpenAI function format\n const converted = this._convertChatOpenAIToolToCompletionsTool(tool, {\n strict,\n });\n if (isLangChainTool(tool) && tool.extras?.defer_loading === true) {\n return { ...converted, defer_loading: true };\n }\n return converted;\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, roleCount] = await Promise.all([\n this.getNumTokens(message.content),\n this.getNumTokens(messageToOpenAIRole(message)),\n ]);\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 * Moderate content using OpenAI's Moderation API.\n *\n * This method checks whether content violates OpenAI's content policy by\n * analyzing text for categories such as hate, harassment, self-harm,\n * sexual content, violence, and more.\n *\n * @param input - The text or array of texts to moderate\n * @param params - Optional parameters for the moderation request\n * @param params.model - The moderation model to use. Defaults to \"omni-moderation-latest\".\n * @param params.options - Additional options to pass to the underlying request\n * @returns A promise that resolves to the moderation response containing results for each input\n *\n * @example\n * ```typescript\n * const model = new ChatOpenAI({ model: \"gpt-4o-mini\" });\n *\n * // Moderate a single text\n * const result = await model.moderateContent(\"This is a test message\");\n * console.log(result.results[0].flagged); // false\n * console.log(result.results[0].categories); // { hate: false, harassment: false, ... }\n *\n * // Moderate multiple texts\n * const results = await model.moderateContent([\n * \"Hello, how are you?\",\n * \"This is inappropriate content\"\n * ]);\n * results.results.forEach((result, index) => {\n * console.log(`Text ${index + 1} flagged:`, result.flagged);\n * });\n *\n * // Use a specific moderation model\n * const stableResult = await model.moderateContent(\n * \"Test content\",\n * { model: \"omni-moderation-latest\" }\n * );\n * ```\n */\n async moderateContent(\n input: string | string[],\n params?: {\n model?: OpenAI.ModerationModel;\n options?: OpenAICoreRequestOptions;\n }\n ): Promise<OpenAIClient.ModerationCreateResponse> {\n const clientOptions = this._getClientOptions(params?.options);\n const moderationModel = params?.model ?? \"omni-moderation-latest\";\n const moderationRequest: OpenAIClient.ModerationCreateParams = {\n input,\n model: moderationModel,\n };\n\n return this.caller.call(async () => {\n try {\n const response = await this.client.moderations.create(\n moderationRequest,\n clientOptions\n );\n return response;\n } catch (e) {\n const error = wrapOpenAIClientError(e);\n throw error;\n }\n });\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 // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n RunOutput extends Record<string, any> = Record<string, any>,\n >(\n outputSchema:\n | InteropZodType<RunOutput>\n | SerializableSchema<RunOutput>\n // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n | Record<string, any>,\n config?: StructuredOutputMethodOptions<false>\n ): Runnable<BaseLanguageModelInput, RunOutput>;\n\n withStructuredOutput<\n // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n RunOutput extends Record<string, any> = Record<string, any>,\n >(\n outputSchema:\n | InteropZodType<RunOutput>\n | SerializableSchema<RunOutput>\n // oxlint-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 // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n RunOutput extends Record<string, any> = Record<string, any>,\n >(\n outputSchema:\n | InteropZodType<RunOutput>\n | SerializableSchema<RunOutput>\n // oxlint-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:\n | SerializableSchema<RunOutput>\n | InteropZodType<RunOutput>\n | 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 outputParser = createContentParser(schema);\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 asJsonSchema = toJsonSchema(schema);\n const openaiJsonSchemaParams = {\n name: name ?? \"extract\",\n description: getSchemaDescription(asJsonSchema),\n schema: isInteropZodSchema(schema) ? schema : asJsonSchema,\n strict: config?.strict,\n };\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) || isSerializableSchema(schema)) {\n const altParser = createContentParser(schema);\n outputParser = RunnableLambda.from<AIMessageChunk, RunOutput>(\n async (aiMessage: AIMessageChunk) => {\n if (\"parsed\" in aiMessage.additional_kwargs) {\n return aiMessage.additional_kwargs.parsed as RunOutput;\n }\n return altParser.invoke(aiMessage.content as string);\n }\n );\n } else {\n outputParser = new JsonOutputParser<RunOutput>();\n }\n } else {\n let functionName = name ?? \"extract\";\n const asJsonSchema = toJsonSchema(schema);\n\n // Is function calling\n let toolFunction: FunctionDefinition;\n if (isInteropZodSchema(schema) || isSerializableSchema(schema)) {\n toolFunction = {\n name: functionName,\n description: asJsonSchema.description,\n parameters: asJsonSchema,\n };\n } else if (\n typeof schema.name === \"string\" &&\n typeof schema.parameters === \"object\" &&\n schema.parameters != null\n ) {\n toolFunction = schema as unknown as FunctionDefinition;\n functionName = schema.name;\n } else {\n functionName = (schema.title as string) ?? functionName;\n toolFunction = {\n name: functionName,\n description: (schema.description as string) ?? \"\",\n parameters: schema,\n };\n }\n\n llm = this.withConfig({\n outputVersion: \"v0\",\n tools: [{ type: \"function\" as const, function: toolFunction }],\n tool_choice: {\n type: \"function\" as const,\n function: { name: functionName },\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\n outputParser = createFunctionCallingParser(schema, functionName);\n }\n\n return assembleStructuredOutputPipeline(llm, outputParser, includeRaw);\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAyEA,MAAM,2BAA2B;AA+JjC,SAAgB,yBACd,eACA,WACqB;CACrB,IAAI,OAAO,kBAAkB,UAC3B,OAAO;EAAE,OAAO;EAAe,GAAI,aAAa,CAAC;CAAG;CAEtD,IAAI,iBAAiB,MACnB,OAAO;CAET,OAAO;AACT;;AAGA,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;;;;CAKA;CAEA;CAEA,WAAW;EACT,OAAO;CACT;CAEA,OAAO,UAAU;EACf,OAAO;CACT;CAEA,IAAI,WAAW;EACb,OAAO;GACL,GAAG,MAAM;GACT;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;EACF;CACF;CAEA,kBAAkB;CAElB,IAAI,aAAoD;EACtD,OAAO;GACL,QAAQ;GACR,cAAc;EAChB;CACF;CAEA,IAAI,aAAqC;EACvC,OAAO;GACL,QAAQ;GACR,WAAW;EACb;CACF;CAEA,IAAI,uBAAiC;EACnC,OAAO;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;GACA;EACF;CACF;CAEA,YAAY,SAAqD;EAC/D,MAAM,SAAS,KAAK,iBAAiB,OAAO;EAC5C,OAAO;GACL,aAAa;GACb,eAAe,KAAK;GACpB,eAAe;GACf,gBAAgB,OAAO,eAAe,KAAA;GACtC,eAAe,OAAO,cAAc,KAAA;GACpC,SAAS,QAAQ;EACnB;CACF;CAEA,+BACE,SACsC;EACtC,MAAM,SAAS,KAAK,iBAAiB,OAAO;EAC5C,IAAI,CAAC,MAAM,QAAQ,OAAO,KAAK,GAC7B,OAAO;EAET,OAAO;GACL,GAAG;GACH,OAAO,OAAO,MAAM,KAAK,SAAS;IAChC,IAAI,MAAM,SAAS,OACjB,OAAO;IAET,MAAM,eAAwC,EAAE,GAAG,KAAK;IACxD,IAAI,aAAa,cACf,aAAa,UAAU;IAEzB,IAAI,mBAAmB,cACrB,aAAa,gBAAgB;IAE/B,OAAO;GACT,CAAC;EACH;CACF;CAEA,0BACE,SACA,mBAC2B;EAC3B,IAAI,CAAC,MAAM,QAAQ,QAAQ,KAAK,GAC9B,OAAO;EAET,OAAO;GACL,GAAG;GACH,OAAO,QAAQ,MAAM,KAAK,SAAS;IACjC,IACE,OAAO,SAAS,YAChB,SAAS,QACT,EAAE,UAAU,SACZ,KAAK,SAAS,OAEd,OAAO;IAET,MAAM,eAAe,EAAE,GAAG,KAAK;IAC/B,IAAI,aAAa,cACf,aAAa,UAAU;IAEzB,IAAI,mBAAmB,cACrB,aAAa,gBAAgB;IAE/B,OAAO;GACT,CAAC;EACH;CACF;;CAGA,qBAKkB;EAChB,OAAO;GACL,YAAY,KAAK;GACjB,GAAG,KAAK,iBAAiB;GACzB,GAAG,KAAK;EACV;CACF;;;;CAKA,oBAAoB;EAClB,OAAO,KAAK,mBAAmB;CACjC;CAEA,YAAY,QAA+B;EACzC,MAAM,UAAU,CAAC,CAAC;EAElB,MAAM,eACJ,OAAO,QAAQ,eAAe,WAAW,YACzC,OAAO,QAAQ,eAAe,WAAW,aACrC,QAAQ,eAAe,SACvB,KAAA;EACN,MAAM,gBAAgB,8BAA8B;GAClD,SACE,QAAQ,eAAe,YACtB,uBAAuB,iBAAiB,KACvC,uBAAuB,iBAAiB,KACxC,KAAA;GACJ,cAAc;EAChB,CAAC;EACD,KAAK,SACH,QAAQ,UACR,gBACA,cAAc,UACd,uBAAuB,gBAAgB;EACzC,KAAK,eACH,QAAQ,eAAe,gBACvB,uBAAuB,qBAAqB;EAE9C,KAAK,QAAQ,QAAQ,SAAS,QAAQ,aAAa,KAAK;EACxD,KAAK,cAAc,QAAQ,eAAe,CAAC;EAC3C,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,uBACH,QAAQ,wBAAwB,KAAK;EACvC,KAAK,YAAY,QAAQ,aAAa,KAAK;EAE3C,KAAK,mBAAmB,QAAQ,qBAAqB;EACrD,KAAK,YAAY,QAAQ,cAAc;EACvC,IAAI,KAAK,kBAAkB,KAAK,YAAY;EAE5C,IAAI,QAAQ,cAAc,OAAO,KAAK,mBAAmB;EAEzD,KAAK,cAAc,QAAQ,eAAe,KAAK;EAC/C,IAAI,KAAK,kBAAkB,KAAK,cAAc;EAE9C,KAAK,eAAe;GAClB,QAAQ,KAAK;GACb,cAAc,KAAK;GACnB,yBAAyB;GACzB,GAAG,QAAQ;GACX,SAAS,cAAc;EACzB;EAIA,IAAI,QAAQ,8BAA8B,KAAA,GACxC,KAAK,4BAA4B,OAAO;EAG1C,IAAI,QAAQ,iBAAiB,KAAA,GAC3B,KAAK,eAAe,OAAO;EAG7B,KAAK,aAAa,QAAQ,cAAc;EAExC,KAAK,YAAY,qBAAA,OAAoC;CACvD;;;;;CAMA,oBACE,SACoC;EACpC,IAAI,CAAC,iBAAiB,KAAK,KAAK,GAC9B;EAIF,IAAI;EACJ,IAAI,KAAK,cAAc,KAAA,GACrB,YAAY;GACV,GAAG;GACH,GAAG,KAAK;EACV;EAEF,IAAI,SAAS,cAAc,KAAA,GACzB,YAAY;GACV,GAAG;GACH,GAAG,QAAQ;EACb;EAIF,IACE,SAAS,oBAAoB,KAAA,KAC7B,WAAW,WAAW,KAAA,GAEtB,YAAY;GACV,GAAG;GACH,QAAQ,QAAQ;EAClB;EAGF,OAAO;CACT;;;;;CAMA,mBACE,WACyC;EACzC,IACE,aACA,UAAU,SAAS,iBACnB,UAAU,YAAY,UACtB,mBAAmB,UAAU,YAAY,MAAM,GAE/C,OAAO,yBACL,UAAU,YAAY,QACtB,UAAU,YAAY,MACtB,EACE,aAAa,UAAU,YAAY,YACrC,CACF;EAEF,OAAO;CACT;CAEA,oBACE,mBAC2B;EAC3B,OAAO;GACL,GAAG,KAAK;GACR,GAAI,qBAAqB,CAAC;EAC5B;CACF;;CAGA,kBACE,SAC0B;EAC1B,IAAI,CAAC,KAAK,QAAQ;GAKhB,MAAM,WAAW,YAAY,EAH3B,SAAS,KAAK,aAAa,QAGmB,CAAC;GACjD,MAAM,SAAS;IACb,GAAG,KAAK;IACR,SAAS;IACT,SAAS,KAAK;IACd,YAAY;GACd;GACA,IAAI,CAAC,OAAO,SACV,OAAO,OAAO;GAGhB,OAAO,iBAAiB,wBAAwB,OAAO,cAAc;GAErE,KAAK,SAAS,IAAIA,OAAa,MAAM;EACvC;EAKA,OAAO;GAHL,GAAG,KAAK;GACR,GAAG;EAEe;CACtB;CAGA,wCACE,MACA,QACiC;EACjC,IAAI,aAAa,IAAI,GACnB,OAAO,2BAA2B,KAAK,SAAS,UAAU;EAE5D,IAAIC,aAAqB,IAAI,GAAG;GAC9B,IAAI,QAAQ,WAAW,KAAA,GACrB,OAAO;IACL,GAAG;IACH,UAAU;KACR,GAAG,KAAK;KACR,QAAQ,OAAO;IACjB;GACF;GAGF,OAAO;EACT;EACA,OAAO,qBAAqB,MAAM,MAAM;CAC1C;CAEA,UACE,OACA,QAC+D;EAC/D,IAAI;EACJ,IAAI,QAAQ,WAAW,KAAA,GACrB,SAAS,OAAO;OACX,IAAI,KAAK,8BAA8B,KAAA,GAC5C,SAAS,KAAK;EAEhB,OAAO,KAAK,WAAW;GACrB,OAAO,MAAM,KAAK,SAAS;IAEzB,IAAI,cAAc,IAAI,KAAK,aAAa,IAAI,GAC1C,OAAO;IAIT,IAAI,0BAA0B,IAAI,GAChC,OAAO,KAAK,OAAO;IAGrB,MAAM,YAAY,KAAK,wCAAwC,MAAM,EACnE,OACF,CAAC;IACD,IAAI,gBAAgB,IAAI,KAAK,KAAK,QAAQ,kBAAkB,MAC1D,OAAO;KAAE,GAAG;KAAW,eAAe;IAAK;IAE7C,OAAO;GACT,CAAC;GACD,GAAG;EACL,CAAyB;CAC3B;CAEA,MAAe,OAAO,OAA+B,SAAuB;EAC1E,OAAO,MAAM,OACX,OACA,KAAK,oBAAoB,OAAO,CAClC;CACF;CAEA,MAAe,OAAO,OAA+B,SAAuB;EAC1E,OAAO,MAAM,OACX,OACA,KAAK,oBAAoB,OAAO,CAClC;CACF;;CAGA,kBAAkB,GAAG,YAAgD;EACnE,OAAO,WAAW,QAGf,KAAK,cAAc;GAClB,IAAI,aAAa,UAAU,YAAY;IACrC,IAAI,WAAW,oBACb,UAAU,WAAW,oBAAoB;IAC3C,IAAI,WAAW,gBAAgB,UAAU,WAAW,gBAAgB;IACpE,IAAI,WAAW,eAAe,UAAU,WAAW,eAAe;GACpE;GACA,OAAO;EACT,GACA,EACE,YAAY;GACV,kBAAkB;GAClB,cAAc;GACd,aAAa;EACf,EACF,CACF;CACF;CAEA,MAAM,yBAAyB,UAAyB;EACtD,IAAI,aAAa;EACjB,IAAI,mBAAmB;EACvB,IAAI,gBAAgB;EAGpB,IAAI,KAAK,UAAU,sBAAsB;GACvC,mBAAmB;GACnB,gBAAgB;EAClB,OAAO;GACL,mBAAmB;GACnB,gBAAgB;EAClB;EAEA,MAAM,kBAAkB,MAAM,QAAQ,IACpC,SAAS,IAAI,OAAO,YAAY;GAC9B,MAAM,CAAC,WAAW,aAAa,MAAM,QAAQ,IAAI,CAC/C,KAAK,aAAa,QAAQ,OAAO,GACjC,KAAK,aAAa,oBAAoB,OAAO,CAAC,CAChD,CAAC;GACD,MAAM,YACJ,QAAQ,SAAS,KAAA,IACb,gBAAiB,MAAM,KAAK,aAAa,QAAQ,IAAI,IACrD;GACN,IAAI,QAAQ,YAAY,mBAAmB,YAAY;GAGvD,MAAM,gBAAgB;GACtB,IAAI,cAAc,SAAS,MAAM,YAC/B,SAAS;GAEX,IAAI,cAAc,mBAAmB,eACnC,SAAS;GAEX,IAAI,eAAe,kBAAkB,eAAe,MAClD,SAAS,MAAM,KAAK,aAClB,cAAc,kBAAkB,eAAe,IACjD;GAEF,IAAI,cAAc,kBAAkB,eAAe,WACjD,IAAI;IACF,SAAS,MAAM,KAAK,aAElB,KAAK,UACH,KAAK,MACH,cAAc,kBAAkB,eAAe,SACjD,CACF,CACF;GACF,SAAS,OAAO;IACd,QAAQ,MACN,oCACA,OACA,KAAK,UAAU,cAAc,kBAAkB,aAAa,CAC9D;IACA,SAAS,MAAM,KAAK,aAClB,cAAc,kBAAkB,eAAe,SACjD;GACF;GAGF,cAAc;GACd,OAAO;EACT,CAAC,CACH;EAEA,cAAc;EAEd,OAAO;GAAE;GAAY;EAAgB;CACvC;;CAGA,MAAgB,6BAA6B,aAA+B;EAY1E,QAAO,MAXwB,QAAQ,IACrC,YAAY,IAAI,OAAO,eAAe;GACpC,IAAI,WAAW,QAAQ,mBAAmB,eACxC,QAAQ,MAAM,KAAK,yBAAyB,CAAC,WAAW,OAAO,CAAC,EAAA,CAC7D,gBAAgB;QAEnB,OAAO,MAAM,KAAK,aAAa,WAAW,QAAQ,OAAO;EAE7D,CAAC,CACH,EAAA,CAEwB,QAAQ,GAAG,MAAM,IAAI,GAAG,CAAC;CACnD;;CAGA,MAAgB,kCACd,UACA,WACA,eAIiB;EAIjB,IAAI,UAAU,MAAM,KAAK,yBAAyB,QAAQ,EAAA,CAAG;EAG7D,IAAI,aAAa,kBAAkB,QAAQ;GACzC,MAAM,oBAAoB,0BACxB,SACF;GACA,UAAU,MAAM,KAAK,aAAa,iBAAiB;GACnD,UAAU;EACZ;EAKA,IAAI,aAAa,SAAS,MAAM,MAAM,EAAE,SAAS,MAAM,QAAQ,GAC7D,UAAU;EAMZ,IAAI,kBAAkB,QACpB,UAAU;OACL,IAAI,OAAO,kBAAkB,UAClC,UAAW,MAAM,KAAK,aAAa,cAAc,IAAI,IAAK;EAG5D,OAAO;CACT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwCA,MAAM,gBACJ,OACA,QAIgD;EAChD,MAAM,gBAAgB,KAAK,kBAAkB,QAAQ,OAAO;EAE5D,MAAM,oBAAyD;GAC7D;GACA,OAHsB,QAAQ,SAAS;EAIzC;EAEA,OAAO,KAAK,OAAO,KAAK,YAAY;GAClC,IAAI;IAKF,OAAO,MAJgB,KAAK,OAAO,YAAY,OAC7C,mBACA,aACF;GAEF,SAAS,GAAG;IAEV,MADc,sBAAsB,CAC1B;GACZ;EACF,CAAC;CACH;;;;;;;;;;;;;;;;;;CAmBA,IAAI,UAAwB;EAC1B,OAAO,SAAS,KAAK,UAAU,CAAC;CAClC;;CAGA,2BACE,QACA;EACA,MAAM,gBAAgB,EAAE,GAAG,OAAO;EAClC,IACE,CAAC,KAAK,MAAM,WAAW,OAAO,KAC9B,CAAC,KAAK,MAAM,WAAW,QAAQ,KAC/B,KAAK,UAAU,SAEX;OAAA,eAAe,WAAW,KAAA,GAC5B,OAAO;EAAA,OAEJ,IAAI,cAAc,WAAW,cAClC,QAAQ,KACN,sDAAsD,KAAK,MAAM,iCACnE;EAEF,OAAO,cAAc;CACvB;;;;;;;;;;;;;;;;;;;;CA2DA,qBAGE,cAIA,QACA;EACA,IAAI;EACJ,IAAI;EAEJ,MAAM,EAAE,QAAQ,MAAM,eAAe;GACnC,GAAG;GACH,QAAQ;EACV;EAEA,IAAI,QAAQ,WAAW,KAAA,KAAa,OAAO,WAAW,YACpD,MAAM,IAAI,MACR,uEACF;EAGF,MAAM,SAAS,0BAA0B,KAAK,OAAO,QAAQ,MAAM;EAEnE,IAAI,WAAW,YAAY;GACzB,eAAe,oBAAoB,MAAM;GACzC,MAAM,eAAe,aAAa,MAAM;GACxC,MAAM,KAAK,WAAW;IACpB,eAAe;IACf,iBAAiB,EAAE,MAAM,cAAc;IACvC,6BAA6B;KAC3B,QAAQ,EAAE,QAAQ,YAAY;KAC9B,QAAQ;MAAE,OAAO,QAAQ;MAAW,GAAG;KAAa;IACtD;GACF,CAAyB;EAC3B,OAAO,IAAI,WAAW,cAAc;GAClC,MAAM,eAAe,aAAa,MAAM;GACxC,MAAM,yBAAyB;IAC7B,MAAM,QAAQ;IACd,aAAa,qBAAqB,YAAY;IAC9C,QAAQ,mBAAmB,MAAM,IAAI,SAAS;IAC9C,QAAQ,QAAQ;GAClB;GACA,MAAM,KAAK,WAAW;IACpB,eAAe;IACf,iBAAiB;KACf,MAAM;KACN,aAAa;IACf;IACA,6BAA6B;KAC3B,QAAQ,EAAE,QAAQ,cAAc;KAChC,QAAQ;MACN,OAAO,uBAAuB;MAC9B,aAAa,uBAAuB;MACpC,GAAG;KACL;IACF;GACF,CAAyB;GACzB,IAAI,mBAAmB,MAAM,KAAK,qBAAqB,MAAM,GAAG;IAC9D,MAAM,YAAY,oBAAoB,MAAM;IAC5C,eAAe,eAAe,KAC5B,OAAO,cAA8B;KACnC,IAAI,YAAY,UAAU,mBACxB,OAAO,UAAU,kBAAkB;KAErC,OAAO,UAAU,OAAO,UAAU,OAAiB;IACrD,CACF;GACF,OACE,eAAe,IAAI,iBAA4B;EAEnD,OAAO;GACL,IAAI,eAAe,QAAQ;GAC3B,MAAM,eAAe,aAAa,MAAM;GAGxC,IAAI;GACJ,IAAI,mBAAmB,MAAM,KAAK,qBAAqB,MAAM,GAC3D,eAAe;IACb,MAAM;IACN,aAAa,aAAa;IAC1B,YAAY;GACd;QACK,IACL,OAAO,OAAO,SAAS,YACvB,OAAO,OAAO,eAAe,YAC7B,OAAO,cAAc,MACrB;IACA,eAAe;IACf,eAAe,OAAO;GACxB,OAAO;IACL,eAAgB,OAAO,SAAoB;IAC3C,eAAe;KACb,MAAM;KACN,aAAc,OAAO,eAA0B;KAC/C,YAAY;IACd;GACF;GAEA,MAAM,KAAK,WAAW;IACpB,eAAe;IACf,OAAO,CAAC;KAAE,MAAM;KAAqB,UAAU;IAAa,CAAC;IAC7D,aAAa;KACX,MAAM;KACN,UAAU,EAAE,MAAM,aAAa;IACjC;IACA,6BAA6B;KAC3B,QAAQ,EAAE,QAAQ,mBAAmB;KACrC,QAAQ;MAAE,OAAO;MAAc,GAAG;KAAa;IACjD;IAEA,GAAI,QAAQ,WAAW,KAAA,IAAY,EAAE,QAAQ,OAAO,OAAO,IAAI,CAAC;GAClE,CAAyB;GAEzB,eAAe,4BAA4B,QAAQ,YAAY;EACjE;EAEA,OAAO,iCAAiC,KAAK,cAAc,UAAU;CACvE;AACF"}
|
|
1
|
+
{"version":3,"file":"base.js","names":["OpenAIClient","isOpenAIFunctionTool"],"sources":["../../src/chat_models/base.ts"],"sourcesContent":["import OpenAI, { 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 { resolveLangSmithGatewayConfig } from \"@langchain/core/utils/gateway\";\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 { isLangChainTool } from \"@langchain/core/utils/function_calling\";\nimport { ModelProfile } from \"@langchain/core/language_models/profile\";\nimport { Runnable, RunnableLambda } from \"@langchain/core/runnables\";\nimport { JsonOutputParser } from \"@langchain/core/output_parsers\";\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 OpenAICacheRetentionParam,\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 hasProviderToolDefinition,\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 { wrapOpenAIClientError } from \"../utils/client.js\";\nimport PROFILES from \"./profiles.js\";\nimport {\n isSerializableSchema,\n SerializableSchema,\n} from \"@langchain/core/utils/standard_schema\";\nimport {\n assembleStructuredOutputPipeline,\n createContentParser,\n createFunctionCallingParser,\n} from \"@langchain/core/language_models/structured_output\";\n\nconst MCP_CREDENTIALS_REDACTED = \"**REDACTED**\";\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, 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 * Constrains effort on reasoning for reasoning models. Reduces reasoning in responses,\n * which can reduce latency and cost at the expense of quality.\n *\n * Accepts values: \"low\", \"medium\", or \"high\".\n *\n * @deprecated This is a convenience option that will be merged into the `reasoning` object.\n * Use `reasoning.effort` instead.\n */\n reasoningEffort?: OpenAIClient.Reasoning[\"effort\"];\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 * Used by OpenAI to set cache retention time\n */\n promptCacheRetention?: OpenAICacheRetentionParam;\n\n /**\n * The verbosity of the model's response.\n */\n verbosity?: OpenAIVerbosityParam;\n}\n\nexport interface BaseChatOpenAIFields\n extends Partial<OpenAIChatInput>, BaseChatModelParams {\n /**\n * Optional configuration options for the OpenAI client.\n */\n configuration?: ClientOptions;\n}\n\nexport function getChatOpenAIModelParams<TParams extends BaseChatOpenAIFields>(\n modelOrParams?: string | TParams,\n paramsArg?: Omit<TParams, \"model\">\n): TParams | undefined {\n if (typeof modelOrParams === \"string\") {\n return { model: modelOrParams, ...(paramsArg ?? {}) } as TParams;\n }\n if (modelOrParams == null) {\n return paramsArg as TParams | undefined;\n }\n return modelOrParams;\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 * Used by OpenAI to set cache retention time\n */\n promptCacheRetention?: OpenAICacheRetentionParam;\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 \"reasoning_effort\",\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 \"promptCacheRetention\",\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 protected override _getInvocationParamsForTracing(\n options?: this[\"ParsedCallOptions\"]\n ): ReturnType<this[\"invocationParams\"]> {\n const params = this.invocationParams(options);\n if (!Array.isArray(params.tools)) {\n return params;\n }\n return {\n ...params,\n tools: params.tools.map((tool) => {\n if (tool?.type !== \"mcp\") {\n return tool;\n }\n const redactedTool: Record<string, unknown> = { ...tool };\n if (\"headers\" in redactedTool) {\n redactedTool.headers = MCP_CREDENTIALS_REDACTED;\n }\n if (\"authorization\" in redactedTool) {\n redactedTool.authorization = MCP_CREDENTIALS_REDACTED;\n }\n return redactedTool;\n }),\n };\n }\n\n protected override _getCallOptionsForTracing(\n options: this[\"ParsedCallOptions\"],\n _invocationParams: ReturnType<this[\"invocationParams\"]>\n ): this[\"ParsedCallOptions\"] {\n if (!Array.isArray(options.tools)) {\n return options;\n }\n return {\n ...options,\n tools: options.tools.map((tool) => {\n if (\n typeof tool !== \"object\" ||\n tool === null ||\n !(\"type\" in tool) ||\n tool.type !== \"mcp\"\n ) {\n return tool;\n }\n const redactedTool = { ...tool };\n if (\"headers\" in redactedTool) {\n redactedTool.headers = MCP_CREDENTIALS_REDACTED;\n }\n if (\"authorization\" in redactedTool) {\n redactedTool.authorization = MCP_CREDENTIALS_REDACTED;\n }\n return redactedTool;\n }),\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 const gatewayConfig = resolveLangSmithGatewayConfig({\n baseURL:\n fields?.configuration?.baseURL ??\n (getEnvironmentVariable(\"OPENAI_API_BASE\") ||\n getEnvironmentVariable(\"OPENAI_BASE_URL\") ||\n undefined),\n providerPath: \"openai/v1\",\n });\n this.apiKey =\n fields?.apiKey ??\n configApiKey ??\n gatewayConfig.apiKey ??\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.promptCacheRetention =\n fields?.promptCacheRetention ?? this.promptCacheRetention;\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 baseURL: gatewayConfig.baseURL,\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 this._addVersion(\"@langchain/openai\", __PKG_VERSION__);\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 // Coalesce reasoningEffort into reasoning.effort if reasoning.effort is not already set\n if (\n options?.reasoningEffort !== undefined &&\n reasoning?.effort === undefined\n ) {\n reasoning = {\n ...reasoning,\n effort: options.reasoningEffort,\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 // Built-in tools and custom tools pass through as-is\n if (isBuiltInTool(tool) || isCustomTool(tool)) {\n return tool;\n }\n // Tools with providerToolDefinition (e.g., localShell, shell, computerUse, applyPatch)\n // should use their provider-specific definition\n if (hasProviderToolDefinition(tool)) {\n return tool.extras.providerToolDefinition;\n }\n // Regular tools get converted to OpenAI function format\n const converted = this._convertChatOpenAIToolToCompletionsTool(tool, {\n strict,\n });\n if (isLangChainTool(tool) && tool.extras?.defer_loading === true) {\n return { ...converted, defer_loading: true };\n }\n return converted;\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, roleCount] = await Promise.all([\n this.getNumTokens(message.content),\n this.getNumTokens(messageToOpenAIRole(message)),\n ]);\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 * Moderate content using OpenAI's Moderation API.\n *\n * This method checks whether content violates OpenAI's content policy by\n * analyzing text for categories such as hate, harassment, self-harm,\n * sexual content, violence, and more.\n *\n * @param input - The text or array of texts to moderate\n * @param params - Optional parameters for the moderation request\n * @param params.model - The moderation model to use. Defaults to \"omni-moderation-latest\".\n * @param params.options - Additional options to pass to the underlying request\n * @returns A promise that resolves to the moderation response containing results for each input\n *\n * @example\n * ```typescript\n * const model = new ChatOpenAI({ model: \"gpt-4o-mini\" });\n *\n * // Moderate a single text\n * const result = await model.moderateContent(\"This is a test message\");\n * console.log(result.results[0].flagged); // false\n * console.log(result.results[0].categories); // { hate: false, harassment: false, ... }\n *\n * // Moderate multiple texts\n * const results = await model.moderateContent([\n * \"Hello, how are you?\",\n * \"This is inappropriate content\"\n * ]);\n * results.results.forEach((result, index) => {\n * console.log(`Text ${index + 1} flagged:`, result.flagged);\n * });\n *\n * // Use a specific moderation model\n * const stableResult = await model.moderateContent(\n * \"Test content\",\n * { model: \"omni-moderation-latest\" }\n * );\n * ```\n */\n async moderateContent(\n input: string | string[],\n params?: {\n model?: OpenAI.ModerationModel;\n options?: OpenAICoreRequestOptions;\n }\n ): Promise<OpenAIClient.ModerationCreateResponse> {\n const clientOptions = this._getClientOptions(params?.options);\n const moderationModel = params?.model ?? \"omni-moderation-latest\";\n const moderationRequest: OpenAIClient.ModerationCreateParams = {\n input,\n model: moderationModel,\n };\n\n return this.caller.call(async () => {\n try {\n const response = await this.client.moderations.create(\n moderationRequest,\n clientOptions\n );\n return response;\n } catch (e) {\n const error = wrapOpenAIClientError(e);\n throw error;\n }\n });\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 // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n RunOutput extends Record<string, any> = Record<string, any>,\n >(\n outputSchema:\n | InteropZodType<RunOutput>\n | SerializableSchema<RunOutput>\n // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n | Record<string, any>,\n config?: StructuredOutputMethodOptions<false>\n ): Runnable<BaseLanguageModelInput, RunOutput>;\n\n withStructuredOutput<\n // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n RunOutput extends Record<string, any> = Record<string, any>,\n >(\n outputSchema:\n | InteropZodType<RunOutput>\n | SerializableSchema<RunOutput>\n // oxlint-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 // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n RunOutput extends Record<string, any> = Record<string, any>,\n >(\n outputSchema:\n | InteropZodType<RunOutput>\n | SerializableSchema<RunOutput>\n // oxlint-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:\n | SerializableSchema<RunOutput>\n | InteropZodType<RunOutput>\n | 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 outputParser = createContentParser(schema);\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 asJsonSchema = toJsonSchema(schema);\n const openaiJsonSchemaParams = {\n name: name ?? \"extract\",\n description: getSchemaDescription(asJsonSchema),\n schema: isInteropZodSchema(schema) ? schema : asJsonSchema,\n strict: config?.strict,\n };\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) || isSerializableSchema(schema)) {\n const altParser = createContentParser(schema);\n outputParser = RunnableLambda.from<AIMessageChunk, RunOutput>(\n async (aiMessage: AIMessageChunk) => {\n if (\"parsed\" in aiMessage.additional_kwargs) {\n return aiMessage.additional_kwargs.parsed as RunOutput;\n }\n return altParser.invoke(aiMessage.content as string);\n }\n );\n } else {\n outputParser = new JsonOutputParser<RunOutput>();\n }\n } else {\n let functionName = name ?? \"extract\";\n const asJsonSchema = toJsonSchema(schema);\n\n // Is function calling\n let toolFunction: FunctionDefinition;\n if (isInteropZodSchema(schema) || isSerializableSchema(schema)) {\n toolFunction = {\n name: functionName,\n description: asJsonSchema.description,\n parameters: asJsonSchema,\n };\n } else if (\n typeof schema.name === \"string\" &&\n typeof schema.parameters === \"object\" &&\n schema.parameters != null\n ) {\n toolFunction = schema as unknown as FunctionDefinition;\n functionName = schema.name;\n } else {\n functionName = (schema.title as string) ?? functionName;\n toolFunction = {\n name: functionName,\n description: (schema.description as string) ?? \"\",\n parameters: schema,\n };\n }\n\n llm = this.withConfig({\n outputVersion: \"v0\",\n tools: [{ type: \"function\" as const, function: toolFunction }],\n tool_choice: {\n type: \"function\" as const,\n function: { name: functionName },\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\n outputParser = createFunctionCallingParser(schema, functionName);\n }\n\n return assembleStructuredOutputPipeline(llm, outputParser, includeRaw);\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAyEA,MAAM,2BAA2B;AA+JjC,SAAgB,yBACd,eACA,WACqB;CACrB,IAAI,OAAO,kBAAkB,UAC3B,OAAO;EAAE,OAAO;EAAe,GAAI,aAAa,CAAC;CAAG;CAEtD,IAAI,iBAAiB,MACnB,OAAO;CAET,OAAO;AACT;;AAGA,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;;;;CAKA;CAEA;CAEA,WAAW;EACT,OAAO;CACT;CAEA,OAAO,UAAU;EACf,OAAO;CACT;CAEA,IAAI,WAAW;EACb,OAAO;GACL,GAAG,MAAM;GACT;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;EACF;CACF;CAEA,kBAAkB;CAElB,IAAI,aAAoD;EACtD,OAAO;GACL,QAAQ;GACR,cAAc;EAChB;CACF;CAEA,IAAI,aAAqC;EACvC,OAAO;GACL,QAAQ;GACR,WAAW;EACb;CACF;CAEA,IAAI,uBAAiC;EACnC,OAAO;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;GACA;EACF;CACF;CAEA,YAAY,SAAqD;EAC/D,MAAM,SAAS,KAAK,iBAAiB,OAAO;EAC5C,OAAO;GACL,aAAa;GACb,eAAe,KAAK;GACpB,eAAe;GACf,gBAAgB,OAAO,eAAe,KAAA;GACtC,eAAe,OAAO,cAAc,KAAA;GACpC,SAAS,QAAQ;EACnB;CACF;CAEA,+BACE,SACsC;EACtC,MAAM,SAAS,KAAK,iBAAiB,OAAO;EAC5C,IAAI,CAAC,MAAM,QAAQ,OAAO,KAAK,GAC7B,OAAO;EAET,OAAO;GACL,GAAG;GACH,OAAO,OAAO,MAAM,KAAK,SAAS;IAChC,IAAI,MAAM,SAAS,OACjB,OAAO;IAET,MAAM,eAAwC,EAAE,GAAG,KAAK;IACxD,IAAI,aAAa,cACf,aAAa,UAAU;IAEzB,IAAI,mBAAmB,cACrB,aAAa,gBAAgB;IAE/B,OAAO;GACT,CAAC;EACH;CACF;CAEA,0BACE,SACA,mBAC2B;EAC3B,IAAI,CAAC,MAAM,QAAQ,QAAQ,KAAK,GAC9B,OAAO;EAET,OAAO;GACL,GAAG;GACH,OAAO,QAAQ,MAAM,KAAK,SAAS;IACjC,IACE,OAAO,SAAS,YAChB,SAAS,QACT,EAAE,UAAU,SACZ,KAAK,SAAS,OAEd,OAAO;IAET,MAAM,eAAe,EAAE,GAAG,KAAK;IAC/B,IAAI,aAAa,cACf,aAAa,UAAU;IAEzB,IAAI,mBAAmB,cACrB,aAAa,gBAAgB;IAE/B,OAAO;GACT,CAAC;EACH;CACF;;CAGA,qBAKkB;EAChB,OAAO;GACL,YAAY,KAAK;GACjB,GAAG,KAAK,iBAAiB;GACzB,GAAG,KAAK;EACV;CACF;;;;CAKA,oBAAoB;EAClB,OAAO,KAAK,mBAAmB;CACjC;CAEA,YAAY,QAA+B;EACzC,MAAM,UAAU,CAAC,CAAC;EAElB,MAAM,eACJ,OAAO,QAAQ,eAAe,WAAW,YACzC,OAAO,QAAQ,eAAe,WAAW,aACrC,QAAQ,eAAe,SACvB,KAAA;EACN,MAAM,gBAAgB,8BAA8B;GAClD,SACE,QAAQ,eAAe,YACtB,uBAAuB,iBAAiB,KACvC,uBAAuB,iBAAiB,KACxC,KAAA;GACJ,cAAc;EAChB,CAAC;EACD,KAAK,SACH,QAAQ,UACR,gBACA,cAAc,UACd,uBAAuB,gBAAgB;EACzC,KAAK,eACH,QAAQ,eAAe,gBACvB,uBAAuB,qBAAqB;EAE9C,KAAK,QAAQ,QAAQ,SAAS,QAAQ,aAAa,KAAK;EACxD,KAAK,cAAc,QAAQ,eAAe,CAAC;EAC3C,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,uBACH,QAAQ,wBAAwB,KAAK;EACvC,KAAK,YAAY,QAAQ,aAAa,KAAK;EAE3C,KAAK,mBAAmB,QAAQ,qBAAqB;EACrD,KAAK,YAAY,QAAQ,cAAc;EACvC,IAAI,KAAK,kBAAkB,KAAK,YAAY;EAE5C,IAAI,QAAQ,cAAc,OAAO,KAAK,mBAAmB;EAEzD,KAAK,cAAc,QAAQ,eAAe,KAAK;EAC/C,IAAI,KAAK,kBAAkB,KAAK,cAAc;EAE9C,KAAK,eAAe;GAClB,QAAQ,KAAK;GACb,cAAc,KAAK;GACnB,yBAAyB;GACzB,GAAG,QAAQ;GACX,SAAS,cAAc;EACzB;EAIA,IAAI,QAAQ,8BAA8B,KAAA,GACxC,KAAK,4BAA4B,OAAO;EAG1C,IAAI,QAAQ,iBAAiB,KAAA,GAC3B,KAAK,eAAe,OAAO;EAG7B,KAAK,aAAa,QAAQ,cAAc;EAExC,KAAK,YAAY,qBAAA,QAAoC;CACvD;;;;;CAMA,oBACE,SACoC;EACpC,IAAI,CAAC,iBAAiB,KAAK,KAAK,GAC9B;EAIF,IAAI;EACJ,IAAI,KAAK,cAAc,KAAA,GACrB,YAAY;GACV,GAAG;GACH,GAAG,KAAK;EACV;EAEF,IAAI,SAAS,cAAc,KAAA,GACzB,YAAY;GACV,GAAG;GACH,GAAG,QAAQ;EACb;EAIF,IACE,SAAS,oBAAoB,KAAA,KAC7B,WAAW,WAAW,KAAA,GAEtB,YAAY;GACV,GAAG;GACH,QAAQ,QAAQ;EAClB;EAGF,OAAO;CACT;;;;;CAMA,mBACE,WACyC;EACzC,IACE,aACA,UAAU,SAAS,iBACnB,UAAU,YAAY,UACtB,mBAAmB,UAAU,YAAY,MAAM,GAE/C,OAAO,yBACL,UAAU,YAAY,QACtB,UAAU,YAAY,MACtB,EACE,aAAa,UAAU,YAAY,YACrC,CACF;EAEF,OAAO;CACT;CAEA,oBACE,mBAC2B;EAC3B,OAAO;GACL,GAAG,KAAK;GACR,GAAI,qBAAqB,CAAC;EAC5B;CACF;;CAGA,kBACE,SAC0B;EAC1B,IAAI,CAAC,KAAK,QAAQ;GAChB,MAAM,uBAA6C,EACjD,SAAS,KAAK,aAAa,QAC7B;GAEA,MAAM,WAAW,YAAY,oBAAoB;GACjD,MAAM,SAAS;IACb,GAAG,KAAK;IACR,SAAS;IACT,SAAS,KAAK;IACd,YAAY;GACd;GACA,IAAI,CAAC,OAAO,SACV,OAAO,OAAO;GAGhB,OAAO,iBAAiB,wBAAwB,OAAO,cAAc;GAErE,KAAK,SAAS,IAAIA,OAAa,MAAM;EACvC;EAKA,OAAO;GAHL,GAAG,KAAK;GACR,GAAG;EAEe;CACtB;CAGA,wCACE,MACA,QACiC;EACjC,IAAI,aAAa,IAAI,GACnB,OAAO,2BAA2B,KAAK,SAAS,UAAU;EAE5D,IAAIC,aAAqB,IAAI,GAAG;GAC9B,IAAI,QAAQ,WAAW,KAAA,GACrB,OAAO;IACL,GAAG;IACH,UAAU;KACR,GAAG,KAAK;KACR,QAAQ,OAAO;IACjB;GACF;GAGF,OAAO;EACT;EACA,OAAO,qBAAqB,MAAM,MAAM;CAC1C;CAEA,UACE,OACA,QAC+D;EAC/D,IAAI;EACJ,IAAI,QAAQ,WAAW,KAAA,GACrB,SAAS,OAAO;OACX,IAAI,KAAK,8BAA8B,KAAA,GAC5C,SAAS,KAAK;EAEhB,OAAO,KAAK,WAAW;GACrB,OAAO,MAAM,KAAK,SAAS;IAEzB,IAAI,cAAc,IAAI,KAAK,aAAa,IAAI,GAC1C,OAAO;IAIT,IAAI,0BAA0B,IAAI,GAChC,OAAO,KAAK,OAAO;IAGrB,MAAM,YAAY,KAAK,wCAAwC,MAAM,EACnE,OACF,CAAC;IACD,IAAI,gBAAgB,IAAI,KAAK,KAAK,QAAQ,kBAAkB,MAC1D,OAAO;KAAE,GAAG;KAAW,eAAe;IAAK;IAE7C,OAAO;GACT,CAAC;GACD,GAAG;EACL,CAAyB;CAC3B;CAEA,MAAe,OAAO,OAA+B,SAAuB;EAC1E,OAAO,MAAM,OACX,OACA,KAAK,oBAAoB,OAAO,CAClC;CACF;CAEA,MAAe,OAAO,OAA+B,SAAuB;EAC1E,OAAO,MAAM,OACX,OACA,KAAK,oBAAoB,OAAO,CAClC;CACF;;CAGA,kBAAkB,GAAG,YAAgD;EACnE,OAAO,WAAW,QAGf,KAAK,cAAc;GAClB,IAAI,aAAa,UAAU,YAAY;IACrC,IAAI,WAAW,oBACb,UAAU,WAAW,oBAAoB;IAC3C,IAAI,WAAW,gBAAgB,UAAU,WAAW,gBAAgB;IACpE,IAAI,WAAW,eAAe,UAAU,WAAW,eAAe;GACpE;GACA,OAAO;EACT,GACA,EACE,YAAY;GACV,kBAAkB;GAClB,cAAc;GACd,aAAa;EACf,EACF,CACF;CACF;CAEA,MAAM,yBAAyB,UAAyB;EACtD,IAAI,aAAa;EACjB,IAAI,mBAAmB;EACvB,IAAI,gBAAgB;EAGpB,IAAI,KAAK,UAAU,sBAAsB;GACvC,mBAAmB;GACnB,gBAAgB;EAClB,OAAO;GACL,mBAAmB;GACnB,gBAAgB;EAClB;EAEA,MAAM,kBAAkB,MAAM,QAAQ,IACpC,SAAS,IAAI,OAAO,YAAY;GAC9B,MAAM,CAAC,WAAW,aAAa,MAAM,QAAQ,IAAI,CAC/C,KAAK,aAAa,QAAQ,OAAO,GACjC,KAAK,aAAa,oBAAoB,OAAO,CAAC,CAChD,CAAC;GACD,MAAM,YACJ,QAAQ,SAAS,KAAA,IACb,gBAAiB,MAAM,KAAK,aAAa,QAAQ,IAAI,IACrD;GACN,IAAI,QAAQ,YAAY,mBAAmB,YAAY;GAGvD,MAAM,gBAAgB;GACtB,IAAI,cAAc,SAAS,MAAM,YAC/B,SAAS;GAEX,IAAI,cAAc,mBAAmB,eACnC,SAAS;GAEX,IAAI,eAAe,kBAAkB,eAAe,MAClD,SAAS,MAAM,KAAK,aAClB,cAAc,kBAAkB,eAAe,IACjD;GAEF,IAAI,cAAc,kBAAkB,eAAe,WACjD,IAAI;IACF,SAAS,MAAM,KAAK,aAElB,KAAK,UACH,KAAK,MACH,cAAc,kBAAkB,eAAe,SACjD,CACF,CACF;GACF,SAAS,OAAO;IACd,QAAQ,MACN,oCACA,OACA,KAAK,UAAU,cAAc,kBAAkB,aAAa,CAC9D;IACA,SAAS,MAAM,KAAK,aAClB,cAAc,kBAAkB,eAAe,SACjD;GACF;GAGF,cAAc;GACd,OAAO;EACT,CAAC,CACH;EAEA,cAAc;EAEd,OAAO;GAAE;GAAY;EAAgB;CACvC;;CAGA,MAAgB,6BAA6B,aAA+B;EAY1E,QAAO,MAXwB,QAAQ,IACrC,YAAY,IAAI,OAAO,eAAe;GACpC,IAAI,WAAW,QAAQ,mBAAmB,eACxC,QAAQ,MAAM,KAAK,yBAAyB,CAAC,WAAW,OAAO,CAAC,EAAA,CAC7D,gBAAgB;QAEnB,OAAO,MAAM,KAAK,aAAa,WAAW,QAAQ,OAAO;EAE7D,CAAC,CACH,EAAA,CAEwB,QAAQ,GAAG,MAAM,IAAI,GAAG,CAAC;CACnD;;CAGA,MAAgB,kCACd,UACA,WACA,eAIiB;EAIjB,IAAI,UAAU,MAAM,KAAK,yBAAyB,QAAQ,EAAA,CAAG;EAG7D,IAAI,aAAa,kBAAkB,QAAQ;GACzC,MAAM,oBAAoB,0BACxB,SACF;GACA,UAAU,MAAM,KAAK,aAAa,iBAAiB;GACnD,UAAU;EACZ;EAKA,IAAI,aAAa,SAAS,MAAM,MAAM,EAAE,SAAS,MAAM,QAAQ,GAC7D,UAAU;EAMZ,IAAI,kBAAkB,QACpB,UAAU;OACL,IAAI,OAAO,kBAAkB,UAClC,UAAW,MAAM,KAAK,aAAa,cAAc,IAAI,IAAK;EAG5D,OAAO;CACT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwCA,MAAM,gBACJ,OACA,QAIgD;EAChD,MAAM,gBAAgB,KAAK,kBAAkB,QAAQ,OAAO;EAE5D,MAAM,oBAAyD;GAC7D;GACA,OAHsB,QAAQ,SAAS;EAIzC;EAEA,OAAO,KAAK,OAAO,KAAK,YAAY;GAClC,IAAI;IAKF,OAAO,MAJgB,KAAK,OAAO,YAAY,OAC7C,mBACA,aACF;GAEF,SAAS,GAAG;IAEV,MADc,sBAAsB,CAC1B;GACZ;EACF,CAAC;CACH;;;;;;;;;;;;;;;;;;CAmBA,IAAI,UAAwB;EAC1B,OAAO,SAAS,KAAK,UAAU,CAAC;CAClC;;CAGA,2BACE,QACA;EACA,MAAM,gBAAgB,EAAE,GAAG,OAAO;EAClC,IACE,CAAC,KAAK,MAAM,WAAW,OAAO,KAC9B,CAAC,KAAK,MAAM,WAAW,QAAQ,KAC/B,KAAK,UAAU,SAEX;OAAA,eAAe,WAAW,KAAA,GAC5B,OAAO;EAAA,OAEJ,IAAI,cAAc,WAAW,cAClC,QAAQ,KACN,sDAAsD,KAAK,MAAM,iCACnE;EAEF,OAAO,cAAc;CACvB;;;;;;;;;;;;;;;;;;;;CA2DA,qBAGE,cAIA,QACA;EACA,IAAI;EACJ,IAAI;EAEJ,MAAM,EAAE,QAAQ,MAAM,eAAe;GACnC,GAAG;GACH,QAAQ;EACV;EAEA,IAAI,QAAQ,WAAW,KAAA,KAAa,OAAO,WAAW,YACpD,MAAM,IAAI,MACR,uEACF;EAGF,MAAM,SAAS,0BAA0B,KAAK,OAAO,QAAQ,MAAM;EAEnE,IAAI,WAAW,YAAY;GACzB,eAAe,oBAAoB,MAAM;GACzC,MAAM,eAAe,aAAa,MAAM;GACxC,MAAM,KAAK,WAAW;IACpB,eAAe;IACf,iBAAiB,EAAE,MAAM,cAAc;IACvC,6BAA6B;KAC3B,QAAQ,EAAE,QAAQ,YAAY;KAC9B,QAAQ;MAAE,OAAO,QAAQ;MAAW,GAAG;KAAa;IACtD;GACF,CAAyB;EAC3B,OAAO,IAAI,WAAW,cAAc;GAClC,MAAM,eAAe,aAAa,MAAM;GACxC,MAAM,yBAAyB;IAC7B,MAAM,QAAQ;IACd,aAAa,qBAAqB,YAAY;IAC9C,QAAQ,mBAAmB,MAAM,IAAI,SAAS;IAC9C,QAAQ,QAAQ;GAClB;GACA,MAAM,KAAK,WAAW;IACpB,eAAe;IACf,iBAAiB;KACf,MAAM;KACN,aAAa;IACf;IACA,6BAA6B;KAC3B,QAAQ,EAAE,QAAQ,cAAc;KAChC,QAAQ;MACN,OAAO,uBAAuB;MAC9B,aAAa,uBAAuB;MACpC,GAAG;KACL;IACF;GACF,CAAyB;GACzB,IAAI,mBAAmB,MAAM,KAAK,qBAAqB,MAAM,GAAG;IAC9D,MAAM,YAAY,oBAAoB,MAAM;IAC5C,eAAe,eAAe,KAC5B,OAAO,cAA8B;KACnC,IAAI,YAAY,UAAU,mBACxB,OAAO,UAAU,kBAAkB;KAErC,OAAO,UAAU,OAAO,UAAU,OAAiB;IACrD,CACF;GACF,OACE,eAAe,IAAI,iBAA4B;EAEnD,OAAO;GACL,IAAI,eAAe,QAAQ;GAC3B,MAAM,eAAe,aAAa,MAAM;GAGxC,IAAI;GACJ,IAAI,mBAAmB,MAAM,KAAK,qBAAqB,MAAM,GAC3D,eAAe;IACb,MAAM;IACN,aAAa,aAAa;IAC1B,YAAY;GACd;QACK,IACL,OAAO,OAAO,SAAS,YACvB,OAAO,OAAO,eAAe,YAC7B,OAAO,cAAc,MACrB;IACA,eAAe;IACf,eAAe,OAAO;GACxB,OAAO;IACL,eAAgB,OAAO,SAAoB;IAC3C,eAAe;KACb,MAAM;KACN,aAAc,OAAO,eAA0B;KAC/C,YAAY;IACd;GACF;GAEA,MAAM,KAAK,WAAW;IACpB,eAAe;IACf,OAAO,CAAC;KAAE,MAAM;KAAqB,UAAU;IAAa,CAAC;IAC7D,aAAa;KACX,MAAM;KACN,UAAU,EAAE,MAAM,aAAa;IACjC;IACA,6BAA6B;KAC3B,QAAQ,EAAE,QAAQ,mBAAmB;KACrC,QAAQ;MAAE,OAAO;MAAc,GAAG;KAAa;IACjD;IAEA,GAAI,QAAQ,WAAW,KAAA,IAAY,EAAE,QAAQ,OAAO,OAAO,IAAI,CAAC;GAClE,CAAyB;GAEzB,eAAe,4BAA4B,QAAQ,YAAY;EACjE;EAEA,OAAO,iCAAiC,KAAK,cAAc,UAAU;CACvE;AACF"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"completions.cjs","names":["BaseChatOpenAI","getChatOpenAIModelParams","formatToOpenAIToolChoice","isReasoningModel","convertMessagesToCompletionsMessageParams","AIMessage","ChatGenerationChunk","AIMessageChunk","wrapOpenAIClientError","convertCompletionsDeltaToBaseMessageChunk","convertCompletionsMessageToBaseMessage"],"sources":["../../src/chat_models/completions.ts"],"sourcesContent":["import { OpenAI as OpenAIClient } from \"openai\";\nimport { CallbackManagerForLLMRun } from \"@langchain/core/callbacks/manager\";\nimport type { ChatModelStreamEvent } from \"@langchain/core/language_models/event\";\nimport {\n AIMessage,\n AIMessageChunk,\n type BaseMessage,\n isAIMessage,\n type UsageMetadata,\n type AIMessageFields,\n BaseMessageChunk,\n} from \"@langchain/core/messages\";\nimport {\n ChatGenerationChunk,\n type ChatGeneration,\n type ChatResult,\n} from \"@langchain/core/outputs\";\nimport { NewTokenIndices } from \"@langchain/core/callbacks/base\";\nimport { wrapOpenAIClientError } from \"../utils/client.js\";\nimport {\n OpenAIToolChoice,\n formatToOpenAIToolChoice,\n _convertToOpenAITool,\n} from \"../utils/tools.js\";\nimport { isReasoningModel } from \"../utils/misc.js\";\nimport {\n BaseChatOpenAI,\n BaseChatOpenAICallOptions,\n BaseChatOpenAIFields,\n getChatOpenAIModelParams,\n} from \"./base.js\";\nimport {\n convertCompletionsDeltaToBaseMessageChunk,\n convertCompletionsMessageToBaseMessage,\n convertMessagesToCompletionsMessageParams,\n} from \"../converters/completions.js\";\nimport { convertOpenAICompletionsStream } from \"../utils/stream_events.js\";\n\nexport interface ChatOpenAICompletionsCallOptions extends BaseChatOpenAICallOptions {}\n\ntype ChatCompletionsInvocationParams = Omit<\n OpenAIClient.Chat.Completions.ChatCompletionCreateParams,\n \"messages\"\n>;\n\n/**\n * OpenAI Completions API implementation.\n * @internal\n */\nexport class ChatOpenAICompletions<\n CallOptions extends ChatOpenAICompletionsCallOptions =\n ChatOpenAICompletionsCallOptions,\n> extends BaseChatOpenAI<CallOptions> {\n constructor(model: string, fields?: Omit<BaseChatOpenAIFields, \"model\">);\n constructor(fields?: BaseChatOpenAIFields);\n constructor(\n modelOrFields?: string | BaseChatOpenAIFields,\n fieldsArg?: Omit<BaseChatOpenAIFields, \"model\">\n ) {\n super(getChatOpenAIModelParams(modelOrFields, fieldsArg));\n }\n\n /** @internal */\n override invocationParams(\n options?: this[\"ParsedCallOptions\"],\n extra?: { streaming?: boolean }\n ): ChatCompletionsInvocationParams {\n let strict: boolean | undefined;\n if (options?.strict !== undefined) {\n strict = options.strict;\n } else if (this.supportsStrictToolCalling !== undefined) {\n strict = this.supportsStrictToolCalling;\n }\n\n // A `json_schema` response format goes through the SDK `.parse()` helper,\n // which requires strict function tools — but only on the NON-streaming path\n // (`completionWithRetry` uses `.parse()` only when `!request.stream`).\n // Streaming structured output uses `create()`, which doesn't need strict, so\n // don't force it there. Default to strict for the parse path unless the\n // caller set strict:false. (Re-applied here because the agent core no longer\n // forces strict for every provider.)\n const isStreaming = this.streaming || extra?.streaming;\n if (\n !isStreaming &&\n options?.response_format?.type === \"json_schema\" &&\n strict !== false\n ) {\n strict = true;\n }\n\n let streamOptionsConfig = {};\n if (options?.stream_options !== undefined) {\n streamOptionsConfig = { stream_options: options.stream_options };\n } else if (this.streamUsage && (this.streaming || extra?.streaming)) {\n streamOptionsConfig = { stream_options: { include_usage: true } };\n }\n\n const params: Partial<ChatCompletionsInvocationParams> = {\n model: this.model,\n temperature: this.temperature,\n top_p: this.topP,\n frequency_penalty: this.frequencyPenalty,\n presence_penalty: this.presencePenalty,\n logprobs: this.logprobs,\n top_logprobs: this.topLogprobs,\n n: this.n,\n logit_bias: this.logitBias,\n stop: options?.stop ?? this.stopSequences,\n user: this.user,\n // if include_usage is set or streamUsage then stream must be set to true.\n stream: this.streaming,\n functions: options?.functions,\n function_call: options?.function_call,\n tools: options?.tools?.length\n ? options.tools.map((tool) =>\n this._convertChatOpenAIToolToCompletionsTool(tool, { strict })\n )\n : undefined,\n tool_choice: formatToOpenAIToolChoice(\n options?.tool_choice as OpenAIToolChoice\n ),\n response_format: this._getResponseFormat(options?.response_format),\n seed: options?.seed,\n ...streamOptionsConfig,\n parallel_tool_calls: options?.parallel_tool_calls,\n ...(this.audio || options?.audio\n ? { audio: this.audio || options?.audio }\n : {}),\n ...(this.modalities || options?.modalities\n ? { modalities: this.modalities || options?.modalities }\n : {}),\n ...this.modelKwargs,\n prompt_cache_key: options?.promptCacheKey ?? this.promptCacheKey,\n prompt_cache_retention:\n options?.promptCacheRetention ?? this.promptCacheRetention,\n verbosity: options?.verbosity ?? this.verbosity,\n };\n if (options?.prediction !== undefined) {\n params.prediction = options.prediction;\n }\n if (this.service_tier !== undefined) {\n params.service_tier = this.service_tier;\n }\n if (options?.service_tier !== undefined) {\n params.service_tier = options.service_tier;\n }\n const reasoning = this._getReasoningParams(options);\n if (reasoning !== undefined && reasoning.effort !== undefined) {\n params.reasoning_effort = reasoning.effort;\n }\n if (isReasoningModel(params.model)) {\n params.max_completion_tokens =\n this.maxTokens === -1 ? undefined : this.maxTokens;\n } else {\n params.max_tokens = this.maxTokens === -1 ? undefined : this.maxTokens;\n }\n\n return params as ChatCompletionsInvocationParams;\n }\n\n async _generate(\n messages: BaseMessage[],\n options: this[\"ParsedCallOptions\"],\n runManager?: CallbackManagerForLLMRun\n ): Promise<ChatResult> {\n options.signal?.throwIfAborted();\n const usageMetadata = {} as UsageMetadata;\n const params = this.invocationParams(options);\n const messagesMapped: OpenAIClient.Chat.Completions.ChatCompletionMessageParam[] =\n convertMessagesToCompletionsMessageParams({\n messages,\n model: this.model,\n });\n\n if (params.stream) {\n const stream = this._streamResponseChunks(messages, options, runManager);\n const finalChunks: Record<number, ChatGenerationChunk> = {};\n for await (const chunk of stream) {\n chunk.message.response_metadata = {\n ...chunk.generationInfo,\n ...chunk.message.response_metadata,\n };\n const index =\n (chunk.generationInfo as NewTokenIndices)?.completion ?? 0;\n if (finalChunks[index] === undefined) {\n finalChunks[index] = chunk;\n } else {\n finalChunks[index] = finalChunks[index].concat(chunk);\n }\n }\n const generations = Object.entries(finalChunks)\n .sort(([aKey], [bKey]) => parseInt(aKey, 10) - parseInt(bKey, 10))\n .map(([_, value]) => value);\n\n const { functions, function_call } = this.invocationParams(options);\n\n // OpenAI does not support token usage report under stream mode,\n // fallback to estimation.\n\n const promptTokenUsage = await this._getEstimatedTokenCountFromPrompt(\n messages,\n functions,\n function_call\n );\n const completionTokenUsage =\n await this._getNumTokensFromGenerations(generations);\n\n usageMetadata.input_tokens = promptTokenUsage;\n usageMetadata.output_tokens = completionTokenUsage;\n usageMetadata.total_tokens = promptTokenUsage + completionTokenUsage;\n return {\n generations,\n llmOutput: {\n estimatedTokenUsage: {\n promptTokens: usageMetadata.input_tokens,\n completionTokens: usageMetadata.output_tokens,\n totalTokens: usageMetadata.total_tokens,\n },\n },\n };\n } else {\n const data = await this.completionWithRetry(\n {\n ...params,\n stream: false,\n messages: messagesMapped,\n },\n {\n signal: options?.signal,\n maxRetries: options?.maxRetries,\n ...options?.options,\n }\n );\n\n const {\n completion_tokens: completionTokens,\n prompt_tokens: promptTokens,\n total_tokens: totalTokens,\n prompt_tokens_details: promptTokensDetails,\n completion_tokens_details: completionTokensDetails,\n } = data?.usage ?? {};\n\n if (completionTokens) {\n usageMetadata.output_tokens =\n (usageMetadata.output_tokens ?? 0) + completionTokens;\n }\n\n if (promptTokens) {\n usageMetadata.input_tokens =\n (usageMetadata.input_tokens ?? 0) + promptTokens;\n }\n\n if (totalTokens) {\n usageMetadata.total_tokens =\n (usageMetadata.total_tokens ?? 0) + totalTokens;\n }\n\n if (\n promptTokensDetails?.audio_tokens !== null ||\n promptTokensDetails?.cached_tokens !== null ||\n promptTokensDetails?.cache_write_tokens != null\n ) {\n usageMetadata.input_token_details = {\n ...(promptTokensDetails?.audio_tokens !== null && {\n audio: promptTokensDetails?.audio_tokens,\n }),\n ...(promptTokensDetails?.cached_tokens !== null && {\n cache_read: promptTokensDetails?.cached_tokens,\n }),\n ...(promptTokensDetails?.cache_write_tokens != null && {\n cache_creation: promptTokensDetails?.cache_write_tokens,\n }),\n };\n }\n\n if (\n completionTokensDetails?.audio_tokens !== null ||\n completionTokensDetails?.reasoning_tokens !== null\n ) {\n usageMetadata.output_token_details = {\n ...(completionTokensDetails?.audio_tokens !== null && {\n audio: completionTokensDetails?.audio_tokens,\n }),\n ...(completionTokensDetails?.reasoning_tokens !== null && {\n reasoning: completionTokensDetails?.reasoning_tokens,\n }),\n };\n }\n\n const generations: ChatGeneration[] = [];\n for (const part of data?.choices ?? []) {\n const text = part.message?.content ?? \"\";\n const generation: ChatGeneration = {\n text,\n message: this._convertCompletionsMessageToBaseMessage(\n part.message ?? { role: \"assistant\" },\n data\n ),\n };\n generation.generationInfo = {\n ...(part.finish_reason ? { finish_reason: part.finish_reason } : {}),\n ...(part.logprobs ? { logprobs: part.logprobs } : {}),\n };\n if (isAIMessage(generation.message)) {\n generation.message.usage_metadata = usageMetadata;\n }\n // Fields are not serialized unless passed to the constructor\n // Doing this ensures all fields on the message are serialized\n generation.message = new AIMessage(\n Object.fromEntries(\n Object.entries(generation.message).filter(\n ([key]) => !key.startsWith(\"lc_\")\n )\n ) as AIMessageFields\n );\n generations.push(generation);\n }\n return {\n generations,\n llmOutput: {\n tokenUsage: {\n promptTokens: usageMetadata.input_tokens,\n completionTokens: usageMetadata.output_tokens,\n totalTokens: usageMetadata.total_tokens,\n },\n },\n };\n }\n }\n\n /**\n * Native implementation of the content-block-centric streaming protocol\n * for OpenAI Chat Completions.\n */\n async *_streamChatModelEvents(\n messages: BaseMessage[],\n options: this[\"ParsedCallOptions\"],\n _runManager?: CallbackManagerForLLMRun\n ): AsyncGenerator<ChatModelStreamEvent> {\n const messagesMapped: OpenAIClient.Chat.Completions.ChatCompletionMessageParam[] =\n convertMessagesToCompletionsMessageParams({\n messages,\n model: this.model,\n });\n\n const params = {\n ...this.invocationParams(options, {\n streaming: true,\n }),\n messages: messagesMapped,\n stream: true as const,\n };\n\n const streamIterable = await this.completionWithRetry(params, options);\n const shouldStreamUsage = this.streamUsage ?? options.streamUsage;\n\n const abortableStream = async function* (\n source: AsyncIterable<OpenAIClient.Chat.Completions.ChatCompletionChunk>,\n signal?: AbortSignal\n ) {\n for await (const data of source) {\n if (signal?.aborted) {\n return;\n }\n yield data;\n }\n };\n\n yield* convertOpenAICompletionsStream(\n abortableStream(streamIterable, options.signal),\n {\n streamUsage: shouldStreamUsage ?? true,\n provider: this.streamEventProvider,\n }\n );\n }\n\n /** Provider id used in native stream protocol passthrough events. */\n protected get streamEventProvider(): string {\n return \"openai\";\n }\n\n async *_streamResponseChunks(\n messages: BaseMessage[],\n options: this[\"ParsedCallOptions\"],\n runManager?: CallbackManagerForLLMRun\n ): AsyncGenerator<ChatGenerationChunk> {\n const messagesMapped: OpenAIClient.Chat.Completions.ChatCompletionMessageParam[] =\n convertMessagesToCompletionsMessageParams({\n messages,\n model: this.model,\n });\n\n const params = {\n ...this.invocationParams(options, {\n streaming: true,\n }),\n messages: messagesMapped,\n stream: true as const,\n };\n let defaultRole: OpenAIClient.Chat.ChatCompletionRole | undefined;\n\n const streamIterable = await this.completionWithRetry(params, options);\n let usage: OpenAIClient.Completions.CompletionUsage | undefined;\n for await (const data of streamIterable) {\n if (options.signal?.aborted) {\n return;\n }\n const choice = data?.choices?.[0];\n if (data.usage) {\n usage = data.usage;\n }\n if (!choice) {\n continue;\n }\n\n const { delta } = choice;\n if (!delta) {\n continue;\n }\n const chunk = this._convertCompletionsDeltaToBaseMessageChunk(\n delta,\n data,\n defaultRole\n );\n defaultRole = delta.role ?? defaultRole;\n const newTokenIndices = {\n prompt: options.promptIndex ?? 0,\n completion: choice.index ?? 0,\n };\n if (typeof chunk.content !== \"string\") {\n console.log(\n \"[WARNING]: Received non-string content from OpenAI. This is currently not supported.\"\n );\n continue;\n }\n // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n const generationInfo: Record<string, any> = { ...newTokenIndices };\n if (choice.finish_reason != null) {\n generationInfo.finish_reason = choice.finish_reason;\n // Only include system fingerprint in the last chunk for now\n // to avoid concatenation issues\n generationInfo.system_fingerprint = data.system_fingerprint;\n generationInfo.model_name = data.model;\n generationInfo.service_tier = data.service_tier;\n }\n if (this.logprobs) {\n generationInfo.logprobs = choice.logprobs;\n }\n const generationChunk = new ChatGenerationChunk({\n message: chunk,\n text: chunk.content,\n generationInfo,\n });\n yield generationChunk;\n await runManager?.handleLLMNewToken(\n generationChunk.text ?? \"\",\n newTokenIndices,\n undefined,\n undefined,\n undefined,\n { chunk: generationChunk }\n );\n }\n if (usage) {\n const inputTokenDetails = {\n ...(usage.prompt_tokens_details?.audio_tokens !== null && {\n audio: usage.prompt_tokens_details?.audio_tokens,\n }),\n ...(usage.prompt_tokens_details?.cached_tokens !== null && {\n cache_read: usage.prompt_tokens_details?.cached_tokens,\n }),\n ...(usage.prompt_tokens_details?.cache_write_tokens != null && {\n cache_creation: usage.prompt_tokens_details?.cache_write_tokens,\n }),\n };\n const outputTokenDetails = {\n ...(usage.completion_tokens_details?.audio_tokens !== null && {\n audio: usage.completion_tokens_details?.audio_tokens,\n }),\n ...(usage.completion_tokens_details?.reasoning_tokens !== null && {\n reasoning: usage.completion_tokens_details?.reasoning_tokens,\n }),\n };\n const generationChunk = new ChatGenerationChunk({\n message: new AIMessageChunk({\n content: \"\",\n response_metadata: {\n usage: { ...usage },\n },\n usage_metadata: {\n input_tokens: usage.prompt_tokens,\n output_tokens: usage.completion_tokens,\n total_tokens: usage.total_tokens,\n ...(Object.keys(inputTokenDetails).length > 0 && {\n input_token_details: inputTokenDetails,\n }),\n ...(Object.keys(outputTokenDetails).length > 0 && {\n output_token_details: outputTokenDetails,\n }),\n },\n }),\n text: \"\",\n });\n yield generationChunk;\n await runManager?.handleLLMNewToken(\n generationChunk.text ?? \"\",\n { prompt: 0, completion: 0 },\n undefined,\n undefined,\n undefined,\n { chunk: generationChunk }\n );\n }\n if (options.signal?.aborted) {\n throw new Error(\"AbortError\");\n }\n }\n\n async completionWithRetry(\n request: OpenAIClient.Chat.ChatCompletionCreateParamsStreaming,\n requestOptions?: OpenAIClient.RequestOptions\n ): Promise<AsyncIterable<OpenAIClient.Chat.Completions.ChatCompletionChunk>>;\n\n async completionWithRetry(\n request: OpenAIClient.Chat.ChatCompletionCreateParamsNonStreaming,\n requestOptions?: OpenAIClient.RequestOptions\n ): Promise<OpenAIClient.Chat.Completions.ChatCompletion>;\n\n async completionWithRetry(\n request: OpenAIClient.Chat.ChatCompletionCreateParams,\n requestOptions?: OpenAIClient.RequestOptions\n ): Promise<\n | AsyncIterable<OpenAIClient.Chat.Completions.ChatCompletionChunk>\n | OpenAIClient.Chat.Completions.ChatCompletion\n > {\n // The SDK has its own `maxRetries`; take it for our caller instead so\n // the two retry loops don't multiply.\n const { maxRetries, ...sdkOptions } = requestOptions ?? {};\n const clientOptions = this._getClientOptions(sdkOptions);\n const isParseableFormat =\n request.response_format && request.response_format.type === \"json_schema\";\n return this.caller.callWithOptions({ maxRetries }, async () => {\n try {\n if (isParseableFormat && !request.stream) {\n return await this.client.chat.completions.parse(\n request,\n clientOptions\n );\n } else {\n return await this.client.chat.completions.create(\n request,\n clientOptions\n );\n }\n } catch (e) {\n const error = wrapOpenAIClientError(e);\n throw error;\n }\n });\n }\n\n /**\n * @deprecated\n * This function was hoisted into a publicly accessible function from a\n * different export, but to maintain backwards compatibility with chat models\n * that depend on ChatOpenAICompletions, we'll keep it here as an overridable\n * method. This will be removed in a future release\n */\n protected _convertCompletionsDeltaToBaseMessageChunk(\n // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n delta: Record<string, any>,\n rawResponse: OpenAIClient.Chat.Completions.ChatCompletionChunk,\n defaultRole?: OpenAIClient.Chat.ChatCompletionRole\n ): BaseMessageChunk {\n return convertCompletionsDeltaToBaseMessageChunk({\n delta,\n rawResponse,\n includeRawResponse: this.__includeRawResponse,\n defaultRole,\n });\n }\n\n /**\n * @deprecated\n * This function was hoisted into a publicly accessible function from a\n * different export, but to maintain backwards compatibility with chat models\n * that depend on ChatOpenAICompletions, we'll keep it here as an overridable\n * method. This will be removed in a future release\n */\n protected _convertCompletionsMessageToBaseMessage(\n message: OpenAIClient.ChatCompletionMessage,\n rawResponse: OpenAIClient.ChatCompletion\n ): BaseMessage {\n return convertCompletionsMessageToBaseMessage({\n message,\n rawResponse,\n includeRawResponse: this.__includeRawResponse,\n });\n }\n}\n"],"mappings":";;;;;;;;;;;;;;AAiDA,IAAa,wBAAb,cAGUA,aAAAA,eAA4B;CAGpC,YACE,eACA,WACA;EACA,MAAMC,aAAAA,yBAAyB,eAAe,SAAS,CAAC;CAC1D;;CAGA,iBACE,SACA,OACiC;EACjC,IAAI;EACJ,IAAI,SAAS,WAAW,KAAA,GACtB,SAAS,QAAQ;OACZ,IAAI,KAAK,8BAA8B,KAAA,GAC5C,SAAS,KAAK;EAWhB,IACE,EAFkB,KAAK,aAAa,OAAO,cAG3C,SAAS,iBAAiB,SAAS,iBACnC,WAAW,OAEX,SAAS;EAGX,IAAI,sBAAsB,CAAC;EAC3B,IAAI,SAAS,mBAAmB,KAAA,GAC9B,sBAAsB,EAAE,gBAAgB,QAAQ,eAAe;OAC1D,IAAI,KAAK,gBAAgB,KAAK,aAAa,OAAO,YACvD,sBAAsB,EAAE,gBAAgB,EAAE,eAAe,KAAK,EAAE;EAGlE,MAAM,SAAmD;GACvD,OAAO,KAAK;GACZ,aAAa,KAAK;GAClB,OAAO,KAAK;GACZ,mBAAmB,KAAK;GACxB,kBAAkB,KAAK;GACvB,UAAU,KAAK;GACf,cAAc,KAAK;GACnB,GAAG,KAAK;GACR,YAAY,KAAK;GACjB,MAAM,SAAS,QAAQ,KAAK;GAC5B,MAAM,KAAK;GAEX,QAAQ,KAAK;GACb,WAAW,SAAS;GACpB,eAAe,SAAS;GACxB,OAAO,SAAS,OAAO,SACnB,QAAQ,MAAM,KAAK,SACjB,KAAK,wCAAwC,MAAM,EAAE,OAAO,CAAC,CAC/D,IACA,KAAA;GACJ,aAAaC,cAAAA,yBACX,SAAS,WACX;GACA,iBAAiB,KAAK,mBAAmB,SAAS,eAAe;GACjE,MAAM,SAAS;GACf,GAAG;GACH,qBAAqB,SAAS;GAC9B,GAAI,KAAK,SAAS,SAAS,QACvB,EAAE,OAAO,KAAK,SAAS,SAAS,MAAM,IACtC,CAAC;GACL,GAAI,KAAK,cAAc,SAAS,aAC5B,EAAE,YAAY,KAAK,cAAc,SAAS,WAAW,IACrD,CAAC;GACL,GAAG,KAAK;GACR,kBAAkB,SAAS,kBAAkB,KAAK;GAClD,wBACE,SAAS,wBAAwB,KAAK;GACxC,WAAW,SAAS,aAAa,KAAK;EACxC;EACA,IAAI,SAAS,eAAe,KAAA,GAC1B,OAAO,aAAa,QAAQ;EAE9B,IAAI,KAAK,iBAAiB,KAAA,GACxB,OAAO,eAAe,KAAK;EAE7B,IAAI,SAAS,iBAAiB,KAAA,GAC5B,OAAO,eAAe,QAAQ;EAEhC,MAAM,YAAY,KAAK,oBAAoB,OAAO;EAClD,IAAI,cAAc,KAAA,KAAa,UAAU,WAAW,KAAA,GAClD,OAAO,mBAAmB,UAAU;EAEtC,IAAIC,aAAAA,iBAAiB,OAAO,KAAK,GAC/B,OAAO,wBACL,KAAK,cAAc,KAAK,KAAA,IAAY,KAAK;OAE3C,OAAO,aAAa,KAAK,cAAc,KAAK,KAAA,IAAY,KAAK;EAG/D,OAAO;CACT;CAEA,MAAM,UACJ,UACA,SACA,YACqB;EACrB,QAAQ,QAAQ,eAAe;EAC/B,MAAM,gBAAgB,CAAC;EACvB,MAAM,SAAS,KAAK,iBAAiB,OAAO;EAC5C,MAAM,iBACJC,oBAAAA,0CAA0C;GACxC;GACA,OAAO,KAAK;EACd,CAAC;EAEH,IAAI,OAAO,QAAQ;GACjB,MAAM,SAAS,KAAK,sBAAsB,UAAU,SAAS,UAAU;GACvE,MAAM,cAAmD,CAAC;GAC1D,WAAW,MAAM,SAAS,QAAQ;IAChC,MAAM,QAAQ,oBAAoB;KAChC,GAAG,MAAM;KACT,GAAG,MAAM,QAAQ;IACnB;IACA,MAAM,QACH,MAAM,gBAAoC,cAAc;IAC3D,IAAI,YAAY,WAAW,KAAA,GACzB,YAAY,SAAS;SAErB,YAAY,SAAS,YAAY,MAAM,CAAC,OAAO,KAAK;GAExD;GACA,MAAM,cAAc,OAAO,QAAQ,WAAW,CAAC,CAC5C,MAAM,CAAC,OAAO,CAAC,UAAU,SAAS,MAAM,EAAE,IAAI,SAAS,MAAM,EAAE,CAAC,CAAC,CACjE,KAAK,CAAC,GAAG,WAAW,KAAK;GAE5B,MAAM,EAAE,WAAW,kBAAkB,KAAK,iBAAiB,OAAO;GAKlE,MAAM,mBAAmB,MAAM,KAAK,kCAClC,UACA,WACA,aACF;GACA,MAAM,uBACJ,MAAM,KAAK,6BAA6B,WAAW;GAErD,cAAc,eAAe;GAC7B,cAAc,gBAAgB;GAC9B,cAAc,eAAe,mBAAmB;GAChD,OAAO;IACL;IACA,WAAW,EACT,qBAAqB;KACnB,cAAc,cAAc;KAC5B,kBAAkB,cAAc;KAChC,aAAa,cAAc;IAC7B,EACF;GACF;EACF,OAAO;GACL,MAAM,OAAO,MAAM,KAAK,oBACtB;IACE,GAAG;IACH,QAAQ;IACR,UAAU;GACZ,GACA;IACE,QAAQ,SAAS;IACjB,YAAY,SAAS;IACrB,GAAG,SAAS;GACd,CACF;GAEA,MAAM,EACJ,mBAAmB,kBACnB,eAAe,cACf,cAAc,aACd,uBAAuB,qBACvB,2BAA2B,4BACzB,MAAM,SAAS,CAAC;GAEpB,IAAI,kBACF,cAAc,iBACX,cAAc,iBAAiB,KAAK;GAGzC,IAAI,cACF,cAAc,gBACX,cAAc,gBAAgB,KAAK;GAGxC,IAAI,aACF,cAAc,gBACX,cAAc,gBAAgB,KAAK;GAGxC,IACE,qBAAqB,iBAAiB,QACtC,qBAAqB,kBAAkB,QACvC,qBAAqB,sBAAsB,MAE3C,cAAc,sBAAsB;IAClC,GAAI,qBAAqB,iBAAiB,QAAQ,EAChD,OAAO,qBAAqB,aAC9B;IACA,GAAI,qBAAqB,kBAAkB,QAAQ,EACjD,YAAY,qBAAqB,cACnC;IACA,GAAI,qBAAqB,sBAAsB,QAAQ,EACrD,gBAAgB,qBAAqB,mBACvC;GACF;GAGF,IACE,yBAAyB,iBAAiB,QAC1C,yBAAyB,qBAAqB,MAE9C,cAAc,uBAAuB;IACnC,GAAI,yBAAyB,iBAAiB,QAAQ,EACpD,OAAO,yBAAyB,aAClC;IACA,GAAI,yBAAyB,qBAAqB,QAAQ,EACxD,WAAW,yBAAyB,iBACtC;GACF;GAGF,MAAM,cAAgC,CAAC;GACvC,KAAK,MAAM,QAAQ,MAAM,WAAW,CAAC,GAAG;IAEtC,MAAM,aAA6B;KACjC,MAFW,KAAK,SAAS,WAAW;KAGpC,SAAS,KAAK,wCACZ,KAAK,WAAW,EAAE,MAAM,YAAY,GACpC,IACF;IACF;IACA,WAAW,iBAAiB;KAC1B,GAAI,KAAK,gBAAgB,EAAE,eAAe,KAAK,cAAc,IAAI,CAAC;KAClE,GAAI,KAAK,WAAW,EAAE,UAAU,KAAK,SAAS,IAAI,CAAC;IACrD;IACA,KAAA,GAAA,yBAAA,YAAA,CAAgB,WAAW,OAAO,GAChC,WAAW,QAAQ,iBAAiB;IAItC,WAAW,UAAU,IAAIC,yBAAAA,UACvB,OAAO,YACL,OAAO,QAAQ,WAAW,OAAO,CAAC,CAAC,QAChC,CAAC,SAAS,CAAC,IAAI,WAAW,KAAK,CAClC,CACF,CACF;IACA,YAAY,KAAK,UAAU;GAC7B;GACA,OAAO;IACL;IACA,WAAW,EACT,YAAY;KACV,cAAc,cAAc;KAC5B,kBAAkB,cAAc;KAChC,aAAa,cAAc;IAC7B,EACF;GACF;EACF;CACF;;;;;CAMA,OAAO,uBACL,UACA,SACA,aACsC;EACtC,MAAM,iBACJD,oBAAAA,0CAA0C;GACxC;GACA,OAAO,KAAK;EACd,CAAC;EAEH,MAAM,SAAS;GACb,GAAG,KAAK,iBAAiB,SAAS,EAChC,WAAW,KACb,CAAC;GACD,UAAU;GACV,QAAQ;EACV;EAEA,MAAM,iBAAiB,MAAM,KAAK,oBAAoB,QAAQ,OAAO;EACrE,MAAM,oBAAoB,KAAK,eAAe,QAAQ;EAEtD,MAAM,kBAAkB,iBACtB,QACA,QACA;GACA,WAAW,MAAM,QAAQ,QAAQ;IAC/B,IAAI,QAAQ,SACV;IAEF,MAAM;GACR;EACF;EAEA,QAAA,GAAA,0DAAA,+BAAA,CACE,gBAAgB,gBAAgB,QAAQ,MAAM,GAC9C;GACE,aAAa,qBAAqB;GAClC,UAAU,KAAK;EACjB,CACF;CACF;;CAGA,IAAc,sBAA8B;EAC1C,OAAO;CACT;CAEA,OAAO,sBACL,UACA,SACA,YACqC;EACrC,MAAM,iBACJA,oBAAAA,0CAA0C;GACxC;GACA,OAAO,KAAK;EACd,CAAC;EAEH,MAAM,SAAS;GACb,GAAG,KAAK,iBAAiB,SAAS,EAChC,WAAW,KACb,CAAC;GACD,UAAU;GACV,QAAQ;EACV;EACA,IAAI;EAEJ,MAAM,iBAAiB,MAAM,KAAK,oBAAoB,QAAQ,OAAO;EACrE,IAAI;EACJ,WAAW,MAAM,QAAQ,gBAAgB;GACvC,IAAI,QAAQ,QAAQ,SAClB;GAEF,MAAM,SAAS,MAAM,UAAU;GAC/B,IAAI,KAAK,OACP,QAAQ,KAAK;GAEf,IAAI,CAAC,QACH;GAGF,MAAM,EAAE,UAAU;GAClB,IAAI,CAAC,OACH;GAEF,MAAM,QAAQ,KAAK,2CACjB,OACA,MACA,WACF;GACA,cAAc,MAAM,QAAQ;GAC5B,MAAM,kBAAkB;IACtB,QAAQ,QAAQ,eAAe;IAC/B,YAAY,OAAO,SAAS;GAC9B;GACA,IAAI,OAAO,MAAM,YAAY,UAAU;IACrC,QAAQ,IACN,sFACF;IACA;GACF;GAEA,MAAM,iBAAsC,EAAE,GAAG,gBAAgB;GACjE,IAAI,OAAO,iBAAiB,MAAM;IAChC,eAAe,gBAAgB,OAAO;IAGtC,eAAe,qBAAqB,KAAK;IACzC,eAAe,aAAa,KAAK;IACjC,eAAe,eAAe,KAAK;GACrC;GACA,IAAI,KAAK,UACP,eAAe,WAAW,OAAO;GAEnC,MAAM,kBAAkB,IAAIE,wBAAAA,oBAAoB;IAC9C,SAAS;IACT,MAAM,MAAM;IACZ;GACF,CAAC;GACD,MAAM;GACN,MAAM,YAAY,kBAChB,gBAAgB,QAAQ,IACxB,iBACA,KAAA,GACA,KAAA,GACA,KAAA,GACA,EAAE,OAAO,gBAAgB,CAC3B;EACF;EACA,IAAI,OAAO;GACT,MAAM,oBAAoB;IACxB,GAAI,MAAM,uBAAuB,iBAAiB,QAAQ,EACxD,OAAO,MAAM,uBAAuB,aACtC;IACA,GAAI,MAAM,uBAAuB,kBAAkB,QAAQ,EACzD,YAAY,MAAM,uBAAuB,cAC3C;IACA,GAAI,MAAM,uBAAuB,sBAAsB,QAAQ,EAC7D,gBAAgB,MAAM,uBAAuB,mBAC/C;GACF;GACA,MAAM,qBAAqB;IACzB,GAAI,MAAM,2BAA2B,iBAAiB,QAAQ,EAC5D,OAAO,MAAM,2BAA2B,aAC1C;IACA,GAAI,MAAM,2BAA2B,qBAAqB,QAAQ,EAChE,WAAW,MAAM,2BAA2B,iBAC9C;GACF;GACA,MAAM,kBAAkB,IAAIA,wBAAAA,oBAAoB;IAC9C,SAAS,IAAIC,yBAAAA,eAAe;KAC1B,SAAS;KACT,mBAAmB,EACjB,OAAO,EAAE,GAAG,MAAM,EACpB;KACA,gBAAgB;MACd,cAAc,MAAM;MACpB,eAAe,MAAM;MACrB,cAAc,MAAM;MACpB,GAAI,OAAO,KAAK,iBAAiB,CAAC,CAAC,SAAS,KAAK,EAC/C,qBAAqB,kBACvB;MACA,GAAI,OAAO,KAAK,kBAAkB,CAAC,CAAC,SAAS,KAAK,EAChD,sBAAsB,mBACxB;KACF;IACF,CAAC;IACD,MAAM;GACR,CAAC;GACD,MAAM;GACN,MAAM,YAAY,kBAChB,gBAAgB,QAAQ,IACxB;IAAE,QAAQ;IAAG,YAAY;GAAE,GAC3B,KAAA,GACA,KAAA,GACA,KAAA,GACA,EAAE,OAAO,gBAAgB,CAC3B;EACF;EACA,IAAI,QAAQ,QAAQ,SAClB,MAAM,IAAI,MAAM,YAAY;CAEhC;CAYA,MAAM,oBACJ,SACA,gBAIA;EAGA,MAAM,EAAE,YAAY,GAAG,eAAe,kBAAkB,CAAC;EACzD,MAAM,gBAAgB,KAAK,kBAAkB,UAAU;EACvD,MAAM,oBACJ,QAAQ,mBAAmB,QAAQ,gBAAgB,SAAS;EAC9D,OAAO,KAAK,OAAO,gBAAgB,EAAE,WAAW,GAAG,YAAY;GAC7D,IAAI;IACF,IAAI,qBAAqB,CAAC,QAAQ,QAChC,OAAO,MAAM,KAAK,OAAO,KAAK,YAAY,MACxC,SACA,aACF;SAEA,OAAO,MAAM,KAAK,OAAO,KAAK,YAAY,OACxC,SACA,aACF;GAEJ,SAAS,GAAG;IAEV,MADcC,eAAAA,sBAAsB,CAC1B;GACZ;EACF,CAAC;CACH;;;;;;;;CASA,2CAEE,OACA,aACA,aACkB;EAClB,OAAOC,oBAAAA,0CAA0C;GAC/C;GACA;GACA,oBAAoB,KAAK;GACzB;EACF,CAAC;CACH;;;;;;;;CASA,wCACE,SACA,aACa;EACb,OAAOC,oBAAAA,uCAAuC;GAC5C;GACA;GACA,oBAAoB,KAAK;EAC3B,CAAC;CACH;AACF"}
|
|
1
|
+
{"version":3,"file":"completions.cjs","names":["BaseChatOpenAI","getChatOpenAIModelParams","formatToOpenAIToolChoice","isReasoningModel","convertMessagesToCompletionsMessageParams","isAIMessage","AIMessage","convertOpenAICompletionsStream","ChatGenerationChunk","AIMessageChunk","wrapOpenAIClientError","convertCompletionsDeltaToBaseMessageChunk","convertCompletionsMessageToBaseMessage"],"sources":["../../src/chat_models/completions.ts"],"sourcesContent":["import { OpenAI as OpenAIClient } from \"openai\";\nimport { CallbackManagerForLLMRun } from \"@langchain/core/callbacks/manager\";\nimport type { ChatModelStreamEvent } from \"@langchain/core/language_models/event\";\nimport {\n AIMessage,\n AIMessageChunk,\n type BaseMessage,\n isAIMessage,\n type UsageMetadata,\n type AIMessageFields,\n BaseMessageChunk,\n} from \"@langchain/core/messages\";\nimport {\n ChatGenerationChunk,\n type ChatGeneration,\n type ChatResult,\n} from \"@langchain/core/outputs\";\nimport { NewTokenIndices } from \"@langchain/core/callbacks/base\";\nimport { wrapOpenAIClientError } from \"../utils/client.js\";\nimport {\n OpenAIToolChoice,\n formatToOpenAIToolChoice,\n _convertToOpenAITool,\n} from \"../utils/tools.js\";\nimport { isReasoningModel } from \"../utils/misc.js\";\nimport {\n BaseChatOpenAI,\n BaseChatOpenAICallOptions,\n BaseChatOpenAIFields,\n getChatOpenAIModelParams,\n} from \"./base.js\";\nimport {\n convertCompletionsDeltaToBaseMessageChunk,\n convertCompletionsMessageToBaseMessage,\n convertMessagesToCompletionsMessageParams,\n} from \"../converters/completions.js\";\nimport { convertOpenAICompletionsStream } from \"../utils/stream_events.js\";\n\nexport interface ChatOpenAICompletionsCallOptions extends BaseChatOpenAICallOptions {}\n\ntype ChatCompletionsInvocationParams = Omit<\n OpenAIClient.Chat.Completions.ChatCompletionCreateParams,\n \"messages\"\n>;\n\n/**\n * OpenAI Completions API implementation.\n * @internal\n */\nexport class ChatOpenAICompletions<\n CallOptions extends ChatOpenAICompletionsCallOptions =\n ChatOpenAICompletionsCallOptions,\n> extends BaseChatOpenAI<CallOptions> {\n constructor(model: string, fields?: Omit<BaseChatOpenAIFields, \"model\">);\n constructor(fields?: BaseChatOpenAIFields);\n constructor(\n modelOrFields?: string | BaseChatOpenAIFields,\n fieldsArg?: Omit<BaseChatOpenAIFields, \"model\">\n ) {\n super(getChatOpenAIModelParams(modelOrFields, fieldsArg));\n }\n\n /** @internal */\n override invocationParams(\n options?: this[\"ParsedCallOptions\"],\n extra?: { streaming?: boolean }\n ): ChatCompletionsInvocationParams {\n let strict: boolean | undefined;\n if (options?.strict !== undefined) {\n strict = options.strict;\n } else if (this.supportsStrictToolCalling !== undefined) {\n strict = this.supportsStrictToolCalling;\n }\n\n // A `json_schema` response format goes through the SDK `.parse()` helper,\n // which requires strict function tools — but only on the NON-streaming path\n // (`completionWithRetry` uses `.parse()` only when `!request.stream`).\n // Streaming structured output uses `create()`, which doesn't need strict, so\n // don't force it there. Default to strict for the parse path unless the\n // caller set strict:false. (Re-applied here because the agent core no longer\n // forces strict for every provider.)\n const isStreaming = this.streaming || extra?.streaming;\n if (\n !isStreaming &&\n options?.response_format?.type === \"json_schema\" &&\n strict !== false\n ) {\n strict = true;\n }\n\n let streamOptionsConfig = {};\n if (options?.stream_options !== undefined) {\n streamOptionsConfig = { stream_options: options.stream_options };\n } else if (this.streamUsage && (this.streaming || extra?.streaming)) {\n streamOptionsConfig = { stream_options: { include_usage: true } };\n }\n\n const params: Partial<ChatCompletionsInvocationParams> = {\n model: this.model,\n temperature: this.temperature,\n top_p: this.topP,\n frequency_penalty: this.frequencyPenalty,\n presence_penalty: this.presencePenalty,\n logprobs: this.logprobs,\n top_logprobs: this.topLogprobs,\n n: this.n,\n logit_bias: this.logitBias,\n stop: options?.stop ?? this.stopSequences,\n user: this.user,\n // if include_usage is set or streamUsage then stream must be set to true.\n stream: this.streaming,\n functions: options?.functions,\n function_call: options?.function_call,\n tools: options?.tools?.length\n ? options.tools.map((tool) =>\n this._convertChatOpenAIToolToCompletionsTool(tool, { strict })\n )\n : undefined,\n tool_choice: formatToOpenAIToolChoice(\n options?.tool_choice as OpenAIToolChoice\n ),\n response_format: this._getResponseFormat(options?.response_format),\n seed: options?.seed,\n ...streamOptionsConfig,\n parallel_tool_calls: options?.parallel_tool_calls,\n ...(this.audio || options?.audio\n ? { audio: this.audio || options?.audio }\n : {}),\n ...(this.modalities || options?.modalities\n ? { modalities: this.modalities || options?.modalities }\n : {}),\n ...this.modelKwargs,\n prompt_cache_key: options?.promptCacheKey ?? this.promptCacheKey,\n prompt_cache_retention:\n options?.promptCacheRetention ?? this.promptCacheRetention,\n verbosity: options?.verbosity ?? this.verbosity,\n };\n if (options?.prediction !== undefined) {\n params.prediction = options.prediction;\n }\n if (this.service_tier !== undefined) {\n params.service_tier = this.service_tier;\n }\n if (options?.service_tier !== undefined) {\n params.service_tier = options.service_tier;\n }\n const reasoning = this._getReasoningParams(options);\n if (reasoning !== undefined && reasoning.effort !== undefined) {\n params.reasoning_effort = reasoning.effort;\n }\n if (isReasoningModel(params.model)) {\n params.max_completion_tokens =\n this.maxTokens === -1 ? undefined : this.maxTokens;\n } else {\n params.max_tokens = this.maxTokens === -1 ? undefined : this.maxTokens;\n }\n\n return params as ChatCompletionsInvocationParams;\n }\n\n async _generate(\n messages: BaseMessage[],\n options: this[\"ParsedCallOptions\"],\n runManager?: CallbackManagerForLLMRun\n ): Promise<ChatResult> {\n options.signal?.throwIfAborted();\n const usageMetadata = {} as UsageMetadata;\n const params = this.invocationParams(options);\n const messagesMapped: OpenAIClient.Chat.Completions.ChatCompletionMessageParam[] =\n convertMessagesToCompletionsMessageParams({\n messages,\n model: this.model,\n });\n\n if (params.stream) {\n const stream = this._streamResponseChunks(messages, options, runManager);\n const finalChunks: Record<number, ChatGenerationChunk> = {};\n for await (const chunk of stream) {\n chunk.message.response_metadata = {\n ...chunk.generationInfo,\n ...chunk.message.response_metadata,\n };\n const index =\n (chunk.generationInfo as NewTokenIndices)?.completion ?? 0;\n if (finalChunks[index] === undefined) {\n finalChunks[index] = chunk;\n } else {\n finalChunks[index] = finalChunks[index].concat(chunk);\n }\n }\n const generations = Object.entries(finalChunks)\n .sort(([aKey], [bKey]) => parseInt(aKey, 10) - parseInt(bKey, 10))\n .map(([_, value]) => value);\n\n const { functions, function_call } = this.invocationParams(options);\n\n // OpenAI does not support token usage report under stream mode,\n // fallback to estimation.\n\n const promptTokenUsage = await this._getEstimatedTokenCountFromPrompt(\n messages,\n functions,\n function_call\n );\n const completionTokenUsage =\n await this._getNumTokensFromGenerations(generations);\n\n usageMetadata.input_tokens = promptTokenUsage;\n usageMetadata.output_tokens = completionTokenUsage;\n usageMetadata.total_tokens = promptTokenUsage + completionTokenUsage;\n return {\n generations,\n llmOutput: {\n estimatedTokenUsage: {\n promptTokens: usageMetadata.input_tokens,\n completionTokens: usageMetadata.output_tokens,\n totalTokens: usageMetadata.total_tokens,\n },\n },\n };\n } else {\n const data = await this.completionWithRetry(\n {\n ...params,\n stream: false,\n messages: messagesMapped,\n },\n {\n signal: options?.signal,\n maxRetries: options?.maxRetries,\n ...options?.options,\n }\n );\n\n const {\n completion_tokens: completionTokens,\n prompt_tokens: promptTokens,\n total_tokens: totalTokens,\n prompt_tokens_details: promptTokensDetails,\n completion_tokens_details: completionTokensDetails,\n } = data?.usage ?? {};\n\n if (completionTokens) {\n usageMetadata.output_tokens =\n (usageMetadata.output_tokens ?? 0) + completionTokens;\n }\n\n if (promptTokens) {\n usageMetadata.input_tokens =\n (usageMetadata.input_tokens ?? 0) + promptTokens;\n }\n\n if (totalTokens) {\n usageMetadata.total_tokens =\n (usageMetadata.total_tokens ?? 0) + totalTokens;\n }\n\n if (\n promptTokensDetails?.audio_tokens !== null ||\n promptTokensDetails?.cached_tokens !== null ||\n promptTokensDetails?.cache_write_tokens != null\n ) {\n usageMetadata.input_token_details = {\n ...(promptTokensDetails?.audio_tokens !== null && {\n audio: promptTokensDetails?.audio_tokens,\n }),\n ...(promptTokensDetails?.cached_tokens !== null && {\n cache_read: promptTokensDetails?.cached_tokens,\n }),\n ...(promptTokensDetails?.cache_write_tokens != null && {\n cache_creation: promptTokensDetails?.cache_write_tokens,\n }),\n };\n }\n\n if (\n completionTokensDetails?.audio_tokens !== null ||\n completionTokensDetails?.reasoning_tokens !== null\n ) {\n usageMetadata.output_token_details = {\n ...(completionTokensDetails?.audio_tokens !== null && {\n audio: completionTokensDetails?.audio_tokens,\n }),\n ...(completionTokensDetails?.reasoning_tokens !== null && {\n reasoning: completionTokensDetails?.reasoning_tokens,\n }),\n };\n }\n\n const generations: ChatGeneration[] = [];\n for (const part of data?.choices ?? []) {\n const text = part.message?.content ?? \"\";\n const generation: ChatGeneration = {\n text,\n message: this._convertCompletionsMessageToBaseMessage(\n part.message ?? { role: \"assistant\" },\n data\n ),\n };\n generation.generationInfo = {\n ...(part.finish_reason ? { finish_reason: part.finish_reason } : {}),\n ...(part.logprobs ? { logprobs: part.logprobs } : {}),\n };\n if (isAIMessage(generation.message)) {\n generation.message.usage_metadata = usageMetadata;\n }\n // Fields are not serialized unless passed to the constructor\n // Doing this ensures all fields on the message are serialized\n generation.message = new AIMessage(\n Object.fromEntries(\n Object.entries(generation.message).filter(\n ([key]) => !key.startsWith(\"lc_\")\n )\n ) as AIMessageFields\n );\n generations.push(generation);\n }\n return {\n generations,\n llmOutput: {\n tokenUsage: {\n promptTokens: usageMetadata.input_tokens,\n completionTokens: usageMetadata.output_tokens,\n totalTokens: usageMetadata.total_tokens,\n },\n },\n };\n }\n }\n\n /**\n * Native implementation of the content-block-centric streaming protocol\n * for OpenAI Chat Completions.\n */\n async *_streamChatModelEvents(\n messages: BaseMessage[],\n options: this[\"ParsedCallOptions\"],\n _runManager?: CallbackManagerForLLMRun\n ): AsyncGenerator<ChatModelStreamEvent> {\n const messagesMapped: OpenAIClient.Chat.Completions.ChatCompletionMessageParam[] =\n convertMessagesToCompletionsMessageParams({\n messages,\n model: this.model,\n });\n\n const params = {\n ...this.invocationParams(options, {\n streaming: true,\n }),\n messages: messagesMapped,\n stream: true as const,\n };\n\n const streamIterable = await this.completionWithRetry(params, options);\n const shouldStreamUsage = this.streamUsage ?? options.streamUsage;\n\n const abortableStream = async function* (\n source: AsyncIterable<OpenAIClient.Chat.Completions.ChatCompletionChunk>,\n signal?: AbortSignal\n ) {\n for await (const data of source) {\n if (signal?.aborted) {\n return;\n }\n yield data;\n }\n };\n\n yield* convertOpenAICompletionsStream(\n abortableStream(streamIterable, options.signal),\n {\n streamUsage: shouldStreamUsage ?? true,\n provider: this.streamEventProvider,\n }\n );\n }\n\n /** Provider id used in native stream protocol passthrough events. */\n protected get streamEventProvider(): string {\n return \"openai\";\n }\n\n async *_streamResponseChunks(\n messages: BaseMessage[],\n options: this[\"ParsedCallOptions\"],\n runManager?: CallbackManagerForLLMRun\n ): AsyncGenerator<ChatGenerationChunk> {\n const messagesMapped: OpenAIClient.Chat.Completions.ChatCompletionMessageParam[] =\n convertMessagesToCompletionsMessageParams({\n messages,\n model: this.model,\n });\n\n const params = {\n ...this.invocationParams(options, {\n streaming: true,\n }),\n messages: messagesMapped,\n stream: true as const,\n };\n let defaultRole: OpenAIClient.Chat.ChatCompletionRole | undefined;\n\n const streamIterable = await this.completionWithRetry(params, options);\n let usage: OpenAIClient.Completions.CompletionUsage | undefined;\n for await (const data of streamIterable) {\n if (options.signal?.aborted) {\n return;\n }\n const choice = data?.choices?.[0];\n if (data.usage) {\n usage = data.usage;\n }\n if (!choice) {\n continue;\n }\n\n const { delta } = choice;\n if (!delta) {\n continue;\n }\n const chunk = this._convertCompletionsDeltaToBaseMessageChunk(\n delta,\n data,\n defaultRole\n );\n defaultRole = delta.role ?? defaultRole;\n const newTokenIndices = {\n prompt: options.promptIndex ?? 0,\n completion: choice.index ?? 0,\n };\n if (typeof chunk.content !== \"string\") {\n console.log(\n \"[WARNING]: Received non-string content from OpenAI. This is currently not supported.\"\n );\n continue;\n }\n // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n const generationInfo: Record<string, any> = { ...newTokenIndices };\n if (choice.finish_reason != null) {\n generationInfo.finish_reason = choice.finish_reason;\n // Only include system fingerprint in the last chunk for now\n // to avoid concatenation issues\n generationInfo.system_fingerprint = data.system_fingerprint;\n generationInfo.model_name = data.model;\n generationInfo.service_tier = data.service_tier;\n }\n if (this.logprobs) {\n generationInfo.logprobs = choice.logprobs;\n }\n const generationChunk = new ChatGenerationChunk({\n message: chunk,\n text: chunk.content,\n generationInfo,\n });\n yield generationChunk;\n await runManager?.handleLLMNewToken(\n generationChunk.text ?? \"\",\n newTokenIndices,\n undefined,\n undefined,\n undefined,\n { chunk: generationChunk }\n );\n }\n if (usage) {\n const inputTokenDetails = {\n ...(usage.prompt_tokens_details?.audio_tokens !== null && {\n audio: usage.prompt_tokens_details?.audio_tokens,\n }),\n ...(usage.prompt_tokens_details?.cached_tokens !== null && {\n cache_read: usage.prompt_tokens_details?.cached_tokens,\n }),\n ...(usage.prompt_tokens_details?.cache_write_tokens != null && {\n cache_creation: usage.prompt_tokens_details?.cache_write_tokens,\n }),\n };\n const outputTokenDetails = {\n ...(usage.completion_tokens_details?.audio_tokens !== null && {\n audio: usage.completion_tokens_details?.audio_tokens,\n }),\n ...(usage.completion_tokens_details?.reasoning_tokens !== null && {\n reasoning: usage.completion_tokens_details?.reasoning_tokens,\n }),\n };\n const generationChunk = new ChatGenerationChunk({\n message: new AIMessageChunk({\n content: \"\",\n response_metadata: {\n usage: { ...usage },\n },\n usage_metadata: {\n input_tokens: usage.prompt_tokens,\n output_tokens: usage.completion_tokens,\n total_tokens: usage.total_tokens,\n ...(Object.keys(inputTokenDetails).length > 0 && {\n input_token_details: inputTokenDetails,\n }),\n ...(Object.keys(outputTokenDetails).length > 0 && {\n output_token_details: outputTokenDetails,\n }),\n },\n }),\n text: \"\",\n });\n yield generationChunk;\n await runManager?.handleLLMNewToken(\n generationChunk.text ?? \"\",\n { prompt: 0, completion: 0 },\n undefined,\n undefined,\n undefined,\n { chunk: generationChunk }\n );\n }\n if (options.signal?.aborted) {\n throw new Error(\"AbortError\");\n }\n }\n\n async completionWithRetry(\n request: OpenAIClient.Chat.ChatCompletionCreateParamsStreaming,\n requestOptions?: OpenAIClient.RequestOptions\n ): Promise<AsyncIterable<OpenAIClient.Chat.Completions.ChatCompletionChunk>>;\n\n async completionWithRetry(\n request: OpenAIClient.Chat.ChatCompletionCreateParamsNonStreaming,\n requestOptions?: OpenAIClient.RequestOptions\n ): Promise<OpenAIClient.Chat.Completions.ChatCompletion>;\n\n async completionWithRetry(\n request: OpenAIClient.Chat.ChatCompletionCreateParams,\n requestOptions?: OpenAIClient.RequestOptions\n ): Promise<\n | AsyncIterable<OpenAIClient.Chat.Completions.ChatCompletionChunk>\n | OpenAIClient.Chat.Completions.ChatCompletion\n > {\n // The SDK has its own `maxRetries`; take it for our caller instead so\n // the two retry loops don't multiply.\n const { maxRetries, ...sdkOptions } = requestOptions ?? {};\n const clientOptions = this._getClientOptions(sdkOptions);\n const isParseableFormat =\n request.response_format && request.response_format.type === \"json_schema\";\n return this.caller.callWithOptions({ maxRetries }, async () => {\n try {\n if (isParseableFormat && !request.stream) {\n return await this.client.chat.completions.parse(\n request,\n clientOptions\n );\n } else {\n return await this.client.chat.completions.create(\n request,\n clientOptions\n );\n }\n } catch (e) {\n const error = wrapOpenAIClientError(e);\n throw error;\n }\n });\n }\n\n /**\n * @deprecated\n * This function was hoisted into a publicly accessible function from a\n * different export, but to maintain backwards compatibility with chat models\n * that depend on ChatOpenAICompletions, we'll keep it here as an overridable\n * method. This will be removed in a future release\n */\n protected _convertCompletionsDeltaToBaseMessageChunk(\n // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n delta: Record<string, any>,\n rawResponse: OpenAIClient.Chat.Completions.ChatCompletionChunk,\n defaultRole?: OpenAIClient.Chat.ChatCompletionRole\n ): BaseMessageChunk {\n return convertCompletionsDeltaToBaseMessageChunk({\n delta,\n rawResponse,\n includeRawResponse: this.__includeRawResponse,\n defaultRole,\n });\n }\n\n /**\n * @deprecated\n * This function was hoisted into a publicly accessible function from a\n * different export, but to maintain backwards compatibility with chat models\n * that depend on ChatOpenAICompletions, we'll keep it here as an overridable\n * method. This will be removed in a future release\n */\n protected _convertCompletionsMessageToBaseMessage(\n message: OpenAIClient.ChatCompletionMessage,\n rawResponse: OpenAIClient.ChatCompletion\n ): BaseMessage {\n return convertCompletionsMessageToBaseMessage({\n message,\n rawResponse,\n includeRawResponse: this.__includeRawResponse,\n });\n }\n}\n"],"mappings":";;;;;;;;;;;;;;AAiDA,IAAa,wBAAb,cAGUA,aAAAA,eAA4B;CAGpC,YACE,eACA,WACA;EACA,MAAMC,aAAAA,yBAAyB,eAAe,SAAS,CAAC;CAC1D;;CAGA,iBACE,SACA,OACiC;EACjC,IAAI;EACJ,IAAI,SAAS,WAAW,KAAA,GACtB,SAAS,QAAQ;OACZ,IAAI,KAAK,8BAA8B,KAAA,GAC5C,SAAS,KAAK;EAWhB,IACE,EAFkB,KAAK,aAAa,OAAO,cAG3C,SAAS,iBAAiB,SAAS,iBACnC,WAAW,OAEX,SAAS;EAGX,IAAI,sBAAsB,CAAC;EAC3B,IAAI,SAAS,mBAAmB,KAAA,GAC9B,sBAAsB,EAAE,gBAAgB,QAAQ,eAAe;OAC1D,IAAI,KAAK,gBAAgB,KAAK,aAAa,OAAO,YACvD,sBAAsB,EAAE,gBAAgB,EAAE,eAAe,KAAK,EAAE;EAGlE,MAAM,SAAmD;GACvD,OAAO,KAAK;GACZ,aAAa,KAAK;GAClB,OAAO,KAAK;GACZ,mBAAmB,KAAK;GACxB,kBAAkB,KAAK;GACvB,UAAU,KAAK;GACf,cAAc,KAAK;GACnB,GAAG,KAAK;GACR,YAAY,KAAK;GACjB,MAAM,SAAS,QAAQ,KAAK;GAC5B,MAAM,KAAK;GAEX,QAAQ,KAAK;GACb,WAAW,SAAS;GACpB,eAAe,SAAS;GACxB,OAAO,SAAS,OAAO,SACnB,QAAQ,MAAM,KAAK,SACjB,KAAK,wCAAwC,MAAM,EAAE,OAAO,CAAC,CAC/D,IACA,KAAA;GACJ,aAAaC,cAAAA,yBACX,SAAS,WACX;GACA,iBAAiB,KAAK,mBAAmB,SAAS,eAAe;GACjE,MAAM,SAAS;GACf,GAAG;GACH,qBAAqB,SAAS;GAC9B,GAAI,KAAK,SAAS,SAAS,QACvB,EAAE,OAAO,KAAK,SAAS,SAAS,MAAM,IACtC,CAAC;GACL,GAAI,KAAK,cAAc,SAAS,aAC5B,EAAE,YAAY,KAAK,cAAc,SAAS,WAAW,IACrD,CAAC;GACL,GAAG,KAAK;GACR,kBAAkB,SAAS,kBAAkB,KAAK;GAClD,wBACE,SAAS,wBAAwB,KAAK;GACxC,WAAW,SAAS,aAAa,KAAK;EACxC;EACA,IAAI,SAAS,eAAe,KAAA,GAC1B,OAAO,aAAa,QAAQ;EAE9B,IAAI,KAAK,iBAAiB,KAAA,GACxB,OAAO,eAAe,KAAK;EAE7B,IAAI,SAAS,iBAAiB,KAAA,GAC5B,OAAO,eAAe,QAAQ;EAEhC,MAAM,YAAY,KAAK,oBAAoB,OAAO;EAClD,IAAI,cAAc,KAAA,KAAa,UAAU,WAAW,KAAA,GAClD,OAAO,mBAAmB,UAAU;EAEtC,IAAIC,aAAAA,iBAAiB,OAAO,KAAK,GAC/B,OAAO,wBACL,KAAK,cAAc,KAAK,KAAA,IAAY,KAAK;OAE3C,OAAO,aAAa,KAAK,cAAc,KAAK,KAAA,IAAY,KAAK;EAG/D,OAAO;CACT;CAEA,MAAM,UACJ,UACA,SACA,YACqB;EACrB,QAAQ,QAAQ,eAAe;EAC/B,MAAM,gBAAgB,CAAC;EACvB,MAAM,SAAS,KAAK,iBAAiB,OAAO;EAC5C,MAAM,iBACJC,oBAAAA,0CAA0C;GACxC;GACA,OAAO,KAAK;EACd,CAAC;EAEH,IAAI,OAAO,QAAQ;GACjB,MAAM,SAAS,KAAK,sBAAsB,UAAU,SAAS,UAAU;GACvE,MAAM,cAAmD,CAAC;GAC1D,WAAW,MAAM,SAAS,QAAQ;IAChC,MAAM,QAAQ,oBAAoB;KAChC,GAAG,MAAM;KACT,GAAG,MAAM,QAAQ;IACnB;IACA,MAAM,QACH,MAAM,gBAAoC,cAAc;IAC3D,IAAI,YAAY,WAAW,KAAA,GACzB,YAAY,SAAS;SAErB,YAAY,SAAS,YAAY,MAAM,CAAC,OAAO,KAAK;GAExD;GACA,MAAM,cAAc,OAAO,QAAQ,WAAW,CAAC,CAC5C,MAAM,CAAC,OAAO,CAAC,UAAU,SAAS,MAAM,EAAE,IAAI,SAAS,MAAM,EAAE,CAAC,CAAC,CACjE,KAAK,CAAC,GAAG,WAAW,KAAK;GAE5B,MAAM,EAAE,WAAW,kBAAkB,KAAK,iBAAiB,OAAO;GAKlE,MAAM,mBAAmB,MAAM,KAAK,kCAClC,UACA,WACA,aACF;GACA,MAAM,uBACJ,MAAM,KAAK,6BAA6B,WAAW;GAErD,cAAc,eAAe;GAC7B,cAAc,gBAAgB;GAC9B,cAAc,eAAe,mBAAmB;GAChD,OAAO;IACL;IACA,WAAW,EACT,qBAAqB;KACnB,cAAc,cAAc;KAC5B,kBAAkB,cAAc;KAChC,aAAa,cAAc;IAC7B,EACF;GACF;EACF,OAAO;GACL,MAAM,OAAO,MAAM,KAAK,oBACtB;IACE,GAAG;IACH,QAAQ;IACR,UAAU;GACZ,GACA;IACE,QAAQ,SAAS;IACjB,YAAY,SAAS;IACrB,GAAG,SAAS;GACd,CACF;GAEA,MAAM,EACJ,mBAAmB,kBACnB,eAAe,cACf,cAAc,aACd,uBAAuB,qBACvB,2BAA2B,4BACzB,MAAM,SAAS,CAAC;GAEpB,IAAI,kBACF,cAAc,iBACX,cAAc,iBAAiB,KAAK;GAGzC,IAAI,cACF,cAAc,gBACX,cAAc,gBAAgB,KAAK;GAGxC,IAAI,aACF,cAAc,gBACX,cAAc,gBAAgB,KAAK;GAGxC,IACE,qBAAqB,iBAAiB,QACtC,qBAAqB,kBAAkB,QACvC,qBAAqB,sBAAsB,MAE3C,cAAc,sBAAsB;IAClC,GAAI,qBAAqB,iBAAiB,QAAQ,EAChD,OAAO,qBAAqB,aAC9B;IACA,GAAI,qBAAqB,kBAAkB,QAAQ,EACjD,YAAY,qBAAqB,cACnC;IACA,GAAI,qBAAqB,sBAAsB,QAAQ,EACrD,gBAAgB,qBAAqB,mBACvC;GACF;GAGF,IACE,yBAAyB,iBAAiB,QAC1C,yBAAyB,qBAAqB,MAE9C,cAAc,uBAAuB;IACnC,GAAI,yBAAyB,iBAAiB,QAAQ,EACpD,OAAO,yBAAyB,aAClC;IACA,GAAI,yBAAyB,qBAAqB,QAAQ,EACxD,WAAW,yBAAyB,iBACtC;GACF;GAGF,MAAM,cAAgC,CAAC;GACvC,KAAK,MAAM,QAAQ,MAAM,WAAW,CAAC,GAAG;IAEtC,MAAM,aAA6B;KACjC,MAFW,KAAK,SAAS,WAAW;KAGpC,SAAS,KAAK,wCACZ,KAAK,WAAW,EAAE,MAAM,YAAY,GACpC,IACF;IACF;IACA,WAAW,iBAAiB;KAC1B,GAAI,KAAK,gBAAgB,EAAE,eAAe,KAAK,cAAc,IAAI,CAAC;KAClE,GAAI,KAAK,WAAW,EAAE,UAAU,KAAK,SAAS,IAAI,CAAC;IACrD;IACA,KAAA,GAAIC,yBAAAA,YAAAA,CAAY,WAAW,OAAO,GAChC,WAAW,QAAQ,iBAAiB;IAItC,WAAW,UAAU,IAAIC,yBAAAA,UACvB,OAAO,YACL,OAAO,QAAQ,WAAW,OAAO,CAAC,CAAC,QAChC,CAAC,SAAS,CAAC,IAAI,WAAW,KAAK,CAClC,CACF,CACF;IACA,YAAY,KAAK,UAAU;GAC7B;GACA,OAAO;IACL;IACA,WAAW,EACT,YAAY;KACV,cAAc,cAAc;KAC5B,kBAAkB,cAAc;KAChC,aAAa,cAAc;IAC7B,EACF;GACF;EACF;CACF;;;;;CAMA,OAAO,uBACL,UACA,SACA,aACsC;EACtC,MAAM,iBACJF,oBAAAA,0CAA0C;GACxC;GACA,OAAO,KAAK;EACd,CAAC;EAEH,MAAM,SAAS;GACb,GAAG,KAAK,iBAAiB,SAAS,EAChC,WAAW,KACb,CAAC;GACD,UAAU;GACV,QAAQ;EACV;EAEA,MAAM,iBAAiB,MAAM,KAAK,oBAAoB,QAAQ,OAAO;EACrE,MAAM,oBAAoB,KAAK,eAAe,QAAQ;EAEtD,MAAM,kBAAkB,iBACtB,QACA,QACA;GACA,WAAW,MAAM,QAAQ,QAAQ;IAC/B,IAAI,QAAQ,SACV;IAEF,MAAM;GACR;EACF;EAEA,QAAA,GAAOG,0DAAAA,+BAAAA,CACL,gBAAgB,gBAAgB,QAAQ,MAAM,GAC9C;GACE,aAAa,qBAAqB;GAClC,UAAU,KAAK;EACjB,CACF;CACF;;CAGA,IAAc,sBAA8B;EAC1C,OAAO;CACT;CAEA,OAAO,sBACL,UACA,SACA,YACqC;EACrC,MAAM,iBACJH,oBAAAA,0CAA0C;GACxC;GACA,OAAO,KAAK;EACd,CAAC;EAEH,MAAM,SAAS;GACb,GAAG,KAAK,iBAAiB,SAAS,EAChC,WAAW,KACb,CAAC;GACD,UAAU;GACV,QAAQ;EACV;EACA,IAAI;EAEJ,MAAM,iBAAiB,MAAM,KAAK,oBAAoB,QAAQ,OAAO;EACrE,IAAI;EACJ,WAAW,MAAM,QAAQ,gBAAgB;GACvC,IAAI,QAAQ,QAAQ,SAClB;GAEF,MAAM,SAAS,MAAM,UAAU;GAC/B,IAAI,KAAK,OACP,QAAQ,KAAK;GAEf,IAAI,CAAC,QACH;GAGF,MAAM,EAAE,UAAU;GAClB,IAAI,CAAC,OACH;GAEF,MAAM,QAAQ,KAAK,2CACjB,OACA,MACA,WACF;GACA,cAAc,MAAM,QAAQ;GAC5B,MAAM,kBAAkB;IACtB,QAAQ,QAAQ,eAAe;IAC/B,YAAY,OAAO,SAAS;GAC9B;GACA,IAAI,OAAO,MAAM,YAAY,UAAU;IACrC,QAAQ,IACN,sFACF;IACA;GACF;GAEA,MAAM,iBAAsC,EAAE,GAAG,gBAAgB;GACjE,IAAI,OAAO,iBAAiB,MAAM;IAChC,eAAe,gBAAgB,OAAO;IAGtC,eAAe,qBAAqB,KAAK;IACzC,eAAe,aAAa,KAAK;IACjC,eAAe,eAAe,KAAK;GACrC;GACA,IAAI,KAAK,UACP,eAAe,WAAW,OAAO;GAEnC,MAAM,kBAAkB,IAAII,wBAAAA,oBAAoB;IAC9C,SAAS;IACT,MAAM,MAAM;IACZ;GACF,CAAC;GACD,MAAM;GACN,MAAM,YAAY,kBAChB,gBAAgB,QAAQ,IACxB,iBACA,KAAA,GACA,KAAA,GACA,KAAA,GACA,EAAE,OAAO,gBAAgB,CAC3B;EACF;EACA,IAAI,OAAO;GACT,MAAM,oBAAoB;IACxB,GAAI,MAAM,uBAAuB,iBAAiB,QAAQ,EACxD,OAAO,MAAM,uBAAuB,aACtC;IACA,GAAI,MAAM,uBAAuB,kBAAkB,QAAQ,EACzD,YAAY,MAAM,uBAAuB,cAC3C;IACA,GAAI,MAAM,uBAAuB,sBAAsB,QAAQ,EAC7D,gBAAgB,MAAM,uBAAuB,mBAC/C;GACF;GACA,MAAM,qBAAqB;IACzB,GAAI,MAAM,2BAA2B,iBAAiB,QAAQ,EAC5D,OAAO,MAAM,2BAA2B,aAC1C;IACA,GAAI,MAAM,2BAA2B,qBAAqB,QAAQ,EAChE,WAAW,MAAM,2BAA2B,iBAC9C;GACF;GACA,MAAM,kBAAkB,IAAIA,wBAAAA,oBAAoB;IAC9C,SAAS,IAAIC,yBAAAA,eAAe;KAC1B,SAAS;KACT,mBAAmB,EACjB,OAAO,EAAE,GAAG,MAAM,EACpB;KACA,gBAAgB;MACd,cAAc,MAAM;MACpB,eAAe,MAAM;MACrB,cAAc,MAAM;MACpB,GAAI,OAAO,KAAK,iBAAiB,CAAC,CAAC,SAAS,KAAK,EAC/C,qBAAqB,kBACvB;MACA,GAAI,OAAO,KAAK,kBAAkB,CAAC,CAAC,SAAS,KAAK,EAChD,sBAAsB,mBACxB;KACF;IACF,CAAC;IACD,MAAM;GACR,CAAC;GACD,MAAM;GACN,MAAM,YAAY,kBAChB,gBAAgB,QAAQ,IACxB;IAAE,QAAQ;IAAG,YAAY;GAAE,GAC3B,KAAA,GACA,KAAA,GACA,KAAA,GACA,EAAE,OAAO,gBAAgB,CAC3B;EACF;EACA,IAAI,QAAQ,QAAQ,SAClB,MAAM,IAAI,MAAM,YAAY;CAEhC;CAYA,MAAM,oBACJ,SACA,gBAIA;EAGA,MAAM,EAAE,YAAY,GAAG,eAAe,kBAAkB,CAAC;EACzD,MAAM,gBAAgB,KAAK,kBAAkB,UAAU;EACvD,MAAM,oBACJ,QAAQ,mBAAmB,QAAQ,gBAAgB,SAAS;EAC9D,OAAO,KAAK,OAAO,gBAAgB,EAAE,WAAW,GAAG,YAAY;GAC7D,IAAI;IACF,IAAI,qBAAqB,CAAC,QAAQ,QAChC,OAAO,MAAM,KAAK,OAAO,KAAK,YAAY,MACxC,SACA,aACF;SAEA,OAAO,MAAM,KAAK,OAAO,KAAK,YAAY,OACxC,SACA,aACF;GAEJ,SAAS,GAAG;IAEV,MADcC,eAAAA,sBAAsB,CAC1B;GACZ;EACF,CAAC;CACH;;;;;;;;CASA,2CAEE,OACA,aACA,aACkB;EAClB,OAAOC,oBAAAA,0CAA0C;GAC/C;GACA;GACA,oBAAoB,KAAK;GACzB;EACF,CAAC;CACH;;;;;;;;CASA,wCACE,SACA,aACa;EACb,OAAOC,oBAAAA,uCAAuC;GAC5C;GACA;GACA,oBAAoB,KAAK;EAC3B,CAAC;CACH;AACF"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"responses.cjs","names":["BaseChatOpenAI","getChatOpenAIModelParams","isBuiltInToolChoice","formatToOpenAIToolChoice","convertMessagesToResponsesInput","convertResponsesMessageToAIMessage","convertOpenAIResponsesStream","convertResponsesDeltaToChatGenerationChunk","wrapOpenAIClientError","isBuiltInTool","isCustomTool","isOpenAICustomTool","convertCompletionsCustomTool"],"sources":["../../src/chat_models/responses.ts"],"sourcesContent":["import { OpenAI as OpenAIClient } from \"openai\";\nimport { CallbackManagerForLLMRun } from \"@langchain/core/callbacks/manager\";\nimport type { ChatModelStreamEvent } from \"@langchain/core/language_models/event\";\nimport { AIMessage, type BaseMessage } from \"@langchain/core/messages\";\nimport { ChatGenerationChunk, type ChatResult } from \"@langchain/core/outputs\";\nimport { isOpenAITool as isOpenAIFunctionTool } from \"@langchain/core/language_models/base\";\nimport { wrapOpenAIClientError } from \"../utils/client.js\";\nimport {\n ChatOpenAIToolType,\n convertCompletionsCustomTool,\n formatToOpenAIToolChoice,\n isBuiltInTool,\n isBuiltInToolChoice,\n isCustomTool,\n isOpenAICustomTool,\n ResponsesTool,\n} from \"../utils/tools.js\";\nimport {\n BaseChatOpenAI,\n BaseChatOpenAICallOptions,\n BaseChatOpenAIFields,\n getChatOpenAIModelParams,\n} from \"./base.js\";\nimport {\n convertMessagesToResponsesInput,\n convertResponsesDeltaToChatGenerationChunk,\n convertResponsesMessageToAIMessage,\n} from \"../converters/responses.js\";\nimport { OpenAIVerbosityParam } from \"../types.js\";\nimport { convertOpenAIResponsesStream } from \"../utils/responses_stream_events.js\";\n\nexport interface ChatOpenAIResponsesCallOptions extends BaseChatOpenAICallOptions {\n /**\n * Configuration options for a text response from the model. Can be plain text or\n * structured JSON data.\n */\n text?: OpenAIClient.Responses.ResponseCreateParams[\"text\"];\n\n /**\n * The truncation strategy to use for the model response.\n */\n truncation?: OpenAIClient.Responses.ResponseCreateParams[\"truncation\"];\n\n /**\n * Specify additional output data to include in the model response.\n */\n include?: OpenAIClient.Responses.ResponseCreateParams[\"include\"];\n\n /**\n * The unique ID of the previous response to the model. Use this to create multi-turn\n * conversations.\n */\n previous_response_id?: OpenAIClient.Responses.ResponseCreateParams[\"previous_response_id\"];\n\n /**\n * The verbosity of the model's response.\n */\n verbosity?: OpenAIVerbosityParam;\n}\n\nexport type ChatResponsesInvocationParams = Omit<\n OpenAIClient.Responses.ResponseCreateParams,\n \"input\"\n>;\n\n/**\n * OpenAI Responses API implementation.\n *\n * Will be exported in a later version of @langchain/openai.\n *\n * @internal\n */\nexport class ChatOpenAIResponses<\n CallOptions extends ChatOpenAIResponsesCallOptions =\n ChatOpenAIResponsesCallOptions,\n> extends BaseChatOpenAI<CallOptions> {\n constructor(model: string, fields?: Omit<BaseChatOpenAIFields, \"model\">);\n constructor(fields?: BaseChatOpenAIFields);\n constructor(\n modelOrFields?: string | BaseChatOpenAIFields,\n fieldsArg?: Omit<BaseChatOpenAIFields, \"model\">\n ) {\n super(getChatOpenAIModelParams(modelOrFields, fieldsArg));\n }\n\n override invocationParams(\n options?: this[\"ParsedCallOptions\"]\n ): ChatResponsesInvocationParams {\n let strict: boolean | undefined;\n if (options?.strict !== undefined) {\n strict = options.strict;\n }\n if (strict === undefined && this.supportsStrictToolCalling !== undefined) {\n strict = this.supportsStrictToolCalling;\n }\n\n const params: ChatResponsesInvocationParams = {\n model: this.model,\n temperature: this.temperature,\n top_p: this.topP,\n user: this.user,\n service_tier: this.service_tier,\n\n // if include_usage is set or streamUsage then stream must be set to true.\n stream: this.streaming,\n previous_response_id: options?.previous_response_id,\n truncation: options?.truncation,\n include: options?.include,\n tools: options?.tools?.length\n ? this._reduceChatOpenAITools(options.tools, {\n stream: this.streaming,\n strict,\n })\n : undefined,\n tool_choice: isBuiltInToolChoice(options?.tool_choice)\n ? options?.tool_choice\n : (() => {\n const formatted = formatToOpenAIToolChoice(options?.tool_choice);\n if (typeof formatted === \"object\" && \"type\" in formatted) {\n if (formatted.type === \"function\") {\n return { type: \"function\", name: formatted.function.name };\n } else if (formatted.type === \"allowed_tools\") {\n return {\n type: \"allowed_tools\",\n mode: formatted.allowed_tools.mode,\n tools: formatted.allowed_tools.tools,\n };\n } else if (formatted.type === \"custom\") {\n return {\n type: \"custom\",\n name: formatted.custom.name,\n };\n }\n }\n return undefined;\n })(),\n text: (() => {\n if (options?.text) return options.text;\n const format = this._getResponseFormat(options?.response_format);\n if (format?.type === \"json_schema\") {\n if (format.json_schema.schema != null) {\n return {\n format: {\n type: \"json_schema\",\n schema: format.json_schema.schema,\n description: format.json_schema.description,\n name: format.json_schema.name,\n strict: format.json_schema.strict,\n },\n verbosity: options?.verbosity,\n };\n }\n return undefined;\n }\n return { format, verbosity: options?.verbosity };\n })(),\n parallel_tool_calls: options?.parallel_tool_calls,\n max_output_tokens: this.maxTokens === -1 ? undefined : this.maxTokens,\n prompt_cache_key: options?.promptCacheKey ?? this.promptCacheKey,\n prompt_cache_retention:\n options?.promptCacheRetention ?? this.promptCacheRetention,\n ...(this.zdrEnabled ? { store: false } : {}),\n ...this.modelKwargs,\n };\n\n const reasoning = this._getReasoningParams(options);\n\n if (reasoning !== undefined) {\n params.reasoning = reasoning;\n }\n\n return params;\n }\n\n async _generate(\n messages: BaseMessage[],\n options: this[\"ParsedCallOptions\"],\n runManager?: CallbackManagerForLLMRun\n ): Promise<ChatResult> {\n options.signal?.throwIfAborted();\n const invocationParams = this.invocationParams(options);\n if (invocationParams.stream) {\n const stream = this._streamResponseChunks(messages, options, runManager);\n let finalChunk: ChatGenerationChunk | undefined;\n for await (const chunk of stream) {\n chunk.message.response_metadata = {\n ...chunk.generationInfo,\n ...chunk.message.response_metadata,\n };\n finalChunk = finalChunk?.concat(chunk) ?? chunk;\n }\n\n return {\n generations: finalChunk ? [finalChunk] : [],\n llmOutput: {\n estimatedTokenUsage: (finalChunk?.message as AIMessage | undefined)\n ?.usage_metadata,\n },\n };\n } else {\n const data = await this.completionWithRetry(\n {\n input: convertMessagesToResponsesInput({\n messages,\n zdrEnabled: this.zdrEnabled ?? false,\n model: this.model,\n }),\n ...invocationParams,\n stream: false,\n },\n {\n signal: options?.signal,\n maxRetries: options?.maxRetries,\n ...options?.options,\n }\n );\n\n return {\n generations: [\n {\n text: data.output_text,\n message: convertResponsesMessageToAIMessage(data),\n },\n ],\n llmOutput: {\n id: data.id,\n estimatedTokenUsage: data.usage\n ? {\n promptTokens: data.usage.input_tokens,\n completionTokens: data.usage.output_tokens,\n totalTokens: data.usage.total_tokens,\n }\n : undefined,\n },\n };\n }\n }\n\n async *_streamChatModelEvents(\n messages: BaseMessage[],\n options: this[\"ParsedCallOptions\"],\n _runManager?: CallbackManagerForLLMRun\n ): AsyncGenerator<ChatModelStreamEvent> {\n const streamIterable = await this.completionWithRetry(\n {\n ...this.invocationParams(options),\n input: convertMessagesToResponsesInput({\n messages,\n zdrEnabled: this.zdrEnabled ?? false,\n model: this.model,\n }),\n stream: true,\n },\n options\n );\n\n const shouldStreamUsage = this.streamUsage ?? options.streamUsage;\n\n const abortableStream = async function* (\n source: AsyncIterable<OpenAIClient.Responses.ResponseStreamEvent>,\n signal?: AbortSignal\n ) {\n for await (const data of source) {\n if (signal?.aborted) {\n return;\n }\n yield data;\n }\n };\n\n yield* convertOpenAIResponsesStream(\n abortableStream(streamIterable, options.signal),\n {\n streamUsage: shouldStreamUsage ?? true,\n provider: this.streamEventProvider,\n }\n );\n }\n\n /** Provider id used in native stream protocol passthrough events. */\n protected get streamEventProvider(): string {\n return \"openai\";\n }\n\n async *_streamResponseChunks(\n messages: BaseMessage[],\n options: this[\"ParsedCallOptions\"],\n runManager?: CallbackManagerForLLMRun\n ): AsyncGenerator<ChatGenerationChunk> {\n const streamIterable = await this.completionWithRetry(\n {\n ...this.invocationParams(options),\n input: convertMessagesToResponsesInput({\n messages,\n zdrEnabled: this.zdrEnabled ?? false,\n model: this.model,\n }),\n stream: true,\n },\n options\n );\n\n try {\n for await (const data of streamIterable) {\n if (options.signal?.aborted) {\n return;\n }\n const chunk = convertResponsesDeltaToChatGenerationChunk(data);\n if (chunk == null) continue;\n yield chunk;\n await runManager?.handleLLMNewToken(\n chunk.text || \"\",\n {\n prompt: options.promptIndex ?? 0,\n completion: 0,\n },\n undefined,\n undefined,\n undefined,\n { chunk }\n );\n }\n } catch (e) {\n const error = wrapOpenAIClientError(e);\n throw error;\n }\n }\n\n /**\n * Calls the Responses API with retry logic in case of failures.\n * @param request The request to send to the OpenAI API.\n * @param options Optional configuration for the API call.\n * @returns The response from the OpenAI API.\n */\n async completionWithRetry(\n request: OpenAIClient.Responses.ResponseCreateParamsStreaming,\n requestOptions?: OpenAIClient.RequestOptions\n ): Promise<AsyncIterable<OpenAIClient.Responses.ResponseStreamEvent>>;\n\n async completionWithRetry(\n request: OpenAIClient.Responses.ResponseCreateParamsNonStreaming,\n requestOptions?: OpenAIClient.RequestOptions\n ): Promise<OpenAIClient.Responses.Response>;\n\n async completionWithRetry(\n request: OpenAIClient.Responses.ResponseCreateParams,\n requestOptions?: OpenAIClient.RequestOptions\n ): Promise<\n | AsyncIterable<OpenAIClient.Responses.ResponseStreamEvent>\n | OpenAIClient.Responses.Response\n > {\n // The SDK has its own `maxRetries`; take it for our caller instead so\n // the two retry loops don't multiply.\n const { maxRetries, ...sdkOptions } = requestOptions ?? {};\n const clientOptions = this._getClientOptions(sdkOptions);\n return this.caller.callWithOptions({ maxRetries }, async () => {\n try {\n // use parse if dealing with json_schema\n if (request.text?.format?.type === \"json_schema\" && !request.stream) {\n return await this.client.responses.parse(request, clientOptions);\n }\n return await this.client.responses.create(request, clientOptions);\n } catch (e) {\n const error = wrapOpenAIClientError(e);\n throw error;\n }\n });\n }\n\n /** @internal */\n protected _reduceChatOpenAITools(\n tools: ChatOpenAIToolType[],\n fields: { stream?: boolean; strict?: boolean }\n ): ResponsesTool[] {\n const reducedTools: ResponsesTool[] = [];\n for (const tool of tools) {\n if (isBuiltInTool(tool)) {\n if (tool.type === \"image_generation\" && fields?.stream) {\n // OpenAI sends a 400 error if partial_images is not set and we want to stream.\n // We also set it to 1 since we don't support partial images yet.\n tool.partial_images = 1;\n }\n reducedTools.push(tool);\n } else if (isCustomTool(tool)) {\n const customToolData = tool.metadata.customTool;\n reducedTools.push({\n type: \"custom\",\n name: customToolData.name,\n description: customToolData.description,\n format: customToolData.format,\n } as ResponsesTool);\n } else if (isOpenAIFunctionTool(tool)) {\n const extra: Record<string, unknown> = {};\n for (const [k, v] of Object.entries(tool)) {\n if (k !== \"type\" && k !== \"function\") {\n extra[k] = v;\n }\n }\n reducedTools.push({\n type: \"function\",\n name: tool.function.name,\n parameters: tool.function.parameters,\n description: tool.function.description,\n strict: fields?.strict ?? null,\n ...extra,\n });\n } else if (isOpenAICustomTool(tool)) {\n reducedTools.push(convertCompletionsCustomTool(tool));\n }\n }\n return reducedTools;\n }\n}\n"],"mappings":";;;;;;;;;;;;;;AAwEA,IAAa,sBAAb,cAGUA,aAAAA,eAA4B;CAGpC,YACE,eACA,WACA;EACA,MAAMC,aAAAA,yBAAyB,eAAe,SAAS,CAAC;CAC1D;CAEA,iBACE,SAC+B;EAC/B,IAAI;EACJ,IAAI,SAAS,WAAW,KAAA,GACtB,SAAS,QAAQ;EAEnB,IAAI,WAAW,KAAA,KAAa,KAAK,8BAA8B,KAAA,GAC7D,SAAS,KAAK;EAGhB,MAAM,SAAwC;GAC5C,OAAO,KAAK;GACZ,aAAa,KAAK;GAClB,OAAO,KAAK;GACZ,MAAM,KAAK;GACX,cAAc,KAAK;GAGnB,QAAQ,KAAK;GACb,sBAAsB,SAAS;GAC/B,YAAY,SAAS;GACrB,SAAS,SAAS;GAClB,OAAO,SAAS,OAAO,SACnB,KAAK,uBAAuB,QAAQ,OAAO;IACzC,QAAQ,KAAK;IACb;GACF,CAAC,IACD,KAAA;GACJ,aAAaC,cAAAA,oBAAoB,SAAS,WAAW,IACjD,SAAS,qBACF;IACL,MAAM,YAAYC,cAAAA,yBAAyB,SAAS,WAAW;IAC/D,IAAI,OAAO,cAAc,YAAY,UAAU,WACzC;SAAA,UAAU,SAAS,YACrB,OAAO;MAAE,MAAM;MAAY,MAAM,UAAU,SAAS;KAAK;UACpD,IAAI,UAAU,SAAS,iBAC5B,OAAO;MACL,MAAM;MACN,MAAM,UAAU,cAAc;MAC9B,OAAO,UAAU,cAAc;KACjC;UACK,IAAI,UAAU,SAAS,UAC5B,OAAO;MACL,MAAM;MACN,MAAM,UAAU,OAAO;KACzB;IAAA;GAIN,EAAA,CAAG;GACP,aAAa;IACX,IAAI,SAAS,MAAM,OAAO,QAAQ;IAClC,MAAM,SAAS,KAAK,mBAAmB,SAAS,eAAe;IAC/D,IAAI,QAAQ,SAAS,eAAe;KAClC,IAAI,OAAO,YAAY,UAAU,MAC/B,OAAO;MACL,QAAQ;OACN,MAAM;OACN,QAAQ,OAAO,YAAY;OAC3B,aAAa,OAAO,YAAY;OAChC,MAAM,OAAO,YAAY;OACzB,QAAQ,OAAO,YAAY;MAC7B;MACA,WAAW,SAAS;KACtB;KAEF;IACF;IACA,OAAO;KAAE;KAAQ,WAAW,SAAS;IAAU;GACjD,EAAA,CAAG;GACH,qBAAqB,SAAS;GAC9B,mBAAmB,KAAK,cAAc,KAAK,KAAA,IAAY,KAAK;GAC5D,kBAAkB,SAAS,kBAAkB,KAAK;GAClD,wBACE,SAAS,wBAAwB,KAAK;GACxC,GAAI,KAAK,aAAa,EAAE,OAAO,MAAM,IAAI,CAAC;GAC1C,GAAG,KAAK;EACV;EAEA,MAAM,YAAY,KAAK,oBAAoB,OAAO;EAElD,IAAI,cAAc,KAAA,GAChB,OAAO,YAAY;EAGrB,OAAO;CACT;CAEA,MAAM,UACJ,UACA,SACA,YACqB;EACrB,QAAQ,QAAQ,eAAe;EAC/B,MAAM,mBAAmB,KAAK,iBAAiB,OAAO;EACtD,IAAI,iBAAiB,QAAQ;GAC3B,MAAM,SAAS,KAAK,sBAAsB,UAAU,SAAS,UAAU;GACvE,IAAI;GACJ,WAAW,MAAM,SAAS,QAAQ;IAChC,MAAM,QAAQ,oBAAoB;KAChC,GAAG,MAAM;KACT,GAAG,MAAM,QAAQ;IACnB;IACA,aAAa,YAAY,OAAO,KAAK,KAAK;GAC5C;GAEA,OAAO;IACL,aAAa,aAAa,CAAC,UAAU,IAAI,CAAC;IAC1C,WAAW,EACT,sBAAsB,YAAY,QAAA,EAC9B,eACN;GACF;EACF,OAAO;GACL,MAAM,OAAO,MAAM,KAAK,oBACtB;IACE,OAAOC,kBAAAA,gCAAgC;KACrC;KACA,YAAY,KAAK,cAAc;KAC/B,OAAO,KAAK;IACd,CAAC;IACD,GAAG;IACH,QAAQ;GACV,GACA;IACE,QAAQ,SAAS;IACjB,YAAY,SAAS;IACrB,GAAG,SAAS;GACd,CACF;GAEA,OAAO;IACL,aAAa,CACX;KACE,MAAM,KAAK;KACX,SAASC,kBAAAA,mCAAmC,IAAI;IAClD,CACF;IACA,WAAW;KACT,IAAI,KAAK;KACT,qBAAqB,KAAK,QACtB;MACE,cAAc,KAAK,MAAM;MACzB,kBAAkB,KAAK,MAAM;MAC7B,aAAa,KAAK,MAAM;KAC1B,IACA,KAAA;IACN;GACF;EACF;CACF;CAEA,OAAO,uBACL,UACA,SACA,aACsC;EACtC,MAAM,iBAAiB,MAAM,KAAK,oBAChC;GACE,GAAG,KAAK,iBAAiB,OAAO;GAChC,OAAOD,kBAAAA,gCAAgC;IACrC;IACA,YAAY,KAAK,cAAc;IAC/B,OAAO,KAAK;GACd,CAAC;GACD,QAAQ;EACV,GACA,OACF;EAEA,MAAM,oBAAoB,KAAK,eAAe,QAAQ;EAEtD,MAAM,kBAAkB,iBACtB,QACA,QACA;GACA,WAAW,MAAM,QAAQ,QAAQ;IAC/B,IAAI,QAAQ,SACV;IAEF,MAAM;GACR;EACF;EAEA,OAAOE,gCAAAA,6BACL,gBAAgB,gBAAgB,QAAQ,MAAM,GAC9C;GACE,aAAa,qBAAqB;GAClC,UAAU,KAAK;EACjB,CACF;CACF;;CAGA,IAAc,sBAA8B;EAC1C,OAAO;CACT;CAEA,OAAO,sBACL,UACA,SACA,YACqC;EACrC,MAAM,iBAAiB,MAAM,KAAK,oBAChC;GACE,GAAG,KAAK,iBAAiB,OAAO;GAChC,OAAOF,kBAAAA,gCAAgC;IACrC;IACA,YAAY,KAAK,cAAc;IAC/B,OAAO,KAAK;GACd,CAAC;GACD,QAAQ;EACV,GACA,OACF;EAEA,IAAI;GACF,WAAW,MAAM,QAAQ,gBAAgB;IACvC,IAAI,QAAQ,QAAQ,SAClB;IAEF,MAAM,QAAQG,kBAAAA,2CAA2C,IAAI;IAC7D,IAAI,SAAS,MAAM;IACnB,MAAM;IACN,MAAM,YAAY,kBAChB,MAAM,QAAQ,IACd;KACE,QAAQ,QAAQ,eAAe;KAC/B,YAAY;IACd,GACA,KAAA,GACA,KAAA,GACA,KAAA,GACA,EAAE,MAAM,CACV;GACF;EACF,SAAS,GAAG;GAEV,MADcC,eAAAA,sBAAsB,CAC1B;EACZ;CACF;CAkBA,MAAM,oBACJ,SACA,gBAIA;EAGA,MAAM,EAAE,YAAY,GAAG,eAAe,kBAAkB,CAAC;EACzD,MAAM,gBAAgB,KAAK,kBAAkB,UAAU;EACvD,OAAO,KAAK,OAAO,gBAAgB,EAAE,WAAW,GAAG,YAAY;GAC7D,IAAI;IAEF,IAAI,QAAQ,MAAM,QAAQ,SAAS,iBAAiB,CAAC,QAAQ,QAC3D,OAAO,MAAM,KAAK,OAAO,UAAU,MAAM,SAAS,aAAa;IAEjE,OAAO,MAAM,KAAK,OAAO,UAAU,OAAO,SAAS,aAAa;GAClE,SAAS,GAAG;IAEV,MADcA,eAAAA,sBAAsB,CAC1B;GACZ;EACF,CAAC;CACH;;CAGA,uBACE,OACA,QACiB;EACjB,MAAM,eAAgC,CAAC;EACvC,KAAK,MAAM,QAAQ,OACjB,IAAIC,cAAAA,cAAc,IAAI,GAAG;GACvB,IAAI,KAAK,SAAS,sBAAsB,QAAQ,QAG9C,KAAK,iBAAiB;GAExB,aAAa,KAAK,IAAI;EACxB,OAAO,IAAIC,cAAAA,aAAa,IAAI,GAAG;GAC7B,MAAM,iBAAiB,KAAK,SAAS;GACrC,aAAa,KAAK;IAChB,MAAM;IACN,MAAM,eAAe;IACrB,aAAa,eAAe;IAC5B,QAAQ,eAAe;GACzB,CAAkB;EACpB,OAAO,KAAA,GAAA,qCAAA,aAAA,CAAyB,IAAI,GAAG;GACrC,MAAM,QAAiC,CAAC;GACxC,KAAK,MAAM,CAAC,GAAG,MAAM,OAAO,QAAQ,IAAI,GACtC,IAAI,MAAM,UAAU,MAAM,YACxB,MAAM,KAAK;GAGf,aAAa,KAAK;IAChB,MAAM;IACN,MAAM,KAAK,SAAS;IACpB,YAAY,KAAK,SAAS;IAC1B,aAAa,KAAK,SAAS;IAC3B,QAAQ,QAAQ,UAAU;IAC1B,GAAG;GACL,CAAC;EACH,OAAO,IAAIC,cAAAA,mBAAmB,IAAI,GAChC,aAAa,KAAKC,cAAAA,6BAA6B,IAAI,CAAC;EAGxD,OAAO;CACT;AACF"}
|
|
1
|
+
{"version":3,"file":"responses.cjs","names":["BaseChatOpenAI","getChatOpenAIModelParams","isBuiltInToolChoice","formatToOpenAIToolChoice","convertMessagesToResponsesInput","convertResponsesMessageToAIMessage","convertOpenAIResponsesStream","convertResponsesDeltaToChatGenerationChunk","wrapOpenAIClientError","isBuiltInTool","isCustomTool","isOpenAIFunctionTool","isOpenAICustomTool","convertCompletionsCustomTool"],"sources":["../../src/chat_models/responses.ts"],"sourcesContent":["import { OpenAI as OpenAIClient } from \"openai\";\nimport { CallbackManagerForLLMRun } from \"@langchain/core/callbacks/manager\";\nimport type { ChatModelStreamEvent } from \"@langchain/core/language_models/event\";\nimport { AIMessage, type BaseMessage } from \"@langchain/core/messages\";\nimport { ChatGenerationChunk, type ChatResult } from \"@langchain/core/outputs\";\nimport { isOpenAITool as isOpenAIFunctionTool } from \"@langchain/core/language_models/base\";\nimport { wrapOpenAIClientError } from \"../utils/client.js\";\nimport {\n ChatOpenAIToolType,\n convertCompletionsCustomTool,\n formatToOpenAIToolChoice,\n isBuiltInTool,\n isBuiltInToolChoice,\n isCustomTool,\n isOpenAICustomTool,\n ResponsesTool,\n} from \"../utils/tools.js\";\nimport {\n BaseChatOpenAI,\n BaseChatOpenAICallOptions,\n BaseChatOpenAIFields,\n getChatOpenAIModelParams,\n} from \"./base.js\";\nimport {\n convertMessagesToResponsesInput,\n convertResponsesDeltaToChatGenerationChunk,\n convertResponsesMessageToAIMessage,\n} from \"../converters/responses.js\";\nimport { OpenAIVerbosityParam } from \"../types.js\";\nimport { convertOpenAIResponsesStream } from \"../utils/responses_stream_events.js\";\n\nexport interface ChatOpenAIResponsesCallOptions extends BaseChatOpenAICallOptions {\n /**\n * Configuration options for a text response from the model. Can be plain text or\n * structured JSON data.\n */\n text?: OpenAIClient.Responses.ResponseCreateParams[\"text\"];\n\n /**\n * The truncation strategy to use for the model response.\n */\n truncation?: OpenAIClient.Responses.ResponseCreateParams[\"truncation\"];\n\n /**\n * Specify additional output data to include in the model response.\n */\n include?: OpenAIClient.Responses.ResponseCreateParams[\"include\"];\n\n /**\n * The unique ID of the previous response to the model. Use this to create multi-turn\n * conversations.\n */\n previous_response_id?: OpenAIClient.Responses.ResponseCreateParams[\"previous_response_id\"];\n\n /**\n * The verbosity of the model's response.\n */\n verbosity?: OpenAIVerbosityParam;\n}\n\nexport type ChatResponsesInvocationParams = Omit<\n OpenAIClient.Responses.ResponseCreateParams,\n \"input\"\n>;\n\n/**\n * OpenAI Responses API implementation.\n *\n * Will be exported in a later version of @langchain/openai.\n *\n * @internal\n */\nexport class ChatOpenAIResponses<\n CallOptions extends ChatOpenAIResponsesCallOptions =\n ChatOpenAIResponsesCallOptions,\n> extends BaseChatOpenAI<CallOptions> {\n constructor(model: string, fields?: Omit<BaseChatOpenAIFields, \"model\">);\n constructor(fields?: BaseChatOpenAIFields);\n constructor(\n modelOrFields?: string | BaseChatOpenAIFields,\n fieldsArg?: Omit<BaseChatOpenAIFields, \"model\">\n ) {\n super(getChatOpenAIModelParams(modelOrFields, fieldsArg));\n }\n\n override invocationParams(\n options?: this[\"ParsedCallOptions\"]\n ): ChatResponsesInvocationParams {\n let strict: boolean | undefined;\n if (options?.strict !== undefined) {\n strict = options.strict;\n }\n if (strict === undefined && this.supportsStrictToolCalling !== undefined) {\n strict = this.supportsStrictToolCalling;\n }\n\n const params: ChatResponsesInvocationParams = {\n model: this.model,\n temperature: this.temperature,\n top_p: this.topP,\n user: this.user,\n service_tier: this.service_tier,\n\n // if include_usage is set or streamUsage then stream must be set to true.\n stream: this.streaming,\n previous_response_id: options?.previous_response_id,\n truncation: options?.truncation,\n include: options?.include,\n tools: options?.tools?.length\n ? this._reduceChatOpenAITools(options.tools, {\n stream: this.streaming,\n strict,\n })\n : undefined,\n tool_choice: isBuiltInToolChoice(options?.tool_choice)\n ? options?.tool_choice\n : (() => {\n const formatted = formatToOpenAIToolChoice(options?.tool_choice);\n if (typeof formatted === \"object\" && \"type\" in formatted) {\n if (formatted.type === \"function\") {\n return { type: \"function\", name: formatted.function.name };\n } else if (formatted.type === \"allowed_tools\") {\n return {\n type: \"allowed_tools\",\n mode: formatted.allowed_tools.mode,\n tools: formatted.allowed_tools.tools,\n };\n } else if (formatted.type === \"custom\") {\n return {\n type: \"custom\",\n name: formatted.custom.name,\n };\n }\n }\n return undefined;\n })(),\n text: (() => {\n if (options?.text) return options.text;\n const format = this._getResponseFormat(options?.response_format);\n if (format?.type === \"json_schema\") {\n if (format.json_schema.schema != null) {\n return {\n format: {\n type: \"json_schema\",\n schema: format.json_schema.schema,\n description: format.json_schema.description,\n name: format.json_schema.name,\n strict: format.json_schema.strict,\n },\n verbosity: options?.verbosity,\n };\n }\n return undefined;\n }\n return { format, verbosity: options?.verbosity };\n })(),\n parallel_tool_calls: options?.parallel_tool_calls,\n max_output_tokens: this.maxTokens === -1 ? undefined : this.maxTokens,\n prompt_cache_key: options?.promptCacheKey ?? this.promptCacheKey,\n prompt_cache_retention:\n options?.promptCacheRetention ?? this.promptCacheRetention,\n ...(this.zdrEnabled ? { store: false } : {}),\n ...this.modelKwargs,\n };\n\n const reasoning = this._getReasoningParams(options);\n\n if (reasoning !== undefined) {\n params.reasoning = reasoning;\n }\n\n return params;\n }\n\n async _generate(\n messages: BaseMessage[],\n options: this[\"ParsedCallOptions\"],\n runManager?: CallbackManagerForLLMRun\n ): Promise<ChatResult> {\n options.signal?.throwIfAborted();\n const invocationParams = this.invocationParams(options);\n if (invocationParams.stream) {\n const stream = this._streamResponseChunks(messages, options, runManager);\n let finalChunk: ChatGenerationChunk | undefined;\n for await (const chunk of stream) {\n chunk.message.response_metadata = {\n ...chunk.generationInfo,\n ...chunk.message.response_metadata,\n };\n finalChunk = finalChunk?.concat(chunk) ?? chunk;\n }\n\n return {\n generations: finalChunk ? [finalChunk] : [],\n llmOutput: {\n estimatedTokenUsage: (finalChunk?.message as AIMessage | undefined)\n ?.usage_metadata,\n },\n };\n } else {\n const data = await this.completionWithRetry(\n {\n input: convertMessagesToResponsesInput({\n messages,\n zdrEnabled: this.zdrEnabled ?? false,\n model: this.model,\n }),\n ...invocationParams,\n stream: false,\n },\n {\n signal: options?.signal,\n maxRetries: options?.maxRetries,\n ...options?.options,\n }\n );\n\n return {\n generations: [\n {\n text: data.output_text,\n message: convertResponsesMessageToAIMessage(data),\n },\n ],\n llmOutput: {\n id: data.id,\n estimatedTokenUsage: data.usage\n ? {\n promptTokens: data.usage.input_tokens,\n completionTokens: data.usage.output_tokens,\n totalTokens: data.usage.total_tokens,\n }\n : undefined,\n },\n };\n }\n }\n\n async *_streamChatModelEvents(\n messages: BaseMessage[],\n options: this[\"ParsedCallOptions\"],\n _runManager?: CallbackManagerForLLMRun\n ): AsyncGenerator<ChatModelStreamEvent> {\n const streamIterable = await this.completionWithRetry(\n {\n ...this.invocationParams(options),\n input: convertMessagesToResponsesInput({\n messages,\n zdrEnabled: this.zdrEnabled ?? false,\n model: this.model,\n }),\n stream: true,\n },\n options\n );\n\n const shouldStreamUsage = this.streamUsage ?? options.streamUsage;\n\n const abortableStream = async function* (\n source: AsyncIterable<OpenAIClient.Responses.ResponseStreamEvent>,\n signal?: AbortSignal\n ) {\n for await (const data of source) {\n if (signal?.aborted) {\n return;\n }\n yield data;\n }\n };\n\n yield* convertOpenAIResponsesStream(\n abortableStream(streamIterable, options.signal),\n {\n streamUsage: shouldStreamUsage ?? true,\n provider: this.streamEventProvider,\n }\n );\n }\n\n /** Provider id used in native stream protocol passthrough events. */\n protected get streamEventProvider(): string {\n return \"openai\";\n }\n\n async *_streamResponseChunks(\n messages: BaseMessage[],\n options: this[\"ParsedCallOptions\"],\n runManager?: CallbackManagerForLLMRun\n ): AsyncGenerator<ChatGenerationChunk> {\n const streamIterable = await this.completionWithRetry(\n {\n ...this.invocationParams(options),\n input: convertMessagesToResponsesInput({\n messages,\n zdrEnabled: this.zdrEnabled ?? false,\n model: this.model,\n }),\n stream: true,\n },\n options\n );\n\n try {\n for await (const data of streamIterable) {\n if (options.signal?.aborted) {\n return;\n }\n const chunk = convertResponsesDeltaToChatGenerationChunk(data);\n if (chunk == null) continue;\n yield chunk;\n await runManager?.handleLLMNewToken(\n chunk.text || \"\",\n {\n prompt: options.promptIndex ?? 0,\n completion: 0,\n },\n undefined,\n undefined,\n undefined,\n { chunk }\n );\n }\n } catch (e) {\n const error = wrapOpenAIClientError(e);\n throw error;\n }\n }\n\n /**\n * Calls the Responses API with retry logic in case of failures.\n * @param request The request to send to the OpenAI API.\n * @param options Optional configuration for the API call.\n * @returns The response from the OpenAI API.\n */\n async completionWithRetry(\n request: OpenAIClient.Responses.ResponseCreateParamsStreaming,\n requestOptions?: OpenAIClient.RequestOptions\n ): Promise<AsyncIterable<OpenAIClient.Responses.ResponseStreamEvent>>;\n\n async completionWithRetry(\n request: OpenAIClient.Responses.ResponseCreateParamsNonStreaming,\n requestOptions?: OpenAIClient.RequestOptions\n ): Promise<OpenAIClient.Responses.Response>;\n\n async completionWithRetry(\n request: OpenAIClient.Responses.ResponseCreateParams,\n requestOptions?: OpenAIClient.RequestOptions\n ): Promise<\n | AsyncIterable<OpenAIClient.Responses.ResponseStreamEvent>\n | OpenAIClient.Responses.Response\n > {\n // The SDK has its own `maxRetries`; take it for our caller instead so\n // the two retry loops don't multiply.\n const { maxRetries, ...sdkOptions } = requestOptions ?? {};\n const clientOptions = this._getClientOptions(sdkOptions);\n return this.caller.callWithOptions({ maxRetries }, async () => {\n try {\n // use parse if dealing with json_schema\n if (request.text?.format?.type === \"json_schema\" && !request.stream) {\n return await this.client.responses.parse(request, clientOptions);\n }\n return await this.client.responses.create(request, clientOptions);\n } catch (e) {\n const error = wrapOpenAIClientError(e);\n throw error;\n }\n });\n }\n\n /** @internal */\n protected _reduceChatOpenAITools(\n tools: ChatOpenAIToolType[],\n fields: { stream?: boolean; strict?: boolean }\n ): ResponsesTool[] {\n const reducedTools: ResponsesTool[] = [];\n for (const tool of tools) {\n if (isBuiltInTool(tool)) {\n if (tool.type === \"image_generation\" && fields?.stream) {\n // OpenAI sends a 400 error if partial_images is not set and we want to stream.\n // We also set it to 1 since we don't support partial images yet.\n tool.partial_images = 1;\n }\n reducedTools.push(tool);\n } else if (isCustomTool(tool)) {\n const customToolData = tool.metadata.customTool;\n reducedTools.push({\n type: \"custom\",\n name: customToolData.name,\n description: customToolData.description,\n format: customToolData.format,\n } as ResponsesTool);\n } else if (isOpenAIFunctionTool(tool)) {\n const extra: Record<string, unknown> = {};\n for (const [k, v] of Object.entries(tool)) {\n if (k !== \"type\" && k !== \"function\") {\n extra[k] = v;\n }\n }\n reducedTools.push({\n type: \"function\",\n name: tool.function.name,\n parameters: tool.function.parameters,\n description: tool.function.description,\n strict: fields?.strict ?? null,\n ...extra,\n });\n } else if (isOpenAICustomTool(tool)) {\n reducedTools.push(convertCompletionsCustomTool(tool));\n }\n }\n return reducedTools;\n }\n}\n"],"mappings":";;;;;;;;;;;;;;AAwEA,IAAa,sBAAb,cAGUA,aAAAA,eAA4B;CAGpC,YACE,eACA,WACA;EACA,MAAMC,aAAAA,yBAAyB,eAAe,SAAS,CAAC;CAC1D;CAEA,iBACE,SAC+B;EAC/B,IAAI;EACJ,IAAI,SAAS,WAAW,KAAA,GACtB,SAAS,QAAQ;EAEnB,IAAI,WAAW,KAAA,KAAa,KAAK,8BAA8B,KAAA,GAC7D,SAAS,KAAK;EAGhB,MAAM,SAAwC;GAC5C,OAAO,KAAK;GACZ,aAAa,KAAK;GAClB,OAAO,KAAK;GACZ,MAAM,KAAK;GACX,cAAc,KAAK;GAGnB,QAAQ,KAAK;GACb,sBAAsB,SAAS;GAC/B,YAAY,SAAS;GACrB,SAAS,SAAS;GAClB,OAAO,SAAS,OAAO,SACnB,KAAK,uBAAuB,QAAQ,OAAO;IACzC,QAAQ,KAAK;IACb;GACF,CAAC,IACD,KAAA;GACJ,aAAaC,cAAAA,oBAAoB,SAAS,WAAW,IACjD,SAAS,qBACF;IACL,MAAM,YAAYC,cAAAA,yBAAyB,SAAS,WAAW;IAC/D,IAAI,OAAO,cAAc,YAAY,UAAU,WAAW;KACxD,IAAI,UAAU,SAAS,YACrB,OAAO;MAAE,MAAM;MAAY,MAAM,UAAU,SAAS;KAAK;UACpD,IAAI,UAAU,SAAS,iBAC5B,OAAO;MACL,MAAM;MACN,MAAM,UAAU,cAAc;MAC9B,OAAO,UAAU,cAAc;KACjC;UACK,IAAI,UAAU,SAAS,UAC5B,OAAO;MACL,MAAM;MACN,MAAM,UAAU,OAAO;KACzB;IAEJ;GAEF,EAAA,CAAG;GACP,aAAa;IACX,IAAI,SAAS,MAAM,OAAO,QAAQ;IAClC,MAAM,SAAS,KAAK,mBAAmB,SAAS,eAAe;IAC/D,IAAI,QAAQ,SAAS,eAAe;KAClC,IAAI,OAAO,YAAY,UAAU,MAC/B,OAAO;MACL,QAAQ;OACN,MAAM;OACN,QAAQ,OAAO,YAAY;OAC3B,aAAa,OAAO,YAAY;OAChC,MAAM,OAAO,YAAY;OACzB,QAAQ,OAAO,YAAY;MAC7B;MACA,WAAW,SAAS;KACtB;KAEF;IACF;IACA,OAAO;KAAE;KAAQ,WAAW,SAAS;IAAU;GACjD,EAAA,CAAG;GACH,qBAAqB,SAAS;GAC9B,mBAAmB,KAAK,cAAc,KAAK,KAAA,IAAY,KAAK;GAC5D,kBAAkB,SAAS,kBAAkB,KAAK;GAClD,wBACE,SAAS,wBAAwB,KAAK;GACxC,GAAI,KAAK,aAAa,EAAE,OAAO,MAAM,IAAI,CAAC;GAC1C,GAAG,KAAK;EACV;EAEA,MAAM,YAAY,KAAK,oBAAoB,OAAO;EAElD,IAAI,cAAc,KAAA,GAChB,OAAO,YAAY;EAGrB,OAAO;CACT;CAEA,MAAM,UACJ,UACA,SACA,YACqB;EACrB,QAAQ,QAAQ,eAAe;EAC/B,MAAM,mBAAmB,KAAK,iBAAiB,OAAO;EACtD,IAAI,iBAAiB,QAAQ;GAC3B,MAAM,SAAS,KAAK,sBAAsB,UAAU,SAAS,UAAU;GACvE,IAAI;GACJ,WAAW,MAAM,SAAS,QAAQ;IAChC,MAAM,QAAQ,oBAAoB;KAChC,GAAG,MAAM;KACT,GAAG,MAAM,QAAQ;IACnB;IACA,aAAa,YAAY,OAAO,KAAK,KAAK;GAC5C;GAEA,OAAO;IACL,aAAa,aAAa,CAAC,UAAU,IAAI,CAAC;IAC1C,WAAW,EACT,sBAAsB,YAAY,QAAA,EAC9B,eACN;GACF;EACF,OAAO;GACL,MAAM,OAAO,MAAM,KAAK,oBACtB;IACE,OAAOC,kBAAAA,gCAAgC;KACrC;KACA,YAAY,KAAK,cAAc;KAC/B,OAAO,KAAK;IACd,CAAC;IACD,GAAG;IACH,QAAQ;GACV,GACA;IACE,QAAQ,SAAS;IACjB,YAAY,SAAS;IACrB,GAAG,SAAS;GACd,CACF;GAEA,OAAO;IACL,aAAa,CACX;KACE,MAAM,KAAK;KACX,SAASC,kBAAAA,mCAAmC,IAAI;IAClD,CACF;IACA,WAAW;KACT,IAAI,KAAK;KACT,qBAAqB,KAAK,QACtB;MACE,cAAc,KAAK,MAAM;MACzB,kBAAkB,KAAK,MAAM;MAC7B,aAAa,KAAK,MAAM;KAC1B,IACA,KAAA;IACN;GACF;EACF;CACF;CAEA,OAAO,uBACL,UACA,SACA,aACsC;EACtC,MAAM,iBAAiB,MAAM,KAAK,oBAChC;GACE,GAAG,KAAK,iBAAiB,OAAO;GAChC,OAAOD,kBAAAA,gCAAgC;IACrC;IACA,YAAY,KAAK,cAAc;IAC/B,OAAO,KAAK;GACd,CAAC;GACD,QAAQ;EACV,GACA,OACF;EAEA,MAAM,oBAAoB,KAAK,eAAe,QAAQ;EAEtD,MAAM,kBAAkB,iBACtB,QACA,QACA;GACA,WAAW,MAAM,QAAQ,QAAQ;IAC/B,IAAI,QAAQ,SACV;IAEF,MAAM;GACR;EACF;EAEA,OAAOE,gCAAAA,6BACL,gBAAgB,gBAAgB,QAAQ,MAAM,GAC9C;GACE,aAAa,qBAAqB;GAClC,UAAU,KAAK;EACjB,CACF;CACF;;CAGA,IAAc,sBAA8B;EAC1C,OAAO;CACT;CAEA,OAAO,sBACL,UACA,SACA,YACqC;EACrC,MAAM,iBAAiB,MAAM,KAAK,oBAChC;GACE,GAAG,KAAK,iBAAiB,OAAO;GAChC,OAAOF,kBAAAA,gCAAgC;IACrC;IACA,YAAY,KAAK,cAAc;IAC/B,OAAO,KAAK;GACd,CAAC;GACD,QAAQ;EACV,GACA,OACF;EAEA,IAAI;GACF,WAAW,MAAM,QAAQ,gBAAgB;IACvC,IAAI,QAAQ,QAAQ,SAClB;IAEF,MAAM,QAAQG,kBAAAA,2CAA2C,IAAI;IAC7D,IAAI,SAAS,MAAM;IACnB,MAAM;IACN,MAAM,YAAY,kBAChB,MAAM,QAAQ,IACd;KACE,QAAQ,QAAQ,eAAe;KAC/B,YAAY;IACd,GACA,KAAA,GACA,KAAA,GACA,KAAA,GACA,EAAE,MAAM,CACV;GACF;EACF,SAAS,GAAG;GAEV,MADcC,eAAAA,sBAAsB,CAC1B;EACZ;CACF;CAkBA,MAAM,oBACJ,SACA,gBAIA;EAGA,MAAM,EAAE,YAAY,GAAG,eAAe,kBAAkB,CAAC;EACzD,MAAM,gBAAgB,KAAK,kBAAkB,UAAU;EACvD,OAAO,KAAK,OAAO,gBAAgB,EAAE,WAAW,GAAG,YAAY;GAC7D,IAAI;IAEF,IAAI,QAAQ,MAAM,QAAQ,SAAS,iBAAiB,CAAC,QAAQ,QAC3D,OAAO,MAAM,KAAK,OAAO,UAAU,MAAM,SAAS,aAAa;IAEjE,OAAO,MAAM,KAAK,OAAO,UAAU,OAAO,SAAS,aAAa;GAClE,SAAS,GAAG;IAEV,MADcA,eAAAA,sBAAsB,CAC1B;GACZ;EACF,CAAC;CACH;;CAGA,uBACE,OACA,QACiB;EACjB,MAAM,eAAgC,CAAC;EACvC,KAAK,MAAM,QAAQ,OACjB,IAAIC,cAAAA,cAAc,IAAI,GAAG;GACvB,IAAI,KAAK,SAAS,sBAAsB,QAAQ,QAG9C,KAAK,iBAAiB;GAExB,aAAa,KAAK,IAAI;EACxB,OAAO,IAAIC,cAAAA,aAAa,IAAI,GAAG;GAC7B,MAAM,iBAAiB,KAAK,SAAS;GACrC,aAAa,KAAK;IAChB,MAAM;IACN,MAAM,eAAe;IACrB,aAAa,eAAe;IAC5B,QAAQ,eAAe;GACzB,CAAkB;EACpB,OAAO,KAAA,GAAIC,qCAAAA,aAAAA,CAAqB,IAAI,GAAG;GACrC,MAAM,QAAiC,CAAC;GACxC,KAAK,MAAM,CAAC,GAAG,MAAM,OAAO,QAAQ,IAAI,GACtC,IAAI,MAAM,UAAU,MAAM,YACxB,MAAM,KAAK;GAGf,aAAa,KAAK;IAChB,MAAM;IACN,MAAM,KAAK,SAAS;IACpB,YAAY,KAAK,SAAS;IAC1B,aAAa,KAAK,SAAS;IAC3B,QAAQ,QAAQ,UAAU;IAC1B,GAAG;GACL,CAAC;EACH,OAAO,IAAIC,cAAAA,mBAAmB,IAAI,GAChC,aAAa,KAAKC,cAAAA,6BAA6B,IAAI,CAAC;EAGxD,OAAO;CACT;AACF"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"responses.js","names":["isOpenAIFunctionTool"],"sources":["../../src/chat_models/responses.ts"],"sourcesContent":["import { OpenAI as OpenAIClient } from \"openai\";\nimport { CallbackManagerForLLMRun } from \"@langchain/core/callbacks/manager\";\nimport type { ChatModelStreamEvent } from \"@langchain/core/language_models/event\";\nimport { AIMessage, type BaseMessage } from \"@langchain/core/messages\";\nimport { ChatGenerationChunk, type ChatResult } from \"@langchain/core/outputs\";\nimport { isOpenAITool as isOpenAIFunctionTool } from \"@langchain/core/language_models/base\";\nimport { wrapOpenAIClientError } from \"../utils/client.js\";\nimport {\n ChatOpenAIToolType,\n convertCompletionsCustomTool,\n formatToOpenAIToolChoice,\n isBuiltInTool,\n isBuiltInToolChoice,\n isCustomTool,\n isOpenAICustomTool,\n ResponsesTool,\n} from \"../utils/tools.js\";\nimport {\n BaseChatOpenAI,\n BaseChatOpenAICallOptions,\n BaseChatOpenAIFields,\n getChatOpenAIModelParams,\n} from \"./base.js\";\nimport {\n convertMessagesToResponsesInput,\n convertResponsesDeltaToChatGenerationChunk,\n convertResponsesMessageToAIMessage,\n} from \"../converters/responses.js\";\nimport { OpenAIVerbosityParam } from \"../types.js\";\nimport { convertOpenAIResponsesStream } from \"../utils/responses_stream_events.js\";\n\nexport interface ChatOpenAIResponsesCallOptions extends BaseChatOpenAICallOptions {\n /**\n * Configuration options for a text response from the model. Can be plain text or\n * structured JSON data.\n */\n text?: OpenAIClient.Responses.ResponseCreateParams[\"text\"];\n\n /**\n * The truncation strategy to use for the model response.\n */\n truncation?: OpenAIClient.Responses.ResponseCreateParams[\"truncation\"];\n\n /**\n * Specify additional output data to include in the model response.\n */\n include?: OpenAIClient.Responses.ResponseCreateParams[\"include\"];\n\n /**\n * The unique ID of the previous response to the model. Use this to create multi-turn\n * conversations.\n */\n previous_response_id?: OpenAIClient.Responses.ResponseCreateParams[\"previous_response_id\"];\n\n /**\n * The verbosity of the model's response.\n */\n verbosity?: OpenAIVerbosityParam;\n}\n\nexport type ChatResponsesInvocationParams = Omit<\n OpenAIClient.Responses.ResponseCreateParams,\n \"input\"\n>;\n\n/**\n * OpenAI Responses API implementation.\n *\n * Will be exported in a later version of @langchain/openai.\n *\n * @internal\n */\nexport class ChatOpenAIResponses<\n CallOptions extends ChatOpenAIResponsesCallOptions =\n ChatOpenAIResponsesCallOptions,\n> extends BaseChatOpenAI<CallOptions> {\n constructor(model: string, fields?: Omit<BaseChatOpenAIFields, \"model\">);\n constructor(fields?: BaseChatOpenAIFields);\n constructor(\n modelOrFields?: string | BaseChatOpenAIFields,\n fieldsArg?: Omit<BaseChatOpenAIFields, \"model\">\n ) {\n super(getChatOpenAIModelParams(modelOrFields, fieldsArg));\n }\n\n override invocationParams(\n options?: this[\"ParsedCallOptions\"]\n ): ChatResponsesInvocationParams {\n let strict: boolean | undefined;\n if (options?.strict !== undefined) {\n strict = options.strict;\n }\n if (strict === undefined && this.supportsStrictToolCalling !== undefined) {\n strict = this.supportsStrictToolCalling;\n }\n\n const params: ChatResponsesInvocationParams = {\n model: this.model,\n temperature: this.temperature,\n top_p: this.topP,\n user: this.user,\n service_tier: this.service_tier,\n\n // if include_usage is set or streamUsage then stream must be set to true.\n stream: this.streaming,\n previous_response_id: options?.previous_response_id,\n truncation: options?.truncation,\n include: options?.include,\n tools: options?.tools?.length\n ? this._reduceChatOpenAITools(options.tools, {\n stream: this.streaming,\n strict,\n })\n : undefined,\n tool_choice: isBuiltInToolChoice(options?.tool_choice)\n ? options?.tool_choice\n : (() => {\n const formatted = formatToOpenAIToolChoice(options?.tool_choice);\n if (typeof formatted === \"object\" && \"type\" in formatted) {\n if (formatted.type === \"function\") {\n return { type: \"function\", name: formatted.function.name };\n } else if (formatted.type === \"allowed_tools\") {\n return {\n type: \"allowed_tools\",\n mode: formatted.allowed_tools.mode,\n tools: formatted.allowed_tools.tools,\n };\n } else if (formatted.type === \"custom\") {\n return {\n type: \"custom\",\n name: formatted.custom.name,\n };\n }\n }\n return undefined;\n })(),\n text: (() => {\n if (options?.text) return options.text;\n const format = this._getResponseFormat(options?.response_format);\n if (format?.type === \"json_schema\") {\n if (format.json_schema.schema != null) {\n return {\n format: {\n type: \"json_schema\",\n schema: format.json_schema.schema,\n description: format.json_schema.description,\n name: format.json_schema.name,\n strict: format.json_schema.strict,\n },\n verbosity: options?.verbosity,\n };\n }\n return undefined;\n }\n return { format, verbosity: options?.verbosity };\n })(),\n parallel_tool_calls: options?.parallel_tool_calls,\n max_output_tokens: this.maxTokens === -1 ? undefined : this.maxTokens,\n prompt_cache_key: options?.promptCacheKey ?? this.promptCacheKey,\n prompt_cache_retention:\n options?.promptCacheRetention ?? this.promptCacheRetention,\n ...(this.zdrEnabled ? { store: false } : {}),\n ...this.modelKwargs,\n };\n\n const reasoning = this._getReasoningParams(options);\n\n if (reasoning !== undefined) {\n params.reasoning = reasoning;\n }\n\n return params;\n }\n\n async _generate(\n messages: BaseMessage[],\n options: this[\"ParsedCallOptions\"],\n runManager?: CallbackManagerForLLMRun\n ): Promise<ChatResult> {\n options.signal?.throwIfAborted();\n const invocationParams = this.invocationParams(options);\n if (invocationParams.stream) {\n const stream = this._streamResponseChunks(messages, options, runManager);\n let finalChunk: ChatGenerationChunk | undefined;\n for await (const chunk of stream) {\n chunk.message.response_metadata = {\n ...chunk.generationInfo,\n ...chunk.message.response_metadata,\n };\n finalChunk = finalChunk?.concat(chunk) ?? chunk;\n }\n\n return {\n generations: finalChunk ? [finalChunk] : [],\n llmOutput: {\n estimatedTokenUsage: (finalChunk?.message as AIMessage | undefined)\n ?.usage_metadata,\n },\n };\n } else {\n const data = await this.completionWithRetry(\n {\n input: convertMessagesToResponsesInput({\n messages,\n zdrEnabled: this.zdrEnabled ?? false,\n model: this.model,\n }),\n ...invocationParams,\n stream: false,\n },\n {\n signal: options?.signal,\n maxRetries: options?.maxRetries,\n ...options?.options,\n }\n );\n\n return {\n generations: [\n {\n text: data.output_text,\n message: convertResponsesMessageToAIMessage(data),\n },\n ],\n llmOutput: {\n id: data.id,\n estimatedTokenUsage: data.usage\n ? {\n promptTokens: data.usage.input_tokens,\n completionTokens: data.usage.output_tokens,\n totalTokens: data.usage.total_tokens,\n }\n : undefined,\n },\n };\n }\n }\n\n async *_streamChatModelEvents(\n messages: BaseMessage[],\n options: this[\"ParsedCallOptions\"],\n _runManager?: CallbackManagerForLLMRun\n ): AsyncGenerator<ChatModelStreamEvent> {\n const streamIterable = await this.completionWithRetry(\n {\n ...this.invocationParams(options),\n input: convertMessagesToResponsesInput({\n messages,\n zdrEnabled: this.zdrEnabled ?? false,\n model: this.model,\n }),\n stream: true,\n },\n options\n );\n\n const shouldStreamUsage = this.streamUsage ?? options.streamUsage;\n\n const abortableStream = async function* (\n source: AsyncIterable<OpenAIClient.Responses.ResponseStreamEvent>,\n signal?: AbortSignal\n ) {\n for await (const data of source) {\n if (signal?.aborted) {\n return;\n }\n yield data;\n }\n };\n\n yield* convertOpenAIResponsesStream(\n abortableStream(streamIterable, options.signal),\n {\n streamUsage: shouldStreamUsage ?? true,\n provider: this.streamEventProvider,\n }\n );\n }\n\n /** Provider id used in native stream protocol passthrough events. */\n protected get streamEventProvider(): string {\n return \"openai\";\n }\n\n async *_streamResponseChunks(\n messages: BaseMessage[],\n options: this[\"ParsedCallOptions\"],\n runManager?: CallbackManagerForLLMRun\n ): AsyncGenerator<ChatGenerationChunk> {\n const streamIterable = await this.completionWithRetry(\n {\n ...this.invocationParams(options),\n input: convertMessagesToResponsesInput({\n messages,\n zdrEnabled: this.zdrEnabled ?? false,\n model: this.model,\n }),\n stream: true,\n },\n options\n );\n\n try {\n for await (const data of streamIterable) {\n if (options.signal?.aborted) {\n return;\n }\n const chunk = convertResponsesDeltaToChatGenerationChunk(data);\n if (chunk == null) continue;\n yield chunk;\n await runManager?.handleLLMNewToken(\n chunk.text || \"\",\n {\n prompt: options.promptIndex ?? 0,\n completion: 0,\n },\n undefined,\n undefined,\n undefined,\n { chunk }\n );\n }\n } catch (e) {\n const error = wrapOpenAIClientError(e);\n throw error;\n }\n }\n\n /**\n * Calls the Responses API with retry logic in case of failures.\n * @param request The request to send to the OpenAI API.\n * @param options Optional configuration for the API call.\n * @returns The response from the OpenAI API.\n */\n async completionWithRetry(\n request: OpenAIClient.Responses.ResponseCreateParamsStreaming,\n requestOptions?: OpenAIClient.RequestOptions\n ): Promise<AsyncIterable<OpenAIClient.Responses.ResponseStreamEvent>>;\n\n async completionWithRetry(\n request: OpenAIClient.Responses.ResponseCreateParamsNonStreaming,\n requestOptions?: OpenAIClient.RequestOptions\n ): Promise<OpenAIClient.Responses.Response>;\n\n async completionWithRetry(\n request: OpenAIClient.Responses.ResponseCreateParams,\n requestOptions?: OpenAIClient.RequestOptions\n ): Promise<\n | AsyncIterable<OpenAIClient.Responses.ResponseStreamEvent>\n | OpenAIClient.Responses.Response\n > {\n // The SDK has its own `maxRetries`; take it for our caller instead so\n // the two retry loops don't multiply.\n const { maxRetries, ...sdkOptions } = requestOptions ?? {};\n const clientOptions = this._getClientOptions(sdkOptions);\n return this.caller.callWithOptions({ maxRetries }, async () => {\n try {\n // use parse if dealing with json_schema\n if (request.text?.format?.type === \"json_schema\" && !request.stream) {\n return await this.client.responses.parse(request, clientOptions);\n }\n return await this.client.responses.create(request, clientOptions);\n } catch (e) {\n const error = wrapOpenAIClientError(e);\n throw error;\n }\n });\n }\n\n /** @internal */\n protected _reduceChatOpenAITools(\n tools: ChatOpenAIToolType[],\n fields: { stream?: boolean; strict?: boolean }\n ): ResponsesTool[] {\n const reducedTools: ResponsesTool[] = [];\n for (const tool of tools) {\n if (isBuiltInTool(tool)) {\n if (tool.type === \"image_generation\" && fields?.stream) {\n // OpenAI sends a 400 error if partial_images is not set and we want to stream.\n // We also set it to 1 since we don't support partial images yet.\n tool.partial_images = 1;\n }\n reducedTools.push(tool);\n } else if (isCustomTool(tool)) {\n const customToolData = tool.metadata.customTool;\n reducedTools.push({\n type: \"custom\",\n name: customToolData.name,\n description: customToolData.description,\n format: customToolData.format,\n } as ResponsesTool);\n } else if (isOpenAIFunctionTool(tool)) {\n const extra: Record<string, unknown> = {};\n for (const [k, v] of Object.entries(tool)) {\n if (k !== \"type\" && k !== \"function\") {\n extra[k] = v;\n }\n }\n reducedTools.push({\n type: \"function\",\n name: tool.function.name,\n parameters: tool.function.parameters,\n description: tool.function.description,\n strict: fields?.strict ?? null,\n ...extra,\n });\n } else if (isOpenAICustomTool(tool)) {\n reducedTools.push(convertCompletionsCustomTool(tool));\n }\n }\n return reducedTools;\n }\n}\n"],"mappings":";;;;;;;;;;;;;;AAwEA,IAAa,sBAAb,cAGU,eAA4B;CAGpC,YACE,eACA,WACA;EACA,MAAM,yBAAyB,eAAe,SAAS,CAAC;CAC1D;CAEA,iBACE,SAC+B;EAC/B,IAAI;EACJ,IAAI,SAAS,WAAW,KAAA,GACtB,SAAS,QAAQ;EAEnB,IAAI,WAAW,KAAA,KAAa,KAAK,8BAA8B,KAAA,GAC7D,SAAS,KAAK;EAGhB,MAAM,SAAwC;GAC5C,OAAO,KAAK;GACZ,aAAa,KAAK;GAClB,OAAO,KAAK;GACZ,MAAM,KAAK;GACX,cAAc,KAAK;GAGnB,QAAQ,KAAK;GACb,sBAAsB,SAAS;GAC/B,YAAY,SAAS;GACrB,SAAS,SAAS;GAClB,OAAO,SAAS,OAAO,SACnB,KAAK,uBAAuB,QAAQ,OAAO;IACzC,QAAQ,KAAK;IACb;GACF,CAAC,IACD,KAAA;GACJ,aAAa,oBAAoB,SAAS,WAAW,IACjD,SAAS,qBACF;IACL,MAAM,YAAY,yBAAyB,SAAS,WAAW;IAC/D,IAAI,OAAO,cAAc,YAAY,UAAU,WACzC;SAAA,UAAU,SAAS,YACrB,OAAO;MAAE,MAAM;MAAY,MAAM,UAAU,SAAS;KAAK;UACpD,IAAI,UAAU,SAAS,iBAC5B,OAAO;MACL,MAAM;MACN,MAAM,UAAU,cAAc;MAC9B,OAAO,UAAU,cAAc;KACjC;UACK,IAAI,UAAU,SAAS,UAC5B,OAAO;MACL,MAAM;MACN,MAAM,UAAU,OAAO;KACzB;IAAA;GAIN,EAAA,CAAG;GACP,aAAa;IACX,IAAI,SAAS,MAAM,OAAO,QAAQ;IAClC,MAAM,SAAS,KAAK,mBAAmB,SAAS,eAAe;IAC/D,IAAI,QAAQ,SAAS,eAAe;KAClC,IAAI,OAAO,YAAY,UAAU,MAC/B,OAAO;MACL,QAAQ;OACN,MAAM;OACN,QAAQ,OAAO,YAAY;OAC3B,aAAa,OAAO,YAAY;OAChC,MAAM,OAAO,YAAY;OACzB,QAAQ,OAAO,YAAY;MAC7B;MACA,WAAW,SAAS;KACtB;KAEF;IACF;IACA,OAAO;KAAE;KAAQ,WAAW,SAAS;IAAU;GACjD,EAAA,CAAG;GACH,qBAAqB,SAAS;GAC9B,mBAAmB,KAAK,cAAc,KAAK,KAAA,IAAY,KAAK;GAC5D,kBAAkB,SAAS,kBAAkB,KAAK;GAClD,wBACE,SAAS,wBAAwB,KAAK;GACxC,GAAI,KAAK,aAAa,EAAE,OAAO,MAAM,IAAI,CAAC;GAC1C,GAAG,KAAK;EACV;EAEA,MAAM,YAAY,KAAK,oBAAoB,OAAO;EAElD,IAAI,cAAc,KAAA,GAChB,OAAO,YAAY;EAGrB,OAAO;CACT;CAEA,MAAM,UACJ,UACA,SACA,YACqB;EACrB,QAAQ,QAAQ,eAAe;EAC/B,MAAM,mBAAmB,KAAK,iBAAiB,OAAO;EACtD,IAAI,iBAAiB,QAAQ;GAC3B,MAAM,SAAS,KAAK,sBAAsB,UAAU,SAAS,UAAU;GACvE,IAAI;GACJ,WAAW,MAAM,SAAS,QAAQ;IAChC,MAAM,QAAQ,oBAAoB;KAChC,GAAG,MAAM;KACT,GAAG,MAAM,QAAQ;IACnB;IACA,aAAa,YAAY,OAAO,KAAK,KAAK;GAC5C;GAEA,OAAO;IACL,aAAa,aAAa,CAAC,UAAU,IAAI,CAAC;IAC1C,WAAW,EACT,sBAAsB,YAAY,QAAA,EAC9B,eACN;GACF;EACF,OAAO;GACL,MAAM,OAAO,MAAM,KAAK,oBACtB;IACE,OAAO,gCAAgC;KACrC;KACA,YAAY,KAAK,cAAc;KAC/B,OAAO,KAAK;IACd,CAAC;IACD,GAAG;IACH,QAAQ;GACV,GACA;IACE,QAAQ,SAAS;IACjB,YAAY,SAAS;IACrB,GAAG,SAAS;GACd,CACF;GAEA,OAAO;IACL,aAAa,CACX;KACE,MAAM,KAAK;KACX,SAAS,mCAAmC,IAAI;IAClD,CACF;IACA,WAAW;KACT,IAAI,KAAK;KACT,qBAAqB,KAAK,QACtB;MACE,cAAc,KAAK,MAAM;MACzB,kBAAkB,KAAK,MAAM;MAC7B,aAAa,KAAK,MAAM;KAC1B,IACA,KAAA;IACN;GACF;EACF;CACF;CAEA,OAAO,uBACL,UACA,SACA,aACsC;EACtC,MAAM,iBAAiB,MAAM,KAAK,oBAChC;GACE,GAAG,KAAK,iBAAiB,OAAO;GAChC,OAAO,gCAAgC;IACrC;IACA,YAAY,KAAK,cAAc;IAC/B,OAAO,KAAK;GACd,CAAC;GACD,QAAQ;EACV,GACA,OACF;EAEA,MAAM,oBAAoB,KAAK,eAAe,QAAQ;EAEtD,MAAM,kBAAkB,iBACtB,QACA,QACA;GACA,WAAW,MAAM,QAAQ,QAAQ;IAC/B,IAAI,QAAQ,SACV;IAEF,MAAM;GACR;EACF;EAEA,OAAO,6BACL,gBAAgB,gBAAgB,QAAQ,MAAM,GAC9C;GACE,aAAa,qBAAqB;GAClC,UAAU,KAAK;EACjB,CACF;CACF;;CAGA,IAAc,sBAA8B;EAC1C,OAAO;CACT;CAEA,OAAO,sBACL,UACA,SACA,YACqC;EACrC,MAAM,iBAAiB,MAAM,KAAK,oBAChC;GACE,GAAG,KAAK,iBAAiB,OAAO;GAChC,OAAO,gCAAgC;IACrC;IACA,YAAY,KAAK,cAAc;IAC/B,OAAO,KAAK;GACd,CAAC;GACD,QAAQ;EACV,GACA,OACF;EAEA,IAAI;GACF,WAAW,MAAM,QAAQ,gBAAgB;IACvC,IAAI,QAAQ,QAAQ,SAClB;IAEF,MAAM,QAAQ,2CAA2C,IAAI;IAC7D,IAAI,SAAS,MAAM;IACnB,MAAM;IACN,MAAM,YAAY,kBAChB,MAAM,QAAQ,IACd;KACE,QAAQ,QAAQ,eAAe;KAC/B,YAAY;IACd,GACA,KAAA,GACA,KAAA,GACA,KAAA,GACA,EAAE,MAAM,CACV;GACF;EACF,SAAS,GAAG;GAEV,MADc,sBAAsB,CAC1B;EACZ;CACF;CAkBA,MAAM,oBACJ,SACA,gBAIA;EAGA,MAAM,EAAE,YAAY,GAAG,eAAe,kBAAkB,CAAC;EACzD,MAAM,gBAAgB,KAAK,kBAAkB,UAAU;EACvD,OAAO,KAAK,OAAO,gBAAgB,EAAE,WAAW,GAAG,YAAY;GAC7D,IAAI;IAEF,IAAI,QAAQ,MAAM,QAAQ,SAAS,iBAAiB,CAAC,QAAQ,QAC3D,OAAO,MAAM,KAAK,OAAO,UAAU,MAAM,SAAS,aAAa;IAEjE,OAAO,MAAM,KAAK,OAAO,UAAU,OAAO,SAAS,aAAa;GAClE,SAAS,GAAG;IAEV,MADc,sBAAsB,CAC1B;GACZ;EACF,CAAC;CACH;;CAGA,uBACE,OACA,QACiB;EACjB,MAAM,eAAgC,CAAC;EACvC,KAAK,MAAM,QAAQ,OACjB,IAAI,cAAc,IAAI,GAAG;GACvB,IAAI,KAAK,SAAS,sBAAsB,QAAQ,QAG9C,KAAK,iBAAiB;GAExB,aAAa,KAAK,IAAI;EACxB,OAAO,IAAI,aAAa,IAAI,GAAG;GAC7B,MAAM,iBAAiB,KAAK,SAAS;GACrC,aAAa,KAAK;IAChB,MAAM;IACN,MAAM,eAAe;IACrB,aAAa,eAAe;IAC5B,QAAQ,eAAe;GACzB,CAAkB;EACpB,OAAO,IAAIA,aAAqB,IAAI,GAAG;GACrC,MAAM,QAAiC,CAAC;GACxC,KAAK,MAAM,CAAC,GAAG,MAAM,OAAO,QAAQ,IAAI,GACtC,IAAI,MAAM,UAAU,MAAM,YACxB,MAAM,KAAK;GAGf,aAAa,KAAK;IAChB,MAAM;IACN,MAAM,KAAK,SAAS;IACpB,YAAY,KAAK,SAAS;IAC1B,aAAa,KAAK,SAAS;IAC3B,QAAQ,QAAQ,UAAU;IAC1B,GAAG;GACL,CAAC;EACH,OAAO,IAAI,mBAAmB,IAAI,GAChC,aAAa,KAAK,6BAA6B,IAAI,CAAC;EAGxD,OAAO;CACT;AACF"}
|
|
1
|
+
{"version":3,"file":"responses.js","names":["isOpenAIFunctionTool"],"sources":["../../src/chat_models/responses.ts"],"sourcesContent":["import { OpenAI as OpenAIClient } from \"openai\";\nimport { CallbackManagerForLLMRun } from \"@langchain/core/callbacks/manager\";\nimport type { ChatModelStreamEvent } from \"@langchain/core/language_models/event\";\nimport { AIMessage, type BaseMessage } from \"@langchain/core/messages\";\nimport { ChatGenerationChunk, type ChatResult } from \"@langchain/core/outputs\";\nimport { isOpenAITool as isOpenAIFunctionTool } from \"@langchain/core/language_models/base\";\nimport { wrapOpenAIClientError } from \"../utils/client.js\";\nimport {\n ChatOpenAIToolType,\n convertCompletionsCustomTool,\n formatToOpenAIToolChoice,\n isBuiltInTool,\n isBuiltInToolChoice,\n isCustomTool,\n isOpenAICustomTool,\n ResponsesTool,\n} from \"../utils/tools.js\";\nimport {\n BaseChatOpenAI,\n BaseChatOpenAICallOptions,\n BaseChatOpenAIFields,\n getChatOpenAIModelParams,\n} from \"./base.js\";\nimport {\n convertMessagesToResponsesInput,\n convertResponsesDeltaToChatGenerationChunk,\n convertResponsesMessageToAIMessage,\n} from \"../converters/responses.js\";\nimport { OpenAIVerbosityParam } from \"../types.js\";\nimport { convertOpenAIResponsesStream } from \"../utils/responses_stream_events.js\";\n\nexport interface ChatOpenAIResponsesCallOptions extends BaseChatOpenAICallOptions {\n /**\n * Configuration options for a text response from the model. Can be plain text or\n * structured JSON data.\n */\n text?: OpenAIClient.Responses.ResponseCreateParams[\"text\"];\n\n /**\n * The truncation strategy to use for the model response.\n */\n truncation?: OpenAIClient.Responses.ResponseCreateParams[\"truncation\"];\n\n /**\n * Specify additional output data to include in the model response.\n */\n include?: OpenAIClient.Responses.ResponseCreateParams[\"include\"];\n\n /**\n * The unique ID of the previous response to the model. Use this to create multi-turn\n * conversations.\n */\n previous_response_id?: OpenAIClient.Responses.ResponseCreateParams[\"previous_response_id\"];\n\n /**\n * The verbosity of the model's response.\n */\n verbosity?: OpenAIVerbosityParam;\n}\n\nexport type ChatResponsesInvocationParams = Omit<\n OpenAIClient.Responses.ResponseCreateParams,\n \"input\"\n>;\n\n/**\n * OpenAI Responses API implementation.\n *\n * Will be exported in a later version of @langchain/openai.\n *\n * @internal\n */\nexport class ChatOpenAIResponses<\n CallOptions extends ChatOpenAIResponsesCallOptions =\n ChatOpenAIResponsesCallOptions,\n> extends BaseChatOpenAI<CallOptions> {\n constructor(model: string, fields?: Omit<BaseChatOpenAIFields, \"model\">);\n constructor(fields?: BaseChatOpenAIFields);\n constructor(\n modelOrFields?: string | BaseChatOpenAIFields,\n fieldsArg?: Omit<BaseChatOpenAIFields, \"model\">\n ) {\n super(getChatOpenAIModelParams(modelOrFields, fieldsArg));\n }\n\n override invocationParams(\n options?: this[\"ParsedCallOptions\"]\n ): ChatResponsesInvocationParams {\n let strict: boolean | undefined;\n if (options?.strict !== undefined) {\n strict = options.strict;\n }\n if (strict === undefined && this.supportsStrictToolCalling !== undefined) {\n strict = this.supportsStrictToolCalling;\n }\n\n const params: ChatResponsesInvocationParams = {\n model: this.model,\n temperature: this.temperature,\n top_p: this.topP,\n user: this.user,\n service_tier: this.service_tier,\n\n // if include_usage is set or streamUsage then stream must be set to true.\n stream: this.streaming,\n previous_response_id: options?.previous_response_id,\n truncation: options?.truncation,\n include: options?.include,\n tools: options?.tools?.length\n ? this._reduceChatOpenAITools(options.tools, {\n stream: this.streaming,\n strict,\n })\n : undefined,\n tool_choice: isBuiltInToolChoice(options?.tool_choice)\n ? options?.tool_choice\n : (() => {\n const formatted = formatToOpenAIToolChoice(options?.tool_choice);\n if (typeof formatted === \"object\" && \"type\" in formatted) {\n if (formatted.type === \"function\") {\n return { type: \"function\", name: formatted.function.name };\n } else if (formatted.type === \"allowed_tools\") {\n return {\n type: \"allowed_tools\",\n mode: formatted.allowed_tools.mode,\n tools: formatted.allowed_tools.tools,\n };\n } else if (formatted.type === \"custom\") {\n return {\n type: \"custom\",\n name: formatted.custom.name,\n };\n }\n }\n return undefined;\n })(),\n text: (() => {\n if (options?.text) return options.text;\n const format = this._getResponseFormat(options?.response_format);\n if (format?.type === \"json_schema\") {\n if (format.json_schema.schema != null) {\n return {\n format: {\n type: \"json_schema\",\n schema: format.json_schema.schema,\n description: format.json_schema.description,\n name: format.json_schema.name,\n strict: format.json_schema.strict,\n },\n verbosity: options?.verbosity,\n };\n }\n return undefined;\n }\n return { format, verbosity: options?.verbosity };\n })(),\n parallel_tool_calls: options?.parallel_tool_calls,\n max_output_tokens: this.maxTokens === -1 ? undefined : this.maxTokens,\n prompt_cache_key: options?.promptCacheKey ?? this.promptCacheKey,\n prompt_cache_retention:\n options?.promptCacheRetention ?? this.promptCacheRetention,\n ...(this.zdrEnabled ? { store: false } : {}),\n ...this.modelKwargs,\n };\n\n const reasoning = this._getReasoningParams(options);\n\n if (reasoning !== undefined) {\n params.reasoning = reasoning;\n }\n\n return params;\n }\n\n async _generate(\n messages: BaseMessage[],\n options: this[\"ParsedCallOptions\"],\n runManager?: CallbackManagerForLLMRun\n ): Promise<ChatResult> {\n options.signal?.throwIfAborted();\n const invocationParams = this.invocationParams(options);\n if (invocationParams.stream) {\n const stream = this._streamResponseChunks(messages, options, runManager);\n let finalChunk: ChatGenerationChunk | undefined;\n for await (const chunk of stream) {\n chunk.message.response_metadata = {\n ...chunk.generationInfo,\n ...chunk.message.response_metadata,\n };\n finalChunk = finalChunk?.concat(chunk) ?? chunk;\n }\n\n return {\n generations: finalChunk ? [finalChunk] : [],\n llmOutput: {\n estimatedTokenUsage: (finalChunk?.message as AIMessage | undefined)\n ?.usage_metadata,\n },\n };\n } else {\n const data = await this.completionWithRetry(\n {\n input: convertMessagesToResponsesInput({\n messages,\n zdrEnabled: this.zdrEnabled ?? false,\n model: this.model,\n }),\n ...invocationParams,\n stream: false,\n },\n {\n signal: options?.signal,\n maxRetries: options?.maxRetries,\n ...options?.options,\n }\n );\n\n return {\n generations: [\n {\n text: data.output_text,\n message: convertResponsesMessageToAIMessage(data),\n },\n ],\n llmOutput: {\n id: data.id,\n estimatedTokenUsage: data.usage\n ? {\n promptTokens: data.usage.input_tokens,\n completionTokens: data.usage.output_tokens,\n totalTokens: data.usage.total_tokens,\n }\n : undefined,\n },\n };\n }\n }\n\n async *_streamChatModelEvents(\n messages: BaseMessage[],\n options: this[\"ParsedCallOptions\"],\n _runManager?: CallbackManagerForLLMRun\n ): AsyncGenerator<ChatModelStreamEvent> {\n const streamIterable = await this.completionWithRetry(\n {\n ...this.invocationParams(options),\n input: convertMessagesToResponsesInput({\n messages,\n zdrEnabled: this.zdrEnabled ?? false,\n model: this.model,\n }),\n stream: true,\n },\n options\n );\n\n const shouldStreamUsage = this.streamUsage ?? options.streamUsage;\n\n const abortableStream = async function* (\n source: AsyncIterable<OpenAIClient.Responses.ResponseStreamEvent>,\n signal?: AbortSignal\n ) {\n for await (const data of source) {\n if (signal?.aborted) {\n return;\n }\n yield data;\n }\n };\n\n yield* convertOpenAIResponsesStream(\n abortableStream(streamIterable, options.signal),\n {\n streamUsage: shouldStreamUsage ?? true,\n provider: this.streamEventProvider,\n }\n );\n }\n\n /** Provider id used in native stream protocol passthrough events. */\n protected get streamEventProvider(): string {\n return \"openai\";\n }\n\n async *_streamResponseChunks(\n messages: BaseMessage[],\n options: this[\"ParsedCallOptions\"],\n runManager?: CallbackManagerForLLMRun\n ): AsyncGenerator<ChatGenerationChunk> {\n const streamIterable = await this.completionWithRetry(\n {\n ...this.invocationParams(options),\n input: convertMessagesToResponsesInput({\n messages,\n zdrEnabled: this.zdrEnabled ?? false,\n model: this.model,\n }),\n stream: true,\n },\n options\n );\n\n try {\n for await (const data of streamIterable) {\n if (options.signal?.aborted) {\n return;\n }\n const chunk = convertResponsesDeltaToChatGenerationChunk(data);\n if (chunk == null) continue;\n yield chunk;\n await runManager?.handleLLMNewToken(\n chunk.text || \"\",\n {\n prompt: options.promptIndex ?? 0,\n completion: 0,\n },\n undefined,\n undefined,\n undefined,\n { chunk }\n );\n }\n } catch (e) {\n const error = wrapOpenAIClientError(e);\n throw error;\n }\n }\n\n /**\n * Calls the Responses API with retry logic in case of failures.\n * @param request The request to send to the OpenAI API.\n * @param options Optional configuration for the API call.\n * @returns The response from the OpenAI API.\n */\n async completionWithRetry(\n request: OpenAIClient.Responses.ResponseCreateParamsStreaming,\n requestOptions?: OpenAIClient.RequestOptions\n ): Promise<AsyncIterable<OpenAIClient.Responses.ResponseStreamEvent>>;\n\n async completionWithRetry(\n request: OpenAIClient.Responses.ResponseCreateParamsNonStreaming,\n requestOptions?: OpenAIClient.RequestOptions\n ): Promise<OpenAIClient.Responses.Response>;\n\n async completionWithRetry(\n request: OpenAIClient.Responses.ResponseCreateParams,\n requestOptions?: OpenAIClient.RequestOptions\n ): Promise<\n | AsyncIterable<OpenAIClient.Responses.ResponseStreamEvent>\n | OpenAIClient.Responses.Response\n > {\n // The SDK has its own `maxRetries`; take it for our caller instead so\n // the two retry loops don't multiply.\n const { maxRetries, ...sdkOptions } = requestOptions ?? {};\n const clientOptions = this._getClientOptions(sdkOptions);\n return this.caller.callWithOptions({ maxRetries }, async () => {\n try {\n // use parse if dealing with json_schema\n if (request.text?.format?.type === \"json_schema\" && !request.stream) {\n return await this.client.responses.parse(request, clientOptions);\n }\n return await this.client.responses.create(request, clientOptions);\n } catch (e) {\n const error = wrapOpenAIClientError(e);\n throw error;\n }\n });\n }\n\n /** @internal */\n protected _reduceChatOpenAITools(\n tools: ChatOpenAIToolType[],\n fields: { stream?: boolean; strict?: boolean }\n ): ResponsesTool[] {\n const reducedTools: ResponsesTool[] = [];\n for (const tool of tools) {\n if (isBuiltInTool(tool)) {\n if (tool.type === \"image_generation\" && fields?.stream) {\n // OpenAI sends a 400 error if partial_images is not set and we want to stream.\n // We also set it to 1 since we don't support partial images yet.\n tool.partial_images = 1;\n }\n reducedTools.push(tool);\n } else if (isCustomTool(tool)) {\n const customToolData = tool.metadata.customTool;\n reducedTools.push({\n type: \"custom\",\n name: customToolData.name,\n description: customToolData.description,\n format: customToolData.format,\n } as ResponsesTool);\n } else if (isOpenAIFunctionTool(tool)) {\n const extra: Record<string, unknown> = {};\n for (const [k, v] of Object.entries(tool)) {\n if (k !== \"type\" && k !== \"function\") {\n extra[k] = v;\n }\n }\n reducedTools.push({\n type: \"function\",\n name: tool.function.name,\n parameters: tool.function.parameters,\n description: tool.function.description,\n strict: fields?.strict ?? null,\n ...extra,\n });\n } else if (isOpenAICustomTool(tool)) {\n reducedTools.push(convertCompletionsCustomTool(tool));\n }\n }\n return reducedTools;\n }\n}\n"],"mappings":";;;;;;;;;;;;;;AAwEA,IAAa,sBAAb,cAGU,eAA4B;CAGpC,YACE,eACA,WACA;EACA,MAAM,yBAAyB,eAAe,SAAS,CAAC;CAC1D;CAEA,iBACE,SAC+B;EAC/B,IAAI;EACJ,IAAI,SAAS,WAAW,KAAA,GACtB,SAAS,QAAQ;EAEnB,IAAI,WAAW,KAAA,KAAa,KAAK,8BAA8B,KAAA,GAC7D,SAAS,KAAK;EAGhB,MAAM,SAAwC;GAC5C,OAAO,KAAK;GACZ,aAAa,KAAK;GAClB,OAAO,KAAK;GACZ,MAAM,KAAK;GACX,cAAc,KAAK;GAGnB,QAAQ,KAAK;GACb,sBAAsB,SAAS;GAC/B,YAAY,SAAS;GACrB,SAAS,SAAS;GAClB,OAAO,SAAS,OAAO,SACnB,KAAK,uBAAuB,QAAQ,OAAO;IACzC,QAAQ,KAAK;IACb;GACF,CAAC,IACD,KAAA;GACJ,aAAa,oBAAoB,SAAS,WAAW,IACjD,SAAS,qBACF;IACL,MAAM,YAAY,yBAAyB,SAAS,WAAW;IAC/D,IAAI,OAAO,cAAc,YAAY,UAAU,WAAW;KACxD,IAAI,UAAU,SAAS,YACrB,OAAO;MAAE,MAAM;MAAY,MAAM,UAAU,SAAS;KAAK;UACpD,IAAI,UAAU,SAAS,iBAC5B,OAAO;MACL,MAAM;MACN,MAAM,UAAU,cAAc;MAC9B,OAAO,UAAU,cAAc;KACjC;UACK,IAAI,UAAU,SAAS,UAC5B,OAAO;MACL,MAAM;MACN,MAAM,UAAU,OAAO;KACzB;IAEJ;GAEF,EAAA,CAAG;GACP,aAAa;IACX,IAAI,SAAS,MAAM,OAAO,QAAQ;IAClC,MAAM,SAAS,KAAK,mBAAmB,SAAS,eAAe;IAC/D,IAAI,QAAQ,SAAS,eAAe;KAClC,IAAI,OAAO,YAAY,UAAU,MAC/B,OAAO;MACL,QAAQ;OACN,MAAM;OACN,QAAQ,OAAO,YAAY;OAC3B,aAAa,OAAO,YAAY;OAChC,MAAM,OAAO,YAAY;OACzB,QAAQ,OAAO,YAAY;MAC7B;MACA,WAAW,SAAS;KACtB;KAEF;IACF;IACA,OAAO;KAAE;KAAQ,WAAW,SAAS;IAAU;GACjD,EAAA,CAAG;GACH,qBAAqB,SAAS;GAC9B,mBAAmB,KAAK,cAAc,KAAK,KAAA,IAAY,KAAK;GAC5D,kBAAkB,SAAS,kBAAkB,KAAK;GAClD,wBACE,SAAS,wBAAwB,KAAK;GACxC,GAAI,KAAK,aAAa,EAAE,OAAO,MAAM,IAAI,CAAC;GAC1C,GAAG,KAAK;EACV;EAEA,MAAM,YAAY,KAAK,oBAAoB,OAAO;EAElD,IAAI,cAAc,KAAA,GAChB,OAAO,YAAY;EAGrB,OAAO;CACT;CAEA,MAAM,UACJ,UACA,SACA,YACqB;EACrB,QAAQ,QAAQ,eAAe;EAC/B,MAAM,mBAAmB,KAAK,iBAAiB,OAAO;EACtD,IAAI,iBAAiB,QAAQ;GAC3B,MAAM,SAAS,KAAK,sBAAsB,UAAU,SAAS,UAAU;GACvE,IAAI;GACJ,WAAW,MAAM,SAAS,QAAQ;IAChC,MAAM,QAAQ,oBAAoB;KAChC,GAAG,MAAM;KACT,GAAG,MAAM,QAAQ;IACnB;IACA,aAAa,YAAY,OAAO,KAAK,KAAK;GAC5C;GAEA,OAAO;IACL,aAAa,aAAa,CAAC,UAAU,IAAI,CAAC;IAC1C,WAAW,EACT,sBAAsB,YAAY,QAAA,EAC9B,eACN;GACF;EACF,OAAO;GACL,MAAM,OAAO,MAAM,KAAK,oBACtB;IACE,OAAO,gCAAgC;KACrC;KACA,YAAY,KAAK,cAAc;KAC/B,OAAO,KAAK;IACd,CAAC;IACD,GAAG;IACH,QAAQ;GACV,GACA;IACE,QAAQ,SAAS;IACjB,YAAY,SAAS;IACrB,GAAG,SAAS;GACd,CACF;GAEA,OAAO;IACL,aAAa,CACX;KACE,MAAM,KAAK;KACX,SAAS,mCAAmC,IAAI;IAClD,CACF;IACA,WAAW;KACT,IAAI,KAAK;KACT,qBAAqB,KAAK,QACtB;MACE,cAAc,KAAK,MAAM;MACzB,kBAAkB,KAAK,MAAM;MAC7B,aAAa,KAAK,MAAM;KAC1B,IACA,KAAA;IACN;GACF;EACF;CACF;CAEA,OAAO,uBACL,UACA,SACA,aACsC;EACtC,MAAM,iBAAiB,MAAM,KAAK,oBAChC;GACE,GAAG,KAAK,iBAAiB,OAAO;GAChC,OAAO,gCAAgC;IACrC;IACA,YAAY,KAAK,cAAc;IAC/B,OAAO,KAAK;GACd,CAAC;GACD,QAAQ;EACV,GACA,OACF;EAEA,MAAM,oBAAoB,KAAK,eAAe,QAAQ;EAEtD,MAAM,kBAAkB,iBACtB,QACA,QACA;GACA,WAAW,MAAM,QAAQ,QAAQ;IAC/B,IAAI,QAAQ,SACV;IAEF,MAAM;GACR;EACF;EAEA,OAAO,6BACL,gBAAgB,gBAAgB,QAAQ,MAAM,GAC9C;GACE,aAAa,qBAAqB;GAClC,UAAU,KAAK;EACjB,CACF;CACF;;CAGA,IAAc,sBAA8B;EAC1C,OAAO;CACT;CAEA,OAAO,sBACL,UACA,SACA,YACqC;EACrC,MAAM,iBAAiB,MAAM,KAAK,oBAChC;GACE,GAAG,KAAK,iBAAiB,OAAO;GAChC,OAAO,gCAAgC;IACrC;IACA,YAAY,KAAK,cAAc;IAC/B,OAAO,KAAK;GACd,CAAC;GACD,QAAQ;EACV,GACA,OACF;EAEA,IAAI;GACF,WAAW,MAAM,QAAQ,gBAAgB;IACvC,IAAI,QAAQ,QAAQ,SAClB;IAEF,MAAM,QAAQ,2CAA2C,IAAI;IAC7D,IAAI,SAAS,MAAM;IACnB,MAAM;IACN,MAAM,YAAY,kBAChB,MAAM,QAAQ,IACd;KACE,QAAQ,QAAQ,eAAe;KAC/B,YAAY;IACd,GACA,KAAA,GACA,KAAA,GACA,KAAA,GACA,EAAE,MAAM,CACV;GACF;EACF,SAAS,GAAG;GAEV,MADc,sBAAsB,CAC1B;EACZ;CACF;CAkBA,MAAM,oBACJ,SACA,gBAIA;EAGA,MAAM,EAAE,YAAY,GAAG,eAAe,kBAAkB,CAAC;EACzD,MAAM,gBAAgB,KAAK,kBAAkB,UAAU;EACvD,OAAO,KAAK,OAAO,gBAAgB,EAAE,WAAW,GAAG,YAAY;GAC7D,IAAI;IAEF,IAAI,QAAQ,MAAM,QAAQ,SAAS,iBAAiB,CAAC,QAAQ,QAC3D,OAAO,MAAM,KAAK,OAAO,UAAU,MAAM,SAAS,aAAa;IAEjE,OAAO,MAAM,KAAK,OAAO,UAAU,OAAO,SAAS,aAAa;GAClE,SAAS,GAAG;IAEV,MADc,sBAAsB,CAC1B;GACZ;EACF,CAAC;CACH;;CAGA,uBACE,OACA,QACiB;EACjB,MAAM,eAAgC,CAAC;EACvC,KAAK,MAAM,QAAQ,OACjB,IAAI,cAAc,IAAI,GAAG;GACvB,IAAI,KAAK,SAAS,sBAAsB,QAAQ,QAG9C,KAAK,iBAAiB;GAExB,aAAa,KAAK,IAAI;EACxB,OAAO,IAAI,aAAa,IAAI,GAAG;GAC7B,MAAM,iBAAiB,KAAK,SAAS;GACrC,aAAa,KAAK;IAChB,MAAM;IACN,MAAM,eAAe;IACrB,aAAa,eAAe;IAC5B,QAAQ,eAAe;GACzB,CAAkB;EACpB,OAAO,IAAIA,aAAqB,IAAI,GAAG;GACrC,MAAM,QAAiC,CAAC;GACxC,KAAK,MAAM,CAAC,GAAG,MAAM,OAAO,QAAQ,IAAI,GACtC,IAAI,MAAM,UAAU,MAAM,YACxB,MAAM,KAAK;GAGf,aAAa,KAAK;IAChB,MAAM;IACN,MAAM,KAAK,SAAS;IACpB,YAAY,KAAK,SAAS;IAC1B,aAAa,KAAK,SAAS;IAC3B,QAAQ,QAAQ,UAAU;IAC1B,GAAG;GACL,CAAC;EACH,OAAO,IAAI,mBAAmB,IAAI,GAChC,aAAa,KAAK,6BAA6B,IAAI,CAAC;EAGxD,OAAO;CACT;AACF"}
|
|
@@ -180,8 +180,9 @@ const convertCompletionsMessageToBaseMessage = ({ message, rawResponse, includeR
|
|
|
180
180
|
...rawResponse.system_fingerprint ? { system_fingerprint: rawResponse.system_fingerprint } : {}
|
|
181
181
|
};
|
|
182
182
|
if (message.audio) additional_kwargs.audio = message.audio;
|
|
183
|
+
const content = require_output.handleMultiModalOutput(message.content || "", rawResponse.choices?.[0]?.message);
|
|
183
184
|
return new _langchain_core_messages.AIMessage({
|
|
184
|
-
content
|
|
185
|
+
content,
|
|
185
186
|
tool_calls: toolCalls,
|
|
186
187
|
invalid_tool_calls: invalidToolCalls,
|
|
187
188
|
additional_kwargs,
|
|
@@ -470,6 +471,7 @@ const convertStandardContentMessageToCompletionsMessage = ({ message, model }) =
|
|
|
470
471
|
};
|
|
471
472
|
if (_langchain_core_messages.AIMessage.isInstance(message) && !!message.tool_calls?.length) completionParam.tool_calls = message.tool_calls.map(_langchain_core_output_parsers_openai_tools.convertLangChainToolCallToOpenAI);
|
|
472
473
|
else if (message.additional_kwargs.tool_calls != null) completionParam.tool_calls = message.additional_kwargs.tool_calls;
|
|
474
|
+
if (Array.isArray(completionParam.content) && completionParam.content.length === 0 && completionParam.tool_calls != null) completionParam.content = null;
|
|
473
475
|
return completionParam;
|
|
474
476
|
} else if (role === "tool" && _langchain_core_messages.ToolMessage.isInstance(message)) return {
|
|
475
477
|
role: "tool",
|