@effect/ai-openrouter 4.0.0-beta.65 → 4.0.0-beta.67

package/dist/OpenRouterLanguageModel.d.ts

@@ -26,10 +26,6 @@ declare const Config_base: Context.ServiceClass<Config, "@effect/ai-openrouter/O
         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;
@@ -39,12 +35,16 @@ declare const Config_base: Context.ServiceClass<Config, "@effect/ai-openrouter/O
         readonly only?: readonly string[] | null;
         readonly ignore?: readonly string[] | null;
         readonly quantizations?: readonly ("int4" | "int8" | "fp4" | "fp6" | "fp8" | "fp16" | "bf16" | "fp32" | "unknown")[] | null;
+        readonly sort?: "price" | "throughput" | "latency" | {
+            readonly by?: "price" | "throughput" | "latency" | null;
+            readonly partition?: "none" | "model" | null;
+        } | null;
         readonly max_price?: {
-            readonly image?: unknown;
-            readonly request?: unknown;
-            readonly audio?: unknown;
             readonly prompt?: unknown;
             readonly completion?: unknown;
+            readonly image?: unknown;
+            readonly audio?: unknown;
+            readonly request?: unknown;
         };
         readonly preferred_min_throughput?: number | {
             readonly p50?: number | null;
@@ -68,9 +68,9 @@ declare const Config_base: Context.ServiceClass<Config, "@effect/ai-openrouter/O
     } | {
         readonly id: "web";
         readonly enabled?: boolean;
-        readonly engine?: "native" | "exa";
         readonly max_results?: number;
         readonly search_prompt?: string;
+        readonly engine?: "native" | "exa";
     } | {
         readonly id: "file-parser";
         readonly enabled?: boolean;
@@ -101,25 +101,40 @@ declare const Config_base: Context.ServiceClass<Config, "@effect/ai-openrouter/O
 /**
  * Service definition for OpenRouter language model configuration.
  *
- * @since 1.0.0
  * @category services
+ * @since 4.0.0
  */
 export declare class Config extends Config_base {
 }
 /**
- * @since 1.0.0
+ * OpenRouter assistant reasoning detail blocks preserved for multi-turn
+ * conversations.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type ReasoningDetails = Exclude<typeof Generated.AssistantMessage.Encoded["reasoning_details"], undefined>;
 /**
- * @since 1.0.0
+ * File annotations emitted on OpenRouter assistant messages and exposed in
+ * finish metadata.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type FileAnnotation = Extract<NonNullable<typeof Generated.AssistantMessage.fields.annotations.Type>[number], {
     type: "file";
 }>;
 declare module "effect/unstable/ai/Prompt" {
+    /**
+     * OpenRouter-specific options for system messages.
+     *
+     * These options are used when translating system instructions into
+     * OpenRouter chat messages.
+     */
     interface SystemMessageOptions extends ProviderOptions {
+        /**
+         * Provider-specific options sent to OpenRouter for the system message.
+         */
         readonly openrouter?: {
             /**
              * A breakpoint which marks the end of reusable content eligible for caching.
@@ -127,7 +142,16 @@ declare module "effect/unstable/ai/Prompt" {
             readonly cacheControl?: typeof Generated.ChatMessageContentItemCacheControl.Encoded | null;
         } | null;
     }
+    /**
+     * OpenRouter-specific options for user messages.
+     *
+     * These options are used when translating user content into OpenRouter chat
+     * messages.
+     */
     interface UserMessageOptions extends ProviderOptions {
+        /**
+         * Provider-specific options sent to OpenRouter for the user message.
+         */
         readonly openrouter?: {
             /**
              * A breakpoint which marks the end of reusable content eligible for caching.
@@ -135,7 +159,16 @@ declare module "effect/unstable/ai/Prompt" {
             readonly cacheControl?: typeof Generated.ChatMessageContentItemCacheControl.Encoded | null;
         } | null;
     }
+    /**
+     * OpenRouter-specific options for assistant messages.
+     *
+     * Preserves reasoning metadata when assistant messages are replayed in later
+     * OpenRouter requests.
+     */
     interface AssistantMessageOptions extends ProviderOptions {
+        /**
+         * Provider-specific options sent to OpenRouter for the assistant message.
+         */
         readonly openrouter?: {
             /**
              * A breakpoint which marks the end of reusable content eligible for caching.
@@ -147,7 +180,16 @@ declare module "effect/unstable/ai/Prompt" {
             readonly reasoningDetails?: ReasoningDetails | null;
         } | null;
     }
+    /**
+     * OpenRouter-specific options for tool messages.
+     *
+     * These options are used when converting tool results into OpenRouter chat
+     * messages.
+     */
     interface ToolMessageOptions extends ProviderOptions {
+        /**
+         * Provider-specific options sent to OpenRouter for the tool message.
+         */
         readonly openrouter?: {
             /**
              * A breakpoint which marks the end of reusable content eligible for caching.
@@ -155,7 +197,15 @@ declare module "effect/unstable/ai/Prompt" {
             readonly cacheControl?: typeof Generated.ChatMessageContentItemCacheControl.Encoded | null;
         } | null;
     }
+    /**
+     * OpenRouter-specific options for text prompt parts.
+     *
+     * Use these options to control how text content is sent to OpenRouter.
+     */
     interface TextPartOptions extends ProviderOptions {
+        /**
+         * Provider-specific options sent to OpenRouter for the text part.
+         */
         readonly openrouter?: {
             /**
              * A breakpoint which marks the end of reusable content eligible for caching.
@@ -163,7 +213,16 @@ declare module "effect/unstable/ai/Prompt" {
             readonly cacheControl?: typeof Generated.ChatMessageContentItemCacheControl.Encoded | null;
         } | null;
     }
+    /**
+     * OpenRouter-specific options for reasoning prompt parts.
+     *
+     * Preserves provider reasoning blocks so reasoning-aware conversations can
+     * continue across OpenRouter requests.
+     */
     interface ReasoningPartOptions extends ProviderOptions {
+        /**
+         * Provider-specific options sent to OpenRouter for the reasoning part.
+         */
         readonly openrouter?: {
             /**
              * A breakpoint which marks the end of reusable content eligible for caching.
@@ -175,7 +234,15 @@ declare module "effect/unstable/ai/Prompt" {
             readonly reasoningDetails?: ReasoningDetails | null;
         } | null;
     }
+    /**
+     * OpenRouter-specific options for file prompt parts.
+     *
+     * Controls file naming and prompt caching for files sent to OpenRouter.
+     */
     interface FilePartOptions extends ProviderOptions {
+        /**
+         * Provider-specific options sent to OpenRouter for the file part.
+         */
         readonly openrouter?: {
             /**
              * The name to give to the file. Will be prioritized over the file name
@@ -188,7 +255,16 @@ declare module "effect/unstable/ai/Prompt" {
             readonly cacheControl?: typeof Generated.ChatMessageContentItemCacheControl.Encoded | null;
         } | null;
     }
+    /**
+     * OpenRouter-specific options for tool call prompt parts.
+     *
+     * Preserves reasoning details associated with tool calls when a conversation
+     * is sent back to OpenRouter.
+     */
     interface ToolCallPartOptions extends ProviderOptions {
+        /**
+         * Provider-specific options sent to OpenRouter for the tool call part.
+         */
         readonly openrouter?: {
             /**
              * Reasoning details associated with the tool call part.
@@ -196,7 +272,15 @@ declare module "effect/unstable/ai/Prompt" {
             readonly reasoningDetails?: ReasoningDetails | null;
         } | null;
     }
+    /**
+     * OpenRouter-specific options for tool result prompt parts.
+     *
+     * Controls prompt caching for tool results sent to OpenRouter.
+     */
     interface ToolResultPartOptions extends ProviderOptions {
+        /**
+         * Provider-specific options sent to OpenRouter for the tool result part.
+         */
         readonly openrouter?: {
             /**
              * A breakpoint which marks the end of reusable content eligible for caching.
@@ -206,52 +290,138 @@ declare module "effect/unstable/ai/Prompt" {
     }
 }
 declare module "effect/unstable/ai/Response" {
+    /**
+     * OpenRouter metadata attached to completed reasoning response parts.
+     *
+     * Preserves provider reasoning details that can be sent back in later turns.
+     */
     interface ReasoningPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned for the reasoning part.
+         */
         readonly openrouter?: {
+            /**
+             * Reasoning details emitted by the underlying provider for this part.
+             */
             readonly reasoningDetails?: ReasoningDetails | null;
         } | null;
     }
+    /**
+     * OpenRouter metadata emitted when a streamed reasoning part starts.
+     *
+     * Carries the first reasoning detail chunk when OpenRouter exposes one.
+     */
     interface ReasoningStartPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned for the streamed reasoning start.
+         */
         readonly openrouter?: {
+            /**
+             * Reasoning details emitted by the underlying provider for this part.
+             */
             readonly reasoningDetails?: ReasoningDetails | null;
         } | null;
     }
+    /**
+     * OpenRouter metadata emitted for streamed reasoning deltas.
+     *
+     * Carries provider reasoning detail chunks as they arrive from OpenRouter.
+     */
     interface ReasoningDeltaPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned for the streamed reasoning delta.
+         */
         readonly openrouter?: {
+            /**
+             * Reasoning details emitted by the underlying provider for this delta.
+             */
             readonly reasoningDetails?: ReasoningDetails | null;
         } | null;
     }
+    /**
+     * OpenRouter metadata attached to tool-call response parts.
+     *
+     * Associates tool calls with provider reasoning details when the model emits
+     * reasoning and tool calls together.
+     */
     interface ToolCallPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned for the tool call.
+         */
         readonly openrouter?: {
+            /**
+             * Reasoning details associated with this tool call.
+             */
             readonly reasoningDetails?: ReasoningDetails | null;
         } | null;
     }
+    /**
+     * OpenRouter metadata attached to URL source citations.
+     *
+     * Includes citation text and offsets returned by providers that support URL
+     * annotations.
+     */
     interface UrlSourcePartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific citation metadata returned for the URL source.
+         */
         readonly openrouter?: {
+            /**
+             * The cited source content returned by the provider.
+             */
             readonly content?: string | null;
+            /**
+             * The zero-based start index of the citation in the generated text.
+             */
             readonly startIndex?: number | null;
+            /**
+             * The zero-based end index of the citation in the generated text.
+             */
             readonly endIndex?: number | null;
         } | null;
     }
+    /**
+     * OpenRouter metadata attached to finish response parts.
+     *
+     * Exposes provider response details that are not represented by the common
+     * Effect AI finish part fields.
+     */
     interface FinishPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned when the OpenRouter response finishes.
+         */
         readonly openrouter?: {
+            /**
+             * Provider fingerprint for the backend configuration that served the request.
+             */
             readonly systemFingerprint?: string | null;
+            /**
+             * Raw token usage reported by OpenRouter.
+             */
             readonly usage?: typeof Generated.ChatGenerationTokenUsage.Encoded | null;
+            /**
+             * File annotations returned by the provider.
+             */
             readonly annotations?: ReadonlyArray<FileAnnotation> | null;
+            /**
+             * The OpenRouter provider that served the request, when reported.
+             */
             readonly provider?: string | null;
         } | null;
     }
 }
 /**
- * @since 1.0.0
+ * Creates an AI model descriptor for an OpenRouter language model.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 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
+ * @since 4.0.0
  */
 export declare const make: (args_0: {
     readonly model: string;
@@ -260,8 +430,8 @@ export declare const make: (args_0: {
 /**
  * Creates a layer for the OpenRouter language model.
  *
- * @since 1.0.0
  * @category layers
+ * @since 4.0.0
  */
 export declare const layer: (options: {
     readonly model: string;
@@ -270,22 +440,22 @@ export declare const layer: (options: {
 /**
  * Provides config overrides for OpenRouter language model operations.
  *
- * @since 1.0.0
  * @category configuration
+ * @since 4.0.0
  */
 export declare const withConfigOverride: {
     /**
      * Provides config overrides for OpenRouter language model operations.
      *
-     * @since 1.0.0
      * @category configuration
+     * @since 4.0.0
      */
     (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
+     * @since 4.0.0
      */
     <A, E, R>(self: Effect.Effect<A, E, R>, overrides: typeof Config.Service): Effect.Effect<A, E, Exclude<R, Config>>;
 };

package/dist/OpenRouterLanguageModel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OpenRouterLanguageModel.d.ts","sourceRoot":"","sources":["../src/OpenRouterLanguageModel.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AAEzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAGvC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AAYrC,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,CACf,CAAA;AAEzD;;;;;GAKG;AACH,eAAO,MAAM,IAAI;oBACC,MAAM;sBACJ,IAAI,CAAC,OAAO,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,SAAS;mEA2DlE,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"}
+{"version":3,"file":"OpenRouterLanguageModel.d.ts","sourceRoot":"","sources":["../src/OpenRouterLanguageModel.ts"],"names":[],"mappings":"AAyBA,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AAEzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAGvC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AAYrC,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;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC,OAAO,SAAS,CAAC,gBAAgB,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,SAAS,CAAC,CAAA;AAEjH;;;;;;GAMG;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;;;;;OAKG;IACH,UAAiB,oBAAqB,SAAQ,eAAe;QAC3D;;WAEG;QACH,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;;;;;OAKG;IACH,UAAiB,kBAAmB,SAAQ,eAAe;QACzD;;WAEG;QACH,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;;;;;OAKG;IACH,UAAiB,uBAAwB,SAAQ,eAAe;QAC9D;;WAEG;QACH,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;;;;;OAKG;IACH,UAAiB,kBAAmB,SAAQ,eAAe;QACzD;;WAEG;QACH,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;;;;OAIG;IACH,UAAiB,eAAgB,SAAQ,eAAe;QACtD;;WAEG;QACH,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;;;;;OAKG;IACH,UAAiB,oBAAqB,SAAQ,eAAe;QAC3D;;WAEG;QACH,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;;;;OAIG;IACH,UAAiB,eAAgB,SAAQ,eAAe;QACtD;;WAEG;QACH,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;;;;;OAKG;IACH,UAAiB,mBAAoB,SAAQ,eAAe;QAC1D;;WAEG;QACH,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB;;eAEG;YACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;SACpD,GAAG,IAAI,CAAA;KACT;IAED;;;;OAIG;IACH,UAAiB,qBAAsB,SAAQ,eAAe;QAC5D;;WAEG;QACH,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;;;;OAIG;IACH,UAAiB,qBAAsB,SAAQ,gBAAgB;QAC7D;;WAEG;QACH,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB;;eAEG;YACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;SACpD,GAAG,IAAI,CAAA;KACT;IAED;;;;OAIG;IACH,UAAiB,0BAA2B,SAAQ,gBAAgB;QAClE;;WAEG;QACH,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB;;eAEG;YACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;SACpD,GAAG,IAAI,CAAA;KACT;IAED;;;;OAIG;IACH,UAAiB,0BAA2B,SAAQ,gBAAgB;QAClE;;WAEG;QACH,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB;;eAEG;YACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;SACpD,GAAG,IAAI,CAAA;KACT;IAED;;;;;OAKG;IACH,UAAiB,oBAAqB,SAAQ,gBAAgB;QAC5D;;WAEG;QACH,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB;;eAEG;YACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;SACpD,GAAG,IAAI,CAAA;KACT;IAED;;;;;OAKG;IACH,UAAiB,qBAAsB,SAAQ,gBAAgB;QAC7D;;WAEG;QACH,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB;;eAEG;YACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAChC;;eAEG;YACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YACnC;;eAEG;YACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAClC,GAAG,IAAI,CAAA;KACT;IAED;;;;;OAKG;IACH,UAAiB,kBAAmB,SAAQ,gBAAgB;QAC1D;;WAEG;QACH,QAAQ,CAAC,UAAU,CAAC,EAAE;YACpB;;eAEG;YACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC1C;;eAEG;YACH,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,SAAS,CAAC,wBAAwB,CAAC,OAAO,GAAG,IAAI,CAAA;YACzE;;eAEG;YACH,QAAQ,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,GAAG,IAAI,CAAA;YAC3D;;eAEG;YACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAClC,GAAG,IAAI,CAAA;KACT;CACF;AAMD;;;;;GAKG;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,CACf,CAAA;AAEzD;;;;;GAKG;AACH,eAAO,MAAM,IAAI;oBACC,MAAM;sBACJ,IAAI,CAAC,OAAO,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,SAAS;mEA2DlE,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"}

package/dist/OpenRouterLanguageModel.js

@@ -1,5 +1,25 @@
 /**
- * @since 1.0.0
+ * The `OpenRouterLanguageModel` module provides constructors for using
+ * OpenRouter chat completion models through the Effect AI `LanguageModel`
+ * interface. It adapts Effect prompts, tools, structured output schemas, file
+ * parts, reasoning details, cache-control hints, and telemetry annotations into
+ * the OpenRouter request and response formats.
+ *
+ * Use this module when an application wants to select an OpenRouter model by
+ * name while keeping the rest of its AI workflow provider-agnostic. The
+ * exported layer and model constructors install a `LanguageModel` service backed
+ * by `OpenRouterClient`, and `withConfigOverride` can scope per-request
+ * OpenRouter options such as sampling, routing, tool use, or JSON schema
+ * behavior.
+ *
+ * OpenRouter routes requests to many underlying providers, so model support for
+ * images, files, tools, structured outputs, caching, and reasoning metadata can
+ * vary. Provider-specific prompt and response metadata is preserved under the
+ * `openrouter` option namespace so multi-turn conversations can round-trip
+ * details such as reasoning blocks and file annotations when the selected model
+ * supports them.
+ *
+ * @since 4.0.0
  */
 /** @effect-diagnostics preferSchemaOverJson:skip-file */
 import * as Arr from "effect/Array";
@@ -30,16 +50,18 @@ import { OpenRouterClient } from "./OpenRouterClient.js";
 /**
  * Service definition for OpenRouter language model configuration.
  *
- * @since 1.0.0
  * @category services
+ * @since 4.0.0
  */
 export class Config extends /*#__PURE__*/Context.Service()("@effect/ai-openrouter/OpenRouterLanguageModel/Config") {}
 // =============================================================================
 // Language Model
 // =============================================================================
 /**
- * @since 1.0.0
+ * Creates an AI model descriptor for an OpenRouter language model.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export const model = (model, config) => AiModel.make("openai", model, layer({
   model,
@@ -48,8 +70,8 @@ export const model = (model, config) => AiModel.make("openai", model, layer({
 /**
  * Creates an OpenRouter language model service.
  *
- * @since 1.0.0
  * @category constructors
+ * @since 4.0.0
  */
 export const make = /*#__PURE__*/Effect.fnUntraced(function* ({
   model,
@@ -136,15 +158,15 @@ export const make = /*#__PURE__*/Effect.fnUntraced(function* ({
 /**
  * Creates a layer for the OpenRouter language model.
  *
- * @since 1.0.0
  * @category layers
+ * @since 4.0.0
  */
 export const layer = options => Layer.effect(LanguageModel.LanguageModel, make(options));
 /**
  * Provides config overrides for OpenRouter language model operations.
  *
- * @since 1.0.0
  * @category configuration
+ * @since 4.0.0
  */
 export const withConfigOverride = /*#__PURE__*/dual(2, (self, overrides) => Effect.flatMap(Effect.serviceOption(Config), config => Effect.provideService(self, Config, {
   ...(config._tag === "Some" ? config.value : {}),