@langchain/openai 0.3.1 → 0.3.2

package/dist/index.cjs

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toFile = exports.OpenAIClient = void 0;
+exports.convertPromptToOpenAI = exports.toFile = exports.OpenAIClient = void 0;
 var openai_1 = require("openai");
 Object.defineProperty(exports, "OpenAIClient", { enumerable: true, get: function () { return openai_1.OpenAI; } });
 Object.defineProperty(exports, "toFile", { enumerable: true, get: function () { return openai_1.toFile; } });
@@ -28,3 +28,5 @@ __exportStar(require("./types.cjs"), exports);
 __exportStar(require("./utils/openai.cjs"), exports);
 __exportStar(require("./utils/azure.cjs"), exports);
 __exportStar(require("./tools/index.cjs"), exports);
+var prompts_js_1 = require("./utils/prompts.cjs");
+Object.defineProperty(exports, "convertPromptToOpenAI", { enumerable: true, get: function () { return prompts_js_1.convertPromptToOpenAI; } });

package/dist/index.d.ts

@@ -9,3 +9,4 @@ export * from "./types.js";
 export * from "./utils/openai.js";
 export * from "./utils/azure.js";
 export * from "./tools/index.js";
+export { convertPromptToOpenAI } from "./utils/prompts.js";

package/dist/index.js

@@ -9,3 +9,4 @@ export * from "./types.js";
 export * from "./utils/openai.js";
 export * from "./utils/azure.js";
 export * from "./tools/index.js";
+export { convertPromptToOpenAI } from "./utils/prompts.js";

package/dist/utils/prompts.cjs

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertPromptToOpenAI = void 0;
+const chat_models_js_1 = require("../chat_models.cjs");
+/**
+ * Convert a formatted LangChain prompt (e.g. pulled from the hub) into
+ * a format expected by OpenAI's JS SDK.
+ *
+ * Requires the "@langchain/openai" package to be installed in addition
+ * to the OpenAI SDK.
+ *
+ * @example
+ * ```ts
+ * import { convertPromptToOpenAI } from "langsmith/utils/hub/openai";
+ * import { pull } from "langchain/hub";
+ *
+ * import OpenAI from 'openai';
+ *
+ * const prompt = await pull("jacob/joke-generator");
+ * const formattedPrompt = await prompt.invoke({
+ *   topic: "cats",
+ * });
+ *
+ * const { messages } = convertPromptToOpenAI(formattedPrompt);
+ *
+ * const openAIClient = new OpenAI();
+ *
+ * const openaiResponse = await openAIClient.chat.completions.create({
+ *   model: "gpt-4o",
+ *   messages,
+ * });
+ * ```
+ * @param formattedPrompt
+ * @returns A partial OpenAI payload.
+ */
+function convertPromptToOpenAI(formattedPrompt) {
+    const messages = formattedPrompt.toChatMessages();
+    return {
+        messages: (0, chat_models_js_1._convertMessagesToOpenAIParams)(messages),
+    };
+}
+exports.convertPromptToOpenAI = convertPromptToOpenAI;

package/dist/utils/prompts.d.ts

@@ -0,0 +1,36 @@
+import type { BasePromptValue } from "@langchain/core/prompt_values";
+import type { OpenAI } from "openai";
+/**
+ * Convert a formatted LangChain prompt (e.g. pulled from the hub) into
+ * a format expected by OpenAI's JS SDK.
+ *
+ * Requires the "@langchain/openai" package to be installed in addition
+ * to the OpenAI SDK.
+ *
+ * @example
+ * ```ts
+ * import { convertPromptToOpenAI } from "langsmith/utils/hub/openai";
+ * import { pull } from "langchain/hub";
+ *
+ * import OpenAI from 'openai';
+ *
+ * const prompt = await pull("jacob/joke-generator");
+ * const formattedPrompt = await prompt.invoke({
+ *   topic: "cats",
+ * });
+ *
+ * const { messages } = convertPromptToOpenAI(formattedPrompt);
+ *
+ * const openAIClient = new OpenAI();
+ *
+ * const openaiResponse = await openAIClient.chat.completions.create({
+ *   model: "gpt-4o",
+ *   messages,
+ * });
+ * ```
+ * @param formattedPrompt
+ * @returns A partial OpenAI payload.
+ */
+export declare function convertPromptToOpenAI(formattedPrompt: BasePromptValue): {
+    messages: OpenAI.Chat.ChatCompletionMessageParam[];
+};

package/dist/utils/prompts.js

@@ -0,0 +1,38 @@
+import { _convertMessagesToOpenAIParams } from "../chat_models.js";
+/**
+ * Convert a formatted LangChain prompt (e.g. pulled from the hub) into
+ * a format expected by OpenAI's JS SDK.
+ *
+ * Requires the "@langchain/openai" package to be installed in addition
+ * to the OpenAI SDK.
+ *
+ * @example
+ * ```ts
+ * import { convertPromptToOpenAI } from "langsmith/utils/hub/openai";
+ * import { pull } from "langchain/hub";
+ *
+ * import OpenAI from 'openai';
+ *
+ * const prompt = await pull("jacob/joke-generator");
+ * const formattedPrompt = await prompt.invoke({
+ *   topic: "cats",
+ * });
+ *
+ * const { messages } = convertPromptToOpenAI(formattedPrompt);
+ *
+ * const openAIClient = new OpenAI();
+ *
+ * const openaiResponse = await openAIClient.chat.completions.create({
+ *   model: "gpt-4o",
+ *   messages,
+ * });
+ * ```
+ * @param formattedPrompt
+ * @returns A partial OpenAI payload.
+ */
+export function convertPromptToOpenAI(formattedPrompt) {
+    const messages = formattedPrompt.toChatMessages();
+    return {
+        messages: _convertMessagesToOpenAIParams(messages),
+    };
+}

package/package.json

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