ai 5.0.0-canary.2 → 5.0.0-canary.4

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/CHANGELOG.md CHANGED
@@ -1,5 +1,35 @@
1
1
  # ai
2
2
 
3
+ ## 5.0.0-canary.4
4
+
5
+ ### Major Changes
6
+
7
+ - e1cbf8a: chore(@ai-sdk/rsc): extract to separate package
8
+
9
+ ### Patch Changes
10
+
11
+ - 225f087: fix (ai/mcp): prevent mutation of customEnv
12
+ - a166433: feat: add transcription with experimental_transcribe
13
+ - 0a87932: core (ai): change transcription model mimeType to mediaType
14
+ - Updated dependencies [a166433]
15
+ - Updated dependencies [abf9a79]
16
+ - Updated dependencies [9f95b35]
17
+ - Updated dependencies [0a87932]
18
+ - Updated dependencies [6dc848c]
19
+ - @ai-sdk/provider-utils@3.0.0-canary.3
20
+ - @ai-sdk/provider@2.0.0-canary.2
21
+ - @ai-sdk/ui-utils@2.0.0-canary.3
22
+
23
+ ## 5.0.0-canary.3
24
+
25
+ ### Patch Changes
26
+
27
+ - Updated dependencies [c57e248]
28
+ - Updated dependencies [33f4a6a]
29
+ - @ai-sdk/provider@2.0.0-canary.1
30
+ - @ai-sdk/provider-utils@3.0.0-canary.2
31
+ - @ai-sdk/ui-utils@2.0.0-canary.2
32
+
3
33
  ## 5.0.0-canary.2
4
34
 
5
35
  ### Patch Changes
package/dist/index.d.mts CHANGED
@@ -2,7 +2,7 @@ import { IDGenerator } from '@ai-sdk/provider-utils';
2
2
  export { CoreToolCall, CoreToolResult, IDGenerator, ToolCall, ToolResult, createIdGenerator, generateId } from '@ai-sdk/provider-utils';
3
3
  import { DataStreamString, Message, Schema, DeepPartial, JSONValue as JSONValue$1 } from '@ai-sdk/ui-utils';
4
4
  export { Attachment, ChatRequest, ChatRequestOptions, CreateMessage, DataStreamPart, DeepPartial, IdGenerator, JSONValue, Message, RequestOptions, Schema, ToolInvocation, UIMessage, formatDataStreamPart, jsonSchema, parseDataStreamPart, processDataStream, processTextStream, zodSchema } from '@ai-sdk/ui-utils';
5
- import { LanguageModelV2, LanguageModelV2FinishReason, LanguageModelV2LogProbs, LanguageModelV2CallWarning, LanguageModelV2Source, JSONValue, EmbeddingModelV1, EmbeddingModelV1Embedding, ImageModelV1, ImageModelV1CallWarning, LanguageModelV2ProviderMetadata, LanguageModelV2CallOptions, AISDKError, LanguageModelV2FunctionToolCall, JSONSchema7, JSONParseError, TypeValidationError, LanguageModelV2Middleware, ProviderV2, NoSuchModelError } from '@ai-sdk/provider';
5
+ import { LanguageModelV2, LanguageModelV2FinishReason, LanguageModelV2LogProbs, LanguageModelV2CallWarning, LanguageModelV2Source, JSONValue, EmbeddingModelV1, EmbeddingModelV1Embedding, ImageModelV1, ImageModelV1CallWarning, LanguageModelV2ProviderMetadata, LanguageModelV2CallOptions, AISDKError, LanguageModelV2FunctionToolCall, JSONSchema7, JSONParseError, TypeValidationError, TranscriptionModelV1CallWarning, TranscriptionModelV1, LanguageModelV2ProviderOptions, LanguageModelV2Middleware, ProviderV2, NoSuchModelError } from '@ai-sdk/provider';
6
6
  export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LanguageModelV2, LanguageModelV2CallOptions, LanguageModelV2Prompt, LanguageModelV2StreamPart, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
7
7
  import { ServerResponse } from 'node:http';
8
8
  import { AttributeValue, Tracer } from '@opentelemetry/api';
@@ -496,6 +496,10 @@ type ToolResultContent = Array<{
496
496
  } | {
497
497
  type: 'image';
498
498
  data: string;
499
+ mediaType?: string;
500
+ /**
501
+ * @deprecated Use `mediaType` instead.
502
+ */
499
503
  mimeType?: string;
500
504
  }>;
501
505
 
@@ -532,7 +536,13 @@ interface ImagePart {
532
536
  */
533
537
  image: DataContent | URL;
534
538
  /**
535
- Optional mime type of the image.
539
+ Optional IANA media type of the image.
540
+
541
+ @see https://www.iana.org/assignments/media-types/media-types.xhtml
542
+ */
543
+ mediaType?: string;
544
+ /**
545
+ @deprecated Use `mediaType` instead.
536
546
  */
537
547
  mimeType?: string;
538
548
  /**
@@ -563,9 +573,15 @@ interface FilePart {
563
573
  */
564
574
  filename?: string;
565
575
  /**
566
- Mime type of the file.
576
+ IANA media type of the file.
577
+
578
+ @see https://www.iana.org/assignments/media-types/media-types.xhtml
567
579
  */
568
- mimeType: string;
580
+ mediaType: string;
581
+ /**
582
+ @deprecated Use `mediaType` instead.
583
+ */
584
+ mimeType?: string;
569
585
  /**
570
586
  Additional provider-specific metadata. They are passed through
571
587
  to the provider from the AI SDK and enable provider-specific
@@ -814,9 +830,11 @@ interface GeneratedFile {
814
830
  */
815
831
  readonly uint8Array: Uint8Array;
816
832
  /**
817
- MIME type of the file
833
+ The IANA media type of the file.
834
+
835
+ @see https://www.iana.org/assignments/media-types/media-types.xhtml
818
836
  */
819
- readonly mimeType: string;
837
+ readonly mediaType: string;
820
838
  }
821
839
 
822
840
  type ReasoningDetail = {
@@ -3792,12 +3810,138 @@ Callback that is called when the LLM response and the final object validation ar
3792
3810
  };
3793
3811
  }): StreamObjectResult<JSONValue, JSONValue, never>;
3794
3812
 
3813
+ /**
3814
+ Warning from the model provider for this call. The call will proceed, but e.g.
3815
+ some settings might not be supported, which can lead to suboptimal results.
3816
+ */
3817
+ type TranscriptionWarning = TranscriptionModelV1CallWarning;
3818
+
3819
+ type TranscriptionModelResponseMetadata = {
3820
+ /**
3821
+ Timestamp for the start of the generated response.
3822
+ */
3823
+ timestamp: Date;
3824
+ /**
3825
+ The ID of the response model that was used to generate the response.
3826
+ */
3827
+ modelId: string;
3828
+ /**
3829
+ Response headers.
3830
+ */
3831
+ headers?: Record<string, string>;
3832
+ };
3833
+
3834
+ /**
3835
+ The result of a `transcribe` call.
3836
+ It contains the transcript and additional information.
3837
+ */
3838
+ interface TranscriptionResult {
3839
+ /**
3840
+ * The complete transcribed text from the audio.
3841
+ */
3842
+ readonly text: string;
3843
+ /**
3844
+ * Array of transcript segments with timing information.
3845
+ * Each segment represents a portion of the transcribed text with start and end times.
3846
+ */
3847
+ readonly segments: Array<{
3848
+ /**
3849
+ * The text content of this segment.
3850
+ */
3851
+ readonly text: string;
3852
+ /**
3853
+ * The start time of this segment in seconds.
3854
+ */
3855
+ readonly startSecond: number;
3856
+ /**
3857
+ * The end time of this segment in seconds.
3858
+ */
3859
+ readonly endSecond: number;
3860
+ }>;
3861
+ /**
3862
+ * The detected language of the audio content, as an ISO-639-1 code (e.g., 'en' for English).
3863
+ * May be undefined if the language couldn't be detected.
3864
+ */
3865
+ readonly language: string | undefined;
3866
+ /**
3867
+ * The total duration of the audio file in seconds.
3868
+ * May be undefined if the duration couldn't be determined.
3869
+ */
3870
+ readonly durationInSeconds: number | undefined;
3871
+ /**
3872
+ Warnings for the call, e.g. unsupported settings.
3873
+ */
3874
+ readonly warnings: Array<TranscriptionWarning>;
3875
+ /**
3876
+ Response metadata from the provider. There may be multiple responses if we made multiple calls to the model.
3877
+ */
3878
+ readonly responses: Array<TranscriptionModelResponseMetadata>;
3879
+ /**
3880
+ Provider metadata from the provider.
3881
+ */
3882
+ readonly providerMetadata: Record<string, Record<string, JSONValue>>;
3883
+ }
3884
+
3885
+ /**
3886
+ Generates transcripts using a transcription model.
3887
+
3888
+ @param model - The transcription model to use.
3889
+ @param audio - The audio data to transcribe as DataContent (string | Uint8Array | ArrayBuffer | Buffer) or a URL.
3890
+ @param providerOptions - Additional provider-specific options that are passed through to the provider
3891
+ as body parameters.
3892
+ @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
3893
+ @param abortSignal - An optional abort signal that can be used to cancel the call.
3894
+ @param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
3895
+
3896
+ @returns A result object that contains the generated transcript.
3897
+ */
3898
+ declare function transcribe({ model, audio, providerOptions, maxRetries: maxRetriesArg, abortSignal, headers, }: {
3899
+ /**
3900
+ The transcription model to use.
3901
+ */
3902
+ model: TranscriptionModelV1;
3903
+ /**
3904
+ The audio data to transcribe.
3905
+ */
3906
+ audio: DataContent | URL;
3907
+ /**
3908
+ Additional provider-specific options that are passed through to the provider
3909
+ as body parameters.
3910
+
3911
+ The outer record is keyed by the provider name, and the inner
3912
+ record is keyed by the provider-specific metadata key.
3913
+ ```ts
3914
+ {
3915
+ "openai": {
3916
+ "temperature": 0
3917
+ }
3918
+ }
3919
+ ```
3920
+ */
3921
+ providerOptions?: ProviderOptions;
3922
+ /**
3923
+ Maximum number of retries per transcript model call. Set to 0 to disable retries.
3924
+
3925
+ @default 2
3926
+ */
3927
+ maxRetries?: number;
3928
+ /**
3929
+ Abort signal.
3930
+ */
3931
+ abortSignal?: AbortSignal;
3932
+ /**
3933
+ Additional headers to include in the request.
3934
+ Only applicable for HTTP-based providers.
3935
+ */
3936
+ headers?: Record<string, string>;
3937
+ }): Promise<TranscriptionResult>;
3938
+
3795
3939
  /**
3796
3940
  * Applies default settings for a language model.
3797
3941
  */
3798
3942
  declare function defaultSettingsMiddleware({ settings, }: {
3799
3943
  settings: Partial<LanguageModelV2CallOptions & {
3800
- providerMetadata?: LanguageModelV2ProviderMetadata;
3944
+ providerOptions?: LanguageModelV2ProviderOptions;
3801
3945
  }>;
3802
3946
  }): LanguageModelV2Middleware;
3803
3947
 
@@ -4254,7 +4398,7 @@ The following streams are supported:
4254
4398
  - `LangChainAIMessageChunk` streams (LangChain `model.stream` output)
4255
4399
  - `string` streams (LangChain `StringOutputParser` output)
4256
4400
  */
4257
- declare function toDataStream$1(stream: ReadableStream<LangChainStreamEvent> | ReadableStream<LangChainAIMessageChunk> | ReadableStream<string>, callbacks?: StreamCallbacks): ReadableStream<Uint8Array>;
4401
+ declare function toDataStream$1(stream: ReadableStream<LangChainStreamEvent> | ReadableStream<LangChainAIMessageChunk> | ReadableStream<string>, callbacks?: StreamCallbacks): ReadableStream<Uint8Array<ArrayBufferLike>>;
4258
4402
  declare function toDataStreamResponse$1(stream: ReadableStream<LangChainStreamEvent> | ReadableStream<LangChainAIMessageChunk> | ReadableStream<string>, options?: {
4259
4403
  init?: ResponseInit;
4260
4404
  data?: StreamData;
@@ -4276,7 +4420,7 @@ declare namespace langchainAdapter {
4276
4420
  type EngineResponse = {
4277
4421
  delta: string;
4278
4422
  };
4279
- declare function toDataStream(stream: AsyncIterable<EngineResponse>, callbacks?: StreamCallbacks): ReadableStream<Uint8Array>;
4423
+ declare function toDataStream(stream: AsyncIterable<EngineResponse>, callbacks?: StreamCallbacks): ReadableStream<Uint8Array<ArrayBufferLike>>;
4280
4424
  declare function toDataStreamResponse(stream: AsyncIterable<EngineResponse>, options?: {
4281
4425
  init?: ResponseInit;
4282
4426
  data?: StreamData;
@@ -4298,4 +4442,4 @@ declare namespace llamaindexAdapter {
4298
4442
  };
4299
4443
  }
4300
4444
 
4301
- export { AssistantContent, CallWarning, ChunkDetector, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamOptions, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, FilePart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedFile, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolArgumentsError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MCPClientError, MCPTransport, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, ProviderRegistryProvider, RepairTextFunction, RetryError, StepResult, StreamData, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextPart, TextStreamPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, ToolResultUnion, ToolSet, UserContent, appendClientMessage, appendResponseMessages, convertToCoreMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, createProviderRegistry, customProvider, defaultSettingsMiddleware, embed, embedMany, createMCPClient as experimental_createMCPClient, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, simulateStreamingMiddleware, smoothStream, streamObject, streamText, tool, wrapLanguageModel };
4445
+ export { AssistantContent, CallSettings, CallWarning, ChunkDetector, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamOptions, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, TranscriptionResult as Experimental_TranscriptionResult, FilePart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedFile, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolArgumentsError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MCPClientError, MCPTransport, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Prompt, Provider, ProviderMetadata, ProviderOptions, ProviderRegistryProvider, RepairTextFunction, RetryError, StepResult, StreamData, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextPart, TextStreamPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, ToolResultUnion, ToolSet, UserContent, appendClientMessage, appendResponseMessages, convertToCoreMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, createProviderRegistry, customProvider, defaultSettingsMiddleware, embed, embedMany, createMCPClient as experimental_createMCPClient, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, transcribe as experimental_transcribe, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, simulateStreamingMiddleware, smoothStream, streamObject, streamText, tool, wrapLanguageModel };
package/dist/index.d.ts CHANGED
@@ -2,7 +2,7 @@ import { IDGenerator } from '@ai-sdk/provider-utils';
2
2
  export { CoreToolCall, CoreToolResult, IDGenerator, ToolCall, ToolResult, createIdGenerator, generateId } from '@ai-sdk/provider-utils';
3
3
  import { DataStreamString, Message, Schema, DeepPartial, JSONValue as JSONValue$1 } from '@ai-sdk/ui-utils';
4
4
  export { Attachment, ChatRequest, ChatRequestOptions, CreateMessage, DataStreamPart, DeepPartial, IdGenerator, JSONValue, Message, RequestOptions, Schema, ToolInvocation, UIMessage, formatDataStreamPart, jsonSchema, parseDataStreamPart, processDataStream, processTextStream, zodSchema } from '@ai-sdk/ui-utils';
5
- import { LanguageModelV2, LanguageModelV2FinishReason, LanguageModelV2LogProbs, LanguageModelV2CallWarning, LanguageModelV2Source, JSONValue, EmbeddingModelV1, EmbeddingModelV1Embedding, ImageModelV1, ImageModelV1CallWarning, LanguageModelV2ProviderMetadata, LanguageModelV2CallOptions, AISDKError, LanguageModelV2FunctionToolCall, JSONSchema7, JSONParseError, TypeValidationError, LanguageModelV2Middleware, ProviderV2, NoSuchModelError } from '@ai-sdk/provider';
5
+ import { LanguageModelV2, LanguageModelV2FinishReason, LanguageModelV2LogProbs, LanguageModelV2CallWarning, LanguageModelV2Source, JSONValue, EmbeddingModelV1, EmbeddingModelV1Embedding, ImageModelV1, ImageModelV1CallWarning, LanguageModelV2ProviderMetadata, LanguageModelV2CallOptions, AISDKError, LanguageModelV2FunctionToolCall, JSONSchema7, JSONParseError, TypeValidationError, TranscriptionModelV1CallWarning, TranscriptionModelV1, LanguageModelV2ProviderOptions, LanguageModelV2Middleware, ProviderV2, NoSuchModelError } from '@ai-sdk/provider';
6
6
  export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LanguageModelV2, LanguageModelV2CallOptions, LanguageModelV2Prompt, LanguageModelV2StreamPart, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
7
7
  import { ServerResponse } from 'node:http';
8
8
  import { AttributeValue, Tracer } from '@opentelemetry/api';
@@ -496,6 +496,10 @@ type ToolResultContent = Array<{
496
496
  } | {
497
497
  type: 'image';
498
498
  data: string;
499
+ mediaType?: string;
500
+ /**
501
+ * @deprecated Use `mediaType` instead.
502
+ */
499
503
  mimeType?: string;
500
504
  }>;
501
505
 
@@ -532,7 +536,13 @@ interface ImagePart {
532
536
  */
533
537
  image: DataContent | URL;
534
538
  /**
535
- Optional mime type of the image.
539
+ Optional IANA media type of the image.
540
+
541
+ @see https://www.iana.org/assignments/media-types/media-types.xhtml
542
+ */
543
+ mediaType?: string;
544
+ /**
545
+ @deprecated Use `mediaType` instead.
536
546
  */
537
547
  mimeType?: string;
538
548
  /**
@@ -563,9 +573,15 @@ interface FilePart {
563
573
  */
564
574
  filename?: string;
565
575
  /**
566
- Mime type of the file.
576
+ IANA media type of the file.
577
+
578
+ @see https://www.iana.org/assignments/media-types/media-types.xhtml
567
579
  */
568
- mimeType: string;
580
+ mediaType: string;
581
+ /**
582
+ @deprecated Use `mediaType` instead.
583
+ */
584
+ mimeType?: string;
569
585
  /**
570
586
  Additional provider-specific metadata. They are passed through
571
587
  to the provider from the AI SDK and enable provider-specific
@@ -814,9 +830,11 @@ interface GeneratedFile {
814
830
  */
815
831
  readonly uint8Array: Uint8Array;
816
832
  /**
817
- MIME type of the file
833
+ The IANA media type of the file.
834
+
835
+ @see https://www.iana.org/assignments/media-types/media-types.xhtml
818
836
  */
819
- readonly mimeType: string;
837
+ readonly mediaType: string;
820
838
  }
821
839
 
822
840
  type ReasoningDetail = {
@@ -3792,12 +3810,138 @@ Callback that is called when the LLM response and the final object validation ar
3792
3810
  };
3793
3811
  }): StreamObjectResult<JSONValue, JSONValue, never>;
3794
3812
 
3813
+ /**
3814
+ Warning from the model provider for this call. The call will proceed, but e.g.
3815
+ some settings might not be supported, which can lead to suboptimal results.
3816
+ */
3817
+ type TranscriptionWarning = TranscriptionModelV1CallWarning;
3818
+
3819
+ type TranscriptionModelResponseMetadata = {
3820
+ /**
3821
+ Timestamp for the start of the generated response.
3822
+ */
3823
+ timestamp: Date;
3824
+ /**
3825
+ The ID of the response model that was used to generate the response.
3826
+ */
3827
+ modelId: string;
3828
+ /**
3829
+ Response headers.
3830
+ */
3831
+ headers?: Record<string, string>;
3832
+ };
3833
+
3834
+ /**
3835
+ The result of a `transcribe` call.
3836
+ It contains the transcript and additional information.
3837
+ */
3838
+ interface TranscriptionResult {
3839
+ /**
3840
+ * The complete transcribed text from the audio.
3841
+ */
3842
+ readonly text: string;
3843
+ /**
3844
+ * Array of transcript segments with timing information.
3845
+ * Each segment represents a portion of the transcribed text with start and end times.
3846
+ */
3847
+ readonly segments: Array<{
3848
+ /**
3849
+ * The text content of this segment.
3850
+ */
3851
+ readonly text: string;
3852
+ /**
3853
+ * The start time of this segment in seconds.
3854
+ */
3855
+ readonly startSecond: number;
3856
+ /**
3857
+ * The end time of this segment in seconds.
3858
+ */
3859
+ readonly endSecond: number;
3860
+ }>;
3861
+ /**
3862
+ * The detected language of the audio content, as an ISO-639-1 code (e.g., 'en' for English).
3863
+ * May be undefined if the language couldn't be detected.
3864
+ */
3865
+ readonly language: string | undefined;
3866
+ /**
3867
+ * The total duration of the audio file in seconds.
3868
+ * May be undefined if the duration couldn't be determined.
3869
+ */
3870
+ readonly durationInSeconds: number | undefined;
3871
+ /**
3872
+ Warnings for the call, e.g. unsupported settings.
3873
+ */
3874
+ readonly warnings: Array<TranscriptionWarning>;
3875
+ /**
3876
+ Response metadata from the provider. There may be multiple responses if we made multiple calls to the model.
3877
+ */
3878
+ readonly responses: Array<TranscriptionModelResponseMetadata>;
3879
+ /**
3880
+ Provider metadata from the provider.
3881
+ */
3882
+ readonly providerMetadata: Record<string, Record<string, JSONValue>>;
3883
+ }
3884
+
3885
+ /**
3886
+ Generates transcripts using a transcription model.
3887
+
3888
+ @param model - The transcription model to use.
3889
+ @param audio - The audio data to transcribe as DataContent (string | Uint8Array | ArrayBuffer | Buffer) or a URL.
3890
+ @param providerOptions - Additional provider-specific options that are passed through to the provider
3891
+ as body parameters.
3892
+ @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
3893
+ @param abortSignal - An optional abort signal that can be used to cancel the call.
3894
+ @param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
3895
+
3896
+ @returns A result object that contains the generated transcript.
3897
+ */
3898
+ declare function transcribe({ model, audio, providerOptions, maxRetries: maxRetriesArg, abortSignal, headers, }: {
3899
+ /**
3900
+ The transcription model to use.
3901
+ */
3902
+ model: TranscriptionModelV1;
3903
+ /**
3904
+ The audio data to transcribe.
3905
+ */
3906
+ audio: DataContent | URL;
3907
+ /**
3908
+ Additional provider-specific options that are passed through to the provider
3909
+ as body parameters.
3910
+
3911
+ The outer record is keyed by the provider name, and the inner
3912
+ record is keyed by the provider-specific metadata key.
3913
+ ```ts
3914
+ {
3915
+ "openai": {
3916
+ "temperature": 0
3917
+ }
3918
+ }
3919
+ ```
3920
+ */
3921
+ providerOptions?: ProviderOptions;
3922
+ /**
3923
+ Maximum number of retries per transcript model call. Set to 0 to disable retries.
3924
+
3925
+ @default 2
3926
+ */
3927
+ maxRetries?: number;
3928
+ /**
3929
+ Abort signal.
3930
+ */
3931
+ abortSignal?: AbortSignal;
3932
+ /**
3933
+ Additional headers to include in the request.
3934
+ Only applicable for HTTP-based providers.
3935
+ */
3936
+ headers?: Record<string, string>;
3937
+ }): Promise<TranscriptionResult>;
3938
+
3795
3939
  /**
3796
3940
  * Applies default settings for a language model.
3797
3941
  */
3798
3942
  declare function defaultSettingsMiddleware({ settings, }: {
3799
3943
  settings: Partial<LanguageModelV2CallOptions & {
3800
- providerMetadata?: LanguageModelV2ProviderMetadata;
3944
+ providerOptions?: LanguageModelV2ProviderOptions;
3801
3945
  }>;
3802
3946
  }): LanguageModelV2Middleware;
3803
3947
 
@@ -4254,7 +4398,7 @@ The following streams are supported:
4254
4398
  - `LangChainAIMessageChunk` streams (LangChain `model.stream` output)
4255
4399
  - `string` streams (LangChain `StringOutputParser` output)
4256
4400
  */
4257
- declare function toDataStream$1(stream: ReadableStream<LangChainStreamEvent> | ReadableStream<LangChainAIMessageChunk> | ReadableStream<string>, callbacks?: StreamCallbacks): ReadableStream<Uint8Array>;
4401
+ declare function toDataStream$1(stream: ReadableStream<LangChainStreamEvent> | ReadableStream<LangChainAIMessageChunk> | ReadableStream<string>, callbacks?: StreamCallbacks): ReadableStream<Uint8Array<ArrayBufferLike>>;
4258
4402
  declare function toDataStreamResponse$1(stream: ReadableStream<LangChainStreamEvent> | ReadableStream<LangChainAIMessageChunk> | ReadableStream<string>, options?: {
4259
4403
  init?: ResponseInit;
4260
4404
  data?: StreamData;
@@ -4276,7 +4420,7 @@ declare namespace langchainAdapter {
4276
4420
  type EngineResponse = {
4277
4421
  delta: string;
4278
4422
  };
4279
- declare function toDataStream(stream: AsyncIterable<EngineResponse>, callbacks?: StreamCallbacks): ReadableStream<Uint8Array>;
4423
+ declare function toDataStream(stream: AsyncIterable<EngineResponse>, callbacks?: StreamCallbacks): ReadableStream<Uint8Array<ArrayBufferLike>>;
4280
4424
  declare function toDataStreamResponse(stream: AsyncIterable<EngineResponse>, options?: {
4281
4425
  init?: ResponseInit;
4282
4426
  data?: StreamData;
@@ -4298,4 +4442,4 @@ declare namespace llamaindexAdapter {
4298
4442
  };
4299
4443
  }
4300
4444
 
4301
- export { AssistantContent, CallWarning, ChunkDetector, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamOptions, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, FilePart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedFile, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolArgumentsError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MCPClientError, MCPTransport, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, ProviderRegistryProvider, RepairTextFunction, RetryError, StepResult, StreamData, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextPart, TextStreamPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, ToolResultUnion, ToolSet, UserContent, appendClientMessage, appendResponseMessages, convertToCoreMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, createProviderRegistry, customProvider, defaultSettingsMiddleware, embed, embedMany, createMCPClient as experimental_createMCPClient, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, simulateStreamingMiddleware, smoothStream, streamObject, streamText, tool, wrapLanguageModel };
4445
+ export { AssistantContent, CallSettings, CallWarning, ChunkDetector, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamOptions, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, TranscriptionResult as Experimental_TranscriptionResult, FilePart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedFile, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolArgumentsError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MCPClientError, MCPTransport, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Prompt, Provider, ProviderMetadata, ProviderOptions, ProviderRegistryProvider, RepairTextFunction, RetryError, StepResult, StreamData, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextPart, TextStreamPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, ToolResultUnion, ToolSet, UserContent, appendClientMessage, appendResponseMessages, convertToCoreMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, createProviderRegistry, customProvider, defaultSettingsMiddleware, embed, embedMany, createMCPClient as experimental_createMCPClient, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, transcribe as experimental_transcribe, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, simulateStreamingMiddleware, smoothStream, streamObject, streamText, tool, wrapLanguageModel };