@langchain/openai 0.6.8 → 1.0.0-alpha.1

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 (162) 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 +1951 -2763
  28. package/dist/chat_models.cjs.map +1 -0
  29. package/dist/chat_models.d.cts +930 -0
  30. package/dist/chat_models.d.cts.map +1 -0
  31. package/dist/chat_models.d.ts +365 -336
  32. package/dist/chat_models.d.ts.map +1 -0
  33. package/dist/chat_models.js +1946 -2753
  34. package/dist/chat_models.js.map +1 -0
  35. package/dist/embeddings.cjs +136 -193
  36. package/dist/embeddings.cjs.map +1 -0
  37. package/dist/embeddings.d.cts +115 -0
  38. package/dist/embeddings.d.cts.map +1 -0
  39. package/dist/embeddings.d.ts +88 -81
  40. package/dist/embeddings.d.ts.map +1 -0
  41. package/dist/embeddings.js +134 -188
  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 -234
  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 +30 -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 +27 -0
  120. package/dist/utils/misc.js.map +1 -0
  121. package/dist/utils/output.cjs +74 -0
  122. package/dist/utils/output.cjs.map +1 -0
  123. package/dist/utils/output.js +72 -0
  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 +113 -0
  134. package/dist/utils/standard.cjs.map +1 -0
  135. package/dist/utils/standard.js +111 -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 +33 -41
  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/index.cjs +0 -1
  160. package/index.d.cts +0 -1
  161. package/index.d.ts +0 -1
  162. package/index.js +0 -1
@@ -1,816 +1,672 @@
1
- import { AzureOpenAI as AzureOpenAIClient } from "openai";
1
+ import { getEndpoint, normalizeHeaders } from "../utils/azure.js";
2
+ import { ChatOpenAI, ChatOpenAICompletions, ChatOpenAIResponses } from "../chat_models.js";
3
+ import { AzureOpenAI } from "openai";
2
4
  import { getEnv, getEnvironmentVariable } from "@langchain/core/utils/env";
3
- import { ChatOpenAI, ChatOpenAICompletions, ChatOpenAIResponses, } from "../chat_models.js";
4
- import { getEndpoint } from "../utils/azure.js";
5
- import { normalizeHeaders } from "../utils/headers.js";
5
+
6
+ //#region src/azure/chat_models.ts
6
7
  const AZURE_ALIASES = {
7
- openAIApiKey: "openai_api_key",
8
- openAIApiVersion: "openai_api_version",
9
- openAIBasePath: "openai_api_base",
10
- deploymentName: "deployment_name",
11
- azureOpenAIEndpoint: "azure_endpoint",
12
- azureOpenAIApiVersion: "openai_api_version",
13
- azureOpenAIBasePath: "openai_api_base",
14
- azureOpenAIApiDeploymentName: "deployment_name",
15
- };
16
- const AZURE_SECRETS = {
17
- azureOpenAIApiKey: "AZURE_OPENAI_API_KEY",
8
+ openAIApiKey: "openai_api_key",
9
+ openAIApiVersion: "openai_api_version",
10
+ openAIBasePath: "openai_api_base",
11
+ deploymentName: "deployment_name",
12
+ azureOpenAIEndpoint: "azure_endpoint",
13
+ azureOpenAIApiVersion: "openai_api_version",
14
+ azureOpenAIBasePath: "openai_api_base",
15
+ azureOpenAIApiDeploymentName: "deployment_name"
18
16
  };
17
+ const AZURE_SECRETS = { azureOpenAIApiKey: "AZURE_OPENAI_API_KEY" };
19
18
  const AZURE_SERIALIZABLE_KEYS = [
20
- "azureOpenAIApiKey",
21
- "azureOpenAIApiVersion",
22
- "azureOpenAIBasePath",
23
- "azureOpenAIEndpoint",
24
- "azureOpenAIApiInstanceName",
25
- "azureOpenAIApiDeploymentName",
26
- "deploymentName",
27
- "openAIApiKey",
28
- "openAIApiVersion",
19
+ "azureOpenAIApiKey",
20
+ "azureOpenAIApiVersion",
21
+ "azureOpenAIBasePath",
22
+ "azureOpenAIEndpoint",
23
+ "azureOpenAIApiInstanceName",
24
+ "azureOpenAIApiDeploymentName",
25
+ "deploymentName",
26
+ "openAIApiKey",
27
+ "openAIApiVersion"
29
28
  ];
30
29
  function _constructAzureFields(fields) {
31
- this.azureOpenAIApiKey =
32
- fields?.azureOpenAIApiKey ??
33
- fields?.openAIApiKey ??
34
- fields?.apiKey ??
35
- getEnvironmentVariable("AZURE_OPENAI_API_KEY");
36
- this.azureOpenAIApiInstanceName =
37
- fields?.azureOpenAIApiInstanceName ??
38
- getEnvironmentVariable("AZURE_OPENAI_API_INSTANCE_NAME");
39
- this.azureOpenAIApiDeploymentName =
40
- fields?.azureOpenAIApiDeploymentName ??
41
- fields?.deploymentName ??
42
- getEnvironmentVariable("AZURE_OPENAI_API_DEPLOYMENT_NAME");
43
- this.azureOpenAIApiVersion =
44
- fields?.azureOpenAIApiVersion ??
45
- fields?.openAIApiVersion ??
46
- getEnvironmentVariable("AZURE_OPENAI_API_VERSION");
47
- this.azureOpenAIBasePath =
48
- fields?.azureOpenAIBasePath ??
49
- getEnvironmentVariable("AZURE_OPENAI_BASE_PATH");
50
- this.azureOpenAIEndpoint =
51
- fields?.azureOpenAIEndpoint ??
52
- getEnvironmentVariable("AZURE_OPENAI_ENDPOINT");
53
- this.azureADTokenProvider = fields?.azureADTokenProvider;
54
- if (!this.azureOpenAIApiKey && !this.apiKey && !this.azureADTokenProvider) {
55
- throw new Error("Azure OpenAI API key or Token Provider not found");
56
- }
30
+ this.azureOpenAIApiKey = fields?.azureOpenAIApiKey ?? fields?.openAIApiKey ?? fields?.apiKey ?? getEnvironmentVariable("AZURE_OPENAI_API_KEY");
31
+ this.azureOpenAIApiInstanceName = fields?.azureOpenAIApiInstanceName ?? getEnvironmentVariable("AZURE_OPENAI_API_INSTANCE_NAME");
32
+ this.azureOpenAIApiDeploymentName = fields?.azureOpenAIApiDeploymentName ?? fields?.deploymentName ?? getEnvironmentVariable("AZURE_OPENAI_API_DEPLOYMENT_NAME");
33
+ this.azureOpenAIApiVersion = fields?.azureOpenAIApiVersion ?? fields?.openAIApiVersion ?? getEnvironmentVariable("AZURE_OPENAI_API_VERSION");
34
+ this.azureOpenAIBasePath = fields?.azureOpenAIBasePath ?? getEnvironmentVariable("AZURE_OPENAI_BASE_PATH");
35
+ this.azureOpenAIEndpoint = fields?.azureOpenAIEndpoint ?? getEnvironmentVariable("AZURE_OPENAI_ENDPOINT");
36
+ this.azureADTokenProvider = fields?.azureADTokenProvider;
37
+ if (!this.azureOpenAIApiKey && !this.apiKey && !this.azureADTokenProvider) throw new Error("Azure OpenAI API key or Token Provider not found");
57
38
  }
58
39
  function _getAzureClientOptions(options) {
59
- if (!this.client) {
60
- const openAIEndpointConfig = {
61
- azureOpenAIApiDeploymentName: this.azureOpenAIApiDeploymentName,
62
- azureOpenAIApiInstanceName: this.azureOpenAIApiInstanceName,
63
- azureOpenAIApiKey: this.azureOpenAIApiKey,
64
- azureOpenAIBasePath: this.azureOpenAIBasePath,
65
- azureADTokenProvider: this.azureADTokenProvider,
66
- baseURL: this.clientConfig.baseURL,
67
- azureOpenAIEndpoint: this.azureOpenAIEndpoint,
68
- };
69
- const endpoint = getEndpoint(openAIEndpointConfig);
70
- const params = {
71
- ...this.clientConfig,
72
- baseURL: endpoint,
73
- timeout: this.timeout,
74
- maxRetries: 0,
75
- };
76
- if (!this.azureADTokenProvider) {
77
- params.apiKey = openAIEndpointConfig.azureOpenAIApiKey;
78
- }
79
- if (!params.baseURL) {
80
- delete params.baseURL;
81
- }
82
- let env = getEnv();
83
- if (env === "node" || env === "deno") {
84
- env = `(${env}/${process.version}; ${process.platform}; ${process.arch})`;
85
- }
86
- const defaultHeaders = normalizeHeaders(params.defaultHeaders);
87
- params.defaultHeaders = {
88
- ...params.defaultHeaders,
89
- "User-Agent": defaultHeaders["User-Agent"]
90
- ? `langchainjs-azure-openai/2.0.0 (${env})${defaultHeaders["User-Agent"]}`
91
- : `langchainjs-azure-openai/2.0.0 (${env})`,
92
- };
93
- this.client = new AzureOpenAIClient({
94
- apiVersion: this.azureOpenAIApiVersion,
95
- azureADTokenProvider: this.azureADTokenProvider,
96
- deployment: this.azureOpenAIApiDeploymentName,
97
- ...params,
98
- });
99
- }
100
- const requestOptions = {
101
- ...this.clientConfig,
102
- ...options,
103
- };
104
- if (this.azureOpenAIApiKey) {
105
- requestOptions.headers = {
106
- "api-key": this.azureOpenAIApiKey,
107
- ...requestOptions.headers,
108
- };
109
- requestOptions.query = {
110
- "api-version": this.azureOpenAIApiVersion,
111
- ...requestOptions.query,
112
- };
113
- }
114
- return requestOptions;
40
+ if (!this.client) {
41
+ const openAIEndpointConfig = {
42
+ azureOpenAIApiDeploymentName: this.azureOpenAIApiDeploymentName,
43
+ azureOpenAIApiInstanceName: this.azureOpenAIApiInstanceName,
44
+ azureOpenAIApiKey: this.azureOpenAIApiKey,
45
+ azureOpenAIBasePath: this.azureOpenAIBasePath,
46
+ azureADTokenProvider: this.azureADTokenProvider,
47
+ baseURL: this.clientConfig.baseURL,
48
+ azureOpenAIEndpoint: this.azureOpenAIEndpoint
49
+ };
50
+ const endpoint = getEndpoint(openAIEndpointConfig);
51
+ const params = {
52
+ ...this.clientConfig,
53
+ baseURL: endpoint,
54
+ timeout: this.timeout,
55
+ maxRetries: 0
56
+ };
57
+ if (!this.azureADTokenProvider) params.apiKey = openAIEndpointConfig.azureOpenAIApiKey;
58
+ if (!params.baseURL) delete params.baseURL;
59
+ let env = getEnv();
60
+ if (env === "node" || env === "deno") env = `(${env}/${process.version}; ${process.platform}; ${process.arch})`;
61
+ const defaultHeaders = normalizeHeaders(params.defaultHeaders);
62
+ params.defaultHeaders = {
63
+ ...params.defaultHeaders,
64
+ "User-Agent": defaultHeaders["User-Agent"] ? `langchainjs-azure-openai/2.0.0 (${env})${defaultHeaders["User-Agent"]}` : `langchainjs-azure-openai/2.0.0 (${env})`
65
+ };
66
+ this.client = new AzureOpenAI({
67
+ apiVersion: this.azureOpenAIApiVersion,
68
+ azureADTokenProvider: this.azureADTokenProvider,
69
+ deployment: this.azureOpenAIApiDeploymentName,
70
+ ...params
71
+ });
72
+ }
73
+ const requestOptions = {
74
+ ...this.clientConfig,
75
+ ...options
76
+ };
77
+ if (this.azureOpenAIApiKey) {
78
+ requestOptions.headers = {
79
+ "api-key": this.azureOpenAIApiKey,
80
+ ...requestOptions.headers
81
+ };
82
+ requestOptions.query = {
83
+ "api-version": this.azureOpenAIApiVersion,
84
+ ...requestOptions.query
85
+ };
86
+ }
87
+ return requestOptions;
115
88
  }
116
89
  function _serializeAzureChat(input) {
117
- const json = input;
118
- function isRecord(obj) {
119
- return typeof obj === "object" && obj != null;
120
- }
121
- if (isRecord(json) && isRecord(json.kwargs)) {
122
- delete json.kwargs.azure_openai_base_path;
123
- delete json.kwargs.azure_openai_api_deployment_name;
124
- delete json.kwargs.azure_openai_api_key;
125
- delete json.kwargs.azure_openai_api_version;
126
- delete json.kwargs.azure_open_ai_base_path;
127
- if (!json.kwargs.azure_endpoint && this.azureOpenAIEndpoint) {
128
- json.kwargs.azure_endpoint = this.azureOpenAIEndpoint;
129
- }
130
- if (!json.kwargs.azure_endpoint && this.azureOpenAIBasePath) {
131
- const parts = this.azureOpenAIBasePath.split("/openai/deployments/");
132
- if (parts.length === 2 && parts[0].startsWith("http")) {
133
- const [endpoint] = parts;
134
- json.kwargs.azure_endpoint = endpoint;
135
- }
136
- }
137
- if (!json.kwargs.azure_endpoint && this.azureOpenAIApiInstanceName) {
138
- json.kwargs.azure_endpoint = `https://${this.azureOpenAIApiInstanceName}.openai.azure.com/`;
139
- }
140
- if (!json.kwargs.deployment_name && this.azureOpenAIApiDeploymentName) {
141
- json.kwargs.deployment_name = this.azureOpenAIApiDeploymentName;
142
- }
143
- if (!json.kwargs.deployment_name && this.azureOpenAIBasePath) {
144
- const parts = this.azureOpenAIBasePath.split("/openai/deployments/");
145
- if (parts.length === 2) {
146
- const [, deployment] = parts;
147
- json.kwargs.deployment_name = deployment;
148
- }
149
- }
150
- if (json.kwargs.azure_endpoint &&
151
- json.kwargs.deployment_name &&
152
- json.kwargs.openai_api_base) {
153
- delete json.kwargs.openai_api_base;
154
- }
155
- if (json.kwargs.azure_openai_api_instance_name &&
156
- json.kwargs.azure_endpoint) {
157
- delete json.kwargs.azure_openai_api_instance_name;
158
- }
159
- }
160
- return json;
161
- }
162
- class AzureChatOpenAIResponses extends ChatOpenAIResponses {
163
- _llmType() {
164
- return "azure_openai";
165
- }
166
- get lc_aliases() {
167
- return {
168
- ...super.lc_aliases,
169
- ...AZURE_ALIASES,
170
- };
171
- }
172
- get lc_secrets() {
173
- return {
174
- ...super.lc_secrets,
175
- ...AZURE_SECRETS,
176
- };
177
- }
178
- get lc_serializable_keys() {
179
- return [...super.lc_serializable_keys, ...AZURE_SERIALIZABLE_KEYS];
180
- }
181
- getLsParams(options) {
182
- const params = super.getLsParams(options);
183
- params.ls_provider = "azure";
184
- return params;
185
- }
186
- constructor(fields) {
187
- super(fields);
188
- Object.defineProperty(this, "azureOpenAIApiVersion", {
189
- enumerable: true,
190
- configurable: true,
191
- writable: true,
192
- value: void 0
193
- });
194
- Object.defineProperty(this, "azureOpenAIApiKey", {
195
- enumerable: true,
196
- configurable: true,
197
- writable: true,
198
- value: void 0
199
- });
200
- Object.defineProperty(this, "azureADTokenProvider", {
201
- enumerable: true,
202
- configurable: true,
203
- writable: true,
204
- value: void 0
205
- });
206
- Object.defineProperty(this, "azureOpenAIApiInstanceName", {
207
- enumerable: true,
208
- configurable: true,
209
- writable: true,
210
- value: void 0
211
- });
212
- Object.defineProperty(this, "azureOpenAIApiDeploymentName", {
213
- enumerable: true,
214
- configurable: true,
215
- writable: true,
216
- value: void 0
217
- });
218
- Object.defineProperty(this, "azureOpenAIBasePath", {
219
- enumerable: true,
220
- configurable: true,
221
- writable: true,
222
- value: void 0
223
- });
224
- Object.defineProperty(this, "azureOpenAIEndpoint", {
225
- enumerable: true,
226
- configurable: true,
227
- writable: true,
228
- value: void 0
229
- });
230
- _constructAzureFields.call(this, fields);
231
- }
232
- _getClientOptions(options) {
233
- return _getAzureClientOptions.call(this, options);
234
- }
235
- toJSON() {
236
- return _serializeAzureChat.call(this, super.toJSON());
237
- }
238
- }
239
- class AzureChatOpenAICompletions extends ChatOpenAICompletions {
240
- _llmType() {
241
- return "azure_openai";
242
- }
243
- get lc_aliases() {
244
- return {
245
- ...super.lc_aliases,
246
- ...AZURE_ALIASES,
247
- };
248
- }
249
- get lc_secrets() {
250
- return {
251
- ...super.lc_secrets,
252
- ...AZURE_SECRETS,
253
- };
254
- }
255
- get lc_serializable_keys() {
256
- return [...super.lc_serializable_keys, ...AZURE_SERIALIZABLE_KEYS];
257
- }
258
- getLsParams(options) {
259
- const params = super.getLsParams(options);
260
- params.ls_provider = "azure";
261
- return params;
262
- }
263
- constructor(fields) {
264
- super(fields);
265
- Object.defineProperty(this, "azureOpenAIApiVersion", {
266
- enumerable: true,
267
- configurable: true,
268
- writable: true,
269
- value: void 0
270
- });
271
- Object.defineProperty(this, "azureOpenAIApiKey", {
272
- enumerable: true,
273
- configurable: true,
274
- writable: true,
275
- value: void 0
276
- });
277
- Object.defineProperty(this, "azureADTokenProvider", {
278
- enumerable: true,
279
- configurable: true,
280
- writable: true,
281
- value: void 0
282
- });
283
- Object.defineProperty(this, "azureOpenAIApiInstanceName", {
284
- enumerable: true,
285
- configurable: true,
286
- writable: true,
287
- value: void 0
288
- });
289
- Object.defineProperty(this, "azureOpenAIApiDeploymentName", {
290
- enumerable: true,
291
- configurable: true,
292
- writable: true,
293
- value: void 0
294
- });
295
- Object.defineProperty(this, "azureOpenAIBasePath", {
296
- enumerable: true,
297
- configurable: true,
298
- writable: true,
299
- value: void 0
300
- });
301
- Object.defineProperty(this, "azureOpenAIEndpoint", {
302
- enumerable: true,
303
- configurable: true,
304
- writable: true,
305
- value: void 0
306
- });
307
- _constructAzureFields.call(this, fields);
308
- }
309
- _getClientOptions(options) {
310
- return _getAzureClientOptions.call(this, options);
311
- }
312
- toJSON() {
313
- return _serializeAzureChat.call(this, super.toJSON());
314
- }
90
+ const json = input;
91
+ function isRecord(obj) {
92
+ return typeof obj === "object" && obj != null;
93
+ }
94
+ if (isRecord(json) && isRecord(json.kwargs)) {
95
+ delete json.kwargs.azure_openai_base_path;
96
+ delete json.kwargs.azure_openai_api_deployment_name;
97
+ delete json.kwargs.azure_openai_api_key;
98
+ delete json.kwargs.azure_openai_api_version;
99
+ delete json.kwargs.azure_open_ai_base_path;
100
+ if (!json.kwargs.azure_endpoint && this.azureOpenAIEndpoint) json.kwargs.azure_endpoint = this.azureOpenAIEndpoint;
101
+ if (!json.kwargs.azure_endpoint && this.azureOpenAIBasePath) {
102
+ const parts = this.azureOpenAIBasePath.split("/openai/deployments/");
103
+ if (parts.length === 2 && parts[0].startsWith("http")) {
104
+ const [endpoint] = parts;
105
+ json.kwargs.azure_endpoint = endpoint;
106
+ }
107
+ }
108
+ if (!json.kwargs.azure_endpoint && this.azureOpenAIApiInstanceName) json.kwargs.azure_endpoint = `https://${this.azureOpenAIApiInstanceName}.openai.azure.com/`;
109
+ if (!json.kwargs.deployment_name && this.azureOpenAIApiDeploymentName) json.kwargs.deployment_name = this.azureOpenAIApiDeploymentName;
110
+ if (!json.kwargs.deployment_name && this.azureOpenAIBasePath) {
111
+ const parts = this.azureOpenAIBasePath.split("/openai/deployments/");
112
+ if (parts.length === 2) {
113
+ const [, deployment] = parts;
114
+ json.kwargs.deployment_name = deployment;
115
+ }
116
+ }
117
+ if (json.kwargs.azure_endpoint && json.kwargs.deployment_name && json.kwargs.openai_api_base) delete json.kwargs.openai_api_base;
118
+ if (json.kwargs.azure_openai_api_instance_name && json.kwargs.azure_endpoint) delete json.kwargs.azure_openai_api_instance_name;
119
+ }
120
+ return json;
315
121
  }
122
+ var AzureChatOpenAIResponses = class extends ChatOpenAIResponses {
123
+ azureOpenAIApiVersion;
124
+ azureOpenAIApiKey;
125
+ azureADTokenProvider;
126
+ azureOpenAIApiInstanceName;
127
+ azureOpenAIApiDeploymentName;
128
+ azureOpenAIBasePath;
129
+ azureOpenAIEndpoint;
130
+ _llmType() {
131
+ return "azure_openai";
132
+ }
133
+ get lc_aliases() {
134
+ return {
135
+ ...super.lc_aliases,
136
+ ...AZURE_ALIASES
137
+ };
138
+ }
139
+ get lc_secrets() {
140
+ return {
141
+ ...super.lc_secrets,
142
+ ...AZURE_SECRETS
143
+ };
144
+ }
145
+ get lc_serializable_keys() {
146
+ return [...super.lc_serializable_keys, ...AZURE_SERIALIZABLE_KEYS];
147
+ }
148
+ getLsParams(options) {
149
+ const params = super.getLsParams(options);
150
+ params.ls_provider = "azure";
151
+ return params;
152
+ }
153
+ constructor(fields) {
154
+ super(fields);
155
+ _constructAzureFields.call(this, fields);
156
+ }
157
+ _getClientOptions(options) {
158
+ return _getAzureClientOptions.call(this, options);
159
+ }
160
+ toJSON() {
161
+ return _serializeAzureChat.call(this, super.toJSON());
162
+ }
163
+ };
164
+ var AzureChatOpenAICompletions = class extends ChatOpenAICompletions {
165
+ azureOpenAIApiVersion;
166
+ azureOpenAIApiKey;
167
+ azureADTokenProvider;
168
+ azureOpenAIApiInstanceName;
169
+ azureOpenAIApiDeploymentName;
170
+ azureOpenAIBasePath;
171
+ azureOpenAIEndpoint;
172
+ _llmType() {
173
+ return "azure_openai";
174
+ }
175
+ get lc_aliases() {
176
+ return {
177
+ ...super.lc_aliases,
178
+ ...AZURE_ALIASES
179
+ };
180
+ }
181
+ get lc_secrets() {
182
+ return {
183
+ ...super.lc_secrets,
184
+ ...AZURE_SECRETS
185
+ };
186
+ }
187
+ get lc_serializable_keys() {
188
+ return [...super.lc_serializable_keys, ...AZURE_SERIALIZABLE_KEYS];
189
+ }
190
+ getLsParams(options) {
191
+ const params = super.getLsParams(options);
192
+ params.ls_provider = "azure";
193
+ return params;
194
+ }
195
+ constructor(fields) {
196
+ super(fields);
197
+ _constructAzureFields.call(this, fields);
198
+ }
199
+ _getClientOptions(options) {
200
+ return _getAzureClientOptions.call(this, options);
201
+ }
202
+ toJSON() {
203
+ return _serializeAzureChat.call(this, super.toJSON());
204
+ }
205
+ };
316
206
  /**
317
- * Azure OpenAI chat model integration.
318
- *
319
- * Setup:
320
- * Install `@langchain/openai` and set the following environment variables:
321
- *
322
- * ```bash
323
- * npm install @langchain/openai
324
- * export AZURE_OPENAI_API_KEY="your-api-key"
325
- * export AZURE_OPENAI_API_DEPLOYMENT_NAME="your-deployment-name"
326
- * export AZURE_OPENAI_API_VERSION="your-version"
327
- * export AZURE_OPENAI_BASE_PATH="your-base-path"
328
- * ```
329
- *
330
- * ## [Constructor args](https://api.js.langchain.com/classes/langchain_openai.AzureChatOpenAI.html#constructor)
331
- *
332
- * ## [Runtime args](https://api.js.langchain.com/interfaces/langchain_openai.ChatOpenAICallOptions.html)
333
- *
334
- * Runtime args can be passed as the second argument to any of the base runnable methods `.invoke`. `.stream`, `.batch`, etc.
335
- * They can also be passed via `.withConfig`, or the second arg in `.bindTools`, like shown in the examples below:
336
- *
337
- * ```typescript
338
- * // When calling `.withConfig`, call options should be passed via the first argument
339
- * const llmWithArgsBound = llm.withConfig({
340
- * stop: ["\n"],
341
- * tools: [...],
342
- * });
343
- *
344
- * // When calling `.bindTools`, call options should be passed via the second argument
345
- * const llmWithTools = llm.bindTools(
346
- * [...],
347
- * {
348
- * tool_choice: "auto",
349
- * }
350
- * );
351
- * ```
352
- *
353
- * ## Examples
354
- *
355
- * <details open>
356
- * <summary><strong>Instantiate</strong></summary>
357
- *
358
- * ```typescript
359
- * import { AzureChatOpenAI } from '@langchain/openai';
360
- *
361
- * const llm = new AzureChatOpenAI({
362
- * azureOpenAIApiKey: process.env.AZURE_OPENAI_API_KEY, // In Node.js defaults to process.env.AZURE_OPENAI_API_KEY
363
- * azureOpenAIApiInstanceName: process.env.AZURE_OPENAI_API_INSTANCE_NAME, // In Node.js defaults to process.env.AZURE_OPENAI_API_INSTANCE_NAME
364
- * azureOpenAIApiDeploymentName: process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME, // In Node.js defaults to process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME
365
- * azureOpenAIApiVersion: process.env.AZURE_OPENAI_API_VERSION, // In Node.js defaults to process.env.AZURE_OPENAI_API_VERSION
366
- * temperature: 0,
367
- * maxTokens: undefined,
368
- * timeout: undefined,
369
- * maxRetries: 2,
370
- * // apiKey: "...",
371
- * // baseUrl: "...",
372
- * // other params...
373
- * });
374
- * ```
375
- * </details>
376
- *
377
- * <br />
378
- *
379
- * <details>
380
- * <summary><strong>Invoking</strong></summary>
381
- *
382
- * ```typescript
383
- * const input = `Translate "I love programming" into French.`;
384
- *
385
- * // Models also accept a list of chat messages or a formatted prompt
386
- * const result = await llm.invoke(input);
387
- * console.log(result);
388
- * ```
389
- *
390
- * ```txt
391
- * AIMessage {
392
- * "id": "chatcmpl-9u4Mpu44CbPjwYFkTbeoZgvzB00Tz",
393
- * "content": "J'adore la programmation.",
394
- * "response_metadata": {
395
- * "tokenUsage": {
396
- * "completionTokens": 5,
397
- * "promptTokens": 28,
398
- * "totalTokens": 33
399
- * },
400
- * "finish_reason": "stop",
401
- * "system_fingerprint": "fp_3aa7262c27"
402
- * },
403
- * "usage_metadata": {
404
- * "input_tokens": 28,
405
- * "output_tokens": 5,
406
- * "total_tokens": 33
407
- * }
408
- * }
409
- * ```
410
- * </details>
411
- *
412
- * <br />
413
- *
414
- * <details>
415
- * <summary><strong>Streaming Chunks</strong></summary>
416
- *
417
- * ```typescript
418
- * for await (const chunk of await llm.stream(input)) {
419
- * console.log(chunk);
420
- * }
421
- * ```
422
- *
423
- * ```txt
424
- * AIMessageChunk {
425
- * "id": "chatcmpl-9u4NWB7yUeHCKdLr6jP3HpaOYHTqs",
426
- * "content": ""
427
- * }
428
- * AIMessageChunk {
429
- * "content": "J"
430
- * }
431
- * AIMessageChunk {
432
- * "content": "'adore"
433
- * }
434
- * AIMessageChunk {
435
- * "content": " la"
436
- * }
437
- * AIMessageChunk {
438
- * "content": " programmation",,
439
- * }
440
- * AIMessageChunk {
441
- * "content": ".",,
442
- * }
443
- * AIMessageChunk {
444
- * "content": "",
445
- * "response_metadata": {
446
- * "finish_reason": "stop",
447
- * "system_fingerprint": "fp_c9aa9c0491"
448
- * },
449
- * }
450
- * AIMessageChunk {
451
- * "content": "",
452
- * "usage_metadata": {
453
- * "input_tokens": 28,
454
- * "output_tokens": 5,
455
- * "total_tokens": 33
456
- * }
457
- * }
458
- * ```
459
- * </details>
460
- *
461
- * <br />
462
- *
463
- * <details>
464
- * <summary><strong>Aggregate Streamed Chunks</strong></summary>
465
- *
466
- * ```typescript
467
- * import { AIMessageChunk } from '@langchain/core/messages';
468
- * import { concat } from '@langchain/core/utils/stream';
469
- *
470
- * const stream = await llm.stream(input);
471
- * let full: AIMessageChunk | undefined;
472
- * for await (const chunk of stream) {
473
- * full = !full ? chunk : concat(full, chunk);
474
- * }
475
- * console.log(full);
476
- * ```
477
- *
478
- * ```txt
479
- * AIMessageChunk {
480
- * "id": "chatcmpl-9u4PnX6Fy7OmK46DASy0bH6cxn5Xu",
481
- * "content": "J'adore la programmation.",
482
- * "response_metadata": {
483
- * "prompt": 0,
484
- * "completion": 0,
485
- * "finish_reason": "stop",
486
- * },
487
- * "usage_metadata": {
488
- * "input_tokens": 28,
489
- * "output_tokens": 5,
490
- * "total_tokens": 33
491
- * }
492
- * }
493
- * ```
494
- * </details>
495
- *
496
- * <br />
497
- *
498
- * <details>
499
- * <summary><strong>Bind tools</strong></summary>
500
- *
501
- * ```typescript
502
- * import { z } from 'zod';
503
- *
504
- * const GetWeather = {
505
- * name: "GetWeather",
506
- * description: "Get the current weather in a given location",
507
- * schema: z.object({
508
- * location: z.string().describe("The city and state, e.g. San Francisco, CA")
509
- * }),
510
- * }
511
- *
512
- * const GetPopulation = {
513
- * name: "GetPopulation",
514
- * description: "Get the current population in a given location",
515
- * schema: z.object({
516
- * location: z.string().describe("The city and state, e.g. San Francisco, CA")
517
- * }),
518
- * }
519
- *
520
- * const llmWithTools = llm.bindTools([GetWeather, GetPopulation]);
521
- * const aiMsg = await llmWithTools.invoke(
522
- * "Which city is hotter today and which is bigger: LA or NY?"
523
- * );
524
- * console.log(aiMsg.tool_calls);
525
- * ```
526
- *
527
- * ```txt
528
- * [
529
- * {
530
- * name: 'GetWeather',
531
- * args: { location: 'Los Angeles, CA' },
532
- * type: 'tool_call',
533
- * id: 'call_uPU4FiFzoKAtMxfmPnfQL6UK'
534
- * },
535
- * {
536
- * name: 'GetWeather',
537
- * args: { location: 'New York, NY' },
538
- * type: 'tool_call',
539
- * id: 'call_UNkEwuQsHrGYqgDQuH9nPAtX'
540
- * },
541
- * {
542
- * name: 'GetPopulation',
543
- * args: { location: 'Los Angeles, CA' },
544
- * type: 'tool_call',
545
- * id: 'call_kL3OXxaq9OjIKqRTpvjaCH14'
546
- * },
547
- * {
548
- * name: 'GetPopulation',
549
- * args: { location: 'New York, NY' },
550
- * type: 'tool_call',
551
- * id: 'call_s9KQB1UWj45LLGaEnjz0179q'
552
- * }
553
- * ]
554
- * ```
555
- * </details>
556
- *
557
- * <br />
558
- *
559
- * <details>
560
- * <summary><strong>Structured Output</strong></summary>
561
- *
562
- * ```typescript
563
- * import { z } from 'zod';
564
- *
565
- * const Joke = z.object({
566
- * setup: z.string().describe("The setup of the joke"),
567
- * punchline: z.string().describe("The punchline to the joke"),
568
- * rating: z.number().nullable().describe("How funny the joke is, from 1 to 10")
569
- * }).describe('Joke to tell user.');
570
- *
571
- * const structuredLlm = llm.withStructuredOutput(Joke, { name: "Joke" });
572
- * const jokeResult = await structuredLlm.invoke("Tell me a joke about cats");
573
- * console.log(jokeResult);
574
- * ```
575
- *
576
- * ```txt
577
- * {
578
- * setup: 'Why was the cat sitting on the computer?',
579
- * punchline: 'Because it wanted to keep an eye on the mouse!',
580
- * rating: 7
581
- * }
582
- * ```
583
- * </details>
584
- *
585
- * <br />
586
- *
587
- * <details>
588
- * <summary><strong>JSON Object Response Format</strong></summary>
589
- *
590
- * ```typescript
591
- * const jsonLlm = llm.withConfig({ response_format: { type: "json_object" } });
592
- * const jsonLlmAiMsg = await jsonLlm.invoke(
593
- * "Return a JSON object with key 'randomInts' and a value of 10 random ints in [0-99]"
594
- * );
595
- * console.log(jsonLlmAiMsg.content);
596
- * ```
597
- *
598
- * ```txt
599
- * {
600
- * "randomInts": [23, 87, 45, 12, 78, 34, 56, 90, 11, 67]
601
- * }
602
- * ```
603
- * </details>
604
- *
605
- * <br />
606
- *
607
- * <details>
608
- * <summary><strong>Multimodal</strong></summary>
609
- *
610
- * ```typescript
611
- * import { HumanMessage } from '@langchain/core/messages';
612
- *
613
- * const imageUrl = "https://example.com/image.jpg";
614
- * const imageData = await fetch(imageUrl).then(res => res.arrayBuffer());
615
- * const base64Image = Buffer.from(imageData).toString('base64');
616
- *
617
- * const message = new HumanMessage({
618
- * content: [
619
- * { type: "text", text: "describe the weather in this image" },
620
- * {
621
- * type: "image_url",
622
- * image_url: { url: `data:image/jpeg;base64,${base64Image}` },
623
- * },
624
- * ]
625
- * });
626
- *
627
- * const imageDescriptionAiMsg = await llm.invoke([message]);
628
- * console.log(imageDescriptionAiMsg.content);
629
- * ```
630
- *
631
- * ```txt
632
- * The weather in the image appears to be clear and sunny. The sky is mostly blue with a few scattered white clouds, indicating fair weather. The bright sunlight is casting shadows on the green, grassy hill, suggesting it is a pleasant day with good visibility. There are no signs of rain or stormy conditions.
633
- * ```
634
- * </details>
635
- *
636
- * <br />
637
- *
638
- * <details>
639
- * <summary><strong>Usage Metadata</strong></summary>
640
- *
641
- * ```typescript
642
- * const aiMsgForMetadata = await llm.invoke(input);
643
- * console.log(aiMsgForMetadata.usage_metadata);
644
- * ```
645
- *
646
- * ```txt
647
- * { input_tokens: 28, output_tokens: 5, total_tokens: 33 }
648
- * ```
649
- * </details>
650
- *
651
- * <br />
652
- *
653
- * <details>
654
- * <summary><strong>Logprobs</strong></summary>
655
- *
656
- * ```typescript
657
- * const logprobsLlm = new ChatOpenAI({ model: "gpt-4o-mini", logprobs: true });
658
- * const aiMsgForLogprobs = await logprobsLlm.invoke(input);
659
- * console.log(aiMsgForLogprobs.response_metadata.logprobs);
660
- * ```
661
- *
662
- * ```txt
663
- * {
664
- * content: [
665
- * {
666
- * token: 'J',
667
- * logprob: -0.000050616763,
668
- * bytes: [Array],
669
- * top_logprobs: []
670
- * },
671
- * {
672
- * token: "'",
673
- * logprob: -0.01868736,
674
- * bytes: [Array],
675
- * top_logprobs: []
676
- * },
677
- * {
678
- * token: 'ad',
679
- * logprob: -0.0000030545007,
680
- * bytes: [Array],
681
- * top_logprobs: []
682
- * },
683
- * { token: 'ore', logprob: 0, bytes: [Array], top_logprobs: [] },
684
- * {
685
- * token: ' la',
686
- * logprob: -0.515404,
687
- * bytes: [Array],
688
- * top_logprobs: []
689
- * },
690
- * {
691
- * token: ' programm',
692
- * logprob: -0.0000118755715,
693
- * bytes: [Array],
694
- * top_logprobs: []
695
- * },
696
- * { token: 'ation', logprob: 0, bytes: [Array], top_logprobs: [] },
697
- * {
698
- * token: '.',
699
- * logprob: -0.0000037697225,
700
- * bytes: [Array],
701
- * top_logprobs: []
702
- * }
703
- * ],
704
- * refusal: null
705
- * }
706
- * ```
707
- * </details>
708
- *
709
- * <br />
710
- *
711
- * <details>
712
- * <summary><strong>Response Metadata</strong></summary>
713
- *
714
- * ```typescript
715
- * const aiMsgForResponseMetadata = await llm.invoke(input);
716
- * console.log(aiMsgForResponseMetadata.response_metadata);
717
- * ```
718
- *
719
- * ```txt
720
- * {
721
- * tokenUsage: { completionTokens: 5, promptTokens: 28, totalTokens: 33 },
722
- * finish_reason: 'stop',
723
- * system_fingerprint: 'fp_3aa7262c27'
724
- * }
725
- * ```
726
- * </details>
727
- */
728
- export class AzureChatOpenAI extends ChatOpenAI {
729
- _llmType() {
730
- return "azure_openai";
731
- }
732
- get lc_aliases() {
733
- return {
734
- ...super.lc_aliases,
735
- ...AZURE_ALIASES,
736
- };
737
- }
738
- get lc_secrets() {
739
- return {
740
- ...super.lc_secrets,
741
- ...AZURE_SECRETS,
742
- };
743
- }
744
- get lc_serializable_keys() {
745
- return [...super.lc_serializable_keys, ...AZURE_SERIALIZABLE_KEYS];
746
- }
747
- getLsParams(options) {
748
- const params = super.getLsParams(options);
749
- params.ls_provider = "azure";
750
- return params;
751
- }
752
- constructor(fields) {
753
- super({
754
- ...fields,
755
- completions: new AzureChatOpenAICompletions(fields),
756
- responses: new AzureChatOpenAIResponses(fields),
757
- });
758
- Object.defineProperty(this, "azureOpenAIApiVersion", {
759
- enumerable: true,
760
- configurable: true,
761
- writable: true,
762
- value: void 0
763
- });
764
- Object.defineProperty(this, "azureOpenAIApiKey", {
765
- enumerable: true,
766
- configurable: true,
767
- writable: true,
768
- value: void 0
769
- });
770
- Object.defineProperty(this, "azureADTokenProvider", {
771
- enumerable: true,
772
- configurable: true,
773
- writable: true,
774
- value: void 0
775
- });
776
- Object.defineProperty(this, "azureOpenAIApiInstanceName", {
777
- enumerable: true,
778
- configurable: true,
779
- writable: true,
780
- value: void 0
781
- });
782
- Object.defineProperty(this, "azureOpenAIApiDeploymentName", {
783
- enumerable: true,
784
- configurable: true,
785
- writable: true,
786
- value: void 0
787
- });
788
- Object.defineProperty(this, "azureOpenAIBasePath", {
789
- enumerable: true,
790
- configurable: true,
791
- writable: true,
792
- value: void 0
793
- });
794
- Object.defineProperty(this, "azureOpenAIEndpoint", {
795
- enumerable: true,
796
- configurable: true,
797
- writable: true,
798
- value: void 0
799
- });
800
- _constructAzureFields.call(this, fields);
801
- }
802
- /** @internal */
803
- _getStructuredOutputMethod(config) {
804
- const ensuredConfig = { ...config };
805
- // Not all Azure gpt-4o deployments models support jsonSchema yet
806
- if (this.model.startsWith("gpt-4o")) {
807
- if (ensuredConfig?.method === undefined) {
808
- return "functionCalling";
809
- }
810
- }
811
- return super._getStructuredOutputMethod(ensuredConfig);
812
- }
813
- toJSON() {
814
- return _serializeAzureChat.call(this, super.toJSON());
815
- }
816
- }
207
+ * Azure OpenAI chat model integration.
208
+ *
209
+ * Setup:
210
+ * Install `@langchain/openai` and set the following environment variables:
211
+ *
212
+ * ```bash
213
+ * npm install @langchain/openai
214
+ * export AZURE_OPENAI_API_KEY="your-api-key"
215
+ * export AZURE_OPENAI_API_DEPLOYMENT_NAME="your-deployment-name"
216
+ * export AZURE_OPENAI_API_VERSION="your-version"
217
+ * export AZURE_OPENAI_BASE_PATH="your-base-path"
218
+ * ```
219
+ *
220
+ * ## [Constructor args](https://api.js.langchain.com/classes/langchain_openai.AzureChatOpenAI.html#constructor)
221
+ *
222
+ * ## [Runtime args](https://api.js.langchain.com/interfaces/langchain_openai.ChatOpenAICallOptions.html)
223
+ *
224
+ * Runtime args can be passed as the second argument to any of the base runnable methods `.invoke`. `.stream`, `.batch`, etc.
225
+ * They can also be passed via `.withConfig`, or the second arg in `.bindTools`, like shown in the examples below:
226
+ *
227
+ * ```typescript
228
+ * // When calling `.withConfig`, call options should be passed via the first argument
229
+ * const llmWithArgsBound = llm.withConfig({
230
+ * stop: ["\n"],
231
+ * tools: [...],
232
+ * });
233
+ *
234
+ * // When calling `.bindTools`, call options should be passed via the second argument
235
+ * const llmWithTools = llm.bindTools(
236
+ * [...],
237
+ * {
238
+ * tool_choice: "auto",
239
+ * }
240
+ * );
241
+ * ```
242
+ *
243
+ * ## Examples
244
+ *
245
+ * <details open>
246
+ * <summary><strong>Instantiate</strong></summary>
247
+ *
248
+ * ```typescript
249
+ * import { AzureChatOpenAI } from '@langchain/openai';
250
+ *
251
+ * const llm = new AzureChatOpenAI({
252
+ * azureOpenAIApiKey: process.env.AZURE_OPENAI_API_KEY, // In Node.js defaults to process.env.AZURE_OPENAI_API_KEY
253
+ * azureOpenAIApiInstanceName: process.env.AZURE_OPENAI_API_INSTANCE_NAME, // In Node.js defaults to process.env.AZURE_OPENAI_API_INSTANCE_NAME
254
+ * azureOpenAIApiDeploymentName: process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME, // In Node.js defaults to process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME
255
+ * azureOpenAIApiVersion: process.env.AZURE_OPENAI_API_VERSION, // In Node.js defaults to process.env.AZURE_OPENAI_API_VERSION
256
+ * temperature: 0,
257
+ * maxTokens: undefined,
258
+ * timeout: undefined,
259
+ * maxRetries: 2,
260
+ * // apiKey: "...",
261
+ * // baseUrl: "...",
262
+ * // other params...
263
+ * });
264
+ * ```
265
+ * </details>
266
+ *
267
+ * <br />
268
+ *
269
+ * <details>
270
+ * <summary><strong>Invoking</strong></summary>
271
+ *
272
+ * ```typescript
273
+ * const input = `Translate "I love programming" into French.`;
274
+ *
275
+ * // Models also accept a list of chat messages or a formatted prompt
276
+ * const result = await llm.invoke(input);
277
+ * console.log(result);
278
+ * ```
279
+ *
280
+ * ```txt
281
+ * AIMessage {
282
+ * "id": "chatcmpl-9u4Mpu44CbPjwYFkTbeoZgvzB00Tz",
283
+ * "content": "J'adore la programmation.",
284
+ * "response_metadata": {
285
+ * "tokenUsage": {
286
+ * "completionTokens": 5,
287
+ * "promptTokens": 28,
288
+ * "totalTokens": 33
289
+ * },
290
+ * "finish_reason": "stop",
291
+ * "system_fingerprint": "fp_3aa7262c27"
292
+ * },
293
+ * "usage_metadata": {
294
+ * "input_tokens": 28,
295
+ * "output_tokens": 5,
296
+ * "total_tokens": 33
297
+ * }
298
+ * }
299
+ * ```
300
+ * </details>
301
+ *
302
+ * <br />
303
+ *
304
+ * <details>
305
+ * <summary><strong>Streaming Chunks</strong></summary>
306
+ *
307
+ * ```typescript
308
+ * for await (const chunk of await llm.stream(input)) {
309
+ * console.log(chunk);
310
+ * }
311
+ * ```
312
+ *
313
+ * ```txt
314
+ * AIMessageChunk {
315
+ * "id": "chatcmpl-9u4NWB7yUeHCKdLr6jP3HpaOYHTqs",
316
+ * "content": ""
317
+ * }
318
+ * AIMessageChunk {
319
+ * "content": "J"
320
+ * }
321
+ * AIMessageChunk {
322
+ * "content": "'adore"
323
+ * }
324
+ * AIMessageChunk {
325
+ * "content": " la"
326
+ * }
327
+ * AIMessageChunk {
328
+ * "content": " programmation",,
329
+ * }
330
+ * AIMessageChunk {
331
+ * "content": ".",,
332
+ * }
333
+ * AIMessageChunk {
334
+ * "content": "",
335
+ * "response_metadata": {
336
+ * "finish_reason": "stop",
337
+ * "system_fingerprint": "fp_c9aa9c0491"
338
+ * },
339
+ * }
340
+ * AIMessageChunk {
341
+ * "content": "",
342
+ * "usage_metadata": {
343
+ * "input_tokens": 28,
344
+ * "output_tokens": 5,
345
+ * "total_tokens": 33
346
+ * }
347
+ * }
348
+ * ```
349
+ * </details>
350
+ *
351
+ * <br />
352
+ *
353
+ * <details>
354
+ * <summary><strong>Aggregate Streamed Chunks</strong></summary>
355
+ *
356
+ * ```typescript
357
+ * import { AIMessageChunk } from '@langchain/core/messages';
358
+ * import { concat } from '@langchain/core/utils/stream';
359
+ *
360
+ * const stream = await llm.stream(input);
361
+ * let full: AIMessageChunk | undefined;
362
+ * for await (const chunk of stream) {
363
+ * full = !full ? chunk : concat(full, chunk);
364
+ * }
365
+ * console.log(full);
366
+ * ```
367
+ *
368
+ * ```txt
369
+ * AIMessageChunk {
370
+ * "id": "chatcmpl-9u4PnX6Fy7OmK46DASy0bH6cxn5Xu",
371
+ * "content": "J'adore la programmation.",
372
+ * "response_metadata": {
373
+ * "prompt": 0,
374
+ * "completion": 0,
375
+ * "finish_reason": "stop",
376
+ * },
377
+ * "usage_metadata": {
378
+ * "input_tokens": 28,
379
+ * "output_tokens": 5,
380
+ * "total_tokens": 33
381
+ * }
382
+ * }
383
+ * ```
384
+ * </details>
385
+ *
386
+ * <br />
387
+ *
388
+ * <details>
389
+ * <summary><strong>Bind tools</strong></summary>
390
+ *
391
+ * ```typescript
392
+ * import { z } from 'zod';
393
+ *
394
+ * const GetWeather = {
395
+ * name: "GetWeather",
396
+ * description: "Get the current weather in a given location",
397
+ * schema: z.object({
398
+ * location: z.string().describe("The city and state, e.g. San Francisco, CA")
399
+ * }),
400
+ * }
401
+ *
402
+ * const GetPopulation = {
403
+ * name: "GetPopulation",
404
+ * description: "Get the current population in a given location",
405
+ * schema: z.object({
406
+ * location: z.string().describe("The city and state, e.g. San Francisco, CA")
407
+ * }),
408
+ * }
409
+ *
410
+ * const llmWithTools = llm.bindTools([GetWeather, GetPopulation]);
411
+ * const aiMsg = await llmWithTools.invoke(
412
+ * "Which city is hotter today and which is bigger: LA or NY?"
413
+ * );
414
+ * console.log(aiMsg.tool_calls);
415
+ * ```
416
+ *
417
+ * ```txt
418
+ * [
419
+ * {
420
+ * name: 'GetWeather',
421
+ * args: { location: 'Los Angeles, CA' },
422
+ * type: 'tool_call',
423
+ * id: 'call_uPU4FiFzoKAtMxfmPnfQL6UK'
424
+ * },
425
+ * {
426
+ * name: 'GetWeather',
427
+ * args: { location: 'New York, NY' },
428
+ * type: 'tool_call',
429
+ * id: 'call_UNkEwuQsHrGYqgDQuH9nPAtX'
430
+ * },
431
+ * {
432
+ * name: 'GetPopulation',
433
+ * args: { location: 'Los Angeles, CA' },
434
+ * type: 'tool_call',
435
+ * id: 'call_kL3OXxaq9OjIKqRTpvjaCH14'
436
+ * },
437
+ * {
438
+ * name: 'GetPopulation',
439
+ * args: { location: 'New York, NY' },
440
+ * type: 'tool_call',
441
+ * id: 'call_s9KQB1UWj45LLGaEnjz0179q'
442
+ * }
443
+ * ]
444
+ * ```
445
+ * </details>
446
+ *
447
+ * <br />
448
+ *
449
+ * <details>
450
+ * <summary><strong>Structured Output</strong></summary>
451
+ *
452
+ * ```typescript
453
+ * import { z } from 'zod';
454
+ *
455
+ * const Joke = z.object({
456
+ * setup: z.string().describe("The setup of the joke"),
457
+ * punchline: z.string().describe("The punchline to the joke"),
458
+ * rating: z.number().nullable().describe("How funny the joke is, from 1 to 10")
459
+ * }).describe('Joke to tell user.');
460
+ *
461
+ * const structuredLlm = llm.withStructuredOutput(Joke, { name: "Joke" });
462
+ * const jokeResult = await structuredLlm.invoke("Tell me a joke about cats");
463
+ * console.log(jokeResult);
464
+ * ```
465
+ *
466
+ * ```txt
467
+ * {
468
+ * setup: 'Why was the cat sitting on the computer?',
469
+ * punchline: 'Because it wanted to keep an eye on the mouse!',
470
+ * rating: 7
471
+ * }
472
+ * ```
473
+ * </details>
474
+ *
475
+ * <br />
476
+ *
477
+ * <details>
478
+ * <summary><strong>JSON Object Response Format</strong></summary>
479
+ *
480
+ * ```typescript
481
+ * const jsonLlm = llm.withConfig({ response_format: { type: "json_object" } });
482
+ * const jsonLlmAiMsg = await jsonLlm.invoke(
483
+ * "Return a JSON object with key 'randomInts' and a value of 10 random ints in [0-99]"
484
+ * );
485
+ * console.log(jsonLlmAiMsg.content);
486
+ * ```
487
+ *
488
+ * ```txt
489
+ * {
490
+ * "randomInts": [23, 87, 45, 12, 78, 34, 56, 90, 11, 67]
491
+ * }
492
+ * ```
493
+ * </details>
494
+ *
495
+ * <br />
496
+ *
497
+ * <details>
498
+ * <summary><strong>Multimodal</strong></summary>
499
+ *
500
+ * ```typescript
501
+ * import { HumanMessage } from '@langchain/core/messages';
502
+ *
503
+ * const imageUrl = "https://example.com/image.jpg";
504
+ * const imageData = await fetch(imageUrl).then(res => res.arrayBuffer());
505
+ * const base64Image = Buffer.from(imageData).toString('base64');
506
+ *
507
+ * const message = new HumanMessage({
508
+ * content: [
509
+ * { type: "text", text: "describe the weather in this image" },
510
+ * {
511
+ * type: "image_url",
512
+ * image_url: { url: `data:image/jpeg;base64,${base64Image}` },
513
+ * },
514
+ * ]
515
+ * });
516
+ *
517
+ * const imageDescriptionAiMsg = await llm.invoke([message]);
518
+ * console.log(imageDescriptionAiMsg.content);
519
+ * ```
520
+ *
521
+ * ```txt
522
+ * The weather in the image appears to be clear and sunny. The sky is mostly blue with a few scattered white clouds, indicating fair weather. The bright sunlight is casting shadows on the green, grassy hill, suggesting it is a pleasant day with good visibility. There are no signs of rain or stormy conditions.
523
+ * ```
524
+ * </details>
525
+ *
526
+ * <br />
527
+ *
528
+ * <details>
529
+ * <summary><strong>Usage Metadata</strong></summary>
530
+ *
531
+ * ```typescript
532
+ * const aiMsgForMetadata = await llm.invoke(input);
533
+ * console.log(aiMsgForMetadata.usage_metadata);
534
+ * ```
535
+ *
536
+ * ```txt
537
+ * { input_tokens: 28, output_tokens: 5, total_tokens: 33 }
538
+ * ```
539
+ * </details>
540
+ *
541
+ * <br />
542
+ *
543
+ * <details>
544
+ * <summary><strong>Logprobs</strong></summary>
545
+ *
546
+ * ```typescript
547
+ * const logprobsLlm = new ChatOpenAI({ model: "gpt-4o-mini", logprobs: true });
548
+ * const aiMsgForLogprobs = await logprobsLlm.invoke(input);
549
+ * console.log(aiMsgForLogprobs.response_metadata.logprobs);
550
+ * ```
551
+ *
552
+ * ```txt
553
+ * {
554
+ * content: [
555
+ * {
556
+ * token: 'J',
557
+ * logprob: -0.000050616763,
558
+ * bytes: [Array],
559
+ * top_logprobs: []
560
+ * },
561
+ * {
562
+ * token: "'",
563
+ * logprob: -0.01868736,
564
+ * bytes: [Array],
565
+ * top_logprobs: []
566
+ * },
567
+ * {
568
+ * token: 'ad',
569
+ * logprob: -0.0000030545007,
570
+ * bytes: [Array],
571
+ * top_logprobs: []
572
+ * },
573
+ * { token: 'ore', logprob: 0, bytes: [Array], top_logprobs: [] },
574
+ * {
575
+ * token: ' la',
576
+ * logprob: -0.515404,
577
+ * bytes: [Array],
578
+ * top_logprobs: []
579
+ * },
580
+ * {
581
+ * token: ' programm',
582
+ * logprob: -0.0000118755715,
583
+ * bytes: [Array],
584
+ * top_logprobs: []
585
+ * },
586
+ * { token: 'ation', logprob: 0, bytes: [Array], top_logprobs: [] },
587
+ * {
588
+ * token: '.',
589
+ * logprob: -0.0000037697225,
590
+ * bytes: [Array],
591
+ * top_logprobs: []
592
+ * }
593
+ * ],
594
+ * refusal: null
595
+ * }
596
+ * ```
597
+ * </details>
598
+ *
599
+ * <br />
600
+ *
601
+ * <details>
602
+ * <summary><strong>Response Metadata</strong></summary>
603
+ *
604
+ * ```typescript
605
+ * const aiMsgForResponseMetadata = await llm.invoke(input);
606
+ * console.log(aiMsgForResponseMetadata.response_metadata);
607
+ * ```
608
+ *
609
+ * ```txt
610
+ * {
611
+ * tokenUsage: { completionTokens: 5, promptTokens: 28, totalTokens: 33 },
612
+ * finish_reason: 'stop',
613
+ * system_fingerprint: 'fp_3aa7262c27'
614
+ * }
615
+ * ```
616
+ * </details>
617
+ */
618
+ var AzureChatOpenAI = class extends ChatOpenAI {
619
+ azureOpenAIApiVersion;
620
+ azureOpenAIApiKey;
621
+ azureADTokenProvider;
622
+ azureOpenAIApiInstanceName;
623
+ azureOpenAIApiDeploymentName;
624
+ azureOpenAIBasePath;
625
+ azureOpenAIEndpoint;
626
+ _llmType() {
627
+ return "azure_openai";
628
+ }
629
+ get lc_aliases() {
630
+ return {
631
+ ...super.lc_aliases,
632
+ ...AZURE_ALIASES
633
+ };
634
+ }
635
+ get lc_secrets() {
636
+ return {
637
+ ...super.lc_secrets,
638
+ ...AZURE_SECRETS
639
+ };
640
+ }
641
+ get lc_serializable_keys() {
642
+ return [...super.lc_serializable_keys, ...AZURE_SERIALIZABLE_KEYS];
643
+ }
644
+ getLsParams(options) {
645
+ const params = super.getLsParams(options);
646
+ params.ls_provider = "azure";
647
+ return params;
648
+ }
649
+ constructor(fields) {
650
+ super({
651
+ ...fields,
652
+ completions: new AzureChatOpenAICompletions(fields),
653
+ responses: new AzureChatOpenAIResponses(fields)
654
+ });
655
+ _constructAzureFields.call(this, fields);
656
+ }
657
+ /** @internal */
658
+ _getStructuredOutputMethod(config) {
659
+ const ensuredConfig = { ...config };
660
+ if (this.model.startsWith("gpt-4o")) {
661
+ if (ensuredConfig?.method === void 0) return "functionCalling";
662
+ }
663
+ return super._getStructuredOutputMethod(ensuredConfig);
664
+ }
665
+ toJSON() {
666
+ return _serializeAzureChat.call(this, super.toJSON());
667
+ }
668
+ };
669
+
670
+ //#endregion
671
+ export { AzureChatOpenAI };
672
+ //# sourceMappingURL=chat_models.js.map