@langchain/openai 0.6.16 → 1.0.0-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (163) hide show
  1. package/README.md +8 -8
  2. package/dist/_virtual/rolldown_runtime.cjs +25 -0
  3. package/dist/azure/chat_models.cjs +661 -808
  4. package/dist/azure/chat_models.cjs.map +1 -0
  5. package/dist/azure/chat_models.d.cts +449 -0
  6. package/dist/azure/chat_models.d.cts.map +1 -0
  7. package/dist/azure/chat_models.d.ts +32 -28
  8. package/dist/azure/chat_models.d.ts.map +1 -0
  9. package/dist/azure/chat_models.js +660 -804
  10. package/dist/azure/chat_models.js.map +1 -0
  11. package/dist/azure/embeddings.cjs +81 -130
  12. package/dist/azure/embeddings.cjs.map +1 -0
  13. package/dist/azure/embeddings.d.cts +27 -0
  14. package/dist/azure/embeddings.d.cts.map +1 -0
  15. package/dist/azure/embeddings.d.ts +25 -20
  16. package/dist/azure/embeddings.d.ts.map +1 -0
  17. package/dist/azure/embeddings.js +80 -126
  18. package/dist/azure/embeddings.js.map +1 -0
  19. package/dist/azure/llms.cjs +109 -168
  20. package/dist/azure/llms.cjs.map +1 -0
  21. package/dist/azure/llms.d.cts +33 -0
  22. package/dist/azure/llms.d.cts.map +1 -0
  23. package/dist/azure/llms.d.ts +31 -25
  24. package/dist/azure/llms.d.ts.map +1 -0
  25. package/dist/azure/llms.js +108 -164
  26. package/dist/azure/llms.js.map +1 -0
  27. package/dist/chat_models.cjs +1959 -2789
  28. package/dist/chat_models.cjs.map +1 -0
  29. package/dist/chat_models.d.cts +931 -0
  30. package/dist/chat_models.d.cts.map +1 -0
  31. package/dist/chat_models.d.ts +367 -351
  32. package/dist/chat_models.d.ts.map +1 -0
  33. package/dist/chat_models.js +1954 -2779
  34. package/dist/chat_models.js.map +1 -0
  35. package/dist/embeddings.cjs +140 -206
  36. package/dist/embeddings.cjs.map +1 -0
  37. package/dist/embeddings.d.cts +120 -0
  38. package/dist/embeddings.d.cts.map +1 -0
  39. package/dist/embeddings.d.ts +93 -86
  40. package/dist/embeddings.d.ts.map +1 -0
  41. package/dist/embeddings.js +138 -201
  42. package/dist/embeddings.js.map +1 -0
  43. package/dist/index.cjs +47 -34
  44. package/dist/index.d.cts +16 -0
  45. package/dist/index.d.ts +16 -13
  46. package/dist/index.js +17 -13
  47. package/dist/langchain-core/dist/types/_internal.d.cts +11 -0
  48. package/dist/langchain-core/dist/types/_internal.d.cts.map +1 -0
  49. package/dist/langchain-core/dist/types/_internal.d.ts +11 -0
  50. package/dist/langchain-core/dist/types/_internal.d.ts.map +1 -0
  51. package/dist/langchain-core/dist/utils/stream.d.cts +26 -0
  52. package/dist/langchain-core/dist/utils/stream.d.cts.map +1 -0
  53. package/dist/langchain-core/dist/utils/stream.d.ts +26 -0
  54. package/dist/langchain-core/dist/utils/stream.d.ts.map +1 -0
  55. package/dist/llms.cjs +312 -468
  56. package/dist/llms.cjs.map +1 -0
  57. package/dist/llms.d.cts +123 -0
  58. package/dist/llms.d.cts.map +1 -0
  59. package/dist/llms.d.ts +93 -87
  60. package/dist/llms.d.ts.map +1 -0
  61. package/dist/llms.js +309 -462
  62. package/dist/llms.js.map +1 -0
  63. package/dist/tools/custom.cjs +25 -26
  64. package/dist/tools/custom.cjs.map +1 -0
  65. package/dist/tools/custom.d.cts +10 -0
  66. package/dist/tools/custom.d.cts.map +1 -0
  67. package/dist/tools/custom.d.ts +8 -3
  68. package/dist/tools/custom.d.ts.map +1 -0
  69. package/dist/tools/custom.js +24 -23
  70. package/dist/tools/custom.js.map +1 -0
  71. package/dist/tools/dalle.cjs +104 -194
  72. package/dist/tools/dalle.cjs.map +1 -0
  73. package/dist/tools/dalle.d.cts +123 -0
  74. package/dist/tools/dalle.d.cts.map +1 -0
  75. package/dist/tools/dalle.d.ts +111 -104
  76. package/dist/tools/dalle.d.ts.map +1 -0
  77. package/dist/tools/dalle.js +102 -189
  78. package/dist/tools/dalle.js.map +1 -0
  79. package/dist/tools/index.cjs +1 -17
  80. package/dist/tools/index.js +1 -1
  81. package/dist/types.d.cts +263 -0
  82. package/dist/types.d.cts.map +1 -0
  83. package/dist/types.d.ts +244 -246
  84. package/dist/types.d.ts.map +1 -0
  85. package/dist/utils/azure.cjs +86 -47
  86. package/dist/utils/azure.cjs.map +1 -0
  87. package/dist/utils/azure.d.cts +76 -0
  88. package/dist/utils/azure.d.cts.map +1 -0
  89. package/dist/utils/azure.d.ts +51 -9
  90. package/dist/utils/azure.d.ts.map +1 -0
  91. package/dist/utils/azure.js +85 -45
  92. package/dist/utils/azure.js.map +1 -0
  93. package/dist/utils/client.cjs +25 -0
  94. package/dist/utils/client.cjs.map +1 -0
  95. package/dist/utils/client.d.cts +5 -0
  96. package/dist/utils/client.d.cts.map +1 -0
  97. package/dist/utils/client.d.ts +5 -0
  98. package/dist/utils/client.d.ts.map +1 -0
  99. package/dist/utils/client.js +24 -0
  100. package/dist/utils/client.js.map +1 -0
  101. package/dist/utils/errors.cjs +9 -8
  102. package/dist/utils/errors.cjs.map +1 -0
  103. package/dist/utils/errors.js +9 -6
  104. package/dist/utils/errors.js.map +1 -0
  105. package/dist/utils/message_inputs.cjs +139 -0
  106. package/dist/utils/message_inputs.cjs.map +1 -0
  107. package/dist/utils/message_inputs.d.cts +9 -0
  108. package/dist/utils/message_inputs.d.cts.map +1 -0
  109. package/dist/utils/message_inputs.d.ts +9 -0
  110. package/dist/utils/message_inputs.d.ts.map +1 -0
  111. package/dist/utils/message_inputs.js +137 -0
  112. package/dist/utils/message_inputs.js.map +1 -0
  113. package/dist/utils/misc.cjs +32 -0
  114. package/dist/utils/misc.cjs.map +1 -0
  115. package/dist/utils/misc.d.cts +9 -0
  116. package/dist/utils/misc.d.cts.map +1 -0
  117. package/dist/utils/misc.d.ts +9 -0
  118. package/dist/utils/misc.d.ts.map +1 -0
  119. package/dist/utils/misc.js +29 -0
  120. package/dist/utils/misc.js.map +1 -0
  121. package/dist/utils/output.cjs +106 -45
  122. package/dist/utils/output.cjs.map +1 -0
  123. package/dist/utils/output.js +104 -43
  124. package/dist/utils/output.js.map +1 -0
  125. package/dist/utils/prompts.cjs +39 -38
  126. package/dist/utils/prompts.cjs.map +1 -0
  127. package/dist/utils/prompts.d.cts +42 -0
  128. package/dist/utils/prompts.d.cts.map +1 -0
  129. package/dist/utils/prompts.d.ts +10 -4
  130. package/dist/utils/prompts.d.ts.map +1 -0
  131. package/dist/utils/prompts.js +40 -36
  132. package/dist/utils/prompts.js.map +1 -0
  133. package/dist/utils/standard.cjs +315 -0
  134. package/dist/utils/standard.cjs.map +1 -0
  135. package/dist/utils/standard.js +313 -0
  136. package/dist/utils/standard.js.map +1 -0
  137. package/dist/utils/tools.cjs +150 -127
  138. package/dist/utils/tools.cjs.map +1 -0
  139. package/dist/utils/tools.d.cts +13 -0
  140. package/dist/utils/tools.d.cts.map +1 -0
  141. package/dist/utils/tools.d.ts +12 -42
  142. package/dist/utils/tools.d.ts.map +1 -0
  143. package/dist/utils/tools.js +146 -123
  144. package/dist/utils/tools.js.map +1 -0
  145. package/package.json +51 -60
  146. package/dist/tools/index.d.ts +0 -1
  147. package/dist/types.cjs +0 -2
  148. package/dist/types.js +0 -1
  149. package/dist/utils/errors.d.ts +0 -2
  150. package/dist/utils/headers.cjs +0 -39
  151. package/dist/utils/headers.d.ts +0 -8
  152. package/dist/utils/headers.js +0 -35
  153. package/dist/utils/openai-format-fndef.cjs +0 -80
  154. package/dist/utils/openai-format-fndef.d.ts +0 -44
  155. package/dist/utils/openai-format-fndef.js +0 -77
  156. package/dist/utils/openai.cjs +0 -127
  157. package/dist/utils/openai.d.ts +0 -15
  158. package/dist/utils/openai.js +0 -119
  159. package/dist/utils/output.d.ts +0 -11
  160. package/index.cjs +0 -1
  161. package/index.d.cts +0 -1
  162. package/index.d.ts +0 -1
  163. package/index.js +0 -1
@@ -1,287 +1,301 @@
1
- import { type ClientOptions, OpenAI as OpenAIClient } from "openai";
2
- import { CallbackManagerForLLMRun } from "@langchain/core/callbacks/manager";
3
- import { AIMessageChunk, type BaseMessage, ChatMessageChunk, FunctionMessageChunk, HumanMessageChunk, SystemMessageChunk, ToolMessageChunk } from "@langchain/core/messages";
4
- import { ChatGenerationChunk, type ChatGeneration, type ChatResult } from "@langchain/core/outputs";
5
- import { BaseChatModel, type LangSmithParams, type BaseChatModelParams } from "@langchain/core/language_models/chat_models";
6
- import { type BaseFunctionCallOptions, type BaseLanguageModelInput, type StructuredOutputMethodOptions } from "@langchain/core/language_models/base";
1
+ import { IterableReadableStream } from "./langchain-core/dist/utils/stream.js";
2
+ import { ChatOpenAIReasoningSummary, ChatOpenAIResponseFormat, OpenAICallOptions, OpenAIChatInput, OpenAICoreRequestOptions, OpenAIVerbosityParam, ResponseFormatConfiguration } from "./types.js";
3
+ import { ChatOpenAIToolType, OpenAIToolChoice, ResponsesTool, ResponsesToolChoice } from "./utils/tools.js";
4
+ import { ClientOptions, OpenAI as OpenAI$1 } from "openai";
5
+ import * as _langchain_core_messages0 from "@langchain/core/messages";
6
+ import { AIMessageChunk, BaseMessage, ChatMessageChunk, FunctionMessageChunk, HumanMessageChunk, SystemMessageChunk, ToolMessageChunk } from "@langchain/core/messages";
7
+ import { ChatGeneration, ChatGenerationChunk, ChatResult } from "@langchain/core/outputs";
8
+ import { BaseChatModel, BaseChatModelParams, LangSmithParams } from "@langchain/core/language_models/chat_models";
9
+ import { BaseFunctionCallOptions, BaseLanguageModelInput, StructuredOutputMethodOptions } from "@langchain/core/language_models/base";
7
10
  import { Runnable } from "@langchain/core/runnables";
8
11
  import { InteropZodType } from "@langchain/core/utils/types";
9
- import { type OpenAICallOptions, type OpenAIChatInput, type OpenAICoreRequestOptions, type ChatOpenAIResponseFormat, ChatOpenAIReasoningSummary, ResponseFormatConfiguration, OpenAIVerbosityParam } from "./types.js";
10
- import { OpenAIToolChoice } from "./utils/openai.js";
11
- import { ChatOpenAIToolType, ResponsesTool, ResponsesToolChoice } from "./utils/tools.js";
12
+ import { CallbackManagerForLLMRun } from "@langchain/core/callbacks/manager";
13
+
14
+ //#region src/chat_models.d.ts
12
15
  interface OpenAILLMOutput {
13
- tokenUsage: {
14
- completionTokens?: number;
15
- promptTokens?: number;
16
- totalTokens?: number;
17
- };
16
+ tokenUsage: {
17
+ completionTokens?: number;
18
+ promptTokens?: number;
19
+ totalTokens?: number;
20
+ };
18
21
  }
19
- export type { OpenAICallOptions, OpenAIChatInput };
20
- export declare function messageToOpenAIRole(message: BaseMessage): OpenAIClient.ChatCompletionRole;
21
- export declare function _convertMessagesToOpenAIParams(messages: BaseMessage[], model?: string): OpenAIClient.Chat.Completions.ChatCompletionMessageParam[];
22
- export interface BaseChatOpenAICallOptions extends OpenAICallOptions, BaseFunctionCallOptions {
23
- /**
24
- * A list of tools that the model may use to generate responses.
25
- * Each tool can be a function, a built-in tool, or a custom tool definition.
26
- * If not provided, the model will not use any tools.
27
- */
28
- tools?: ChatOpenAIToolType[];
29
- /**
30
- * Specifies which tool the model should use to respond.
31
- * Can be an {@link OpenAIToolChoice} or a {@link ResponsesToolChoice}.
32
- * If not set, the model will decide which tool to use automatically.
33
- */
34
- tool_choice?: OpenAIToolChoice | ResponsesToolChoice;
35
- /**
36
- * Adds a prompt index to prompts passed to the model to track
37
- * what prompt is being used for a given generation.
38
- */
39
- promptIndex?: number;
40
- /**
41
- * An object specifying the format that the model must output.
42
- */
43
- response_format?: ChatOpenAIResponseFormat;
44
- /**
45
- * When provided, the completions API will make a best effort to sample
46
- * deterministically, such that repeated requests with the same `seed`
47
- * and parameters should return the same result.
48
- */
49
- seed?: number;
50
- /**
51
- * Additional options to pass to streamed completions.
52
- * If provided, this takes precedence over "streamUsage" set at
53
- * initialization time.
54
- */
55
- stream_options?: OpenAIClient.Chat.ChatCompletionStreamOptions;
56
- /**
57
- * The model may choose to call multiple functions in a single turn. You can
58
- * set parallel_tool_calls to false which ensures only one tool is called at most.
59
- * [Learn more](https://platform.openai.com/docs/guides/function-calling#parallel-function-calling)
60
- */
61
- parallel_tool_calls?: boolean;
62
- /**
63
- * If `true`, model output is guaranteed to exactly match the JSON Schema
64
- * provided in the tool definition. If `true`, the input schema will also be
65
- * validated according to
66
- * https://platform.openai.com/docs/guides/structured-outputs/supported-schemas.
67
- *
68
- * If `false`, input schema will not be validated and model output will not
69
- * be validated.
70
- *
71
- * If `undefined`, `strict` argument will not be passed to the model.
72
- */
73
- strict?: boolean;
74
- /**
75
- * Output types that you would like the model to generate for this request. Most
76
- * models are capable of generating text, which is the default:
77
- *
78
- * `["text"]`
79
- *
80
- * The `gpt-4o-audio-preview` model can also be used to
81
- * [generate audio](https://platform.openai.com/docs/guides/audio). To request that
82
- * this model generate both text and audio responses, you can use:
83
- *
84
- * `["text", "audio"]`
85
- */
86
- modalities?: Array<OpenAIClient.Chat.ChatCompletionModality>;
87
- /**
88
- * Parameters for audio output. Required when audio output is requested with
89
- * `modalities: ["audio"]`.
90
- * [Learn more](https://platform.openai.com/docs/guides/audio).
91
- */
92
- audio?: OpenAIClient.Chat.ChatCompletionAudioParam;
93
- /**
94
- * Static predicted output content, such as the content of a text file that is being regenerated.
95
- * [Learn more](https://platform.openai.com/docs/guides/latency-optimization#use-predicted-outputs).
96
- */
97
- prediction?: OpenAIClient.ChatCompletionPredictionContent;
98
- /**
99
- * Options for reasoning models.
100
- *
101
- * Note that some options, like reasoning summaries, are only available when using the responses
102
- * API. If these options are set, the responses API will be used to fulfill the request.
103
- *
104
- * These options will be ignored when not using a reasoning model.
105
- */
106
- reasoning?: OpenAIClient.Reasoning;
107
- /**
108
- * Service tier to use for this request. Can be "auto", "default", or "flex"
109
- * Specifies the service tier for prioritization and latency optimization.
110
- */
111
- service_tier?: OpenAIClient.Chat.ChatCompletionCreateParams["service_tier"];
112
- /**
113
- * Used by OpenAI to cache responses for similar requests to optimize your cache
114
- * hit rates. Replaces the `user` field.
115
- * [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
116
- */
117
- promptCacheKey?: string;
118
- /**
119
- * The verbosity of the model's response.
120
- */
121
- verbosity?: OpenAIVerbosityParam;
22
+ interface BaseChatOpenAICallOptions extends OpenAICallOptions, BaseFunctionCallOptions {
23
+ /**
24
+ * A list of tools that the model may use to generate responses.
25
+ * Each tool can be a function, a built-in tool, or a custom tool definition.
26
+ * If not provided, the model will not use any tools.
27
+ */
28
+ tools?: ChatOpenAIToolType[];
29
+ /**
30
+ * Specifies which tool the model should use to respond.
31
+ * Can be an {@link OpenAIToolChoice} or a {@link ResponsesToolChoice}.
32
+ * If not set, the model will decide which tool to use automatically.
33
+ */
34
+ // TODO: break OpenAIToolChoice and ResponsesToolChoice into options sub classes
35
+ tool_choice?: OpenAIToolChoice | ResponsesToolChoice;
36
+ /**
37
+ * Adds a prompt index to prompts passed to the model to track
38
+ * what prompt is being used for a given generation.
39
+ */
40
+ promptIndex?: number;
41
+ /**
42
+ * An object specifying the format that the model must output.
43
+ */
44
+ response_format?: ChatOpenAIResponseFormat;
45
+ /**
46
+ * When provided, the completions API will make a best effort to sample
47
+ * deterministically, such that repeated requests with the same `seed`
48
+ * and parameters should return the same result.
49
+ */
50
+ seed?: number;
51
+ /**
52
+ * Additional options to pass to streamed completions.
53
+ * If provided, this takes precedence over "streamUsage" set at
54
+ * initialization time.
55
+ */
56
+ stream_options?: OpenAI$1.Chat.ChatCompletionStreamOptions;
57
+ /**
58
+ * The model may choose to call multiple functions in a single turn. You can
59
+ * set parallel_tool_calls to false which ensures only one tool is called at most.
60
+ * [Learn more](https://platform.openai.com/docs/guides/function-calling#parallel-function-calling)
61
+ */
62
+ parallel_tool_calls?: boolean;
63
+ /**
64
+ * If `true`, model output is guaranteed to exactly match the JSON Schema
65
+ * provided in the tool definition. If `true`, the input schema will also be
66
+ * validated according to
67
+ * https://platform.openai.com/docs/guides/structured-outputs/supported-schemas.
68
+ *
69
+ * If `false`, input schema will not be validated and model output will not
70
+ * be validated.
71
+ *
72
+ * If `undefined`, `strict` argument will not be passed to the model.
73
+ */
74
+ strict?: boolean;
75
+ /**
76
+ * Output types that you would like the model to generate for this request. Most
77
+ * models are capable of generating text, which is the default:
78
+ *
79
+ * `["text"]`
80
+ *
81
+ * The `gpt-4o-audio-preview` model can also be used to
82
+ * [generate audio](https://platform.openai.com/docs/guides/audio). To request that
83
+ * this model generate both text and audio responses, you can use:
84
+ *
85
+ * `["text", "audio"]`
86
+ */
87
+ modalities?: Array<OpenAI$1.Chat.ChatCompletionModality>;
88
+ /**
89
+ * Parameters for audio output. Required when audio output is requested with
90
+ * `modalities: ["audio"]`.
91
+ * [Learn more](https://platform.openai.com/docs/guides/audio).
92
+ */
93
+ audio?: OpenAI$1.Chat.ChatCompletionAudioParam;
94
+ /**
95
+ * Static predicted output content, such as the content of a text file that is being regenerated.
96
+ * [Learn more](https://platform.openai.com/docs/guides/latency-optimization#use-predicted-outputs).
97
+ */
98
+ prediction?: OpenAI$1.ChatCompletionPredictionContent;
99
+ /**
100
+ * Options for reasoning models.
101
+ *
102
+ * Note that some options, like reasoning summaries, are only available when using the responses
103
+ * API. If these options are set, the responses API will be used to fulfill the request.
104
+ *
105
+ * These options will be ignored when not using a reasoning model.
106
+ */
107
+ reasoning?: OpenAI$1.Reasoning;
108
+ /**
109
+ * Service tier to use for this request. Can be "auto", "default", or "flex"
110
+ * Specifies the service tier for prioritization and latency optimization.
111
+ */
112
+ service_tier?: OpenAI$1.Chat.ChatCompletionCreateParams["service_tier"];
113
+ /**
114
+ * Used by OpenAI to cache responses for similar requests to optimize your cache
115
+ * hit rates. Replaces the `user` field.
116
+ * [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
117
+ */
118
+ promptCacheKey?: string;
119
+ /**
120
+ * The verbosity of the model's response.
121
+ */
122
+ verbosity?: OpenAIVerbosityParam;
122
123
  }
123
- export interface BaseChatOpenAIFields extends Partial<OpenAIChatInput>, BaseChatModelParams {
124
- /**
125
- * Optional configuration options for the OpenAI client.
126
- */
127
- configuration?: ClientOptions;
124
+ interface BaseChatOpenAIFields extends Partial<OpenAIChatInput>, BaseChatModelParams {
125
+ /**
126
+ * Optional configuration options for the OpenAI client.
127
+ */
128
+ configuration?: ClientOptions;
128
129
  }
129
130
  /** @internal */
130
- export declare abstract class BaseChatOpenAI<CallOptions extends BaseChatOpenAICallOptions> extends BaseChatModel<CallOptions, AIMessageChunk> implements Partial<OpenAIChatInput> {
131
- temperature?: number;
132
- topP?: number;
133
- frequencyPenalty?: number;
134
- presencePenalty?: number;
135
- n?: number;
136
- logitBias?: Record<string, number>;
137
- model: string;
138
- modelKwargs?: OpenAIChatInput["modelKwargs"];
139
- stop?: string[];
140
- stopSequences?: string[];
141
- user?: string;
142
- timeout?: number;
143
- streaming: boolean;
144
- streamUsage: boolean;
145
- maxTokens?: number;
146
- logprobs?: boolean;
147
- topLogprobs?: number;
148
- apiKey?: string;
149
- organization?: string;
150
- __includeRawResponse?: boolean;
151
- /** @internal */
152
- client: OpenAIClient;
153
- /** @internal */
154
- clientConfig: ClientOptions;
155
- /**
156
- * Whether the model supports the `strict` argument when passing in tools.
157
- * If `undefined` the `strict` argument will not be passed to OpenAI.
158
- */
159
- supportsStrictToolCalling?: boolean;
160
- audio?: OpenAIClient.Chat.ChatCompletionAudioParam;
161
- modalities?: Array<OpenAIClient.Chat.ChatCompletionModality>;
162
- reasoning?: OpenAIClient.Reasoning;
163
- /**
164
- * Must be set to `true` in tenancies with Zero Data Retention. Setting to `true` will disable
165
- * output storage in the Responses API, but this DOES NOT enable Zero Data Retention in your
166
- * OpenAI organization or project. This must be configured directly with OpenAI.
167
- *
168
- * See:
169
- * https://platform.openai.com/docs/guides/your-data
170
- * https://platform.openai.com/docs/api-reference/responses/create#responses-create-store
171
- *
172
- * @default false
173
- */
174
- zdrEnabled?: boolean | undefined;
175
- /**
176
- * Service tier to use for this request. Can be "auto", "default", or "flex" or "priority".
177
- * Specifies the service tier for prioritization and latency optimization.
178
- */
179
- service_tier?: OpenAIClient.Chat.ChatCompletionCreateParams["service_tier"];
180
- /**
181
- * Used by OpenAI to cache responses for similar requests to optimize your cache
182
- * hit rates.
183
- * [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
184
- */
185
- promptCacheKey: string;
186
- /**
187
- * The verbosity of the model's response.
188
- */
189
- verbosity?: OpenAIVerbosityParam;
190
- protected defaultOptions: CallOptions;
191
- _llmType(): string;
192
- static lc_name(): string;
193
- get callKeys(): string[];
194
- lc_serializable: boolean;
195
- get lc_secrets(): {
196
- [key: string]: string;
197
- } | undefined;
198
- get lc_aliases(): Record<string, string>;
199
- get lc_serializable_keys(): string[];
200
- getLsParams(options: this["ParsedCallOptions"]): LangSmithParams;
201
- /** @ignore */
202
- _identifyingParams(): Omit<OpenAIClient.Chat.ChatCompletionCreateParams, "messages"> & {
203
- model_name: string;
204
- } & ClientOptions;
205
- /**
206
- * Get the identifying parameters for the model
207
- */
208
- identifyingParams(): Omit<OpenAIClient.Chat.Completions.ChatCompletionCreateParams, "messages"> & {
209
- model_name: string;
210
- } & ClientOptions;
211
- constructor(fields?: BaseChatOpenAIFields);
212
- /**
213
- * Returns backwards compatible reasoning parameters from constructor params and call options
214
- * @internal
215
- */
216
- protected _getReasoningParams(options?: this["ParsedCallOptions"]): OpenAIClient.Reasoning | undefined;
217
- /**
218
- * Returns an openai compatible response format from a set of options
219
- * @internal
220
- */
221
- protected _getResponseFormat(resFormat?: CallOptions["response_format"]): ResponseFormatConfiguration | undefined;
222
- protected _combineCallOptions(additionalOptions?: this["ParsedCallOptions"]): this["ParsedCallOptions"];
223
- /** @internal */
224
- _getClientOptions(options: OpenAICoreRequestOptions | undefined): OpenAICoreRequestOptions;
225
- protected _convertChatOpenAIToolToCompletionsTool(tool: ChatOpenAIToolType, fields?: {
226
- strict?: boolean;
227
- }): OpenAIClient.ChatCompletionTool;
228
- bindTools(tools: ChatOpenAIToolType[], kwargs?: Partial<CallOptions>): Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions>;
229
- stream(input: BaseLanguageModelInput, options?: CallOptions): Promise<import("@langchain/core/utils/stream").IterableReadableStream<AIMessageChunk>>;
230
- invoke(input: BaseLanguageModelInput, options?: CallOptions): Promise<AIMessageChunk>;
231
- /** @ignore */
232
- _combineLLMOutput(...llmOutputs: OpenAILLMOutput[]): OpenAILLMOutput;
233
- getNumTokensFromMessages(messages: BaseMessage[]): Promise<{
234
- totalCount: number;
235
- countPerMessage: number[];
236
- }>;
237
- /** @internal */
238
- protected _getNumTokensFromGenerations(generations: ChatGeneration[]): Promise<number>;
239
- /** @internal */
240
- protected _getEstimatedTokenCountFromPrompt(messages: BaseMessage[], functions?: OpenAIClient.Chat.ChatCompletionCreateParams.Function[], function_call?: "none" | "auto" | OpenAIClient.Chat.ChatCompletionFunctionCallOption): Promise<number>;
241
- /** @internal */
242
- protected _getStructuredOutputMethod(config: StructuredOutputMethodOptions<boolean>): string | undefined;
243
- withStructuredOutput<RunOutput extends Record<string, any> = Record<string, any>>(outputSchema: InteropZodType<RunOutput> | Record<string, any>, config?: StructuredOutputMethodOptions<false>): Runnable<BaseLanguageModelInput, RunOutput>;
244
- withStructuredOutput<RunOutput extends Record<string, any> = Record<string, any>>(outputSchema: InteropZodType<RunOutput> | Record<string, any>, config?: StructuredOutputMethodOptions<true>): Runnable<BaseLanguageModelInput, {
245
- raw: BaseMessage;
246
- parsed: RunOutput;
247
- }>;
248
- withStructuredOutput<RunOutput extends Record<string, any> = Record<string, any>>(outputSchema: InteropZodType<RunOutput> | Record<string, any>, config?: StructuredOutputMethodOptions<boolean>): Runnable<BaseLanguageModelInput, RunOutput> | Runnable<BaseLanguageModelInput, {
249
- raw: BaseMessage;
250
- parsed: RunOutput;
251
- }>;
131
+ declare abstract class BaseChatOpenAI<CallOptions extends BaseChatOpenAICallOptions> extends BaseChatModel<CallOptions, AIMessageChunk> implements Partial<OpenAIChatInput> {
132
+ temperature?: number;
133
+ topP?: number;
134
+ frequencyPenalty?: number;
135
+ presencePenalty?: number;
136
+ n?: number;
137
+ logitBias?: Record<string, number>;
138
+ model: string;
139
+ modelKwargs?: OpenAIChatInput["modelKwargs"];
140
+ stop?: string[];
141
+ stopSequences?: string[];
142
+ user?: string;
143
+ timeout?: number;
144
+ streaming: boolean;
145
+ streamUsage: boolean;
146
+ maxTokens?: number;
147
+ logprobs?: boolean;
148
+ topLogprobs?: number;
149
+ apiKey?: string;
150
+ organization?: string;
151
+ __includeRawResponse?: boolean;
152
+ /** @internal */
153
+ client: OpenAI$1;
154
+ /** @internal */
155
+ clientConfig: ClientOptions;
156
+ /**
157
+ * Whether the model supports the `strict` argument when passing in tools.
158
+ * If `undefined` the `strict` argument will not be passed to OpenAI.
159
+ */
160
+ supportsStrictToolCalling?: boolean;
161
+ audio?: OpenAI$1.Chat.ChatCompletionAudioParam;
162
+ modalities?: Array<OpenAI$1.Chat.ChatCompletionModality>;
163
+ reasoning?: OpenAI$1.Reasoning;
164
+ /**
165
+ * Must be set to `true` in tenancies with Zero Data Retention. Setting to `true` will disable
166
+ * output storage in the Responses API, but this DOES NOT enable Zero Data Retention in your
167
+ * OpenAI organization or project. This must be configured directly with OpenAI.
168
+ *
169
+ * See:
170
+ * https://platform.openai.com/docs/guides/your-data
171
+ * https://platform.openai.com/docs/api-reference/responses/create#responses-create-store
172
+ *
173
+ * @default false
174
+ */
175
+ zdrEnabled?: boolean | undefined;
176
+ /**
177
+ * Service tier to use for this request. Can be "auto", "default", or "flex" or "priority".
178
+ * Specifies the service tier for prioritization and latency optimization.
179
+ */
180
+ service_tier?: OpenAI$1.Chat.ChatCompletionCreateParams["service_tier"];
181
+ /**
182
+ * Used by OpenAI to cache responses for similar requests to optimize your cache
183
+ * hit rates.
184
+ * [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
185
+ */
186
+ promptCacheKey: string;
187
+ /**
188
+ * The verbosity of the model's response.
189
+ */
190
+ verbosity?: OpenAIVerbosityParam;
191
+ protected defaultOptions: CallOptions;
192
+ _llmType(): string;
193
+ static lc_name(): string;
194
+ get callKeys(): string[];
195
+ lc_serializable: boolean;
196
+ get lc_secrets(): {
197
+ [key: string]: string;
198
+ } | undefined;
199
+ get lc_aliases(): Record<string, string>;
200
+ get lc_serializable_keys(): string[];
201
+ getLsParams(options: this["ParsedCallOptions"]): LangSmithParams;
202
+ /** @ignore */
203
+ _identifyingParams(): Omit<OpenAI$1.Chat.ChatCompletionCreateParams, "messages"> & {
204
+ model_name: string;
205
+ } & ClientOptions;
206
+ /**
207
+ * Get the identifying parameters for the model
208
+ */
209
+ identifyingParams(): Omit<OpenAI$1.ChatCompletionCreateParams, "messages"> & {
210
+ model_name: string;
211
+ } & ClientOptions;
212
+ constructor(fields?: BaseChatOpenAIFields);
213
+ /**
214
+ * Returns backwards compatible reasoning parameters from constructor params and call options
215
+ * @internal
216
+ */
217
+ protected _getReasoningParams(options?: this["ParsedCallOptions"]): OpenAI$1.Reasoning | undefined;
218
+ /**
219
+ * Returns an openai compatible response format from a set of options
220
+ * @internal
221
+ */
222
+ protected _getResponseFormat(resFormat?: CallOptions["response_format"]): ResponseFormatConfiguration | undefined;
223
+ protected _combineCallOptions(additionalOptions?: this["ParsedCallOptions"]): this["ParsedCallOptions"];
224
+ /** @internal */
225
+ _getClientOptions(options: OpenAICoreRequestOptions | undefined): OpenAICoreRequestOptions;
226
+ // TODO: move to completions class
227
+ protected _convertChatOpenAIToolToCompletionsTool(tool: ChatOpenAIToolType, fields?: {
228
+ strict?: boolean;
229
+ }): OpenAI$1.ChatCompletionTool;
230
+ bindTools(tools: ChatOpenAIToolType[], kwargs?: Partial<CallOptions>): Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions>;
231
+ stream(input: BaseLanguageModelInput, options?: CallOptions): Promise<IterableReadableStream<AIMessageChunk<_langchain_core_messages0.MessageStructure>>>;
232
+ invoke(input: BaseLanguageModelInput, options?: CallOptions): Promise<AIMessageChunk<_langchain_core_messages0.MessageStructure>>;
233
+ /** @ignore */
234
+ _combineLLMOutput(...llmOutputs: OpenAILLMOutput[]): OpenAILLMOutput;
235
+ getNumTokensFromMessages(messages: BaseMessage[]): Promise<{
236
+ totalCount: number;
237
+ countPerMessage: number[];
238
+ }>;
239
+ /** @internal */
240
+ protected _getNumTokensFromGenerations(generations: ChatGeneration[]): Promise<number>;
241
+ /** @internal */
242
+ protected _getEstimatedTokenCountFromPrompt(messages: BaseMessage[], functions?: OpenAI$1.Chat.ChatCompletionCreateParams.Function[], function_call?: "none" | "auto" | OpenAI$1.Chat.ChatCompletionFunctionCallOption): Promise<number>;
243
+ /** @internal */
244
+ protected _getStructuredOutputMethod(config: StructuredOutputMethodOptions<boolean>): string | undefined;
245
+ withStructuredOutput<
246
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
247
+ RunOutput extends Record<string, any> = Record<string, any>>(outputSchema: InteropZodType<RunOutput>
248
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
249
+ | Record<string, any>, config?: StructuredOutputMethodOptions<false>): Runnable<BaseLanguageModelInput, RunOutput>;
250
+ withStructuredOutput<
251
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
252
+ RunOutput extends Record<string, any> = Record<string, any>>(outputSchema: InteropZodType<RunOutput>
253
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
254
+ | Record<string, any>, config?: StructuredOutputMethodOptions<true>): Runnable<BaseLanguageModelInput, {
255
+ raw: BaseMessage;
256
+ parsed: RunOutput;
257
+ }>;
258
+ withStructuredOutput<
259
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
260
+ RunOutput extends Record<string, any> = Record<string, any>>(outputSchema: InteropZodType<RunOutput>
261
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
262
+ | Record<string, any>, config?: StructuredOutputMethodOptions<boolean>): Runnable<BaseLanguageModelInput, RunOutput> | Runnable<BaseLanguageModelInput, {
263
+ raw: BaseMessage;
264
+ parsed: RunOutput;
265
+ }>;
252
266
  }
267
+ interface ChatOpenAIResponsesCallOptions extends BaseChatOpenAICallOptions {
268
+ /**
269
+ * Configuration options for a text response from the model. Can be plain text or
270
+ * structured JSON data.
271
+ */
272
+ text?: OpenAI$1.Responses.ResponseCreateParams["text"];
273
+ /**
274
+ * The truncation strategy to use for the model response.
275
+ */
276
+ truncation?: OpenAI$1.Responses.ResponseCreateParams["truncation"];
277
+ /**
278
+ * Specify additional output data to include in the model response.
279
+ */
280
+ include?: OpenAI$1.Responses.ResponseCreateParams["include"];
281
+ /**
282
+ * The unique ID of the previous response to the model. Use this to create multi-turn
283
+ * conversations.
284
+ */
285
+ previous_response_id?: OpenAI$1.Responses.ResponseCreateParams["previous_response_id"];
286
+ /**
287
+ * The verbosity of the model's response.
288
+ */
289
+ verbosity?: OpenAIVerbosityParam;
290
+ }
291
+ type ChatResponsesInvocationParams = Omit<OpenAI$1.Responses.ResponseCreateParams, "input">;
253
292
  type ExcludeController<T> = T extends {
254
- controller: unknown;
293
+ controller: unknown;
255
294
  } ? never : T;
256
- type ResponsesCreate = OpenAIClient.Responses["create"];
257
- type ResponsesParse = OpenAIClient.Responses["parse"];
295
+ type ResponsesCreate = OpenAI$1.Responses["create"];
296
+ type ResponsesParse = OpenAI$1.Responses["parse"];
258
297
  type ResponsesCreateInvoke = ExcludeController<Awaited<ReturnType<ResponsesCreate>>>;
259
298
  type ResponsesParseInvoke = ExcludeController<Awaited<ReturnType<ResponsesParse>>>;
260
- export interface ChatOpenAIResponsesCallOptions extends BaseChatOpenAICallOptions {
261
- /**
262
- * Configuration options for a text response from the model. Can be plain text or
263
- * structured JSON data.
264
- */
265
- text?: OpenAIClient.Responses.ResponseCreateParams["text"];
266
- /**
267
- * The truncation strategy to use for the model response.
268
- */
269
- truncation?: OpenAIClient.Responses.ResponseCreateParams["truncation"];
270
- /**
271
- * Specify additional output data to include in the model response.
272
- */
273
- include?: OpenAIClient.Responses.ResponseCreateParams["include"];
274
- /**
275
- * The unique ID of the previous response to the model. Use this to create multi-turn
276
- * conversations.
277
- */
278
- previous_response_id?: OpenAIClient.Responses.ResponseCreateParams["previous_response_id"];
279
- /**
280
- * The verbosity of the model's response.
281
- */
282
- verbosity?: OpenAIVerbosityParam;
283
- }
284
- type ChatResponsesInvocationParams = Omit<OpenAIClient.Responses.ResponseCreateParams, "input">;
285
299
  /**
286
300
  * OpenAI Responses API implementation.
287
301
  *
@@ -289,70 +303,71 @@ type ChatResponsesInvocationParams = Omit<OpenAIClient.Responses.ResponseCreateP
289
303
  *
290
304
  * @internal
291
305
  */
292
- export declare class ChatOpenAIResponses<CallOptions extends ChatOpenAIResponsesCallOptions = ChatOpenAIResponsesCallOptions> extends BaseChatOpenAI<CallOptions> {
293
- invocationParams(options?: this["ParsedCallOptions"]): ChatResponsesInvocationParams;
294
- _generate(messages: BaseMessage[], options: this["ParsedCallOptions"]): Promise<ChatResult>;
295
- _streamResponseChunks(messages: BaseMessage[], options: this["ParsedCallOptions"], runManager?: CallbackManagerForLLMRun): AsyncGenerator<ChatGenerationChunk>;
296
- /**
297
- * Calls the Responses API with retry logic in case of failures.
298
- * @param request The request to send to the OpenAI API.
299
- * @param options Optional configuration for the API call.
300
- * @returns The response from the OpenAI API.
301
- */
302
- completionWithRetry(request: OpenAIClient.Responses.ResponseCreateParamsStreaming, requestOptions?: OpenAIClient.RequestOptions): Promise<AsyncIterable<OpenAIClient.Responses.ResponseStreamEvent>>;
303
- completionWithRetry(request: OpenAIClient.Responses.ResponseCreateParamsNonStreaming, requestOptions?: OpenAIClient.RequestOptions): Promise<OpenAIClient.Responses.Response>;
304
- /** @internal */
305
- protected _convertResponsesMessageToBaseMessage(response: ResponsesCreateInvoke | ResponsesParseInvoke): BaseMessage;
306
- /** @internal */
307
- protected _convertResponsesDeltaToBaseMessageChunk(chunk: OpenAIClient.Responses.ResponseStreamEvent): ChatGenerationChunk | null;
308
- /** @internal */
309
- protected _convertMessagesToResponsesParams(messages: BaseMessage[]): (OpenAIClient.Responses.ResponseReasoningItem | OpenAIClient.Responses.EasyInputMessage | OpenAIClient.Responses.ResponseInputItem.Message | OpenAIClient.Responses.ResponseOutputMessage | OpenAIClient.Responses.ResponseFileSearchToolCall | OpenAIClient.Responses.ResponseComputerToolCall | OpenAIClient.Responses.ResponseInputItem.ComputerCallOutput | OpenAIClient.Responses.ResponseFunctionWebSearch | OpenAIClient.Responses.ResponseFunctionToolCall | OpenAIClient.Responses.ResponseInputItem.FunctionCallOutput | OpenAIClient.Responses.ResponseInputItem.ImageGenerationCall | OpenAIClient.Responses.ResponseCodeInterpreterToolCall | OpenAIClient.Responses.ResponseInputItem.LocalShellCall | OpenAIClient.Responses.ResponseInputItem.LocalShellCallOutput | OpenAIClient.Responses.ResponseInputItem.McpListTools | OpenAIClient.Responses.ResponseInputItem.McpApprovalRequest | OpenAIClient.Responses.ResponseInputItem.McpApprovalResponse | OpenAIClient.Responses.ResponseInputItem.McpCall | OpenAIClient.Responses.ResponseCustomToolCallOutput | OpenAIClient.Responses.ResponseCustomToolCall | OpenAIClient.Responses.ResponseInputItem.ItemReference)[];
310
- /** @internal */
311
- protected _convertReasoningSummary(reasoning: ChatOpenAIReasoningSummary): OpenAIClient.Responses.ResponseReasoningItem;
312
- /** @internal */
313
- protected _reduceChatOpenAITools(tools: ChatOpenAIToolType[], fields: {
314
- stream?: boolean;
315
- strict?: boolean;
316
- }): ResponsesTool[];
317
- }
318
- export interface ChatOpenAICompletionsCallOptions extends BaseChatOpenAICallOptions {
306
+ declare class ChatOpenAIResponses<CallOptions extends ChatOpenAIResponsesCallOptions = ChatOpenAIResponsesCallOptions> extends BaseChatOpenAI<CallOptions> {
307
+ invocationParams(options?: this["ParsedCallOptions"]): ChatResponsesInvocationParams;
308
+ _generate(messages: BaseMessage[], options: this["ParsedCallOptions"]): Promise<ChatResult>;
309
+ _streamResponseChunks(messages: BaseMessage[], options: this["ParsedCallOptions"], runManager?: CallbackManagerForLLMRun): AsyncGenerator<ChatGenerationChunk>;
310
+ /**
311
+ * Calls the Responses API with retry logic in case of failures.
312
+ * @param request The request to send to the OpenAI API.
313
+ * @param options Optional configuration for the API call.
314
+ * @returns The response from the OpenAI API.
315
+ */
316
+ completionWithRetry(request: OpenAI$1.Responses.ResponseCreateParamsStreaming, requestOptions?: OpenAI$1.RequestOptions): Promise<AsyncIterable<OpenAI$1.Responses.ResponseStreamEvent>>;
317
+ completionWithRetry(request: OpenAI$1.Responses.ResponseCreateParamsNonStreaming, requestOptions?: OpenAI$1.RequestOptions): Promise<OpenAI$1.Responses.Response>;
318
+ /** @internal */
319
+ protected _convertResponsesMessageToBaseMessage(response: ResponsesCreateInvoke | ResponsesParseInvoke): BaseMessage;
320
+ /** @internal */
321
+ protected _convertResponsesDeltaToBaseMessageChunk(chunk: OpenAI$1.Responses.ResponseStreamEvent): ChatGenerationChunk | null;
322
+ /** @internal */
323
+ protected _convertMessagesToResponsesParams(messages: BaseMessage[]): any[];
324
+ /** @internal */
325
+ protected _convertReasoningSummary(reasoning: ChatOpenAIReasoningSummary): OpenAI$1.Responses.ResponseReasoningItem;
326
+ /** @internal */
327
+ protected _reduceChatOpenAITools(tools: ChatOpenAIToolType[], fields: {
328
+ stream?: boolean;
329
+ strict?: boolean;
330
+ }): ResponsesTool[];
319
331
  }
320
- type ChatCompletionsInvocationParams = Omit<OpenAIClient.Chat.Completions.ChatCompletionCreateParams, "messages">;
332
+ interface ChatOpenAICompletionsCallOptions extends BaseChatOpenAICallOptions {}
333
+ type ChatCompletionsInvocationParams = Omit<OpenAI$1.Chat.Completions.ChatCompletionCreateParams, "messages">;
321
334
  /**
322
335
  * OpenAI Completions API implementation.
323
336
  * @internal
324
337
  */
325
- export declare class ChatOpenAICompletions<CallOptions extends ChatOpenAICompletionsCallOptions = ChatOpenAICompletionsCallOptions> extends BaseChatOpenAI<CallOptions> {
326
- /** @internal */
327
- invocationParams(options?: this["ParsedCallOptions"], extra?: {
328
- streaming?: boolean;
329
- }): ChatCompletionsInvocationParams;
330
- _generate(messages: BaseMessage[], options: this["ParsedCallOptions"], runManager?: CallbackManagerForLLMRun): Promise<ChatResult>;
331
- _streamResponseChunks(messages: BaseMessage[], options: this["ParsedCallOptions"], runManager?: CallbackManagerForLLMRun): AsyncGenerator<ChatGenerationChunk>;
332
- completionWithRetry(request: OpenAIClient.Chat.ChatCompletionCreateParamsStreaming, requestOptions?: OpenAIClient.RequestOptions): Promise<AsyncIterable<OpenAIClient.Chat.Completions.ChatCompletionChunk>>;
333
- completionWithRetry(request: OpenAIClient.Chat.ChatCompletionCreateParamsNonStreaming, requestOptions?: OpenAIClient.RequestOptions): Promise<OpenAIClient.Chat.Completions.ChatCompletion>;
334
- /** @internal */
335
- protected _convertCompletionsMessageToBaseMessage(message: OpenAIClient.Chat.Completions.ChatCompletionMessage, rawResponse: OpenAIClient.Chat.Completions.ChatCompletion): BaseMessage;
336
- /** @internal */
337
- protected _convertCompletionsDeltaToBaseMessageChunk(delta: Record<string, any>, rawResponse: OpenAIClient.Chat.Completions.ChatCompletionChunk, defaultRole?: OpenAIClient.Chat.ChatCompletionRole): AIMessageChunk | HumanMessageChunk | SystemMessageChunk | FunctionMessageChunk | ToolMessageChunk | ChatMessageChunk;
338
+ declare class ChatOpenAICompletions<CallOptions extends ChatOpenAICompletionsCallOptions = ChatOpenAICompletionsCallOptions> extends BaseChatOpenAI<CallOptions> {
339
+ /** @internal */
340
+ invocationParams(options?: this["ParsedCallOptions"], extra?: {
341
+ streaming?: boolean;
342
+ }): ChatCompletionsInvocationParams;
343
+ _generate(messages: BaseMessage[], options: this["ParsedCallOptions"], runManager?: CallbackManagerForLLMRun): Promise<ChatResult>;
344
+ _streamResponseChunks(messages: BaseMessage[], options: this["ParsedCallOptions"], runManager?: CallbackManagerForLLMRun): AsyncGenerator<ChatGenerationChunk>;
345
+ completionWithRetry(request: OpenAI$1.Chat.ChatCompletionCreateParamsStreaming, requestOptions?: OpenAI$1.RequestOptions): Promise<AsyncIterable<OpenAI$1.Chat.Completions.ChatCompletionChunk>>;
346
+ completionWithRetry(request: OpenAI$1.Chat.ChatCompletionCreateParamsNonStreaming, requestOptions?: OpenAI$1.RequestOptions): Promise<OpenAI$1.Chat.Completions.ChatCompletion>;
347
+ /** @internal */
348
+ protected _convertCompletionsMessageToBaseMessage(message: OpenAI$1.Chat.Completions.ChatCompletionMessage, rawResponse: OpenAI$1.Chat.Completions.ChatCompletion): BaseMessage;
349
+ /** @internal */
350
+ protected _convertCompletionsDeltaToBaseMessageChunk(
351
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
352
+ delta: Record<string, any>, rawResponse: OpenAI$1.Chat.Completions.ChatCompletionChunk, defaultRole?: OpenAI$1.Chat.ChatCompletionRole): AIMessageChunk<_langchain_core_messages0.MessageStructure> | ChatMessageChunk<_langchain_core_messages0.MessageStructure> | FunctionMessageChunk<_langchain_core_messages0.MessageStructure> | HumanMessageChunk<_langchain_core_messages0.MessageStructure> | SystemMessageChunk<_langchain_core_messages0.MessageStructure> | ToolMessageChunk<_langchain_core_messages0.MessageStructure>;
338
353
  }
339
- export type ChatOpenAICallOptions = ChatOpenAICompletionsCallOptions & ChatOpenAIResponsesCallOptions;
340
- export interface ChatOpenAIFields extends BaseChatOpenAIFields {
341
- /**
342
- * Whether to use the responses API for all requests. If `false` the responses API will be used
343
- * only when required in order to fulfill the request.
344
- */
345
- useResponsesApi?: boolean;
346
- /**
347
- * The completions chat instance
348
- * @internal
349
- */
350
- completions?: ChatOpenAICompletions;
351
- /**
352
- * The responses chat instance
353
- * @internal
354
- */
355
- responses?: ChatOpenAIResponses;
354
+ type ChatOpenAICallOptions = ChatOpenAICompletionsCallOptions & ChatOpenAIResponsesCallOptions;
355
+ interface ChatOpenAIFields extends BaseChatOpenAIFields {
356
+ /**
357
+ * Whether to use the responses API for all requests. If `false` the responses API will be used
358
+ * only when required in order to fulfill the request.
359
+ */
360
+ useResponsesApi?: boolean;
361
+ /**
362
+ * The completions chat instance
363
+ * @internal
364
+ */
365
+ completions?: ChatOpenAICompletions;
366
+ /**
367
+ * The responses chat instance
368
+ * @internal
369
+ */
370
+ responses?: ChatOpenAIResponses;
356
371
  }
357
372
  /**
358
373
  * OpenAI chat model integration.
@@ -405,9 +420,7 @@ export interface ChatOpenAIFields extends BaseChatOpenAIFields {
405
420
  * timeout: undefined,
406
421
  * maxRetries: 2,
407
422
  * // apiKey: "...",
408
- * // configuration: {
409
- * // baseURL: "...",
410
- * // }
423
+ * // baseUrl: "...",
411
424
  * // organization: "...",
412
425
  * // other params...
413
426
  * });
@@ -894,22 +907,25 @@ export interface ChatOpenAIFields extends BaseChatOpenAIFields {
894
907
  *
895
908
  * <br />
896
909
  */
897
- export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = ChatOpenAICallOptions> extends BaseChatOpenAI<CallOptions> {
898
- protected fields?: ChatOpenAIFields | undefined;
899
- /**
900
- * Whether to use the responses API for all requests. If `false` the responses API will be used
901
- * only when required in order to fulfill the request.
902
- */
903
- useResponsesApi: boolean;
904
- protected responses: ChatOpenAIResponses;
905
- protected completions: ChatOpenAICompletions;
906
- get lc_serializable_keys(): string[];
907
- constructor(fields?: ChatOpenAIFields | undefined);
908
- protected _useResponsesApi(options: this["ParsedCallOptions"] | undefined): boolean | undefined;
909
- getLsParams(options: this["ParsedCallOptions"]): LangSmithParams;
910
- invocationParams(options?: this["ParsedCallOptions"]): ChatResponsesInvocationParams | ChatCompletionsInvocationParams;
911
- /** @ignore */
912
- _generate(messages: BaseMessage[], options: this["ParsedCallOptions"], runManager?: CallbackManagerForLLMRun): Promise<ChatResult>;
913
- _streamResponseChunks(messages: BaseMessage[], options: this["ParsedCallOptions"], runManager?: CallbackManagerForLLMRun): AsyncGenerator<ChatGenerationChunk>;
914
- withConfig(config: Partial<CallOptions>): Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions>;
910
+ declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = ChatOpenAICallOptions> extends BaseChatOpenAI<CallOptions> {
911
+ protected fields?: ChatOpenAIFields | undefined;
912
+ /**
913
+ * Whether to use the responses API for all requests. If `false` the responses API will be used
914
+ * only when required in order to fulfill the request.
915
+ */
916
+ useResponsesApi: boolean;
917
+ protected responses: ChatOpenAIResponses;
918
+ protected completions: ChatOpenAICompletions;
919
+ get lc_serializable_keys(): string[];
920
+ constructor(fields?: ChatOpenAIFields | undefined);
921
+ protected _useResponsesApi(options: this["ParsedCallOptions"] | undefined): boolean | undefined;
922
+ getLsParams(options: this["ParsedCallOptions"]): LangSmithParams;
923
+ invocationParams(options?: this["ParsedCallOptions"]): ChatCompletionsInvocationParams | ChatResponsesInvocationParams;
924
+ /** @ignore */
925
+ _generate(messages: BaseMessage[], options: this["ParsedCallOptions"], runManager?: CallbackManagerForLLMRun): Promise<ChatResult>;
926
+ _streamResponseChunks(messages: BaseMessage[], options: this["ParsedCallOptions"], runManager?: CallbackManagerForLLMRun): AsyncGenerator<ChatGenerationChunk>;
927
+ withConfig(config: Partial<CallOptions>): Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions>;
915
928
  }
929
+ //#endregion
930
+ export { BaseChatOpenAI, BaseChatOpenAICallOptions, BaseChatOpenAIFields, ChatOpenAI, ChatOpenAICallOptions, ChatOpenAICompletions, ChatOpenAICompletionsCallOptions, ChatOpenAIFields, ChatOpenAIResponses, ChatOpenAIResponsesCallOptions };
931
+ //# sourceMappingURL=chat_models.d.ts.map