@ai-sdk/provider 3.0.5 → 3.0.6

package/src/language-model/v3/language-model-v3-tool-result.ts

@@ -2,7 +2,7 @@ import { JSONValue } from '../../json-value';
 import { SharedV3ProviderMetadata } from '../../shared/v3/shared-v3-provider-metadata';
 
 /**
-Result of a tool call that has been executed by the provider.
+ * Result of a tool call that has been executed by the provider.
  */
 export type LanguageModelV3ToolResult = {
   type: 'tool-result';

package/src/language-model/v3/language-model-v3-usage.ts

@@ -9,7 +9,7 @@ export type LanguageModelV3Usage = {
    */
   inputTokens: {
     /**
-     *The total number of input (prompt) tokens used.
+     * The total number of input (prompt) tokens used.
      */
     total: number | undefined;
 

package/src/provider/v2/provider-v2.ts

@@ -9,56 +9,56 @@ import { TranscriptionModelV2 } from '../../transcription-model/v2/transcription
  */
 export interface ProviderV2 {
   /**
-Returns the language model with the given id.
-The model id is then passed to the provider function to get the model.
-
-@param {string} modelId - The id of the model to return.
-
-@returns {LanguageModel} The language model associated with the id
-
-@throws {NoSuchModelError} If no such model exists.
+   * Returns the language model with the given id.
+   * The model id is then passed to the provider function to get the model.
+   *
+   * @param {string} modelId - The id of the model to return.
+   *
+   * @returns {LanguageModel} The language model associated with the id
+   *
+   * @throws {NoSuchModelError} If no such model exists.
    */
   languageModel(modelId: string): LanguageModelV2;
 
   /**
-Returns the text embedding model with the given id.
-The model id is then passed to the provider function to get the model.
-
-@param {string} modelId - The id of the model to return.
-
-@returns {LanguageModel} The language model associated with the id
-
-@throws {NoSuchModelError} If no such model exists.
+   * Returns the text embedding model with the given id.
+   * The model id is then passed to the provider function to get the model.
+   *
+   * @param {string} modelId - The id of the model to return.
+   *
+   * @returns {LanguageModel} The language model associated with the id
+   *
+   * @throws {NoSuchModelError} If no such model exists.
    */
   textEmbeddingModel(modelId: string): EmbeddingModelV2<string>;
 
   /**
-Returns the image model with the given id.
-The model id is then passed to the provider function to get the model.
-
-@param {string} modelId - The id of the model to return.
-
-@returns {ImageModel} The image model associated with the id
-*/
+   * Returns the image model with the given id.
+   * The model id is then passed to the provider function to get the model.
+   *
+   * @param {string} modelId - The id of the model to return.
+   *
+   * @returns {ImageModel} The image model associated with the id
+   */
   imageModel(modelId: string): ImageModelV2;
 
   /**
-Returns the transcription model with the given id.
-The model id is then passed to the provider function to get the model.
-
-@param {string} modelId - The id of the model to return.
-
-@returns {TranscriptionModel} The transcription model associated with the id
-  */
+   * Returns the transcription model with the given id.
+   * The model id is then passed to the provider function to get the model.
+   *
+   * @param {string} modelId - The id of the model to return.
+   *
+   * @returns {TranscriptionModel} The transcription model associated with the id
+   */
   transcriptionModel?(modelId: string): TranscriptionModelV2;
 
   /**
-Returns the speech model with the given id.
-The model id is then passed to the provider function to get the model.
-
-@param {string} modelId - The id of the model to return.
-
-@returns {SpeechModel} The speech model associated with the id
-  */
+   * Returns the speech model with the given id.
+   * The model id is then passed to the provider function to get the model.
+   *
+   * @param {string} modelId - The id of the model to return.
+   *
+   * @returns {SpeechModel} The speech model associated with the id
+   */
   speechModel?(modelId: string): SpeechModelV2;
 }

package/src/provider/v3/provider-v3.ts

@@ -12,82 +12,82 @@ export interface ProviderV3 {
   readonly specificationVersion: 'v3';
 
   /**
-Returns the language model with the given id.
-The model id is then passed to the provider function to get the model.
-
-@param {string} modelId - The id of the model to return.
-
-@returns {LanguageModel} The language model associated with the id
-
-@throws {NoSuchModelError} If no such model exists.
+   * Returns the language model with the given id.
+   * The model id is then passed to the provider function to get the model.
+   *
+   * @param {string} modelId - The id of the model to return.
+   *
+   * @returns {LanguageModel} The language model associated with the id
+   *
+   * @throws {NoSuchModelError} If no such model exists.
    */
   languageModel(modelId: string): LanguageModelV3;
 
   /**
-Returns the text embedding model with the given id.
-The model id is then passed to the provider function to get the model.
-
-@param {string} modelId - The id of the model to return.
-
-@returns {LanguageModel} The language model associated with the id
-
-@throws {NoSuchModelError} If no such model exists.
+   * Returns the text embedding model with the given id.
+   * The model id is then passed to the provider function to get the model.
+   *
+   * @param {string} modelId - The id of the model to return.
+   *
+   * @returns {LanguageModel} The language model associated with the id
+   *
+   * @throws {NoSuchModelError} If no such model exists.
    */
   embeddingModel(modelId: string): EmbeddingModelV3;
 
   /**
-Returns the text embedding model with the given id.
-The model id is then passed to the provider function to get the model.
-
-@param {string} modelId - The id of the model to return.
-
-@returns {EmbeddingModel} The embedding model associated with the id
-
-@throws {NoSuchModelError} If no such model exists.
-
-@deprecated Use `embeddingModel` instead.
+   * Returns the text embedding model with the given id.
+   * The model id is then passed to the provider function to get the model.
+   *
+   * @param {string} modelId - The id of the model to return.
+   *
+   * @returns {EmbeddingModel} The embedding model associated with the id
+   *
+   * @throws {NoSuchModelError} If no such model exists.
+   *
+   * @deprecated Use `embeddingModel` instead.
    */
   textEmbeddingModel?(modelId: string): EmbeddingModelV3;
 
   /**
-Returns the image model with the given id.
-The model id is then passed to the provider function to get the model.
-
-@param {string} modelId - The id of the model to return.
-
-@returns {ImageModel} The image model associated with the id
-*/
+   * Returns the image model with the given id.
+   * The model id is then passed to the provider function to get the model.
+   *
+   * @param {string} modelId - The id of the model to return.
+   *
+   * @returns {ImageModel} The image model associated with the id
+   */
   imageModel(modelId: string): ImageModelV3;
 
   /**
-Returns the transcription model with the given id.
-The model id is then passed to the provider function to get the model.
-
-@param {string} modelId - The id of the model to return.
-
-@returns {TranscriptionModel} The transcription model associated with the id
-  */
+   * Returns the transcription model with the given id.
+   * The model id is then passed to the provider function to get the model.
+   *
+   * @param {string} modelId - The id of the model to return.
+   *
+   * @returns {TranscriptionModel} The transcription model associated with the id
+   */
   transcriptionModel?(modelId: string): TranscriptionModelV3;
 
   /**
-Returns the speech model with the given id.
-The model id is then passed to the provider function to get the model.
-
-@param {string} modelId - The id of the model to return.
-
-@returns {SpeechModel} The speech model associated with the id
-  */
+   * Returns the speech model with the given id.
+   * The model id is then passed to the provider function to get the model.
+   *
+   * @param {string} modelId - The id of the model to return.
+   *
+   * @returns {SpeechModel} The speech model associated with the id
+   */
   speechModel?(modelId: string): SpeechModelV3;
 
   /**
-Returns the reranking model with the given id.
-The model id is then passed to the provider function to get the model.
-
-@param {string} modelId - The id of the model to return.
-
-@returns {RerankingModel} The reranking model associated with the id
-
-@throws {NoSuchModelError} If no such model exists.
+   * Returns the reranking model with the given id.
+   * The model id is then passed to the provider function to get the model.
+   *
+   * @param {string} modelId - The id of the model to return.
+   *
+   * @returns {RerankingModel} The reranking model associated with the id
+   *
+   * @throws {NoSuchModelError} If no such model exists.
    */
   rerankingModel?(modelId: string): RerankingModelV3;
 }

package/src/transcription-model/v2/transcription-model-v2-call-options.ts

@@ -7,42 +7,42 @@ type TranscriptionModelV2ProviderOptions = Record<
 
 export type TranscriptionModelV2CallOptions = {
   /**
-Audio data to transcribe.
-Accepts a `Uint8Array` or `string`, where `string` is a base64 encoded audio file.
-     */
+   * Audio data to transcribe.
+   * Accepts a `Uint8Array` or `string`, where `string` is a base64 encoded audio file.
+   */
   audio: Uint8Array | string;
 
   /**
-The IANA media type of the audio data.
-
-@see https://www.iana.org/assignments/media-types/media-types.xhtml
+   * The IANA media type of the audio data.
+   *
+   * @see https://www.iana.org/assignments/media-types/media-types.xhtml
    */
   mediaType: string;
 
   /**
-Additional provider-specific options that are passed through to the provider
-as body parameters.
-
-The outer record is keyed by the provider name, and the inner
-record is keyed by the provider-specific metadata key.
-```ts
-{
-"openai": {
-"timestampGranularities": ["word"]
-}
-}
-```
- */
+   * Additional provider-specific options that are passed through to the provider
+   * as body parameters.
+   *
+   * The outer record is keyed by the provider name, and the inner
+   * record is keyed by the provider-specific metadata key.
+   * ```ts
+   * {
+   * "openai": {
+   * "timestampGranularities": ["word"]
+   * }
+   * }
+   * ```
+   */
   providerOptions?: TranscriptionModelV2ProviderOptions;
 
   /**
-Abort signal for cancelling the operation.
- */
+   * Abort signal for cancelling the operation.
+   */
   abortSignal?: AbortSignal;
 
   /**
-Additional HTTP headers to be sent with the request.
-Only applicable for HTTP-based providers.
- */
+   * Additional HTTP headers to be sent with the request.
+   * Only applicable for HTTP-based providers.
+   */
   headers?: Record<string, string | undefined>;
 };

package/src/transcription-model/v2/transcription-model-v2-call-warning.ts

@@ -1,8 +1,8 @@
 import { TranscriptionModelV2CallOptions } from './transcription-model-v2-call-options';
 
 /**
-Warning from the model provider for this call. The call will proceed, but e.g.
-some settings might not be supported, which can lead to suboptimal results.
+ * Warning from the model provider for this call. The call will proceed, but e.g.
+ * some settings might not be supported, which can lead to suboptimal results.
  */
 export type TranscriptionModelV2CallWarning =
   | {

package/src/transcription-model/v2/transcription-model-v2.ts

@@ -4,30 +4,30 @@ import { TranscriptionModelV2CallOptions } from './transcription-model-v2-call-o
 import { TranscriptionModelV2CallWarning } from './transcription-model-v2-call-warning';
 
 /**
-Transcription model specification version 2.
+ * Transcription model specification version 2.
  */
 export type TranscriptionModelV2 = {
   /**
-The transcription model must specify which transcription model interface
-version it implements. This will allow us to evolve the transcription
-model interface and retain backwards compatibility. The different
-implementation versions can be handled as a discriminated union
-on our side.
+   * The transcription model must specify which transcription model interface
+   * version it implements. This will allow us to evolve the transcription
+   * model interface and retain backwards compatibility. The different
+   * implementation versions can be handled as a discriminated union
+   * on our side.
    */
   readonly specificationVersion: 'v2';
 
   /**
-Name of the provider for logging purposes.
+   * Name of the provider for logging purposes.
    */
   readonly provider: string;
 
   /**
-Provider-specific model ID for logging purposes.
+   * Provider-specific model ID for logging purposes.
    */
   readonly modelId: string;
 
   /**
-Generates a transcript.
+   * Generates a transcript.
    */
   doGenerate(options: TranscriptionModelV2CallOptions): PromiseLike<{
     /**
@@ -67,50 +67,50 @@ Generates a transcript.
     durationInSeconds: number | undefined;
 
     /**
-Warnings for the call, e.g. unsupported settings.
+     * Warnings for the call, e.g. unsupported settings.
      */
     warnings: Array<TranscriptionModelV2CallWarning>;
 
     /**
-Optional request information for telemetry and debugging purposes.
+     * Optional request information for telemetry and debugging purposes.
      */
     request?: {
       /**
-Raw request HTTP body that was sent to the provider API as a string (JSON should be stringified).
-Non-HTTP(s) providers should not set this.
+       * Raw request HTTP body that was sent to the provider API as a string (JSON should be stringified).
+       * Non-HTTP(s) providers should not set this.
        */
       body?: string;
     };
 
     /**
-Response information for telemetry and debugging purposes.
+     * Response information for telemetry and debugging purposes.
      */
     response: {
       /**
-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;
 
       /**
-Response headers.
-      */
+       * Response headers.
+       */
       headers?: SharedV2Headers;
 
       /**
-Response body.
-      */
+       * Response body.
+       */
       body?: unknown;
     };
 
     /**
-Additional provider-specific metadata. They are passed through
-from the provider to the AI SDK and enable provider-specific
-results that can be fully encapsulated in the provider.
+     * Additional provider-specific metadata. They are passed through
+     * from the provider to the AI SDK and enable provider-specific
+     * results that can be fully encapsulated in the provider.
      */
     providerMetadata?: Record<string, Record<string, JSONValue>>;
   }>;

package/src/transcription-model/v3/transcription-model-v3-call-options.ts

@@ -4,42 +4,42 @@ type TranscriptionModelV3ProviderOptions = Record<string, JSONObject>;
 
 export type TranscriptionModelV3CallOptions = {
   /**
-Audio data to transcribe.
-Accepts a `Uint8Array` or `string`, where `string` is a base64 encoded audio file.
-     */
+   * Audio data to transcribe.
+   * Accepts a `Uint8Array` or `string`, where `string` is a base64 encoded audio file.
+   */
   audio: Uint8Array | string;
 
   /**
-The IANA media type of the audio data.
-
-@see https://www.iana.org/assignments/media-types/media-types.xhtml
+   * The IANA media type of the audio data.
+   *
+   * @see https://www.iana.org/assignments/media-types/media-types.xhtml
    */
   mediaType: string;
 
   /**
-Additional provider-specific options that are passed through to the provider
-as body parameters.
-
-The outer record is keyed by the provider name, and the inner
-record is keyed by the provider-specific metadata key.
-```ts
-{
-"openai": {
-"timestampGranularities": ["word"]
-}
-}
-```
- */
+   * Additional provider-specific options that are passed through to the provider
+   * as body parameters.
+   *
+   * The outer record is keyed by the provider name, and the inner
+   * record is keyed by the provider-specific metadata key.
+   * ```ts
+   * {
+   * "openai": {
+   * "timestampGranularities": ["word"]
+   * }
+   * }
+   * ```
+   */
   providerOptions?: TranscriptionModelV3ProviderOptions;
 
   /**
-Abort signal for cancelling the operation.
- */
+   * Abort signal for cancelling the operation.
+   */
   abortSignal?: AbortSignal;
 
   /**
-Additional HTTP headers to be sent with the request.
-Only applicable for HTTP-based providers.
- */
+   * Additional HTTP headers to be sent with the request.
+   * Only applicable for HTTP-based providers.
+   */
   headers?: Record<string, string | undefined>;
 };

package/src/transcription-model/v3/transcription-model-v3.ts

@@ -4,30 +4,30 @@ import { SharedV3Warning } from '../../shared/v3/shared-v3-warning';
 import { TranscriptionModelV3CallOptions } from './transcription-model-v3-call-options';
 
 /**
-Transcription model specification version 3.
+ * Transcription model specification version 3.
  */
 export type TranscriptionModelV3 = {
   /**
-The transcription model must specify which transcription model interface
-version it implements. This will allow us to evolve the transcription
-model interface and retain backwards compatibility. The different
-implementation versions can be handled as a discriminated union
-on our side.
+   * The transcription model must specify which transcription model interface
+   * version it implements. This will allow us to evolve the transcription
+   * model interface and retain backwards compatibility. The different
+   * implementation versions can be handled as a discriminated union
+   * on our side.
    */
   readonly specificationVersion: 'v3';
 
   /**
-Name of the provider for logging purposes.
+   * Name of the provider for logging purposes.
    */
   readonly provider: string;
 
   /**
-Provider-specific model ID for logging purposes.
+   * Provider-specific model ID for logging purposes.
    */
   readonly modelId: string;
 
   /**
-Generates a transcript.
+   * Generates a transcript.
    */
   doGenerate(options: TranscriptionModelV3CallOptions): PromiseLike<{
     /**
@@ -67,50 +67,50 @@ Generates a transcript.
     durationInSeconds: number | undefined;
 
     /**
-Warnings for the call, e.g. unsupported settings.
+     * Warnings for the call, e.g. unsupported settings.
      */
     warnings: Array<SharedV3Warning>;
 
     /**
-Optional request information for telemetry and debugging purposes.
+     * Optional request information for telemetry and debugging purposes.
      */
     request?: {
       /**
-Raw request HTTP body that was sent to the provider API as a string (JSON should be stringified).
-Non-HTTP(s) providers should not set this.
+       * Raw request HTTP body that was sent to the provider API as a string (JSON should be stringified).
+       * Non-HTTP(s) providers should not set this.
        */
       body?: string;
     };
 
     /**
-Response information for telemetry and debugging purposes.
+     * Response information for telemetry and debugging purposes.
      */
     response: {
       /**
-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;
 
       /**
-Response headers.
-      */
+       * Response headers.
+       */
       headers?: SharedV3Headers;
 
       /**
-Response body.
-      */
+       * Response body.
+       */
       body?: unknown;
     };
 
     /**
-Additional provider-specific metadata. They are passed through
-from the provider to the AI SDK and enable provider-specific
-results that can be fully encapsulated in the provider.
+     * Additional provider-specific metadata. They are passed through
+     * from the provider to the AI SDK and enable provider-specific
+     * results that can be fully encapsulated in the provider.
      */
     providerMetadata?: Record<string, JSONObject>;
   }>;