@openrouter/ai-sdk-provider 0.0.3

package/dist/index.d.ts

@@ -0,0 +1,228 @@
+import { LanguageModelV1 } from '@ai-sdk/provider';
+
+type OpenRouterChatModelId = string;
+interface OpenRouterChatSettings {
+    /**
+  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;
+    /**
+  Whether to enable parallel function calling during tool use. Default to true.
+     */
+    parallelToolCalls?: boolean;
+    /**
+  A unique identifier representing your end-user, which can help OpenRouter to
+  monitor and detect abuse. Learn more.
+  */
+    user?: string;
+}
+
+type OpenRouterChatConfig = {
+    provider: string;
+    compatibility: "strict" | "compatible";
+    headers: () => Record<string, string | undefined>;
+    url: (options: {
+        modelId: string;
+        path: string;
+    }) => string;
+    fetch?: typeof fetch;
+};
+declare class OpenRouterChatLanguageModel implements LanguageModelV1 {
+    readonly specificationVersion = "v1";
+    readonly defaultObjectGenerationMode = "tool";
+    readonly modelId: OpenRouterChatModelId;
+    readonly settings: OpenRouterChatSettings;
+    private readonly config;
+    constructor(modelId: OpenRouterChatModelId, settings: OpenRouterChatSettings, config: OpenRouterChatConfig);
+    get provider(): string;
+    private getArgs;
+    doGenerate(options: Parameters<LanguageModelV1["doGenerate"]>[0]): Promise<Awaited<ReturnType<LanguageModelV1["doGenerate"]>>>;
+    doStream(options: Parameters<LanguageModelV1["doStream"]>[0]): Promise<Awaited<ReturnType<LanguageModelV1["doStream"]>>>;
+}
+
+type OpenRouterCompletionModelId = "openai/gpt-3.5-turbo-instruct" | (string & {});
+interface OpenRouterCompletionSettings {
+    /**
+  Echo back the prompt in addition to the completion.
+     */
+    echo?: boolean;
+    /**
+  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;
+    /**
+  A unique identifier representing your end-user, which can help OpenRouter to
+  monitor and detect abuse. Learn more.
+     */
+    user?: string;
+}
+
+type OpenRouterCompletionConfig = {
+    provider: string;
+    compatibility: "strict" | "compatible";
+    headers: () => Record<string, string | undefined>;
+    url: (options: {
+        modelId: string;
+        path: string;
+    }) => string;
+    fetch?: typeof fetch;
+};
+declare class OpenRouterCompletionLanguageModel implements LanguageModelV1 {
+    readonly specificationVersion = "v1";
+    readonly defaultObjectGenerationMode: undefined;
+    readonly modelId: OpenRouterCompletionModelId;
+    readonly settings: OpenRouterCompletionSettings;
+    private readonly config;
+    constructor(modelId: OpenRouterCompletionModelId, settings: OpenRouterCompletionSettings, config: OpenRouterCompletionConfig);
+    get provider(): string;
+    private getArgs;
+    doGenerate(options: Parameters<LanguageModelV1["doGenerate"]>[0]): Promise<Awaited<ReturnType<LanguageModelV1["doGenerate"]>>>;
+    doStream(options: Parameters<LanguageModelV1["doStream"]>[0]): Promise<Awaited<ReturnType<LanguageModelV1["doStream"]>>>;
+}
+
+interface OpenRouterProvider {
+    (modelId: "openai/gpt-3.5-turbo-instruct", settings?: OpenRouterCompletionSettings): OpenRouterCompletionLanguageModel;
+    (modelId: OpenRouterChatModelId, settings?: OpenRouterChatSettings): OpenRouterChatLanguageModel;
+    languageModel(modelId: "openai/gpt-3.5-turbo-instruct", settings?: OpenRouterCompletionSettings): OpenRouterCompletionLanguageModel;
+    languageModel(modelId: OpenRouterChatModelId, settings?: OpenRouterChatSettings): OpenRouterChatLanguageModel;
+    /**
+  Creates an OpenRouter chat model for text generation.
+     */
+    chat(modelId: OpenRouterChatModelId, settings?: OpenRouterChatSettings): OpenRouterChatLanguageModel;
+    /**
+  Creates an OpenRouter completion model for text generation.
+     */
+    completion(modelId: OpenRouterCompletionModelId, settings?: OpenRouterCompletionSettings): OpenRouterCompletionLanguageModel;
+}
+interface OpenRouterProviderSettings {
+    /**
+  Base URL for the OpenRouter API calls.
+       */
+    baseURL?: string;
+    /**
+  @deprecated Use `baseURL` instead.
+       */
+    baseUrl?: string;
+    /**
+  API key for authenticating requests.
+       */
+    apiKey?: string;
+    /**
+  OpenRouter Organization.
+       */
+    organization?: string;
+    /**
+  OpenRouter project.
+       */
+    project?: string;
+    /**
+  Custom headers to include in the requests.
+       */
+    headers?: Record<string, string>;
+    /**
+  OpenRouter compatibility mode. Should be set to `strict` when using the OpenRouter API,
+  and `compatible` when using 3rd party providers. In `compatible` mode, newer
+  information such as streamOptions are not being sent. Defaults to 'compatible'.
+     */
+    compatibility?: "strict" | "compatible";
+    /**
+  Custom fetch implementation. You can use it as a middleware to intercept requests,
+  or to provide a custom fetch implementation for e.g. testing.
+      */
+    fetch?: typeof fetch;
+}
+/**
+Create an OpenRouter provider instance.
+ */
+declare function createOpenRouter(options?: OpenRouterProviderSettings): OpenRouterProvider;
+/**
+Default OpenRouter provider instance. It uses 'strict' compatibility mode.
+ */
+declare const openrouter: OpenRouterProvider;
+
+/**
+@deprecated Use `createOpenRouter` instead.
+ */
+declare class OpenRouter {
+    /**
+  Use a different URL prefix for API calls, e.g. to use proxy servers.
+  The default prefix is `https://openrouter.ai/api/v1`.
+     */
+    readonly baseURL: string;
+    /**
+  API key that is being send using the `Authorization` header.
+  It defaults to the `OPENAI_API_KEY` environment variable.
+   */
+    readonly apiKey?: string;
+    /**
+  OpenRouter Organization.
+     */
+    readonly organization?: string;
+    /**
+  OpenRouter project.
+     */
+    readonly project?: string;
+    /**
+  Custom headers to include in the requests.
+     */
+    readonly headers?: Record<string, string>;
+    /**
+     * Creates a new OpenRouter provider instance.
+     */
+    constructor(options?: OpenRouterProviderSettings);
+    private get baseConfig();
+    chat(modelId: OpenRouterChatModelId, settings?: OpenRouterChatSettings): OpenRouterChatLanguageModel;
+    completion(modelId: OpenRouterCompletionModelId, settings?: OpenRouterCompletionSettings): OpenRouterCompletionLanguageModel;
+}
+
+export { OpenRouter, type OpenRouterProvider, type OpenRouterProviderSettings, createOpenRouter, openrouter };