@langchain/openai 0.2.5 → 0.2.7

package/dist/types.d.ts

@@ -1,6 +1,8 @@
 import type { OpenAI as OpenAIClient } from "openai";
+import type { ResponseFormatText, ResponseFormatJSONObject, ResponseFormatJSONSchema } from "openai/resources/shared";
 import { TiktokenModel } from "js-tiktoken/lite";
 import type { BaseLanguageModelCallOptions } from "@langchain/core/language_models/base";
+import type { z } from "zod";
 export type { TiktokenModel };
 export declare interface OpenAIBaseInput {
     /** Sampling temperature to use */
@@ -121,6 +123,11 @@ export interface OpenAIChatInput extends OpenAIBaseInput {
      * Currently in experimental beta.
      */
     __includeRawResponse?: boolean;
+    /**
+     * Whether the model supports the `strict` argument when passing in tools.
+     * If `undefined` the `strict` argument will not be passed to OpenAI.
+     */
+    supportsStrictToolCalling?: boolean;
 }
 export declare interface AzureOpenAIInput {
     /**
@@ -174,3 +181,13 @@ export declare interface AzureOpenAIInput {
      */
     azureADTokenProvider?: () => Promise<string>;
 }
+type ChatOpenAIResponseFormatJSONSchema = Omit<ResponseFormatJSONSchema, "json_schema"> & {
+    json_schema: Omit<ResponseFormatJSONSchema["json_schema"], "schema"> & {
+        /**
+         * The schema for the response format, described as a JSON Schema object
+         * or a Zod object.
+         */
+        schema: Record<string, any> | z.ZodObject<any, any, any, any>;
+    };
+};
+export type ChatOpenAIResponseFormat = ResponseFormatText | ResponseFormatJSONObject | ChatOpenAIResponseFormatJSONSchema;

package/dist/utils/tools.cjs

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._convertToOpenAITool = void 0;
+const function_calling_1 = require("@langchain/core/utils/function_calling");
+const zod_1 = require("openai/helpers/zod");
+/**
+ * Formats a tool in either OpenAI format, or LangChain structured tool format
+ * into an OpenAI tool format. If the tool is already in OpenAI format, return without
+ * any changes. If it is in LangChain structured tool format, convert it to OpenAI tool format
+ * using OpenAI's `zodFunction` util, falling back to `convertToOpenAIFunction` if the parameters
+ * returned from the `zodFunction` util are not defined.
+ *
+ * @param {BindToolsInput} tool The tool to convert to an OpenAI tool.
+ * @param {Object} [fields] Additional fields to add to the OpenAI tool.
+ * @returns {ToolDefinition} The inputted tool in OpenAI tool format.
+ */
+function _convertToOpenAITool(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+tool, fields) {
+    let toolDef;
+    if ((0, function_calling_1.isLangChainTool)(tool)) {
+        const oaiToolDef = (0, zod_1.zodFunction)({
+            name: tool.name,
+            parameters: tool.schema,
+            description: tool.description,
+        });
+        if (!oaiToolDef.function.parameters) {
+            // Fallback to the `convertToOpenAIFunction` util if the parameters are not defined.
+            toolDef = {
+                type: "function",
+                function: (0, function_calling_1.convertToOpenAIFunction)(tool, fields),
+            };
+        }
+        else {
+            toolDef = {
+                type: oaiToolDef.type,
+                function: {
+                    name: oaiToolDef.function.name,
+                    description: oaiToolDef.function.description,
+                    parameters: oaiToolDef.function.parameters,
+                    ...(fields?.strict !== undefined ? { strict: fields.strict } : {}),
+                },
+            };
+        }
+    }
+    else {
+        toolDef = tool;
+    }
+    if (fields?.strict !== undefined) {
+        toolDef.function.strict = fields.strict;
+    }
+    return toolDef;
+}
+exports._convertToOpenAITool = _convertToOpenAITool;

package/dist/utils/tools.d.ts

@@ -0,0 +1,20 @@
+import { ToolDefinition } from "@langchain/core/language_models/base";
+import { BindToolsInput } from "@langchain/core/language_models/chat_models";
+/**
+ * Formats a tool in either OpenAI format, or LangChain structured tool format
+ * into an OpenAI tool format. If the tool is already in OpenAI format, return without
+ * any changes. If it is in LangChain structured tool format, convert it to OpenAI tool format
+ * using OpenAI's `zodFunction` util, falling back to `convertToOpenAIFunction` if the parameters
+ * returned from the `zodFunction` util are not defined.
+ *
+ * @param {BindToolsInput} tool The tool to convert to an OpenAI tool.
+ * @param {Object} [fields] Additional fields to add to the OpenAI tool.
+ * @returns {ToolDefinition} The inputted tool in OpenAI tool format.
+ */
+export declare function _convertToOpenAITool(tool: BindToolsInput, fields?: {
+    /**
+     * If `true`, model output is guaranteed to exactly match the JSON Schema
+     * provided in the function definition.
+     */
+    strict?: boolean;
+}): ToolDefinition;

package/dist/utils/tools.js

@@ -0,0 +1,50 @@
+import { convertToOpenAIFunction, isLangChainTool, } from "@langchain/core/utils/function_calling";
+import { zodFunction } from "openai/helpers/zod";
+/**
+ * Formats a tool in either OpenAI format, or LangChain structured tool format
+ * into an OpenAI tool format. If the tool is already in OpenAI format, return without
+ * any changes. If it is in LangChain structured tool format, convert it to OpenAI tool format
+ * using OpenAI's `zodFunction` util, falling back to `convertToOpenAIFunction` if the parameters
+ * returned from the `zodFunction` util are not defined.
+ *
+ * @param {BindToolsInput} tool The tool to convert to an OpenAI tool.
+ * @param {Object} [fields] Additional fields to add to the OpenAI tool.
+ * @returns {ToolDefinition} The inputted tool in OpenAI tool format.
+ */
+export function _convertToOpenAITool(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+tool, fields) {
+    let toolDef;
+    if (isLangChainTool(tool)) {
+        const oaiToolDef = zodFunction({
+            name: tool.name,
+            parameters: tool.schema,
+            description: tool.description,
+        });
+        if (!oaiToolDef.function.parameters) {
+            // Fallback to the `convertToOpenAIFunction` util if the parameters are not defined.
+            toolDef = {
+                type: "function",
+                function: convertToOpenAIFunction(tool, fields),
+            };
+        }
+        else {
+            toolDef = {
+                type: oaiToolDef.type,
+                function: {
+                    name: oaiToolDef.function.name,
+                    description: oaiToolDef.function.description,
+                    parameters: oaiToolDef.function.parameters,
+                    ...(fields?.strict !== undefined ? { strict: fields.strict } : {}),
+                },
+            };
+        }
+    }
+    else {
+        toolDef = tool;
+    }
+    if (fields?.strict !== undefined) {
+        toolDef.function.strict = fields.strict;
+    }
+    return toolDef;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/openai",
-  "version": "0.2.5",
+  "version": "0.2.7",
   "description": "OpenAI integrations for LangChain.js",
   "type": "module",
   "engines": {
@@ -15,7 +15,7 @@
   "homepage": "https://github.com/langchain-ai/langchainjs/tree/main/libs/langchain-openai/",
   "scripts": {
     "build": "yarn turbo:command build:internal --filter=@langchain/openai",
-    "build:internal": "yarn lc-build:v2 --create-entrypoints --pre --tree-shaking",
+    "build:internal": "yarn lc_build_v2 --create-entrypoints --pre --tree-shaking",
     "lint:eslint": "NODE_OPTIONS=--max-old-space-size=4096 eslint --cache --ext .ts,.js src/",
     "lint:dpdm": "dpdm --exit-code circular:1 --no-warning --no-tree src/*.ts src/**/*.ts",
     "lint": "yarn lint:eslint && yarn lint:dpdm",
@@ -35,16 +35,16 @@
   "author": "LangChain",
   "license": "MIT",
   "dependencies": {
-    "@langchain/core": ">=0.2.16 <0.3.0",
+    "@langchain/core": ">=0.2.26 <0.3.0",
     "js-tiktoken": "^1.0.12",
-    "openai": "^4.49.1",
+    "openai": "^4.55.0",
     "zod": "^3.22.4",
     "zod-to-json-schema": "^3.22.3"
   },
   "devDependencies": {
-    "@azure/identity": "^4.2.0",
+    "@azure/identity": "^4.2.1",
     "@jest/globals": "^29.5.0",
-    "@langchain/scripts": "~0.0.14",
+    "@langchain/scripts": "^0.0.21",
     "@langchain/standard-tests": "0.0.0",
     "@swc/core": "^1.3.90",
     "@swc/jest": "^0.2.29",
@@ -59,7 +59,7 @@
     "jest": "^29.5.0",
     "jest-environment-node": "^29.6.4",
     "prettier": "^2.8.3",
-    "release-it": "^15.10.1",
+    "release-it": "^17.6.0",
     "rimraf": "^5.0.1",
     "ts-jest": "^29.1.0",
     "typescript": "~5.1.6"

package/dist/tools/tests/dalle.int.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tools/tests/dalle.int.test.js

@@ -1,57 +0,0 @@
-import { test, expect } from "@jest/globals";
-import { DallEAPIWrapper } from "../dalle.js";
-test.skip("Dalle can generate images", async () => {
-    const dalle = new DallEAPIWrapper();
-    const res = await dalle.invoke("A painting of a cat");
-    expect(res).toBeDefined();
-    expect(res).toContain("https://");
-});
-test.skip("Dalle can generate images with base 64 response format", async () => {
-    const dalle = new DallEAPIWrapper({
-        responseFormat: "b64_json",
-    });
-    const res = await dalle.invoke("A painting of a cat");
-    expect(res).toBeDefined();
-    expect(res).not.toContain("https://");
-});
-test.skip("Dalle returns multiple image URLs if n > 1", async () => {
-    const dalle = new DallEAPIWrapper({
-        n: 2,
-    });
-    const res = await dalle.invoke("A painting of a cat");
-    expect(res).toBeDefined();
-    expect(res).toBeInstanceOf(Array);
-    if (!Array.isArray(res))
-        return;
-    expect(res).toHaveLength(2);
-    // The types for each should be `image_url` with an `image_url` field containing the URL
-    expect(res[0].type).toBe("image_url");
-    expect(res[1].type).toBe("image_url");
-    expect(res[0]).toHaveProperty("image_url");
-    expect(res[1]).toHaveProperty("image_url");
-    expect(res[0].image_url.startsWith("https://")).toBe(true);
-    expect(res[1].image_url.startsWith("https://")).toBe(true);
-});
-test.skip("Dalle returns multiple base64 image strings if n > 1", async () => {
-    const dalle = new DallEAPIWrapper({
-        n: 2,
-        dallEResponseFormat: "b64_json",
-    });
-    const res = await dalle.invoke("A painting of a cat");
-    expect(res).toBeDefined();
-    expect(res).toBeInstanceOf(Array);
-    if (!Array.isArray(res))
-        return;
-    expect(res).toHaveLength(2);
-    // The types for each should be `b64_json` with an `b64_json` field containing the URL
-    expect(res[0].type).toBe("image_url");
-    expect(res[1].type).toBe("image_url");
-    expect(res[0]).toHaveProperty("image_url");
-    expect(res[1]).toHaveProperty("image_url");
-    expect(res[0].image_url).toHaveProperty("url");
-    expect(res[1].image_url).toHaveProperty("url");
-    expect(res[0].image_url.url).toBeDefined();
-    expect(res[1].image_url.url).toBeDefined();
-    expect(res[0].image_url.url).not.toBe("");
-    expect(res[1].image_url.url).not.toBe("");
-});