modelfusion 0.103.0 → 0.105.0

package/model-provider/openai/{chat/OpenAIChatFunctionCallStructureGenerationModel.cjs → OpenAIChatFunctionCallStructureGenerationModel.cjs}

@@ -5,7 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenAIChatFunctionCallStructureGenerationModel = void 0;
 const secure_json_parse_1 = __importDefault(require("secure-json-parse"));
-const StructureParseError_js_1 = require("../../../model-function/generate-structure/StructureParseError.cjs");
+const StructureParseError_js_1 = require("../../model-function/generate-structure/StructureParseError.cjs");
+const parsePartialJson_js_1 = require("../../model-function/generate-structure/parsePartialJson.cjs");
 const AbstractOpenAIChatModel_js_1 = require("./AbstractOpenAIChatModel.cjs");
 const OpenAIChatPromptTemplate_js_1 = require("./OpenAIChatPromptTemplate.cjs");
 class OpenAIChatFunctionCallStructureGenerationModel {
@@ -132,7 +133,7 @@ class OpenAIChatFunctionCallStructureGenerationModel {
         const expandedPrompt = this.promptTemplate.format(prompt);
         return this.model.callAPI(expandedPrompt, {
             ...options,
-            responseFormat: AbstractOpenAIChatModel_js_1.OpenAIChatResponseFormat.structureDeltaIterable,
+            responseFormat: AbstractOpenAIChatModel_js_1.OpenAIChatResponseFormat.deltaIterable,
             functionCall: { name: this.fnName },
             functions: [
                 {
@@ -143,5 +144,20 @@ class OpenAIChatFunctionCallStructureGenerationModel {
             ],
         });
     }
+    extractStructureTextDelta(delta) {
+        const chunk = delta;
+        if (chunk.object !== "chat.completion.chunk") {
+            return undefined;
+        }
+        const chatChunk = chunk;
+        const firstChoice = chatChunk.choices[0];
+        if (firstChoice.index > 0) {
+            return undefined;
+        }
+        return firstChoice.delta.function_call?.arguments;
+    }
+    parseAccumulatedStructureText(accumulatedText) {
+        return (0, parsePartialJson_js_1.parsePartialJson)(accumulatedText);
+    }
 }
 exports.OpenAIChatFunctionCallStructureGenerationModel = OpenAIChatFunctionCallStructureGenerationModel;

package/model-provider/openai/{chat/OpenAIChatFunctionCallStructureGenerationModel.d.ts → OpenAIChatFunctionCallStructureGenerationModel.d.ts}

@@ -1,11 +1,11 @@
-import { FunctionOptions } from "../../../core/FunctionOptions.js";
-import { JsonSchemaProducer } from "../../../core/schema/JsonSchemaProducer.js";
-import { Schema } from "../../../core/schema/Schema.js";
-import { StructureGenerationModel } from "../../../model-function/generate-structure/StructureGenerationModel.js";
-import { TextGenerationPromptTemplate } from "../../../model-function/generate-text/TextGenerationPromptTemplate.js";
+import { FunctionOptions } from "../../core/FunctionOptions.js";
+import { JsonSchemaProducer } from "../../core/schema/JsonSchemaProducer.js";
+import { Schema } from "../../core/schema/Schema.js";
+import { StructureStreamingModel } from "../../model-function/generate-structure/StructureGenerationModel.js";
+import { TextGenerationPromptTemplate } from "../../model-function/generate-text/TextGenerationPromptTemplate.js";
 import { OpenAIChatPrompt } from "./AbstractOpenAIChatModel.js";
-import { OpenAIChatModel, OpenAIChatSettings } from "./OpenAIChatModel";
-export declare class OpenAIChatFunctionCallStructureGenerationModel<PROMPT_TEMPLATE extends TextGenerationPromptTemplate<unknown, OpenAIChatPrompt>> implements StructureGenerationModel<Parameters<PROMPT_TEMPLATE["format"]>[0], // first argument of the function
+import { OpenAIChatModel, OpenAIChatSettings } from "./OpenAIChatModel.js";
+export declare class OpenAIChatFunctionCallStructureGenerationModel<PROMPT_TEMPLATE extends TextGenerationPromptTemplate<unknown, OpenAIChatPrompt>> implements StructureStreamingModel<Parameters<PROMPT_TEMPLATE["format"]>[0], // first argument of the function
 OpenAIChatSettings> {
     readonly model: OpenAIChatModel;
     readonly fnName: string;
@@ -17,7 +17,7 @@ OpenAIChatSettings> {
         fnDescription?: string;
         promptTemplate: PROMPT_TEMPLATE;
     });
-    get modelInformation(): import("../../../index.js").ModelInformation;
+    get modelInformation(): import("../../index.js").ModelInformation;
     get settings(): OpenAIChatSettings;
     get settingsForEvent(): Partial<OpenAIChatSettings>;
     /**
@@ -27,11 +27,11 @@ OpenAIChatSettings> {
     /**
      * Returns this model with an instruction prompt template.
      */
-    withInstructionPrompt(): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptTemplate<import("../../../index.js").MultiModalInstructionPrompt | import("../../../index.js").TextInstructionPrompt, OpenAIChatPrompt>>;
+    withInstructionPrompt(): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptTemplate<import("../../index.js").InstructionPrompt, OpenAIChatPrompt>>;
     /**
      * Returns this model with a chat prompt template.
      */
-    withChatPrompt(): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptTemplate<import("../../../index.js").TextChatPrompt | import("../../../index.js").MultiModalChatPrompt, OpenAIChatPrompt>>;
+    withChatPrompt(): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptTemplate<import("../../index.js").ChatPrompt, OpenAIChatPrompt>>;
     withPromptTemplate<TARGET_PROMPT_FORMAT extends TextGenerationPromptTemplate<unknown, OpenAIChatPrompt>>(promptTemplate: TARGET_PROMPT_FORMAT): OpenAIChatFunctionCallStructureGenerationModel<TARGET_PROMPT_FORMAT>;
     withSettings(additionalSettings: Partial<OpenAIChatSettings>): this;
     /**
@@ -85,5 +85,35 @@ OpenAIChatSettings> {
         };
     }>;
     doStreamStructure(schema: Schema<unknown> & JsonSchemaProducer, prompt: Parameters<PROMPT_TEMPLATE["format"]>[0], // first argument of the function
-    options?: FunctionOptions): Promise<AsyncIterable<import("../../../index.js").Delta<unknown>>>;
+    options?: FunctionOptions): Promise<AsyncIterable<import("../../index.js").Delta<{
+        object: "chat.completion.chunk";
+        model: string;
+        id: string;
+        created: number;
+        choices: {
+            delta: {
+                role?: "user" | "assistant" | undefined;
+                content?: string | null | undefined;
+                function_call?: {
+                    name?: string | undefined;
+                    arguments?: string | undefined;
+                } | undefined;
+                tool_calls?: {
+                    function: {
+                        name: string;
+                        arguments: string;
+                    };
+                    type: "function";
+                    id: string;
+                }[] | undefined;
+            };
+            index: number;
+            finish_reason?: "length" | "stop" | "function_call" | "tool_calls" | "content_filter" | null | undefined;
+        }[];
+        system_fingerprint?: string | null | undefined;
+    } | {
+        object: string;
+    }>>>;
+    extractStructureTextDelta(delta: unknown): string | undefined;
+    parseAccumulatedStructureText(accumulatedText: string): unknown;
 }

package/model-provider/openai/{chat/OpenAIChatFunctionCallStructureGenerationModel.js → OpenAIChatFunctionCallStructureGenerationModel.js}

@@ -1,5 +1,6 @@
 import SecureJSON from "secure-json-parse";
-import { StructureParseError } from "../../../model-function/generate-structure/StructureParseError.js";
+import { StructureParseError } from "../../model-function/generate-structure/StructureParseError.js";
+import { parsePartialJson } from "../../model-function/generate-structure/parsePartialJson.js";
 import { OpenAIChatResponseFormat, } from "./AbstractOpenAIChatModel.js";
 import { chat, instruction, text } from "./OpenAIChatPromptTemplate.js";
 export class OpenAIChatFunctionCallStructureGenerationModel {
@@ -126,7 +127,7 @@ export class OpenAIChatFunctionCallStructureGenerationModel {
         const expandedPrompt = this.promptTemplate.format(prompt);
         return this.model.callAPI(expandedPrompt, {
             ...options,
-            responseFormat: OpenAIChatResponseFormat.structureDeltaIterable,
+            responseFormat: OpenAIChatResponseFormat.deltaIterable,
             functionCall: { name: this.fnName },
             functions: [
                 {
@@ -137,4 +138,19 @@ export class OpenAIChatFunctionCallStructureGenerationModel {
             ],
         });
     }
+    extractStructureTextDelta(delta) {
+        const chunk = delta;
+        if (chunk.object !== "chat.completion.chunk") {
+            return undefined;
+        }
+        const chatChunk = chunk;
+        const firstChoice = chatChunk.choices[0];
+        if (firstChoice.index > 0) {
+            return undefined;
+        }
+        return firstChoice.delta.function_call?.arguments;
+    }
+    parseAccumulatedStructureText(accumulatedText) {
+        return parsePartialJson(accumulatedText);
+    }
 }

package/model-provider/openai/{chat/OpenAIChatMessage.d.ts → OpenAIChatMessage.d.ts}

@@ -1,5 +1,5 @@
-import { MultiModalInput } from "../../../model-function/generate-text/prompt-template/Content.js";
-import { ToolCall } from "../../../tool/ToolCall.js";
+import { ImagePart, TextPart } from "../../model-function/generate-text/prompt-template/ContentPart.js";
+import { ToolCall } from "../../tool/ToolCall.js";
 export type OpenAIChatMessage = {
     role: "system";
     content: string;
@@ -50,7 +50,7 @@ export declare const OpenAIChatMessage: {
     /**
      * Creates a user chat message. The message can be a string or a multi-modal input.
      */
-    user(content: string | MultiModalInput, options?: {
+    user(content: string | Array<TextPart | ImagePart>, options?: {
         name?: string;
     }): OpenAIChatMessage;
     /**

package/model-provider/openai/{chat/OpenAIChatModel.cjs → OpenAIChatModel.cjs}

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenAIChatModel = exports.calculateOpenAIChatCostInMillicents = exports.isOpenAIChatModel = exports.getOpenAIChatModelInformation = exports.OPENAI_CHAT_MODELS = void 0;
-const StructureFromTextStreamingModel_js_1 = require("../../../model-function/generate-structure/StructureFromTextStreamingModel.cjs");
-const PromptTemplateTextStreamingModel_js_1 = require("../../../model-function/generate-text/PromptTemplateTextStreamingModel.cjs");
-const TextGenerationModel_js_1 = require("../../../model-function/generate-text/TextGenerationModel.cjs");
-const TikTokenTokenizer_js_1 = require("../TikTokenTokenizer.cjs");
+const StructureFromTextStreamingModel_js_1 = require("../../model-function/generate-structure/StructureFromTextStreamingModel.cjs");
+const PromptTemplateFullTextModel_js_1 = require("../../model-function/generate-text/PromptTemplateFullTextModel.cjs");
+const TextGenerationModel_js_1 = require("../../model-function/generate-text/TextGenerationModel.cjs");
 const AbstractOpenAIChatModel_js_1 = require("./AbstractOpenAIChatModel.cjs");
 const OpenAIChatFunctionCallStructureGenerationModel_js_1 = require("./OpenAIChatFunctionCallStructureGenerationModel.cjs");
 const OpenAIChatPromptTemplate_js_1 = require("./OpenAIChatPromptTemplate.cjs");
+const TikTokenTokenizer_js_1 = require("./TikTokenTokenizer.cjs");
 const countOpenAIChatMessageTokens_js_1 = require("./countOpenAIChatMessageTokens.cjs");
 /*
  * Available OpenAI chat models, their token limits, and pricing.
@@ -243,7 +243,7 @@ class OpenAIChatModel extends AbstractOpenAIChatModel_js_1.AbstractOpenAIChatMod
         return this.withPromptTemplate((0, OpenAIChatPromptTemplate_js_1.chat)());
     }
     withPromptTemplate(promptTemplate) {
-        return new PromptTemplateTextStreamingModel_js_1.PromptTemplateTextStreamingModel({
+        return new PromptTemplateFullTextModel_js_1.PromptTemplateFullTextModel({
             model: this.withSettings({
                 stopSequences: [
                     ...(this.settings.stopSequences ?? []),

package/model-provider/openai/{chat/OpenAIChatModel.d.ts → OpenAIChatModel.d.ts}

@@ -1,13 +1,13 @@
-import { StructureFromTextPromptTemplate } from "../../../model-function/generate-structure/StructureFromTextPromptTemplate.js";
-import { StructureFromTextStreamingModel } from "../../../model-function/generate-structure/StructureFromTextStreamingModel.js";
-import { PromptTemplateTextStreamingModel } from "../../../model-function/generate-text/PromptTemplateTextStreamingModel.js";
-import { TextGenerationModelSettings, TextStreamingModel } from "../../../model-function/generate-text/TextGenerationModel.js";
-import { TextGenerationPromptTemplate } from "../../../model-function/generate-text/TextGenerationPromptTemplate.js";
-import { ToolCallGenerationModel } from "../../../tool/generate-tool-call/ToolCallGenerationModel.js";
-import { ToolCallsOrTextGenerationModel } from "../../../tool/generate-tool-calls-or-text/ToolCallsOrTextGenerationModel.js";
-import { TikTokenTokenizer } from "../TikTokenTokenizer.js";
+import { StructureFromTextPromptTemplate } from "../../model-function/generate-structure/StructureFromTextPromptTemplate.js";
+import { StructureFromTextStreamingModel } from "../../model-function/generate-structure/StructureFromTextStreamingModel.js";
+import { PromptTemplateFullTextModel } from "../../model-function/generate-text/PromptTemplateFullTextModel.js";
+import { TextGenerationModelSettings, TextStreamingModel } from "../../model-function/generate-text/TextGenerationModel.js";
+import { TextGenerationPromptTemplate } from "../../model-function/generate-text/TextGenerationPromptTemplate.js";
+import { ToolCallGenerationModel } from "../../tool/generate-tool-call/ToolCallGenerationModel.js";
+import { ToolCallsOrTextGenerationModel } from "../../tool/generate-tool-calls-or-text/ToolCallsOrTextGenerationModel.js";
 import { AbstractOpenAIChatCallSettings, AbstractOpenAIChatModel, OpenAIChatPrompt, OpenAIChatResponse } from "./AbstractOpenAIChatModel.js";
 import { OpenAIChatFunctionCallStructureGenerationModel } from "./OpenAIChatFunctionCallStructureGenerationModel.js";
+import { TikTokenTokenizer } from "./TikTokenTokenizer.js";
 export declare const OPENAI_CHAT_MODELS: {
     "gpt-4": {
         contextWindowSize: number;
@@ -147,16 +147,16 @@ export declare class OpenAIChatModel extends AbstractOpenAIChatModel<OpenAIChatS
     /**
      * Returns this model with a text prompt template.
      */
-    withTextPrompt(): PromptTemplateTextStreamingModel<string, OpenAIChatPrompt, OpenAIChatSettings, this>;
+    withTextPrompt(): PromptTemplateFullTextModel<string, OpenAIChatPrompt, OpenAIChatSettings, this>;
     /**
      * Returns this model with an instruction prompt template.
      */
-    withInstructionPrompt(): PromptTemplateTextStreamingModel<import("../../../index.js").MultiModalInstructionPrompt | import("../../../index.js").TextInstructionPrompt, OpenAIChatPrompt, OpenAIChatSettings, this>;
+    withInstructionPrompt(): PromptTemplateFullTextModel<import("../../index.js").InstructionPrompt, OpenAIChatPrompt, OpenAIChatSettings, this>;
     /**
      * Returns this model with a chat prompt template.
      */
-    withChatPrompt(): PromptTemplateTextStreamingModel<import("../../../index.js").TextChatPrompt | import("../../../index.js").MultiModalChatPrompt, OpenAIChatPrompt, OpenAIChatSettings, this>;
-    withPromptTemplate<INPUT_PROMPT>(promptTemplate: TextGenerationPromptTemplate<INPUT_PROMPT, OpenAIChatPrompt>): PromptTemplateTextStreamingModel<INPUT_PROMPT, OpenAIChatPrompt, OpenAIChatSettings, this>;
+    withChatPrompt(): PromptTemplateFullTextModel<import("../../index.js").ChatPrompt, OpenAIChatPrompt, OpenAIChatSettings, this>;
+    withPromptTemplate<INPUT_PROMPT>(promptTemplate: TextGenerationPromptTemplate<INPUT_PROMPT, OpenAIChatPrompt>): PromptTemplateFullTextModel<INPUT_PROMPT, OpenAIChatPrompt, OpenAIChatSettings, this>;
     withSettings(additionalSettings: Partial<OpenAIChatSettings>): this;
 }
 export {};

package/model-provider/openai/{chat/OpenAIChatModel.js → OpenAIChatModel.js}

@@ -1,10 +1,10 @@
-import { StructureFromTextStreamingModel } from "../../../model-function/generate-structure/StructureFromTextStreamingModel.js";
-import { PromptTemplateTextStreamingModel } from "../../../model-function/generate-text/PromptTemplateTextStreamingModel.js";
-import { textGenerationModelProperties, } from "../../../model-function/generate-text/TextGenerationModel.js";
-import { TikTokenTokenizer } from "../TikTokenTokenizer.js";
+import { StructureFromTextStreamingModel } from "../../model-function/generate-structure/StructureFromTextStreamingModel.js";
+import { PromptTemplateFullTextModel } from "../../model-function/generate-text/PromptTemplateFullTextModel.js";
+import { textGenerationModelProperties, } from "../../model-function/generate-text/TextGenerationModel.js";
 import { AbstractOpenAIChatModel, } from "./AbstractOpenAIChatModel.js";
 import { OpenAIChatFunctionCallStructureGenerationModel } from "./OpenAIChatFunctionCallStructureGenerationModel.js";
 import { chat, identity, instruction, text, } from "./OpenAIChatPromptTemplate.js";
+import { TikTokenTokenizer } from "./TikTokenTokenizer.js";
 import { countOpenAIChatPromptTokens } from "./countOpenAIChatMessageTokens.js";
 /*
  * Available OpenAI chat models, their token limits, and pricing.
@@ -237,7 +237,7 @@ export class OpenAIChatModel extends AbstractOpenAIChatModel {
         return this.withPromptTemplate(chat());
     }
     withPromptTemplate(promptTemplate) {
-        return new PromptTemplateTextStreamingModel({
+        return new PromptTemplateFullTextModel({
             model: this.withSettings({
                 stopSequences: [
                     ...(this.settings.stopSequences ?? []),

package/model-provider/openai/OpenAIChatModel.test.cjs

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const zod_1 = require("zod");
+const ZodSchema_js_1 = require("../../core/schema/ZodSchema.cjs");
+const streamStructure_js_1 = require("../../model-function/generate-structure/streamStructure.cjs");
+const streamText_js_1 = require("../../model-function/generate-text/streamText.cjs");
+const StreamingTestServer_js_1 = require("../../test/StreamingTestServer.cjs");
+const arrayFromAsync_js_1 = require("../../test/arrayFromAsync.cjs");
+const OpenAIApiConfiguration_js_1 = require("./OpenAIApiConfiguration.cjs");
+const OpenAIChatModel_js_1 = require("./OpenAIChatModel.cjs");
+describe("streamText", () => {
+    const server = new StreamingTestServer_js_1.StreamingTestServer("https://api.openai.com/v1/chat/completions");
+    server.setupTestEnvironment();
+    it("should return only values from the first choice when using streamText", async () => {
+        server.responseChunks = [
+            `data: {"id":"chatcmpl-123","object":"chat.completion.chunk","created":1702657020,"model":"gpt-3.5-turbo-0613",` +
+                `"system_fingerprint":null,"choices":[{"index":0,"delta":{"role":"assistant","content":""},"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-123","object":"chat.completion.chunk","created":1702657020,"model":"gpt-3.5-turbo-0613",` +
+                `"system_fingerprint":null,"choices":[{"index":0,"delta":{"content":"A"},"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-123","object":"chat.completion.chunk","created":1702657020,"model":"gpt-3.5-turbo-0613",` +
+                `"system_fingerprint":null,"choices":[{"index":1,"delta":{"role":"assistant","content":""},"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-123","object":"chat.completion.chunk","created":1702657020,"model":"gpt-3.5-turbo-0613",` +
+                `"system_fingerprint":null,"choices":[{"index":1,"delta":{"content":"B"},"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-123","object":"chat.completion.chunk","created":1702657020,"model":"gpt-3.5-turbo-0613",` +
+                `"system_fingerprint":null,"choices":[{"index":0,"delta":{},"finish_reason":"stop"}]}\n\n`,
+            `data: {"id":"chatcmpl-123","object":"chat.completion.chunk","created":1702657020,"model":"gpt-3.5-turbo-0613",` +
+                `"system_fingerprint":null,"choices":[{"index":1,"delta":{},"finish_reason":"stop"}]}\n\n`,
+            "data: [DONE]\n\n",
+        ];
+        const stream = await (0, streamText_js_1.streamText)(new OpenAIChatModel_js_1.OpenAIChatModel({
+            api: new OpenAIApiConfiguration_js_1.OpenAIApiConfiguration({ apiKey: "test-key" }),
+            model: "gpt-3.5-turbo",
+            numberOfGenerations: 2,
+        }).withTextPrompt(), "test prompt");
+        expect(await (0, arrayFromAsync_js_1.arrayFromAsync)(stream)).toStrictEqual(["A"]);
+    });
+});
+describe("streamStructure", () => {
+    const server = new StreamingTestServer_js_1.StreamingTestServer("https://api.openai.com/v1/chat/completions");
+    server.setupTestEnvironment();
+    it("should return a text stream", async () => {
+        server.responseChunks = [
+            `data: {"id":"chatcmpl-8ZhZtizjTCGmZaPRwyUiuDJ1DYUD0","object":"chat.completion.chunk",` +
+                `"created":1703519685,"model":"gpt-3.5-turbo-0613","system_fingerprint":null,` +
+                `"choices":[{"index":0,"delta":{"role":"assistant","content":null,` +
+                `"function_call":{"name":"generateCharacter","arguments":""}},"logprobs":null,"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-8ZhZtizjTCGmZaPRwyUiuDJ1DYUD0","object":"chat.completion.chunk",` +
+                `"created":1703519685,"model":"gpt-3.5-turbo-0613","system_fingerprint":null,` +
+                `"choices":[{"index":0,"delta":{"function_call":{"arguments":"{\\n"}},"logprobs":null,"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-8ZhZtizjTCGmZaPRwyUiuDJ1DYUD0","object":"chat.completion.chunk",` +
+                `"created":1703519685,"model":"gpt-3.5-turbo-0613","system_fingerprint":null,` +
+                `"choices":[{"index":0,"delta":{"function_call":{"arguments":" "}},"logprobs":null,"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-8ZhZtizjTCGmZaPRwyUiuDJ1DYUD0","object":"chat.completion.chunk",` +
+                `"created":1703519685,"model":"gpt-3.5-turbo-0613","system_fingerprint":null,` +
+                `"choices":[{"index":0,"delta":{"function_call":{"arguments":" \\""}},"logprobs":null,"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-8ZhZtizjTCGmZaPRwyUiuDJ1DYUD0","object":"chat.completion.chunk",` +
+                `"created":1703519685,"model":"gpt-3.5-turbo-0613","system_fingerprint":null,` +
+                `"choices":[{"index":0,"delta":{"function_call":{"arguments":"name"}},"logprobs":null,"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-8ZhZtizjTCGmZaPRwyUiuDJ1DYUD0","object":"chat.completion.chunk",` +
+                `"created":1703519685,"model":"gpt-3.5-turbo-0613","system_fingerprint":null,` +
+                `"choices":[{"index":0,"delta":{"function_call":{"arguments":"\\":\\""}},"logprobs":null,"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-8ZhZtizjTCGmZaPRwyUiuDJ1DYUD0","object":"chat.completion.chunk",` +
+                `"created":1703519685,"model":"gpt-3.5-turbo-0613","system_fingerprint":null,` +
+                `"choices":[{"index":0,"delta":{"function_call":{"arguments":"M"}},"logprobs":null,"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-8ZhZtizjTCGmZaPRwyUiuDJ1DYUD0","object":"chat.completion.chunk",` +
+                `"created":1703519685,"model":"gpt-3.5-turbo-0613","system_fingerprint":null,` +
+                `"choices":[{"index":0,"delta":{"function_call":{"arguments":"ike\\"\\n"}},"logprobs":null,"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-8ZhZtizjTCGmZaPRwyUiuDJ1DYUD0","object":"chat.completion.chunk",` +
+                `"created":1703519685,"model":"gpt-3.5-turbo-0613","system_fingerprint":null,` +
+                `"choices":[{"index":0,"delta":{"function_call":{"arguments":"}"}},"logprobs":null,"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-8ZhZtizjTCGmZaPRwyUiuDJ1DYUD0","object":"chat.completion.chunk",` +
+                `"created":1703519685,"model":"gpt-3.5-turbo-0613","system_fingerprint":null,` +
+                `"choices":[{"index":0,"delta":{},"logprobs":null,"finish_reason":"stop"}]}\n\n`,
+            `data: [DONE]\n\n`,
+        ];
+        const stream = await (0, streamStructure_js_1.streamStructure)(new OpenAIChatModel_js_1.OpenAIChatModel({
+            api: new OpenAIApiConfiguration_js_1.OpenAIApiConfiguration({ apiKey: "test-key" }),
+            model: "gpt-3.5-turbo",
+        })
+            .asFunctionCallStructureGenerationModel({
+            fnName: "generateCharacter",
+            fnDescription: "Generate character descriptions.",
+        })
+            .withTextPrompt(), (0, ZodSchema_js_1.zodSchema)(zod_1.z.object({ name: zod_1.z.string() })), "generate a name");
+        // note: space moved to last chunk bc of trimming
+        expect(await (0, arrayFromAsync_js_1.arrayFromAsync)(stream)).toStrictEqual([
+            { isComplete: false, value: {} },
+            { isComplete: false, value: { name: "" } },
+            { isComplete: false, value: { name: "M" } },
+            { isComplete: false, value: { name: "Mike" } },
+            { isComplete: true, value: { name: "Mike" } },
+        ]);
+    });
+});

package/model-provider/openai/OpenAIChatModel.test.d.ts

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

package/model-provider/openai/OpenAIChatModel.test.js

@@ -0,0 +1,92 @@
+import { z } from "zod";
+import { zodSchema } from "../../core/schema/ZodSchema.js";
+import { streamStructure } from "../../model-function/generate-structure/streamStructure.js";
+import { streamText } from "../../model-function/generate-text/streamText.js";
+import { StreamingTestServer } from "../../test/StreamingTestServer.js";
+import { arrayFromAsync } from "../../test/arrayFromAsync.js";
+import { OpenAIApiConfiguration } from "./OpenAIApiConfiguration.js";
+import { OpenAIChatModel } from "./OpenAIChatModel.js";
+describe("streamText", () => {
+    const server = new StreamingTestServer("https://api.openai.com/v1/chat/completions");
+    server.setupTestEnvironment();
+    it("should return only values from the first choice when using streamText", async () => {
+        server.responseChunks = [
+            `data: {"id":"chatcmpl-123","object":"chat.completion.chunk","created":1702657020,"model":"gpt-3.5-turbo-0613",` +
+                `"system_fingerprint":null,"choices":[{"index":0,"delta":{"role":"assistant","content":""},"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-123","object":"chat.completion.chunk","created":1702657020,"model":"gpt-3.5-turbo-0613",` +
+                `"system_fingerprint":null,"choices":[{"index":0,"delta":{"content":"A"},"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-123","object":"chat.completion.chunk","created":1702657020,"model":"gpt-3.5-turbo-0613",` +
+                `"system_fingerprint":null,"choices":[{"index":1,"delta":{"role":"assistant","content":""},"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-123","object":"chat.completion.chunk","created":1702657020,"model":"gpt-3.5-turbo-0613",` +
+                `"system_fingerprint":null,"choices":[{"index":1,"delta":{"content":"B"},"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-123","object":"chat.completion.chunk","created":1702657020,"model":"gpt-3.5-turbo-0613",` +
+                `"system_fingerprint":null,"choices":[{"index":0,"delta":{},"finish_reason":"stop"}]}\n\n`,
+            `data: {"id":"chatcmpl-123","object":"chat.completion.chunk","created":1702657020,"model":"gpt-3.5-turbo-0613",` +
+                `"system_fingerprint":null,"choices":[{"index":1,"delta":{},"finish_reason":"stop"}]}\n\n`,
+            "data: [DONE]\n\n",
+        ];
+        const stream = await streamText(new OpenAIChatModel({
+            api: new OpenAIApiConfiguration({ apiKey: "test-key" }),
+            model: "gpt-3.5-turbo",
+            numberOfGenerations: 2,
+        }).withTextPrompt(), "test prompt");
+        expect(await arrayFromAsync(stream)).toStrictEqual(["A"]);
+    });
+});
+describe("streamStructure", () => {
+    const server = new StreamingTestServer("https://api.openai.com/v1/chat/completions");
+    server.setupTestEnvironment();
+    it("should return a text stream", async () => {
+        server.responseChunks = [
+            `data: {"id":"chatcmpl-8ZhZtizjTCGmZaPRwyUiuDJ1DYUD0","object":"chat.completion.chunk",` +
+                `"created":1703519685,"model":"gpt-3.5-turbo-0613","system_fingerprint":null,` +
+                `"choices":[{"index":0,"delta":{"role":"assistant","content":null,` +
+                `"function_call":{"name":"generateCharacter","arguments":""}},"logprobs":null,"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-8ZhZtizjTCGmZaPRwyUiuDJ1DYUD0","object":"chat.completion.chunk",` +
+                `"created":1703519685,"model":"gpt-3.5-turbo-0613","system_fingerprint":null,` +
+                `"choices":[{"index":0,"delta":{"function_call":{"arguments":"{\\n"}},"logprobs":null,"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-8ZhZtizjTCGmZaPRwyUiuDJ1DYUD0","object":"chat.completion.chunk",` +
+                `"created":1703519685,"model":"gpt-3.5-turbo-0613","system_fingerprint":null,` +
+                `"choices":[{"index":0,"delta":{"function_call":{"arguments":" "}},"logprobs":null,"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-8ZhZtizjTCGmZaPRwyUiuDJ1DYUD0","object":"chat.completion.chunk",` +
+                `"created":1703519685,"model":"gpt-3.5-turbo-0613","system_fingerprint":null,` +
+                `"choices":[{"index":0,"delta":{"function_call":{"arguments":" \\""}},"logprobs":null,"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-8ZhZtizjTCGmZaPRwyUiuDJ1DYUD0","object":"chat.completion.chunk",` +
+                `"created":1703519685,"model":"gpt-3.5-turbo-0613","system_fingerprint":null,` +
+                `"choices":[{"index":0,"delta":{"function_call":{"arguments":"name"}},"logprobs":null,"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-8ZhZtizjTCGmZaPRwyUiuDJ1DYUD0","object":"chat.completion.chunk",` +
+                `"created":1703519685,"model":"gpt-3.5-turbo-0613","system_fingerprint":null,` +
+                `"choices":[{"index":0,"delta":{"function_call":{"arguments":"\\":\\""}},"logprobs":null,"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-8ZhZtizjTCGmZaPRwyUiuDJ1DYUD0","object":"chat.completion.chunk",` +
+                `"created":1703519685,"model":"gpt-3.5-turbo-0613","system_fingerprint":null,` +
+                `"choices":[{"index":0,"delta":{"function_call":{"arguments":"M"}},"logprobs":null,"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-8ZhZtizjTCGmZaPRwyUiuDJ1DYUD0","object":"chat.completion.chunk",` +
+                `"created":1703519685,"model":"gpt-3.5-turbo-0613","system_fingerprint":null,` +
+                `"choices":[{"index":0,"delta":{"function_call":{"arguments":"ike\\"\\n"}},"logprobs":null,"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-8ZhZtizjTCGmZaPRwyUiuDJ1DYUD0","object":"chat.completion.chunk",` +
+                `"created":1703519685,"model":"gpt-3.5-turbo-0613","system_fingerprint":null,` +
+                `"choices":[{"index":0,"delta":{"function_call":{"arguments":"}"}},"logprobs":null,"finish_reason":null}]}\n\n`,
+            `data: {"id":"chatcmpl-8ZhZtizjTCGmZaPRwyUiuDJ1DYUD0","object":"chat.completion.chunk",` +
+                `"created":1703519685,"model":"gpt-3.5-turbo-0613","system_fingerprint":null,` +
+                `"choices":[{"index":0,"delta":{},"logprobs":null,"finish_reason":"stop"}]}\n\n`,
+            `data: [DONE]\n\n`,
+        ];
+        const stream = await streamStructure(new OpenAIChatModel({
+            api: new OpenAIApiConfiguration({ apiKey: "test-key" }),
+            model: "gpt-3.5-turbo",
+        })
+            .asFunctionCallStructureGenerationModel({
+            fnName: "generateCharacter",
+            fnDescription: "Generate character descriptions.",
+        })
+            .withTextPrompt(), zodSchema(z.object({ name: z.string() })), "generate a name");
+        // note: space moved to last chunk bc of trimming
+        expect(await arrayFromAsync(stream)).toStrictEqual([
+            { isComplete: false, value: {} },
+            { isComplete: false, value: { name: "" } },
+            { isComplete: false, value: { name: "M" } },
+            { isComplete: false, value: { name: "Mike" } },
+            { isComplete: true, value: { name: "Mike" } },
+        ]);
+    });
+});

package/model-provider/openai/OpenAIChatPromptTemplate.cjs

@@ -0,0 +1,114 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.chat = exports.instruction = exports.text = exports.identity = void 0;
+const OpenAIChatMessage_js_1 = require("./OpenAIChatMessage.cjs");
+/**
+ * OpenAIMessage[] identity chat format.
+ */
+function identity() {
+    return { format: (prompt) => prompt, stopSequences: [] };
+}
+exports.identity = identity;
+/**
+ * Formats a text prompt as an OpenAI chat prompt.
+ */
+function text() {
+    return {
+        format: (prompt) => [OpenAIChatMessage_js_1.OpenAIChatMessage.user(prompt)],
+        stopSequences: [],
+    };
+}
+exports.text = text;
+/**
+ * Formats an instruction prompt as an OpenAI chat prompt.
+ */
+function instruction() {
+    return {
+        format(prompt) {
+            const messages = [];
+            if (prompt.system != null) {
+                messages.push(OpenAIChatMessage_js_1.OpenAIChatMessage.system(prompt.system));
+            }
+            messages.push(OpenAIChatMessage_js_1.OpenAIChatMessage.user(prompt.instruction));
+            return messages;
+        },
+        stopSequences: [],
+    };
+}
+exports.instruction = instruction;
+/**
+ * Formats a chat prompt as an OpenAI chat prompt.
+ */
+function chat() {
+    return {
+        format(prompt) {
+            const messages = [];
+            if (prompt.system != null) {
+                messages.push(OpenAIChatMessage_js_1.OpenAIChatMessage.system(prompt.system));
+            }
+            for (const { role, content } of prompt.messages) {
+                switch (role) {
+                    case "user": {
+                        messages.push(OpenAIChatMessage_js_1.OpenAIChatMessage.user(content));
+                        break;
+                    }
+                    case "assistant": {
+                        if (typeof content === "string") {
+                            messages.push(OpenAIChatMessage_js_1.OpenAIChatMessage.assistant(content));
+                        }
+                        else {
+                            let text = "";
+                            const toolCalls = [];
+                            for (const part of content) {
+                                switch (part.type) {
+                                    case "text": {
+                                        text += part.text;
+                                        break;
+                                    }
+                                    case "tool-call": {
+                                        toolCalls.push({
+                                            id: part.id,
+                                            type: "function",
+                                            function: {
+                                                name: part.name,
+                                                arguments: JSON.stringify(part.args),
+                                            },
+                                        });
+                                        break;
+                                    }
+                                    default: {
+                                        const _exhaustiveCheck = part;
+                                        throw new Error(`Unsupported part: ${_exhaustiveCheck}`);
+                                    }
+                                }
+                            }
+                            messages.push({
+                                role: "assistant",
+                                content: text,
+                                tool_calls: toolCalls,
+                            });
+                        }
+                        break;
+                    }
+                    case "tool": {
+                        for (const toolResponse of content) {
+                            messages.push({
+                                role: "tool",
+                                tool_call_id: toolResponse.id,
+                                content: JSON.stringify(toolResponse.response),
+                            });
+                        }
+                        break;
+                    }
+                    default: {
+                        const _exhaustiveCheck = role;
+                        throw new Error(`Unsupported role: ${_exhaustiveCheck}`);
+                    }
+                }
+            }
+            return messages;
+        },
+        stopSequences: [],
+    };
+}
+exports.chat = chat;

package/model-provider/openai/OpenAIChatPromptTemplate.d.ts

@@ -0,0 +1,20 @@
+import { TextGenerationPromptTemplate } from "../../model-function/generate-text/TextGenerationPromptTemplate.js";
+import { ChatPrompt } from "../../model-function/generate-text/prompt-template/ChatPrompt.js";
+import { InstructionPrompt } from "../../model-function/generate-text/prompt-template/InstructionPrompt.js";
+import { OpenAIChatPrompt } from "./AbstractOpenAIChatModel.js";
+/**
+ * OpenAIMessage[] identity chat format.
+ */
+export declare function identity(): TextGenerationPromptTemplate<OpenAIChatPrompt, OpenAIChatPrompt>;
+/**
+ * Formats a text prompt as an OpenAI chat prompt.
+ */
+export declare function text(): TextGenerationPromptTemplate<string, OpenAIChatPrompt>;
+/**
+ * Formats an instruction prompt as an OpenAI chat prompt.
+ */
+export declare function instruction(): TextGenerationPromptTemplate<InstructionPrompt, OpenAIChatPrompt>;
+/**
+ * Formats a chat prompt as an OpenAI chat prompt.
+ */
+export declare function chat(): TextGenerationPromptTemplate<ChatPrompt, OpenAIChatPrompt>;