modelfusion 0.121.2 → 0.123.0

package/CHANGELOG.md

@@ -1,10 +1,87 @@
 # Changelog
 
+## v0.123.0 - 2024-01-13
+
+### Added
+
+- `classify` model function ([docs](https://modelfusion.dev/guide/function/classify)) for classifying values. The `SemanticClassifier` has been renamed to `EmbeddingSimilarityClassifier` and can be used in conjunction with `classify`:
+
+  ```ts
+  import { classify, EmbeddingSimilarityClassifier, openai } from "modelfusion";
+
+  const classifier = new EmbeddingSimilarityClassifier({
+    embeddingModel: openai.TextEmbedder({ model: "text-embedding-ada-002" }),
+    similarityThreshold: 0.82,
+    clusters: [
+      {
+        name: "politics" as const,
+        values: [
+          "they will save the country!",
+          // ...
+        ],
+      },
+      {
+        name: "chitchat" as const,
+        values: [
+          "how's the weather today?",
+          // ...
+        ],
+      },
+    ],
+  });
+
+  // strongly typed result:
+  const result = await classify({
+    model: classifier,
+    value: "don't you love politics?",
+  });
+  ```
+
+## v0.122.0 - 2024-01-13
+
+### Changed
+
+- **breaking change**: Switch from positional parameters to named parameters (parameter object) for all model and tool functions. The parameter object is the first and only parameter of the function. Additional options (last parameter before) are now part of the parameter object. Example:
+
+  ```ts
+  // old:
+  const text = await generateText(
+    openai
+      .ChatTextGenerator({
+        model: "gpt-3.5-turbo",
+        maxGenerationTokens: 1000,
+      })
+      .withTextPrompt(),
+
+    "Write a short story about a robot learning to love",
+
+    {
+      functionId: "example-function",
+    }
+  );
+
+  // new:
+  const text = await generateText({
+    model: openai
+      .ChatTextGenerator({
+        model: "gpt-3.5-turbo",
+        maxGenerationTokens: 1000,
+      })
+      .withTextPrompt(),
+
+    prompt: "Write a short story about a robot learning to love",
+
+    functionId: "example-function",
+  });
+  ```
+
+  This change was made to make the API more flexible and to allow for future extensions.
+
 ## v0.121.2 - 2024-01-11
 
 ### Fixed
 
-- Ollama response schema for repeated calls with Ollama 0.1.19 completion models. Thanks [@jakedetels](https://github.com/Necmttn) for the bugfix!
+- Ollama response schema for repeated calls with Ollama 0.1.19 completion models. Thanks [@Necmttn](https://github.com/Necmttn) for the bugfix!
 
 ## v0.121.1 - 2024-01-10
 

package/README.md

@@ -22,7 +22,7 @@
 - **Built for production**: ModelFusion is fully tree-shakeable, can be used in serverless environments, and only uses a minimal set of dependencies.
 
 > [!NOTE]
-> ModelFusion is getting closer to a stable v1, which is expected in Q1/2024. The main API is now mostly stable, but until version 1.0 there may be breaking changes. Feedback and suggestions are welcome.
+> ModelFusion is getting closer to a stable v1, which is expected in Q2/2024. The main API is now mostly stable, but until version 1.0 there may be breaking changes. Feedback and suggestions are welcome.
 
 ## Quick Install
 
@@ -53,10 +53,10 @@ You can use [prompt templates](https://modelfusion.dev/guide/function/generate-t
 ```ts
 import { generateText, openai } from "modelfusion";
 
-const text = await generateText(
-  openai.CompletionTextGenerator({ model: "gpt-3.5-turbo-instruct" }),
-  "Write a short story about a robot learning to love:\n\n"
-);
+const text = await generateText({
+  model: openai.CompletionTextGenerator({ model: "gpt-3.5-turbo-instruct" }),
+  prompt: "Write a short story about a robot learning to love:\n\n",
+});
 ```
 
 Providers: [OpenAI](https://modelfusion.dev/integration/model-provider/openai), [OpenAI compatible](https://modelfusion.dev/integration/model-provider/openaicompatible), [Llama.cpp](https://modelfusion.dev/integration/model-provider/llamacpp), [Ollama](https://modelfusion.dev/integration/model-provider/ollama), [Mistral](https://modelfusion.dev/integration/model-provider/mistral), [Hugging Face](https://modelfusion.dev/integration/model-provider/huggingface), [Cohere](https://modelfusion.dev/integration/model-provider/cohere)
@@ -66,10 +66,10 @@ Providers: [OpenAI](https://modelfusion.dev/integration/model-provider/openai),
 ```ts
 import { streamText, openai } from "modelfusion";
 
-const textStream = await streamText(
-  openai.CompletionTextGenerator({ model: "gpt-3.5-turbo-instruct" }),
-  "Write a short story about a robot learning to love:\n\n"
-);
+const textStream = await streamText({
+  model: openai.CompletionTextGenerator({ model: "gpt-3.5-turbo-instruct" }),
+  prompt: "Write a short story about a robot learning to love:\n\n",
+});
 
 for await (const textPart of textStream) {
   process.stdout.write(textPart);
@@ -88,15 +88,15 @@ import { readFileSync } from "fs";
 
 const image = readFileSync("./image.png").toString("base64");
 
-const textStream = await streamText(
-  openai.ChatTextGenerator({ model: "gpt-4-vision-preview" }),
-  [
+const textStream = await streamText({
+  model: openai.ChatTextGenerator({ model: "gpt-4-vision-preview" }),
+  prompt: [
     openai.ChatMessage.user([
       { type: "text", text: "Describe the image in detail:" },
       { type: "image", base64Image: image, mimeType: "image/png" },
     ]),
-  ]
-);
+  ],
+});
 
 for await (const textPart of textStream) {
   process.stdout.write(textPart);
@@ -121,9 +121,8 @@ import {
   jsonStructurePrompt,
 } from "modelfusion";
 
-const sentiment = await generateStructure(
-  // model:
-  ollama
+const sentiment = await generateStructure({
+  model: ollama
     .ChatTextGenerator({
       model: "openhermes2.5-mistral",
       maxGenerationTokens: 1024,
@@ -131,8 +130,7 @@ const sentiment = await generateStructure(
     })
     .asStructureGenerationModel(jsonStructurePrompt.instruction()),
 
-  // schema:
-  zodSchema(
+  schema: zodSchema(
     z.object({
       sentiment: z
         .enum(["positive", "neutral", "negative"])
@@ -140,16 +138,15 @@ const sentiment = await generateStructure(
     })
   ),
 
-  // prompt:
-  {
+  prompt: {
     system:
       "You are a sentiment evaluator. " +
       "Analyze the sentiment of the following product review:",
     instruction:
       "After I opened the package, I was met by a very unpleasant smell " +
       "that did not disappear even after washing. Never again!",
-  }
-);
+  },
+});
 ```
 
 Providers: [OpenAI](https://modelfusion.dev/integration/model-provider/openai), [Ollama](https://modelfusion.dev//integration/model-provider/ollama), [Llama.cpp](https://modelfusion.dev//integration/model-provider/llama.cpp)
@@ -161,8 +158,8 @@ Stream a structure that matches a schema. Partial structures before the final pa
 ```ts
 import { zodSchema, openai, streamStructure } from "modelfusion";
 
-const structureStream = await streamStructure(
-  openai
+const structureStream = await streamStructure({
+  model: openai
     .ChatTextGenerator(/* ... */)
     .asFunctionCallStructureGenerationModel({
       fnName: "generateCharacter",
@@ -170,7 +167,7 @@ const structureStream = await streamStructure(
     })
     .withTextPrompt(),
 
-  zodSchema(
+  schema: zodSchema(
     z.object({
       characters: z.array(
         z.object({
@@ -184,8 +181,8 @@ const structureStream = await streamStructure(
     })
   ),
 
-  "Generate 3 character descriptions for a fantasy role playing game."
-);
+  prompt: "Generate 3 character descriptions for a fantasy role playing game.",
+});
 
 for await (const part of structureStream) {
   if (!part.isComplete) {
@@ -207,10 +204,11 @@ Generate an image from a prompt.
 ```ts
 import { generateImage, openai } from "modelfusion";
 
-const image = await generateImage(
-  openai.ImageGenerator({ model: "dall-e-3", size: "1024x1024" }),
-  "the wicked witch of the west in the style of early 19th century painting"
-);
+const image = await generateImage({
+  model: openai.ImageGenerator({ model: "dall-e-3", size: "1024x1024" }),
+  prompt:
+    "the wicked witch of the west in the style of early 19th century painting",
+});
 ```
 
 Providers: [OpenAI (Dall·E)](https://modelfusion.dev/integration/model-provider/openai), [Stability AI](https://modelfusion.dev/integration/model-provider/stability), [Automatic1111](https://modelfusion.dev/integration/model-provider/automatic1111)
@@ -227,15 +225,16 @@ Synthesize speech (audio) from text. Also called TTS (text-to-speech).
 import { generateSpeech, lmnt } from "modelfusion";
 
 // `speech` is a Buffer with MP3 audio data
-const speech = await generateSpeech(
-  lmnt.SpeechGenerator({
+const speech = await generateSpeech({
+  model: lmnt.SpeechGenerator({
     voice: "034b632b-df71-46c8-b440-86a42ffc3cf3", // Henry
   }),
-  "Good evening, ladies and gentlemen! Exciting news on the airwaves tonight " +
+  text:
+    "Good evening, ladies and gentlemen! Exciting news on the airwaves tonight " +
     "as The Rolling Stones unveil 'Hackney Diamonds,' their first collection of " +
     "fresh tunes in nearly twenty years, featuring the illustrious Lady Gaga, the " +
-    "magical Stevie Wonder, and the final beats from the late Charlie Watts."
-);
+    "magical Stevie Wonder, and the final beats from the late Charlie Watts.",
+});
 ```
 
 Providers: [Eleven Labs](https://modelfusion.dev/integration/model-provider/elevenlabs), [LMNT](https://modelfusion.dev/integration/model-provider/lmnt), [OpenAI](https://modelfusion.dev/integration/model-provider/openai)
@@ -249,8 +248,8 @@ import { streamSpeech, elevenlabs } from "modelfusion";
 
 const textStream: AsyncIterable<string>;
 
-const speechStream = await streamSpeech(
-  elevenlabs.SpeechGenerator({
+const speechStream = await streamSpeech({
+  model: elevenlabs.SpeechGenerator({
     model: "eleven_turbo_v2",
     voice: "pNInz6obpgDQGcFmaJgB", // Adam
     optimizeStreamingLatency: 1,
@@ -259,8 +258,8 @@ const speechStream = await streamSpeech(
       chunkLengthSchedule: [50, 90, 120, 150, 200],
     },
   }),
-  textStream
-);
+  text: textStream,
+});
 
 for await (const part of speechStream) {
   // each part is a Buffer with MP3 audio data
@@ -276,13 +275,13 @@ Transcribe speech (audio) data into text. Also called speech-to-text (STT).
 ```ts
 import { generateTranscription, openai } from "modelfusion";
 
-const transcription = await generateTranscription(
-  openai.Transcriber({ model: "whisper-1" }),
-  {
+const transcription = await generateTranscription({
+  model: openai.Transcriber({ model: "whisper-1" }),
+  data: {
     type: "mp3",
     data: await fs.promises.readFile("data/test.mp3"),
-  }
-);
+  },
+});
 ```
 
 Providers: [OpenAI (Whisper)](https://modelfusion.dev/integration/model-provider/openai), [Whisper.cpp](https://modelfusion.dev/integration/model-provider/whispercpp)
@@ -292,24 +291,63 @@ Providers: [OpenAI (Whisper)](https://modelfusion.dev/integration/model-provider
 Create embeddings for text and other values. Embeddings are vectors that represent the essence of the values in the context of the model.
 
 ```ts
+import { embed, embedMany, openai } from "modelfusion";
+
 // embed single value:
-const embedding = await embed(
-  openai.TextEmbedder({ model: "text-embedding-ada-002" }),
-  "At first, Nox didn't know what to do with the pup."
-);
+const embedding = await embed({
+  model: openai.TextEmbedder({ model: "text-embedding-ada-002" }),
+  value: "At first, Nox didn't know what to do with the pup.",
+});
 
 // embed many values:
-const embeddings = await embedMany(
-  openai.TextEmbedder({ model: "text-embedding-ada-002" }),
-  [
+const embeddings = await embedMany({
+  model: openai.TextEmbedder({ model: "text-embedding-ada-002" }),
+  values: [
     "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.",
-  ]
-);
+  ],
+});
 ```
 
 Providers: [OpenAI](https://modelfusion.dev/integration/model-provider/openai), [Llama.cpp](https://modelfusion.dev/integration/model-provider/llamacpp), [Ollama](https://modelfusion.dev/integration/model-provider/ollama), [Mistral](https://modelfusion.dev/integration/model-provider/mistral), [Hugging Face](https://modelfusion.dev/integration/model-provider/huggingface), [Cohere](https://modelfusion.dev/integration/model-provider/cohere)
 
+### [Classify Value](https://modelfusion.dev/guide/function/classify)
+
+Classifies a value into a category.
+
+```ts
+import { classify, EmbeddingSimilarityClassifier, openai } from "modelfusion";
+
+const classifier = new EmbeddingSimilarityClassifier({
+  embeddingModel: openai.TextEmbedder({ model: "text-embedding-ada-002" }),
+  similarityThreshold: 0.82,
+  clusters: [
+    {
+      name: "politics" as const,
+      values: [
+        "they will save the country!",
+        // ...
+      ],
+    },
+    {
+      name: "chitchat" as const,
+      values: [
+        "how's the weather today?",
+        // ...
+      ],
+    },
+  ],
+});
+
+// strongly typed result:
+const result = await classify({
+  model: classifier,
+  value: "don't you love politics?",
+});
+```
+
+Classifiers: [EmbeddingSimilarityClassifier](https://modelfusion.dev/guide/function/classify#embeddingsimilarityclassifier)
+
 ### [Tokenize Text](https://modelfusion.dev/guide/function/tokenize-text)
 
 Split text into tokens and reconstruct the text from tokens.
@@ -339,11 +377,11 @@ ModelFusion offers several tools out-of-the-box: [Math.js](https://modelfusion.d
 With `useTool`, you can ask a tool-compatible language model (e.g. OpenAI chat) to invoke a single tool. `useTool` first generates a tool call and then executes the tool with the arguments.
 
 ```ts
-const { tool, toolCall, args, ok, result } = await useTool(
-  openai.ChatTextGenerator({ model: "gpt-3.5-turbo" }),
-  calculator,
-  [openai.ChatMessage.user("What's fourteen times twelve?")]
-);
+const { tool, toolCall, args, ok, result } = await useTool({
+  model: openai.ChatTextGenerator({ model: "gpt-3.5-turbo" }),
+  too: calculator,
+  prompt: [openai.ChatMessage.user("What's fourteen times twelve?")],
+});
 
 console.log(`Tool call:`, toolCall);
 console.log(`Tool:`, tool);
@@ -357,11 +395,11 @@ console.log(`Result or Error:`, result);
 With `useTools`, you can ask a language model to generate several tool calls as well as text. The model will choose which tools (if any) should be called with which arguments. Both the text and the tool calls are optional. This function executes the tools.
 
 ```ts
-const { text, toolResults } = await useTools(
-  openai.ChatTextGenerator({ model: "gpt-3.5-turbo" }),
-  [calculator /* ... */],
-  [openai.ChatMessage.user("What's fourteen times twelve?")]
-);
+const { text, toolResults } = await useTools({
+  model: openai.ChatTextGenerator({ model: "gpt-3.5-turbo" }),
+  tools: [calculator /* ... */],
+  prompt: [openai.ChatMessage.user("What's fourteen times twelve?")],
+});
 ```
 
 #### [Agent Loop](https://modelfusion.dev/guide/tools/agent-loop)
@@ -411,21 +449,22 @@ Prompt templates let you use higher level prompt structures (such as text, instr
 #### Text Prompt Example
 
 ```ts
-const text = await generateText(
-  openai
+const text = await generateText({
+  model: openai
     .ChatTextGenerator({
       // ...
     })
     .withTextPrompt(),
-  "Write a short story about a robot learning to love"
-);
+
+  prompt: "Write a short story about a robot learning to love",
+});
 ```
 
 #### Instruction Prompt Example
 
 ```ts
-const text = await generateText(
-  llamacpp
+const text = await generateText({
+  model: llamacpp
     .CompletionTextGenerator({
       // run https://huggingface.co/TheBloke/Llama-2-7B-Chat-GGUF with llama.cpp
       promptTemplate: llamacpp.prompt.Llama2, // Set prompt template
@@ -433,11 +472,12 @@ const text = await generateText(
       maxGenerationTokens: 512,
     })
     .withInstructionPrompt(),
-  {
+
+  prompt: {
     system: "You are a story writer.",
     instruction: "Write a short story about a robot learning to love.",
-  }
-);
+  },
+});
 ```
 
 They can also be accessed through the shorthand methods `.withTextPrompt()`, `.withChatPrompt()` and `.withInstructionPrompt()` for many models:
@@ -445,13 +485,14 @@ They can also be accessed through the shorthand methods `.withTextPrompt()`, `.w
 #### Chat Prompt Example
 
 ```ts
-const textStream = await streamText(
-  openai
+const textStream = await streamText({
+  model: openai
     .ChatTextGenerator({
       model: "gpt-3.5-turbo",
     })
     .withChatPrompt(),
-  {
+
+  prompt: {
     system: "You are a celebrated poet.",
     messages: [
       {
@@ -467,8 +508,8 @@ const textStream = await streamText(
         content: "Write a short story about Robbie learning to love",
       },
     ],
-  }
-);
+  },
+});
 ```
 
 | Prompt Template  | Text Prompt | Instruction Prompt | Chat Prompt |
@@ -504,19 +545,19 @@ const image = await generateImage(
 
 ### Metadata and original responses
 
-ModelFusion model functions return rich responses that include the raw (original) response and metadata when you set the `fullResponse` option to `true`.
+ModelFusion model functions return rich responses that include the raw (original) response and metadata when you set the `fullResponse` argument to `true`.
 
 ```ts
 // access the raw response (needs to be typed) and the metadata:
-const { text, rawResponse, metadata } = await generateText(
-  openai.CompletionTextGenerator({
+const { text, rawResponse, metadata } = await generateText({
+  model: openai.CompletionTextGenerator({
     model: "gpt-3.5-turbo-instruct",
     maxGenerationTokens: 1000,
     n: 2, // generate 2 completions
   }),
-  "Write a short story about a robot learning to love:\n\n",
-  { fullResponse: true }
-);
+  prompt: "Write a short story about a robot learning to love:\n\n",
+  fullResponse: true,
+});
 
 console.log(metadata);
 
@@ -550,6 +591,7 @@ modelfusion.setLogFormat("detailed-object"); // log full events
   - [Generate transcription](https://modelfusion.dev/guide/function/generation-transcription)
   - [Tokenize Text](https://modelfusion.dev/guide/function/tokenize-text)
   - [Embed Value](https://modelfusion.dev/guide/function/embed)
+  - [Classify Value](https://modelfusion.dev/guide/function/classify)
 - [Tools](https://modelfusion.dev/guide/tools)
   - [Use Tool](https://modelfusion.dev/guide/tools/use-tool)
   - [Use Tools](https://modelfusion.dev/guide/tools/use-tools)

package/index.cjs

@@ -14,7 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./classifier/index.cjs"), exports);
 __exportStar(require("./core/index.cjs"), exports);
 __exportStar(require("./model-function/index.cjs"), exports);
 __exportStar(require("./model-provider/index.cjs"), exports);

package/index.d.ts

@@ -1,4 +1,3 @@
-export * from "./classifier/index.js";
 export * from "./core/index.js";
 export * from "./model-function/index.js";
 export * from "./model-provider/index.js";

package/index.js

@@ -1,4 +1,3 @@
-export * from "./classifier/index.js";
 export * from "./core/index.js";
 export * from "./model-function/index.js";
 export * from "./model-provider/index.js";

package/model-function/ModelCallEvent.d.ts

@@ -2,6 +2,7 @@ import { BaseFunctionFinishedEvent, BaseFunctionStartedEvent } from "../core/Fun
 import { ToolCallGenerationFinishedEvent, ToolCallGenerationStartedEvent } from "../tool/generate-tool-call/ToolCallGenerationEvent.js";
 import { ToolCallsGenerationFinishedEvent, ToolCallsGenerationStartedEvent } from "../tool/generate-tool-calls/ToolCallsGenerationEvent.js";
 import { ModelInformation } from "./ModelInformation.js";
+import { ClassifyFinishedEvent, ClassifyStartedEvent } from "./classify/ClassifyEvent.js";
 import { EmbeddingFinishedEvent, EmbeddingStartedEvent } from "./embed/EmbeddingEvent.js";
 import { ImageGenerationFinishedEvent, ImageGenerationStartedEvent } from "./generate-image/ImageGenerationEvent.js";
 import { SpeechGenerationFinishedEvent, SpeechGenerationStartedEvent, SpeechStreamingFinishedEvent, SpeechStreamingStartedEvent } from "./generate-speech/SpeechGenerationEvent.js";
@@ -22,6 +23,9 @@ export interface BaseModelCallStartedEvent extends BaseFunctionStartedEvent {
 }
 export type BaseModelCallFinishedEventResult = {
     status: "success";
+    /**
+     * The original model response.
+     */
     rawResponse: unknown;
     value: unknown;
     /**
@@ -49,5 +53,5 @@ export interface BaseModelCallFinishedEvent extends BaseFunctionFinishedEvent {
      */
     result: BaseModelCallFinishedEventResult;
 }
-export type ModelCallStartedEvent = EmbeddingStartedEvent | ImageGenerationStartedEvent | SpeechGenerationStartedEvent | SpeechStreamingStartedEvent | StructureGenerationStartedEvent | StructureStreamingStartedEvent | TextGenerationStartedEvent | TextStreamingStartedEvent | ToolCallGenerationStartedEvent | ToolCallsGenerationStartedEvent | TranscriptionStartedEvent;
-export type ModelCallFinishedEvent = EmbeddingFinishedEvent | ImageGenerationFinishedEvent | SpeechGenerationFinishedEvent | SpeechStreamingFinishedEvent | StructureGenerationFinishedEvent | StructureStreamingFinishedEvent | TextGenerationFinishedEvent | TextStreamingFinishedEvent | ToolCallGenerationFinishedEvent | ToolCallsGenerationFinishedEvent | TranscriptionFinishedEvent;
+export type ModelCallStartedEvent = ClassifyStartedEvent | EmbeddingStartedEvent | ImageGenerationStartedEvent | SpeechGenerationStartedEvent | SpeechStreamingStartedEvent | StructureGenerationStartedEvent | StructureStreamingStartedEvent | TextGenerationStartedEvent | TextStreamingStartedEvent | ToolCallGenerationStartedEvent | ToolCallsGenerationStartedEvent | TranscriptionStartedEvent;
+export type ModelCallFinishedEvent = ClassifyFinishedEvent | EmbeddingFinishedEvent | ImageGenerationFinishedEvent | SpeechGenerationFinishedEvent | SpeechStreamingFinishedEvent | StructureGenerationFinishedEvent | StructureStreamingFinishedEvent | TextGenerationFinishedEvent | TextStreamingFinishedEvent | ToolCallGenerationFinishedEvent | ToolCallsGenerationFinishedEvent | TranscriptionFinishedEvent;

package/model-function/classify/Classifier.cjs

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/model-function/classify/Classifier.d.ts

@@ -0,0 +1,10 @@
+import { FunctionCallOptions } from "../../core/FunctionOptions.js";
+import { Model, ModelSettings } from "../Model.js";
+export interface ClassifierSettings extends ModelSettings {
+}
+export interface Classifier<VALUE, CLASS extends string | null, SETTINGS extends ClassifierSettings = ClassifierSettings> extends Model<SETTINGS> {
+    doClassify(value: VALUE, options: FunctionCallOptions): PromiseLike<{
+        rawResponse: unknown | undefined;
+        class: CLASS;
+    }>;
+}

package/model-function/classify/Classifier.js

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

package/model-function/classify/ClassifyEvent.cjs

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/model-function/classify/ClassifyEvent.d.ts

@@ -0,0 +1,20 @@
+import { BaseModelCallFinishedEvent, BaseModelCallStartedEvent } from "../ModelCallEvent.js";
+export interface ClassifyStartedEvent extends BaseModelCallStartedEvent {
+    functionType: "classify";
+    input: unknown | Array<unknown>;
+}
+export type ClassifyFinishedEventResult = {
+    status: "success";
+    rawResponse: unknown;
+    value: unknown;
+} | {
+    status: "error";
+    error: unknown;
+} | {
+    status: "abort";
+};
+export interface ClassifyFinishedEvent extends BaseModelCallFinishedEvent {
+    functionType: "classify";
+    input: unknown;
+    result: ClassifyFinishedEventResult;
+}

package/model-function/classify/ClassifyEvent.js

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