@opencode-ai/ai 0.0.0-beta-17492

package/dist/providers/openai.d.ts

@@ -0,0 +1,264 @@
+import { type ProviderAuthOption } from "../route/auth-options.js";
+import type { Route, RouteDefaultsInput } from "../route/client.js";
+import type { ProviderPackage } from "../provider-package.js";
+import { ToolDefinition, type ModelID } from "../schema/index.js";
+import { type OpenAIProviderOptionsInput } from "./openai-options.js";
+import { type OpenAIImageString } from "../protocols/openai-images.js";
+export type { OpenAIOptionsInput, OpenAIResponseIncludable } from "./openai-options.js";
+export type { OpenAIImageOptions } from "../protocols/openai-images.js";
+export declare const id: string & import("effect/Brand").Brand<"AI.ProviderID">;
+export declare const routes: (Route<{
+    readonly model: string;
+    readonly messages: readonly ({
+        readonly role: "system";
+        readonly content: string | readonly ({
+            readonly type: "text";
+            readonly text: string;
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: string | undefined;
+            } | undefined;
+        } | {
+            readonly type: "image_url";
+            readonly image_url: {
+                readonly url: string;
+            };
+        })[];
+    } | {
+        readonly role: "user";
+        readonly content: string | readonly ({
+            readonly type: "text";
+            readonly text: string;
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: string | undefined;
+            } | undefined;
+        } | {
+            readonly type: "image_url";
+            readonly image_url: {
+                readonly url: string;
+            };
+        })[];
+    } | {
+        readonly [x: string]: unknown;
+        readonly content: string | null;
+        readonly role: "assistant";
+        readonly reasoning?: string | undefined;
+        readonly reasoning_content?: string | undefined;
+        readonly reasoning_text?: string | undefined;
+        readonly cache_control?: {
+            readonly type: "ephemeral";
+            readonly ttl?: string | undefined;
+        } | undefined;
+        readonly tool_calls?: readonly {
+            readonly id: string;
+            readonly type: "function";
+            readonly function: {
+                readonly name: string;
+                readonly arguments: string;
+            };
+        }[] | undefined;
+        readonly reasoning_details?: unknown;
+    } | {
+        readonly content: string;
+        readonly role: "tool";
+        readonly tool_call_id: string;
+        readonly cache_control?: {
+            readonly type: "ephemeral";
+            readonly ttl?: string | undefined;
+        } | undefined;
+    })[];
+    readonly stream: true;
+    readonly stop?: readonly string[] | undefined;
+    readonly max_completion_tokens?: number | undefined;
+    readonly max_tokens?: number | undefined;
+    readonly tools?: readonly {
+        readonly function: {
+            readonly name: string;
+            readonly description: string;
+            readonly parameters: {
+                readonly [x: string]: unknown;
+            };
+        };
+        readonly type: "function";
+        readonly cache_control?: {
+            readonly type: "ephemeral";
+            readonly ttl?: string | undefined;
+        } | undefined;
+    }[] | undefined;
+    readonly temperature?: number | undefined;
+    readonly seed?: number | undefined;
+    readonly tool_choice?: "required" | "none" | "auto" | {
+        readonly type: "function";
+        readonly function: {
+            readonly name: string;
+        };
+    } | undefined;
+    readonly top_p?: number | undefined;
+    readonly store?: boolean | undefined;
+    readonly stream_options?: {
+        readonly include_usage: boolean;
+    } | undefined;
+    readonly prompt_cache_key?: string | undefined;
+    readonly reasoning_effort?: string | undefined;
+    readonly frequency_penalty?: number | undefined;
+    readonly presence_penalty?: number | undefined;
+}, import("../route/transport/http.js").HttpPrepared<string>> | Route<{
+    readonly input: readonly ({
+        readonly type: "reasoning";
+        readonly summary: readonly {
+            readonly type: "summary_text";
+            readonly text: string;
+        }[];
+        readonly id?: string | undefined;
+        readonly encrypted_content?: string | null | undefined;
+    } | {
+        readonly type: "item_reference";
+        readonly id: string;
+    } | {
+        readonly role: "system";
+        readonly content: string;
+    } | {
+        readonly role: "user";
+        readonly content: readonly ({
+            readonly type: "input_image";
+            readonly image_url: string;
+        } | {
+            readonly type: "input_file";
+            readonly filename: string;
+            readonly file_data: string;
+            readonly mime_type?: string | undefined;
+        } | {
+            readonly type: "input_text";
+            readonly text: string;
+        })[];
+    } | {
+        readonly content: readonly {
+            readonly type: "output_text";
+            readonly text: string;
+        }[];
+        readonly role: "assistant";
+        readonly phase?: "commentary" | "final_answer" | undefined;
+    } | {
+        readonly type: "function_call";
+        readonly call_id: string;
+        readonly name: string;
+        readonly arguments: string;
+    } | {
+        readonly type: "function_call_output";
+        readonly call_id: string;
+        readonly output: string | readonly ({
+            readonly type: "input_image";
+            readonly image_url: string;
+        } | {
+            readonly type: "input_file";
+            readonly filename: string;
+            readonly file_data: string;
+            readonly mime_type?: string | undefined;
+        } | {
+            readonly type: "input_text";
+            readonly text: string;
+        })[];
+    } | {
+        readonly content: readonly {
+            readonly type: "output_text";
+            readonly text: string;
+        }[];
+        readonly role: "assistant";
+        readonly phase?: "commentary" | "final_answer" | null | undefined;
+    })[];
+    readonly model: string;
+    readonly stream: true;
+    readonly instructions?: string | undefined;
+    readonly reasoning?: {
+        readonly summary?: "auto" | "concise" | "detailed" | undefined;
+        readonly effort?: string | undefined;
+    } | undefined;
+    readonly tools?: readonly ({
+        readonly type: "function";
+        readonly description: string;
+        readonly name: string;
+        readonly parameters: {
+            readonly [x: string]: unknown;
+        };
+        readonly strict?: boolean | undefined;
+    } | {
+        readonly type: "image_generation";
+        readonly size?: string | undefined;
+        readonly action?: "generate" | "auto" | "edit" | undefined;
+        readonly output_format?: "png" | "jpeg" | "webp" | undefined;
+        readonly quality?: "low" | "medium" | "high" | "auto" | undefined;
+        readonly background?: "auto" | "opaque" | "transparent" | undefined;
+        readonly output_compression?: number | undefined;
+        readonly input_fidelity?: "low" | "high" | undefined;
+        readonly partial_images?: number | undefined;
+    })[] | undefined;
+    readonly text?: {
+        readonly verbosity?: "low" | "medium" | "high" | undefined;
+    } | undefined;
+    readonly temperature?: number | undefined;
+    readonly tool_choice?: "required" | "none" | "auto" | {
+        readonly type: "function";
+        readonly name: string;
+    } | {
+        readonly type: "image_generation";
+    } | undefined;
+    readonly top_p?: number | undefined;
+    readonly include?: readonly ("file_search_call.results" | "web_search_call.results" | "web_search_call.action.sources" | "message.input_image.image_url" | "computer_call_output.output.image_url" | "code_interpreter_call.outputs" | "reasoning.encrypted_content" | "message.output_text.logprobs")[] | undefined;
+    readonly store?: boolean | undefined;
+    readonly prompt_cache_key?: string | undefined;
+    readonly service_tier?: "default" | "auto" | "flex" | "priority" | undefined;
+    readonly max_output_tokens?: number | undefined;
+}, import("../protocols/open-responses-channel.js").Prepared>)[];
+export type Config = RouteDefaultsInput & ProviderAuthOption<"optional"> & {
+    readonly baseURL?: string;
+    readonly queryParams?: Record<string, string>;
+    readonly providerOptions?: OpenAIProviderOptionsInput;
+};
+export interface ImageGenerationOptions {
+    readonly action?: OpenAIImageString<"auto" | "generate" | "edit">;
+    readonly background?: OpenAIImageString<"auto" | "opaque" | "transparent">;
+    readonly inputFidelity?: OpenAIImageString<"low" | "high">;
+    readonly outputCompression?: number;
+    readonly outputFormat?: OpenAIImageString<"png" | "jpeg" | "webp">;
+    readonly partialImages?: number;
+    readonly quality?: OpenAIImageString<"auto" | "low" | "medium" | "high" | "standard" | "hd">;
+    readonly size?: OpenAIImageString<"auto" | "256x256" | "512x512" | "1024x1024" | "1536x1024" | "1024x1536" | "1792x1024" | "1024x1792">;
+}
+export declare const imageGeneration: (options?: ImageGenerationOptions) => ToolDefinition;
+export interface Settings extends ProviderPackage.Settings {
+    readonly apiKey?: string;
+    readonly baseURL?: string;
+    readonly organization?: string;
+    readonly project?: string;
+    readonly queryParams?: Readonly<Record<string, string>>;
+    readonly providerOptions?: OpenAIProviderOptionsInput;
+}
+export declare const configure: (input?: Config) => {
+    id: string & import("effect/Brand").Brand<"AI.ProviderID">;
+    model: (id: string | ModelID) => import("../schema/options.js").LanguageModel<OpenAIProviderOptionsInput>;
+    responses: (id: string | ModelID) => import("../schema/options.js").LanguageModel<OpenAIProviderOptionsInput>;
+    chat: (id: string | ModelID) => import("../schema/options.js").LanguageModel<OpenAIProviderOptionsInput>;
+    image: (modelID: string | ModelID) => import("../image.js").ImageModel<import("../protocols/openai-images.js").OpenAIImageOptions>;
+    configure: (input?: Config) => /*elided*/ any;
+};
+export declare const provider: {
+    id: string & import("effect/Brand").Brand<"AI.ProviderID">;
+    model: (id: string | ModelID) => import("../schema/options.js").LanguageModel<OpenAIProviderOptionsInput>;
+    responses: (id: string | ModelID) => import("../schema/options.js").LanguageModel<OpenAIProviderOptionsInput>;
+    chat: (id: string | ModelID) => import("../schema/options.js").LanguageModel<OpenAIProviderOptionsInput>;
+    image: (modelID: string | ModelID) => import("../image.js").ImageModel<import("../protocols/openai-images.js").OpenAIImageOptions>;
+    configure: (input?: Config) => {
+        id: string & import("effect/Brand").Brand<"AI.ProviderID">;
+        model: (id: string | ModelID) => import("../schema/options.js").LanguageModel<OpenAIProviderOptionsInput>;
+        responses: (id: string | ModelID) => import("../schema/options.js").LanguageModel<OpenAIProviderOptionsInput>;
+        chat: (id: string | ModelID) => import("../schema/options.js").LanguageModel<OpenAIProviderOptionsInput>;
+        image: (modelID: string | ModelID) => import("../image.js").ImageModel<import("../protocols/openai-images.js").OpenAIImageOptions>;
+        configure: /*elided*/ any;
+    };
+};
+export declare const model: ProviderPackage.Definition<Settings, OpenAIProviderOptionsInput>["model"];
+export declare const chatModel: ProviderPackage.Definition<Settings, OpenAIProviderOptionsInput>["model"];
+export declare const responses: (id: string | ModelID) => import("../schema/options.js").LanguageModel<OpenAIProviderOptionsInput>;
+export declare const chat: (id: string | ModelID) => import("../schema/options.js").LanguageModel<OpenAIProviderOptionsInput>;
+export declare const image: (modelID: string | ModelID) => import("../image.js").ImageModel<import("../protocols/openai-images.js").OpenAIImageOptions>;

package/dist/providers/openai.js

@@ -0,0 +1,83 @@
+import { AuthOptions } from "../route/auth-options.js";
+import { HttpOptions, ProviderID, ToolDefinition, mergeHttpOptions } from "../schema/index.js";
+import * as OpenAIChat from "../protocols/openai-chat.js";
+import * as OpenAIResponses from "../protocols/openai-responses.js";
+import { withOpenAIOptions } from "./openai-options.js";
+import { OpenAIImages } from "../protocols/openai-images.js";
+export const id = ProviderID.make("openai");
+export const routes = [OpenAIResponses.route, OpenAIChat.route];
+export const imageGeneration = (options = {}) => ToolDefinition.make({
+    name: "image_generation",
+    description: "Generate or edit an image using OpenAI's hosted image generation tool.",
+    inputSchema: { type: "object", properties: {}, additionalProperties: false },
+    native: {
+        openai: {
+            type: "image_generation",
+            action: options.action,
+            background: options.background,
+            input_fidelity: options.inputFidelity,
+            output_compression: options.outputCompression,
+            output_format: options.outputFormat,
+            partial_images: options.partialImages,
+            quality: options.quality,
+            size: options.size,
+        },
+    },
+});
+const auth = (options) => AuthOptions.bearer(options, "OPENAI_API_KEY");
+const defaults = (input) => {
+    const { apiKey: _, auth: _auth, baseURL: _baseURL, queryParams: _queryParams, ...rest } = input;
+    return rest;
+};
+const configuredRoute = (route, input) => route.with({
+    auth: auth(input),
+    endpoint: { baseURL: input.baseURL, query: input.queryParams },
+});
+export const configure = (input = {}) => {
+    const responsesRoute = configuredRoute(OpenAIResponses.route, input);
+    const chatRoute = configuredRoute(OpenAIChat.route, input);
+    const modelDefaults = defaults(input);
+    const responses = (id) => responsesRoute
+        .with(withOpenAIOptions(id, modelDefaults, { textVerbosity: true }))
+        .model({ id });
+    const chat = (id) => chatRoute.with(withOpenAIOptions(id, modelDefaults)).model({ id });
+    const image = (modelID) => OpenAIImages.model({
+        id: modelID,
+        auth: auth(input),
+        baseURL: input.baseURL,
+        headers: input.headers,
+        http: mergeHttpOptions(input.http === undefined ? undefined : HttpOptions.make(input.http), input.queryParams === undefined ? undefined : new HttpOptions({ query: input.queryParams })),
+    });
+    return {
+        id,
+        model: responses,
+        responses,
+        chat,
+        image,
+        configure,
+    };
+};
+export const provider = configure();
+const config = (settings) => {
+    const headers = {
+        ...(settings.organization === undefined ? {} : { "OpenAI-Organization": settings.organization }),
+        ...(settings.project === undefined ? {} : { "OpenAI-Project": settings.project }),
+        ...settings.headers,
+    };
+    return {
+        apiKey: settings.apiKey,
+        baseURL: settings.baseURL,
+        headers: Object.keys(headers).length === 0 ? undefined : headers,
+        http: settings.body === undefined ? undefined : { body: { ...settings.body } },
+        limits: settings.limits,
+        providerOptions: settings.providerOptions,
+        queryParams: settings.queryParams === undefined ? undefined : { ...settings.queryParams },
+    };
+};
+export const model = (modelID, settings) => {
+    return configure(config(settings)).responses(modelID);
+};
+export const chatModel = (modelID, settings) => configure(config(settings)).chat(modelID);
+export const responses = provider.responses;
+export const chat = provider.chat;
+export const image = provider.image;