modelfusion 0.132.0 → 0.134.0

package/model-provider/cohere/CohereTextGenerationModel.d.ts

@@ -1,379 +0,0 @@
-import { z } from "zod";
-import { FunctionCallOptions } from "../../core/FunctionOptions.js";
-import { ApiConfiguration } from "../../core/api/ApiConfiguration.js";
-import { ResponseHandler } from "../../core/api/postToApi.js";
-import { AbstractModel } from "../../model-function/AbstractModel.js";
-import { PromptTemplateTextStreamingModel } from "../../model-function/generate-text/PromptTemplateTextStreamingModel.js";
-import { TextGenerationModelSettings, TextStreamingBaseModel } from "../../model-function/generate-text/TextGenerationModel.js";
-import { TextGenerationPromptTemplate } from "../../model-function/generate-text/TextGenerationPromptTemplate.js";
-import { TextGenerationFinishReason } from "../../model-function/generate-text/TextGenerationResult.js";
-import { CohereTokenizer } from "./CohereTokenizer.js";
-export declare const COHERE_TEXT_GENERATION_MODELS: {
-    command: {
-        contextWindowSize: number;
-    };
-    "command-light": {
-        contextWindowSize: number;
-    };
-};
-export type CohereTextGenerationModelType = keyof typeof COHERE_TEXT_GENERATION_MODELS;
-export interface CohereTextGenerationModelSettings extends TextGenerationModelSettings {
-    api?: ApiConfiguration;
-    model: CohereTextGenerationModelType;
-    temperature?: number;
-    k?: number;
-    p?: number;
-    frequencyPenalty?: number;
-    presencePenalty?: number;
-    returnLikelihoods?: "GENERATION" | "ALL" | "NONE";
-    logitBias?: Record<string, number>;
-    truncate?: "NONE" | "START" | "END";
-    cohereStopSequences?: string[];
-}
-/**
- * Create a text generation model that calls the Cohere Co.Generate API.
- *
- * @see https://docs.cohere.com/reference/generate
- *
- * @example
- * const model = new CohereTextGenerationModel({
- *   model: "command",
- *   temperature: 0.7,
- *   maxGenerationTokens: 500,
- * });
- *
- * const text = await generateText(
- *    model,
- *   "Write a short story about a robot learning to love:\n\n"
- * );
- */
-export declare class CohereTextGenerationModel extends AbstractModel<CohereTextGenerationModelSettings> implements TextStreamingBaseModel<string, CohereTextGenerationModelSettings> {
-    constructor(settings: CohereTextGenerationModelSettings);
-    readonly provider: "cohere";
-    get modelName(): "command" | "command-light";
-    readonly contextWindowSize: number;
-    readonly tokenizer: CohereTokenizer;
-    countPromptTokens(input: string): Promise<number>;
-    callAPI<RESPONSE>(prompt: string, callOptions: FunctionCallOptions, options: {
-        responseFormat: CohereTextGenerationResponseFormatType<RESPONSE>;
-    }): Promise<RESPONSE>;
-    get settingsForEvent(): Partial<CohereTextGenerationModelSettings>;
-    doGenerateTexts(prompt: string, options: FunctionCallOptions): Promise<{
-        rawResponse: {
-            prompt: string;
-            id: string;
-            generations: {
-                text: string;
-                id: string;
-                finish_reason?: string | undefined;
-            }[];
-            meta?: {
-                api_version: {
-                    version: string;
-                };
-            } | undefined;
-        };
-        textGenerationResults: {
-            text: string;
-            finishReason: TextGenerationFinishReason;
-        }[];
-    }>;
-    restoreGeneratedTexts(rawResponse: unknown): {
-        rawResponse: {
-            prompt: string;
-            id: string;
-            generations: {
-                text: string;
-                id: string;
-                finish_reason?: string | undefined;
-            }[];
-            meta?: {
-                api_version: {
-                    version: string;
-                };
-            } | undefined;
-        };
-        textGenerationResults: {
-            text: string;
-            finishReason: TextGenerationFinishReason;
-        }[];
-    };
-    processTextGenerationResponse(rawResponse: CohereTextGenerationResponse): {
-        rawResponse: {
-            prompt: string;
-            id: string;
-            generations: {
-                text: string;
-                id: string;
-                finish_reason?: string | undefined;
-            }[];
-            meta?: {
-                api_version: {
-                    version: string;
-                };
-            } | undefined;
-        };
-        textGenerationResults: {
-            text: string;
-            finishReason: TextGenerationFinishReason;
-        }[];
-    };
-    private translateFinishReason;
-    doStreamText(prompt: string, options: FunctionCallOptions): Promise<AsyncIterable<import("../../index.js").Delta<{
-        text: string;
-        is_finished: false;
-    } | {
-        response: {
-            prompt: string;
-            id: string;
-            generations: {
-                text: string;
-                id: string;
-                finish_reason?: string | undefined;
-            }[];
-            meta?: {
-                api_version: {
-                    version: string;
-                };
-            } | undefined;
-        };
-        finish_reason: string;
-        is_finished: true;
-    }>>>;
-    extractTextDelta(delta: unknown): string;
-    withJsonOutput(): this;
-    withTextPrompt(): PromptTemplateTextStreamingModel<string, string, CohereTextGenerationModelSettings, this>;
-    withInstructionPrompt(): PromptTemplateTextStreamingModel<import("../../index.js").InstructionPrompt, string, CohereTextGenerationModelSettings, this>;
-    withChatPrompt(options?: {
-        user?: string;
-        assistant?: string;
-    }): PromptTemplateTextStreamingModel<import("../../index.js").ChatPrompt, string, CohereTextGenerationModelSettings, this>;
-    withPromptTemplate<INPUT_PROMPT>(promptTemplate: TextGenerationPromptTemplate<INPUT_PROMPT, string>): PromptTemplateTextStreamingModel<INPUT_PROMPT, string, CohereTextGenerationModelSettings, this>;
-    withSettings(additionalSettings: Partial<CohereTextGenerationModelSettings>): this;
-}
-declare const cohereTextGenerationResponseSchema: z.ZodObject<{
-    id: z.ZodString;
-    generations: z.ZodArray<z.ZodObject<{
-        id: z.ZodString;
-        text: z.ZodString;
-        finish_reason: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        text: string;
-        id: string;
-        finish_reason?: string | undefined;
-    }, {
-        text: string;
-        id: string;
-        finish_reason?: string | undefined;
-    }>, "many">;
-    prompt: z.ZodString;
-    meta: z.ZodOptional<z.ZodObject<{
-        api_version: z.ZodObject<{
-            version: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            version: string;
-        }, {
-            version: string;
-        }>;
-    }, "strip", z.ZodTypeAny, {
-        api_version: {
-            version: string;
-        };
-    }, {
-        api_version: {
-            version: string;
-        };
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    prompt: string;
-    id: string;
-    generations: {
-        text: string;
-        id: string;
-        finish_reason?: string | undefined;
-    }[];
-    meta?: {
-        api_version: {
-            version: string;
-        };
-    } | undefined;
-}, {
-    prompt: string;
-    id: string;
-    generations: {
-        text: string;
-        id: string;
-        finish_reason?: string | undefined;
-    }[];
-    meta?: {
-        api_version: {
-            version: string;
-        };
-    } | undefined;
-}>;
-export type CohereTextGenerationResponse = z.infer<typeof cohereTextGenerationResponseSchema>;
-declare const cohereTextStreamChunkSchema: z.ZodDiscriminatedUnion<"is_finished", [z.ZodObject<{
-    text: z.ZodString;
-    is_finished: z.ZodLiteral<false>;
-}, "strip", z.ZodTypeAny, {
-    text: string;
-    is_finished: false;
-}, {
-    text: string;
-    is_finished: false;
-}>, z.ZodObject<{
-    is_finished: z.ZodLiteral<true>;
-    finish_reason: z.ZodString;
-    response: z.ZodObject<{
-        id: z.ZodString;
-        generations: z.ZodArray<z.ZodObject<{
-            id: z.ZodString;
-            text: z.ZodString;
-            finish_reason: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            text: string;
-            id: string;
-            finish_reason?: string | undefined;
-        }, {
-            text: string;
-            id: string;
-            finish_reason?: string | undefined;
-        }>, "many">;
-        prompt: z.ZodString;
-        meta: z.ZodOptional<z.ZodObject<{
-            api_version: z.ZodObject<{
-                version: z.ZodString;
-            }, "strip", z.ZodTypeAny, {
-                version: string;
-            }, {
-                version: string;
-            }>;
-        }, "strip", z.ZodTypeAny, {
-            api_version: {
-                version: string;
-            };
-        }, {
-            api_version: {
-                version: string;
-            };
-        }>>;
-    }, "strip", z.ZodTypeAny, {
-        prompt: string;
-        id: string;
-        generations: {
-            text: string;
-            id: string;
-            finish_reason?: string | undefined;
-        }[];
-        meta?: {
-            api_version: {
-                version: string;
-            };
-        } | undefined;
-    }, {
-        prompt: string;
-        id: string;
-        generations: {
-            text: string;
-            id: string;
-            finish_reason?: string | undefined;
-        }[];
-        meta?: {
-            api_version: {
-                version: string;
-            };
-        } | undefined;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    response: {
-        prompt: string;
-        id: string;
-        generations: {
-            text: string;
-            id: string;
-            finish_reason?: string | undefined;
-        }[];
-        meta?: {
-            api_version: {
-                version: string;
-            };
-        } | undefined;
-    };
-    finish_reason: string;
-    is_finished: true;
-}, {
-    response: {
-        prompt: string;
-        id: string;
-        generations: {
-            text: string;
-            id: string;
-            finish_reason?: string | undefined;
-        }[];
-        meta?: {
-            api_version: {
-                version: string;
-            };
-        } | undefined;
-    };
-    finish_reason: string;
-    is_finished: true;
-}>]>;
-export type CohereTextStreamChunk = z.infer<typeof cohereTextStreamChunkSchema>;
-export type CohereTextGenerationResponseFormatType<T> = {
-    stream: boolean;
-    handler: ResponseHandler<T>;
-};
-export declare const CohereTextGenerationResponseFormat: {
-    /**
-     * Returns the response as a JSON object.
-     */
-    json: {
-        stream: boolean;
-        handler: ResponseHandler<{
-            prompt: string;
-            id: string;
-            generations: {
-                text: string;
-                id: string;
-                finish_reason?: string | undefined;
-            }[];
-            meta?: {
-                api_version: {
-                    version: string;
-                };
-            } | undefined;
-        }>;
-    };
-    /**
-     * Returns an async iterable over the full deltas (all choices, including full current state at time of event)
-     * of the response stream.
-     */
-    deltaIterable: {
-        stream: boolean;
-        handler: ({ response }: {
-            response: Response;
-        }) => Promise<AsyncIterable<import("../../index.js").Delta<{
-            text: string;
-            is_finished: false;
-        } | {
-            response: {
-                prompt: string;
-                id: string;
-                generations: {
-                    text: string;
-                    id: string;
-                    finish_reason?: string | undefined;
-                }[];
-                meta?: {
-                    api_version: {
-                        version: string;
-                    };
-                } | undefined;
-            };
-            finish_reason: string;
-            is_finished: true;
-        }>>>;
-    };
-};
-export {};

package/model-provider/cohere/CohereTextGenerationModel.js

@@ -1,240 +0,0 @@
-import { z } from "zod";
-import { callWithRetryAndThrottle } from "../../core/api/callWithRetryAndThrottle.js";
-import { createJsonResponseHandler, postJsonToApi, } from "../../core/api/postToApi.js";
-import { zodSchema } from "../../core/schema/ZodSchema.js";
-import { validateTypes } from "../../core/schema/validateTypes.js";
-import { AbstractModel } from "../../model-function/AbstractModel.js";
-import { PromptTemplateTextStreamingModel } from "../../model-function/generate-text/PromptTemplateTextStreamingModel.js";
-import { textGenerationModelProperties, } from "../../model-function/generate-text/TextGenerationModel.js";
-import { chat, instruction, text, } from "../../model-function/generate-text/prompt-template/TextPromptTemplate.js";
-import { countTokens } from "../../model-function/tokenize-text/countTokens.js";
-import { createJsonStreamResponseHandler } from "../../util/streaming/createJsonStreamResponseHandler.js";
-import { CohereApiConfiguration } from "./CohereApiConfiguration.js";
-import { failedCohereCallResponseHandler } from "./CohereError.js";
-import { CohereTokenizer } from "./CohereTokenizer.js";
-export const COHERE_TEXT_GENERATION_MODELS = {
-    command: {
-        contextWindowSize: 4096,
-    },
-    "command-light": {
-        contextWindowSize: 4096,
-    },
-};
-/**
- * Create a text generation model that calls the Cohere Co.Generate API.
- *
- * @see https://docs.cohere.com/reference/generate
- *
- * @example
- * const model = new CohereTextGenerationModel({
- *   model: "command",
- *   temperature: 0.7,
- *   maxGenerationTokens: 500,
- * });
- *
- * const text = await generateText(
- *    model,
- *   "Write a short story about a robot learning to love:\n\n"
- * );
- */
-export class CohereTextGenerationModel extends AbstractModel {
-    constructor(settings) {
-        super({ settings });
-        Object.defineProperty(this, "provider", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "cohere"
-        });
-        Object.defineProperty(this, "contextWindowSize", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "tokenizer", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.contextWindowSize =
-            COHERE_TEXT_GENERATION_MODELS[this.settings.model].contextWindowSize;
-        this.tokenizer = new CohereTokenizer({
-            api: this.settings.api,
-            model: this.settings.model,
-        });
-    }
-    get modelName() {
-        return this.settings.model;
-    }
-    async countPromptTokens(input) {
-        return countTokens(this.tokenizer, input);
-    }
-    async callAPI(prompt, callOptions, options) {
-        const api = this.settings.api ?? new CohereApiConfiguration();
-        const responseFormat = options.responseFormat;
-        const abortSignal = callOptions.run?.abortSignal;
-        return callWithRetryAndThrottle({
-            retry: api.retry,
-            throttle: api.throttle,
-            call: async () => postJsonToApi({
-                url: api.assembleUrl(`/generate`),
-                headers: api.headers({
-                    functionType: callOptions.functionType,
-                    functionId: callOptions.functionId,
-                    run: callOptions.run,
-                    callId: callOptions.callId,
-                }),
-                body: {
-                    stream: responseFormat.stream,
-                    model: this.settings.model,
-                    prompt,
-                    num_generations: this.settings.numberOfGenerations,
-                    max_tokens: this.settings.maxGenerationTokens,
-                    temperature: this.settings.temperature,
-                    k: this.settings.k,
-                    p: this.settings.p,
-                    frequency_penalty: this.settings.frequencyPenalty,
-                    presence_penalty: this.settings.presencePenalty,
-                    end_sequences: this.settings.stopSequences,
-                    stop_sequences: this.settings.cohereStopSequences,
-                    return_likelihoods: this.settings.returnLikelihoods,
-                    logit_bias: this.settings.logitBias,
-                    truncate: this.settings.truncate,
-                },
-                failedResponseHandler: failedCohereCallResponseHandler,
-                successfulResponseHandler: responseFormat.handler,
-                abortSignal,
-            }),
-        });
-    }
-    get settingsForEvent() {
-        const eventSettingProperties = [
-            ...textGenerationModelProperties,
-            "temperature",
-            "k",
-            "p",
-            "frequencyPenalty",
-            "presencePenalty",
-            "returnLikelihoods",
-            "logitBias",
-            "truncate",
-            "cohereStopSequences",
-        ];
-        return Object.fromEntries(Object.entries(this.settings).filter(([key]) => eventSettingProperties.includes(key)));
-    }
-    async doGenerateTexts(prompt, options) {
-        return this.processTextGenerationResponse(await this.callAPI(prompt, options, {
-            responseFormat: CohereTextGenerationResponseFormat.json,
-        }));
-    }
-    restoreGeneratedTexts(rawResponse) {
-        return this.processTextGenerationResponse(validateTypes({
-            value: rawResponse,
-            schema: zodSchema(cohereTextGenerationResponseSchema),
-        }));
-    }
-    processTextGenerationResponse(rawResponse) {
-        return {
-            rawResponse,
-            textGenerationResults: rawResponse.generations.map((generation) => ({
-                text: generation.text,
-                finishReason: this.translateFinishReason(generation.finish_reason),
-            })),
-        };
-    }
-    translateFinishReason(finishReason) {
-        switch (finishReason) {
-            case "COMPLETE":
-                return "stop";
-            case "MAX_TOKENS":
-                return "length";
-            case "ERROR_TOXIC":
-                return "content-filter";
-            case "ERROR":
-                return "error";
-            default:
-                return "unknown";
-        }
-    }
-    doStreamText(prompt, options) {
-        return this.callAPI(prompt, options, {
-            responseFormat: CohereTextGenerationResponseFormat.deltaIterable,
-        });
-    }
-    extractTextDelta(delta) {
-        const chunk = delta;
-        return chunk.is_finished === true ? "" : chunk.text;
-    }
-    withJsonOutput() {
-        return this;
-    }
-    withTextPrompt() {
-        return this.withPromptTemplate(text());
-    }
-    withInstructionPrompt() {
-        return this.withPromptTemplate(instruction());
-    }
-    withChatPrompt(options) {
-        return this.withPromptTemplate(chat(options));
-    }
-    withPromptTemplate(promptTemplate) {
-        return new PromptTemplateTextStreamingModel({
-            model: this.withSettings({
-                stopSequences: [
-                    ...(this.settings.stopSequences ?? []),
-                    ...promptTemplate.stopSequences,
-                ],
-            }),
-            promptTemplate,
-        });
-    }
-    withSettings(additionalSettings) {
-        return new CohereTextGenerationModel(Object.assign({}, this.settings, additionalSettings));
-    }
-}
-const cohereTextGenerationResponseSchema = z.object({
-    id: z.string(),
-    generations: z.array(z.object({
-        id: z.string(),
-        text: z.string(),
-        finish_reason: z.string().optional(),
-    })),
-    prompt: z.string(),
-    meta: z
-        .object({
-        api_version: z.object({
-            version: z.string(),
-        }),
-    })
-        .optional(),
-});
-const cohereTextStreamChunkSchema = z.discriminatedUnion("is_finished", [
-    z.object({
-        text: z.string(),
-        is_finished: z.literal(false),
-    }),
-    z.object({
-        is_finished: z.literal(true),
-        finish_reason: z.string(),
-        response: cohereTextGenerationResponseSchema,
-    }),
-]);
-export const CohereTextGenerationResponseFormat = {
-    /**
-     * Returns the response as a JSON object.
-     */
-    json: {
-        stream: false,
-        handler: createJsonResponseHandler(zodSchema(cohereTextGenerationResponseSchema)),
-    },
-    /**
-     * Returns an async iterable over the full deltas (all choices, including full current state at time of event)
-     * of the response stream.
-     */
-    deltaIterable: {
-        stream: true,
-        handler: createJsonStreamResponseHandler(zodSchema(cohereTextStreamChunkSchema)),
-    },
-};

package/model-provider/cohere/CohereTextGenerationModel.test.cjs

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-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 CohereApiConfiguration_js_1 = require("./CohereApiConfiguration.cjs");
-const CohereTextGenerationModel_js_1 = require("./CohereTextGenerationModel.cjs");
-describe("streamText", () => {
-    const server = new StreamingTestServer_js_1.StreamingTestServer("https://api.cohere.ai/v1/generate");
-    server.setupTestEnvironment();
-    it("should return a text stream", async () => {
-        server.responseChunks = [
-            `{"text":"Hello","is_finished":false}\n`,
-            `{"text":", ","is_finished":false}\n`,
-            `{"text":"world!","is_finished":false}\n`,
-            `{"is_finished":true,"finish_reason":"COMPLETE",` +
-                `"response":{"id":"40141e4f-2202-4e09-9188-c6ece324b7ba",` +
-                `"generations":[{"id":"c598f9d2-4a6d-46d6-beed-47d55b996540",` +
-                `"text":"Hello, world!","finish_reason":"COMPLETE"}],` +
-                `"prompt":"hello"}}\n`,
-        ];
-        const stream = await (0, streamText_js_1.streamText)({
-            model: new CohereTextGenerationModel_js_1.CohereTextGenerationModel({
-                api: new CohereApiConfiguration_js_1.CohereApiConfiguration({ apiKey: "test-key" }),
-                model: "command-light",
-            }),
-            prompt: "hello",
-        });
-        // note: space moved to last chunk bc of trimming
-        expect(await (0, arrayFromAsync_js_1.arrayFromAsync)(stream)).toStrictEqual([
-            "Hello",
-            ",",
-            " world!",
-        ]);
-    });
-});

package/model-provider/cohere/CohereTextGenerationModel.test.d.ts

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

package/model-provider/cohere/CohereTextGenerationModel.test.js

@@ -1,34 +0,0 @@
-import { streamText } from "../../model-function/generate-text/streamText.js";
-import { StreamingTestServer } from "../../test/StreamingTestServer.js";
-import { arrayFromAsync } from "../../test/arrayFromAsync.js";
-import { CohereApiConfiguration } from "./CohereApiConfiguration.js";
-import { CohereTextGenerationModel } from "./CohereTextGenerationModel.js";
-describe("streamText", () => {
-    const server = new StreamingTestServer("https://api.cohere.ai/v1/generate");
-    server.setupTestEnvironment();
-    it("should return a text stream", async () => {
-        server.responseChunks = [
-            `{"text":"Hello","is_finished":false}\n`,
-            `{"text":", ","is_finished":false}\n`,
-            `{"text":"world!","is_finished":false}\n`,
-            `{"is_finished":true,"finish_reason":"COMPLETE",` +
-                `"response":{"id":"40141e4f-2202-4e09-9188-c6ece324b7ba",` +
-                `"generations":[{"id":"c598f9d2-4a6d-46d6-beed-47d55b996540",` +
-                `"text":"Hello, world!","finish_reason":"COMPLETE"}],` +
-                `"prompt":"hello"}}\n`,
-        ];
-        const stream = await streamText({
-            model: new CohereTextGenerationModel({
-                api: new CohereApiConfiguration({ apiKey: "test-key" }),
-                model: "command-light",
-            }),
-            prompt: "hello",
-        });
-        // note: space moved to last chunk bc of trimming
-        expect(await arrayFromAsync(stream)).toStrictEqual([
-            "Hello",
-            ",",
-            " world!",
-        ]);
-    });
-});