ai 3.3.3 → 3.3.4

package/dist/index.d.mts

@@ -597,6 +597,8 @@ This function does not stream the output. If you want to stream the output, use
 @param model - The language model to use.
 
 @param schema - The schema of the object that the model should generate.
+@param schemaName - Optional name of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema name.
+@param schemaDescription - Optional description of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema description.
 @param mode - The mode to use for object generation. Not all models support all modes. Defaults to 'auto'.
 
 @param system - A system message that will be part of the prompt.
@@ -629,7 +631,7 @@ If set and supported by the model, calls will generate deterministic results.
 @returns
 A result object that contains the generated object, the finish reason, the token usage, and additional information.
  */
-declare function generateObject<T>({ model, schema: inputSchema, mode, system, prompt, messages, maxRetries, abortSignal, headers, experimental_telemetry: telemetry, ...settings }: Omit<CallSettings, 'stopSequences'> & Prompt & {
+declare function generateObject<T>({ model, schema: inputSchema, schemaName, schemaDescription, mode, system, prompt, messages, maxRetries, abortSignal, headers, experimental_telemetry: telemetry, ...settings }: Omit<CallSettings, 'stopSequences'> & Prompt & {
     /**
 The language model to use.
      */
@@ -639,6 +641,18 @@ The schema of the object that the model should generate.
      */
     schema: z.Schema<T, z.ZodTypeDef, any> | Schema<T>;
     /**
+Optional name of the output that should be generated.
+Used by some providers for additional LLM guidance, e.g.
+via tool or schema name.
+     */
+    schemaName?: string;
+    /**
+Optional description of the output that should be generated.
+Used by some providers for additional LLM guidance, e.g.
+via tool or schema description.
+     */
+    schemaDescription?: string;
+    /**
 The mode to use for object generation.
 
 The schema is converted in a JSON schema and used in one of the following ways
@@ -774,6 +788,8 @@ This function streams the output. If you do not want to stream the output, use `
 @param model - The language model to use.
 
 @param schema - The schema of the object that the model should generate.
+@param schemaName - Optional name of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema name.
+@param schemaDescription - Optional description of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema description.
 @param mode - The mode to use for object generation. Not all models support all modes. Defaults to 'auto'.
 
 @param system - A system message that will be part of the prompt.
@@ -806,7 +822,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing the partial object stream and additional information.
  */
-declare function streamObject<T>({ model, schema: inputSchema, mode, system, prompt, messages, maxRetries, abortSignal, headers, experimental_telemetry: telemetry, onFinish, ...settings }: Omit<CallSettings, 'stopSequences'> & Prompt & {
+declare function streamObject<T>({ model, schema: inputSchema, schemaName, schemaDescription, mode, system, prompt, messages, maxRetries, abortSignal, headers, experimental_telemetry: telemetry, onFinish, ...settings }: Omit<CallSettings, 'stopSequences'> & Prompt & {
     /**
 The language model to use.
      */
@@ -816,6 +832,18 @@ The schema of the object that the model should generate.
  */
     schema: z.Schema<T, z.ZodTypeDef, any> | Schema<T>;
     /**
+Optional name of the output that should be generated.
+Used by some providers for additional LLM guidance, e.g.
+via tool or schema name.
+     */
+    schemaName?: string;
+    /**
+Optional description of the output that should be generated.
+Used by some providers for additional LLM guidance, e.g.
+via tool or schema description.
+ */
+    schemaDescription?: string;
+    /**
 The mode to use for object generation.
 
 The schema is converted in a JSON schema and used in one of the following ways
@@ -2628,7 +2656,15 @@ declare function streamToResponse(res: ReadableStream, response: ServerResponse$
 /**
  * A utility class for streaming text responses.
  *
- * @deprecated Use `streamText.toDataStreamResponse()` instead.
+ * @deprecated Use `streamText.toDataStreamResponse()` (if you did send StreamData)
+ * or a regular `Response` instead (if you did not send any StreamData):
+ *
+ * ```ts
+ * return new Response(stream, {
+ *   status: 200,
+ *   contentType: 'text/plain; charset=utf-8',
+ * })
+ * ```
  */
 declare class StreamingTextResponse extends Response {
     constructor(res: ReadableStream, init?: ResponseInit, data?: StreamData);
@@ -2640,4 +2676,4 @@ declare const generateId: (size?: number | undefined) => string;
  */
 declare const nanoid: (size?: number | undefined) => string;
 
-export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantResponse, CallWarning, CohereStream, CompletionTokenUsage, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolChoice, CoreToolMessage, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingTokenUsage, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidModelIdError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LogProbs, MistralStream, NoObjectGeneratedError, NoSuchModelError, NoSuchProviderError, NoSuchToolError, ObjectStreamInputPart, ObjectStreamPart, OpenAIStream, OpenAIStreamCallbacks, ReplicateStream, RetryError, StreamData, StreamObjectResult, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, TokenUsage, ToolCallPart, ToolCallPayload, ToolContent, ToolResultPart, UserContent, convertDataContentToBase64String, convertDataContentToUint8Array, convertToCoreMessages, convertUint8ArrayToText, cosineSimilarity, createCallbacksTransformer, createEventStreamTransformer, createStreamDataTransformer, embed, embedMany, experimental_AssistantResponse, experimental_ModelRegistry, experimental_ProviderRegistry, experimental_StreamData, experimental_createModelRegistry, experimental_createProviderRegistry, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, generateId, generateObject, generateText, jsonSchema, nanoid, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };
+export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantResponse, CallWarning, CohereStream, CompletionTokenUsage, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolChoice, CoreToolMessage, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingTokenUsage, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidModelIdError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LogProbs, MistralStream, NoObjectGeneratedError, NoSuchModelError, NoSuchProviderError, NoSuchToolError, ObjectStreamInputPart, ObjectStreamPart, OpenAIStream, OpenAIStreamCallbacks, ReplicateStream, RetryError, Schema, StreamData, StreamObjectResult, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, TokenUsage, ToolCallPart, ToolCallPayload, ToolContent, ToolResultPart, UserContent, convertDataContentToBase64String, convertDataContentToUint8Array, convertToCoreMessages, convertUint8ArrayToText, cosineSimilarity, createCallbacksTransformer, createEventStreamTransformer, createStreamDataTransformer, embed, embedMany, experimental_AssistantResponse, experimental_ModelRegistry, experimental_ProviderRegistry, experimental_StreamData, experimental_createModelRegistry, experimental_createProviderRegistry, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, generateId, generateObject, generateText, jsonSchema, nanoid, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };

package/dist/index.d.ts

@@ -597,6 +597,8 @@ This function does not stream the output. If you want to stream the output, use
 @param model - The language model to use.
 
 @param schema - The schema of the object that the model should generate.
+@param schemaName - Optional name of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema name.
+@param schemaDescription - Optional description of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema description.
 @param mode - The mode to use for object generation. Not all models support all modes. Defaults to 'auto'.
 
 @param system - A system message that will be part of the prompt.
@@ -629,7 +631,7 @@ If set and supported by the model, calls will generate deterministic results.
 @returns
 A result object that contains the generated object, the finish reason, the token usage, and additional information.
  */
-declare function generateObject<T>({ model, schema: inputSchema, mode, system, prompt, messages, maxRetries, abortSignal, headers, experimental_telemetry: telemetry, ...settings }: Omit<CallSettings, 'stopSequences'> & Prompt & {
+declare function generateObject<T>({ model, schema: inputSchema, schemaName, schemaDescription, mode, system, prompt, messages, maxRetries, abortSignal, headers, experimental_telemetry: telemetry, ...settings }: Omit<CallSettings, 'stopSequences'> & Prompt & {
     /**
 The language model to use.
      */
@@ -639,6 +641,18 @@ The schema of the object that the model should generate.
      */
     schema: z.Schema<T, z.ZodTypeDef, any> | Schema<T>;
     /**
+Optional name of the output that should be generated.
+Used by some providers for additional LLM guidance, e.g.
+via tool or schema name.
+     */
+    schemaName?: string;
+    /**
+Optional description of the output that should be generated.
+Used by some providers for additional LLM guidance, e.g.
+via tool or schema description.
+     */
+    schemaDescription?: string;
+    /**
 The mode to use for object generation.
 
 The schema is converted in a JSON schema and used in one of the following ways
@@ -774,6 +788,8 @@ This function streams the output. If you do not want to stream the output, use `
 @param model - The language model to use.
 
 @param schema - The schema of the object that the model should generate.
+@param schemaName - Optional name of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema name.
+@param schemaDescription - Optional description of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema description.
 @param mode - The mode to use for object generation. Not all models support all modes. Defaults to 'auto'.
 
 @param system - A system message that will be part of the prompt.
@@ -806,7 +822,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing the partial object stream and additional information.
  */
-declare function streamObject<T>({ model, schema: inputSchema, mode, system, prompt, messages, maxRetries, abortSignal, headers, experimental_telemetry: telemetry, onFinish, ...settings }: Omit<CallSettings, 'stopSequences'> & Prompt & {
+declare function streamObject<T>({ model, schema: inputSchema, schemaName, schemaDescription, mode, system, prompt, messages, maxRetries, abortSignal, headers, experimental_telemetry: telemetry, onFinish, ...settings }: Omit<CallSettings, 'stopSequences'> & Prompt & {
     /**
 The language model to use.
      */
@@ -816,6 +832,18 @@ The schema of the object that the model should generate.
  */
     schema: z.Schema<T, z.ZodTypeDef, any> | Schema<T>;
     /**
+Optional name of the output that should be generated.
+Used by some providers for additional LLM guidance, e.g.
+via tool or schema name.
+     */
+    schemaName?: string;
+    /**
+Optional description of the output that should be generated.
+Used by some providers for additional LLM guidance, e.g.
+via tool or schema description.
+ */
+    schemaDescription?: string;
+    /**
 The mode to use for object generation.
 
 The schema is converted in a JSON schema and used in one of the following ways
@@ -2628,7 +2656,15 @@ declare function streamToResponse(res: ReadableStream, response: ServerResponse$
 /**
  * A utility class for streaming text responses.
  *
- * @deprecated Use `streamText.toDataStreamResponse()` instead.
+ * @deprecated Use `streamText.toDataStreamResponse()` (if you did send StreamData)
+ * or a regular `Response` instead (if you did not send any StreamData):
+ *
+ * ```ts
+ * return new Response(stream, {
+ *   status: 200,
+ *   contentType: 'text/plain; charset=utf-8',
+ * })
+ * ```
  */
 declare class StreamingTextResponse extends Response {
     constructor(res: ReadableStream, init?: ResponseInit, data?: StreamData);
@@ -2640,4 +2676,4 @@ declare const generateId: (size?: number | undefined) => string;
  */
 declare const nanoid: (size?: number | undefined) => string;
 
-export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantResponse, CallWarning, CohereStream, CompletionTokenUsage, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolChoice, CoreToolMessage, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingTokenUsage, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidModelIdError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LogProbs, MistralStream, NoObjectGeneratedError, NoSuchModelError, NoSuchProviderError, NoSuchToolError, ObjectStreamInputPart, ObjectStreamPart, OpenAIStream, OpenAIStreamCallbacks, ReplicateStream, RetryError, StreamData, StreamObjectResult, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, TokenUsage, ToolCallPart, ToolCallPayload, ToolContent, ToolResultPart, UserContent, convertDataContentToBase64String, convertDataContentToUint8Array, convertToCoreMessages, convertUint8ArrayToText, cosineSimilarity, createCallbacksTransformer, createEventStreamTransformer, createStreamDataTransformer, embed, embedMany, experimental_AssistantResponse, experimental_ModelRegistry, experimental_ProviderRegistry, experimental_StreamData, experimental_createModelRegistry, experimental_createProviderRegistry, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, generateId, generateObject, generateText, jsonSchema, nanoid, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };
+export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantResponse, CallWarning, CohereStream, CompletionTokenUsage, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolChoice, CoreToolMessage, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingTokenUsage, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, FinishReason, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidModelIdError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LogProbs, MistralStream, NoObjectGeneratedError, NoSuchModelError, NoSuchProviderError, NoSuchToolError, ObjectStreamInputPart, ObjectStreamPart, OpenAIStream, OpenAIStreamCallbacks, ReplicateStream, RetryError, Schema, StreamData, StreamObjectResult, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, TokenUsage, ToolCallPart, ToolCallPayload, ToolContent, ToolResultPart, UserContent, convertDataContentToBase64String, convertDataContentToUint8Array, convertToCoreMessages, convertUint8ArrayToText, cosineSimilarity, createCallbacksTransformer, createEventStreamTransformer, createStreamDataTransformer, embed, embedMany, experimental_AssistantResponse, experimental_ModelRegistry, experimental_ProviderRegistry, experimental_StreamData, experimental_createModelRegistry, experimental_createProviderRegistry, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, generateId, generateObject, generateText, jsonSchema, nanoid, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };

package/dist/index.js

@@ -1368,6 +1368,8 @@ _a6 = symbol6;
 async function generateObject({
   model,
   schema: inputSchema,
+  schemaName,
+  schemaDescription,
   mode,
   system,
   prompt,
@@ -1404,6 +1406,8 @@ async function generateObject({
         "ai.schema": {
           input: () => JSON.stringify(schema.jsonSchema)
         },
+        "ai.schema.name": schemaName,
+        "ai.schema.description": schemaDescription,
         "ai.settings.mode": mode
       }
     }),
@@ -1463,7 +1467,12 @@ async function generateObject({
               tracer,
               fn: async (span2) => {
                 const result2 = await model.doGenerate({
-                  mode: { type: "object-json", schema: schema.jsonSchema },
+                  mode: {
+                    type: "object-json",
+                    schema: schema.jsonSchema,
+                    name: schemaName,
+                    description: schemaDescription
+                  },
                   ...prepareCallSettings(settings),
                   inputFormat,
                   prompt: promptMessages,
@@ -1545,8 +1554,8 @@ async function generateObject({
                     type: "object-tool",
                     tool: {
                       type: "function",
-                      name: "json",
-                      description: "Respond with a JSON object.",
+                      name: schemaName != null ? schemaName : "json",
+                      description: schemaDescription != null ? schemaDescription : "Respond with a JSON object.",
                       parameters: schema.jsonSchema
                     }
                   },
@@ -1724,6 +1733,8 @@ function createAsyncIterableStream(source, transformer) {
 async function streamObject({
   model,
   schema: inputSchema,
+  schemaName,
+  schemaDescription,
   mode,
   system,
   prompt,
@@ -1760,6 +1771,8 @@ async function streamObject({
           input: () => JSON.stringify({ system, prompt, messages })
         },
         "ai.schema": { input: () => JSON.stringify(schema.jsonSchema) },
+        "ai.schema.name": schemaName,
+        "ai.schema.description": schemaDescription,
         "ai.settings.mode": mode
       }
     }),
@@ -1782,7 +1795,12 @@ async function streamObject({
             messages
           });
           callOptions = {
-            mode: { type: "object-json", schema: schema.jsonSchema },
+            mode: {
+              type: "object-json",
+              schema: schema.jsonSchema,
+              name: schemaName,
+              description: schemaDescription
+            },
             ...prepareCallSettings(settings),
             inputFormat: validatedPrompt.type,
             prompt: await convertToLanguageModelPrompt({
@@ -1818,8 +1836,8 @@ async function streamObject({
               type: "object-tool",
               tool: {
                 type: "function",
-                name: "json",
-                description: "Respond with a JSON object.",
+                name: schemaName != null ? schemaName : "json",
+                description: schemaDescription != null ? schemaDescription : "Respond with a JSON object.",
                 parameters: schema.jsonSchema
               }
             },
@@ -3716,6 +3734,7 @@ function readableFromAsyncIterable(iterable) {
 
 // streams/stream-data.ts
 var import_ui_utils3 = require("@ai-sdk/ui-utils");
+var STREAM_DATA_WARNING_TIME_MS = 15 * 1e3;
 var StreamData2 = class {
   constructor() {
     this.encoder = new TextEncoder();
@@ -3731,7 +3750,7 @@ var StreamData2 = class {
             console.warn(
               "The data stream is hanging. Did you forget to close it with `data.close()`?"
             );
-          }, 3e3);
+          }, STREAM_DATA_WARNING_TIME_MS);
         }
       },
       pull: (controller) => {