@ai-sdk/provider 0.0.21 → 0.0.23

package/CHANGELOG.md

@@ -0,0 +1,144 @@
+# @ai-sdk/provider
+
+## 0.0.23
+
+### Patch Changes
+
+- 03313cd: feat (ai): expose response id, response model, response timestamp in telemetry and api
+- 3be7c1c: fix (provider/anthropic): support prompt caching on assistant messages
+
+## 0.0.22
+
+### Patch Changes
+
+- 26515cb: feat (ai/provider): introduce ProviderV1 specification
+
+## 0.0.21
+
+### Patch Changes
+
+- f2c025e: feat (ai/core): prompt validation
+
+## 0.0.20
+
+### Patch Changes
+
+- 6ac355e: feat (provider/anthropic): add cache control support
+
+## 0.0.19
+
+### Patch Changes
+
+- dd4a0f5: fix (ai/provider): remove invalid check in isJSONParseError
+
+## 0.0.18
+
+### Patch Changes
+
+- 4bd27a9: chore (ai/provider): refactor type validation
+
+## 0.0.17
+
+### Patch Changes
+
+- 029af4c: feat (ai/core): support schema name & description in generateObject & streamObject
+
+## 0.0.16
+
+### Patch Changes
+
+- d58517b: feat (ai/openai): structured outputs
+
+## 0.0.15
+
+### Patch Changes
+
+- 96aed25: fix (ai/provider): release new version
+
+## 0.0.14
+
+### Patch Changes
+
+- a8d1c9e9: feat (ai/core): parallel image download
+
+## 0.0.13
+
+### Patch Changes
+
+- 2b9da0f0: feat (core): support stopSequences setting.
+- a5b58845: feat (core): support topK setting
+- 4aa8deb3: feat (provider): support responseFormat setting in provider api
+- 13b27ec6: chore (ai/core): remove grammar mode
+
+## 0.0.12
+
+### Patch Changes
+
+- b7290943: feat (ai/core): add token usage to embed and embedMany
+
+## 0.0.11
+
+### Patch Changes
+
+- 5edc6110: feat (provider): add headers support to language and embedding model spec
+
+## 0.0.10
+
+### Patch Changes
+
+- 102ca22f: fix (@ai-sdk/provider): fix TypeValidationError.isTypeValidationError
+
+## 0.0.9
+
+### Patch Changes
+
+- 09295e2e: feat (@ai-sdk/provider): add DownloadError
+
+## 0.0.8
+
+### Patch Changes
+
+- f39c0dd2: feat (provider): add toolChoice to language model specification
+
+## 0.0.7
+
+### Patch Changes
+
+- 8e780288: feat (ai/provider): add "unknown" finish reason (for models that don't provide a finish reason)
+
+## 0.0.6
+
+### Patch Changes
+
+- 6a50ac4: feat (provider): add additional error types
+
+## 0.0.5
+
+### Patch Changes
+
+- 0f6bc4e: feat (ai/core): add embed function
+
+## 0.0.4
+
+### Patch Changes
+
+- 325ca55: feat (ai/core): improve image content part error message
+
+## 0.0.3
+
+### Patch Changes
+
+- 41d5736: ai/core: re-expose language model types.
+
+## 0.0.2
+
+### Patch Changes
+
+- d6431ae: ai/core: add logprobs support (thanks @SamStenner for the contribution)
+- 25f3350: ai/core: add support for getting raw response headers.
+
+## 0.0.1
+
+### Patch Changes
+
+- eb150a6: ai/core: remove scaling of setting values (breaking change). If you were using the temperature, frequency penalty, or presence penalty settings, you need to update the providers and adjust the setting values.

package/dist/index.d.mts

@@ -82,13 +82,13 @@ type EmbeddingModelV1<VALUE> = {
     }>;
 };
 
-declare const symbol$b: unique symbol;
+declare const symbol$c: unique symbol;
 /**
  * Custom error class for AI SDK related errors.
  * @extends Error
  */
 declare class AISDKError extends Error {
-    private readonly [symbol$b];
+    private readonly [symbol$c];
     /**
      * The underlying cause of the error, if any.
      */
@@ -125,9 +125,9 @@ declare class AISDKError extends Error {
     };
 }
 
-declare const symbol$a: unique symbol;
+declare const symbol$b: unique symbol;
 declare class APICallError extends AISDKError {
-    private readonly [symbol$a];
+    private readonly [symbol$b];
     readonly url: string;
     readonly requestBodyValues: unknown;
     readonly statusCode?: number;
@@ -169,9 +169,9 @@ declare class APICallError extends AISDKError {
     };
 }
 
-declare const symbol$9: unique symbol;
+declare const symbol$a: unique symbol;
 declare class EmptyResponseBodyError extends AISDKError {
-    private readonly [symbol$9];
+    private readonly [symbol$a];
     constructor({ message }?: {
         message?: string;
     });
@@ -184,13 +184,13 @@ declare class EmptyResponseBodyError extends AISDKError {
 
 declare function getErrorMessage(error: unknown | undefined): string;
 
-declare const symbol$8: unique symbol;
+declare const symbol$9: unique symbol;
 /**
  * A prompt is invalid. This error should be thrown by providers when they cannot
  * process a prompt.
  */
 declare class InvalidPromptError extends AISDKError {
-    private readonly [symbol$8];
+    private readonly [symbol$9];
     readonly prompt: unknown;
     constructor({ prompt, message, cause, }: {
         prompt: unknown;
@@ -213,13 +213,13 @@ declare class InvalidPromptError extends AISDKError {
     };
 }
 
-declare const symbol$7: unique symbol;
+declare const symbol$8: unique symbol;
 /**
  * Server returned a response with invalid data content.
  * This should be thrown by providers when they cannot parse the response from the API.
  */
 declare class InvalidResponseDataError extends AISDKError {
-    private readonly [symbol$7];
+    private readonly [symbol$8];
     readonly data: unknown;
     constructor({ data, message, }: {
         data: unknown;
@@ -241,9 +241,9 @@ declare class InvalidResponseDataError extends AISDKError {
     };
 }
 
-declare const symbol$6: unique symbol;
+declare const symbol$7: unique symbol;
 declare class JSONParseError extends AISDKError {
-    private readonly [symbol$6];
+    private readonly [symbol$7];
     readonly text: string;
     constructor({ text, cause }: {
         text: string;
@@ -266,9 +266,9 @@ declare class JSONParseError extends AISDKError {
     };
 }
 
-declare const symbol$5: unique symbol;
+declare const symbol$6: unique symbol;
 declare class LoadAPIKeyError extends AISDKError {
-    private readonly [symbol$5];
+    private readonly [symbol$6];
     constructor({ message }: {
         message: string;
     });
@@ -279,9 +279,9 @@ declare class LoadAPIKeyError extends AISDKError {
     static isLoadAPIKeyError(error: unknown): error is LoadAPIKeyError;
 }
 
-declare const symbol$4: unique symbol;
+declare const symbol$5: unique symbol;
 declare class LoadSettingError extends AISDKError {
-    private readonly [symbol$4];
+    private readonly [symbol$5];
     constructor({ message }: {
         message: string;
     });
@@ -292,12 +292,12 @@ declare class LoadSettingError extends AISDKError {
     static isLoadSettingError(error: unknown): error is LoadSettingError;
 }
 
-declare const symbol$3: unique symbol;
+declare const symbol$4: unique symbol;
 /**
 Thrown when the AI provider fails to generate any content.
  */
 declare class NoContentGeneratedError extends AISDKError {
-    private readonly [symbol$3];
+    private readonly [symbol$4];
     constructor({ message, }?: {
         message?: string;
     });
@@ -317,6 +317,34 @@ declare class NoContentGeneratedError extends AISDKError {
     };
 }
 
+declare const symbol$3: unique symbol;
+declare class NoSuchModelError extends AISDKError {
+    private readonly [symbol$3];
+    readonly modelId: string;
+    readonly modelType: 'languageModel' | 'textEmbeddingModel';
+    constructor({ errorName, modelId, modelType, message, }: {
+        errorName?: string;
+        modelId: string;
+        modelType: 'languageModel' | 'textEmbeddingModel';
+        message?: string;
+    });
+    static isInstance(error: unknown): error is NoSuchModelError;
+    /**
+     * @deprecated use `isInstance` instead
+     */
+    static isNoSuchModelError(error: unknown): error is NoSuchModelError;
+    /**
+     * @deprecated Do not use this method. It will be removed in the next major version.
+     */
+    toJSON(): {
+        name: string;
+        message: string;
+        stack: string | undefined;
+        modelId: string;
+        modelType: "languageModel" | "textEmbeddingModel";
+    };
+}
+
 declare const symbol$2: unique symbol;
 declare class TooManyEmbeddingValuesForCallError extends AISDKError {
     private readonly [symbol$2];
@@ -631,6 +659,12 @@ interface LanguageModelV1ToolCallPart {
   Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
      */
     args: unknown;
+    /**
+     * Additional provider-specific metadata. They are passed through
+     * to the provider from the AI SDK and enable provider-specific
+     * functionality that can be fully encapsulated in the provider.
+     */
+    providerMetadata?: LanguageModelV1ProviderMetadata;
 }
 /**
 Tool result content part of a prompt. It contains the result of the tool call with the matching ID.
@@ -729,6 +763,12 @@ Specifies how the tool should be selected. Defaults to 'auto'.
   the language model interface.
      */
     prompt: LanguageModelV1Prompt;
+    /**
+     * Additional provider-specific metadata. They are passed through
+     * to the provider from the AI SDK and enable provider-specific
+     * functionality that can be fully encapsulated in the provider.
+     */
+    providerMetadata?: LanguageModelV1ProviderMetadata;
 };
 
 /**
@@ -832,8 +872,6 @@ type LanguageModelV1 = {
   use further optimizations if this flag is set to `true`.
   
   Defaults to `false`.
-  
-  TODO rename to supportsGrammarGuidedGeneration in v2
   */
     readonly supportsStructuredOutputs?: boolean;
     /**
@@ -880,7 +918,7 @@ type LanguageModelV1 = {
             rawSettings: Record<string, unknown>;
         };
         /**
-    Optional raw response information for debugging purposes.
+    Optional response information for telemetry and debugging purposes.
          */
         rawResponse?: {
             /**
@@ -888,6 +926,20 @@ type LanguageModelV1 = {
             */
             headers?: Record<string, string>;
         };
+        response?: {
+            /**
+      ID for the generated response, if the provider sends one.
+           */
+            id?: string;
+            /**
+      Timestamp for the start of the generated response, if the provider sends one.
+           */
+            timestamp?: Date;
+            /**
+      The ID of the response model that was used to generate the response, if the provider sends one.
+           */
+            modelId?: string;
+        };
         warnings?: LanguageModelV1CallWarning[];
         /**
     Additional provider-specific metadata. They are passed through
@@ -896,8 +948,10 @@ type LanguageModelV1 = {
          */
         providerMetadata?: LanguageModelV1ProviderMetadata;
         /**
-      Logprobs for the completion.
-      `undefined` if the mode does not support logprobs or if was not enabled
+    Logprobs for the completion.
+    `undefined` if the mode does not support logprobs or if was not enabled
+    
+    @deprecated will be changed into a provider-specific extension in v2
          */
         logprobs?: LanguageModelV1LogProbs;
     }>;
@@ -949,19 +1003,51 @@ type LanguageModelV1StreamPart = {
     toolCallId: string;
     toolName: string;
     argsTextDelta: string;
+} | {
+    type: 'response-metadata';
+    id?: string;
+    timestamp?: Date;
+    modelId?: string;
 } | {
     type: 'finish';
     finishReason: LanguageModelV1FinishReason;
-    logprobs?: LanguageModelV1LogProbs;
     providerMetadata?: LanguageModelV1ProviderMetadata;
     usage: {
         promptTokens: number;
         completionTokens: number;
     };
+    logprobs?: LanguageModelV1LogProbs;
 } | {
     type: 'error';
     error: unknown;
 };
-type LanguageModelV1ResponseMetadata = {};
 
-export { AISDKError, APICallError, type EmbeddingModelV1, type EmbeddingModelV1Embedding, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, type JSONArray, type JSONObject, JSONParseError, type JSONValue, type LanguageModelV1, type LanguageModelV1CallOptions, type LanguageModelV1CallWarning, type LanguageModelV1FinishReason, type LanguageModelV1FunctionTool, type LanguageModelV1FunctionToolCall, type LanguageModelV1ImagePart, type LanguageModelV1LogProbs, type LanguageModelV1Message, type LanguageModelV1Prompt, type LanguageModelV1ProviderMetadata, type LanguageModelV1ResponseMetadata, type LanguageModelV1StreamPart, type LanguageModelV1TextPart, type LanguageModelV1ToolCallPart, type LanguageModelV1ToolChoice, type LanguageModelV1ToolResultPart, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, TooManyEmbeddingValuesForCallError, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage, isJSONArray, isJSONObject, isJSONValue };
+/**
+ * Provider for language and text embedding models.
+ */
+interface ProviderV1 {
+    /**
+  Returns the language model with the given id.
+  The model id is then passed to the provider function to get the model.
+  
+  @param {string} id - 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): LanguageModelV1;
+    /**
+  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} id - 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): EmbeddingModelV1<string>;
+}
+
+export { AISDKError, APICallError, type EmbeddingModelV1, type EmbeddingModelV1Embedding, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, type JSONArray, type JSONObject, JSONParseError, type JSONValue, type LanguageModelV1, type LanguageModelV1CallOptions, type LanguageModelV1CallWarning, type LanguageModelV1FinishReason, type LanguageModelV1FunctionTool, type LanguageModelV1FunctionToolCall, type LanguageModelV1ImagePart, type LanguageModelV1LogProbs, type LanguageModelV1Message, type LanguageModelV1Prompt, type LanguageModelV1ProviderMetadata, type LanguageModelV1StreamPart, type LanguageModelV1TextPart, type LanguageModelV1ToolCallPart, type LanguageModelV1ToolChoice, type LanguageModelV1ToolResultPart, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, type ProviderV1, TooManyEmbeddingValuesForCallError, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage, isJSONArray, isJSONObject, isJSONValue };