ai 4.0.5 → 4.0.6

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # ai
 
+## 4.0.6
+
+### Patch Changes
+
+- fc18132: feat (ai/core): experimental output for generateText
+- 2779f6d: fix (ai/core): do not send maxRetries into providers
+
 ## 4.0.5
 
 ### Patch Changes

package/dist/index.d.mts

@@ -221,7 +221,7 @@ Embed a value using an embedding model. The type of the value is defined by the
 
 @returns A result object that contains the embedding, the value, and additional information.
  */
-declare function embed<VALUE>({ model, value, maxRetries, abortSignal, headers, experimental_telemetry: telemetry, }: {
+declare function embed<VALUE>({ model, value, maxRetries: maxRetriesArg, abortSignal, headers, experimental_telemetry: telemetry, }: {
     /**
   The embedding model to use.
        */
@@ -286,7 +286,7 @@ has a limit on how many embeddings can be generated in a single call.
 
 @returns A result object that contains the embeddings, the value, and additional information.
  */
-declare function embedMany<VALUE>({ model, values, maxRetries, abortSignal, headers, experimental_telemetry: telemetry, }: {
+declare function embedMany<VALUE>({ model, values, maxRetries: maxRetriesArg, abortSignal, headers, experimental_telemetry: telemetry, }: {
     /**
   The embedding model to use.
        */
@@ -626,11 +626,11 @@ type Prompt = {
 /**
 The result of a `generateObject` call.
  */
-interface GenerateObjectResult<T> {
+interface GenerateObjectResult<OBJECT> {
     /**
     The generated object (typed according to the schema).
        */
-    readonly object: T;
+    readonly object: OBJECT;
     /**
     The reason why the generation finished.
        */
@@ -1405,12 +1405,16 @@ type StepResult<TOOLS extends Record<string, CoreTool>> = {
 The result of a `generateText` call.
 It contains the generated text, the tool calls that were made during the generation, and the results of the tool calls.
  */
-interface GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
+interface GenerateTextResult<TOOLS extends Record<string, CoreTool>, OUTPUT> {
     /**
     The generated text.
        */
     readonly text: string;
     /**
+    The generated output.
+     */
+    readonly experimental_output: OUTPUT;
+    /**
     The tool calls that were made during the generation.
      */
     readonly toolCalls: ToolCallArray<TOOLS>;
@@ -1469,6 +1473,35 @@ interface GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
     readonly experimental_providerMetadata: ProviderMetadata | undefined;
 }
 
+interface Output<OUTPUT> {
+    readonly type: 'object' | 'text';
+    injectIntoSystemPrompt(options: {
+        system: string | undefined;
+        model: LanguageModel;
+    }): string | undefined;
+    responseFormat: (options: {
+        model: LanguageModel;
+    }) => LanguageModelV1CallOptions['responseFormat'];
+    parseOutput(options: {
+        text: string;
+    }): OUTPUT;
+}
+declare const text: () => Output<string>;
+declare const object: <OUTPUT>({ schema: inputSchema, }: {
+    schema: z.Schema<OUTPUT, z.ZodTypeDef, any> | Schema<OUTPUT>;
+}) => Output<OUTPUT>;
+
+type output_Output<OUTPUT> = Output<OUTPUT>;
+declare const output_object: typeof object;
+declare const output_text: typeof text;
+declare namespace output {
+  export {
+    output_Output as Output,
+    output_object as object,
+    output_text as text,
+  };
+}
+
 /**
 Generate a text and call tools for a given prompt using a language model.
 
@@ -1515,7 +1548,7 @@ If set and supported by the model, calls will generate deterministic results.
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxSteps, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_activeTools: activeTools, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, CoreTool>, OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, maxSteps, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_activeTools: activeTools, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1557,6 +1590,7 @@ Limits the tools that are available for the model to call without
 changing the tool call and result types in the result.
      */
     experimental_activeTools?: Array<keyof TOOLS>;
+    experimental_output?: Output<OUTPUT>;
     /**
     Callback that is called when each step (LLM call) is finished, including intermediate steps.
     */
@@ -1568,7 +1602,7 @@ changing the tool call and result types in the result.
         generateId?: () => string;
         currentDate?: () => Date;
     };
-}): Promise<GenerateTextResult<TOOLS>>;
+}): Promise<GenerateTextResult<TOOLS, OUTPUT>>;
 
 /**
  * A stream wrapper to send custom JSON-encoded data back to the client.
@@ -2255,4 +2289,4 @@ declare namespace llamaindexAdapter {
   };
 }
 
-export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoObjectGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, TextPart, TextStreamPart, ToolCallPart, ToolContent, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createStreamDataTransformer, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, experimental_wrapLanguageModel, generateObject, generateText, streamObject, streamText, tool };
+export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoObjectGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, TextPart, TextStreamPart, ToolCallPart, ToolContent, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createStreamDataTransformer, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, experimental_wrapLanguageModel, generateObject, generateText, streamObject, streamText, tool };

package/dist/index.d.ts

@@ -221,7 +221,7 @@ Embed a value using an embedding model. The type of the value is defined by the
 
 @returns A result object that contains the embedding, the value, and additional information.
  */
-declare function embed<VALUE>({ model, value, maxRetries, abortSignal, headers, experimental_telemetry: telemetry, }: {
+declare function embed<VALUE>({ model, value, maxRetries: maxRetriesArg, abortSignal, headers, experimental_telemetry: telemetry, }: {
     /**
   The embedding model to use.
        */
@@ -286,7 +286,7 @@ has a limit on how many embeddings can be generated in a single call.
 
 @returns A result object that contains the embeddings, the value, and additional information.
  */
-declare function embedMany<VALUE>({ model, values, maxRetries, abortSignal, headers, experimental_telemetry: telemetry, }: {
+declare function embedMany<VALUE>({ model, values, maxRetries: maxRetriesArg, abortSignal, headers, experimental_telemetry: telemetry, }: {
     /**
   The embedding model to use.
        */
@@ -626,11 +626,11 @@ type Prompt = {
 /**
 The result of a `generateObject` call.
  */
-interface GenerateObjectResult<T> {
+interface GenerateObjectResult<OBJECT> {
     /**
     The generated object (typed according to the schema).
        */
-    readonly object: T;
+    readonly object: OBJECT;
     /**
     The reason why the generation finished.
        */
@@ -1405,12 +1405,16 @@ type StepResult<TOOLS extends Record<string, CoreTool>> = {
 The result of a `generateText` call.
 It contains the generated text, the tool calls that were made during the generation, and the results of the tool calls.
  */
-interface GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
+interface GenerateTextResult<TOOLS extends Record<string, CoreTool>, OUTPUT> {
     /**
     The generated text.
        */
     readonly text: string;
     /**
+    The generated output.
+     */
+    readonly experimental_output: OUTPUT;
+    /**
     The tool calls that were made during the generation.
      */
     readonly toolCalls: ToolCallArray<TOOLS>;
@@ -1469,6 +1473,35 @@ interface GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
     readonly experimental_providerMetadata: ProviderMetadata | undefined;
 }
 
+interface Output<OUTPUT> {
+    readonly type: 'object' | 'text';
+    injectIntoSystemPrompt(options: {
+        system: string | undefined;
+        model: LanguageModel;
+    }): string | undefined;
+    responseFormat: (options: {
+        model: LanguageModel;
+    }) => LanguageModelV1CallOptions['responseFormat'];
+    parseOutput(options: {
+        text: string;
+    }): OUTPUT;
+}
+declare const text: () => Output<string>;
+declare const object: <OUTPUT>({ schema: inputSchema, }: {
+    schema: z.Schema<OUTPUT, z.ZodTypeDef, any> | Schema<OUTPUT>;
+}) => Output<OUTPUT>;
+
+type output_Output<OUTPUT> = Output<OUTPUT>;
+declare const output_object: typeof object;
+declare const output_text: typeof text;
+declare namespace output {
+  export {
+    output_Output as Output,
+    output_object as object,
+    output_text as text,
+  };
+}
+
 /**
 Generate a text and call tools for a given prompt using a language model.
 
@@ -1515,7 +1548,7 @@ If set and supported by the model, calls will generate deterministic results.
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxSteps, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_activeTools: activeTools, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, CoreTool>, OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, maxSteps, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_activeTools: activeTools, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1557,6 +1590,7 @@ Limits the tools that are available for the model to call without
 changing the tool call and result types in the result.
      */
     experimental_activeTools?: Array<keyof TOOLS>;
+    experimental_output?: Output<OUTPUT>;
     /**
     Callback that is called when each step (LLM call) is finished, including intermediate steps.
     */
@@ -1568,7 +1602,7 @@ changing the tool call and result types in the result.
         generateId?: () => string;
         currentDate?: () => Date;
     };
-}): Promise<GenerateTextResult<TOOLS>>;
+}): Promise<GenerateTextResult<TOOLS, OUTPUT>>;
 
 /**
  * A stream wrapper to send custom JSON-encoded data back to the client.
@@ -2255,4 +2289,4 @@ declare namespace llamaindexAdapter {
   };
 }
 
-export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoObjectGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, TextPart, TextStreamPart, ToolCallPart, ToolContent, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createStreamDataTransformer, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, experimental_wrapLanguageModel, generateObject, generateText, streamObject, streamText, tool };
+export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoObjectGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, TextPart, TextStreamPart, ToolCallPart, ToolContent, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createStreamDataTransformer, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, experimental_wrapLanguageModel, generateObject, generateText, streamObject, streamText, tool };