@ai-sdk/provider 0.0.4 → 0.0.6

package/dist/index.d.ts

@@ -1,5 +1,76 @@
 import { JSONSchema7 } from 'json-schema';
 
+/**
+An embedding is a vector, i.e. an array of numbers.
+It is e.g. used to represent a text as a vector of word embeddings.
+ */
+type EmbeddingModelV1Embedding = Array<number>;
+
+/**
+Experimental: Specification for an embedding model that implements the embedding model
+interface version 1.
+
+VALUE is the type of the values that the model can embed.
+This will allow us to go beyond text embeddings in the future,
+e.g. to support image embeddings
+ */
+type EmbeddingModelV1<VALUE> = {
+    /**
+  The embedding model must specify which embedding model interface
+  version it implements. This will allow us to evolve the embedding
+  model interface and retain backwards compatibility. The different
+  implementation versions can be handled as a discriminated union
+  on our side.
+     */
+    readonly specificationVersion: 'v1';
+    /**
+  Name of the provider for logging purposes.
+     */
+    readonly provider: string;
+    /**
+  Provider-specific model ID for logging purposes.
+     */
+    readonly modelId: string;
+    /**
+  Limit of how many embeddings can be generated in a single API call.
+     */
+    readonly maxEmbeddingsPerCall: number | undefined;
+    /**
+  True if the model can handle multiple embedding calls in parallel.
+     */
+    readonly supportsParallelCalls: boolean;
+    /**
+  Generates a list of embeddings for the given input text.
+  
+  Naming: "do" prefix to prevent accidental direct usage of the method
+  by the user.
+     */
+    doEmbed(options: {
+        /**
+    List of values to embed.
+         */
+        values: Array<VALUE>;
+        /**
+    Abort signal for cancelling the operation.
+         */
+        abortSignal?: AbortSignal;
+    }): PromiseLike<{
+        /**
+    Generated embeddings. They are in the same order as the input values.
+         */
+        embeddings: Array<EmbeddingModelV1Embedding>;
+        /**
+    Optional raw response information for debugging purposes.
+         */
+        rawResponse?: {
+            /**
+      Response headers.
+             */
+            headers?: Record<string, string>;
+        };
+    }>;
+};
+
 declare class APICallError extends Error {
     readonly url: string;
     readonly requestBodyValues: unknown;
@@ -167,10 +238,43 @@ declare class LoadAPIKeyError extends Error {
     };
 }
 
+declare class LoadSettingError extends Error {
+    constructor({ message }: {
+        message: string;
+    });
+    static isLoadSettingError(error: unknown): error is LoadSettingError;
+    toJSON(): {
+        name: string;
+        message: string;
+    };
+}
+
+/**
+Thrown when the AI provider fails to generate any content.
+ */
+declare class NoContentGeneratedError extends Error {
+    readonly cause: unknown;
+    constructor({ message, }?: {
+        message?: string;
+    });
+    static isNoContentGeneratedError(error: unknown): error is NoContentGeneratedError;
+    toJSON(): {
+        name: string;
+        cause: unknown;
+        message: string;
+        stack: string | undefined;
+    };
+}
+
+/**
+Thrown when the AI provider fails to generate a parsable object.
+ */
 declare class NoObjectGeneratedError extends Error {
     readonly cause: unknown;
-    constructor();
-    static isNoTextGeneratedError(error: unknown): error is NoObjectGeneratedError;
+    constructor({ message }?: {
+        message?: string;
+    });
+    static isNoObjectGeneratedError(error: unknown): error is NoObjectGeneratedError;
     toJSON(): {
         name: string;
         cause: unknown;
@@ -217,6 +321,29 @@ declare class RetryError extends Error {
     };
 }
 
+declare class TooManyEmbeddingValuesForCallError extends Error {
+    readonly provider: string;
+    readonly modelId: string;
+    readonly maxEmbeddingsPerCall: number;
+    readonly values: Array<unknown>;
+    constructor(options: {
+        provider: string;
+        modelId: string;
+        maxEmbeddingsPerCall: number;
+        values: Array<unknown>;
+    });
+    static isInvalidPromptError(error: unknown): error is TooManyEmbeddingValuesForCallError;
+    toJSON(): {
+        name: string;
+        message: string;
+        stack: string | undefined;
+        provider: string;
+        modelId: string;
+        maxEmbeddingsPerCall: number;
+        values: unknown[];
+    };
+}
+
 /**
 A tool has a name, a description, and a set of parameters.
 
@@ -233,7 +360,15 @@ type LanguageModelV1FunctionTool = {
   The name of the tool. Unique within this model call.
      */
     name: string;
+    /**
+  A description of the tool. The language model uses this to understand the
+  tool's purpose and to provide better completion suggestions.
+     */
     description?: string;
+    /**
+  The parameters that the tool expects. The language model uses this to
+  understand the tool's input requirements and to provide matching suggestions.
+     */
     parameters: JSONSchema7;
 };
 
@@ -309,38 +444,38 @@ declare class UnsupportedJSONSchemaError extends Error {
 
 type LanguageModelV1CallSettings = {
     /**
-     * Maximum number of tokens to generate.
+  Maximum number of tokens to generate.
      */
     maxTokens?: number;
     /**
-     * Temperature setting.
-     *
-     * It is recommended to set either `temperature` or `topP`, but not both.
+  Temperature setting.
+  
+  It is recommended to set either `temperature` or `topP`, but not both.
      */
     temperature?: number;
     /**
-     * Nucleus sampling.
-     *
-     * It is recommended to set either `temperature` or `topP`, but not both.
+  Nucleus sampling.
+  
+  It is recommended to set either `temperature` or `topP`, but not both.
      */
     topP?: number;
     /**
-     * Presence penalty setting. It affects the likelihood of the model to
-     * repeat information that is already in the prompt.
+  Presence penalty setting. It affects the likelihood of the model to
+  repeat information that is already in the prompt.
      */
     presencePenalty?: number;
     /**
-     * Frequency penalty setting. It affects the likelihood of the model
-     * to repeatedly use the same words or phrases.
+  Frequency penalty setting. It affects the likelihood of the model
+  to repeatedly use the same words or phrases.
      */
     frequencyPenalty?: number;
     /**
-     * The seed (integer) to use for random sampling. If set and supported
-     * by the model, calls will generate deterministic results.
+  The seed (integer) to use for random sampling. If set and supported
+  by the model, calls will generate deterministic results.
      */
     seed?: number;
     /**
-     * Abort signal for cancelling the operation.
+  Abort signal for cancelling the operation.
      */
     abortSignal?: AbortSignal;
 };
@@ -435,19 +570,19 @@ interface LanguageModelV1ToolResultPart {
 
 type LanguageModelV1CallOptions = LanguageModelV1CallSettings & {
     /**
-     * Whether the user provided the input as messages or as
-     * a prompt. This can help guide non-chat models in the
-     * expansion, bc different expansions can be needed for
-     * chat/non-chat use cases.
+  Whether the user provided the input as messages or as
+  a prompt. This can help guide non-chat models in the
+  expansion, bc different expansions can be needed for
+  chat/non-chat use cases.
      */
     inputFormat: 'messages' | 'prompt';
     /**
-     * The mode affects the behavior of the language model. It is required to
-     * support provider-independent streaming and generation of structured objects.
-     * The model can take this information and e.g. configure json mode, the correct
-     * low level grammar, etc. It can also be used to optimize the efficiency of the
-     * streaming, e.g. tool-delta stream parts are only needed in the
-     * object-tool mode.
+  The mode affects the behavior of the language model. It is required to
+  support provider-independent streaming and generation of structured objects.
+  The model can take this information and e.g. configure json mode, the correct
+  low level grammar, etc. It can also be used to optimize the efficiency of the
+  streaming, e.g. tool-delta stream parts are only needed in the
+  object-tool mode.
      */
     mode: {
         type: 'regular';
@@ -462,19 +597,19 @@ type LanguageModelV1CallOptions = LanguageModelV1CallSettings & {
         tool: LanguageModelV1FunctionTool;
     };
     /**
-     * A language mode prompt is a standardized prompt type.
-     *
-     * Note: This is **not** the user-facing prompt. The AI SDK methods will map the
-     * user-facing prompt types such as chat or instruction prompts to this format.
-     * That approach allows us to evolve the user  facing prompts without breaking
-     * the language model interface.
+  A language mode prompt is a standardized prompt type.
+  
+  Note: This is **not** the user-facing prompt. The AI SDK methods will map the
+  user-facing prompt types such as chat or instruction prompts to this format.
+  That approach allows us to evolve the user  facing prompts without breaking
+  the language model interface.
      */
     prompt: LanguageModelV1Prompt;
 };
 
 /**
- * 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.
  */
 type LanguageModelV1CallWarning = {
     type: 'unsupported-setting';
@@ -502,8 +637,8 @@ type LanguageModelV1FunctionToolCall = {
     toolCallId: string;
     toolName: string;
     /**
-     * Stringified JSON object with the tool call arguments. Must match the
-     * parameters schema of the tool.
+  Stringified JSON object with the tool call arguments. Must match the
+  parameters schema of the tool.
      */
     args: string;
 };
@@ -521,125 +656,124 @@ type LanguageModelV1LogProbs = Array<{
 }>;
 
 /**
- * Experimental: Specification for a language model that implements the language model
- * interface version 1.
+Specification for a language model that implements the language model interface version 1.
  */
 type LanguageModelV1 = {
     /**
-     * The language model must specify which language model interface
-     * version it implements. This will allow us to evolve the language
-     * model interface and retain backwards compatibility. The different
-     * implementation versions can be handled as a discriminated union
-     * on our side.
+  The language model must specify which language model interface
+  version it implements. This will allow us to evolve the language
+  model interface and retain backwards compatibility. The different
+  implementation versions can be handled as a discriminated union
+  on our side.
      */
     readonly specificationVersion: 'v1';
     /**
-     * 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;
     /**
-     * Default object generation mode that should be used with this model when
-     * no mode is specified. Should be the mode with the best results for this
-     * model. `undefined` can be returned if object generation is not supported.
-     *
-     * This is needed to generate the best objects possible w/o requiring the
-     * user to explicitly specify the object generation mode.
+  Default object generation mode that should be used with this model when
+  no mode is specified. Should be the mode with the best results for this
+  model. `undefined` can be returned if object generation is not supported.
+  
+  This is needed to generate the best objects possible w/o requiring the
+  user to explicitly specify the object generation mode.
      */
     readonly defaultObjectGenerationMode: 'json' | 'tool' | 'grammar' | undefined;
     /**
-     * Generates a language model output (non-streaming).
-     *
-     * Naming: "do" prefix to prevent accidental direct usage of the method
-     * by the user.
+  Generates a language model output (non-streaming).
+  
+  Naming: "do" prefix to prevent accidental direct usage of the method
+  by the user.
      */
     doGenerate(options: LanguageModelV1CallOptions): PromiseLike<{
         /**
-         * Text that the model has generated. Can be undefined if the model
-         * has only generated tool calls.
+    Text that the model has generated. Can be undefined if the model
+    has only generated tool calls.
          */
         text?: string;
         /**
-         * Tool calls that the model has generated. Can be undefined if the
-         * model has only generated text.
+    Tool calls that the model has generated. Can be undefined if the
+    model has only generated text.
          */
         toolCalls?: Array<LanguageModelV1FunctionToolCall>;
         /**
-         * Finish reason.
+    Finish reason.
          */
         finishReason: LanguageModelV1FinishReason;
         /**
-         * Usage information.
+      Usage information.
          */
         usage: {
             promptTokens: number;
             completionTokens: number;
         };
         /**
-         * Raw prompt and setting information for observability provider integration.
+    Raw prompt and setting information for observability provider integration.
          */
         rawCall: {
             /**
-             * Raw prompt after expansion and conversion to the format that the
-             * provider uses to send the information to their API.
+      Raw prompt after expansion and conversion to the format that the
+      provider uses to send the information to their API.
              */
             rawPrompt: unknown;
             /**
-             * Raw settings that are used for the API call. Includes provider-specific
-             * settings.
+      Raw settings that are used for the API call. Includes provider-specific
+      settings.
              */
             rawSettings: Record<string, unknown>;
         };
         /**
-         * Optional raw response information for debugging purposes.
+    Optional raw response information for debugging purposes.
          */
         rawResponse?: {
             /**
-             * Response headers.
-             */
+      Response headers.
+            */
             headers?: Record<string, string>;
         };
         warnings?: LanguageModelV1CallWarning[];
         /**
-         * 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
          */
         logprobs?: LanguageModelV1LogProbs;
     }>;
     /**
-     * Generates a language model output (streaming).
-     *
-     * Naming: "do" prefix to prevent accidental direct usage of the method
-     * by the user.
+  Generates a language model output (streaming).
+  
+  Naming: "do" prefix to prevent accidental direct usage of the method
+  by the user.
      *
-     * @return A stream of higher-level language model output parts.
+  @return A stream of higher-level language model output parts.
      */
     doStream(options: LanguageModelV1CallOptions): PromiseLike<{
         stream: ReadableStream<LanguageModelV1StreamPart>;
         /**
-         * Raw prompt and setting information for observability provider integration.
+    Raw prompt and setting information for observability provider integration.
          */
         rawCall: {
             /**
-             * Raw prompt after expansion and conversion to the format that the
-             * provider uses to send the information to their API.
+      Raw prompt after expansion and conversion to the format that the
+      provider uses to send the information to their API.
              */
             rawPrompt: unknown;
             /**
-             * Raw settings that are used for the API call. Includes provider-specific
-             * settings.
+      Raw settings that are used for the API call. Includes provider-specific
+      settings.
              */
             rawSettings: Record<string, unknown>;
         };
         /**
-         * Optional raw response data.
+    Optional raw response data.
          */
         rawResponse?: {
             /**
-             * Response headers.
+      Response headers.
              */
             headers?: Record<string, string>;
         };
@@ -671,4 +805,4 @@ type LanguageModelV1StreamPart = {
 };
 type LanguageModelV1ResponseMetadata = {};
 
-export { APICallError, EmptyResponseBodyError, InvalidArgumentError, InvalidDataContentError, InvalidPromptError, InvalidResponseDataError, InvalidToolArgumentsError, JSONParseError, type LanguageModelV1, type LanguageModelV1CallOptions, type LanguageModelV1CallWarning, type LanguageModelV1FinishReason, type LanguageModelV1FunctionTool, type LanguageModelV1FunctionToolCall, type LanguageModelV1ImagePart, type LanguageModelV1LogProbs, type LanguageModelV1Message, type LanguageModelV1Prompt, type LanguageModelV1ResponseMetadata, type LanguageModelV1StreamPart, type LanguageModelV1TextPart, type LanguageModelV1ToolCallPart, type LanguageModelV1ToolResultPart, LoadAPIKeyError, NoObjectGeneratedError, NoSuchToolError, RetryError, type RetryErrorReason, ToolCallParseError, TypeValidationError, UnsupportedFunctionalityError, UnsupportedJSONSchemaError };
+export { APICallError, type EmbeddingModelV1, type EmbeddingModelV1Embedding, EmptyResponseBodyError, InvalidArgumentError, InvalidDataContentError, InvalidPromptError, InvalidResponseDataError, InvalidToolArgumentsError, JSONParseError, type LanguageModelV1, type LanguageModelV1CallOptions, type LanguageModelV1CallWarning, type LanguageModelV1FinishReason, type LanguageModelV1FunctionTool, type LanguageModelV1FunctionToolCall, type LanguageModelV1ImagePart, type LanguageModelV1LogProbs, type LanguageModelV1Message, type LanguageModelV1Prompt, type LanguageModelV1ResponseMetadata, type LanguageModelV1StreamPart, type LanguageModelV1TextPart, type LanguageModelV1ToolCallPart, type LanguageModelV1ToolResultPart, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoObjectGeneratedError, NoSuchToolError, RetryError, type RetryErrorReason, TooManyEmbeddingValuesForCallError, ToolCallParseError, TypeValidationError, UnsupportedFunctionalityError, UnsupportedJSONSchemaError };

package/dist/index.js

@@ -29,9 +29,12 @@ __export(src_exports, {
   InvalidToolArgumentsError: () => InvalidToolArgumentsError,
   JSONParseError: () => JSONParseError,
   LoadAPIKeyError: () => LoadAPIKeyError,
+  LoadSettingError: () => LoadSettingError,
+  NoContentGeneratedError: () => NoContentGeneratedError,
   NoObjectGeneratedError: () => NoObjectGeneratedError,
   NoSuchToolError: () => NoSuchToolError,
   RetryError: () => RetryError,
+  TooManyEmbeddingValuesForCallError: () => TooManyEmbeddingValuesForCallError,
   ToolCallParseError: () => ToolCallParseError,
   TypeValidationError: () => TypeValidationError,
   UnsupportedFunctionalityError: () => UnsupportedFunctionalityError,
@@ -286,13 +289,51 @@ var LoadAPIKeyError = class extends Error {
   }
 };
 
+// src/errors/load-setting-error.ts
+var LoadSettingError = class extends Error {
+  constructor({ message }) {
+    super(message);
+    this.name = "AI_LoadSettingError";
+  }
+  static isLoadSettingError(error) {
+    return error instanceof Error && error.name === "AI_LoadSettingError";
+  }
+  toJSON() {
+    return {
+      name: this.name,
+      message: this.message
+    };
+  }
+};
+
+// src/errors/no-content-generated-error.ts
+var NoContentGeneratedError = class extends Error {
+  constructor({
+    message = "No content generated."
+  } = {}) {
+    super(message);
+    this.name = "AI_NoContentGeneratedError";
+  }
+  static isNoContentGeneratedError(error) {
+    return error instanceof Error && error.name === "AI_NoContentGeneratedError";
+  }
+  toJSON() {
+    return {
+      name: this.name,
+      cause: this.cause,
+      message: this.message,
+      stack: this.stack
+    };
+  }
+};
+
 // src/errors/no-object-generated-error.ts
 var NoObjectGeneratedError = class extends Error {
-  constructor() {
-    super(`No object generated.`);
+  constructor({ message = "No object generated." } = {}) {
+    super(message);
     this.name = "AI_NoObjectGeneratedError";
   }
-  static isNoTextGeneratedError(error) {
+  static isNoObjectGeneratedError(error) {
     return error instanceof Error && error.name === "AI_NoObjectGeneratedError";
   }
   toJSON() {
@@ -358,6 +399,34 @@ var RetryError = class extends Error {
   }
 };
 
+// src/errors/too-many-embedding-values-for-call-error.ts
+var TooManyEmbeddingValuesForCallError = class extends Error {
+  constructor(options) {
+    super(
+      `Too many values for a single embedding call. The ${options.provider} model "${options.modelId}" can only embed up to ${options.maxEmbeddingsPerCall} values per call, but ${options.values.length} values were provided.`
+    );
+    this.name = "AI_TooManyEmbeddingValuesForCallError";
+    this.provider = options.provider;
+    this.modelId = options.modelId;
+    this.maxEmbeddingsPerCall = options.maxEmbeddingsPerCall;
+    this.values = options.values;
+  }
+  static isInvalidPromptError(error) {
+    return error instanceof Error && error.name === "AI_TooManyEmbeddingValuesForCallError" && "provider" in error && typeof error.provider === "string" && "modelId" in error && typeof error.modelId === "string" && "maxEmbeddingsPerCall" in error && typeof error.maxEmbeddingsPerCall === "number" && "values" in error && Array.isArray(error.values);
+  }
+  toJSON() {
+    return {
+      name: this.name,
+      message: this.message,
+      stack: this.stack,
+      provider: this.provider,
+      modelId: this.modelId,
+      maxEmbeddingsPerCall: this.maxEmbeddingsPerCall,
+      values: this.values
+    };
+  }
+};
+
 // src/errors/tool-call-parse-error.ts
 var ToolCallParseError = class extends Error {
   constructor({
@@ -468,9 +537,12 @@ var UnsupportedJSONSchemaError = class extends Error {
   InvalidToolArgumentsError,
   JSONParseError,
   LoadAPIKeyError,
+  LoadSettingError,
+  NoContentGeneratedError,
   NoObjectGeneratedError,
   NoSuchToolError,
   RetryError,
+  TooManyEmbeddingValuesForCallError,
   ToolCallParseError,
   TypeValidationError,
   UnsupportedFunctionalityError,