@effect/ai-openrouter 0.8.2 → 4.0.0-beta.0

package/dist/OpenRouterLanguageModel.d.ts

@@ -0,0 +1,285 @@
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import * as ServiceMap from "effect/ServiceMap";
+import * as LanguageModel from "effect/unstable/ai/LanguageModel";
+import * as AiModel from "effect/unstable/ai/Model";
+import type * as Generated from "./Generated.ts";
+import { OpenRouterClient } from "./OpenRouterClient.ts";
+declare const Config_base: ServiceMap.ServiceClass<Config, "@effect/ai-openrouter/OpenRouterLanguageModel/Config", {
+    readonly metadata?: {};
+    readonly max_tokens?: number | null;
+    readonly model?: string;
+    readonly user?: string;
+    readonly max_completion_tokens?: number | null;
+    readonly temperature?: number | null;
+    readonly top_p?: number | null;
+    readonly frequency_penalty?: number | null;
+    readonly presence_penalty?: number | null;
+    readonly logit_bias?: {} | null;
+    readonly logprobs?: boolean | null;
+    readonly top_logprobs?: number | null;
+    readonly seed?: number | null;
+    readonly stop?: string | readonly string[] | null;
+    readonly reasoning?: {
+        readonly effort?: "high" | "low" | "medium" | "none" | "xhigh" | "minimal" | null;
+        readonly summary?: "auto" | "concise" | "detailed" | null;
+    };
+    readonly provider?: {
+        readonly sort?: "price" | "throughput" | "latency" | {
+            readonly by?: "price" | "throughput" | "latency" | null;
+            readonly partition?: "none" | "model" | null;
+        } | null;
+        readonly allow_fallbacks?: boolean | null;
+        readonly require_parameters?: boolean | null;
+        readonly data_collection?: "deny" | "allow" | null;
+        readonly zdr?: boolean | null;
+        readonly enforce_distillable_text?: boolean | null;
+        readonly order?: readonly string[] | null;
+        readonly only?: readonly string[] | null;
+        readonly ignore?: readonly string[] | null;
+        readonly quantizations?: readonly ("int4" | "int8" | "fp4" | "fp6" | "fp8" | "fp16" | "bf16" | "fp32" | "unknown")[] | null;
+        readonly max_price?: {
+            readonly image?: unknown;
+            readonly request?: unknown;
+            readonly audio?: unknown;
+            readonly prompt?: unknown;
+            readonly completion?: unknown;
+        };
+        readonly preferred_min_throughput?: number | {
+            readonly p50?: number | null;
+            readonly p75?: number | null;
+            readonly p90?: number | null;
+            readonly p99?: number | null;
+        } | null;
+        readonly preferred_max_latency?: number | {
+            readonly p50?: number | null;
+            readonly p75?: number | null;
+            readonly p90?: number | null;
+            readonly p99?: number | null;
+        } | null;
+    } | null;
+    readonly plugins?: readonly ({
+        readonly id: "auto-router";
+        readonly enabled?: boolean;
+        readonly allowed_models?: readonly string[];
+    } | {
+        readonly id: "moderation";
+    } | {
+        readonly id: "web";
+        readonly enabled?: boolean;
+        readonly engine?: "native" | "exa";
+        readonly max_results?: number;
+        readonly search_prompt?: string;
+    } | {
+        readonly id: "file-parser";
+        readonly enabled?: boolean;
+        readonly pdf?: {
+            readonly engine?: "native" | "mistral-ocr" | "pdf-text";
+        };
+    } | {
+        readonly id: "response-healing";
+        readonly enabled?: boolean;
+    })[];
+    readonly route?: "sort" | "fallback" | null;
+    readonly session_id?: string;
+    readonly models?: readonly string[];
+    readonly image_config?: {};
+    readonly modalities?: readonly ("text" | "image")[];
+    readonly debug?: {
+        readonly echo_upstream_body?: boolean;
+    };
+    readonly strictJsonSchema?: boolean | undefined | undefined;
+}>;
+/**
+ * Service definition for OpenRouter language model configuration.
+ *
+ * @since 1.0.0
+ * @category services
+ */
+export declare class Config extends Config_base {
+}
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export type ReasoningDetails = Exclude<typeof Generated.AssistantMessage.Encoded["reasoning_details"], undefined>;
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export type FileAnnotation = Extract<NonNullable<typeof Generated.AssistantMessage.fields.annotations.Type>[number], {
+    type: "file";
+}>;
+declare module "effect/unstable/ai/Prompt" {
+    interface SystemMessageOptions extends ProviderOptions {
+        readonly openrouter?: {
+            /**
+             * A breakpoint which marks the end of reusable content eligible for caching.
+             */
+            readonly cacheControl?: typeof Generated.ChatMessageContentItemCacheControl.Encoded | null;
+        } | null;
+    }
+    interface UserMessageOptions extends ProviderOptions {
+        readonly openrouter?: {
+            /**
+             * A breakpoint which marks the end of reusable content eligible for caching.
+             */
+            readonly cacheControl?: typeof Generated.ChatMessageContentItemCacheControl.Encoded | null;
+        } | null;
+    }
+    interface AssistantMessageOptions extends ProviderOptions {
+        readonly openrouter?: {
+            /**
+             * A breakpoint which marks the end of reusable content eligible for caching.
+             */
+            readonly cacheControl?: typeof Generated.ChatMessageContentItemCacheControl.Encoded | null;
+            /**
+             * Reasoning details associated with the assistant message.
+             */
+            readonly reasoningDetails?: ReasoningDetails | null;
+        } | null;
+    }
+    interface ToolMessageOptions extends ProviderOptions {
+        readonly openrouter?: {
+            /**
+             * A breakpoint which marks the end of reusable content eligible for caching.
+             */
+            readonly cacheControl?: typeof Generated.ChatMessageContentItemCacheControl.Encoded | null;
+        } | null;
+    }
+    interface TextPartOptions extends ProviderOptions {
+        readonly openrouter?: {
+            /**
+             * A breakpoint which marks the end of reusable content eligible for caching.
+             */
+            readonly cacheControl?: typeof Generated.ChatMessageContentItemCacheControl.Encoded | null;
+        } | null;
+    }
+    interface ReasoningPartOptions extends ProviderOptions {
+        readonly openrouter?: {
+            /**
+             * A breakpoint which marks the end of reusable content eligible for caching.
+             */
+            readonly cacheControl?: typeof Generated.ChatMessageContentItemCacheControl.Encoded | null;
+            /**
+             * Reasoning details associated with the reasoning part.
+             */
+            readonly reasoningDetails?: ReasoningDetails | null;
+        } | null;
+    }
+    interface FilePartOptions extends ProviderOptions {
+        readonly openrouter?: {
+            /**
+             * The name to give to the file. Will be prioritized over the file name
+             * associated with the file part, if present.
+             */
+            readonly fileName?: string | null;
+            /**
+             * A breakpoint which marks the end of reusable content eligible for caching.
+             */
+            readonly cacheControl?: typeof Generated.ChatMessageContentItemCacheControl.Encoded | null;
+        } | null;
+    }
+    interface ToolCallPartOptions extends ProviderOptions {
+        readonly openrouter?: {
+            /**
+             * Reasoning details associated with the tool call part.
+             */
+            readonly reasoningDetails?: ReasoningDetails | null;
+        } | null;
+    }
+    interface ToolResultPartOptions extends ProviderOptions {
+        readonly openrouter?: {
+            /**
+             * A breakpoint which marks the end of reusable content eligible for caching.
+             */
+            readonly cacheControl?: typeof Generated.ChatMessageContentItemCacheControl.Encoded | null;
+        } | null;
+    }
+}
+declare module "effect/unstable/ai/Response" {
+    interface ReasoningPartMetadata extends ProviderMetadata {
+        readonly openrouter?: {
+            readonly reasoningDetails?: ReasoningDetails | null;
+        } | null;
+    }
+    interface ReasoningStartPartMetadata extends ProviderMetadata {
+        readonly openrouter?: {
+            readonly reasoningDetails?: ReasoningDetails | null;
+        } | null;
+    }
+    interface ReasoningDeltaPartMetadata extends ProviderMetadata {
+        readonly openrouter?: {
+            readonly reasoningDetails?: ReasoningDetails | null;
+        } | null;
+    }
+    interface ToolCallPartMetadata extends ProviderMetadata {
+        readonly openrouter?: {
+            readonly reasoningDetails?: ReasoningDetails | null;
+        } | null;
+    }
+    interface UrlSourcePartMetadata extends ProviderMetadata {
+        readonly openrouter?: {
+            readonly content?: string | null;
+            readonly startIndex?: number | null;
+            readonly endIndex?: number | null;
+        } | null;
+    }
+    interface FinishPartMetadata extends ProviderMetadata {
+        readonly openrouter?: {
+            readonly systemFingerprint?: string | null;
+            readonly usage?: typeof Generated.ChatGenerationTokenUsage.Encoded | null;
+            readonly annotations?: ReadonlyArray<FileAnnotation> | null;
+            readonly provider?: string | null;
+        } | null;
+    }
+}
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export declare const model: (model: string, config?: Omit<typeof Config.Service, "model">) => AiModel.Model<"openai", LanguageModel.LanguageModel, OpenRouterClient>;
+/**
+ * Creates an OpenRouter language model service.
+ *
+ * @since 1.0.0
+ * @category constructors
+ */
+export declare const make: (args_0: {
+    readonly model: string;
+    readonly config?: Omit<typeof Config.Service, "model"> | undefined;
+}) => Effect.Effect<LanguageModel.Service, never, OpenRouterClient>;
+/**
+ * Creates a layer for the OpenRouter language model.
+ *
+ * @since 1.0.0
+ * @category layers
+ */
+export declare const layer: (options: {
+    readonly model: string;
+    readonly config?: Omit<typeof Config.Service, "model"> | undefined;
+}) => Layer.Layer<LanguageModel.LanguageModel, never, OpenRouterClient>;
+/**
+ * Provides config overrides for OpenRouter language model operations.
+ *
+ * @since 1.0.0
+ * @category configuration
+ */
+export declare const withConfigOverride: {
+    /**
+     * Provides config overrides for OpenRouter language model operations.
+     *
+     * @since 1.0.0
+     * @category configuration
+     */
+    (overrides: typeof Config.Service): <A, E, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A, E, Exclude<R, Config>>;
+    /**
+     * Provides config overrides for OpenRouter language model operations.
+     *
+     * @since 1.0.0
+     * @category configuration
+     */
+    <A, E, R>(self: Effect.Effect<A, E, R>, overrides: typeof Config.Service): Effect.Effect<A, E, Exclude<R, Config>>;
+};
+export {};
+//# sourceMappingURL=OpenRouterLanguageModel.d.ts.map

package/dist/OpenRouterLanguageModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OpenRouterLanguageModel.d.ts","sourceRoot":"","sources":["../src/OpenRouterLanguageModel.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAGvC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AAKrC,OAAO,KAAK,UAAU,MAAM,mBAAmB,CAAA;AAO/C,OAAO,KAAK,aAAa,MAAM,kCAAkC,CAAA;AACjE,OAAO,KAAK,OAAO,MAAM,0BAA0B,CAAA;AAQnD,OAAO,KAAK,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAEhD,OAAO,EAAuC,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gCA4B3D,OAAO,GAAG,SAAS;;AAtBrD;;;;;GAKG;AACH,qBAAa,MAAO,SAAQ,WAmB+B;CAAG;AAM9D;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC,OAAO,SAAS,CAAC,gBAAgB,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,SAAS,CAAC,CAAA;AAEjH;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,CAClC,WAAW,CAAC,OAAO,SAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,EAC9E;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CACjB,CAAA;AAED,OAAO,QAAQ,2BAA2B,CAAC;IACzC,UAAiB,oBAAqB,SAAQ,eAAe;QAC3D,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB;;eAEG;YACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,SAAS,CAAC,kCAAkC,CAAC,OAAO,GAAG,IAAI,CAAA;SAC3F,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,kBAAmB,SAAQ,eAAe;QACzD,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB;;eAEG;YACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,SAAS,CAAC,kCAAkC,CAAC,OAAO,GAAG,IAAI,CAAA;SAC3F,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,uBAAwB,SAAQ,eAAe;QAC9D,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB;;eAEG;YACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,SAAS,CAAC,kCAAkC,CAAC,OAAO,GAAG,IAAI,CAAA;YAC1F;;eAEG;YACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;SACpD,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,kBAAmB,SAAQ,eAAe;QACzD,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB;;eAEG;YACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,SAAS,CAAC,kCAAkC,CAAC,OAAO,GAAG,IAAI,CAAA;SAC3F,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,eAAgB,SAAQ,eAAe;QACtD,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB;;eAEG;YACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,SAAS,CAAC,kCAAkC,CAAC,OAAO,GAAG,IAAI,CAAA;SAC3F,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,oBAAqB,SAAQ,eAAe;QAC3D,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB;;eAEG;YACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,SAAS,CAAC,kCAAkC,CAAC,OAAO,GAAG,IAAI,CAAA;YAC1F;;eAEG;YACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;SACpD,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,eAAgB,SAAQ,eAAe;QACtD,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB;;;eAGG;YACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YACjC;;eAEG;YACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,SAAS,CAAC,kCAAkC,CAAC,OAAO,GAAG,IAAI,CAAA;SAC3F,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,mBAAoB,SAAQ,eAAe;QAC1D,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB;;eAEG;YACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;SACpD,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,qBAAsB,SAAQ,eAAe;QAC5D,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB;;eAEG;YACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,SAAS,CAAC,kCAAkC,CAAC,OAAO,GAAG,IAAI,CAAA;SAC3F,GAAG,IAAI,CAAA;KACT;CACF;AAED,OAAO,QAAQ,6BAA6B,CAAC;IAC3C,UAAiB,qBAAsB,SAAQ,gBAAgB;QAC7D,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;SACpD,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,0BAA2B,SAAQ,gBAAgB;QAClE,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;SACpD,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,0BAA2B,SAAQ,gBAAgB;QAClE,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;SACpD,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,oBAAqB,SAAQ,gBAAgB;QAC5D,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;SACpD,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,qBAAsB,SAAQ,gBAAgB;QAC7D,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAChC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YACnC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAClC,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,kBAAmB,SAAQ,gBAAgB;QAC1D,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC1C,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,SAAS,CAAC,wBAAwB,CAAC,OAAO,GAAG,IAAI,CAAA;YACzE,QAAQ,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,GAAG,IAAI,CAAA;YAC3D,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAClC,GAAG,IAAI,CAAA;KACT;CACF;AAMD;;;GAGG;AACH,eAAO,MAAM,KAAK,GAChB,OAAO,MAAM,EACb,SAAS,IAAI,CAAC,OAAO,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,KAC5C,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,aAAa,CAAC,aAAa,EAAE,gBAAgB,CACtB,CAAA;AAElD;;;;;GAKG;AACH,eAAO,MAAM,IAAI;oBACC,MAAM;sBACJ,IAAI,CAAC,OAAO,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,SAAS;mEA6DlE,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,KAAK,GAAI,SAAS;IAC7B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,OAAO,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;CACnE,KAAG,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,aAAa,EAAE,KAAK,EAAE,gBAAgB,CACV,CAAA;AAE1D;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,EAAE;IAC/B;;;;;OAKG;IACH,CAAC,SAAS,EAAE,OAAO,MAAM,CAAC,OAAO,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAA;IACtH;;;;;OAKG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAA;CAwBhH,CAAA"}