ai 3.3.8 → 3.3.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { Schema, DeepPartial, Attachment, JSONValue, CreateMessage, FunctionCall as FunctionCall$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
2
2
  export { AssistantMessage, AssistantStatus, ChatRequest, ChatRequestOptions, CreateMessage, DataMessage, DeepPartial, Function, FunctionCall, FunctionCallHandler, IdGenerator, JSONValue, Message, RequestOptions, Schema, StreamPart, Tool, ToolCall, ToolCallHandler, ToolChoice, ToolInvocation, UseAssistantOptions, formatStreamPart, jsonSchema, parseComplexResponse, parseStreamPart, readDataStream } from '@ai-sdk/ui-utils';
3
3
  import { AttributeValue, Span } from '@opentelemetry/api';
4
- import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1StreamPart, AISDKError } from '@ai-sdk/provider';
4
+ import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1ProviderMetadata, LanguageModelV1StreamPart, AISDKError } from '@ai-sdk/provider';
5
5
  export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LoadAPIKeyError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
6
6
  import { z } from 'zod';
7
7
  import { ServerResponse } from 'http';
@@ -103,6 +103,12 @@ some settings might not be supported, which can lead to suboptimal results.
103
103
  */
104
104
  type CallWarning = LanguageModelV1CallWarning;
105
105
  /**
106
+ Additional provider-specific metadata. They are passed through
107
+ to the provider from the AI SDK and enable provider-specific
108
+ functionality that can be fully encapsulated in the provider.
109
+ */
110
+ type ProviderMetadata = LanguageModelV1ProviderMetadata;
111
+ /**
106
112
  Tool choice for the generation. It supports the following settings:
107
113
 
108
114
  - `auto` (default): the model can choose whether and which tools to call.
@@ -369,6 +375,12 @@ interface TextPart$1 {
369
375
  The text content.
370
376
  */
371
377
  text: string;
378
+ /**
379
+ Additional provider-specific metadata. They are passed through
380
+ to the provider from the AI SDK and enable provider-specific
381
+ functionality that can be fully encapsulated in the provider.
382
+ */
383
+ experimental_providerMetadata?: ProviderMetadata;
372
384
  }
373
385
  /**
374
386
  Image content part of a prompt. It contains an image.
@@ -386,6 +398,12 @@ interface ImagePart {
386
398
  Optional mime type of the image.
387
399
  */
388
400
  mimeType?: string;
401
+ /**
402
+ Additional provider-specific metadata. They are passed through
403
+ to the provider from the AI SDK and enable provider-specific
404
+ functionality that can be fully encapsulated in the provider.
405
+ */
406
+ experimental_providerMetadata?: ProviderMetadata;
389
407
  }
390
408
  /**
391
409
  Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).
@@ -426,6 +444,12 @@ interface ToolResultPart {
426
444
  Optional flag if the result is an error or an error message.
427
445
  */
428
446
  isError?: boolean;
447
+ /**
448
+ Additional provider-specific metadata. They are passed through
449
+ to the provider from the AI SDK and enable provider-specific
450
+ functionality that can be fully encapsulated in the provider.
451
+ */
452
+ experimental_providerMetadata?: ProviderMetadata;
429
453
  }
430
454
 
431
455
  /**
@@ -443,6 +467,12 @@ type CoreMessage = CoreSystemMessage | CoreUserMessage | CoreAssistantMessage |
443
467
  type CoreSystemMessage = {
444
468
  role: 'system';
445
469
  content: string;
470
+ /**
471
+ Additional provider-specific metadata. They are passed through
472
+ to the provider from the AI SDK and enable provider-specific
473
+ functionality that can be fully encapsulated in the provider.
474
+ */
475
+ experimental_providerMetadata?: ProviderMetadata;
446
476
  };
447
477
  /**
448
478
  * @deprecated Use `CoreMessage` instead.
@@ -454,6 +484,12 @@ A user message. It can contain text or a combination of text and images.
454
484
  type CoreUserMessage = {
455
485
  role: 'user';
456
486
  content: UserContent;
487
+ /**
488
+ Additional provider-specific metadata. They are passed through
489
+ to the provider from the AI SDK and enable provider-specific
490
+ functionality that can be fully encapsulated in the provider.
491
+ */
492
+ experimental_providerMetadata?: ProviderMetadata;
457
493
  };
458
494
  /**
459
495
  * @deprecated Use `CoreUserMessage` instead.
@@ -469,6 +505,12 @@ An assistant message. It can contain text, tool calls, or a combination of text
469
505
  type CoreAssistantMessage = {
470
506
  role: 'assistant';
471
507
  content: AssistantContent;
508
+ /**
509
+ Additional provider-specific metadata. They are passed through
510
+ to the provider from the AI SDK and enable provider-specific
511
+ functionality that can be fully encapsulated in the provider.
512
+ */
513
+ experimental_providerMetadata?: ProviderMetadata;
472
514
  };
473
515
  /**
474
516
  * @deprecated Use `CoreAssistantMessage` instead.
@@ -484,6 +526,12 @@ A tool message. It contains the result of one or more tool calls.
484
526
  type CoreToolMessage = {
485
527
  role: 'tool';
486
528
  content: ToolContent;
529
+ /**
530
+ Additional provider-specific metadata. They are passed through
531
+ to the provider from the AI SDK and enable provider-specific
532
+ functionality that can be fully encapsulated in the provider.
533
+ */
534
+ experimental_providerMetadata?: ProviderMetadata;
487
535
  };
488
536
  /**
489
537
  * @deprecated Use `CoreToolMessage` instead.
@@ -547,6 +595,12 @@ interface GenerateObjectResult<T> {
547
595
  */
548
596
  readonly logprobs: LogProbs | undefined;
549
597
  /**
598
+ Additional provider-specific metadata. They are passed through
599
+ from the provider to the AI SDK and enable provider-specific
600
+ results that can be fully encapsulated in the provider.
601
+ */
602
+ readonly experimental_providerMetadata: ProviderMetadata | undefined;
603
+ /**
550
604
  Converts the object to a JSON response.
551
605
  The response will have a status code of 200 and a content type of `application/json; charset=utf-8`.
552
606
  */
@@ -642,6 +696,7 @@ declare class DefaultGenerateObjectResult<T> implements GenerateObjectResult<T>
642
696
  readonly warnings: GenerateObjectResult<T>['warnings'];
643
697
  readonly rawResponse: GenerateObjectResult<T>['rawResponse'];
644
698
  readonly logprobs: GenerateObjectResult<T>['logprobs'];
699
+ readonly experimental_providerMetadata: GenerateObjectResult<T>['experimental_providerMetadata'];
645
700
  constructor(options: {
646
701
  object: GenerateObjectResult<T>['object'];
647
702
  finishReason: GenerateObjectResult<T>['finishReason'];
@@ -649,6 +704,7 @@ declare class DefaultGenerateObjectResult<T> implements GenerateObjectResult<T>
649
704
  warnings: GenerateObjectResult<T>['warnings'];
650
705
  rawResponse: GenerateObjectResult<T>['rawResponse'];
651
706
  logprobs: GenerateObjectResult<T>['logprobs'];
707
+ providerMetadata: GenerateObjectResult<T>['experimental_providerMetadata'];
652
708
  });
653
709
  toJsonResponse(init?: ResponseInit): Response;
654
710
  }
@@ -672,6 +728,12 @@ interface StreamObjectResult<T> {
672
728
  */
673
729
  readonly usage: Promise<CompletionTokenUsage$1>;
674
730
  /**
731
+ Additional provider-specific metadata. They are passed through
732
+ from the provider to the AI SDK and enable provider-specific
733
+ results that can be fully encapsulated in the provider.
734
+ */
735
+ readonly experimental_providerMetadata: Promise<ProviderMetadata | undefined>;
736
+ /**
675
737
  Optional raw response data.
676
738
  */
677
739
  readonly rawResponse?: {
@@ -735,6 +797,7 @@ type ObjectStreamInputPart = {
735
797
  completionTokens: number;
736
798
  totalTokens: number;
737
799
  };
800
+ providerMetadata?: ProviderMetadata;
738
801
  };
739
802
  type ObjectStreamPart<T> = ObjectStreamInputPart | {
740
803
  type: 'object';
@@ -854,6 +917,12 @@ Callback that is called when the LLM response and the final object validation ar
854
917
  Warnings from the model provider (e.g. unsupported settings).
855
918
  */
856
919
  warnings?: CallWarning[];
920
+ /**
921
+ Additional provider-specific metadata. They are passed through
922
+ from the provider to the AI SDK and enable provider-specific
923
+ results that can be fully encapsulated in the provider.
924
+ */
925
+ experimental_providerMetadata: ProviderMetadata | undefined;
857
926
  }) => Promise<void> | void;
858
927
  }): Promise<DefaultStreamObjectResult<T>>;
859
928
  declare class DefaultStreamObjectResult<T> implements StreamObjectResult<T> {
@@ -861,6 +930,7 @@ declare class DefaultStreamObjectResult<T> implements StreamObjectResult<T> {
861
930
  private readonly objectPromise;
862
931
  readonly warnings: StreamObjectResult<T>['warnings'];
863
932
  readonly usage: StreamObjectResult<T>['usage'];
933
+ readonly experimental_providerMetadata: StreamObjectResult<T>['experimental_providerMetadata'];
864
934
  readonly rawResponse: StreamObjectResult<T>['rawResponse'];
865
935
  constructor({ stream, warnings, rawResponse, schema, onFinish, rootSpan, doStreamSpan, telemetry, }: {
866
936
  stream: ReadableStream<string | Omit<LanguageModelV1StreamPart, 'text-delta'>>;
@@ -1130,6 +1200,12 @@ interface GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
1130
1200
  `undefined` if the mode does not support logprobs or if was not enabled.
1131
1201
  */
1132
1202
  readonly logprobs: LogProbs | undefined;
1203
+ /**
1204
+ Additional provider-specific metadata. They are passed through
1205
+ from the provider to the AI SDK and enable provider-specific
1206
+ results that can be fully encapsulated in the provider.
1207
+ */
1208
+ readonly experimental_providerMetadata: ProviderMetadata | undefined;
1133
1209
  }
1134
1210
 
1135
1211
  /**
@@ -1233,6 +1309,12 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
1233
1309
  */
1234
1310
  readonly finishReason: Promise<FinishReason>;
1235
1311
  /**
1312
+ Additional provider-specific metadata. They are passed through
1313
+ from the provider to the AI SDK and enable provider-specific
1314
+ results that can be fully encapsulated in the provider.
1315
+ */
1316
+ readonly experimental_providerMetadata: Promise<ProviderMetadata | undefined>;
1317
+ /**
1236
1318
  The full text that has been generated. Resolved when the response is finished.
1237
1319
  */
1238
1320
  readonly text: Promise<string>;
@@ -1378,6 +1460,7 @@ type TextStreamPart<TOOLS extends Record<string, CoreTool>> = {
1378
1460
  completionTokens: number;
1379
1461
  totalTokens: number;
1380
1462
  };
1463
+ experimental_providerMetadata?: ProviderMetadata;
1381
1464
  } | {
1382
1465
  type: 'error';
1383
1466
  error: unknown;
@@ -1494,6 +1577,12 @@ Callback that is called when the LLM response and all request tool executions
1494
1577
  Warnings from the model provider (e.g. unsupported settings).
1495
1578
  */
1496
1579
  warnings?: CallWarning[];
1580
+ /**
1581
+ Additional provider-specific metadata. They are passed through
1582
+ from the provider to the AI SDK and enable provider-specific
1583
+ results that can be fully encapsulated in the provider.
1584
+ */
1585
+ readonly experimental_providerMetadata: ProviderMetadata | undefined;
1497
1586
  }) => Promise<void> | void;
1498
1587
  }): Promise<DefaultStreamTextResult<TOOLS>>;
1499
1588
  declare class DefaultStreamTextResult<TOOLS extends Record<string, CoreTool>> implements StreamTextResult<TOOLS> {
@@ -1501,6 +1590,7 @@ declare class DefaultStreamTextResult<TOOLS extends Record<string, CoreTool>> im
1501
1590
  readonly warnings: StreamTextResult<TOOLS>['warnings'];
1502
1591
  readonly usage: StreamTextResult<TOOLS>['usage'];
1503
1592
  readonly finishReason: StreamTextResult<TOOLS>['finishReason'];
1593
+ readonly experimental_providerMetadata: StreamTextResult<TOOLS>['experimental_providerMetadata'];
1504
1594
  readonly text: StreamTextResult<TOOLS>['text'];
1505
1595
  readonly toolCalls: StreamTextResult<TOOLS>['toolCalls'];
1506
1596
  readonly toolResults: StreamTextResult<TOOLS>['toolResults'];
@@ -2709,4 +2799,4 @@ declare const generateId: (size?: number) => string;
2709
2799
  */
2710
2800
  declare const nanoid: (size?: number) => string;
2711
2801
 
2712
- 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, ModelType, 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_Provider, experimental_ProviderRegistry, experimental_StreamData, experimental_createModelRegistry, experimental_createProviderRegistry, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, generateId, generateObject, generateText, nanoid, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };
2802
+ 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, ModelType, NoObjectGeneratedError, NoSuchModelError, NoSuchProviderError, NoSuchToolError, ObjectStreamInputPart, ObjectStreamPart, OpenAIStream, OpenAIStreamCallbacks, ProviderMetadata, 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_Provider, experimental_ProviderRegistry, experimental_StreamData, experimental_createModelRegistry, experimental_createProviderRegistry, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, generateId, generateObject, generateText, nanoid, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };
package/dist/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { Schema, DeepPartial, Attachment, JSONValue, CreateMessage, FunctionCall as FunctionCall$1, AssistantMessage, DataMessage } from '@ai-sdk/ui-utils';
2
2
  export { AssistantMessage, AssistantStatus, ChatRequest, ChatRequestOptions, CreateMessage, DataMessage, DeepPartial, Function, FunctionCall, FunctionCallHandler, IdGenerator, JSONValue, Message, RequestOptions, Schema, StreamPart, Tool, ToolCall, ToolCallHandler, ToolChoice, ToolInvocation, UseAssistantOptions, formatStreamPart, jsonSchema, parseComplexResponse, parseStreamPart, readDataStream } from '@ai-sdk/ui-utils';
3
3
  import { AttributeValue, Span } from '@opentelemetry/api';
4
- import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1StreamPart, AISDKError } from '@ai-sdk/provider';
4
+ import { EmbeddingModelV1, EmbeddingModelV1Embedding, LanguageModelV1, LanguageModelV1FinishReason, LanguageModelV1LogProbs, LanguageModelV1CallWarning, LanguageModelV1ProviderMetadata, LanguageModelV1StreamPart, AISDKError } from '@ai-sdk/provider';
5
5
  export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LoadAPIKeyError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
6
6
  import { z } from 'zod';
7
7
  import { ServerResponse } from 'http';
@@ -103,6 +103,12 @@ some settings might not be supported, which can lead to suboptimal results.
103
103
  */
104
104
  type CallWarning = LanguageModelV1CallWarning;
105
105
  /**
106
+ Additional provider-specific metadata. They are passed through
107
+ to the provider from the AI SDK and enable provider-specific
108
+ functionality that can be fully encapsulated in the provider.
109
+ */
110
+ type ProviderMetadata = LanguageModelV1ProviderMetadata;
111
+ /**
106
112
  Tool choice for the generation. It supports the following settings:
107
113
 
108
114
  - `auto` (default): the model can choose whether and which tools to call.
@@ -369,6 +375,12 @@ interface TextPart$1 {
369
375
  The text content.
370
376
  */
371
377
  text: string;
378
+ /**
379
+ Additional provider-specific metadata. They are passed through
380
+ to the provider from the AI SDK and enable provider-specific
381
+ functionality that can be fully encapsulated in the provider.
382
+ */
383
+ experimental_providerMetadata?: ProviderMetadata;
372
384
  }
373
385
  /**
374
386
  Image content part of a prompt. It contains an image.
@@ -386,6 +398,12 @@ interface ImagePart {
386
398
  Optional mime type of the image.
387
399
  */
388
400
  mimeType?: string;
401
+ /**
402
+ Additional provider-specific metadata. They are passed through
403
+ to the provider from the AI SDK and enable provider-specific
404
+ functionality that can be fully encapsulated in the provider.
405
+ */
406
+ experimental_providerMetadata?: ProviderMetadata;
389
407
  }
390
408
  /**
391
409
  Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).
@@ -426,6 +444,12 @@ interface ToolResultPart {
426
444
  Optional flag if the result is an error or an error message.
427
445
  */
428
446
  isError?: boolean;
447
+ /**
448
+ Additional provider-specific metadata. They are passed through
449
+ to the provider from the AI SDK and enable provider-specific
450
+ functionality that can be fully encapsulated in the provider.
451
+ */
452
+ experimental_providerMetadata?: ProviderMetadata;
429
453
  }
430
454
 
431
455
  /**
@@ -443,6 +467,12 @@ type CoreMessage = CoreSystemMessage | CoreUserMessage | CoreAssistantMessage |
443
467
  type CoreSystemMessage = {
444
468
  role: 'system';
445
469
  content: string;
470
+ /**
471
+ Additional provider-specific metadata. They are passed through
472
+ to the provider from the AI SDK and enable provider-specific
473
+ functionality that can be fully encapsulated in the provider.
474
+ */
475
+ experimental_providerMetadata?: ProviderMetadata;
446
476
  };
447
477
  /**
448
478
  * @deprecated Use `CoreMessage` instead.
@@ -454,6 +484,12 @@ A user message. It can contain text or a combination of text and images.
454
484
  type CoreUserMessage = {
455
485
  role: 'user';
456
486
  content: UserContent;
487
+ /**
488
+ Additional provider-specific metadata. They are passed through
489
+ to the provider from the AI SDK and enable provider-specific
490
+ functionality that can be fully encapsulated in the provider.
491
+ */
492
+ experimental_providerMetadata?: ProviderMetadata;
457
493
  };
458
494
  /**
459
495
  * @deprecated Use `CoreUserMessage` instead.
@@ -469,6 +505,12 @@ An assistant message. It can contain text, tool calls, or a combination of text
469
505
  type CoreAssistantMessage = {
470
506
  role: 'assistant';
471
507
  content: AssistantContent;
508
+ /**
509
+ Additional provider-specific metadata. They are passed through
510
+ to the provider from the AI SDK and enable provider-specific
511
+ functionality that can be fully encapsulated in the provider.
512
+ */
513
+ experimental_providerMetadata?: ProviderMetadata;
472
514
  };
473
515
  /**
474
516
  * @deprecated Use `CoreAssistantMessage` instead.
@@ -484,6 +526,12 @@ A tool message. It contains the result of one or more tool calls.
484
526
  type CoreToolMessage = {
485
527
  role: 'tool';
486
528
  content: ToolContent;
529
+ /**
530
+ Additional provider-specific metadata. They are passed through
531
+ to the provider from the AI SDK and enable provider-specific
532
+ functionality that can be fully encapsulated in the provider.
533
+ */
534
+ experimental_providerMetadata?: ProviderMetadata;
487
535
  };
488
536
  /**
489
537
  * @deprecated Use `CoreToolMessage` instead.
@@ -547,6 +595,12 @@ interface GenerateObjectResult<T> {
547
595
  */
548
596
  readonly logprobs: LogProbs | undefined;
549
597
  /**
598
+ Additional provider-specific metadata. They are passed through
599
+ from the provider to the AI SDK and enable provider-specific
600
+ results that can be fully encapsulated in the provider.
601
+ */
602
+ readonly experimental_providerMetadata: ProviderMetadata | undefined;
603
+ /**
550
604
  Converts the object to a JSON response.
551
605
  The response will have a status code of 200 and a content type of `application/json; charset=utf-8`.
552
606
  */
@@ -642,6 +696,7 @@ declare class DefaultGenerateObjectResult<T> implements GenerateObjectResult<T>
642
696
  readonly warnings: GenerateObjectResult<T>['warnings'];
643
697
  readonly rawResponse: GenerateObjectResult<T>['rawResponse'];
644
698
  readonly logprobs: GenerateObjectResult<T>['logprobs'];
699
+ readonly experimental_providerMetadata: GenerateObjectResult<T>['experimental_providerMetadata'];
645
700
  constructor(options: {
646
701
  object: GenerateObjectResult<T>['object'];
647
702
  finishReason: GenerateObjectResult<T>['finishReason'];
@@ -649,6 +704,7 @@ declare class DefaultGenerateObjectResult<T> implements GenerateObjectResult<T>
649
704
  warnings: GenerateObjectResult<T>['warnings'];
650
705
  rawResponse: GenerateObjectResult<T>['rawResponse'];
651
706
  logprobs: GenerateObjectResult<T>['logprobs'];
707
+ providerMetadata: GenerateObjectResult<T>['experimental_providerMetadata'];
652
708
  });
653
709
  toJsonResponse(init?: ResponseInit): Response;
654
710
  }
@@ -672,6 +728,12 @@ interface StreamObjectResult<T> {
672
728
  */
673
729
  readonly usage: Promise<CompletionTokenUsage$1>;
674
730
  /**
731
+ Additional provider-specific metadata. They are passed through
732
+ from the provider to the AI SDK and enable provider-specific
733
+ results that can be fully encapsulated in the provider.
734
+ */
735
+ readonly experimental_providerMetadata: Promise<ProviderMetadata | undefined>;
736
+ /**
675
737
  Optional raw response data.
676
738
  */
677
739
  readonly rawResponse?: {
@@ -735,6 +797,7 @@ type ObjectStreamInputPart = {
735
797
  completionTokens: number;
736
798
  totalTokens: number;
737
799
  };
800
+ providerMetadata?: ProviderMetadata;
738
801
  };
739
802
  type ObjectStreamPart<T> = ObjectStreamInputPart | {
740
803
  type: 'object';
@@ -854,6 +917,12 @@ Callback that is called when the LLM response and the final object validation ar
854
917
  Warnings from the model provider (e.g. unsupported settings).
855
918
  */
856
919
  warnings?: CallWarning[];
920
+ /**
921
+ Additional provider-specific metadata. They are passed through
922
+ from the provider to the AI SDK and enable provider-specific
923
+ results that can be fully encapsulated in the provider.
924
+ */
925
+ experimental_providerMetadata: ProviderMetadata | undefined;
857
926
  }) => Promise<void> | void;
858
927
  }): Promise<DefaultStreamObjectResult<T>>;
859
928
  declare class DefaultStreamObjectResult<T> implements StreamObjectResult<T> {
@@ -861,6 +930,7 @@ declare class DefaultStreamObjectResult<T> implements StreamObjectResult<T> {
861
930
  private readonly objectPromise;
862
931
  readonly warnings: StreamObjectResult<T>['warnings'];
863
932
  readonly usage: StreamObjectResult<T>['usage'];
933
+ readonly experimental_providerMetadata: StreamObjectResult<T>['experimental_providerMetadata'];
864
934
  readonly rawResponse: StreamObjectResult<T>['rawResponse'];
865
935
  constructor({ stream, warnings, rawResponse, schema, onFinish, rootSpan, doStreamSpan, telemetry, }: {
866
936
  stream: ReadableStream<string | Omit<LanguageModelV1StreamPart, 'text-delta'>>;
@@ -1130,6 +1200,12 @@ interface GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
1130
1200
  `undefined` if the mode does not support logprobs or if was not enabled.
1131
1201
  */
1132
1202
  readonly logprobs: LogProbs | undefined;
1203
+ /**
1204
+ Additional provider-specific metadata. They are passed through
1205
+ from the provider to the AI SDK and enable provider-specific
1206
+ results that can be fully encapsulated in the provider.
1207
+ */
1208
+ readonly experimental_providerMetadata: ProviderMetadata | undefined;
1133
1209
  }
1134
1210
 
1135
1211
  /**
@@ -1233,6 +1309,12 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
1233
1309
  */
1234
1310
  readonly finishReason: Promise<FinishReason>;
1235
1311
  /**
1312
+ Additional provider-specific metadata. They are passed through
1313
+ from the provider to the AI SDK and enable provider-specific
1314
+ results that can be fully encapsulated in the provider.
1315
+ */
1316
+ readonly experimental_providerMetadata: Promise<ProviderMetadata | undefined>;
1317
+ /**
1236
1318
  The full text that has been generated. Resolved when the response is finished.
1237
1319
  */
1238
1320
  readonly text: Promise<string>;
@@ -1378,6 +1460,7 @@ type TextStreamPart<TOOLS extends Record<string, CoreTool>> = {
1378
1460
  completionTokens: number;
1379
1461
  totalTokens: number;
1380
1462
  };
1463
+ experimental_providerMetadata?: ProviderMetadata;
1381
1464
  } | {
1382
1465
  type: 'error';
1383
1466
  error: unknown;
@@ -1494,6 +1577,12 @@ Callback that is called when the LLM response and all request tool executions
1494
1577
  Warnings from the model provider (e.g. unsupported settings).
1495
1578
  */
1496
1579
  warnings?: CallWarning[];
1580
+ /**
1581
+ Additional provider-specific metadata. They are passed through
1582
+ from the provider to the AI SDK and enable provider-specific
1583
+ results that can be fully encapsulated in the provider.
1584
+ */
1585
+ readonly experimental_providerMetadata: ProviderMetadata | undefined;
1497
1586
  }) => Promise<void> | void;
1498
1587
  }): Promise<DefaultStreamTextResult<TOOLS>>;
1499
1588
  declare class DefaultStreamTextResult<TOOLS extends Record<string, CoreTool>> implements StreamTextResult<TOOLS> {
@@ -1501,6 +1590,7 @@ declare class DefaultStreamTextResult<TOOLS extends Record<string, CoreTool>> im
1501
1590
  readonly warnings: StreamTextResult<TOOLS>['warnings'];
1502
1591
  readonly usage: StreamTextResult<TOOLS>['usage'];
1503
1592
  readonly finishReason: StreamTextResult<TOOLS>['finishReason'];
1593
+ readonly experimental_providerMetadata: StreamTextResult<TOOLS>['experimental_providerMetadata'];
1504
1594
  readonly text: StreamTextResult<TOOLS>['text'];
1505
1595
  readonly toolCalls: StreamTextResult<TOOLS>['toolCalls'];
1506
1596
  readonly toolResults: StreamTextResult<TOOLS>['toolResults'];
@@ -2709,4 +2799,4 @@ declare const generateId: (size?: number) => string;
2709
2799
  */
2710
2800
  declare const nanoid: (size?: number) => string;
2711
2801
 
2712
- 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, ModelType, 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_Provider, experimental_ProviderRegistry, experimental_StreamData, experimental_createModelRegistry, experimental_createProviderRegistry, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, generateId, generateObject, generateText, nanoid, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };
2802
+ 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, ModelType, NoObjectGeneratedError, NoSuchModelError, NoSuchProviderError, NoSuchToolError, ObjectStreamInputPart, ObjectStreamPart, OpenAIStream, OpenAIStreamCallbacks, ProviderMetadata, 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_Provider, experimental_ProviderRegistry, experimental_StreamData, experimental_createModelRegistry, experimental_createProviderRegistry, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, generateId, generateObject, generateText, nanoid, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };