ai 3.4.17 → 3.4.20

package/dist/index.d.ts

@@ -8,6 +8,7 @@ import { ServerResponse } from 'http';
 import { ServerResponse as ServerResponse$1 } from 'node:http';
 import { AssistantStream } from 'openai/lib/AssistantStream';
 import { Run } from 'openai/resources/beta/threads/runs/runs';
+export { ToolCall as CoreToolCall, ToolResult as CoreToolResult } from '@ai-sdk/provider-utils';
 
 /**
  * Telemetry configuration.
@@ -120,23 +121,36 @@ type CoreToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | '
     type: 'tool';
     toolName: keyof TOOLS;
 };
+
+type LanguageModelRequestMetadata = {
+    /**
+    Raw request HTTP body that was sent to the provider API as a string (JSON should be stringified).
+       */
+    body?: string;
+};
+
 type LanguageModelResponseMetadata = {
     /**
-  ID for the generated response.
+    ID for the generated response.
        */
     id: string;
     /**
-  Timestamp for the start of the generated response.
-  */
+    Timestamp for the start of the generated response.
+    */
     timestamp: Date;
     /**
-  The ID of the response model that was used to generate the response.
-  */
+    The ID of the response model that was used to generate the response.
+    */
     modelId: string;
-};
-type LanguageModelResponseMetadataWithHeaders = LanguageModelResponseMetadata & {
+    /**
+  Response headers.
+       */
     headers?: Record<string, string>;
 };
+/**
+@deprecated Use `LanguageModelResponseMetadata` instead.
+ */
+type LanguageModelResponseMetadataWithHeaders = LanguageModelResponseMetadata;
 
 /**
  * Provider for language and text embedding models.
@@ -402,6 +416,15 @@ Data content. Can either be a base64-encoded string, a Uint8Array, an ArrayBuffe
  */
 type DataContent = string | Uint8Array | ArrayBuffer | Buffer;
 
+type ToolResultContent = Array<{
+    type: 'text';
+    text: string;
+} | {
+    type: 'image';
+    data: string;
+    mimeType?: string;
+}>;
+
 /**
 Text content part of a prompt. It contains a string of text.
  */
@@ -506,6 +529,10 @@ interface ToolResultPart {
      */
     result: unknown;
     /**
+  Multi-part content of the tool result. Only for tools that support multipart results.
+     */
+    experimental_content?: ToolResultContent;
+    /**
   Optional flag if the result is an error or an error message.
      */
     isError?: boolean;
@@ -608,7 +635,8 @@ It can be a user message, an assistant message, or a tool message.
 type CoreMessage = CoreSystemMessage | CoreUserMessage | CoreAssistantMessage | CoreToolMessage;
 
 /**
-Prompt part of the AI function options. It contains a system message, a simple text prompt, or a list of messages.
+Prompt part of the AI function options.
+It contains a system message, a simple text prompt, or a list of messages.
  */
 type Prompt = {
     /**
@@ -620,7 +648,7 @@ type Prompt = {
    */
     prompt?: string;
     /**
-  A list of messsages. You can either use `prompt` or `messages` but not both.
+  A list of messages. You can either use `prompt` or `messages` but not both.
      */
     messages?: Array<CoreMessage>;
 };
@@ -657,9 +685,13 @@ interface GenerateObjectResult<T> {
         headers?: Record<string, string>;
     };
     /**
+  Additional request information.
+     */
+    readonly request: LanguageModelRequestMetadata;
+    /**
   Additional response information.
      */
-    readonly response: LanguageModelResponseMetadataWithHeaders;
+    readonly response: LanguageModelResponseMetadata;
     /**
    Logprobs for the completion.
   `undefined` if the mode does not support logprobs or if was not enabled.
@@ -927,9 +959,13 @@ interface StreamObjectResult<PARTIAL, RESULT, ELEMENT_STREAM> {
         headers?: Record<string, string>;
     };
     /**
+  Additional request information from the last step.
+   */
+    readonly request: Promise<LanguageModelRequestMetadata>;
+    /**
   Additional response information.
    */
-    readonly response: Promise<LanguageModelResponseMetadataWithHeaders>;
+    readonly response: Promise<LanguageModelResponseMetadata>;
     /**
     The generated object (typed according to the schema). Resolved when the response is finished.
        */
@@ -1019,7 +1055,7 @@ type OnFinishCallback<RESULT> = (event: {
     /**
   Response metadata.
    */
-    response: LanguageModelResponseMetadataWithHeaders;
+    response: LanguageModelResponseMetadata;
     /**
   Warnings from the model provider (e.g. unsupported settings).
   */
@@ -1219,11 +1255,7 @@ This enables the language model to generate the input.
 
 The tool can also contain an optional execute function for the actual execution function of the tool.
  */
-interface CoreTool<PARAMETERS extends Parameters = any, RESULT = any> {
-    /**
-  An optional description of what the tool does. Will be used by the language model to decide whether to use the tool.
-     */
-    description?: string;
+type CoreTool<PARAMETERS extends Parameters = any, RESULT = any> = {
     /**
   The schema of the input that the tool expects. The language model will use this to generate the input.
   It is also used to validate the output of the language model.
@@ -1231,6 +1263,10 @@ interface CoreTool<PARAMETERS extends Parameters = any, RESULT = any> {
      */
     parameters: PARAMETERS;
     /**
+  Optional conversion function that maps the tool result to multi-part tool content for LLMs.
+     */
+    experimental_toToolResultContent?: (result: RESULT) => ToolResultContent;
+    /**
   An async function that is called with the arguments from the tool call and produces a result.
   If not provided, the tool will not be executed automatically.
   
@@ -1240,7 +1276,29 @@ interface CoreTool<PARAMETERS extends Parameters = any, RESULT = any> {
     execute?: (args: inferParameters<PARAMETERS>, options: {
         abortSignal?: AbortSignal;
     }) => PromiseLike<RESULT>;
-}
+} & ({
+    /**
+Function tool.
+     */
+    type?: undefined | 'function';
+    /**
+An optional description of what the tool does. Will be used by the language model to decide whether to use the tool.
+ */
+    description?: string;
+} | {
+    /**
+Provider-defined tool.
+     */
+    type: 'provider-defined';
+    /**
+The ID of the tool. Should follow the format `<provider-name>.<tool-name>`.
+     */
+    id: `${string}.${string}`;
+    /**
+The arguments for configuring the tool. Must match the expected arguments defined by the provider for this tool.
+     */
+    args: Record<string, unknown>;
+});
 /**
 Helper function for inferring the execute args of a tool.
  */
@@ -1317,24 +1375,6 @@ onlyBar('bar');
 */
 type ValueOf<ObjectType, ValueType extends keyof ObjectType = keyof ObjectType> = ObjectType[ValueType];
 
-/**
-Typed tool call that is returned by `generateText` and `streamText`.
-It contains the tool call ID, the tool name, and the tool arguments.
- */
-interface ToolCall<NAME extends string, ARGS> {
-    /**
-  ID of the tool call. This ID is used to match the tool call with the tool result.
-   */
-    toolCallId: string;
-    /**
-  Name of the tool that is being called.
-   */
-    toolName: NAME;
-    /**
-  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
-     */
-    args: ARGS;
-}
 type ToolCallUnion<TOOLS extends Record<string, CoreTool>> = ValueOf<{
     [NAME in keyof TOOLS]: {
         type: 'tool-call';
@@ -1345,28 +1385,6 @@ type ToolCallUnion<TOOLS extends Record<string, CoreTool>> = ValueOf<{
 }>;
 type ToolCallArray<TOOLS extends Record<string, CoreTool>> = Array<ToolCallUnion<TOOLS>>;
 
-/**
-Typed tool result that is returned by `generateText` and `streamText`.
-It contains the tool call ID, the tool name, the tool arguments, and the tool result.
- */
-interface ToolResult<NAME extends string, ARGS, RESULT> {
-    /**
-  ID of the tool call. This ID is used to match the tool call with the tool result.
-   */
-    toolCallId: string;
-    /**
-  Name of the tool that was called.
-   */
-    toolName: NAME;
-    /**
-  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
-     */
-    args: ARGS;
-    /**
-  Result of the tool call. This is the result of the tool's execution.
-     */
-    result: RESULT;
-}
 type ToToolsWithExecute<TOOLS extends Record<string, CoreTool>> = {
     [K in keyof TOOLS as TOOLS[K] extends {
         execute: any;
@@ -1432,9 +1450,19 @@ type StepResult<TOOLS extends Record<string, CoreTool>> = {
         readonly headers?: Record<string, string>;
     };
     /**
+  Additional request information.
+     */
+    readonly request: LanguageModelRequestMetadata;
+    /**
   Additional response information.
   */
-    readonly response: LanguageModelResponseMetadataWithHeaders;
+    readonly response: LanguageModelResponseMetadata & {
+        /**
+    The response messages that were generated during the call. It consists of an assistant message,
+    potentially containing tool calls.
+    */
+        readonly messages: Array<CoreAssistantMessage | CoreToolMessage>;
+    };
     /**
   Additional provider-specific metadata. They are passed through
   from the provider to the AI SDK and enable provider-specific
@@ -1483,12 +1511,7 @@ interface GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
      */
     readonly warnings: CallWarning[] | undefined;
     /**
-  The response messages that were generated during the call. It consists of an assistant message,
-  potentially containing tool calls.
-  
-  When there are tool results, there is an additional tool message with the tool results that are available.
-  If there are tools that do not have execute functions, they are not included in the tool results and
-  need to be added separately.
+  @deprecated use `response.messages` instead.
        */
     readonly responseMessages: Array<CoreAssistantMessage | CoreToolMessage>;
     /**
@@ -1516,9 +1539,23 @@ interface GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
         readonly headers?: Record<string, string>;
     };
     /**
+  Additional request information.
+     */
+    readonly request: LanguageModelRequestMetadata;
+    /**
   Additional response information.
      */
-    readonly response: LanguageModelResponseMetadataWithHeaders;
+    readonly response: LanguageModelResponseMetadata & {
+        /**
+    The response messages that were generated during the call. It consists of an assistant message,
+    potentially containing tool calls.
+    
+    When there are tool results, there is an additional tool message with the tool results that are available.
+    If there are tools that do not have execute functions, they are not included in the tool results and
+    need to be added separately.
+           */
+        messages: Array<CoreAssistantMessage | CoreToolMessage>;
+    };
     /**
   Logprobs for the completion.
   `undefined` if the mode does not support logprobs or if it was not enabled.
@@ -1719,14 +1756,7 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
         headers?: Record<string, string>;
     };
     /**
-  The response messages that were generated during the call. It consists of an assistant message,
-  potentially containing tool calls.
-  
-  When there are tool results, there is an additional tool message with the tool results that are available.
-  If there are tools that do not have execute functions, they are not included in the tool results and
-  need to be added separately.
-  
-  Resolved when the response is finished.
+  @deprecated use `response.messages` instead.
        */
     readonly responseMessages: Promise<Array<CoreAssistantMessage | CoreToolMessage>>;
     /**
@@ -1736,7 +1766,11 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
      */
     readonly steps: Promise<Array<StepResult<TOOLS>>>;
     /**
-  Additional response information.
+  Additional request information from the last step.
+   */
+    readonly request: Promise<LanguageModelRequestMetadata>;
+    /**
+  Additional response information from the last step.
    */
     readonly response: Promise<LanguageModelResponseMetadataWithHeaders>;
     /**
@@ -3241,4 +3275,4 @@ declare const generateId: (size?: number) => string;
  */
 declare const nanoid: (size?: number) => string;
 
-export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantResponse, CallWarning, CohereStream, CompletionTokenUsage, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCall as CoreToolCall, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResult as CoreToolResult, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, EmbeddingTokenUsage, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LanguageModelResponseMetadata, LanguageModelResponseMetadataWithHeaders, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, MistralStream, NoObjectGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, OpenAIStream, OpenAIStreamCallbacks, Provider, ProviderMetadata, ReplicateStream, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, TokenUsage, ToolCallPart, ToolCallPayload, ToolContent, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createCallbacksTransformer, createEventStreamTransformer, createStreamDataTransformer, embed, embedMany, experimental_AssistantResponse, experimental_ModelRegistry, experimental_Provider, experimental_ProviderRegistry, experimental_StreamData, experimental_createModelRegistry, experimental_createProviderRegistry, experimental_customProvider, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, experimental_wrapLanguageModel, generateId, generateObject, generateText, 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, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, EmbeddingTokenUsage, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelResponseMetadataWithHeaders, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, MistralStream, NoObjectGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, OpenAIStream, OpenAIStreamCallbacks, Provider, ProviderMetadata, ReplicateStream, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, TokenUsage, ToolCallPart, ToolCallPayload, ToolContent, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createCallbacksTransformer, createEventStreamTransformer, createStreamDataTransformer, embed, embedMany, experimental_AssistantResponse, experimental_ModelRegistry, experimental_Provider, experimental_ProviderRegistry, experimental_StreamData, experimental_createModelRegistry, experimental_createProviderRegistry, experimental_customProvider, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, experimental_wrapLanguageModel, generateId, generateObject, generateText, nanoid, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };