ai 3.1.1 → 3.1.2

package/dist/index.d.mts

@@ -303,7 +303,16 @@ The schema of the object that the model should generate.
      */
     schema: z.Schema<T>;
     /**
-The mode to use for object generation. Not all models support all modes.
+The mode to use for object generation.
+
+The Zod schema is converted in a JSON schema and used in one of the following ways
+
+- 'auto': The provider will choose the best mode for the model.
+- 'tool': A tool with the JSON schema as parameters is is provided and the provider is instructed to use it.
+- 'json': The JSON schema and a instruction is injected into the prompt. If the provider supports JSON mode, it is enabled.
+- 'grammar': The provider is instructed to converted the JSON schema into a provider specific grammar and use it to select the output tokens.
+
+Please note that most providers do not support all modes.
 
 Default and recommended: 'auto' (best mode for the model).
      */
@@ -423,10 +432,19 @@ The schema of the object that the model should generate.
  */
     schema: z.Schema<T>;
     /**
-The mode to use for object generation. Not all models support all modes.
+The mode to use for object generation.
+
+The Zod schema is converted in a JSON schema and used in one of the following ways
+
+- 'auto': The provider will choose the best mode for the model.
+- 'tool': A tool with the JSON schema as parameters is is provided and the provider is instructed to use it.
+- 'json': The JSON schema and a instruction is injected into the prompt. If the provider supports JSON mode, it is enabled.
+- 'grammar': The provider is instructed to converted the JSON schema into a provider specific grammar and use it to select the output tokens.
+
+Please note that most providers do not support all modes.
 
 Default and recommended: 'auto' (best mode for the model).
- */
+     */
     mode?: 'auto' | 'json' | 'tool' | 'grammar';
 }): Promise<StreamObjectResult<T>>;
 type ObjectStreamPartInput = {
@@ -764,7 +782,7 @@ type TextStreamPart<TOOLS extends Record<string, CoreTool>> = {
 A result object for accessing different stream types and additional information.
  */
 declare class StreamTextResult<TOOLS extends Record<string, CoreTool>> {
-    private readonly originalStream;
+    private originalStream;
     /**
   Warnings from the model provider (e.g. unsupported settings)
      */
@@ -786,6 +804,15 @@ declare class StreamTextResult<TOOLS extends Record<string, CoreTool>> {
         };
     });
     /**
+  Split out a new stream from the original stream.
+  The original stream is replaced to allow for further splitting,
+  since we do not know how many times the stream will be split.
+  
+  Note: this leads to buffering the stream content on the server.
+  However, the LLM results are expected to be small enough to not cause issues.
+     */
+    private teeStream;
+    /**
   A text stream that returns only the generated text deltas. You can use it
   as either an AsyncIterable or a ReadableStream. When an error occurs, the
   stream will throw the error.

package/dist/index.d.ts

@@ -303,7 +303,16 @@ The schema of the object that the model should generate.
      */
     schema: z.Schema<T>;
     /**
-The mode to use for object generation. Not all models support all modes.
+The mode to use for object generation.
+
+The Zod schema is converted in a JSON schema and used in one of the following ways
+
+- 'auto': The provider will choose the best mode for the model.
+- 'tool': A tool with the JSON schema as parameters is is provided and the provider is instructed to use it.
+- 'json': The JSON schema and a instruction is injected into the prompt. If the provider supports JSON mode, it is enabled.
+- 'grammar': The provider is instructed to converted the JSON schema into a provider specific grammar and use it to select the output tokens.
+
+Please note that most providers do not support all modes.
 
 Default and recommended: 'auto' (best mode for the model).
      */
@@ -423,10 +432,19 @@ The schema of the object that the model should generate.
  */
     schema: z.Schema<T>;
     /**
-The mode to use for object generation. Not all models support all modes.
+The mode to use for object generation.
+
+The Zod schema is converted in a JSON schema and used in one of the following ways
+
+- 'auto': The provider will choose the best mode for the model.
+- 'tool': A tool with the JSON schema as parameters is is provided and the provider is instructed to use it.
+- 'json': The JSON schema and a instruction is injected into the prompt. If the provider supports JSON mode, it is enabled.
+- 'grammar': The provider is instructed to converted the JSON schema into a provider specific grammar and use it to select the output tokens.
+
+Please note that most providers do not support all modes.
 
 Default and recommended: 'auto' (best mode for the model).
- */
+     */
     mode?: 'auto' | 'json' | 'tool' | 'grammar';
 }): Promise<StreamObjectResult<T>>;
 type ObjectStreamPartInput = {
@@ -764,7 +782,7 @@ type TextStreamPart<TOOLS extends Record<string, CoreTool>> = {
 A result object for accessing different stream types and additional information.
  */
 declare class StreamTextResult<TOOLS extends Record<string, CoreTool>> {
-    private readonly originalStream;
+    private originalStream;
     /**
   Warnings from the model provider (e.g. unsupported settings)
      */
@@ -786,6 +804,15 @@ declare class StreamTextResult<TOOLS extends Record<string, CoreTool>> {
         };
     });
     /**
+  Split out a new stream from the original stream.
+  The original stream is replaced to allow for further splitting,
+  since we do not know how many times the stream will be split.
+  
+  Note: this leads to buffering the stream content on the server.
+  However, the LLM results are expected to be small enough to not cause issues.
+     */
+    private teeStream;
+    /**
   A text stream that returns only the generated text deltas. You can use it
   as either an AsyncIterable or a ReadableStream. When an error occurs, the
   stream will throw the error.

package/dist/index.js

@@ -1491,12 +1491,25 @@ var StreamTextResult = class {
     this.rawResponse = rawResponse;
   }
   /**
+  Split out a new stream from the original stream.
+  The original stream is replaced to allow for further splitting,
+  since we do not know how many times the stream will be split.
+  
+  Note: this leads to buffering the stream content on the server.
+  However, the LLM results are expected to be small enough to not cause issues.
+     */
+  teeStream() {
+    const [stream1, stream2] = this.originalStream.tee();
+    this.originalStream = stream2;
+    return stream1;
+  }
+  /**
   A text stream that returns only the generated text deltas. You can use it
   as either an AsyncIterable or a ReadableStream. When an error occurs, the
   stream will throw the error.
      */
   get textStream() {
-    return createAsyncIterableStream(this.originalStream, {
+    return createAsyncIterableStream(this.teeStream(), {
       transform(chunk, controller) {
         if (chunk.type === "text-delta") {
           if (chunk.textDelta.length > 0) {
@@ -1515,7 +1528,7 @@ var StreamTextResult = class {
   stream will throw the error.
      */
   get fullStream() {
-    return createAsyncIterableStream(this.originalStream, {
+    return createAsyncIterableStream(this.teeStream(), {
       transform(chunk, controller) {
         if (chunk.type === "text-delta") {
           if (chunk.textDelta.length > 0) {