@langchain/openai 0.0.10 → 0.0.12

package/dist/chat_models.cjs

@@ -6,6 +6,7 @@ const messages_1 = require("@langchain/core/messages");
 const outputs_1 = require("@langchain/core/outputs");
 const env_1 = require("@langchain/core/utils/env");
 const chat_models_1 = require("@langchain/core/language_models/chat_models");
+const function_calling_1 = require("@langchain/core/utils/function_calling");
 const azure_js_1 = require("./utils/azure.cjs");
 const openai_js_1 = require("./utils/openai.cjs");
 const openai_format_fndef_js_1 = require("./utils/openai-format-fndef.cjs");
@@ -266,6 +267,18 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "logprobs", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "topLogprobs", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "openAIApiKey", {
             enumerable: true,
             configurable: true,
@@ -351,6 +364,8 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
         this.frequencyPenalty = fields?.frequencyPenalty ?? this.frequencyPenalty;
         this.presencePenalty = fields?.presencePenalty ?? this.presencePenalty;
         this.maxTokens = fields?.maxTokens;
+        this.logprobs = fields?.logprobs;
+        this.topLogprobs = fields?.topLogprobs;
         this.n = fields?.n ?? this.n;
         this.logitBias = fields?.logitBias;
         this.stop = fields?.stop;
@@ -396,6 +411,8 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             frequency_penalty: this.frequencyPenalty,
             presence_penalty: this.presencePenalty,
             max_tokens: this.maxTokens === -1 ? undefined : this.maxTokens,
+            logprobs: this.logprobs,
+            top_logprobs: this.topLogprobs,
             n: this.n,
             logit_bias: this.logitBias,
             stop: options?.stop ?? this.stop,
@@ -404,7 +421,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             functions: options?.functions,
             function_call: options?.function_call,
             tools: isStructuredToolArray(options?.tools)
-                ? options?.tools.map(openai_js_1.formatToOpenAITool)
+                ? options?.tools.map(function_calling_1.convertToOpenAITool)
                 : options?.tools,
             tool_choice: options?.tool_choice,
             response_format: options?.response_format,
@@ -526,9 +543,10 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
                     text,
                     message: openAIResponseToChatMessage(part.message ?? { role: "assistant" }),
                 };
-                if (part.finish_reason) {
-                    generation.generationInfo = { finish_reason: part.finish_reason };
-                }
+                generation.generationInfo = {
+                    ...(part.finish_reason ? { finish_reason: part.finish_reason } : {}),
+                    ...(part.logprobs ? { logprobs: part.logprobs } : {}),
+                };
                 generations.push(generation);
             }
             return {

package/dist/chat_models.d.ts

@@ -81,6 +81,8 @@ export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = Chat
     timeout?: number;
     streaming: boolean;
     maxTokens?: number;
+    logprobs?: boolean;
+    topLogprobs?: number;
     openAIApiKey?: string;
     azureOpenAIApiVersion?: string;
     azureOpenAIApiKey?: string;

package/dist/chat_models.js

@@ -3,8 +3,9 @@ import { AIMessage, AIMessageChunk, ChatMessage, ChatMessageChunk, FunctionMessa
 import { ChatGenerationChunk, } from "@langchain/core/outputs";
 import { getEnvironmentVariable } from "@langchain/core/utils/env";
 import { BaseChatModel, } from "@langchain/core/language_models/chat_models";
+import { convertToOpenAITool } from "@langchain/core/utils/function_calling";
 import { getEndpoint } from "./utils/azure.js";
-import { wrapOpenAIClientError, formatToOpenAITool } from "./utils/openai.js";
+import { wrapOpenAIClientError } from "./utils/openai.js";
 import { formatFunctionDefinitions, } from "./utils/openai-format-fndef.js";
 function extractGenericMessageCustomRole(message) {
     if (message.role !== "system" &&
@@ -262,6 +263,18 @@ export class ChatOpenAI extends BaseChatModel {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "logprobs", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "topLogprobs", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "openAIApiKey", {
             enumerable: true,
             configurable: true,
@@ -347,6 +360,8 @@ export class ChatOpenAI extends BaseChatModel {
         this.frequencyPenalty = fields?.frequencyPenalty ?? this.frequencyPenalty;
         this.presencePenalty = fields?.presencePenalty ?? this.presencePenalty;
         this.maxTokens = fields?.maxTokens;
+        this.logprobs = fields?.logprobs;
+        this.topLogprobs = fields?.topLogprobs;
         this.n = fields?.n ?? this.n;
         this.logitBias = fields?.logitBias;
         this.stop = fields?.stop;
@@ -392,6 +407,8 @@ export class ChatOpenAI extends BaseChatModel {
             frequency_penalty: this.frequencyPenalty,
             presence_penalty: this.presencePenalty,
             max_tokens: this.maxTokens === -1 ? undefined : this.maxTokens,
+            logprobs: this.logprobs,
+            top_logprobs: this.topLogprobs,
             n: this.n,
             logit_bias: this.logitBias,
             stop: options?.stop ?? this.stop,
@@ -400,7 +417,7 @@ export class ChatOpenAI extends BaseChatModel {
             functions: options?.functions,
             function_call: options?.function_call,
             tools: isStructuredToolArray(options?.tools)
-                ? options?.tools.map(formatToOpenAITool)
+                ? options?.tools.map(convertToOpenAITool)
                 : options?.tools,
             tool_choice: options?.tool_choice,
             response_format: options?.response_format,
@@ -522,9 +539,10 @@ export class ChatOpenAI extends BaseChatModel {
                     text,
                     message: openAIResponseToChatMessage(part.message ?? { role: "assistant" }),
                 };
-                if (part.finish_reason) {
-                    generation.generationInfo = { finish_reason: part.finish_reason };
-                }
+                generation.generationInfo = {
+                    ...(part.finish_reason ? { finish_reason: part.finish_reason } : {}),
+                    ...(part.logprobs ? { logprobs: part.logprobs } : {}),
+                };
                 generations.push(generation);
             }
             return {

package/dist/types.d.ts

@@ -83,6 +83,16 @@ export interface LegacyOpenAIInput {
     };
 }
 export interface OpenAIChatInput extends OpenAIBaseInput {
+    /**
+     * Whether to return log probabilities of the output tokens or not.
+     * If true, returns the log probabilities of each output token returned in the content of message.
+     */
+    logprobs?: boolean;
+    /**
+     * An integer between 0 and 5 specifying the number of most likely tokens to return at each token position,
+     * each with an associated log probability. logprobs must be set to true if this parameter is used.
+     */
+    topLogprobs?: number;
     /** ChatGPT messages to pass as a prefix to the prompt */
     prefixMessages?: OpenAIClient.Chat.CreateChatCompletionRequestMessage[];
 }

package/dist/utils/azure.d.ts

@@ -3,7 +3,7 @@ export interface OpenAIEndpointConfig {
     azureOpenAIApiInstanceName?: string;
     azureOpenAIApiKey?: string;
     azureOpenAIBasePath?: string;
-    baseURL?: string;
+    baseURL?: string | null;
 }
 /**
  * This function generates an endpoint URL for (Azure) OpenAI
@@ -27,4 +27,4 @@ export interface OpenAIEndpointConfig {
  *
  * @returns {string | undefined} The generated (Azure) OpenAI endpoint URL.
  */
-export declare function getEndpoint(config: OpenAIEndpointConfig): string | undefined;
+export declare function getEndpoint(config: OpenAIEndpointConfig): string | null | undefined;

package/dist/utils/openai.cjs

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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");
+Object.defineProperty(exports, "formatToOpenAIFunction", { enumerable: true, get: function () { return function_calling_1.convertToOpenAIFunction; } });
+Object.defineProperty(exports, "formatToOpenAITool", { enumerable: true, get: function () { return function_calling_1.convertToOpenAITool; } });
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function wrapOpenAIClientError(e) {
     let error;
@@ -20,32 +23,6 @@ function wrapOpenAIClientError(e) {
     return error;
 }
 exports.wrapOpenAIClientError = wrapOpenAIClientError;
-/**
- * Formats a `StructuredTool` instance into a format that is compatible
- * with OpenAI's ChatCompletionFunctions. It uses the `zodToJsonSchema`
- * function to convert the schema of the `StructuredTool` into a JSON
- * schema, which is then used as the parameters for the OpenAI function.
- */
-function formatToOpenAIFunction(tool) {
-    return {
-        name: tool.name,
-        description: tool.description,
-        parameters: (0, zod_to_json_schema_1.zodToJsonSchema)(tool.schema),
-    };
-}
-exports.formatToOpenAIFunction = formatToOpenAIFunction;
-function formatToOpenAITool(tool) {
-    const schema = (0, zod_to_json_schema_1.zodToJsonSchema)(tool.schema);
-    return {
-        type: "function",
-        function: {
-            name: tool.name,
-            description: tool.description,
-            parameters: schema,
-        },
-    };
-}
-exports.formatToOpenAITool = formatToOpenAITool;
 function formatToOpenAIAssistantTool(tool) {
     return {
         type: "function",

package/dist/utils/openai.d.ts

@@ -1,12 +1,6 @@
 import { type 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;
-/**
- * Formats a `StructuredTool` instance into a format that is compatible
- * with OpenAI's ChatCompletionFunctions. It uses the `zodToJsonSchema`
- * function to convert the schema of the `StructuredTool` into a JSON
- * schema, which is then used as the parameters for the OpenAI function.
- */
-export declare function formatToOpenAIFunction(tool: StructuredToolInterface): OpenAIClient.Chat.ChatCompletionCreateParams.Function;
-export declare function formatToOpenAITool(tool: StructuredToolInterface): OpenAIClient.Chat.ChatCompletionTool;
+export { convertToOpenAIFunction as formatToOpenAIFunction, convertToOpenAITool as formatToOpenAITool, };
 export declare function formatToOpenAIAssistantTool(tool: StructuredToolInterface): OpenAIClient.Beta.AssistantCreateParams.AssistantToolsFunction;

package/dist/utils/openai.js

@@ -1,5 +1,6 @@
 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
 export function wrapOpenAIClientError(e) {
     let error;
@@ -16,30 +17,7 @@ export function wrapOpenAIClientError(e) {
     }
     return error;
 }
-/**
- * Formats a `StructuredTool` instance into a format that is compatible
- * with OpenAI's ChatCompletionFunctions. It uses the `zodToJsonSchema`
- * function to convert the schema of the `StructuredTool` into a JSON
- * schema, which is then used as the parameters for the OpenAI function.
- */
-export function formatToOpenAIFunction(tool) {
-    return {
-        name: tool.name,
-        description: tool.description,
-        parameters: zodToJsonSchema(tool.schema),
-    };
-}
-export function formatToOpenAITool(tool) {
-    const schema = zodToJsonSchema(tool.schema);
-    return {
-        type: "function",
-        function: {
-            name: tool.name,
-            description: tool.description,
-            parameters: schema,
-        },
-    };
-}
+export { convertToOpenAIFunction as formatToOpenAIFunction, convertToOpenAITool as formatToOpenAITool, };
 export function formatToOpenAIAssistantTool(tool) {
     return {
         type: "function",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/openai",
-  "version": "0.0.10",
+  "version": "0.0.12",
   "description": "OpenAI integrations for LangChain.js",
   "type": "module",
   "engines": {
@@ -35,9 +35,9 @@
   "author": "LangChain",
   "license": "MIT",
   "dependencies": {
-    "@langchain/core": "~0.1.9",
+    "@langchain/core": "~0.1.13",
     "js-tiktoken": "^1.0.7",
-    "openai": "^4.19.0",
+    "openai": "^4.24.2",
     "zod": "^3.22.3",
     "zod-to-json-schema": "3.20.3"
   },