@effect/ai-openai-compat 4.0.0-beta.0

package/dist/OpenAiLanguageModel.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 Annotation, type IncludeEnum, type MessageStatus, OpenAiClient } from "./OpenAiClient.ts";
+/**
+ * Image detail level for vision requests.
+ */
+type ImageDetail = "auto" | "low" | "high";
+declare const Config_base: ServiceMap.ServiceClass<Config, "@effect/ai-openai-compat/OpenAiLanguageModel/Config", {
+    readonly metadata?: Readonly<Record<string, string>> | null | undefined;
+    readonly service_tier?: string | undefined | undefined;
+    readonly model?: string | undefined | undefined;
+    readonly temperature?: number | null | undefined | undefined;
+    readonly top_p?: number | null | undefined | undefined;
+    readonly user?: string | null | undefined | undefined;
+    readonly seed?: number | undefined | undefined;
+    readonly parallel_tool_calls?: boolean | null | undefined | undefined;
+    readonly reasoning?: unknown;
+    readonly max_output_tokens?: number | null | undefined | undefined;
+    readonly top_logprobs?: number | undefined | undefined;
+    readonly safety_identifier?: string | null | undefined | undefined;
+    readonly prompt_cache_key?: string | null | undefined | undefined;
+    readonly prompt_cache_retention?: "in-memory" | "24h" | null | undefined | undefined;
+    readonly previous_response_id?: string | null | undefined | undefined;
+    readonly background?: boolean | null | undefined | undefined;
+    readonly max_tool_calls?: number | null | undefined | undefined;
+    readonly truncation?: "auto" | "disabled" | null | undefined | undefined;
+    readonly include?: readonly IncludeEnum[] | null | undefined;
+    readonly store?: boolean | null | undefined | undefined;
+    readonly instructions?: string | null | undefined | undefined;
+    readonly conversation?: string | null | undefined | undefined;
+    readonly modalities?: readonly ("text" | "audio")[] | undefined;
+    readonly fileIdPrefixes?: readonly string[] | undefined;
+    readonly text?: {
+        /**
+         * Constrains the verbosity of the model's response. Lower values will
+         * result in more concise responses, while higher values will result in
+         * more verbose responses.
+         *
+         * Defaults to `"medium"`.
+         */
+        readonly verbosity?: "low" | "medium" | "high" | undefined;
+    } | undefined
+    /**
+     * Whether to use strict JSON schema validation.
+     *
+     * Defaults to `true`.
+     */
+     | undefined;
+    readonly strictJsonSchema?: boolean | undefined | undefined;
+}>;
+/**
+ * Service definition for OpenAI language model configuration.
+ *
+ * @since 1.0.0
+ * @category context
+ */
+export declare class Config extends Config_base {
+}
+declare module "effect/unstable/ai/Prompt" {
+    interface FilePartOptions extends ProviderOptions {
+        readonly openai?: {
+            /**
+             * The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`.
+             */
+            readonly imageDetail?: ImageDetail | null;
+        } | null;
+    }
+    interface ReasoningPartOptions extends ProviderOptions {
+        readonly openai?: {
+            /**
+             * The ID of the item to reference.
+             */
+            readonly itemId?: string | null;
+            /**
+             * The encrypted content of the reasoning item - populated when a response
+             * is generated with `reasoning.encrypted_content` in the `include`
+             * parameter.
+             */
+            readonly encryptedContent?: string | null;
+        } | null;
+    }
+    interface ToolCallPartOptions extends ProviderOptions {
+        readonly openai?: {
+            /**
+             * The ID of the item to reference.
+             */
+            readonly itemId?: string | null;
+            /**
+             * The status of item.
+             */
+            readonly status?: MessageStatus | null;
+        } | null;
+    }
+    interface ToolResultPartOptions extends ProviderOptions {
+        readonly openai?: {
+            /**
+             * The ID of the item to reference.
+             */
+            readonly itemId?: string | null;
+            /**
+             * The status of item.
+             */
+            readonly status?: MessageStatus | null;
+        } | null;
+    }
+    interface TextPartOptions extends ProviderOptions {
+        readonly openai?: {
+            /**
+             * The ID of the item to reference.
+             */
+            readonly itemId?: string | null;
+            /**
+             * The status of item.
+             */
+            readonly status?: MessageStatus | null;
+            /**
+             * A list of annotations that apply to the output text.
+             */
+            readonly annotations?: ReadonlyArray<Annotation> | null;
+        } | null;
+    }
+}
+declare module "effect/unstable/ai/Response" {
+    interface TextPartMetadata extends ProviderMetadata {
+        readonly openai?: {
+            readonly itemId?: string | null;
+            /**
+             * If the model emits a refusal content part, the refusal explanation
+             * from the model will be contained in the metadata of an empty text
+             * part.
+             */
+            readonly refusal?: string | null;
+            /**
+             * The status of item.
+             */
+            readonly status?: MessageStatus | null;
+            /**
+             * The text content part annotations.
+             */
+            readonly annotations?: ReadonlyArray<Annotation> | null;
+        };
+    }
+    interface TextStartPartMetadata extends ProviderMetadata {
+        readonly openai?: {
+            readonly itemId?: string | null;
+        } | null;
+    }
+    interface TextEndPartMetadata extends ProviderMetadata {
+        readonly openai?: {
+            readonly itemId?: string | null;
+            readonly annotations?: ReadonlyArray<Annotation> | null;
+        } | null;
+    }
+    interface ReasoningPartMetadata extends ProviderMetadata {
+        readonly openai?: {
+            readonly itemId?: string | null;
+            readonly encryptedContent?: string | null;
+        } | null;
+    }
+    interface ReasoningStartPartMetadata extends ProviderMetadata {
+        readonly openai?: {
+            readonly itemId?: string | null;
+            readonly encryptedContent?: string | null;
+        } | null;
+    }
+    interface ReasoningDeltaPartMetadata extends ProviderMetadata {
+        readonly openai?: {
+            readonly itemId?: string | null;
+        } | null;
+    }
+    interface ReasoningEndPartMetadata extends ProviderMetadata {
+        readonly openai?: {
+            readonly itemId?: string | null;
+            readonly encryptedContent?: string;
+        } | null;
+    }
+    interface ToolCallPartMetadata extends ProviderMetadata {
+        readonly openai?: {
+            readonly itemId?: string | null;
+        } | null;
+    }
+    interface DocumentSourcePartMetadata extends ProviderMetadata {
+        readonly openai?: {
+            readonly type: "file_citation";
+            /**
+             * The index of the file in the list of files.
+             */
+            readonly index: number;
+            /**
+             * The ID of the file.
+             */
+            readonly fileId: string;
+        } | {
+            readonly type: "file_path";
+            /**
+             * The index of the file in the list of files.
+             */
+            readonly index: number;
+            /**
+             * The ID of the file.
+             */
+            readonly fileId: string;
+        } | {
+            readonly type: "container_file_citation";
+            /**
+             * The ID of the file.
+             */
+            readonly fileId: string;
+            /**
+             * The ID of the container file.
+             */
+            readonly containerId: string;
+        } | null;
+    }
+    interface UrlSourcePartMetadata extends ProviderMetadata {
+        readonly openai?: {
+            readonly type: "url_citation";
+            /**
+             * The index of the first character of the URL citation in the message.
+             */
+            readonly startIndex: number;
+            /**
+             * The index of the last character of the URL citation in the message.
+             */
+            readonly endIndex: number;
+        } | null;
+    }
+    interface FinishPartMetadata extends ProviderMetadata {
+        readonly openai?: {
+            readonly serviceTier?: "default" | "auto" | "flex" | "scale" | "priority" | 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, OpenAiClient>;
+/**
+ * Creates an OpenAI 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, OpenAiClient>;
+/**
+ * Creates a layer for the OpenAI 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, OpenAiClient>;
+/**
+ * Provides config overrides for OpenAI language model operations.
+ *
+ * @since 1.0.0
+ * @category configuration
+ */
+export declare const withConfigOverride: {
+    /**
+     * Provides config overrides for OpenAI 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 OpenAI 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=OpenAiLanguageModel.d.ts.map

package/dist/OpenAiLanguageModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OpenAiLanguageModel.d.ts","sourceRoot":"","sources":["../src/OpenAiLanguageModel.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAGvC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AAKrC,OAAO,KAAK,UAAU,MAAM,mBAAmB,CAAA;AAK/C,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,WAwC8B;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,CAClB,CAAA;AAalD;;;;;GAKG;AACH,eAAO,MAAM,IAAI;oBACC,MAAM;sBACJ,IAAI,CAAC,OAAO,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,SAAS;+DA0FlE,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"}