@langchain/openai 0.2.3 → 0.2.4

package/dist/chat_models.cjs

@@ -568,7 +568,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             tools: isStructuredToolArray(options?.tools)
                 ? options?.tools.map(function_calling_1.convertToOpenAITool)
                 : options?.tools,
-            tool_choice: options?.tool_choice,
+            tool_choice: (0, openai_js_1.formatToOpenAIToolChoice)(options?.tool_choice),
             response_format: options?.response_format,
             seed: options?.seed,
             ...streamOptionsConfig,

package/dist/chat_models.d.ts

@@ -8,6 +8,7 @@ import type { BaseFunctionCallOptions, BaseLanguageModelInput, StructuredOutputM
 import { z } from "zod";
 import { Runnable, RunnableToolLike } from "@langchain/core/runnables";
 import type { AzureOpenAIInput, OpenAICallOptions, OpenAIChatInput, OpenAICoreRequestOptions, LegacyOpenAIInput } from "./types.js";
+import { OpenAIToolChoice } from "./utils/openai.js";
 export type { AzureOpenAIInput, OpenAICallOptions, OpenAIChatInput };
 interface TokenUsage {
     completionTokens?: number;
@@ -21,7 +22,7 @@ type OpenAIRoleEnum = "system" | "assistant" | "user" | "function" | "tool";
 export declare function messageToOpenAIRole(message: BaseMessage): OpenAIRoleEnum;
 export interface ChatOpenAICallOptions extends OpenAICallOptions, BaseFunctionCallOptions {
     tools?: StructuredToolInterface[] | OpenAIClient.ChatCompletionTool[];
-    tool_choice?: OpenAIClient.ChatCompletionToolChoiceOption;
+    tool_choice?: OpenAIToolChoice;
     promptIndex?: number;
     response_format?: {
         type: "json_object";

package/dist/chat_models.js

@@ -9,7 +9,7 @@ import { JsonOutputParser, StructuredOutputParser, } from "@langchain/core/outpu
 import { JsonOutputKeyToolsParser, convertLangChainToolCallToOpenAI, makeInvalidToolCall, parseToolCall, } from "@langchain/core/output_parsers/openai_tools";
 import { zodToJsonSchema } from "zod-to-json-schema";
 import { getEndpoint } from "./utils/azure.js";
-import { wrapOpenAIClientError } from "./utils/openai.js";
+import { formatToOpenAIToolChoice, wrapOpenAIClientError, } from "./utils/openai.js";
 import { formatFunctionDefinitions, } from "./utils/openai-format-fndef.js";
 function extractGenericMessageCustomRole(message) {
     if (message.role !== "system" &&
@@ -564,7 +564,7 @@ export class ChatOpenAI extends BaseChatModel {
             tools: isStructuredToolArray(options?.tools)
                 ? options?.tools.map(convertToOpenAITool)
                 : options?.tools,
-            tool_choice: options?.tool_choice,
+            tool_choice: formatToOpenAIToolChoice(options?.tool_choice),
             response_format: options?.response_format,
             seed: options?.seed,
             ...streamOptionsConfig,

package/dist/utils/openai.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatToOpenAIAssistantTool = exports.formatToOpenAITool = exports.formatToOpenAIFunction = exports.wrapOpenAIClientError = void 0;
+exports.formatToOpenAIToolChoice = exports.formatToOpenAIAssistantTool = exports.formatToOpenAITool = exports.formatToOpenAIFunction = exports.wrapOpenAIClientError = void 0;
 const openai_1 = require("openai");
 const zod_to_json_schema_1 = require("zod-to-json-schema");
 const function_calling_1 = require("@langchain/core/utils/function_calling");
@@ -34,3 +34,29 @@ function formatToOpenAIAssistantTool(tool) {
     };
 }
 exports.formatToOpenAIAssistantTool = formatToOpenAIAssistantTool;
+function formatToOpenAIToolChoice(toolChoice) {
+    if (!toolChoice) {
+        return undefined;
+    }
+    else if (toolChoice === "any" || toolChoice === "required") {
+        return "required";
+    }
+    else if (toolChoice === "auto") {
+        return "auto";
+    }
+    else if (toolChoice === "none") {
+        return "none";
+    }
+    else if (typeof toolChoice === "string") {
+        return {
+            type: "function",
+            function: {
+                name: toolChoice,
+            },
+        };
+    }
+    else {
+        return toolChoice;
+    }
+}
+exports.formatToOpenAIToolChoice = formatToOpenAIToolChoice;

package/dist/utils/openai.d.ts

@@ -1,3 +1,4 @@
+import { OpenAI as OpenAIClient } from "openai";
 import type { StructuredToolInterface } from "@langchain/core/tools";
 import { convertToOpenAIFunction, convertToOpenAITool } from "@langchain/core/utils/function_calling";
 export declare function wrapOpenAIClientError(e: any): any;
@@ -15,3 +16,5 @@ export declare function formatToOpenAIAssistantTool(tool: StructuredToolInterfac
         };
     };
 };
+export type OpenAIToolChoice = OpenAIClient.ChatCompletionToolChoiceOption | "any" | string;
+export declare function formatToOpenAIToolChoice(toolChoice?: OpenAIToolChoice): OpenAIClient.ChatCompletionToolChoiceOption | undefined;

package/dist/utils/openai.js

@@ -1,4 +1,4 @@
-import { APIConnectionTimeoutError, APIUserAbortError } from "openai";
+import { APIConnectionTimeoutError, APIUserAbortError, } from "openai";
 import { zodToJsonSchema } from "zod-to-json-schema";
 import { convertToOpenAIFunction, convertToOpenAITool, } from "@langchain/core/utils/function_calling";
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -28,3 +28,28 @@ export function formatToOpenAIAssistantTool(tool) {
         },
     };
 }
+export function formatToOpenAIToolChoice(toolChoice) {
+    if (!toolChoice) {
+        return undefined;
+    }
+    else if (toolChoice === "any" || toolChoice === "required") {
+        return "required";
+    }
+    else if (toolChoice === "auto") {
+        return "auto";
+    }
+    else if (toolChoice === "none") {
+        return "none";
+    }
+    else if (typeof toolChoice === "string") {
+        return {
+            type: "function",
+            function: {
+                name: toolChoice,
+            },
+        };
+    }
+    else {
+        return toolChoice;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/openai",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "OpenAI integrations for LangChain.js",
   "type": "module",
   "engines": {