@opencode-ai/ai 0.0.0-beta-17492

package/dist/protocols/anthropic-messages.d.ts

@@ -0,0 +1,633 @@
+import { Schema } from "effect";
+import { Route } from "../route/client.js";
+import { Protocol } from "../route/protocol.js";
+import { type ProviderOptions } from "../schema/index.js";
+import { Lifecycle } from "./utils/lifecycle.js";
+import { ToolStream } from "./utils/tool-stream.js";
+export declare const DEFAULT_BASE_URL = "https://api.anthropic.com/v1";
+export declare const PATH = "/messages";
+export type ThinkingInput = {
+    readonly type: "adaptive";
+    readonly display?: "summarized" | "omitted";
+} | {
+    readonly type: "disabled";
+} | ({
+    readonly type: "enabled";
+} & ({
+    readonly budgetTokens: number;
+    readonly budget_tokens?: number;
+} | {
+    readonly budgetTokens?: number;
+    readonly budget_tokens: number;
+}));
+export interface OptionsInput {
+    readonly [key: string]: unknown;
+    readonly thinking?: ThinkingInput;
+    readonly effort?: string;
+}
+export type ProviderOptionsInput = ProviderOptions & {
+    readonly anthropic?: OptionsInput;
+};
+export declare const AnthropicMessagesBody: Schema.Struct<{
+    model: Schema.String;
+    system: Schema.optional<Schema.$Array<Schema.Struct<{
+        readonly type: Schema.tag<"text">;
+        readonly text: Schema.String;
+        readonly cache_control: Schema.optional<Schema.Struct<{
+            readonly type: Schema.tag<"ephemeral">;
+            readonly ttl: Schema.optional<Schema.Literals<readonly ["5m", "1h"]>>;
+        }>>;
+    }>>>;
+    messages: Schema.$Array<Schema.toTaggedUnion<"role", readonly [Schema.Struct<{
+        readonly role: Schema.Literal<"user">;
+        readonly content: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+            readonly type: Schema.tag<"text">;
+            readonly text: Schema.String;
+            readonly cache_control: Schema.optional<Schema.Struct<{
+                readonly type: Schema.tag<"ephemeral">;
+                readonly ttl: Schema.optional<Schema.Literals<readonly ["5m", "1h"]>>;
+            }>>;
+        }>, Schema.Struct<{
+            readonly type: Schema.tag<"image">;
+            readonly source: Schema.Struct<{
+                readonly type: Schema.tag<"base64">;
+                readonly media_type: Schema.String;
+                readonly data: Schema.String;
+            }>;
+            readonly cache_control: Schema.optional<Schema.Struct<{
+                readonly type: Schema.tag<"ephemeral">;
+                readonly ttl: Schema.optional<Schema.Literals<readonly ["5m", "1h"]>>;
+            }>>;
+        }>, Schema.Struct<{
+            readonly type: Schema.tag<"document">;
+            readonly source: Schema.Struct<{
+                readonly type: Schema.tag<"base64">;
+                readonly media_type: Schema.Literal<"application/pdf">;
+                readonly data: Schema.String;
+            }>;
+            readonly cache_control: Schema.optional<Schema.Struct<{
+                readonly type: Schema.tag<"ephemeral">;
+                readonly ttl: Schema.optional<Schema.Literals<readonly ["5m", "1h"]>>;
+            }>>;
+        }>, Schema.Struct<{
+            readonly type: Schema.tag<"tool_result">;
+            readonly tool_use_id: Schema.String;
+            readonly content: Schema.Union<readonly [Schema.String, Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+                readonly type: Schema.tag<"text">;
+                readonly text: Schema.String;
+                readonly cache_control: Schema.optional<Schema.Struct<{
+                    readonly type: Schema.tag<"ephemeral">;
+                    readonly ttl: Schema.optional<Schema.Literals<readonly ["5m", "1h"]>>;
+                }>>;
+            }>, Schema.Struct<{
+                readonly type: Schema.tag<"image">;
+                readonly source: Schema.Struct<{
+                    readonly type: Schema.tag<"base64">;
+                    readonly media_type: Schema.String;
+                    readonly data: Schema.String;
+                }>;
+                readonly cache_control: Schema.optional<Schema.Struct<{
+                    readonly type: Schema.tag<"ephemeral">;
+                    readonly ttl: Schema.optional<Schema.Literals<readonly ["5m", "1h"]>>;
+                }>>;
+            }>, Schema.Struct<{
+                readonly type: Schema.tag<"document">;
+                readonly source: Schema.Struct<{
+                    readonly type: Schema.tag<"base64">;
+                    readonly media_type: Schema.Literal<"application/pdf">;
+                    readonly data: Schema.String;
+                }>;
+                readonly cache_control: Schema.optional<Schema.Struct<{
+                    readonly type: Schema.tag<"ephemeral">;
+                    readonly ttl: Schema.optional<Schema.Literals<readonly ["5m", "1h"]>>;
+                }>>;
+            }>]>>]>;
+            readonly is_error: Schema.optional<Schema.Boolean>;
+            readonly cache_control: Schema.optional<Schema.Struct<{
+                readonly type: Schema.tag<"ephemeral">;
+                readonly ttl: Schema.optional<Schema.Literals<readonly ["5m", "1h"]>>;
+            }>>;
+        }>]>>;
+    }>, Schema.Struct<{
+        readonly role: Schema.Literal<"assistant">;
+        readonly content: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+            readonly type: Schema.tag<"text">;
+            readonly text: Schema.String;
+            readonly cache_control: Schema.optional<Schema.Struct<{
+                readonly type: Schema.tag<"ephemeral">;
+                readonly ttl: Schema.optional<Schema.Literals<readonly ["5m", "1h"]>>;
+            }>>;
+        }>, Schema.Struct<{
+            readonly type: Schema.tag<"thinking">;
+            readonly thinking: Schema.String;
+            readonly signature: Schema.optional<Schema.String>;
+            readonly cache_control: Schema.optional<Schema.Struct<{
+                readonly type: Schema.tag<"ephemeral">;
+                readonly ttl: Schema.optional<Schema.Literals<readonly ["5m", "1h"]>>;
+            }>>;
+        }>, Schema.Struct<{
+            readonly type: Schema.tag<"redacted_thinking">;
+            readonly data: Schema.String;
+            readonly cache_control: Schema.optional<Schema.Struct<{
+                readonly type: Schema.tag<"ephemeral">;
+                readonly ttl: Schema.optional<Schema.Literals<readonly ["5m", "1h"]>>;
+            }>>;
+        }>, Schema.Struct<{
+            readonly type: Schema.tag<"tool_use">;
+            readonly id: Schema.String;
+            readonly name: Schema.String;
+            readonly input: Schema.Unknown;
+            readonly cache_control: Schema.optional<Schema.Struct<{
+                readonly type: Schema.tag<"ephemeral">;
+                readonly ttl: Schema.optional<Schema.Literals<readonly ["5m", "1h"]>>;
+            }>>;
+        }>, Schema.Struct<{
+            readonly type: Schema.tag<"server_tool_use">;
+            readonly id: Schema.String;
+            readonly name: Schema.String;
+            readonly input: Schema.Unknown;
+            readonly cache_control: Schema.optional<Schema.Struct<{
+                readonly type: Schema.tag<"ephemeral">;
+                readonly ttl: Schema.optional<Schema.Literals<readonly ["5m", "1h"]>>;
+            }>>;
+        }>, Schema.Struct<{
+            readonly type: Schema.Literals<readonly ["web_search_tool_result", "code_execution_tool_result", "web_fetch_tool_result"]>;
+            readonly tool_use_id: Schema.String;
+            readonly content: Schema.Unknown;
+            readonly cache_control: Schema.optional<Schema.Struct<{
+                readonly type: Schema.tag<"ephemeral">;
+                readonly ttl: Schema.optional<Schema.Literals<readonly ["5m", "1h"]>>;
+            }>>;
+        }>]>>;
+    }>, Schema.Struct<{
+        readonly role: Schema.Literal<"system">;
+        readonly content: Schema.$Array<Schema.Struct<{
+            readonly type: Schema.tag<"text">;
+            readonly text: Schema.String;
+            readonly cache_control: Schema.optional<Schema.Struct<{
+                readonly type: Schema.tag<"ephemeral">;
+                readonly ttl: Schema.optional<Schema.Literals<readonly ["5m", "1h"]>>;
+            }>>;
+        }>>;
+    }>]>>;
+    tools: Schema.optional<Schema.$Array<Schema.Struct<{
+        readonly name: Schema.String;
+        readonly description: Schema.String;
+        readonly input_schema: Schema.$Record<Schema.String, Schema.Unknown>;
+        readonly cache_control: Schema.optional<Schema.Struct<{
+            readonly type: Schema.tag<"ephemeral">;
+            readonly ttl: Schema.optional<Schema.Literals<readonly ["5m", "1h"]>>;
+        }>>;
+    }>>>;
+    tool_choice: Schema.optional<Schema.Union<readonly [Schema.Struct<{
+        readonly type: Schema.Literals<readonly ["auto", "any", "none"]>;
+    }>, Schema.Struct<{
+        readonly type: Schema.tag<"tool">;
+        readonly name: Schema.String;
+    }>]>>;
+    stream: Schema.Literal<true>;
+    max_tokens: Schema.Number;
+    temperature: Schema.optional<Schema.Number>;
+    top_p: Schema.optional<Schema.Number>;
+    top_k: Schema.optional<Schema.Number>;
+    stop_sequences: Schema.optional<Schema.$Array<Schema.String>>;
+    thinking: Schema.optional<Schema.Union<readonly [Schema.Struct<{
+        readonly type: Schema.tag<"enabled">;
+        readonly budget_tokens: Schema.Number;
+    }>, Schema.Struct<{
+        readonly type: Schema.tag<"adaptive">;
+        readonly display: Schema.optional<Schema.Literals<readonly ["summarized", "omitted"]>>;
+    }>, Schema.Struct<{
+        readonly type: Schema.tag<"disabled">;
+    }>]>>;
+    output_config: Schema.optional<Schema.Struct<{
+        readonly effort: Schema.optional<Schema.String>;
+    }>>;
+}>;
+export type AnthropicMessagesBody = Schema.Schema.Type<typeof AnthropicMessagesBody>;
+/**
+ * The Anthropic Messages protocol — request body construction, body schema,
+ * and the streaming-event state machine. Used by native Anthropic Cloud and
+ * (once registered) Vertex Anthropic / Bedrock-hosted Anthropic passthrough.
+ */
+export declare const protocol: Protocol<{
+    readonly max_tokens: number;
+    readonly model: string;
+    readonly messages: readonly ({
+        readonly role: "user";
+        readonly content: readonly ({
+            readonly type: "text";
+            readonly text: string;
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+        } | {
+            readonly type: "image";
+            readonly source: {
+                readonly type: "base64";
+                readonly media_type: string;
+                readonly data: string;
+            };
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+        } | {
+            readonly type: "document";
+            readonly source: {
+                readonly type: "base64";
+                readonly media_type: "application/pdf";
+                readonly data: string;
+            };
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+        } | {
+            readonly type: "tool_result";
+            readonly content: string | readonly ({
+                readonly type: "text";
+                readonly text: string;
+                readonly cache_control?: {
+                    readonly type: "ephemeral";
+                    readonly ttl?: "1h" | "5m" | undefined;
+                } | undefined;
+            } | {
+                readonly type: "image";
+                readonly source: {
+                    readonly type: "base64";
+                    readonly media_type: string;
+                    readonly data: string;
+                };
+                readonly cache_control?: {
+                    readonly type: "ephemeral";
+                    readonly ttl?: "1h" | "5m" | undefined;
+                } | undefined;
+            } | {
+                readonly type: "document";
+                readonly source: {
+                    readonly type: "base64";
+                    readonly media_type: "application/pdf";
+                    readonly data: string;
+                };
+                readonly cache_control?: {
+                    readonly type: "ephemeral";
+                    readonly ttl?: "1h" | "5m" | undefined;
+                } | undefined;
+            })[];
+            readonly tool_use_id: string;
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+            readonly is_error?: boolean | undefined;
+        })[];
+    } | {
+        readonly role: "assistant";
+        readonly content: readonly ({
+            readonly type: "text";
+            readonly text: string;
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+        } | {
+            readonly id: string;
+            readonly type: "tool_use";
+            readonly name: string;
+            readonly input: unknown;
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+        } | {
+            readonly id: string;
+            readonly type: "server_tool_use";
+            readonly name: string;
+            readonly input: unknown;
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+        } | {
+            readonly type: "web_search_tool_result" | "code_execution_tool_result" | "web_fetch_tool_result";
+            readonly content: unknown;
+            readonly tool_use_id: string;
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+        } | {
+            readonly type: "thinking";
+            readonly thinking: string;
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+            readonly signature?: string | undefined;
+        } | {
+            readonly data: string;
+            readonly type: "redacted_thinking";
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+        })[];
+    } | {
+        readonly role: "system";
+        readonly content: readonly {
+            readonly type: "text";
+            readonly text: string;
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+        }[];
+    })[];
+    readonly stream: true;
+    readonly system?: readonly {
+        readonly type: "text";
+        readonly text: string;
+        readonly cache_control?: {
+            readonly type: "ephemeral";
+            readonly ttl?: "1h" | "5m" | undefined;
+        } | undefined;
+    }[] | undefined;
+    readonly tools?: readonly {
+        readonly description: string;
+        readonly name: string;
+        readonly input_schema: {
+            readonly [x: string]: unknown;
+        };
+        readonly cache_control?: {
+            readonly type: "ephemeral";
+            readonly ttl?: "1h" | "5m" | undefined;
+        } | undefined;
+    }[] | undefined;
+    readonly temperature?: number | undefined;
+    readonly thinking?: {
+        readonly type: "enabled";
+        readonly budget_tokens: number;
+    } | {
+        readonly type: "adaptive";
+        readonly display?: "summarized" | "omitted" | undefined;
+    } | {
+        readonly type: "disabled";
+    } | undefined;
+    readonly tool_choice?: {
+        readonly type: "none" | "auto" | "any";
+    } | {
+        readonly type: "tool";
+        readonly name: string;
+    } | undefined;
+    readonly top_p?: number | undefined;
+    readonly top_k?: number | undefined;
+    readonly stop_sequences?: readonly string[] | undefined;
+    readonly output_config?: {
+        readonly effort?: string | undefined;
+    } | undefined;
+}, string, {
+    readonly type: string;
+    readonly error?: {
+        readonly type?: string | undefined;
+        readonly message?: string | undefined;
+    } | undefined;
+    readonly message?: {
+        readonly usage?: {
+            readonly [x: string]: unknown;
+            readonly server_tool_use?: {
+                readonly [x: string]: unknown;
+                readonly web_search_requests?: number | undefined;
+            } | null | undefined;
+            readonly input_tokens?: number | undefined;
+            readonly output_tokens?: number | undefined;
+            readonly cache_creation_input_tokens?: number | null | undefined;
+            readonly cache_read_input_tokens?: number | null | undefined;
+            readonly output_tokens_details?: {
+                readonly [x: string]: unknown;
+                readonly thinking_tokens?: number | undefined;
+            } | null | undefined;
+        } | undefined;
+    } | undefined;
+    readonly delta?: {
+        readonly type?: string | undefined;
+        readonly text?: string | undefined;
+        readonly thinking?: string | undefined;
+        readonly signature?: string | undefined;
+        readonly partial_json?: string | undefined;
+        readonly stop_reason?: string | null | undefined;
+        readonly stop_sequence?: string | null | undefined;
+    } | undefined;
+    readonly index?: number | undefined;
+    readonly usage?: {
+        readonly [x: string]: unknown;
+        readonly server_tool_use?: {
+            readonly [x: string]: unknown;
+            readonly web_search_requests?: number | undefined;
+        } | null | undefined;
+        readonly input_tokens?: number | undefined;
+        readonly output_tokens?: number | undefined;
+        readonly cache_creation_input_tokens?: number | null | undefined;
+        readonly cache_read_input_tokens?: number | null | undefined;
+        readonly output_tokens_details?: {
+            readonly [x: string]: unknown;
+            readonly thinking_tokens?: number | undefined;
+        } | null | undefined;
+    } | undefined;
+    readonly content_block?: {
+        readonly type: string;
+        readonly id?: string | undefined;
+        readonly data?: string | undefined;
+        readonly name?: string | undefined;
+        readonly input?: unknown;
+        readonly text?: string | undefined;
+        readonly content?: unknown;
+        readonly thinking?: string | undefined;
+        readonly signature?: string | undefined;
+        readonly tool_use_id?: string | undefined;
+    } | undefined;
+}, {
+    tools: Partial<Record<number, ToolStream.PendingTool>>;
+    reasoningSignatures: {};
+    lifecycle: Lifecycle.State;
+}>;
+export declare const route: Route<{
+    readonly max_tokens: number;
+    readonly model: string;
+    readonly messages: readonly ({
+        readonly role: "user";
+        readonly content: readonly ({
+            readonly type: "text";
+            readonly text: string;
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+        } | {
+            readonly type: "image";
+            readonly source: {
+                readonly type: "base64";
+                readonly media_type: string;
+                readonly data: string;
+            };
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+        } | {
+            readonly type: "document";
+            readonly source: {
+                readonly type: "base64";
+                readonly media_type: "application/pdf";
+                readonly data: string;
+            };
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+        } | {
+            readonly type: "tool_result";
+            readonly content: string | readonly ({
+                readonly type: "text";
+                readonly text: string;
+                readonly cache_control?: {
+                    readonly type: "ephemeral";
+                    readonly ttl?: "1h" | "5m" | undefined;
+                } | undefined;
+            } | {
+                readonly type: "image";
+                readonly source: {
+                    readonly type: "base64";
+                    readonly media_type: string;
+                    readonly data: string;
+                };
+                readonly cache_control?: {
+                    readonly type: "ephemeral";
+                    readonly ttl?: "1h" | "5m" | undefined;
+                } | undefined;
+            } | {
+                readonly type: "document";
+                readonly source: {
+                    readonly type: "base64";
+                    readonly media_type: "application/pdf";
+                    readonly data: string;
+                };
+                readonly cache_control?: {
+                    readonly type: "ephemeral";
+                    readonly ttl?: "1h" | "5m" | undefined;
+                } | undefined;
+            })[];
+            readonly tool_use_id: string;
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+            readonly is_error?: boolean | undefined;
+        })[];
+    } | {
+        readonly role: "assistant";
+        readonly content: readonly ({
+            readonly type: "text";
+            readonly text: string;
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+        } | {
+            readonly id: string;
+            readonly type: "tool_use";
+            readonly name: string;
+            readonly input: unknown;
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+        } | {
+            readonly id: string;
+            readonly type: "server_tool_use";
+            readonly name: string;
+            readonly input: unknown;
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+        } | {
+            readonly type: "web_search_tool_result" | "code_execution_tool_result" | "web_fetch_tool_result";
+            readonly content: unknown;
+            readonly tool_use_id: string;
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+        } | {
+            readonly type: "thinking";
+            readonly thinking: string;
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+            readonly signature?: string | undefined;
+        } | {
+            readonly data: string;
+            readonly type: "redacted_thinking";
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+        })[];
+    } | {
+        readonly role: "system";
+        readonly content: readonly {
+            readonly type: "text";
+            readonly text: string;
+            readonly cache_control?: {
+                readonly type: "ephemeral";
+                readonly ttl?: "1h" | "5m" | undefined;
+            } | undefined;
+        }[];
+    })[];
+    readonly stream: true;
+    readonly system?: readonly {
+        readonly type: "text";
+        readonly text: string;
+        readonly cache_control?: {
+            readonly type: "ephemeral";
+            readonly ttl?: "1h" | "5m" | undefined;
+        } | undefined;
+    }[] | undefined;
+    readonly tools?: readonly {
+        readonly description: string;
+        readonly name: string;
+        readonly input_schema: {
+            readonly [x: string]: unknown;
+        };
+        readonly cache_control?: {
+            readonly type: "ephemeral";
+            readonly ttl?: "1h" | "5m" | undefined;
+        } | undefined;
+    }[] | undefined;
+    readonly temperature?: number | undefined;
+    readonly thinking?: {
+        readonly type: "enabled";
+        readonly budget_tokens: number;
+    } | {
+        readonly type: "adaptive";
+        readonly display?: "summarized" | "omitted" | undefined;
+    } | {
+        readonly type: "disabled";
+    } | undefined;
+    readonly tool_choice?: {
+        readonly type: "none" | "auto" | "any";
+    } | {
+        readonly type: "tool";
+        readonly name: string;
+    } | undefined;
+    readonly top_p?: number | undefined;
+    readonly top_k?: number | undefined;
+    readonly stop_sequences?: readonly string[] | undefined;
+    readonly output_config?: {
+        readonly effort?: string | undefined;
+    } | undefined;
+}, import("../route/transport/http.js").HttpPrepared<string>>;
+export * as AnthropicMessages from "./anthropic-messages.js";