@opencode-ai/ai 0.0.0-beta-17492

package/dist/protocols/openai-responses.d.ts

@@ -0,0 +1,596 @@
+import { Schema } from "effect";
+import { Route } from "../route/client.js";
+import { Protocol } from "../route/protocol.js";
+import { HttpTransport } from "../route/transport/index.js";
+import { OpenResponses } from "./open-responses.js";
+export declare const DEFAULT_BASE_URL = "https://api.openai.com/v1";
+export declare const PATH = "/responses";
+declare const OpenAIResponsesBody: Schema.Struct<{
+    readonly stream: Schema.Literal<true>;
+    readonly input: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+        readonly role: Schema.tag<"assistant">;
+        readonly content: Schema.$Array<Schema.Struct<{
+            readonly type: Schema.tag<"output_text">;
+            readonly text: Schema.String;
+        }>>;
+        readonly phase: Schema.optionalKey<Schema.NullOr<Schema.Literals<readonly ["commentary", "final_answer"]>>>;
+    }>, Schema.Union<readonly [Schema.Struct<{
+        readonly role: Schema.tag<"system">;
+        readonly content: Schema.String;
+    }>, Schema.Struct<{
+        readonly role: Schema.tag<"user">;
+        readonly content: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+            readonly type: Schema.tag<"input_text">;
+            readonly text: Schema.String;
+        }>, Schema.Union<readonly [Schema.Struct<{
+            readonly type: Schema.tag<"input_image">;
+            readonly image_url: Schema.String;
+        }>, Schema.Struct<{
+            readonly type: Schema.tag<"input_file">;
+            readonly filename: Schema.String;
+            readonly file_data: Schema.String;
+            readonly mime_type: Schema.optional<Schema.String>;
+        }>]>]>>;
+    }>, Schema.Struct<{
+        readonly role: Schema.tag<"assistant">;
+        readonly content: Schema.$Array<Schema.Struct<{
+            readonly type: Schema.tag<"output_text">;
+            readonly text: Schema.String;
+        }>>;
+        readonly phase: Schema.optionalKey<Schema.Literals<readonly ["commentary", "final_answer"]>>;
+    }>, Schema.Struct<{
+        readonly type: Schema.tag<"reasoning">;
+        readonly id: Schema.optionalKey<Schema.String>;
+        readonly summary: Schema.$Array<Schema.Struct<{
+            readonly type: Schema.tag<"summary_text">;
+            readonly text: Schema.String;
+        }>>;
+        readonly encrypted_content: Schema.optional<Schema.NullOr<Schema.String>>;
+    }>, Schema.Struct<{
+        readonly type: Schema.tag<"item_reference">;
+        readonly id: Schema.String;
+    }>, Schema.Struct<{
+        readonly type: Schema.tag<"function_call">;
+        readonly call_id: Schema.String;
+        readonly name: Schema.String;
+        readonly arguments: Schema.String;
+    }>, Schema.Struct<{
+        readonly type: Schema.tag<"function_call_output">;
+        readonly call_id: Schema.String;
+        readonly output: Schema.Union<readonly [Schema.String, Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+            readonly type: Schema.tag<"input_text">;
+            readonly text: Schema.String;
+        }>, Schema.Struct<{
+            readonly type: Schema.tag<"input_image">;
+            readonly image_url: Schema.String;
+        }>, Schema.Struct<{
+            readonly type: Schema.tag<"input_file">;
+            readonly filename: Schema.String;
+            readonly file_data: Schema.String;
+            readonly mime_type: Schema.optional<Schema.String>;
+        }>]>>]>;
+    }>]>]>>;
+    readonly tools: Schema.optional<Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+        readonly type: Schema.tag<"function">;
+        readonly name: Schema.String;
+        readonly description: Schema.String;
+        readonly parameters: Schema.$Record<Schema.String, Schema.Unknown>;
+        readonly strict: Schema.optional<Schema.Boolean>;
+    }>, Schema.Struct<{
+        readonly type: Schema.tag<"image_generation">;
+        readonly action: Schema.optional<Schema.Literals<readonly ["auto", "generate", "edit"]>>;
+        readonly background: Schema.optional<Schema.Literals<readonly ["auto", "opaque", "transparent"]>>;
+        readonly input_fidelity: Schema.optional<Schema.Literals<readonly ["low", "high"]>>;
+        readonly output_compression: Schema.optional<Schema.Int>;
+        readonly output_format: Schema.optional<Schema.Literals<readonly ["png", "jpeg", "webp"]>>;
+        readonly partial_images: Schema.optional<Schema.Int>;
+        readonly quality: Schema.optional<Schema.Literals<readonly ["auto", "low", "medium", "high"]>>;
+        readonly size: Schema.optional<Schema.String>;
+    }>]>>>;
+    readonly tool_choice: Schema.optional<Schema.Union<readonly [Schema.Union<readonly [Schema.Literals<readonly ["auto", "none", "required"]>, Schema.Struct<{
+        readonly type: Schema.tag<"function">;
+        readonly name: Schema.String;
+    }>]>, Schema.Struct<{
+        readonly type: Schema.tag<"image_generation">;
+    }>]>>;
+    readonly model: Schema.String;
+    readonly instructions: Schema.optional<Schema.String>;
+    readonly store: Schema.optional<Schema.Boolean>;
+    readonly service_tier: Schema.optional<Schema.Literals<readonly ["auto", "default", "flex", "priority"]>>;
+    readonly prompt_cache_key: Schema.optional<Schema.String>;
+    readonly include: Schema.optional<Schema.$Array<Schema.Literals<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"]>>>;
+    readonly reasoning: Schema.optional<Schema.Struct<{
+        readonly effort: Schema.optional<Schema.String>;
+        readonly summary: Schema.optional<Schema.Literals<readonly ["auto", "concise", "detailed"]>>;
+    }>>;
+    readonly text: Schema.optional<Schema.Struct<{
+        readonly verbosity: Schema.optional<Schema.Literals<readonly ["low", "medium", "high"]>>;
+    }>>;
+    readonly max_output_tokens: Schema.optional<Schema.Number>;
+    readonly temperature: Schema.optional<Schema.Number>;
+    readonly top_p: Schema.optional<Schema.Number>;
+}>;
+export type OpenAIResponsesBody = Schema.Schema.Type<typeof OpenAIResponsesBody>;
+export declare const protocol: Protocol<{
+    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;
+}, string, {
+    readonly [x: string]: unknown;
+    readonly type: string;
+    readonly error?: {
+        readonly type?: string | null | undefined;
+        readonly code?: string | null | undefined;
+        readonly message?: string | null | undefined;
+        readonly param?: string | null | undefined;
+    } | null | undefined;
+    readonly status?: unknown;
+    readonly code?: string | null | undefined;
+    readonly message?: string | undefined;
+    readonly headers?: unknown;
+    readonly text?: string | undefined;
+    readonly item?: {
+        readonly [x: string]: unknown;
+        readonly type: string;
+        readonly id?: string | undefined;
+        readonly name?: string | undefined;
+        readonly arguments?: string | undefined;
+        readonly encrypted_content?: string | null | undefined;
+        readonly call_id?: string | undefined;
+    } | undefined;
+    readonly delta?: string | undefined;
+    readonly response?: {
+        readonly [x: string]: unknown;
+        readonly error?: {
+            readonly type?: string | null | undefined;
+            readonly code?: string | null | undefined;
+            readonly message?: string | null | undefined;
+            readonly param?: string | null | undefined;
+        } | null | undefined;
+        readonly id?: string | undefined;
+        readonly usage?: {
+            readonly input_tokens?: number | undefined;
+            readonly output_tokens?: number | undefined;
+            readonly output_tokens_details?: {
+                readonly reasoning_tokens?: number | undefined;
+            } | null | undefined;
+            readonly total_tokens?: number | undefined;
+            readonly input_tokens_details?: {
+                readonly cached_tokens?: number | undefined;
+                readonly cache_write_tokens?: number | undefined;
+            } | null | undefined;
+        } | null | undefined;
+        readonly service_tier?: string | null | undefined;
+        readonly incomplete_details?: {
+            readonly reason?: string | undefined;
+        } | null | undefined;
+    } | undefined;
+    readonly param?: string | null | undefined;
+    readonly status_code?: unknown;
+    readonly item_id?: string | undefined;
+    readonly summary_index?: number | undefined;
+}, OpenResponses.ParserState>;
+export declare const httpTransport: HttpTransport.HttpJsonTransport<{
+    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;
+}, string>;
+export declare const transport: import("../route/transport/index.js").Transport<{
+    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("./open-responses-channel.js").Prepared, string>;
+export declare const route: 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("./open-responses-channel.js").Prepared>;
+export * as OpenAIResponses from "./openai-responses.js";