ai 3.1.0-canary.2 → 3.1.0-canary.4

package/core/dist/index.d.ts

@@ -51,6 +51,10 @@ type LanguageModelV1CallSettings = {
      * by the model, calls will generate deterministic results.
      */
     seed?: number;
+    /**
+     * Abort signal for cancelling the operation.
+     */
+    abortSignal?: AbortSignal;
 };
 
 /**
@@ -106,9 +110,9 @@ interface LanguageModelV1TextPart {
 interface LanguageModelV1ImagePart {
     type: 'image';
     /**
-     * Image data as a Uint8Array.
+     * Image data as a Uint8Array (e.g. from a Blob or Buffer) or a URL.
      */
-    image: Uint8Array;
+    image: Uint8Array | URL;
     /**
      * Optional mime type of the image.
      */
@@ -234,6 +238,32 @@ type LanguageModelV1 = {
          * model has only generated text.
          */
         toolCalls?: Array<LanguageModelV1FunctionToolCall>;
+        /**
+         * Finish reason.
+         */
+        finishReason: LanguageModelV1FinishReason;
+        /**
+         * Usage information.
+         */
+        usage: {
+            promptTokens: number;
+            completionTokens: number;
+        };
+        /**
+         * Raw prompt and setting information for observability provider integration.
+         */
+        rawCall: {
+            /**
+             * Raw prompt after expansion and conversion to the format that the
+             * provider uses to send the information to their API.
+             */
+            rawPrompt: unknown;
+            /**
+             * Raw settings that are used for the API call. Includes provider-specific
+             * settings.
+             */
+            rawSettings: Record<string, unknown>;
+        };
         warnings?: LanguageModelV1CallWarning[];
     }>;
     /**
@@ -246,6 +276,21 @@ type LanguageModelV1 = {
      */
     doStream(options: LanguageModelV1CallOptions): PromiseLike<{
         stream: ReadableStream<LanguageModelV1StreamPart>;
+        /**
+         * Raw prompt and setting information for observability provider integration.
+         */
+        rawCall: {
+            /**
+             * Raw prompt after expansion and conversion to the format that the
+             * provider uses to send the information to their API.
+             */
+            rawPrompt: unknown;
+            /**
+             * Raw settings that are used for the API call. Includes provider-specific
+             * settings.
+             */
+            rawSettings: Record<string, unknown>;
+        };
         warnings?: LanguageModelV1CallWarning[];
     }>;
 };
@@ -271,6 +316,12 @@ type LanguageModelV1StreamPart = {
     error: unknown;
 };
 
+type TokenUsage = {
+    promptTokens: number;
+    completionTokens: number;
+    totalTokens: number;
+};
+
 type CallSettings = {
     /**
      * Maximum number of tokens to generate.
@@ -281,6 +332,8 @@ type CallSettings = {
      * 1 (very random).
      *
      * It is recommended to set either `temperature` or `topP`, but not both.
+     *
+     * Default: 0
      */
     temperature?: number;
     /**
@@ -298,6 +351,8 @@ type CallSettings = {
      *
      * The presence penalty is a number between -1 (increase repetition)
      * and 1 (maximum penalty, decrease repetition). 0 means no penalty.
+     *
+     * Default: 0
      */
     presencePenalty?: number;
     /**
@@ -306,6 +361,8 @@ type CallSettings = {
      *
      * The frequency penalty is a number between -1 (increase repetition)
      * and 1 (maximum penalty, decrease repetition). 0 means no penalty.
+     *
+     * Default: 0
      */
     frequencyPenalty?: number;
     /**
@@ -313,6 +370,16 @@ type CallSettings = {
      * by the model, calls will generate deterministic results.
      */
     seed?: number;
+    /**
+     * Maximum number of retries. Set to 0 to disable retries.
+     *
+     * Default: 2.
+     */
+    maxRetries?: number;
+    /**
+     * Abort signal.
+     */
+    abortSignal?: AbortSignal;
 };
 
 /**
@@ -332,9 +399,12 @@ interface TextPart {
 interface ImagePart {
     type: 'image';
     /**
-     * Image data. Can either be a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer.
+     * Image data. Can either be:
+     *
+     * - data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer
+     * - URL: a URL that points to the image
      */
-    image: DataContent;
+    image: DataContent | URL;
     /**
      * Optional mime type of the image.
      */
@@ -379,31 +449,38 @@ type Prompt = {
 /**
  * Generate a structured, typed object using a language model.
  */
-declare function generateObject<T>({ model, schema, mode, system, prompt, messages, ...settings }: CallSettings & Prompt & {
+declare function generateObject<T>({ model, schema, mode, system, prompt, messages, maxRetries, abortSignal, ...settings }: CallSettings & Prompt & {
     model: LanguageModelV1;
     schema: z.Schema<T>;
     mode?: 'auto' | 'json' | 'tool' | 'grammar';
 }): Promise<GenerateObjectResult<T>>;
 declare class GenerateObjectResult<T> {
     readonly object: T;
+    readonly finishReason: LanguageModelV1FinishReason;
+    readonly usage: TokenUsage;
     constructor(options: {
         object: T;
+        finishReason: LanguageModelV1FinishReason;
+        usage: TokenUsage;
     });
 }
 
+type AsyncIterableStream<T> = AsyncIterable<T> & ReadableStream<T>;
+
 /**
  * Stream an object as a partial object stream.
  */
-declare function streamObject<T>({ model, schema, mode, system, prompt, messages, ...settings }: CallSettings & Prompt & {
+declare function streamObject<T>({ model, schema, mode, system, prompt, messages, maxRetries, abortSignal, ...settings }: CallSettings & Prompt & {
     model: LanguageModelV1;
     schema: z.Schema<T>;
     mode?: 'auto' | 'json' | 'tool' | 'grammar';
 }): Promise<StreamObjectResult<T>>;
 declare class StreamObjectResult<T> {
-    readonly objectStream: AsyncIterable<PartialDeep<T, {
+    private readonly originalStream;
+    constructor(stream: ReadableStream<string | ErrorStreamPart>);
+    get objectStream(): AsyncIterableStream<PartialDeep<T, {
         recurseIntoArrays: true;
     }>>;
-    constructor(modelStream: ReadableStream<string | ErrorStreamPart>);
 }
 type ErrorStreamPart = {
     type: 'error';
@@ -477,7 +554,7 @@ type ToToolResultArray<TOOLS extends Record<string, Tool>> = Array<ToToolResult<
 /**
  * Generate a text and call tools using a language model.
  */
-declare function generateText<TOOLS extends Record<string, Tool>>({ model, tools, system, prompt, messages, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, Tool>>({ model, tools, system, prompt, messages, maxRetries, abortSignal, ...settings }: CallSettings & Prompt & {
     model: LanguageModelV1;
     tools?: TOOLS;
 }): Promise<GenerateTextResult<TOOLS>>;
@@ -485,21 +562,45 @@ declare class GenerateTextResult<TOOLS extends Record<string, Tool>> {
     readonly text: string;
     readonly toolCalls: ToToolCallArray<TOOLS>;
     readonly toolResults: ToToolResultArray<TOOLS>;
+    readonly finishReason: LanguageModelV1FinishReason;
+    readonly usage: TokenUsage;
     constructor(options: {
         text: string;
         toolCalls: ToToolCallArray<TOOLS>;
         toolResults: ToToolResultArray<TOOLS>;
+        finishReason: LanguageModelV1FinishReason;
+        usage: TokenUsage;
     });
 }
 
-declare class StreamTextHttpResponse extends Response {
-    constructor(messageStream: ReadableStream<TextStreamPart<any>>);
+/**
+ * Configuration options and helper callback methods for AIStream stream lifecycle events.
+ * @interface
+ */
+interface AIStreamCallbacksAndOptions {
+    /** `onStart`: Called once when the stream is initialized. */
+    onStart?: () => Promise<void> | void;
+    /** `onCompletion`: Called for each tokenized message. */
+    onCompletion?: (completion: string) => Promise<void> | void;
+    /** `onFinal`: Called once when the stream is closed with the final completion message. */
+    onFinal?: (completion: string) => Promise<void> | void;
+    /** `onToken`: Called for each tokenized message. */
+    onToken?: (token: string) => Promise<void> | void;
+    /** `onText`: Called for each text chunk. */
+    onText?: (text: string) => Promise<void> | void;
+    /**
+     * A flag for enabling the experimental_StreamData class and the new protocol.
+     * @see https://github.com/vercel-labs/ai/pull/425
+     *
+     * When StreamData is rolled out, this will be removed and the new protocol will be used by default.
+     */
+    experimental_streamData?: boolean;
 }
 
 /**
  * Stream text generated by a language model.
  */
-declare function streamText<TOOLS extends Record<string, Tool>>({ model, tools, system, prompt, messages, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends Record<string, Tool>>({ model, tools, system, prompt, messages, maxRetries, abortSignal, ...settings }: CallSettings & Prompt & {
     model: LanguageModelV1;
     tools?: TOOLS;
 }): Promise<StreamTextResult<TOOLS>>;
@@ -515,11 +616,11 @@ type TextStreamPart<TOOLS extends Record<string, Tool>> = {
     type: 'tool-result';
 } & ToToolResult<TOOLS>);
 declare class StreamTextResult<TOOLS extends Record<string, Tool>> {
-    private readonly rootStream;
-    readonly textStream: AsyncIterable<string>;
-    readonly fullStream: AsyncIterable<TextStreamPart<TOOLS>>;
+    private readonly originalStream;
     constructor(stream: ReadableStream<TextStreamPart<TOOLS>>);
-    toResponse(): StreamTextHttpResponse;
+    get textStream(): AsyncIterableStream<string>;
+    get fullStream(): AsyncIterableStream<TextStreamPart<TOOLS>>;
+    toAIStream(callbacks?: AIStreamCallbacksAndOptions): ReadableStream<any>;
 }
 
-export { AssistantContent, AssistantMessage, DataContent, ErrorStreamPart, GenerateObjectResult, GenerateTextResult, ImagePart, Message, StreamObjectResult, StreamTextHttpResponse, StreamTextResult, TextPart, TextStreamPart, Tool, ToolCallPart, ToolContent, ToolMessage, ToolResultPart, UserContent, UserMessage, convertDataContentToBase64String, convertDataContentToUint8Array, generateObject, generateText, streamObject, streamText, tool };
+export { AssistantContent, AssistantMessage, DataContent, ErrorStreamPart, GenerateObjectResult, GenerateTextResult, ImagePart, Message, StreamObjectResult, StreamTextResult, TextPart, TextStreamPart, Tool, ToolCallPart, ToolContent, ToolMessage, ToolResultPart, UserContent, UserMessage, convertDataContentToBase64String, convertDataContentToUint8Array, generateObject, generateText, streamObject, streamText, tool };