@effect/ai-openai-compat 4.0.0-beta.66 → 4.0.0-beta.68

package/dist/OpenAiLanguageModel.d.ts

@@ -4,7 +4,7 @@
  * Provides a LanguageModel implementation for OpenAI's chat completions API,
  * supporting text generation, structured output, tool calling, and streaming.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 import * as Context from "effect/Context";
 import * as Effect from "effect/Effect";
@@ -63,13 +63,22 @@ declare const Config_base: Context.ServiceClass<Config, "@effect/ai-openai-compa
 /**
  * Service definition for OpenAI language model configuration.
  *
- * @since 1.0.0
  * @category context
+ * @since 4.0.0
  */
 export declare class Config extends Config_base {
 }
 declare module "effect/unstable/ai/Prompt" {
+    /**
+     * OpenAI-compatible options for file prompt parts.
+     *
+     * @category request
+     * @since 4.0.0
+     */
     interface FilePartOptions extends ProviderOptions {
+        /**
+         * Provider-specific file options for OpenAI-compatible APIs.
+         */
         readonly openai?: {
             /**
              * The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`.
@@ -77,7 +86,16 @@ declare module "effect/unstable/ai/Prompt" {
             readonly imageDetail?: ImageDetail | null;
         } | null;
     }
+    /**
+     * OpenAI-compatible options for reasoning prompt parts.
+     *
+     * @category request
+     * @since 4.0.0
+     */
     interface ReasoningPartOptions extends ProviderOptions {
+        /**
+         * Provider-specific reasoning options for OpenAI-compatible APIs.
+         */
         readonly openai?: {
             /**
              * The ID of the item to reference.
@@ -91,38 +109,65 @@ declare module "effect/unstable/ai/Prompt" {
             readonly encryptedContent?: string | null;
         } | null;
     }
+    /**
+     * OpenAI-compatible options for assistant tool-call prompt parts.
+     *
+     * @category request
+     * @since 4.0.0
+     */
     interface ToolCallPartOptions extends ProviderOptions {
+        /**
+         * Provider-specific tool-call options for OpenAI-compatible APIs.
+         */
         readonly openai?: {
             /**
              * The ID of the item to reference.
              */
             readonly itemId?: string | null;
             /**
-             * The status of item.
+             * The status to send for the tool-call item.
              */
             readonly status?: MessageStatus | null;
         } | null;
     }
+    /**
+     * OpenAI-compatible options for tool-result prompt parts.
+     *
+     * @category request
+     * @since 4.0.0
+     */
     interface ToolResultPartOptions extends ProviderOptions {
+        /**
+         * Provider-specific tool-result options for OpenAI-compatible APIs.
+         */
         readonly openai?: {
             /**
              * The ID of the item to reference.
              */
             readonly itemId?: string | null;
             /**
-             * The status of item.
+             * The status to send for the tool-result item.
              */
             readonly status?: MessageStatus | null;
         } | null;
     }
+    /**
+     * OpenAI-compatible options for text prompt parts.
+     *
+     * @category request
+     * @since 4.0.0
+     */
     interface TextPartOptions extends ProviderOptions {
+        /**
+         * Provider-specific text options for OpenAI-compatible APIs.
+         */
         readonly openai?: {
             /**
              * The ID of the item to reference.
              */
             readonly itemId?: string | null;
             /**
-             * The status of item.
+             * The status to send for the text item.
              */
             readonly status?: MessageStatus | null;
             /**
@@ -133,8 +178,20 @@ declare module "effect/unstable/ai/Prompt" {
     }
 }
 declare module "effect/unstable/ai/Response" {
+    /**
+     * OpenAI-compatible metadata attached to a complete text response part.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface TextPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned for the text part.
+         */
         readonly openai?: {
+            /**
+             * The OpenAI item ID associated with the text part.
+             */
             readonly itemId?: string | null;
             /**
              * If the model emits a refusal content part, the refusal explanation
@@ -143,7 +200,7 @@ declare module "effect/unstable/ai/Response" {
              */
             readonly refusal?: string | null;
             /**
-             * The status of item.
+             * The status returned for the text item.
              */
             readonly status?: MessageStatus | null;
             /**
@@ -152,47 +209,155 @@ declare module "effect/unstable/ai/Response" {
             readonly annotations?: ReadonlyArray<Annotation> | null;
         };
     }
+    /**
+     * OpenAI-compatible metadata emitted when a streamed text part starts.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface TextStartPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned for the streamed text start.
+         */
         readonly openai?: {
+            /**
+             * The OpenAI item ID associated with the streamed text part.
+             */
             readonly itemId?: string | null;
         } | null;
     }
+    /**
+     * OpenAI-compatible metadata emitted when a streamed text part ends.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface TextEndPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned for the streamed text end.
+         */
         readonly openai?: {
+            /**
+             * The OpenAI item ID associated with the streamed text part.
+             */
             readonly itemId?: string | null;
+            /**
+             * The annotations collected for the completed streamed text part.
+             */
             readonly annotations?: ReadonlyArray<Annotation> | null;
         } | null;
     }
+    /**
+     * OpenAI-compatible metadata attached to a complete reasoning response part.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface ReasoningPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned for the reasoning part.
+         */
         readonly openai?: {
+            /**
+             * The OpenAI item ID associated with the reasoning part.
+             */
             readonly itemId?: string | null;
+            /**
+             * Encrypted reasoning content that can be sent back in later requests.
+             */
             readonly encryptedContent?: string | null;
         } | null;
     }
+    /**
+     * OpenAI-compatible metadata emitted when a streamed reasoning part starts.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface ReasoningStartPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned for the streamed reasoning start.
+         */
         readonly openai?: {
+            /**
+             * The OpenAI item ID associated with the reasoning part.
+             */
             readonly itemId?: string | null;
+            /**
+             * Encrypted reasoning content that can be sent back in later requests.
+             */
             readonly encryptedContent?: string | null;
         } | null;
     }
+    /**
+     * OpenAI-compatible metadata emitted for a streamed reasoning delta.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface ReasoningDeltaPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned for the streamed reasoning delta.
+         */
         readonly openai?: {
+            /**
+             * The OpenAI item ID associated with the reasoning part.
+             */
             readonly itemId?: string | null;
         } | null;
     }
+    /**
+     * OpenAI-compatible metadata emitted when a streamed reasoning part ends.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface ReasoningEndPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned for the streamed reasoning end.
+         */
         readonly openai?: {
+            /**
+             * The OpenAI item ID associated with the reasoning part.
+             */
             readonly itemId?: string | null;
+            /**
+             * Encrypted reasoning content that can be sent back in later requests.
+             */
             readonly encryptedContent?: string;
         } | null;
     }
+    /**
+     * OpenAI-compatible metadata attached to tool-call response parts.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface ToolCallPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned for the tool call.
+         */
         readonly openai?: {
+            /**
+             * The OpenAI item ID associated with the tool call.
+             */
             readonly itemId?: string | null;
         } | null;
     }
+    /**
+     * OpenAI-compatible metadata attached to document source citations.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface DocumentSourcePartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific citation metadata for OpenAI-compatible APIs.
+         */
         readonly openai?: {
+            /**
+             * Identifies a citation to an uploaded file.
+             */
             readonly type: "file_citation";
             /**
              * The index of the file in the list of files.
@@ -203,6 +368,9 @@ declare module "effect/unstable/ai/Response" {
              */
             readonly fileId: string;
         } | {
+            /**
+             * Identifies a citation to a generated file path.
+             */
             readonly type: "file_path";
             /**
              * The index of the file in the list of files.
@@ -213,6 +381,9 @@ declare module "effect/unstable/ai/Response" {
              */
             readonly fileId: string;
         } | {
+            /**
+             * Identifies a citation to a file inside a container.
+             */
             readonly type: "container_file_citation";
             /**
              * The ID of the file.
@@ -224,8 +395,20 @@ declare module "effect/unstable/ai/Response" {
             readonly containerId: string;
         } | null;
     }
+    /**
+     * OpenAI-compatible metadata attached to URL source citations.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface UrlSourcePartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific URL citation metadata for OpenAI-compatible APIs.
+         */
         readonly openai?: {
+            /**
+             * Identifies a citation to a URL.
+             */
             readonly type: "url_citation";
             /**
              * The index of the first character of the URL citation in the message.
@@ -237,22 +420,36 @@ declare module "effect/unstable/ai/Response" {
             readonly endIndex: number;
         } | null;
     }
+    /**
+     * OpenAI-compatible metadata attached to finish response parts.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface FinishPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned when generation finishes.
+         */
         readonly openai?: {
+            /**
+             * The service tier reported by the OpenAI-compatible provider.
+             */
             readonly serviceTier?: "default" | "auto" | "flex" | "scale" | "priority" | null;
         } | null;
     }
 }
 /**
- * @since 1.0.0
+ * Creates an AI model descriptor for an OpenAI-compatible 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, OpenAiClient>;
 /**
  * Creates an OpenAI language model service.
  *
- * @since 1.0.0
  * @category constructors
+ * @since 4.0.0
  */
 export declare const make: (args_0: {
     readonly model: string;
@@ -261,8 +458,8 @@ export declare const make: (args_0: {
 /**
  * Creates a layer for the OpenAI language model.
  *
- * @since 1.0.0
  * @category layers
+ * @since 4.0.0
  */
 export declare const layer: (options: {
     readonly model: string;
@@ -271,22 +468,22 @@ export declare const layer: (options: {
 /**
  * Provides config overrides for OpenAI language model operations.
  *
- * @since 1.0.0
  * @category configuration
+ * @since 4.0.0
  */
 export declare const withConfigOverride: {
     /**
      * Provides config overrides for OpenAI 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 OpenAI 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/OpenAiLanguageModel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OpenAiLanguageModel.d.ts","sourceRoot":"","sources":["../src/OpenAiLanguageModel.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AAEzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAGvC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AAUrC,OAAO,KAAK,aAAa,MAAM,kCAAkC,CAAA;AACjE,OAAO,KAAK,OAAO,MAAM,0BAA0B,CAAA;AAQnD,OAAO,EACL,KAAK,UAAU,EAMf,KAAK,WAAW,EAGhB,KAAK,aAAa,EAClB,YAAY,EAKb,MAAM,mBAAmB,CAAA;AAG1B;;GAEG;AACH,KAAK,WAAW,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAkCpB;QACd;;;;;;WAMG;QACH,QAAQ,CAAC,SAAS,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAA;KAC3D,GAAG,SAAS;IACb;;;;OAIG;;gCACyB,OAAO,GAAG,SAAS;;AA3CrD;;;;;GAKG;AACH,qBAAa,MAAO,SAAQ,WAyC8B;CAAG;AAM7D,OAAO,QAAQ,2BAA2B,CAAC;IACzC,UAAiB,eAAgB,SAAQ,eAAe;QACtD,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,GAAG,IAAI,CAAA;SAC1C,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,oBAAqB,SAAQ,eAAe;QAC3D,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;;;eAIG;YACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAC1C,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,mBAAoB,SAAQ,eAAe;QAC1D,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,IAAI,CAAA;SACvC,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,qBAAsB,SAAQ,eAAe;QAC5D,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,IAAI,CAAA;SACvC,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,eAAgB,SAAQ,eAAe;QACtD,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,IAAI,CAAA;YACtC;;eAEG;YACH,QAAQ,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,GAAG,IAAI,CAAA;SACxD,GAAG,IAAI,CAAA;KACT;CACF;AAED,OAAO,QAAQ,6BAA6B,CAAC;IAC3C,UAAiB,gBAAiB,SAAQ,gBAAgB;QACxD,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;;;eAIG;YACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAChC;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,IAAI,CAAA;YACtC;;eAEG;YACH,QAAQ,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,GAAG,IAAI,CAAA;SACxD,CAAA;KACF;IAED,UAAiB,qBAAsB,SAAQ,gBAAgB;QAC7D,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAChC,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,mBAAoB,SAAQ,gBAAgB;QAC3D,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B,QAAQ,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,GAAG,IAAI,CAAA;SACxD,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,qBAAsB,SAAQ,gBAAgB;QAC7D,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAC1C,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,0BAA2B,SAAQ,gBAAgB;QAClE,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAC1C,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,0BAA2B,SAAQ,gBAAgB;QAClE,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAChC,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,wBAAyB,SAAQ,gBAAgB;QAChE,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;SACnC,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,oBAAqB,SAAQ,gBAAgB;QAC5D,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAChC,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,0BAA2B,SAAQ,gBAAgB;QAClE,QAAQ,CAAC,MAAM,CAAC,EACZ;YACA,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;YAC9B;;eAEG;YACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;YACtB;;eAEG;YACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;SACxB,GACC;YACA,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;YAC1B;;eAEG;YACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;YACtB;;eAEG;YACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;SACxB,GACC;YACA,QAAQ,CAAC,IAAI,EAAE,yBAAyB,CAAA;YACxC;;eAEG;YACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;YACvB;;eAEG;YACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;SAC7B,GACC,IAAI,CAAA;KACT;IAED,UAAiB,qBAAsB,SAAQ,gBAAgB;QAC7D,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAA;YAC7B;;eAEG;YACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;YAC3B;;eAEG;YACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;SAC1B,GAAG,IAAI,CAAA;KACT;IAED,UAAiB,kBAAmB,SAAQ,gBAAgB;QAC1D,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,IAAI,CAAA;SACjF,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,YAAY,CACX,CAAA;AAazD;;;;;GAKG;AACH,eAAO,MAAM,IAAI;oBACC,MAAM;sBACJ,IAAI,CAAC,OAAO,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,SAAS;+DAyFlE,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,YAAY,CACN,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":"OpenAiLanguageModel.d.ts","sourceRoot":"","sources":["../src/OpenAiLanguageModel.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AAEzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAGvC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AAUrC,OAAO,KAAK,aAAa,MAAM,kCAAkC,CAAA;AACjE,OAAO,KAAK,OAAO,MAAM,0BAA0B,CAAA;AAQnD,OAAO,EACL,KAAK,UAAU,EAMf,KAAK,WAAW,EAGhB,KAAK,aAAa,EAClB,YAAY,EAKb,MAAM,mBAAmB,CAAA;AAG1B;;GAEG;AACH,KAAK,WAAW,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAkCpB;QACd;;;;;;WAMG;QACH,QAAQ,CAAC,SAAS,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAA;KAC3D,GAAG,SAAS;IACb;;;;OAIG;;gCACyB,OAAO,GAAG,SAAS;;AA3CrD;;;;;GAKG;AACH,qBAAa,MAAO,SAAQ,WAyC8B;CAAG;AAM7D,OAAO,QAAQ,2BAA2B,CAAC;IACzC;;;;;OAKG;IACH,UAAiB,eAAgB,SAAQ,eAAe;QACtD;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,GAAG,IAAI,CAAA;SAC1C,GAAG,IAAI,CAAA;KACT;IAED;;;;;OAKG;IACH,UAAiB,oBAAqB,SAAQ,eAAe;QAC3D;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;;;eAIG;YACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAC1C,GAAG,IAAI,CAAA;KACT;IAED;;;;;OAKG;IACH,UAAiB,mBAAoB,SAAQ,eAAe;QAC1D;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,IAAI,CAAA;SACvC,GAAG,IAAI,CAAA;KACT;IAED;;;;;OAKG;IACH,UAAiB,qBAAsB,SAAQ,eAAe;QAC5D;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,IAAI,CAAA;SACvC,GAAG,IAAI,CAAA;KACT;IAED;;;;;OAKG;IACH,UAAiB,eAAgB,SAAQ,eAAe;QACtD;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,IAAI,CAAA;YACtC;;eAEG;YACH,QAAQ,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,GAAG,IAAI,CAAA;SACxD,GAAG,IAAI,CAAA;KACT;CACF;AAED,OAAO,QAAQ,6BAA6B,CAAC;IAC3C;;;;;OAKG;IACH,UAAiB,gBAAiB,SAAQ,gBAAgB;QACxD;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;;;eAIG;YACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAChC;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,IAAI,CAAA;YACtC;;eAEG;YACH,QAAQ,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,GAAG,IAAI,CAAA;SACxD,CAAA;KACF;IAED;;;;;OAKG;IACH,UAAiB,qBAAsB,SAAQ,gBAAgB;QAC7D;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAChC,GAAG,IAAI,CAAA;KACT;IAED;;;;;OAKG;IACH,UAAiB,mBAAoB,SAAQ,gBAAgB;QAC3D;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;eAEG;YACH,QAAQ,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,GAAG,IAAI,CAAA;SACxD,GAAG,IAAI,CAAA;KACT;IAED;;;;;OAKG;IACH,UAAiB,qBAAsB,SAAQ,gBAAgB;QAC7D;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;eAEG;YACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAC1C,GAAG,IAAI,CAAA;KACT;IAED;;;;;OAKG;IACH,UAAiB,0BAA2B,SAAQ,gBAAgB;QAClE;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;eAEG;YACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAC1C,GAAG,IAAI,CAAA;KACT;IAED;;;;;OAKG;IACH,UAAiB,0BAA2B,SAAQ,gBAAgB;QAClE;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAChC,GAAG,IAAI,CAAA;KACT;IAED;;;;;OAKG;IACH,UAAiB,wBAAyB,SAAQ,gBAAgB;QAChE;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;eAEG;YACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;SACnC,GAAG,IAAI,CAAA;KACT;IAED;;;;;OAKG;IACH,UAAiB,oBAAqB,SAAQ,gBAAgB;QAC5D;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAChC,GAAG,IAAI,CAAA;KACT;IAED;;;;;OAKG;IACH,UAAiB,0BAA2B,SAAQ,gBAAgB;QAClE;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EACZ;YACA;;eAEG;YACH,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;YAC9B;;eAEG;YACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;YACtB;;eAEG;YACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;SACxB,GACC;YACA;;eAEG;YACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;YAC1B;;eAEG;YACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;YACtB;;eAEG;YACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;SACxB,GACC;YACA;;eAEG;YACH,QAAQ,CAAC,IAAI,EAAE,yBAAyB,CAAA;YACxC;;eAEG;YACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;YACvB;;eAEG;YACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;SAC7B,GACC,IAAI,CAAA;KACT;IAED;;;;;OAKG;IACH,UAAiB,qBAAsB,SAAQ,gBAAgB;QAC7D;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAA;YAC7B;;eAEG;YACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;YAC3B;;eAEG;YACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;SAC1B,GAAG,IAAI,CAAA;KACT;IAED;;;;;OAKG;IACH,UAAiB,kBAAmB,SAAQ,gBAAgB;QAC1D;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,IAAI,CAAA;SACjF,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,YAAY,CACX,CAAA;AAazD;;;;;GAKG;AACH,eAAO,MAAM,IAAI;oBACC,MAAM;sBACJ,IAAI,CAAC,OAAO,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,SAAS;+DAyFlE,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,YAAY,CACN,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/OpenAiLanguageModel.js

@@ -4,7 +4,7 @@
  * Provides a LanguageModel implementation for OpenAI's chat completions API,
  * supporting text generation, structured output, tool calling, and streaming.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 import * as Context from "effect/Context";
 import * as DateTime from "effect/DateTime";
@@ -31,16 +31,18 @@ import { addGenAIAnnotations } from "./OpenAiTelemetry.js";
 /**
  * Service definition for OpenAI language model configuration.
  *
- * @since 1.0.0
  * @category context
+ * @since 4.0.0
  */
 export class Config extends /*#__PURE__*/Context.Service()("@effect/ai-openai-compat/OpenAiLanguageModel/Config") {}
 // =============================================================================
 // Language Model
 // =============================================================================
 /**
- * @since 1.0.0
+ * Creates an AI model descriptor for an OpenAI-compatible language model.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export const model = (model, config) => AiModel.make("openai", model, layer({
   model,
@@ -48,7 +50,7 @@ export const model = (model, config) => AiModel.make("openai", model, layer({
 }));
 // TODO
 // /**
-//  * @since 1.0.0
+//  * @since 4.0.0
 //  * @category constructors
 //  */
 // export const modelWithTokenizer = (
@@ -59,8 +61,8 @@ export const model = (model, config) => AiModel.make("openai", model, layer({
 /**
  * Creates an OpenAI language model service.
  *
- * @since 1.0.0
  * @category constructors
+ * @since 4.0.0
  */
 export const make = /*#__PURE__*/Effect.fnUntraced(function* ({
   model,
@@ -166,15 +168,15 @@ export const make = /*#__PURE__*/Effect.fnUntraced(function* ({
 /**
  * Creates a layer for the OpenAI 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 OpenAI 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 : {}),