ai 3.1.0-canary.3 → 3.1.0-canary.4

package/core/dist/index.d.mts

@@ -332,6 +332,8 @@ type CallSettings = {
      * 1 (very random).
      *
      * It is recommended to set either `temperature` or `topP`, but not both.
+     *
+     * Default: 0
      */
     temperature?: number;
     /**
@@ -349,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;
     /**
@@ -357,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;
     /**
@@ -365,7 +371,9 @@ type CallSettings = {
      */
     seed?: number;
     /**
-     * Maximum number of retries. Set to 0 to disable retries. Default is 2.
+     * Maximum number of retries. Set to 0 to disable retries.
+     *
+     * Default: 2.
      */
     maxRetries?: number;
     /**
@@ -457,6 +465,8 @@ declare class GenerateObjectResult<T> {
     });
 }
 
+type AsyncIterableStream<T> = AsyncIterable<T> & ReadableStream<T>;
+
 /**
  * Stream an object as a partial object stream.
  */
@@ -466,10 +476,11 @@ declare function streamObject<T>({ model, schema, mode, system, prompt, messages
     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';
@@ -562,6 +573,30 @@ declare class GenerateTextResult<TOOLS extends Record<string, Tool>> {
     });
 }
 
+/**
+ * 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.
  */
@@ -581,10 +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>>);
+    get textStream(): AsyncIterableStream<string>;
+    get fullStream(): AsyncIterableStream<TextStreamPart<TOOLS>>;
+    toAIStream(callbacks?: AIStreamCallbacksAndOptions): ReadableStream<any>;
 }
 
 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 };

package/core/dist/index.d.ts

@@ -332,6 +332,8 @@ type CallSettings = {
      * 1 (very random).
      *
      * It is recommended to set either `temperature` or `topP`, but not both.
+     *
+     * Default: 0
      */
     temperature?: number;
     /**
@@ -349,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;
     /**
@@ -357,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;
     /**
@@ -365,7 +371,9 @@ type CallSettings = {
      */
     seed?: number;
     /**
-     * Maximum number of retries. Set to 0 to disable retries. Default is 2.
+     * Maximum number of retries. Set to 0 to disable retries.
+     *
+     * Default: 2.
      */
     maxRetries?: number;
     /**
@@ -457,6 +465,8 @@ declare class GenerateObjectResult<T> {
     });
 }
 
+type AsyncIterableStream<T> = AsyncIterable<T> & ReadableStream<T>;
+
 /**
  * Stream an object as a partial object stream.
  */
@@ -466,10 +476,11 @@ declare function streamObject<T>({ model, schema, mode, system, prompt, messages
     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';
@@ -562,6 +573,30 @@ declare class GenerateTextResult<TOOLS extends Record<string, Tool>> {
     });
 }
 
+/**
+ * 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.
  */
@@ -581,10 +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>>);
+    get textStream(): AsyncIterableStream<string>;
+    get fullStream(): AsyncIterableStream<TextStreamPart<TOOLS>>;
+    toAIStream(callbacks?: AIStreamCallbacksAndOptions): ReadableStream<any>;
 }
 
 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 };