@langchain/openai 0.0.10 → 0.0.11

package/dist/chat_models.cjs

@@ -266,6 +266,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 +363,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 +410,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,
@@ -526,9 +542,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

@@ -262,6 +262,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 +359,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 +406,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,
@@ -522,9 +538,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.d.ts

@@ -1,5 +1,6 @@
 import { type OpenAI as OpenAIClient } from "openai";
 import type { StructuredToolInterface } from "@langchain/core/tools";
+import type { FunctionDefinition } from "@langchain/core/language_models/base";
 export declare function wrapOpenAIClientError(e: any): any;
 /**
  * Formats a `StructuredTool` instance into a format that is compatible
@@ -7,6 +8,6 @@ export declare function wrapOpenAIClientError(e: any): any;
  * 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 formatToOpenAIFunction(tool: StructuredToolInterface): FunctionDefinition;
 export declare function formatToOpenAITool(tool: StructuredToolInterface): OpenAIClient.Chat.ChatCompletionTool;
 export declare function formatToOpenAIAssistantTool(tool: StructuredToolInterface): OpenAIClient.Beta.AssistantCreateParams.AssistantToolsFunction;

package/package.json

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