modelfusion 0.74.1 → 0.76.0

package/model-provider/llamacpp/LlamaCppTextEmbeddingModel.d.ts

@@ -6,14 +6,14 @@ import { EmbeddingModel, EmbeddingModelSettings } from "../../model-function/emb
 export interface LlamaCppTextEmbeddingModelSettings extends EmbeddingModelSettings {
     api?: ApiConfiguration;
     embeddingDimensions?: number;
-    isParallizable?: boolean;
+    isParallelizable?: boolean;
 }
 export declare class LlamaCppTextEmbeddingModel extends AbstractModel<LlamaCppTextEmbeddingModelSettings> implements EmbeddingModel<string, LlamaCppTextEmbeddingModelSettings> {
     constructor(settings?: LlamaCppTextEmbeddingModelSettings);
     readonly provider: "llamacpp";
     get modelName(): null;
     readonly maxValuesPerCall = 1;
-    get isParallizable(): boolean;
+    get isParallelizable(): boolean;
     readonly contextWindowSize: undefined;
     get embeddingDimensions(): number | undefined;
     private readonly tokenizer;

package/model-provider/llamacpp/LlamaCppTextEmbeddingModel.js

@@ -37,8 +37,8 @@ export class LlamaCppTextEmbeddingModel extends AbstractModel {
     get modelName() {
         return null;
     }
-    get isParallizable() {
-        return this.settings.isParallizable ?? false;
+    get isParallelizable() {
+        return this.settings.isParallelizable ?? false;
     }
     get embeddingDimensions() {
         return this.settings.embeddingDimensions;

package/model-provider/llamacpp/index.cjs

@@ -26,11 +26,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LlamaCppError = exports.LlamaCppBakLLaVA1Format = void 0;
+exports.llamacpp = exports.LlamaCppError = exports.LlamaCppBakLLaVA1Format = void 0;
 __exportStar(require("./LlamaCppApiConfiguration.cjs"), exports);
 exports.LlamaCppBakLLaVA1Format = __importStar(require("./LlamaCppBakLLaVA1Format.cjs"));
 var LlamaCppError_js_1 = require("./LlamaCppError.cjs");
 Object.defineProperty(exports, "LlamaCppError", { enumerable: true, get: function () { return LlamaCppError_js_1.LlamaCppError; } });
+exports.llamacpp = __importStar(require("./LlamaCppFacade.cjs"));
 __exportStar(require("./LlamaCppTextEmbeddingModel.cjs"), exports);
 __exportStar(require("./LlamaCppTextGenerationModel.cjs"), exports);
 __exportStar(require("./LlamaCppTokenizer.cjs"), exports);

package/model-provider/llamacpp/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./LlamaCppApiConfiguration.js";
 export * as LlamaCppBakLLaVA1Format from "./LlamaCppBakLLaVA1Format.js";
 export { LlamaCppError, LlamaCppErrorData } from "./LlamaCppError.js";
+export * as llamacpp from "./LlamaCppFacade.js";
 export * from "./LlamaCppTextEmbeddingModel.js";
 export * from "./LlamaCppTextGenerationModel.js";
 export * from "./LlamaCppTokenizer.js";

package/model-provider/llamacpp/index.js

@@ -1,6 +1,7 @@
 export * from "./LlamaCppApiConfiguration.js";
 export * as LlamaCppBakLLaVA1Format from "./LlamaCppBakLLaVA1Format.js";
 export { LlamaCppError } from "./LlamaCppError.js";
+export * as llamacpp from "./LlamaCppFacade.js";
 export * from "./LlamaCppTextEmbeddingModel.js";
 export * from "./LlamaCppTextGenerationModel.js";
 export * from "./LlamaCppTokenizer.js";

package/model-provider/lmnt/LmntFacade.cjs

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Speech = void 0;
+const LmntSpeechModel_js_1 = require("./LmntSpeechModel.cjs");
+/**
+ * Synthesize speech using the LMNT API.
+ *
+ * @see https://www.lmnt.com/docs/rest/#synthesize-speech
+ *
+ * @returns A new instance of {@link LmntSpeechModel}.
+ */
+function Speech(settings) {
+    return new LmntSpeechModel_js_1.LmntSpeechModel(settings);
+}
+exports.Speech = Speech;

package/model-provider/lmnt/LmntFacade.d.ts

@@ -0,0 +1,9 @@
+import { LmntSpeechModel, LmntSpeechModelSettings } from "./LmntSpeechModel.js";
+/**
+ * Synthesize speech using the LMNT API.
+ *
+ * @see https://www.lmnt.com/docs/rest/#synthesize-speech
+ *
+ * @returns A new instance of {@link LmntSpeechModel}.
+ */
+export declare function Speech(settings: LmntSpeechModelSettings): LmntSpeechModel;

package/model-provider/lmnt/LmntFacade.js

@@ -0,0 +1,11 @@
+import { LmntSpeechModel } from "./LmntSpeechModel.js";
+/**
+ * Synthesize speech using the LMNT API.
+ *
+ * @see https://www.lmnt.com/docs/rest/#synthesize-speech
+ *
+ * @returns A new instance of {@link LmntSpeechModel}.
+ */
+export function Speech(settings) {
+    return new LmntSpeechModel(settings);
+}

package/model-provider/lmnt/index.cjs

@@ -10,9 +10,23 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.lmnt = void 0;
 __exportStar(require("./LmntApiConfiguration.cjs"), exports);
+exports.lmnt = __importStar(require("./LmntFacade.cjs"));
 __exportStar(require("./LmntSpeechModel.cjs"), exports);

package/model-provider/lmnt/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./LmntApiConfiguration.js";
+export * as lmnt from "./LmntFacade.js";
 export * from "./LmntSpeechModel.js";

package/model-provider/lmnt/index.js

@@ -1,2 +1,3 @@
 export * from "./LmntApiConfiguration.js";
+export * as lmnt from "./LmntFacade.js";
 export * from "./LmntSpeechModel.js";

package/model-provider/ollama/OllamaFacade.cjs

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextEmbedder = exports.TextGenerator = void 0;
+const OllamaTextEmbeddingModel_js_1 = require("./OllamaTextEmbeddingModel.cjs");
+const OllamaTextGenerationModel_js_1 = require("./OllamaTextGenerationModel.cjs");
+function TextGenerator(settings) {
+    return new OllamaTextGenerationModel_js_1.OllamaTextGenerationModel(settings);
+}
+exports.TextGenerator = TextGenerator;
+function TextEmbedder(settings) {
+    return new OllamaTextEmbeddingModel_js_1.OllamaTextEmbeddingModel(settings);
+}
+exports.TextEmbedder = TextEmbedder;

package/model-provider/ollama/OllamaFacade.d.ts

@@ -0,0 +1,4 @@
+import { OllamaTextEmbeddingModel, OllamaTextEmbeddingModelSettings } from "./OllamaTextEmbeddingModel.js";
+import { OllamaTextGenerationModel, OllamaTextGenerationModelSettings } from "./OllamaTextGenerationModel.js";
+export declare function TextGenerator<CONTEXT_WINDOW_SIZE extends number>(settings: OllamaTextGenerationModelSettings<CONTEXT_WINDOW_SIZE>): OllamaTextGenerationModel<CONTEXT_WINDOW_SIZE>;
+export declare function TextEmbedder(settings: OllamaTextEmbeddingModelSettings): OllamaTextEmbeddingModel;

package/model-provider/ollama/OllamaFacade.js

@@ -0,0 +1,8 @@
+import { OllamaTextEmbeddingModel, } from "./OllamaTextEmbeddingModel.js";
+import { OllamaTextGenerationModel, } from "./OllamaTextGenerationModel.js";
+export function TextGenerator(settings) {
+    return new OllamaTextGenerationModel(settings);
+}
+export function TextEmbedder(settings) {
+    return new OllamaTextEmbeddingModel(settings);
+}

package/model-provider/ollama/OllamaTextEmbeddingModel.cjs

@@ -32,8 +32,8 @@ class OllamaTextEmbeddingModel extends AbstractModel_js_1.AbstractModel {
     get modelName() {
         return null;
     }
-    get isParallizable() {
-        return this.settings.isParallizable ?? false;
+    get isParallelizable() {
+        return this.settings.isParallelizable ?? false;
     }
     get embeddingDimensions() {
         return this.settings.embeddingDimensions;

package/model-provider/ollama/OllamaTextEmbeddingModel.d.ts

@@ -7,14 +7,14 @@ export interface OllamaTextEmbeddingModelSettings extends EmbeddingModelSettings
     api?: ApiConfiguration;
     model: string;
     embeddingDimensions?: number;
-    isParallizable?: boolean;
+    isParallelizable?: boolean;
 }
 export declare class OllamaTextEmbeddingModel extends AbstractModel<OllamaTextEmbeddingModelSettings> implements EmbeddingModel<string, OllamaTextEmbeddingModelSettings> {
     constructor(settings: OllamaTextEmbeddingModelSettings);
     readonly provider: "ollama";
     get modelName(): null;
     readonly maxValuesPerCall = 1;
-    get isParallizable(): boolean;
+    get isParallelizable(): boolean;
     readonly contextWindowSize: undefined;
     get embeddingDimensions(): number | undefined;
     callAPI(texts: Array<string>, options?: FunctionOptions): Promise<OllamaTextEmbeddingResponse>;

package/model-provider/ollama/OllamaTextEmbeddingModel.js

@@ -29,8 +29,8 @@ export class OllamaTextEmbeddingModel extends AbstractModel {
     get modelName() {
         return null;
     }
-    get isParallizable() {
-        return this.settings.isParallizable ?? false;
+    get isParallelizable() {
+        return this.settings.isParallelizable ?? false;
     }
     get embeddingDimensions() {
         return this.settings.embeddingDimensions;

package/model-provider/ollama/index.cjs

@@ -10,13 +10,26 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OllamaError = void 0;
+exports.ollama = exports.OllamaError = void 0;
 __exportStar(require("./OllamaApiConfiguration.cjs"), exports);
 var OllamaError_js_1 = require("./OllamaError.cjs");
 Object.defineProperty(exports, "OllamaError", { enumerable: true, get: function () { return OllamaError_js_1.OllamaError; } });
+exports.ollama = __importStar(require("./OllamaFacade.cjs"));
 __exportStar(require("./OllamaTextEmbeddingModel.cjs"), exports);
 __exportStar(require("./OllamaTextGenerationModel.cjs"), exports);

package/model-provider/ollama/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./OllamaApiConfiguration.js";
 export { OllamaError } from "./OllamaError.js";
+export * as ollama from "./OllamaFacade.js";
 export * from "./OllamaTextEmbeddingModel.js";
 export * from "./OllamaTextGenerationModel.js";

package/model-provider/ollama/index.js

@@ -1,4 +1,5 @@
 export * from "./OllamaApiConfiguration.js";
 export { OllamaError } from "./OllamaError.js";
+export * as ollama from "./OllamaFacade.js";
 export * from "./OllamaTextEmbeddingModel.js";
 export * from "./OllamaTextGenerationModel.js";

package/model-provider/openai/OpenAIFacade.cjs

@@ -0,0 +1,148 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Tokenizer = exports.ImageGenerator = exports.Transcription = exports.Speech = exports.TextEmbedder = exports.ChatTextGenerator = exports.CompletionTextGenerator = void 0;
+const OpenAICompletionModel_js_1 = require("./OpenAICompletionModel.cjs");
+const OpenAIImageGenerationModel_js_1 = require("./OpenAIImageGenerationModel.cjs");
+const OpenAISpeechModel_js_1 = require("./OpenAISpeechModel.cjs");
+const OpenAITextEmbeddingModel_js_1 = require("./OpenAITextEmbeddingModel.cjs");
+const OpenAITranscriptionModel_js_1 = require("./OpenAITranscriptionModel.cjs");
+const TikTokenTokenizer_js_1 = require("./TikTokenTokenizer.cjs");
+const OpenAIChatModel_js_1 = require("./chat/OpenAIChatModel.cjs");
+/**
+ * Create a text generation model that calls the OpenAI text completion API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/completions/create
+ *
+ * @example
+ * const model = openai.CompletionTextGenerator({
+ *   model: "gpt-3.5-turbo-instruct",
+ *   temperature: 0.7,
+ *   maxCompletionTokens: 500,
+ *   retry: retryWithExponentialBackoff({ maxTries: 5 }),
+ * });
+ *
+ * const text = await generateText(
+ *   model,
+ *   "Write a short story about a robot learning to love:\n\n"
+ * );
+ *
+ * @return A new instance of {@link OpenAICompletionModel}.
+ */
+function CompletionTextGenerator(settings) {
+    return new OpenAICompletionModel_js_1.OpenAICompletionModel(settings);
+}
+exports.CompletionTextGenerator = CompletionTextGenerator;
+/**
+ * Create a text generation model that calls the OpenAI chat completion API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/chat/create
+ *
+ * @example
+ * const model = openai.ChatTextGenerator({
+ *   model: "gpt-3.5-turbo",
+ *   temperature: 0.7,
+ *   maxCompletionTokens: 500,
+ * });
+ *
+ * const text = await generateText([
+ *   model,
+ *   OpenAIChatMessage.system(
+ *     "Write a short story about a robot learning to love:"
+ *   ),
+ * ]);
+ */
+function ChatTextGenerator(settings) {
+    return new OpenAIChatModel_js_1.OpenAIChatModel(settings);
+}
+exports.ChatTextGenerator = ChatTextGenerator;
+/**
+ * Create a text embedding model that calls the OpenAI embedding API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/embeddings
+ *
+ * @example
+ * const embeddings = await embedMany(
+ *   openai.TextEmbedder({ model: "text-embedding-ada-002" }),
+ *   [
+ *     "At first, Nox didn't know what to do with the pup.",
+ *     "He keenly observed and absorbed everything around him, from the birds in the sky to the trees in the forest.",
+ *   ]
+ * );
+ *
+ * @returns A new instance of {@link OpenAITextEmbeddingModel}.
+ */
+function TextEmbedder(settings) {
+    return new OpenAITextEmbeddingModel_js_1.OpenAITextEmbeddingModel(settings);
+}
+exports.TextEmbedder = TextEmbedder;
+/**
+ * Synthesize speech using the OpenAI API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/audio/createSpeech
+ *
+ * @returns A new instance of {@link OpenAISpeechModel}.
+ */
+function Speech(settings) {
+    return new OpenAISpeechModel_js_1.OpenAISpeechModel(settings);
+}
+exports.Speech = Speech;
+/**
+ * Create a transcription model that calls the OpenAI transcription API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/audio/create
+ *
+ * @example
+ * const data = await fs.promises.readFile("data/test.mp3");
+ *
+ * const transcription = await transcribe(
+ *   openai.Transcription({ model: "whisper-1" }),
+ *   {
+ *     type: "mp3",
+ *     data,
+ *   }
+ * );
+ *
+ * @returns A new instance of {@link OpenAITranscriptionModel}.
+ */
+function Transcription(settings) {
+    return new OpenAITranscriptionModel_js_1.OpenAITranscriptionModel(settings);
+}
+exports.Transcription = Transcription;
+/**
+ * Create an image generation model that calls the OpenAI AI image creation API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/images/create
+ *
+ * @example
+ * const image = await generateImage(
+ *   new OpenAIImageGenerationModel({ size: "512x512" }),
+ *   "the wicked witch of the west in the style of early 19th century painting"
+ * );
+ *
+ * @returns A new instance of {@link OpenAIImageGenerationModel}.
+ */
+function ImageGenerator(settings) {
+    return new OpenAIImageGenerationModel_js_1.OpenAIImageGenerationModel(settings);
+}
+exports.ImageGenerator = ImageGenerator;
+/**
+ * Creates a TikToken tokenizer for OpenAI language models.
+ *
+ * @see https://github.com/openai/tiktoken
+ *
+ * @example
+ * const tokenizer = openai.Tokenizer({ model: "gpt-4" });
+ *
+ * const text = "At first, Nox didn't know what to do with the pup.";
+ *
+ * const tokenCount = await countTokens(tokenizer, text);
+ * const tokens = await tokenizer.tokenize(text);
+ * const tokensAndTokenTexts = await tokenizer.tokenizeWithTexts(text);
+ * const reconstructedText = await tokenizer.detokenize(tokens);
+ *
+ * @returns A new instance of {@link TikTokenTokenizer}.
+ */
+function Tokenizer(settings) {
+    return new TikTokenTokenizer_js_1.TikTokenTokenizer(settings);
+}
+exports.Tokenizer = Tokenizer;

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

@@ -0,0 +1,124 @@
+import { OpenAICompletionModel, OpenAICompletionModelSettings } from "./OpenAICompletionModel.js";
+import { OpenAIImageGenerationModel, OpenAIImageGenerationSettings } from "./OpenAIImageGenerationModel.js";
+import { OpenAISpeechModel, OpenAISpeechModelSettings } from "./OpenAISpeechModel.js";
+import { OpenAITextEmbeddingModel, OpenAITextEmbeddingModelSettings } from "./OpenAITextEmbeddingModel.js";
+import { OpenAITranscriptionModel, OpenAITranscriptionModelSettings } from "./OpenAITranscriptionModel.js";
+import { TikTokenTokenizer, TikTokenTokenizerSettings } from "./TikTokenTokenizer.js";
+import { OpenAIChatModel, OpenAIChatSettings } from "./chat/OpenAIChatModel.js";
+/**
+ * Create a text generation model that calls the OpenAI text completion API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/completions/create
+ *
+ * @example
+ * const model = openai.CompletionTextGenerator({
+ *   model: "gpt-3.5-turbo-instruct",
+ *   temperature: 0.7,
+ *   maxCompletionTokens: 500,
+ *   retry: retryWithExponentialBackoff({ maxTries: 5 }),
+ * });
+ *
+ * const text = await generateText(
+ *   model,
+ *   "Write a short story about a robot learning to love:\n\n"
+ * );
+ *
+ * @return A new instance of {@link OpenAICompletionModel}.
+ */
+export declare function CompletionTextGenerator(settings: OpenAICompletionModelSettings): OpenAICompletionModel;
+/**
+ * Create a text generation model that calls the OpenAI chat completion API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/chat/create
+ *
+ * @example
+ * const model = openai.ChatTextGenerator({
+ *   model: "gpt-3.5-turbo",
+ *   temperature: 0.7,
+ *   maxCompletionTokens: 500,
+ * });
+ *
+ * const text = await generateText([
+ *   model,
+ *   OpenAIChatMessage.system(
+ *     "Write a short story about a robot learning to love:"
+ *   ),
+ * ]);
+ */
+export declare function ChatTextGenerator(settings: OpenAIChatSettings): OpenAIChatModel;
+/**
+ * Create a text embedding model that calls the OpenAI embedding API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/embeddings
+ *
+ * @example
+ * const embeddings = await embedMany(
+ *   openai.TextEmbedder({ model: "text-embedding-ada-002" }),
+ *   [
+ *     "At first, Nox didn't know what to do with the pup.",
+ *     "He keenly observed and absorbed everything around him, from the birds in the sky to the trees in the forest.",
+ *   ]
+ * );
+ *
+ * @returns A new instance of {@link OpenAITextEmbeddingModel}.
+ */
+export declare function TextEmbedder(settings: OpenAITextEmbeddingModelSettings): OpenAITextEmbeddingModel;
+/**
+ * Synthesize speech using the OpenAI API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/audio/createSpeech
+ *
+ * @returns A new instance of {@link OpenAISpeechModel}.
+ */
+export declare function Speech(settings: OpenAISpeechModelSettings): OpenAISpeechModel;
+/**
+ * Create a transcription model that calls the OpenAI transcription API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/audio/create
+ *
+ * @example
+ * const data = await fs.promises.readFile("data/test.mp3");
+ *
+ * const transcription = await transcribe(
+ *   openai.Transcription({ model: "whisper-1" }),
+ *   {
+ *     type: "mp3",
+ *     data,
+ *   }
+ * );
+ *
+ * @returns A new instance of {@link OpenAITranscriptionModel}.
+ */
+export declare function Transcription(settings: OpenAITranscriptionModelSettings): OpenAITranscriptionModel;
+/**
+ * Create an image generation model that calls the OpenAI AI image creation API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/images/create
+ *
+ * @example
+ * const image = await generateImage(
+ *   new OpenAIImageGenerationModel({ size: "512x512" }),
+ *   "the wicked witch of the west in the style of early 19th century painting"
+ * );
+ *
+ * @returns A new instance of {@link OpenAIImageGenerationModel}.
+ */
+export declare function ImageGenerator(settings: OpenAIImageGenerationSettings): OpenAIImageGenerationModel;
+/**
+ * Creates a TikToken tokenizer for OpenAI language models.
+ *
+ * @see https://github.com/openai/tiktoken
+ *
+ * @example
+ * const tokenizer = openai.Tokenizer({ model: "gpt-4" });
+ *
+ * const text = "At first, Nox didn't know what to do with the pup.";
+ *
+ * const tokenCount = await countTokens(tokenizer, text);
+ * const tokens = await tokenizer.tokenize(text);
+ * const tokensAndTokenTexts = await tokenizer.tokenizeWithTexts(text);
+ * const reconstructedText = await tokenizer.detokenize(tokens);
+ *
+ * @returns A new instance of {@link TikTokenTokenizer}.
+ */
+export declare function Tokenizer(settings: TikTokenTokenizerSettings): TikTokenTokenizer;

package/model-provider/openai/OpenAIFacade.js

@@ -0,0 +1,138 @@
+import { OpenAICompletionModel, } from "./OpenAICompletionModel.js";
+import { OpenAIImageGenerationModel, } from "./OpenAIImageGenerationModel.js";
+import { OpenAISpeechModel, } from "./OpenAISpeechModel.js";
+import { OpenAITextEmbeddingModel, } from "./OpenAITextEmbeddingModel.js";
+import { OpenAITranscriptionModel, } from "./OpenAITranscriptionModel.js";
+import { TikTokenTokenizer, } from "./TikTokenTokenizer.js";
+import { OpenAIChatModel } from "./chat/OpenAIChatModel.js";
+/**
+ * Create a text generation model that calls the OpenAI text completion API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/completions/create
+ *
+ * @example
+ * const model = openai.CompletionTextGenerator({
+ *   model: "gpt-3.5-turbo-instruct",
+ *   temperature: 0.7,
+ *   maxCompletionTokens: 500,
+ *   retry: retryWithExponentialBackoff({ maxTries: 5 }),
+ * });
+ *
+ * const text = await generateText(
+ *   model,
+ *   "Write a short story about a robot learning to love:\n\n"
+ * );
+ *
+ * @return A new instance of {@link OpenAICompletionModel}.
+ */
+export function CompletionTextGenerator(settings) {
+    return new OpenAICompletionModel(settings);
+}
+/**
+ * Create a text generation model that calls the OpenAI chat completion API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/chat/create
+ *
+ * @example
+ * const model = openai.ChatTextGenerator({
+ *   model: "gpt-3.5-turbo",
+ *   temperature: 0.7,
+ *   maxCompletionTokens: 500,
+ * });
+ *
+ * const text = await generateText([
+ *   model,
+ *   OpenAIChatMessage.system(
+ *     "Write a short story about a robot learning to love:"
+ *   ),
+ * ]);
+ */
+export function ChatTextGenerator(settings) {
+    return new OpenAIChatModel(settings);
+}
+/**
+ * Create a text embedding model that calls the OpenAI embedding API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/embeddings
+ *
+ * @example
+ * const embeddings = await embedMany(
+ *   openai.TextEmbedder({ model: "text-embedding-ada-002" }),
+ *   [
+ *     "At first, Nox didn't know what to do with the pup.",
+ *     "He keenly observed and absorbed everything around him, from the birds in the sky to the trees in the forest.",
+ *   ]
+ * );
+ *
+ * @returns A new instance of {@link OpenAITextEmbeddingModel}.
+ */
+export function TextEmbedder(settings) {
+    return new OpenAITextEmbeddingModel(settings);
+}
+/**
+ * Synthesize speech using the OpenAI API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/audio/createSpeech
+ *
+ * @returns A new instance of {@link OpenAISpeechModel}.
+ */
+export function Speech(settings) {
+    return new OpenAISpeechModel(settings);
+}
+/**
+ * Create a transcription model that calls the OpenAI transcription API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/audio/create
+ *
+ * @example
+ * const data = await fs.promises.readFile("data/test.mp3");
+ *
+ * const transcription = await transcribe(
+ *   openai.Transcription({ model: "whisper-1" }),
+ *   {
+ *     type: "mp3",
+ *     data,
+ *   }
+ * );
+ *
+ * @returns A new instance of {@link OpenAITranscriptionModel}.
+ */
+export function Transcription(settings) {
+    return new OpenAITranscriptionModel(settings);
+}
+/**
+ * Create an image generation model that calls the OpenAI AI image creation API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/images/create
+ *
+ * @example
+ * const image = await generateImage(
+ *   new OpenAIImageGenerationModel({ size: "512x512" }),
+ *   "the wicked witch of the west in the style of early 19th century painting"
+ * );
+ *
+ * @returns A new instance of {@link OpenAIImageGenerationModel}.
+ */
+export function ImageGenerator(settings) {
+    return new OpenAIImageGenerationModel(settings);
+}
+/**
+ * Creates a TikToken tokenizer for OpenAI language models.
+ *
+ * @see https://github.com/openai/tiktoken
+ *
+ * @example
+ * const tokenizer = openai.Tokenizer({ model: "gpt-4" });
+ *
+ * const text = "At first, Nox didn't know what to do with the pup.";
+ *
+ * const tokenCount = await countTokens(tokenizer, text);
+ * const tokens = await tokenizer.tokenize(text);
+ * const tokensAndTokenTexts = await tokenizer.tokenizeWithTexts(text);
+ * const reconstructedText = await tokenizer.detokenize(tokens);
+ *
+ * @returns A new instance of {@link TikTokenTokenizer}.
+ */
+export function Tokenizer(settings) {
+    return new TikTokenTokenizer(settings);
+}