modelfusion 0.103.0 → 0.105.0

package/model-function/generate-text/prompt-template/Llama2PromptTemplate.js

@@ -1,4 +1,5 @@
-import { validateChatPrompt } from "./ChatPrompt.js";
+import { validateContentIsString } from "./ContentPart.js";
+import { InvalidPromptError } from "./InvalidPromptError.js";
 // see https://github.com/facebookresearch/llama/blob/6c7fe276574e78057f917549435a2554000a876d/llama/generation.py#L44
 const BEGIN_SEGMENT = "<s>";
 const END_SEGMENT = " </s>";
@@ -43,9 +44,10 @@ export function instruction() {
     return {
         stopSequences: [END_SEGMENT],
         format(prompt) {
+            const instruction = validateContentIsString(prompt.instruction, prompt);
             return `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${prompt.system != null
                 ? `${BEGIN_SYSTEM}${prompt.system}${END_SYSTEM}`
-                : ""}${prompt.instruction}${END_INSTRUCTION}${prompt.responsePrefix ?? ""}`;
+                : ""}${instruction}${END_INSTRUCTION}${prompt.responsePrefix ?? ""}`;
         },
     };
 }
@@ -64,7 +66,7 @@ export function instruction() {
 export function chat() {
     return {
         format(prompt) {
-            validateChatPrompt(prompt);
+            validateLlama2Prompt(prompt);
             let text = prompt.system != null
                 ? // Separate section for system message to simplify implementation
                     // (this is slightly different from the original instructions):
@@ -73,13 +75,17 @@ export function chat() {
             for (const { role, content } of prompt.messages) {
                 switch (role) {
                     case "user": {
-                        text += `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${content}${END_INSTRUCTION}`;
+                        const textContent = validateContentIsString(content, prompt);
+                        text += `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${textContent}${END_INSTRUCTION}`;
                         break;
                     }
                     case "assistant": {
-                        text += `${content}${END_SEGMENT}`;
+                        text += `${validateContentIsString(content, prompt)}${END_SEGMENT}`;
                         break;
                     }
+                    case "tool": {
+                        throw new InvalidPromptError("Tool messages are not supported.", prompt);
+                    }
                     default: {
                         const _exhaustiveCheck = role;
                         throw new Error(`Unsupported role: ${_exhaustiveCheck}`);
@@ -91,3 +97,30 @@ export function chat() {
         stopSequences: [END_SEGMENT],
     };
 }
+/**
+ * Checks if a Llama2 chat prompt is valid. Throws a {@link ChatPromptValidationError} if it's not.
+ *
+ * - The first message of the chat must be a user message.
+ * - Then it must be alternating between an assistant message and a user message.
+ * - The last message must always be a user message (when submitting to a model).
+ *
+ * The type checking is done at runtime when you submit a chat prompt to a model with a prompt template.
+ *
+ * @throws {@link ChatPromptValidationError}
+ */
+export function validateLlama2Prompt(chatPrompt) {
+    const messages = chatPrompt.messages;
+    if (messages.length < 1) {
+        throw new InvalidPromptError("ChatPrompt should have at least one message.", chatPrompt);
+    }
+    for (let i = 0; i < messages.length; i++) {
+        const expectedRole = i % 2 === 0 ? "user" : "assistant";
+        const role = messages[i].role;
+        if (role !== expectedRole) {
+            throw new InvalidPromptError(`Message at index ${i} should have role '${expectedRole}', but has role '${role}'.`, chatPrompt);
+        }
+    }
+    if (messages.length % 2 === 0) {
+        throw new InvalidPromptError("The last message must be a user message.", chatPrompt);
+    }
+}

package/model-function/generate-text/prompt-template/NeuralChatPromptTemplate.cjs

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.chat = exports.instruction = exports.text = void 0;
-const ChatPrompt_js_1 = require("./ChatPrompt.cjs");
+const ContentPart_js_1 = require("./ContentPart.cjs");
+const InvalidPromptError_js_1 = require("./InvalidPromptError.cjs");
 const roleNames = {
     system: "System",
     user: "User",
@@ -36,8 +37,9 @@ exports.text = text;
 const instruction = () => ({
     stopSequences: [],
     format(prompt) {
+        const instruction = (0, ContentPart_js_1.validateContentIsString)(prompt.instruction, prompt);
         return (segment("system", prompt.system) +
-            segment("user", prompt.instruction) +
+            segment("user", instruction) +
             segmentStart("assistant") +
             (prompt.responsePrefix ?? ""));
     },
@@ -53,18 +55,21 @@ exports.instruction = instruction;
 function chat() {
     return {
         format(prompt) {
-            (0, ChatPrompt_js_1.validateChatPrompt)(prompt);
             let text = prompt.system != null ? segment("system", prompt.system) : "";
             for (const { role, content } of prompt.messages) {
                 switch (role) {
                     case "user": {
-                        text += segment("user", content);
+                        const textContent = (0, ContentPart_js_1.validateContentIsString)(content, prompt);
+                        text += segment("user", textContent);
                         break;
                     }
                     case "assistant": {
-                        text += segment("assistant", content);
+                        text += segment("assistant", (0, ContentPart_js_1.validateContentIsString)(content, prompt));
                         break;
                     }
+                    case "tool": {
+                        throw new InvalidPromptError_js_1.InvalidPromptError("Tool messages are not supported.", prompt);
+                    }
                     default: {
                         const _exhaustiveCheck = role;
                         throw new Error(`Unsupported role: ${_exhaustiveCheck}`);

package/model-function/generate-text/prompt-template/NeuralChatPromptTemplate.d.ts

@@ -1,6 +1,6 @@
 import { TextGenerationPromptTemplate } from "../TextGenerationPromptTemplate.js";
-import { TextChatPrompt } from "./ChatPrompt.js";
-import { TextInstructionPrompt } from "./InstructionPrompt.js";
+import { ChatPrompt } from "./ChatPrompt.js";
+import { InstructionPrompt } from "./InstructionPrompt.js";
 /**
  * Formats a text prompt as a neural chat prompt.
  *
@@ -12,7 +12,7 @@ export declare function text(): TextGenerationPromptTemplate<string, string>;
  *
  * @see https://huggingface.co/Intel/neural-chat-7b-v3-1#prompt-template
  */
-export declare const instruction: () => TextGenerationPromptTemplate<TextInstructionPrompt, string>;
+export declare const instruction: () => TextGenerationPromptTemplate<InstructionPrompt, string>;
 /**
  * Formats a chat prompt as a basic text prompt.
  *
@@ -20,4 +20,4 @@ export declare const instruction: () => TextGenerationPromptTemplate<TextInstruc
  * @param assistant The label of the assistant in the chat. Default to "assistant".
  * @param system The label of the system in the chat. Optional, defaults to no prefix.
  */
-export declare function chat(): TextGenerationPromptTemplate<TextChatPrompt, string>;
+export declare function chat(): TextGenerationPromptTemplate<ChatPrompt, string>;

package/model-function/generate-text/prompt-template/NeuralChatPromptTemplate.js

@@ -1,4 +1,5 @@
-import { validateChatPrompt } from "./ChatPrompt.js";
+import { validateContentIsString } from "./ContentPart.js";
+import { InvalidPromptError } from "./InvalidPromptError.js";
 const roleNames = {
     system: "System",
     user: "User",
@@ -32,8 +33,9 @@ export function text() {
 export const instruction = () => ({
     stopSequences: [],
     format(prompt) {
+        const instruction = validateContentIsString(prompt.instruction, prompt);
         return (segment("system", prompt.system) +
-            segment("user", prompt.instruction) +
+            segment("user", instruction) +
             segmentStart("assistant") +
             (prompt.responsePrefix ?? ""));
     },
@@ -48,18 +50,21 @@ export const instruction = () => ({
 export function chat() {
     return {
         format(prompt) {
-            validateChatPrompt(prompt);
             let text = prompt.system != null ? segment("system", prompt.system) : "";
             for (const { role, content } of prompt.messages) {
                 switch (role) {
                     case "user": {
-                        text += segment("user", content);
+                        const textContent = validateContentIsString(content, prompt);
+                        text += segment("user", textContent);
                         break;
                     }
                     case "assistant": {
-                        text += segment("assistant", content);
+                        text += segment("assistant", validateContentIsString(content, prompt));
                         break;
                     }
+                    case "tool": {
+                        throw new InvalidPromptError("Tool messages are not supported.", prompt);
+                    }
                     default: {
                         const _exhaustiveCheck = role;
                         throw new Error(`Unsupported role: ${_exhaustiveCheck}`);

package/model-function/generate-text/prompt-template/TextPromptTemplate.cjs

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.chat = exports.instruction = exports.text = void 0;
-const ChatPrompt_js_1 = require("./ChatPrompt.cjs");
+const ContentPart_js_1 = require("./ContentPart.cjs");
+const InvalidPromptError_js_1 = require("./InvalidPromptError.cjs");
 /**
  * Formats a text prompt as a basic text prompt. Does not change the text prompt in any way.
  */
@@ -20,7 +21,7 @@ const instruction = () => ({
         if (prompt.system != null) {
             text += `${prompt.system}\n\n`;
         }
-        text += `${prompt.instruction}\n\n`;
+        text += `${(0, ContentPart_js_1.validateContentIsString)(prompt.instruction, prompt)}\n\n`;
         if (prompt.responsePrefix != null) {
             text += prompt.responsePrefix;
         }
@@ -37,20 +38,22 @@ exports.instruction = instruction;
  */
 const chat = ({ user = "user", assistant = "assistant", system, } = {}) => ({
     format(prompt) {
-        (0, ChatPrompt_js_1.validateChatPrompt)(prompt);
         let text = prompt.system != null
             ? `${system != null ? `${system}:` : ""}${prompt.system}\n\n`
             : "";
         for (const { role, content } of prompt.messages) {
             switch (role) {
                 case "user": {
-                    text += `${user}:\n${content}\n\n`;
+                    text += `${user}:\n${(0, ContentPart_js_1.validateContentIsString)(content, prompt)}\n\n`;
                     break;
                 }
                 case "assistant": {
-                    text += `${assistant}:\n${content}\n\n`;
+                    text += `${assistant}:\n${(0, ContentPart_js_1.validateContentIsString)(content, prompt)}\n\n`;
                     break;
                 }
+                case "tool": {
+                    throw new InvalidPromptError_js_1.InvalidPromptError("Tool messages are not supported.", prompt);
+                }
                 default: {
                     const _exhaustiveCheck = role;
                     throw new Error(`Unsupported role: ${_exhaustiveCheck}`);

package/model-function/generate-text/prompt-template/TextPromptTemplate.d.ts

@@ -1,6 +1,6 @@
 import { TextGenerationPromptTemplate } from "../TextGenerationPromptTemplate.js";
-import { TextChatPrompt } from "./ChatPrompt.js";
-import { TextInstructionPrompt } from "./InstructionPrompt.js";
+import { ChatPrompt } from "./ChatPrompt.js";
+import { InstructionPrompt } from "./InstructionPrompt.js";
 /**
  * Formats a text prompt as a basic text prompt. Does not change the text prompt in any way.
  */
@@ -8,7 +8,7 @@ export declare const text: () => TextGenerationPromptTemplate<string, string>;
 /**
  * Formats an instruction prompt as a basic text prompt.
  */
-export declare const instruction: () => TextGenerationPromptTemplate<TextInstructionPrompt, string>;
+export declare const instruction: () => TextGenerationPromptTemplate<InstructionPrompt, string>;
 /**
  * Formats a chat prompt as a basic text prompt.
  *
@@ -20,4 +20,4 @@ export declare const chat: (options?: {
     user?: string;
     assistant?: string;
     system?: string;
-}) => TextGenerationPromptTemplate<TextChatPrompt, string>;
+}) => TextGenerationPromptTemplate<ChatPrompt, string>;

package/model-function/generate-text/prompt-template/TextPromptTemplate.js

@@ -1,4 +1,5 @@
-import { validateChatPrompt } from "./ChatPrompt.js";
+import { validateContentIsString } from "./ContentPart.js";
+import { InvalidPromptError } from "./InvalidPromptError.js";
 /**
  * Formats a text prompt as a basic text prompt. Does not change the text prompt in any way.
  */
@@ -16,7 +17,7 @@ export const instruction = () => ({
         if (prompt.system != null) {
             text += `${prompt.system}\n\n`;
         }
-        text += `${prompt.instruction}\n\n`;
+        text += `${validateContentIsString(prompt.instruction, prompt)}\n\n`;
         if (prompt.responsePrefix != null) {
             text += prompt.responsePrefix;
         }
@@ -32,20 +33,22 @@ export const instruction = () => ({
  */
 export const chat = ({ user = "user", assistant = "assistant", system, } = {}) => ({
     format(prompt) {
-        validateChatPrompt(prompt);
         let text = prompt.system != null
             ? `${system != null ? `${system}:` : ""}${prompt.system}\n\n`
             : "";
         for (const { role, content } of prompt.messages) {
             switch (role) {
                 case "user": {
-                    text += `${user}:\n${content}\n\n`;
+                    text += `${user}:\n${validateContentIsString(content, prompt)}\n\n`;
                     break;
                 }
                 case "assistant": {
-                    text += `${assistant}:\n${content}\n\n`;
+                    text += `${assistant}:\n${validateContentIsString(content, prompt)}\n\n`;
                     break;
                 }
+                case "tool": {
+                    throw new InvalidPromptError("Tool messages are not supported.", prompt);
+                }
                 default: {
                     const _exhaustiveCheck = role;
                     throw new Error(`Unsupported role: ${_exhaustiveCheck}`);

package/model-function/generate-text/prompt-template/VicunaPromptTemplate.cjs

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.chat = void 0;
-const ChatPrompt_js_1 = require("./ChatPrompt.cjs");
+const ContentPart_js_1 = require("./ContentPart.cjs");
+const InvalidPromptError_js_1 = require("./InvalidPromptError.cjs");
 // default Vicuna 1 system message
 const DEFAULT_SYSTEM_MESSAGE = "A chat between a curious user and an artificial intelligence assistant. " +
     "The assistant gives helpful, detailed, and polite answers to the user's questions.";
@@ -21,20 +22,23 @@ const DEFAULT_SYSTEM_MESSAGE = "A chat between a curious user and an artificial
 function chat() {
     return {
         format(prompt) {
-            (0, ChatPrompt_js_1.validateChatPrompt)(prompt);
             let text = prompt.system != null
                 ? `${prompt.system}\n\n`
                 : `${DEFAULT_SYSTEM_MESSAGE}\n\n`;
             for (const { role, content } of prompt.messages) {
                 switch (role) {
                     case "user": {
-                        text += `USER: ${content}\n`;
+                        const textContent = (0, ContentPart_js_1.validateContentIsString)(content, prompt);
+                        text += `USER: ${textContent}\n`;
                         break;
                     }
                     case "assistant": {
-                        text += `ASSISTANT: ${content}\n`;
+                        text += `ASSISTANT: ${(0, ContentPart_js_1.validateContentIsString)(content, prompt)}\n`;
                         break;
                     }
+                    case "tool": {
+                        throw new InvalidPromptError_js_1.InvalidPromptError("Tool messages are not supported.", prompt);
+                    }
                     default: {
                         const _exhaustiveCheck = role;
                         throw new Error(`Unsupported role: ${_exhaustiveCheck}`);

package/model-function/generate-text/prompt-template/VicunaPromptTemplate.d.ts

@@ -1,5 +1,5 @@
 import { TextGenerationPromptTemplate } from "../TextGenerationPromptTemplate.js";
-import { TextChatPrompt } from "./ChatPrompt.js";
+import { ChatPrompt } from "./ChatPrompt.js";
 /**
  * Formats a chat prompt as a Vicuna prompt.
  *
@@ -13,4 +13,4 @@ import { TextChatPrompt } from "./ChatPrompt.js";
  * ASSISTANT:
  * ```
  */
-export declare function chat(): TextGenerationPromptTemplate<TextChatPrompt, string>;
+export declare function chat(): TextGenerationPromptTemplate<ChatPrompt, string>;

package/model-function/generate-text/prompt-template/VicunaPromptTemplate.js

@@ -1,4 +1,5 @@
-import { validateChatPrompt } from "./ChatPrompt.js";
+import { validateContentIsString } from "./ContentPart.js";
+import { InvalidPromptError } from "./InvalidPromptError.js";
 // default Vicuna 1 system message
 const DEFAULT_SYSTEM_MESSAGE = "A chat between a curious user and an artificial intelligence assistant. " +
     "The assistant gives helpful, detailed, and polite answers to the user's questions.";
@@ -18,20 +19,23 @@ const DEFAULT_SYSTEM_MESSAGE = "A chat between a curious user and an artificial
 export function chat() {
     return {
         format(prompt) {
-            validateChatPrompt(prompt);
             let text = prompt.system != null
                 ? `${prompt.system}\n\n`
                 : `${DEFAULT_SYSTEM_MESSAGE}\n\n`;
             for (const { role, content } of prompt.messages) {
                 switch (role) {
                     case "user": {
-                        text += `USER: ${content}\n`;
+                        const textContent = validateContentIsString(content, prompt);
+                        text += `USER: ${textContent}\n`;
                         break;
                     }
                     case "assistant": {
-                        text += `ASSISTANT: ${content}\n`;
+                        text += `ASSISTANT: ${validateContentIsString(content, prompt)}\n`;
                         break;
                     }
+                    case "tool": {
+                        throw new InvalidPromptError("Tool messages are not supported.", prompt);
+                    }
                     default: {
                         const _exhaustiveCheck = role;
                         throw new Error(`Unsupported role: ${_exhaustiveCheck}`);

package/model-function/generate-text/prompt-template/index.cjs

@@ -30,7 +30,7 @@ exports.VicunaPrompt = exports.TextPrompt = exports.NeuralChatPrompt = exports.L
 exports.AlpacaPrompt = __importStar(require("./AlpacaPromptTemplate.cjs"));
 exports.ChatMLPrompt = __importStar(require("./ChatMLPromptTemplate.cjs"));
 __exportStar(require("./ChatPrompt.cjs"), exports);
-__exportStar(require("./Content.cjs"), exports);
+__exportStar(require("./ContentPart.cjs"), exports);
 __exportStar(require("./InstructionPrompt.cjs"), exports);
 __exportStar(require("./InvalidPromptError.cjs"), exports);
 exports.Llama2Prompt = __importStar(require("./Llama2PromptTemplate.cjs"));

package/model-function/generate-text/prompt-template/index.d.ts

@@ -1,7 +1,7 @@
 export * as AlpacaPrompt from "./AlpacaPromptTemplate.js";
 export * as ChatMLPrompt from "./ChatMLPromptTemplate.js";
 export * from "./ChatPrompt.js";
-export * from "./Content.js";
+export * from "./ContentPart.js";
 export * from "./InstructionPrompt.js";
 export * from "./InvalidPromptError.js";
 export * as Llama2Prompt from "./Llama2PromptTemplate.js";

package/model-function/generate-text/prompt-template/index.js

@@ -1,7 +1,7 @@
 export * as AlpacaPrompt from "./AlpacaPromptTemplate.js";
 export * as ChatMLPrompt from "./ChatMLPromptTemplate.js";
 export * from "./ChatPrompt.js";
-export * from "./Content.js";
+export * from "./ContentPart.js";
 export * from "./InstructionPrompt.js";
 export * from "./InvalidPromptError.js";
 export * as Llama2Prompt from "./Llama2PromptTemplate.js";

package/model-function/generate-text/prompt-template/trimChatPrompt.cjs

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.trimChatPrompt = void 0;
-const ChatPrompt_js_1 = require("./ChatPrompt.cjs");
 /**
  * Keeps only the most recent messages in the prompt, while leaving enough space for the completion.
  *
@@ -14,7 +13,6 @@ const ChatPrompt_js_1 = require("./ChatPrompt.cjs");
  */
 async function trimChatPrompt({ prompt, model, tokenLimit = model.contextWindowSize -
     (model.settings.maxGenerationTokens ?? model.contextWindowSize / 4), }) {
-    (0, ChatPrompt_js_1.validateChatPrompt)(prompt);
     let minimalPrompt = {
         system: prompt.system,
         messages: [prompt.messages[prompt.messages.length - 1]], // last user message

package/model-function/generate-text/prompt-template/trimChatPrompt.d.ts

@@ -1,5 +1,5 @@
 import { HasContextWindowSize, HasTokenizer, TextGenerationModel, TextGenerationModelSettings } from "../TextGenerationModel.js";
-import { TextChatPrompt } from "./ChatPrompt.js";
+import { ChatPrompt } from "./ChatPrompt.js";
 /**
  * Keeps only the most recent messages in the prompt, while leaving enough space for the completion.
  *
@@ -11,7 +11,7 @@ import { TextChatPrompt } from "./ChatPrompt.js";
  * @see https://modelfusion.dev/guide/function/generate-text#limiting-the-chat-length
  */
 export declare function trimChatPrompt({ prompt, model, tokenLimit, }: {
-    prompt: TextChatPrompt;
-    model: TextGenerationModel<TextChatPrompt, TextGenerationModelSettings> & HasTokenizer<TextChatPrompt> & HasContextWindowSize;
+    prompt: ChatPrompt;
+    model: TextGenerationModel<ChatPrompt, TextGenerationModelSettings> & HasTokenizer<ChatPrompt> & HasContextWindowSize;
     tokenLimit?: number;
-}): Promise<TextChatPrompt>;
+}): Promise<ChatPrompt>;

package/model-function/generate-text/prompt-template/trimChatPrompt.js

@@ -1,4 +1,3 @@
-import { validateChatPrompt } from "./ChatPrompt.js";
 /**
  * Keeps only the most recent messages in the prompt, while leaving enough space for the completion.
  *
@@ -11,7 +10,6 @@ import { validateChatPrompt } from "./ChatPrompt.js";
  */
 export async function trimChatPrompt({ prompt, model, tokenLimit = model.contextWindowSize -
     (model.settings.maxGenerationTokens ?? model.contextWindowSize / 4), }) {
-    validateChatPrompt(prompt);
     let minimalPrompt = {
         system: prompt.system,
         messages: [prompt.messages[prompt.messages.length - 1]], // last user message

package/model-function/generate-text/streamText.cjs

@@ -5,9 +5,12 @@ const executeStreamCall_js_1 = require("../executeStreamCall.cjs");
 async function streamText(model, prompt, options) {
     const shouldTrimWhitespace = model.settings.trimWhitespace ?? true;
     let accumulatedText = "";
-    let lastFullDelta;
     let isFirstDelta = true;
     let trailingWhitespace = "";
+    let resolveText;
+    const textPromise = new Promise((resolve) => {
+        resolveText = resolve;
+    });
     const fullResponse = await (0, executeStreamCall_js_1.executeStreamCall)({
         functionType: "stream-text",
         input: prompt,
@@ -15,39 +18,35 @@ async function streamText(model, prompt, options) {
         options,
         startStream: async (options) => model.doStreamText(prompt, options),
         processDelta: (delta) => {
-            lastFullDelta = delta.fullDelta;
-            let textDelta = delta.valueDelta;
-            if (textDelta != null && textDelta.length > 0) {
-                if (shouldTrimWhitespace) {
-                    if (isFirstDelta) {
-                        // remove leading whitespace:
-                        textDelta = textDelta.trimStart();
-                    }
-                    else {
-                        // restore trailing whitespace from previous chunk:
-                        textDelta = trailingWhitespace + textDelta;
-                    }
-                    // trim trailing whitespace and store it for the next chunk:
-                    const trailingWhitespaceMatch = textDelta.match(/\s+$/);
-                    trailingWhitespace = trailingWhitespaceMatch
-                        ? trailingWhitespaceMatch[0]
-                        : "";
-                    textDelta = textDelta.trimEnd();
-                }
-                isFirstDelta = false;
-                accumulatedText += textDelta;
-                return textDelta;
+            let textDelta = model.extractTextDelta(delta.deltaValue);
+            if (textDelta == null || textDelta.length === 0) {
+                return undefined;
+            }
+            if (shouldTrimWhitespace) {
+                textDelta = isFirstDelta
+                    ? // remove leading whitespace:
+                        textDelta.trimStart()
+                    : // restore trailing whitespace from previous chunk:
+                        trailingWhitespace + textDelta;
+                // trim trailing whitespace and store it for the next chunk:
+                const trailingWhitespaceMatch = textDelta.match(/\s+$/);
+                trailingWhitespace = trailingWhitespaceMatch
+                    ? trailingWhitespaceMatch[0]
+                    : "";
+                textDelta = textDelta.trimEnd();
             }
-            return undefined;
+            isFirstDelta = false;
+            accumulatedText += textDelta;
+            return textDelta;
+        },
+        onDone: () => {
+            resolveText(accumulatedText);
         },
-        getResult: () => ({
-            response: lastFullDelta,
-            value: accumulatedText,
-        }),
     });
     return options?.fullResponse
         ? {
             textStream: fullResponse.value,
+            text: textPromise,
             metadata: fullResponse.metadata,
         }
         : fullResponse.value;

package/model-function/generate-text/streamText.d.ts

@@ -33,5 +33,6 @@ export declare function streamText<PROMPT>(model: TextStreamingModel<PROMPT>, pr
     fullResponse: true;
 }): Promise<{
     textStream: AsyncIterable<string>;
+    text: PromiseLike<string>;
     metadata: Omit<ModelCallMetadata, "durationInMs" | "finishTimestamp">;
 }>;

package/model-function/generate-text/streamText.js

@@ -2,9 +2,12 @@ import { executeStreamCall } from "../executeStreamCall.js";
 export async function streamText(model, prompt, options) {
     const shouldTrimWhitespace = model.settings.trimWhitespace ?? true;
     let accumulatedText = "";
-    let lastFullDelta;
     let isFirstDelta = true;
     let trailingWhitespace = "";
+    let resolveText;
+    const textPromise = new Promise((resolve) => {
+        resolveText = resolve;
+    });
     const fullResponse = await executeStreamCall({
         functionType: "stream-text",
         input: prompt,
@@ -12,39 +15,35 @@ export async function streamText(model, prompt, options) {
         options,
         startStream: async (options) => model.doStreamText(prompt, options),
         processDelta: (delta) => {
-            lastFullDelta = delta.fullDelta;
-            let textDelta = delta.valueDelta;
-            if (textDelta != null && textDelta.length > 0) {
-                if (shouldTrimWhitespace) {
-                    if (isFirstDelta) {
-                        // remove leading whitespace:
-                        textDelta = textDelta.trimStart();
-                    }
-                    else {
-                        // restore trailing whitespace from previous chunk:
-                        textDelta = trailingWhitespace + textDelta;
-                    }
-                    // trim trailing whitespace and store it for the next chunk:
-                    const trailingWhitespaceMatch = textDelta.match(/\s+$/);
-                    trailingWhitespace = trailingWhitespaceMatch
-                        ? trailingWhitespaceMatch[0]
-                        : "";
-                    textDelta = textDelta.trimEnd();
-                }
-                isFirstDelta = false;
-                accumulatedText += textDelta;
-                return textDelta;
+            let textDelta = model.extractTextDelta(delta.deltaValue);
+            if (textDelta == null || textDelta.length === 0) {
+                return undefined;
+            }
+            if (shouldTrimWhitespace) {
+                textDelta = isFirstDelta
+                    ? // remove leading whitespace:
+                        textDelta.trimStart()
+                    : // restore trailing whitespace from previous chunk:
+                        trailingWhitespace + textDelta;
+                // trim trailing whitespace and store it for the next chunk:
+                const trailingWhitespaceMatch = textDelta.match(/\s+$/);
+                trailingWhitespace = trailingWhitespaceMatch
+                    ? trailingWhitespaceMatch[0]
+                    : "";
+                textDelta = textDelta.trimEnd();
             }
-            return undefined;
+            isFirstDelta = false;
+            accumulatedText += textDelta;
+            return textDelta;
+        },
+        onDone: () => {
+            resolveText(accumulatedText);
         },
-        getResult: () => ({
-            response: lastFullDelta,
-            value: accumulatedText,
-        }),
     });
     return options?.fullResponse
         ? {
             textStream: fullResponse.value,
+            text: textPromise,
             metadata: fullResponse.metadata,
         }
         : fullResponse.value;