@langchain/openrouter 0.1.0

package/dist/api-types.d.ts

@@ -0,0 +1,368 @@
+//#region src/api-types.d.ts
+declare namespace OpenRouter {
+  /** An OpenRouter model identifier, e.g. `"anthropic/claude-4-sonnet"`. */
+  export type ModelName = string;
+  /**
+   * A string that represents a large number (price per million tokens).
+   * Encoded as a string to avoid floating-point precision issues.
+   */
+  export type BigNumberUnion = string;
+  export type ReasoningSummaryVerbosity = "auto" | "concise" | "detailed" | (string & {});
+  export type DataCollection = "deny" | "allow" | (string & {});
+  export type Quantization = "int4" | "int8" | "fp4" | "fp6" | "fp8" | "fp16" | "bf16" | "fp32" | "unknown" | (string & {});
+  export type ProviderSort = "price" | "throughput" | "latency" | (string & {});
+  export type ProviderName = "AI21" | "AionLabs" | "Alibaba" | "Ambient" | "Amazon Bedrock" | "Amazon Nova" | "Anthropic" | "Arcee AI" | "AtlasCloud" | "Avian" | "Azure" | "BaseTen" | "BytePlus" | "Black Forest Labs" | "Cerebras" | "Chutes" | "Cirrascale" | "Clarifai" | "Cloudflare" | "Cohere" | "Crusoe" | "DeepInfra" | "DeepSeek" | "Featherless" | "Fireworks" | "Friendli" | "GMICloud" | "Google" | "Google AI Studio" | "Groq" | "Hyperbolic" | "Inception" | "Inceptron" | "InferenceNet" | "Infermatic" | "Io Net" | "Inflection" | "Liquid" | "Mara" | "Mancer 2" | "Minimax" | "ModelRun" | "Mistral" | "Modular" | "Moonshot AI" | "Morph" | "NCompass" | "Nebius" | "NextBit" | "Novita" | "Nvidia" | "OpenAI" | "OpenInference" | "Parasail" | "Perplexity" | "Phala" | "Relace" | "SambaNova" | "Seed" | "SiliconFlow" | "Sourceful" | "StepFun" | "Stealth" | "StreamLake" | "Switchpoint" | "Together" | "Upstage" | "Venice" | "WandB" | "Xiaomi" | "xAI" | "Z.AI" | "FakeProvider" | (string & {});
+  export type ChatCompletionFinishReason = "tool_calls" | "stop" | "length" | "content_filter" | "error" | (string & {});
+  export type ReasoningDetailFormat = "unknown" | "openai-responses-v1" | "azure-openai-responses-v1" | "xai-responses-v1" | "anthropic-claude-v1" | "google-gemini-v1" | (string & {});
+  export interface ChatMessageContentItemCacheControl {
+    type: "ephemeral";
+    ttl?: "5m" | "1h" | (string & {});
+  }
+  export interface ChatMessageContentItemText {
+    type: "text";
+    text: string;
+    cache_control?: ChatMessageContentItemCacheControl;
+  }
+  export interface ChatMessageContentItemImage {
+    type: "image_url";
+    image_url: {
+      url: string;
+      detail?: "auto" | "low" | "high" | (string & {});
+    };
+  }
+  export interface ChatMessageContentItemAudio {
+    type: "input_audio";
+    input_audio: {
+      data: string;
+      format: string;
+    };
+  }
+  export type ChatMessageContentItemVideo = {
+    type: "input_video";
+    video_url: {
+      url: string;
+    };
+  } | {
+    type: "video_url";
+    video_url: {
+      url: string;
+    };
+  };
+  /** Discriminated union of all content part types (discriminant: `type`). */
+  export type ChatMessageContentItem = ChatMessageContentItemText | ChatMessageContentItemImage | ChatMessageContentItemAudio | ChatMessageContentItemVideo;
+  interface ReasoningDetailBase {
+    id?: string | null;
+    format?: ReasoningDetailFormat | null;
+    index?: number;
+  }
+  export interface ReasoningSummaryDetail extends ReasoningDetailBase {
+    type: "reasoning.summary";
+    summary: string;
+  }
+  export interface ReasoningEncryptedDetail extends ReasoningDetailBase {
+    type: "reasoning.encrypted";
+    data: string;
+  }
+  export interface ReasoningTextDetail extends ReasoningDetailBase {
+    type: "reasoning.text";
+    text?: string | null;
+    signature?: string | null;
+  }
+  export type ReasoningDetail = ReasoningSummaryDetail | ReasoningEncryptedDetail | ReasoningTextDetail;
+  export interface SystemMessage {
+    role: "system";
+    content: string | ChatMessageContentItemText[];
+    name?: string;
+  }
+  export interface UserMessage {
+    role: "user";
+    content: string | ChatMessageContentItem[];
+    name?: string;
+  }
+  export interface DeveloperMessage {
+    role: "developer";
+    content: string | ChatMessageContentItemText[];
+    name?: string;
+  }
+  export interface AssistantMessage {
+    role: "assistant";
+    content?: string | ChatMessageContentItem[] | null;
+    name?: string;
+    tool_calls?: ChatMessageToolCall[];
+    refusal?: string | null;
+    reasoning?: string | null;
+    reasoning_details?: ReasoningDetail[];
+    images?: Array<{
+      image_url: {
+        url: string;
+      };
+    }>;
+  }
+  export interface ToolResponseMessage {
+    role: "tool";
+    content: string | ChatMessageContentItem[];
+    tool_call_id: string;
+  }
+  /** Discriminated union of all message types (discriminant: `role`). */
+  export type Message = SystemMessage | UserMessage | DeveloperMessage | AssistantMessage | ToolResponseMessage;
+  export interface ChatMessageToolCall {
+    id: string;
+    type: "function";
+    function: {
+      name: string;
+      arguments: string;
+    };
+  }
+  export interface ChatStreamingMessageToolCall {
+    index: number;
+    id?: string;
+    type?: "function";
+    function?: {
+      name?: string;
+      arguments?: string;
+    };
+  }
+  export interface ToolDefinitionJson {
+    type: "function";
+    function: {
+      name: string;
+      description?: string;
+      parameters?: Record<string, unknown>;
+      strict?: boolean | null;
+    };
+    cache_control?: ChatMessageContentItemCacheControl;
+  }
+  export interface NamedToolChoice {
+    type: "function";
+    function: {
+      name: string;
+    };
+  }
+  export type ToolChoiceOption = "none" | "auto" | "required" | NamedToolChoice;
+  export interface JSONSchemaConfig {
+    name: string;
+    description?: string;
+    schema?: Record<string, unknown>;
+    strict?: boolean | null;
+  }
+  export interface ResponseFormatJSONSchema {
+    type: "json_schema";
+    json_schema: JSONSchemaConfig;
+  }
+  export interface ResponseFormatTextGrammar {
+    type: "grammar";
+    grammar: string;
+  }
+  export interface ChatMessageTokenLogprob {
+    token: string;
+    logprob: number;
+    bytes: number[] | null;
+    top_logprobs: Array<{
+      token: string;
+      logprob: number;
+      bytes: number[] | null;
+    }>;
+  }
+  export interface ChatMessageTokenLogprobs {
+    content: ChatMessageTokenLogprob[] | null;
+    refusal: ChatMessageTokenLogprob[] | null;
+  }
+  export interface ChatGenerationTokenUsage {
+    completion_tokens: number;
+    prompt_tokens: number;
+    total_tokens: number;
+    completion_tokens_details?: {
+      reasoning_tokens?: number | null;
+      audio_tokens?: number | null;
+      accepted_prediction_tokens?: number | null;
+      rejected_prediction_tokens?: number | null;
+    } | null;
+    prompt_tokens_details?: {
+      cached_tokens?: number;
+      cache_write_tokens?: number;
+      audio_tokens?: number;
+      video_tokens?: number;
+    } | null;
+  }
+  export interface PercentileLatencyCutoffs {
+    p50?: number | null;
+    p75?: number | null;
+    p90?: number | null;
+    p99?: number | null;
+  }
+  export interface PercentileThroughputCutoffs {
+    p50?: number | null;
+    p75?: number | null;
+    p90?: number | null;
+    p99?: number | null;
+  }
+  export type PreferredMaxLatency = number | PercentileLatencyCutoffs;
+  export type PreferredMinThroughput = number | PercentileThroughputCutoffs;
+  export interface ProviderSortConfig {
+    by?: ProviderSort | null;
+    partition?: "model" | "none" | (string & {}) | null;
+  }
+  export type ProviderSortUnion = ProviderSort | ProviderSortConfig;
+  export interface ProviderPreferences {
+    allow_fallbacks?: boolean | null;
+    require_parameters?: boolean | null;
+    data_collection?: DataCollection;
+    zdr?: boolean | null;
+    enforce_distillable_text?: boolean | null;
+    order?: Array<ProviderName | string> | null;
+    only?: Array<ProviderName | string> | null;
+    ignore?: Array<ProviderName | string> | null;
+    quantizations?: Quantization[] | null;
+    sort?: ProviderSortUnion | null;
+    max_price?: {
+      prompt?: BigNumberUnion;
+      completion?: BigNumberUnion;
+      image?: BigNumberUnion;
+      audio?: BigNumberUnion;
+      request?: BigNumberUnion;
+    };
+    preferred_min_throughput?: PreferredMinThroughput;
+    preferred_max_latency?: PreferredMaxLatency;
+  }
+  export interface AutoRouterPlugin {
+    id: "auto-router";
+    enabled?: boolean;
+    allowed_models?: string[];
+  }
+  export interface ModerationPlugin {
+    id: "moderation";
+  }
+  export interface WebPlugin {
+    id: "web";
+    enabled?: boolean;
+    max_results?: number;
+    search_prompt?: string;
+    engine?: "native" | "exa" | (string & {});
+  }
+  export interface FileParserPlugin {
+    id: "file-parser";
+    enabled?: boolean;
+    pdf?: {
+      engine?: "mistral-ocr" | "pdf-text" | "native" | (string & {});
+    };
+  }
+  export interface ResponseHealingPlugin {
+    id: "response-healing";
+    enabled?: boolean;
+  }
+  export type PluginDefinition = AutoRouterPlugin | ModerationPlugin | WebPlugin | FileParserPlugin | ResponseHealingPlugin | {
+    id: string;
+    [key: string]: unknown;
+  };
+  export interface TraceConfig {
+    trace_id?: string;
+    trace_name?: string;
+    span_name?: string;
+    generation_name?: string;
+    parent_span_id?: string;
+    [key: string]: unknown;
+  }
+  export interface ChatStreamOptions {
+    include_usage?: boolean;
+  }
+  export interface ChatGenerationParams {
+    messages: Message[];
+    model?: ModelName;
+    models?: ModelName[];
+    provider?: ProviderPreferences | null;
+    plugins?: PluginDefinition[];
+    route?: "fallback" | "sort" | (string & {}) | null;
+    user?: string;
+    session_id?: string;
+    trace?: TraceConfig;
+    frequency_penalty?: number | null;
+    logit_bias?: Record<string, number> | null;
+    logprobs?: boolean | null;
+    top_logprobs?: number | null;
+    max_completion_tokens?: number | null;
+    max_tokens?: number | null;
+    metadata?: Record<string, string>;
+    presence_penalty?: number | null;
+    reasoning?: {
+      effort?: "xhigh" | "high" | "medium" | "low" | "minimal" | "none" | (string & {}) | null;
+      summary?: ReasoningSummaryVerbosity | null;
+    };
+    response_format?: {
+      type: "text";
+    } | {
+      type: "json_object";
+    } | ResponseFormatJSONSchema | ResponseFormatTextGrammar | {
+      type: "python";
+    };
+    seed?: number | null;
+    stop?: string | string[] | null;
+    stream?: boolean;
+    stream_options?: ChatStreamOptions | null;
+    temperature?: number | null;
+    parallel_tool_calls?: boolean | null;
+    tool_choice?: ToolChoiceOption;
+    tools?: ToolDefinitionJson[];
+    top_p?: number | null;
+    debug?: {
+      echo_upstream_body?: boolean;
+    };
+    image_config?: Record<string, string | number | unknown[]>;
+    modalities?: Array<"text" | "image" | (string & {})>;
+  }
+  export interface ChatResponseChoice {
+    finish_reason: ChatCompletionFinishReason | null;
+    index: number;
+    message: AssistantMessage;
+    logprobs?: ChatMessageTokenLogprobs | null;
+  }
+  export interface ChatResponse {
+    id: string;
+    choices: ChatResponseChoice[];
+    created: number;
+    model: string;
+    object: "chat.completion";
+    system_fingerprint?: string | null;
+    usage?: ChatGenerationTokenUsage;
+  }
+  export interface ChatStreamingMessageChunk {
+    role?: "assistant";
+    content?: string | null;
+    reasoning?: string | null;
+    refusal?: string | null;
+    tool_calls?: ChatStreamingMessageToolCall[];
+    reasoning_details?: ReasoningDetail[];
+  }
+  export interface ChatStreamingChoice {
+    delta: ChatStreamingMessageChunk;
+    finish_reason: ChatCompletionFinishReason | null;
+    index: number;
+    logprobs?: ChatMessageTokenLogprobs | null;
+  }
+  export interface ChatStreamingResponseChunk {
+    data: {
+      id: string;
+      choices: ChatStreamingChoice[];
+      created: number;
+      model: string;
+      object: "chat.completion.chunk";
+      system_fingerprint?: string | null;
+      error?: {
+        message: string;
+        code: number;
+      };
+      usage?: ChatGenerationTokenUsage;
+    };
+  }
+  export interface ChatError {
+    error: {
+      code: string | number | null;
+      message: string;
+      param?: string | null;
+      type?: string | null;
+    };
+  }
+  export {};
+}
+//#endregion
+export { OpenRouter };
+//# sourceMappingURL=api-types.d.ts.map

package/dist/api-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-types.d.ts","names":[],"sources":["../src/api-types.ts"],"mappings":";kBAMiB,UAAA;EAAA;EAAA,YAMH,SAAA;;;;;cAMA,cAAA;EAAA,YAMA,yBAAA;EAAA,YAMA,cAAA;EAAA,YAEA,YAAA;EAAA,YAYA,YAAA;EAAA,YAEA,YAAA;EAAA,YA4EA,0BAAA;EAAA,YAQA,qBAAA;EAAA,iBAaK,kCAAA;IACf,IAAA;IACA,GAAA;EAAA;EAAA,iBAOe,0BAAA;IACf,IAAA;IACA,IAAA;IACA,aAAA,GAAgB,kCAAA;EAAA;EAAA,iBAGD,2BAAA;IACf,IAAA;IACA,SAAA;MACE,GAAA;MACA,MAAA;IAAA;EAAA;EAAA,iBAIa,2BAAA;IACf,IAAA;IACA,WAAA;MAAe,IAAA;MAAc,MAAA;IAAA;EAAA;EAAA,YAGnB,2BAAA;IACN,IAAA;IAAqB,SAAA;MAAa,GAAA;IAAA;EAAA;IAClC,IAAA;IAAmB,SAAA;MAAa,GAAA;IAAA;EAAA;EAkOpB;EAAA,YA/NN,sBAAA,GACR,0BAAA,GACA,2BAAA,GACA,2BAAA,GACA,2BAAA;EAAA,UAMM,mBAAA;IACR,EAAA;IACA,MAAA,GAAS,qBAAA;IACT,KAAA;EAAA;EAAA,iBAGe,sBAAA,SAA+B,mBAAA;IAC9C,IAAA;IACA,OAAA;EAAA;EAAA,iBAGe,wBAAA,SAAiC,mBAAA;IAChD,IAAA;IACA,IAAA;EAAA;EAAA,iBAGe,mBAAA,SAA4B,mBAAA;IAC3C,IAAA;IACA,IAAA;IACA,SAAA;EAAA;EAAA,YAGU,eAAA,GACR,sBAAA,GACA,wBAAA,GACA,mBAAA;EAAA,iBAMa,aAAA;IACf,IAAA;IACA,OAAA,WAAkB,0BAAA;IAClB,IAAA;EAAA;EAAA,iBAGe,WAAA;IACf,IAAA;IACA,OAAA,WAAkB,sBAAA;IAClB,IAAA;EAAA;EAAA,iBAGe,gBAAA;IACf,IAAA;IACA,OAAA,WAAkB,0BAAA;IAClB,IAAA;EAAA;EAAA,iBAGe,gBAAA;IACf,IAAA;IACA,OAAA,YAAmB,sBAAA;IACnB,IAAA;IACA,UAAA,GAAa,mBAAA;IACb,OAAA;IACA,SAAA;IACA,iBAAA,GAAoB,eAAA;IACpB,MAAA,GAAS,KAAA;MAAQ,SAAA;QAAa,GAAA;MAAA;IAAA;EAAA;EAAA,iBAGf,mBAAA;IACf,IAAA;IACA,OAAA,WAAkB,sBAAA;IAClB,YAAA;EAAA;EAxGA;EAAA,YA4GU,OAAA,GACR,aAAA,GACA,WAAA,GACA,gBAAA,GACA,gBAAA,GACA,mBAAA;EAAA,iBAMa,mBAAA;IACf,EAAA;IACA,IAAA;IACA,QAAA;MAAY,IAAA;MAAc,SAAA;IAAA;EAAA;EAAA,iBAGX,4BAAA;IACf,KAAA;IACA,EAAA;IACA,IAAA;IACA,QAAA;MAAa,IAAA;MAAe,SAAA;IAAA;EAAA;EAAA,iBAOb,kBAAA;IACf,IAAA;IACA,QAAA;MACE,IAAA;MACA,WAAA;MACA,UAAA,GAAa,MAAA;MACb,MAAA;IAAA;IAEF,aAAA,GAAgB,kCAAA;EAAA;EAAA,iBAGD,eAAA;IACf,IAAA;IACA,QAAA;MAAY,IAAA;IAAA;EAAA;EAAA,YAGF,gBAAA,kCAAkD,eAAA;EAAA,iBAM7C,gBAAA;IACf,IAAA;IACA,WAAA;IACA,MAAA,GAAS,MAAA;IACT,MAAA;EAAA;EAAA,iBAGe,wBAAA;IACf,IAAA;IACA,WAAA,EAAa,gBAAA;EAAA;EAAA,iBAGE,yBAAA;IACf,IAAA;IACA,OAAA;EAAA;EAAA,iBAOe,uBAAA;IACf,KAAA;IACA,OAAA;IACA,KAAA;IACA,YAAA,EAAc,KAAA;MACZ,KAAA;MACA,OAAA;MACA,KAAA;IAAA;EAAA;EAAA,iBAIa,wBAAA;IACf,OAAA,EAAS,uBAAA;IACT,OAAA,EAAS,uBAAA;EAAA;EAAA,iBAOM,wBAAA;IACf,iBAAA;IACA,aAAA;IACA,YAAA;IACA,yBAAA;MACE,gBAAA;MACA,YAAA;MACA,0BAAA;MACA,0BAAA;IAAA;IAEF,qBAAA;MACE,aAAA;MACA,kBAAA;MACA,YAAA;MACA,YAAA;IAAA;EAAA;EAAA,iBAQa,wBAAA;IACf,GAAA;IACA,GAAA;IACA,GAAA;IACA,GAAA;EAAA;EAAA,iBAGe,2BAAA;IACf,GAAA;IACA,GAAA;IACA,GAAA;IACA,GAAA;EAAA;EAAA,YAGU,mBAAA,YAA+B,wBAAA;EAAA,YAC/B,sBAAA,YAAkC,2BAAA;EAAA,iBAE7B,kBAAA;IACf,EAAA,GAAK,YAAA;IACL,SAAA;EAAA;EAAA,YAGU,iBAAA,GAAoB,YAAA,GAAe,kBAAA;EAAA,iBAE9B,mBAAA;IACf,eAAA;IACA,kBAAA;IACA,eAAA,GAAkB,cAAA;IAClB,GAAA;IACA,wBAAA;IACA,KAAA,GAAQ,KAAA,CAAM,YAAA;IACd,IAAA,GAAO,KAAA,CAAM,YAAA;IACb,MAAA,GAAS,KAAA,CAAM,YAAA;IACf,aAAA,GAAgB,YAAA;IAChB,IAAA,GAAO,iBAAA;IACP,SAAA;MACE,MAAA,GAAS,cAAA;MACT,UAAA,GAAa,cAAA;MACb,KAAA,GAAQ,cAAA;MACR,KAAA,GAAQ,cAAA;MACR,OAAA,GAAU,cAAA;IAAA;IAEZ,wBAAA,GAA2B,sBAAA;IAC3B,qBAAA,GAAwB,mBAAA;EAAA;EAAA,iBAOT,gBAAA;IACf,EAAA;IACA,OAAA;IACA,cAAA;EAAA;EAAA,iBAGe,gBAAA;IACf,EAAA;EAAA;EAAA,iBAGe,SAAA;IACf,EAAA;IACA,OAAA;IACA,WAAA;IACA,aAAA;IACA,MAAA;EAAA;EAAA,iBAGe,gBAAA;IACf,EAAA;IACA,OAAA;IACA,GAAA;MACE,MAAA;IAAA;EAAA;EAAA,iBAIa,qBAAA;IACf,EAAA;IACA,OAAA;EAAA;EAAA,YAGU,gBAAA,GACR,gBAAA,GACA,gBAAA,GACA,SAAA,GACA,gBAAA,GACA,qBAAA;IACE,EAAA;IAAA,CAAa,GAAA;EAAA;EAAA,iBAMF,WAAA;IACf,QAAA;IACA,UAAA;IACA,SAAA;IACA,eAAA;IACA,cAAA;IAAA,CACC,GAAA;EAAA;EAAA,iBAOc,iBAAA;IACf,aAAA;EAAA;EAAA,iBAOe,oBAAA;IACf,QAAA,EAAU,OAAA;IACV,KAAA,GAAQ,SAAA;IACR,MAAA,GAAS,SAAA;IACT,QAAA,GAAW,mBAAA;IACX,OAAA,GAAU,gBAAA;IACV,KAAA;IACA,IAAA;IACA,UAAA;IACA,KAAA,GAAQ,WAAA;IACR,iBAAA;IACA,UAAA,GAAa,MAAA;IACb,QAAA;IACA,YAAA;IACA,qBAAA;IACA,UAAA;IACA,QAAA,GAAW,MAAA;IACX,gBAAA;IACA,SAAA;MACE,MAAA;MASA,OAAA,GAAU,yBAAA;IAAA;IAEZ,eAAA;MACM,IAAA;IAAA;MACA,IAAA;IAAA,IACF,wBAAA,GACA,yBAAA;MACE,IAAA;IAAA;IACN,IAAA;IACA,IAAA;IACA,MAAA;IACA,cAAA,GAAiB,iBAAA;IACjB,WAAA;IACA,mBAAA;IACA,WAAA,GAAc,gBAAA;IACd,KAAA,GAAQ,kBAAA;IACR,KAAA;IACA,KAAA;MAAU,kBAAA;IAAA;IACV,YAAA,GAAe,MAAA;IACf,UAAA,GAAa,KAAA;EAAA;EAAA,iBAOE,kBAAA;IACf,aAAA,EAAe,0BAAA;IACf,KAAA;IACA,OAAA,EAAS,gBAAA;IACT,QAAA,GAAW,wBAAA;EAAA;EAAA,iBAGI,YAAA;IACf,EAAA;IACA,OAAA,EAAS,kBAAA;IACT,OAAA;IACA,KAAA;IACA,MAAA;IACA,kBAAA;IACA,KAAA,GAAQ,wBAAA;EAAA;EAAA,iBAOO,yBAAA;IACf,IAAA;IACA,OAAA;IACA,SAAA;IACA,OAAA;IACA,UAAA,GAAa,4BAAA;IACb,iBAAA,GAAoB,eAAA;EAAA;EAAA,iBAGL,mBAAA;IACf,KAAA,EAAO,yBAAA;IACP,aAAA,EAAe,0BAAA;IACf,KAAA;IACA,QAAA,GAAW,wBAAA;EAAA;EAAA,iBAGI,0BAAA;IACf,IAAA;MACE,EAAA;MACA,OAAA,EAAS,mBAAA;MACT,OAAA;MACA,KAAA;MACA,MAAA;MACA,kBAAA;MACA,KAAA;QAAU,OAAA;QAAiB,IAAA;MAAA;MAC3B,KAAA,GAAQ,wBAAA;IAAA;EAAA;EAAA,iBAQK,SAAA;IACf,KAAA;MACE,IAAA;MACA,OAAA;MACA,KAAA;MACA,IAAA;IAAA;EAAA;EAAA;AAAA"}