@openrouter/ai-sdk-provider 1.3.0 → 1.4.1

package/dist/internal/index.d.mts

@@ -38,124 +38,6 @@ declare const ReasoningDetailUnionSchema: z.ZodUnion<readonly [z.ZodObject<{
 }, z.core.$strip>]>;
 type ReasoningDetailUnion = z.infer<typeof ReasoningDetailUnionSchema>;
 
-type OpenRouterProviderOptions = {
-    models?: string[];
-    /**
-     * https://openrouter.ai/docs/use-cases/reasoning-tokens
-     * One of `max_tokens` or `effort` is required.
-     * If `exclude` is true, reasoning will be removed from the response. Default is false.
-     */
-    reasoning?: {
-        enabled?: boolean;
-        exclude?: boolean;
-    } & ({
-        max_tokens: number;
-    } | {
-        effort: 'high' | 'medium' | 'low';
-    });
-    /**
-     * A unique identifier representing your end-user, which can
-     * help OpenRouter to monitor and detect abuse.
-     */
-    user?: string;
-};
-type OpenRouterSharedSettings = OpenRouterProviderOptions & {
-    /**
-     * @deprecated use `reasoning` instead
-     */
-    includeReasoning?: boolean;
-    extraBody?: Record<string, unknown>;
-    /**
-     * Enable usage accounting to get detailed token usage information.
-     * https://openrouter.ai/docs/use-cases/usage-accounting
-     */
-    usage?: {
-        /**
-         * When true, includes token usage information in the response.
-         */
-        include: boolean;
-    };
-};
-/**
- * Usage accounting response
- * @see https://openrouter.ai/docs/use-cases/usage-accounting
- */
-type OpenRouterUsageAccounting = {
-    promptTokens: number;
-    promptTokensDetails?: {
-        cachedTokens: number;
-    };
-    completionTokens: number;
-    completionTokensDetails?: {
-        reasoningTokens: number;
-    };
-    totalTokens: number;
-    cost?: number;
-    costDetails?: {
-        upstreamInferenceCost: number;
-    };
-};
-
-type OpenRouterCompletionModelId = string;
-type OpenRouterCompletionSettings = {
-    /**
-  Modify the likelihood of specified tokens appearing in the completion.
-  
-  Accepts a JSON object that maps tokens (specified by their token ID in
-  the GPT tokenizer) to an associated bias value from -100 to 100. You
-  can use this tokenizer tool to convert text to token IDs. Mathematically,
-  the bias is added to the logits generated by the model prior to sampling.
-  The exact effect will vary per model, but values between -1 and 1 should
-  decrease or increase likelihood of selection; values like -100 or 100
-  should result in a ban or exclusive selection of the relevant token.
-  
-  As an example, you can pass {"50256": -100} to prevent the <|endoftext|>
-  token from being generated.
-     */
-    logitBias?: Record<number, number>;
-    /**
-  Return the log probabilities of the tokens. Including logprobs will increase
-  the response size and can slow down response times. However, it can
-  be useful to better understand how the model is behaving.
-  
-  Setting to true will return the log probabilities of the tokens that
-  were generated.
-  
-  Setting to a number will return the log probabilities of the top n
-  tokens that were generated.
-     */
-    logprobs?: boolean | number;
-    /**
-  The suffix that comes after a completion of inserted text.
-     */
-    suffix?: string;
-} & OpenRouterSharedSettings;
-
-type OpenRouterCompletionConfig = {
-    provider: string;
-    compatibility: 'strict' | 'compatible';
-    headers: () => Record<string, string | undefined>;
-    url: (options: {
-        modelId: string;
-        path: string;
-    }) => string;
-    fetch?: typeof fetch;
-    extraBody?: Record<string, unknown>;
-};
-declare class OpenRouterCompletionLanguageModel implements LanguageModelV2 {
-    readonly specificationVersion: "v2";
-    readonly provider = "openrouter";
-    readonly modelId: OpenRouterCompletionModelId;
-    readonly supportedUrls: Record<string, RegExp[]>;
-    readonly defaultObjectGenerationMode: undefined;
-    readonly settings: OpenRouterCompletionSettings;
-    private readonly config;
-    constructor(modelId: OpenRouterCompletionModelId, settings: OpenRouterCompletionSettings, config: OpenRouterCompletionConfig);
-    private getArgs;
-    doGenerate(options: LanguageModelV2CallOptions): Promise<Awaited<ReturnType<LanguageModelV2['doGenerate']>>>;
-    doStream(options: LanguageModelV2CallOptions): Promise<Awaited<ReturnType<LanguageModelV2['doStream']>>>;
-}
-
 type OpenRouterChatModelId = string;
 type OpenRouterChatSettings = {
     /**
@@ -223,6 +105,14 @@ type OpenRouterChatSettings = {
          * Custom search prompt to guide the search query
          */
         search_prompt?: string;
+        /**
+         * Search engine to use for web search
+         * - "native": Use provider's built-in web search
+         * - "exa": Use Exa's search API
+         * - undefined: Native if supported, otherwise Exa
+         * @see https://openrouter.ai/docs/features/web-search
+         */
+        engine?: models.Engine;
     };
     /**
      * Debug options for troubleshooting API requests.
@@ -283,9 +173,185 @@ type OpenRouterChatSettings = {
             audio?: number | string;
             request?: number | string;
         };
+        /**
+         * Whether to restrict routing to only ZDR (Zero Data Retention) endpoints.
+         * When true, only endpoints that do not retain prompts will be used.
+         */
+        zdr?: boolean;
+    };
+} & OpenRouterSharedSettings;
+
+type OpenRouterCompletionModelId = string;
+type OpenRouterCompletionSettings = {
+    /**
+  Modify the likelihood of specified tokens appearing in the completion.
+  
+  Accepts a JSON object that maps tokens (specified by their token ID in
+  the GPT tokenizer) to an associated bias value from -100 to 100. You
+  can use this tokenizer tool to convert text to token IDs. Mathematically,
+  the bias is added to the logits generated by the model prior to sampling.
+  The exact effect will vary per model, but values between -1 and 1 should
+  decrease or increase likelihood of selection; values like -100 or 100
+  should result in a ban or exclusive selection of the relevant token.
+  
+  As an example, you can pass {"50256": -100} to prevent the <|endoftext|>
+  token from being generated.
+     */
+    logitBias?: Record<number, number>;
+    /**
+  Return the log probabilities of the tokens. Including logprobs will increase
+  the response size and can slow down response times. However, it can
+  be useful to better understand how the model is behaving.
+  
+  Setting to true will return the log probabilities of the tokens that
+  were generated.
+  
+  Setting to a number will return the log probabilities of the top n
+  tokens that were generated.
+     */
+    logprobs?: boolean | number;
+    /**
+  The suffix that comes after a completion of inserted text.
+     */
+    suffix?: string;
+} & OpenRouterSharedSettings;
+
+type OpenRouterCompletionConfig = {
+    provider: string;
+    compatibility: 'strict' | 'compatible';
+    headers: () => Record<string, string | undefined>;
+    url: (options: {
+        modelId: string;
+        path: string;
+    }) => string;
+    fetch?: typeof fetch;
+    extraBody?: Record<string, unknown>;
+};
+declare class OpenRouterCompletionLanguageModel implements LanguageModelV2 {
+    readonly specificationVersion: "v2";
+    readonly provider = "openrouter";
+    readonly modelId: OpenRouterCompletionModelId;
+    readonly supportsImageUrls = true;
+    readonly supportedUrls: Record<string, RegExp[]>;
+    readonly defaultObjectGenerationMode: undefined;
+    readonly settings: OpenRouterCompletionSettings;
+    private readonly config;
+    constructor(modelId: OpenRouterCompletionModelId, settings: OpenRouterCompletionSettings, config: OpenRouterCompletionConfig);
+    private getArgs;
+    doGenerate(options: LanguageModelV2CallOptions): Promise<Awaited<ReturnType<LanguageModelV2['doGenerate']>>>;
+    doStream(options: LanguageModelV2CallOptions): Promise<Awaited<ReturnType<LanguageModelV2['doStream']>>>;
+}
+
+type OpenRouterEmbeddingModelId = string;
+type OpenRouterEmbeddingSettings = {
+    /**
+     * A unique identifier representing your end-user, which can help OpenRouter to
+     * monitor and detect abuse.
+     */
+    user?: string;
+    /**
+     * Provider routing preferences to control request routing behavior
+     */
+    provider?: {
+        /**
+         * List of provider slugs to try in order (e.g. ["openai", "voyageai"])
+         */
+        order?: string[];
+        /**
+         * Whether to allow backup providers when primary is unavailable (default: true)
+         */
+        allow_fallbacks?: boolean;
+        /**
+         * Only use providers that support all parameters in your request (default: false)
+         */
+        require_parameters?: boolean;
+        /**
+         * Control whether to use providers that may store data
+         */
+        data_collection?: 'allow' | 'deny';
+        /**
+         * List of provider slugs to allow for this request
+         */
+        only?: string[];
+        /**
+         * List of provider slugs to skip for this request
+         */
+        ignore?: string[];
+        /**
+         * Sort providers by price, throughput, or latency
+         */
+        sort?: 'price' | 'throughput' | 'latency';
+        /**
+         * Maximum pricing you want to pay for this request
+         */
+        max_price?: {
+            prompt?: number | string;
+            completion?: number | string;
+            image?: number | string;
+            audio?: number | string;
+            request?: number | string;
+        };
     };
 } & OpenRouterSharedSettings;
 
+type OpenRouterProviderOptions = {
+    models?: string[];
+    /**
+     * https://openrouter.ai/docs/use-cases/reasoning-tokens
+     * One of `max_tokens` or `effort` is required.
+     * If `exclude` is true, reasoning will be removed from the response. Default is false.
+     */
+    reasoning?: {
+        enabled?: boolean;
+        exclude?: boolean;
+    } & ({
+        max_tokens: number;
+    } | {
+        effort: 'high' | 'medium' | 'low';
+    });
+    /**
+     * A unique identifier representing your end-user, which can
+     * help OpenRouter to monitor and detect abuse.
+     */
+    user?: string;
+};
+type OpenRouterSharedSettings = OpenRouterProviderOptions & {
+    /**
+     * @deprecated use `reasoning` instead
+     */
+    includeReasoning?: boolean;
+    extraBody?: Record<string, unknown>;
+    /**
+     * Enable usage accounting to get detailed token usage information.
+     * https://openrouter.ai/docs/use-cases/usage-accounting
+     */
+    usage?: {
+        /**
+         * When true, includes token usage information in the response.
+         */
+        include: boolean;
+    };
+};
+/**
+ * Usage accounting response
+ * @see https://openrouter.ai/docs/use-cases/usage-accounting
+ */
+type OpenRouterUsageAccounting = {
+    promptTokens: number;
+    promptTokensDetails?: {
+        cachedTokens: number;
+    };
+    completionTokens: number;
+    completionTokensDetails?: {
+        reasoningTokens: number;
+    };
+    totalTokens: number;
+    cost?: number;
+    costDetails?: {
+        upstreamInferenceCost: number;
+    };
+};
+
 type OpenRouterChatConfig = {
     provider: string;
     compatibility: 'strict' | 'compatible';
@@ -302,6 +368,7 @@ declare class OpenRouterChatLanguageModel implements LanguageModelV2 {
     readonly provider = "openrouter";
     readonly defaultObjectGenerationMode: "tool";
     readonly modelId: OpenRouterChatModelId;
+    readonly supportsImageUrls = true;
     readonly supportedUrls: Record<string, RegExp[]>;
     readonly settings: OpenRouterChatSettings;
     private readonly config;
@@ -340,4 +407,4 @@ declare class OpenRouterChatLanguageModel implements LanguageModelV2 {
     }>;
 }
 
-export { OpenRouterChatLanguageModel, type OpenRouterChatModelId, type OpenRouterChatSettings, OpenRouterCompletionLanguageModel, type OpenRouterCompletionModelId, type OpenRouterCompletionSettings, type OpenRouterProviderOptions, type OpenRouterSharedSettings, type OpenRouterUsageAccounting };
+export { OpenRouterChatLanguageModel, type OpenRouterChatModelId, type OpenRouterChatSettings, OpenRouterCompletionLanguageModel, type OpenRouterCompletionModelId, type OpenRouterCompletionSettings, type OpenRouterEmbeddingModelId, type OpenRouterEmbeddingSettings, type OpenRouterProviderOptions, type OpenRouterSharedSettings, type OpenRouterUsageAccounting };

package/dist/internal/index.d.ts

@@ -38,124 +38,6 @@ declare const ReasoningDetailUnionSchema: z.ZodUnion<readonly [z.ZodObject<{
 }, z.core.$strip>]>;
 type ReasoningDetailUnion = z.infer<typeof ReasoningDetailUnionSchema>;
 
-type OpenRouterProviderOptions = {
-    models?: string[];
-    /**
-     * https://openrouter.ai/docs/use-cases/reasoning-tokens
-     * One of `max_tokens` or `effort` is required.
-     * If `exclude` is true, reasoning will be removed from the response. Default is false.
-     */
-    reasoning?: {
-        enabled?: boolean;
-        exclude?: boolean;
-    } & ({
-        max_tokens: number;
-    } | {
-        effort: 'high' | 'medium' | 'low';
-    });
-    /**
-     * A unique identifier representing your end-user, which can
-     * help OpenRouter to monitor and detect abuse.
-     */
-    user?: string;
-};
-type OpenRouterSharedSettings = OpenRouterProviderOptions & {
-    /**
-     * @deprecated use `reasoning` instead
-     */
-    includeReasoning?: boolean;
-    extraBody?: Record<string, unknown>;
-    /**
-     * Enable usage accounting to get detailed token usage information.
-     * https://openrouter.ai/docs/use-cases/usage-accounting
-     */
-    usage?: {
-        /**
-         * When true, includes token usage information in the response.
-         */
-        include: boolean;
-    };
-};
-/**
- * Usage accounting response
- * @see https://openrouter.ai/docs/use-cases/usage-accounting
- */
-type OpenRouterUsageAccounting = {
-    promptTokens: number;
-    promptTokensDetails?: {
-        cachedTokens: number;
-    };
-    completionTokens: number;
-    completionTokensDetails?: {
-        reasoningTokens: number;
-    };
-    totalTokens: number;
-    cost?: number;
-    costDetails?: {
-        upstreamInferenceCost: number;
-    };
-};
-
-type OpenRouterCompletionModelId = string;
-type OpenRouterCompletionSettings = {
-    /**
-  Modify the likelihood of specified tokens appearing in the completion.
-  
-  Accepts a JSON object that maps tokens (specified by their token ID in
-  the GPT tokenizer) to an associated bias value from -100 to 100. You
-  can use this tokenizer tool to convert text to token IDs. Mathematically,
-  the bias is added to the logits generated by the model prior to sampling.
-  The exact effect will vary per model, but values between -1 and 1 should
-  decrease or increase likelihood of selection; values like -100 or 100
-  should result in a ban or exclusive selection of the relevant token.
-  
-  As an example, you can pass {"50256": -100} to prevent the <|endoftext|>
-  token from being generated.
-     */
-    logitBias?: Record<number, number>;
-    /**
-  Return the log probabilities of the tokens. Including logprobs will increase
-  the response size and can slow down response times. However, it can
-  be useful to better understand how the model is behaving.
-  
-  Setting to true will return the log probabilities of the tokens that
-  were generated.
-  
-  Setting to a number will return the log probabilities of the top n
-  tokens that were generated.
-     */
-    logprobs?: boolean | number;
-    /**
-  The suffix that comes after a completion of inserted text.
-     */
-    suffix?: string;
-} & OpenRouterSharedSettings;
-
-type OpenRouterCompletionConfig = {
-    provider: string;
-    compatibility: 'strict' | 'compatible';
-    headers: () => Record<string, string | undefined>;
-    url: (options: {
-        modelId: string;
-        path: string;
-    }) => string;
-    fetch?: typeof fetch;
-    extraBody?: Record<string, unknown>;
-};
-declare class OpenRouterCompletionLanguageModel implements LanguageModelV2 {
-    readonly specificationVersion: "v2";
-    readonly provider = "openrouter";
-    readonly modelId: OpenRouterCompletionModelId;
-    readonly supportedUrls: Record<string, RegExp[]>;
-    readonly defaultObjectGenerationMode: undefined;
-    readonly settings: OpenRouterCompletionSettings;
-    private readonly config;
-    constructor(modelId: OpenRouterCompletionModelId, settings: OpenRouterCompletionSettings, config: OpenRouterCompletionConfig);
-    private getArgs;
-    doGenerate(options: LanguageModelV2CallOptions): Promise<Awaited<ReturnType<LanguageModelV2['doGenerate']>>>;
-    doStream(options: LanguageModelV2CallOptions): Promise<Awaited<ReturnType<LanguageModelV2['doStream']>>>;
-}
-
 type OpenRouterChatModelId = string;
 type OpenRouterChatSettings = {
     /**
@@ -223,6 +105,14 @@ type OpenRouterChatSettings = {
          * Custom search prompt to guide the search query
          */
         search_prompt?: string;
+        /**
+         * Search engine to use for web search
+         * - "native": Use provider's built-in web search
+         * - "exa": Use Exa's search API
+         * - undefined: Native if supported, otherwise Exa
+         * @see https://openrouter.ai/docs/features/web-search
+         */
+        engine?: models.Engine;
     };
     /**
      * Debug options for troubleshooting API requests.
@@ -283,9 +173,185 @@ type OpenRouterChatSettings = {
             audio?: number | string;
             request?: number | string;
         };
+        /**
+         * Whether to restrict routing to only ZDR (Zero Data Retention) endpoints.
+         * When true, only endpoints that do not retain prompts will be used.
+         */
+        zdr?: boolean;
+    };
+} & OpenRouterSharedSettings;
+
+type OpenRouterCompletionModelId = string;
+type OpenRouterCompletionSettings = {
+    /**
+  Modify the likelihood of specified tokens appearing in the completion.
+  
+  Accepts a JSON object that maps tokens (specified by their token ID in
+  the GPT tokenizer) to an associated bias value from -100 to 100. You
+  can use this tokenizer tool to convert text to token IDs. Mathematically,
+  the bias is added to the logits generated by the model prior to sampling.
+  The exact effect will vary per model, but values between -1 and 1 should
+  decrease or increase likelihood of selection; values like -100 or 100
+  should result in a ban or exclusive selection of the relevant token.
+  
+  As an example, you can pass {"50256": -100} to prevent the <|endoftext|>
+  token from being generated.
+     */
+    logitBias?: Record<number, number>;
+    /**
+  Return the log probabilities of the tokens. Including logprobs will increase
+  the response size and can slow down response times. However, it can
+  be useful to better understand how the model is behaving.
+  
+  Setting to true will return the log probabilities of the tokens that
+  were generated.
+  
+  Setting to a number will return the log probabilities of the top n
+  tokens that were generated.
+     */
+    logprobs?: boolean | number;
+    /**
+  The suffix that comes after a completion of inserted text.
+     */
+    suffix?: string;
+} & OpenRouterSharedSettings;
+
+type OpenRouterCompletionConfig = {
+    provider: string;
+    compatibility: 'strict' | 'compatible';
+    headers: () => Record<string, string | undefined>;
+    url: (options: {
+        modelId: string;
+        path: string;
+    }) => string;
+    fetch?: typeof fetch;
+    extraBody?: Record<string, unknown>;
+};
+declare class OpenRouterCompletionLanguageModel implements LanguageModelV2 {
+    readonly specificationVersion: "v2";
+    readonly provider = "openrouter";
+    readonly modelId: OpenRouterCompletionModelId;
+    readonly supportsImageUrls = true;
+    readonly supportedUrls: Record<string, RegExp[]>;
+    readonly defaultObjectGenerationMode: undefined;
+    readonly settings: OpenRouterCompletionSettings;
+    private readonly config;
+    constructor(modelId: OpenRouterCompletionModelId, settings: OpenRouterCompletionSettings, config: OpenRouterCompletionConfig);
+    private getArgs;
+    doGenerate(options: LanguageModelV2CallOptions): Promise<Awaited<ReturnType<LanguageModelV2['doGenerate']>>>;
+    doStream(options: LanguageModelV2CallOptions): Promise<Awaited<ReturnType<LanguageModelV2['doStream']>>>;
+}
+
+type OpenRouterEmbeddingModelId = string;
+type OpenRouterEmbeddingSettings = {
+    /**
+     * A unique identifier representing your end-user, which can help OpenRouter to
+     * monitor and detect abuse.
+     */
+    user?: string;
+    /**
+     * Provider routing preferences to control request routing behavior
+     */
+    provider?: {
+        /**
+         * List of provider slugs to try in order (e.g. ["openai", "voyageai"])
+         */
+        order?: string[];
+        /**
+         * Whether to allow backup providers when primary is unavailable (default: true)
+         */
+        allow_fallbacks?: boolean;
+        /**
+         * Only use providers that support all parameters in your request (default: false)
+         */
+        require_parameters?: boolean;
+        /**
+         * Control whether to use providers that may store data
+         */
+        data_collection?: 'allow' | 'deny';
+        /**
+         * List of provider slugs to allow for this request
+         */
+        only?: string[];
+        /**
+         * List of provider slugs to skip for this request
+         */
+        ignore?: string[];
+        /**
+         * Sort providers by price, throughput, or latency
+         */
+        sort?: 'price' | 'throughput' | 'latency';
+        /**
+         * Maximum pricing you want to pay for this request
+         */
+        max_price?: {
+            prompt?: number | string;
+            completion?: number | string;
+            image?: number | string;
+            audio?: number | string;
+            request?: number | string;
+        };
     };
 } & OpenRouterSharedSettings;
 
+type OpenRouterProviderOptions = {
+    models?: string[];
+    /**
+     * https://openrouter.ai/docs/use-cases/reasoning-tokens
+     * One of `max_tokens` or `effort` is required.
+     * If `exclude` is true, reasoning will be removed from the response. Default is false.
+     */
+    reasoning?: {
+        enabled?: boolean;
+        exclude?: boolean;
+    } & ({
+        max_tokens: number;
+    } | {
+        effort: 'high' | 'medium' | 'low';
+    });
+    /**
+     * A unique identifier representing your end-user, which can
+     * help OpenRouter to monitor and detect abuse.
+     */
+    user?: string;
+};
+type OpenRouterSharedSettings = OpenRouterProviderOptions & {
+    /**
+     * @deprecated use `reasoning` instead
+     */
+    includeReasoning?: boolean;
+    extraBody?: Record<string, unknown>;
+    /**
+     * Enable usage accounting to get detailed token usage information.
+     * https://openrouter.ai/docs/use-cases/usage-accounting
+     */
+    usage?: {
+        /**
+         * When true, includes token usage information in the response.
+         */
+        include: boolean;
+    };
+};
+/**
+ * Usage accounting response
+ * @see https://openrouter.ai/docs/use-cases/usage-accounting
+ */
+type OpenRouterUsageAccounting = {
+    promptTokens: number;
+    promptTokensDetails?: {
+        cachedTokens: number;
+    };
+    completionTokens: number;
+    completionTokensDetails?: {
+        reasoningTokens: number;
+    };
+    totalTokens: number;
+    cost?: number;
+    costDetails?: {
+        upstreamInferenceCost: number;
+    };
+};
+
 type OpenRouterChatConfig = {
     provider: string;
     compatibility: 'strict' | 'compatible';
@@ -302,6 +368,7 @@ declare class OpenRouterChatLanguageModel implements LanguageModelV2 {
     readonly provider = "openrouter";
     readonly defaultObjectGenerationMode: "tool";
     readonly modelId: OpenRouterChatModelId;
+    readonly supportsImageUrls = true;
     readonly supportedUrls: Record<string, RegExp[]>;
     readonly settings: OpenRouterChatSettings;
     private readonly config;
@@ -340,4 +407,4 @@ declare class OpenRouterChatLanguageModel implements LanguageModelV2 {
     }>;
 }
 
-export { OpenRouterChatLanguageModel, type OpenRouterChatModelId, type OpenRouterChatSettings, OpenRouterCompletionLanguageModel, type OpenRouterCompletionModelId, type OpenRouterCompletionSettings, type OpenRouterProviderOptions, type OpenRouterSharedSettings, type OpenRouterUsageAccounting };
+export { OpenRouterChatLanguageModel, type OpenRouterChatModelId, type OpenRouterChatSettings, OpenRouterCompletionLanguageModel, type OpenRouterCompletionModelId, type OpenRouterCompletionSettings, type OpenRouterEmbeddingModelId, type OpenRouterEmbeddingSettings, type OpenRouterProviderOptions, type OpenRouterSharedSettings, type OpenRouterUsageAccounting };