@opencode-ai/ai 0.0.0-bootstrap.0 → 0.0.0-next-15618

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

@@ -0,0 +1,391 @@
+import { Schema } from "effect";
+import { Route } from "../route/client";
+import { HttpTransport } from "../route/transport";
+import { Protocol } from "../route/protocol";
+import { LLMEvent, Usage, type FinishReason } from "../schema";
+import { Lifecycle } from "./utils/lifecycle";
+import { ToolStream } from "./utils/tool-stream";
+export declare const DEFAULT_BASE_URL = "https://api.openai.com/v1";
+export declare const PATH = "/chat/completions";
+export declare const bodyFields: {
+    model: Schema.String;
+    messages: Schema.$Array<Schema.toTaggedUnion<"role", readonly [Schema.Struct<{
+        readonly role: Schema.Literal<"system">;
+        readonly content: Schema.String;
+    }>, Schema.Struct<{
+        readonly role: Schema.Literal<"user">;
+        readonly content: Schema.Union<readonly [Schema.String, Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+            readonly type: Schema.Literal<"text">;
+            readonly text: Schema.String;
+        }>, Schema.Struct<{
+            readonly type: Schema.Literal<"image_url">;
+            readonly image_url: Schema.Struct<{
+                readonly url: Schema.String;
+            }>;
+        }>]>>]>;
+    }>, Schema.Struct<{
+        readonly role: Schema.Literal<"assistant">;
+        readonly content: Schema.NullOr<Schema.String>;
+        readonly tool_calls: Schema.optional<Schema.$Array<Schema.Struct<{
+            readonly id: Schema.String;
+            readonly type: Schema.tag<"function">;
+            readonly function: Schema.Struct<{
+                readonly name: Schema.String;
+                readonly arguments: Schema.String;
+            }>;
+        }>>>;
+        readonly reasoning_content: Schema.optional<Schema.String>;
+    }>, Schema.Struct<{
+        readonly role: Schema.Literal<"tool">;
+        readonly tool_call_id: Schema.String;
+        readonly content: Schema.String;
+    }>]>>;
+    tools: Schema.optional<Schema.$Array<Schema.Struct<{
+        readonly type: Schema.tag<"function">;
+        readonly function: Schema.Struct<{
+            readonly name: Schema.String;
+            readonly description: Schema.String;
+            readonly parameters: Schema.$Record<Schema.String, Schema.Unknown>;
+        }>;
+    }>>>;
+    tool_choice: Schema.optional<Schema.Union<readonly [Schema.Literals<readonly ["auto", "none", "required"]>, Schema.Struct<{
+        readonly type: Schema.tag<"function">;
+        readonly function: Schema.Struct<{
+            readonly name: Schema.String;
+        }>;
+    }>]>>;
+    stream: Schema.Literal<true>;
+    stream_options: Schema.optional<Schema.Struct<{
+        readonly include_usage: Schema.Boolean;
+    }>>;
+    store: Schema.optional<Schema.Boolean>;
+    reasoning_effort: Schema.optional<Schema.String>;
+    max_tokens: Schema.optional<Schema.Number>;
+    temperature: Schema.optional<Schema.Number>;
+    top_p: Schema.optional<Schema.Number>;
+    frequency_penalty: Schema.optional<Schema.Number>;
+    presence_penalty: Schema.optional<Schema.Number>;
+    seed: Schema.optional<Schema.Number>;
+    stop: Schema.optional<Schema.$Array<Schema.String>>;
+};
+declare const OpenAIChatBody: Schema.Struct<{
+    model: Schema.String;
+    messages: Schema.$Array<Schema.toTaggedUnion<"role", readonly [Schema.Struct<{
+        readonly role: Schema.Literal<"system">;
+        readonly content: Schema.String;
+    }>, Schema.Struct<{
+        readonly role: Schema.Literal<"user">;
+        readonly content: Schema.Union<readonly [Schema.String, Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+            readonly type: Schema.Literal<"text">;
+            readonly text: Schema.String;
+        }>, Schema.Struct<{
+            readonly type: Schema.Literal<"image_url">;
+            readonly image_url: Schema.Struct<{
+                readonly url: Schema.String;
+            }>;
+        }>]>>]>;
+    }>, Schema.Struct<{
+        readonly role: Schema.Literal<"assistant">;
+        readonly content: Schema.NullOr<Schema.String>;
+        readonly tool_calls: Schema.optional<Schema.$Array<Schema.Struct<{
+            readonly id: Schema.String;
+            readonly type: Schema.tag<"function">;
+            readonly function: Schema.Struct<{
+                readonly name: Schema.String;
+                readonly arguments: Schema.String;
+            }>;
+        }>>>;
+        readonly reasoning_content: Schema.optional<Schema.String>;
+    }>, Schema.Struct<{
+        readonly role: Schema.Literal<"tool">;
+        readonly tool_call_id: Schema.String;
+        readonly content: Schema.String;
+    }>]>>;
+    tools: Schema.optional<Schema.$Array<Schema.Struct<{
+        readonly type: Schema.tag<"function">;
+        readonly function: Schema.Struct<{
+            readonly name: Schema.String;
+            readonly description: Schema.String;
+            readonly parameters: Schema.$Record<Schema.String, Schema.Unknown>;
+        }>;
+    }>>>;
+    tool_choice: Schema.optional<Schema.Union<readonly [Schema.Literals<readonly ["auto", "none", "required"]>, Schema.Struct<{
+        readonly type: Schema.tag<"function">;
+        readonly function: Schema.Struct<{
+            readonly name: Schema.String;
+        }>;
+    }>]>>;
+    stream: Schema.Literal<true>;
+    stream_options: Schema.optional<Schema.Struct<{
+        readonly include_usage: Schema.Boolean;
+    }>>;
+    store: Schema.optional<Schema.Boolean>;
+    reasoning_effort: Schema.optional<Schema.String>;
+    max_tokens: Schema.optional<Schema.Number>;
+    temperature: Schema.optional<Schema.Number>;
+    top_p: Schema.optional<Schema.Number>;
+    frequency_penalty: Schema.optional<Schema.Number>;
+    presence_penalty: Schema.optional<Schema.Number>;
+    seed: Schema.optional<Schema.Number>;
+    stop: Schema.optional<Schema.$Array<Schema.String>>;
+}>;
+export type OpenAIChatBody = Schema.Schema.Type<typeof OpenAIChatBody>;
+export declare const OpenAIChatEvent: Schema.Struct<{
+    readonly choices: Schema.$Array<Schema.Struct<{
+        readonly delta: Schema.optional<Schema.NullOr<Schema.Struct<{
+            readonly content: Schema.optional<Schema.NullOr<Schema.String>>;
+            readonly reasoning_content: Schema.optional<Schema.NullOr<Schema.String>>;
+            readonly tool_calls: Schema.optional<Schema.NullOr<Schema.$Array<Schema.Struct<{
+                readonly index: Schema.Number;
+                readonly id: Schema.optional<Schema.NullOr<Schema.String>>;
+                readonly function: Schema.optional<Schema.NullOr<Schema.Struct<{
+                    readonly name: Schema.optional<Schema.NullOr<Schema.String>>;
+                    readonly arguments: Schema.optional<Schema.NullOr<Schema.String>>;
+                }>>>;
+            }>>>>;
+        }>>>;
+        readonly finish_reason: Schema.optional<Schema.NullOr<Schema.String>>;
+    }>>;
+    readonly usage: Schema.optional<Schema.NullOr<Schema.Struct<{
+        readonly prompt_tokens: Schema.optional<Schema.Number>;
+        readonly completion_tokens: Schema.optional<Schema.Number>;
+        readonly total_tokens: Schema.optional<Schema.Number>;
+        readonly prompt_tokens_details: Schema.optional<Schema.NullOr<Schema.Struct<{
+            readonly cached_tokens: Schema.optional<Schema.Number>;
+        }>>>;
+        readonly completion_tokens_details: Schema.optional<Schema.NullOr<Schema.Struct<{
+            readonly reasoning_tokens: Schema.optional<Schema.Number>;
+        }>>>;
+    }>>>;
+}>;
+export type OpenAIChatEvent = Schema.Schema.Type<typeof OpenAIChatEvent>;
+export interface ParserState {
+    readonly tools: ToolStream.State<number>;
+    readonly toolCallEvents: ReadonlyArray<LLMEvent>;
+    readonly usage?: Usage;
+    readonly finishReason?: FinishReason;
+    readonly lifecycle: Lifecycle.State;
+}
+/**
+ * The OpenAI Chat protocol — request body construction, body schema, and the
+ * streaming-event state machine. Reused by every route that speaks OpenAI Chat
+ * over HTTP+SSE: native OpenAI, DeepSeek, TogetherAI, Cerebras, Baseten,
+ * Fireworks, DeepInfra, and (once added) Azure OpenAI Chat.
+ */
+export declare const protocol: Protocol<{
+    readonly model: string;
+    readonly messages: readonly ({
+        readonly role: "system";
+        readonly content: string;
+    } | {
+        readonly role: "user";
+        readonly content: string | readonly ({
+            readonly type: "text";
+            readonly text: string;
+        } | {
+            readonly type: "image_url";
+            readonly image_url: {
+                readonly url: string;
+            };
+        })[];
+    } | {
+        readonly role: "assistant";
+        readonly content: string | null;
+        readonly tool_calls?: readonly {
+            readonly id: string;
+            readonly type: "function";
+            readonly function: {
+                readonly name: string;
+                readonly arguments: string;
+            };
+        }[] | undefined;
+        readonly reasoning_content?: string | undefined;
+    } | {
+        readonly role: "tool";
+        readonly tool_call_id: string;
+        readonly content: string;
+    })[];
+    readonly stream: true;
+    readonly tools?: readonly {
+        readonly type: "function";
+        readonly function: {
+            readonly name: string;
+            readonly description: string;
+            readonly parameters: {
+                readonly [x: string]: unknown;
+            };
+        };
+    }[] | undefined;
+    readonly tool_choice?: "required" | "none" | "auto" | {
+        readonly type: "function";
+        readonly function: {
+            readonly name: string;
+        };
+    } | undefined;
+    readonly stream_options?: {
+        readonly include_usage: boolean;
+    } | undefined;
+    readonly store?: boolean | undefined;
+    readonly reasoning_effort?: string | undefined;
+    readonly max_tokens?: number | undefined;
+    readonly temperature?: number | undefined;
+    readonly top_p?: number | undefined;
+    readonly frequency_penalty?: number | undefined;
+    readonly presence_penalty?: number | undefined;
+    readonly seed?: number | undefined;
+    readonly stop?: readonly string[] | undefined;
+}, string, {
+    readonly choices: readonly {
+        readonly delta?: {
+            readonly content?: string | null | undefined;
+            readonly reasoning_content?: string | null | undefined;
+            readonly tool_calls?: readonly {
+                readonly index: number;
+                readonly id?: string | null | undefined;
+                readonly function?: {
+                    readonly name?: string | null | undefined;
+                    readonly arguments?: string | null | undefined;
+                } | null | undefined;
+            }[] | null | undefined;
+        } | null | undefined;
+        readonly finish_reason?: string | null | undefined;
+    }[];
+    readonly usage?: {
+        readonly prompt_tokens?: number | undefined;
+        readonly completion_tokens?: number | undefined;
+        readonly total_tokens?: number | undefined;
+        readonly prompt_tokens_details?: {
+            readonly cached_tokens?: number | undefined;
+        } | null | undefined;
+        readonly completion_tokens_details?: {
+            readonly reasoning_tokens?: number | undefined;
+        } | null | undefined;
+    } | null | undefined;
+}, ParserState>;
+export declare const httpTransport: HttpTransport.HttpJsonTransport<{
+    readonly model: string;
+    readonly messages: readonly ({
+        readonly role: "system";
+        readonly content: string;
+    } | {
+        readonly role: "user";
+        readonly content: string | readonly ({
+            readonly type: "text";
+            readonly text: string;
+        } | {
+            readonly type: "image_url";
+            readonly image_url: {
+                readonly url: string;
+            };
+        })[];
+    } | {
+        readonly role: "assistant";
+        readonly content: string | null;
+        readonly tool_calls?: readonly {
+            readonly id: string;
+            readonly type: "function";
+            readonly function: {
+                readonly name: string;
+                readonly arguments: string;
+            };
+        }[] | undefined;
+        readonly reasoning_content?: string | undefined;
+    } | {
+        readonly role: "tool";
+        readonly tool_call_id: string;
+        readonly content: string;
+    })[];
+    readonly stream: true;
+    readonly tools?: readonly {
+        readonly type: "function";
+        readonly function: {
+            readonly name: string;
+            readonly description: string;
+            readonly parameters: {
+                readonly [x: string]: unknown;
+            };
+        };
+    }[] | undefined;
+    readonly tool_choice?: "required" | "none" | "auto" | {
+        readonly type: "function";
+        readonly function: {
+            readonly name: string;
+        };
+    } | undefined;
+    readonly stream_options?: {
+        readonly include_usage: boolean;
+    } | undefined;
+    readonly store?: boolean | undefined;
+    readonly reasoning_effort?: string | undefined;
+    readonly max_tokens?: number | undefined;
+    readonly temperature?: number | undefined;
+    readonly top_p?: number | undefined;
+    readonly frequency_penalty?: number | undefined;
+    readonly presence_penalty?: number | undefined;
+    readonly seed?: number | undefined;
+    readonly stop?: readonly string[] | undefined;
+}, string>;
+export declare const route: Route<{
+    readonly model: string;
+    readonly messages: readonly ({
+        readonly role: "system";
+        readonly content: string;
+    } | {
+        readonly role: "user";
+        readonly content: string | readonly ({
+            readonly type: "text";
+            readonly text: string;
+        } | {
+            readonly type: "image_url";
+            readonly image_url: {
+                readonly url: string;
+            };
+        })[];
+    } | {
+        readonly role: "assistant";
+        readonly content: string | null;
+        readonly tool_calls?: readonly {
+            readonly id: string;
+            readonly type: "function";
+            readonly function: {
+                readonly name: string;
+                readonly arguments: string;
+            };
+        }[] | undefined;
+        readonly reasoning_content?: string | undefined;
+    } | {
+        readonly role: "tool";
+        readonly tool_call_id: string;
+        readonly content: string;
+    })[];
+    readonly stream: true;
+    readonly tools?: readonly {
+        readonly type: "function";
+        readonly function: {
+            readonly name: string;
+            readonly description: string;
+            readonly parameters: {
+                readonly [x: string]: unknown;
+            };
+        };
+    }[] | undefined;
+    readonly tool_choice?: "required" | "none" | "auto" | {
+        readonly type: "function";
+        readonly function: {
+            readonly name: string;
+        };
+    } | undefined;
+    readonly stream_options?: {
+        readonly include_usage: boolean;
+    } | undefined;
+    readonly store?: boolean | undefined;
+    readonly reasoning_effort?: string | undefined;
+    readonly max_tokens?: number | undefined;
+    readonly temperature?: number | undefined;
+    readonly top_p?: number | undefined;
+    readonly frequency_penalty?: number | undefined;
+    readonly presence_penalty?: number | undefined;
+    readonly seed?: number | undefined;
+    readonly stop?: readonly string[] | undefined;
+}, HttpTransport.HttpPrepared<string>>;
+export * as OpenAIChat from "./openai-chat";