@opencode-ai/ai 0.0.0-beta-17492

package/dist/protocols/bedrock-converse.d.ts

@@ -0,0 +1,533 @@
+import { Schema } from "effect";
+import { Route } from "../route/client.js";
+import { Protocol } from "../route/protocol.js";
+import { Usage, type FinishReasonDetails } from "../schema/index.js";
+import { BedrockAuth } from "./utils/bedrock-auth.js";
+import { Lifecycle } from "./utils/lifecycle.js";
+import { ToolStream } from "./utils/tool-stream.js";
+export type { Credentials as BedrockCredentials } from "./utils/bedrock-auth.js";
+declare const BedrockConverseBody: Schema.Struct<{
+    modelId: Schema.String;
+    messages: Schema.$Array<Schema.toTaggedUnion<"role", readonly [Schema.Struct<{
+        readonly role: Schema.Literal<"user">;
+        readonly content: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+            readonly text: Schema.String;
+        }>, Schema.Struct<{
+            readonly image: Schema.Struct<{
+                readonly format: Schema.Literals<readonly ["png", "jpeg", "gif", "webp"]>;
+                readonly source: Schema.Struct<{
+                    readonly bytes: Schema.String;
+                }>;
+            }>;
+        }>, Schema.Struct<{
+            readonly document: Schema.Struct<{
+                readonly format: Schema.Literals<readonly ["pdf", "csv", "doc", "docx", "xls", "xlsx", "html", "txt", "md"]>;
+                readonly name: Schema.String;
+                readonly source: Schema.Struct<{
+                    readonly bytes: Schema.String;
+                }>;
+            }>;
+        }>, Schema.Struct<{
+            readonly toolResult: Schema.Struct<{
+                readonly toolUseId: Schema.String;
+                readonly content: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+                    readonly text: Schema.String;
+                }>, Schema.Struct<{
+                    readonly json: Schema.Unknown;
+                }>, Schema.Struct<{
+                    readonly image: Schema.Struct<{
+                        readonly format: Schema.Literals<readonly ["png", "jpeg", "gif", "webp"]>;
+                        readonly source: Schema.Struct<{
+                            readonly bytes: Schema.String;
+                        }>;
+                    }>;
+                }>, Schema.Struct<{
+                    readonly document: Schema.Struct<{
+                        readonly format: Schema.Literals<readonly ["pdf", "csv", "doc", "docx", "xls", "xlsx", "html", "txt", "md"]>;
+                        readonly name: Schema.String;
+                        readonly source: Schema.Struct<{
+                            readonly bytes: Schema.String;
+                        }>;
+                    }>;
+                }>]>>;
+                readonly status: Schema.optional<Schema.Literals<readonly ["success", "error"]>>;
+            }>;
+        }>, Schema.Struct<{
+            readonly cachePoint: Schema.Struct<{
+                readonly type: Schema.tag<"default">;
+                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 text: Schema.String;
+        }>, Schema.Struct<{
+            readonly reasoningContent: Schema.Union<readonly [Schema.Struct<{
+                readonly reasoningText: Schema.Struct<{
+                    readonly text: Schema.String;
+                    readonly signature: Schema.optional<Schema.String>;
+                }>;
+            }>, Schema.Struct<{
+                readonly redactedContent: Schema.String;
+            }>]>;
+        }>, Schema.Struct<{
+            readonly toolUse: Schema.Struct<{
+                readonly toolUseId: Schema.String;
+                readonly name: Schema.String;
+                readonly input: Schema.Unknown;
+            }>;
+        }>, Schema.Struct<{
+            readonly cachePoint: Schema.Struct<{
+                readonly type: Schema.tag<"default">;
+                readonly ttl: Schema.optional<Schema.Literals<readonly ["5m", "1h"]>>;
+            }>;
+        }>]>>;
+    }>]>>;
+    system: Schema.optional<Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+        readonly text: Schema.String;
+    }>, Schema.Struct<{
+        readonly cachePoint: Schema.Struct<{
+            readonly type: Schema.tag<"default">;
+            readonly ttl: Schema.optional<Schema.Literals<readonly ["5m", "1h"]>>;
+        }>;
+    }>]>>>;
+    inferenceConfig: Schema.optional<Schema.Struct<{
+        readonly maxTokens: Schema.optional<Schema.Number>;
+        readonly temperature: Schema.optional<Schema.Number>;
+        readonly topP: Schema.optional<Schema.Number>;
+        readonly stopSequences: Schema.optional<Schema.$Array<Schema.String>>;
+    }>>;
+    toolConfig: Schema.optional<Schema.Struct<{
+        readonly tools: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+            readonly toolSpec: Schema.Struct<{
+                readonly name: Schema.String;
+                readonly description: Schema.String;
+                readonly inputSchema: Schema.Struct<{
+                    readonly json: Schema.$Record<Schema.String, Schema.Unknown>;
+                }>;
+            }>;
+        }>, Schema.Struct<{
+            readonly cachePoint: Schema.Struct<{
+                readonly type: Schema.tag<"default">;
+                readonly ttl: Schema.optional<Schema.Literals<readonly ["5m", "1h"]>>;
+            }>;
+        }>]>>;
+        readonly toolChoice: Schema.optional<Schema.Union<readonly [Schema.Struct<{
+            readonly auto: Schema.Struct<{}>;
+        }>, Schema.Struct<{
+            readonly any: Schema.Struct<{}>;
+        }>, Schema.Struct<{
+            readonly tool: Schema.Struct<{
+                readonly name: Schema.String;
+            }>;
+        }>]>>;
+    }>>;
+    additionalModelRequestFields: Schema.optional<Schema.$Record<Schema.String, Schema.Unknown>>;
+}>;
+export type BedrockConverseBody = Schema.Schema.Type<typeof BedrockConverseBody>;
+interface ParserState {
+    readonly tools: ToolStream.State<number>;
+    readonly pendingFinish: {
+        readonly reason: FinishReasonDetails;
+        readonly usage?: Usage;
+    } | undefined;
+    readonly hasToolCalls: boolean;
+    readonly lifecycle: Lifecycle.State;
+    readonly reasoningSignatures: Readonly<Record<number, string>>;
+}
+/**
+ * The Bedrock Converse protocol — request body construction, body schema, and
+ * the streaming-event state machine.
+ */
+export declare const protocol: Protocol<{
+    readonly messages: readonly ({
+        readonly role: "user";
+        readonly content: readonly ({
+            readonly cachePoint: {
+                readonly type: "default";
+                readonly ttl?: "1h" | "5m" | undefined;
+            };
+        } | {
+            readonly image: {
+                readonly format: "png" | "jpeg" | "gif" | "webp";
+                readonly source: {
+                    readonly bytes: string;
+                };
+            };
+        } | {
+            readonly document: {
+                readonly format: "pdf" | "csv" | "doc" | "docx" | "xls" | "xlsx" | "html" | "txt" | "md";
+                readonly name: string;
+                readonly source: {
+                    readonly bytes: string;
+                };
+            };
+        } | {
+            readonly text: string;
+        } | {
+            readonly toolResult: {
+                readonly content: readonly ({
+                    readonly image: {
+                        readonly format: "png" | "jpeg" | "gif" | "webp";
+                        readonly source: {
+                            readonly bytes: string;
+                        };
+                    };
+                } | {
+                    readonly document: {
+                        readonly format: "pdf" | "csv" | "doc" | "docx" | "xls" | "xlsx" | "html" | "txt" | "md";
+                        readonly name: string;
+                        readonly source: {
+                            readonly bytes: string;
+                        };
+                    };
+                } | {
+                    readonly text: string;
+                } | {
+                    readonly json: unknown;
+                })[];
+                readonly toolUseId: string;
+                readonly status?: "error" | "success" | undefined;
+            };
+        })[];
+    } | {
+        readonly role: "assistant";
+        readonly content: readonly ({
+            readonly cachePoint: {
+                readonly type: "default";
+                readonly ttl?: "1h" | "5m" | undefined;
+            };
+        } | {
+            readonly text: string;
+        } | {
+            readonly toolUse: {
+                readonly toolUseId: string;
+                readonly name: string;
+                readonly input: unknown;
+            };
+        } | {
+            readonly reasoningContent: {
+                readonly reasoningText: {
+                    readonly text: string;
+                    readonly signature?: string | undefined;
+                };
+            } | {
+                readonly redactedContent: string;
+            };
+        })[];
+    })[];
+    readonly modelId: string;
+    readonly system?: readonly ({
+        readonly cachePoint: {
+            readonly type: "default";
+            readonly ttl?: "1h" | "5m" | undefined;
+        };
+    } | {
+        readonly text: string;
+    })[] | undefined;
+    readonly inferenceConfig?: {
+        readonly maxTokens?: number | undefined;
+        readonly temperature?: number | undefined;
+        readonly topP?: number | undefined;
+        readonly stopSequences?: readonly string[] | undefined;
+    } | undefined;
+    readonly toolConfig?: {
+        readonly tools: readonly ({
+            readonly cachePoint: {
+                readonly type: "default";
+                readonly ttl?: "1h" | "5m" | undefined;
+            };
+        } | {
+            readonly toolSpec: {
+                readonly name: string;
+                readonly description: string;
+                readonly inputSchema: {
+                    readonly json: {
+                        readonly [x: string]: unknown;
+                    };
+                };
+            };
+        })[];
+        readonly toolChoice?: {
+            readonly auto: {};
+        } | {
+            readonly any: {};
+        } | {
+            readonly tool: {
+                readonly name: string;
+            };
+        } | undefined;
+    } | undefined;
+    readonly additionalModelRequestFields?: {
+        readonly [x: string]: unknown;
+    } | undefined;
+}, {
+    readonly metadata?: {
+        readonly usage?: {
+            readonly inputTokens?: number | undefined;
+            readonly outputTokens?: number | undefined;
+            readonly cacheReadInputTokens?: number | undefined;
+            readonly cacheWriteInputTokens?: number | undefined;
+            readonly totalTokens?: number | undefined;
+        } | undefined;
+        readonly metrics?: unknown;
+    } | undefined;
+    readonly messageStart?: {
+        readonly role: string;
+    } | undefined;
+    readonly contentBlockStart?: {
+        readonly contentBlockIndex: number;
+        readonly start?: {
+            readonly toolUse?: {
+                readonly toolUseId: string;
+                readonly name: string;
+            } | undefined;
+        } | undefined;
+    } | undefined;
+    readonly contentBlockDelta?: {
+        readonly contentBlockIndex: number;
+        readonly delta?: {
+            readonly text?: string | undefined;
+            readonly toolUse?: {
+                readonly input: string;
+            } | undefined;
+            readonly reasoningContent?: {
+                readonly data?: string | undefined;
+                readonly text?: string | undefined;
+                readonly signature?: string | undefined;
+                readonly redactedContent?: string | undefined;
+            } | undefined;
+        } | undefined;
+    } | undefined;
+    readonly contentBlockStop?: {
+        readonly contentBlockIndex: number;
+    } | undefined;
+    readonly messageStop?: {
+        readonly stopReason: string;
+        readonly additionalModelResponseFields?: unknown;
+    } | undefined;
+    readonly internalServerException?: {
+        readonly message?: string | undefined;
+        readonly originalMessage?: string | undefined;
+        readonly originalStatusCode?: number | undefined;
+    } | undefined;
+    readonly modelStreamErrorException?: {
+        readonly message?: string | undefined;
+        readonly originalMessage?: string | undefined;
+        readonly originalStatusCode?: number | undefined;
+    } | undefined;
+    readonly validationException?: {
+        readonly message?: string | undefined;
+        readonly originalMessage?: string | undefined;
+        readonly originalStatusCode?: number | undefined;
+    } | undefined;
+    readonly throttlingException?: {
+        readonly message?: string | undefined;
+        readonly originalMessage?: string | undefined;
+        readonly originalStatusCode?: number | undefined;
+    } | undefined;
+    readonly serviceUnavailableException?: {
+        readonly message?: string | undefined;
+        readonly originalMessage?: string | undefined;
+        readonly originalStatusCode?: number | undefined;
+    } | undefined;
+}, {
+    readonly metadata?: {
+        readonly usage?: {
+            readonly inputTokens?: number | undefined;
+            readonly outputTokens?: number | undefined;
+            readonly cacheReadInputTokens?: number | undefined;
+            readonly cacheWriteInputTokens?: number | undefined;
+            readonly totalTokens?: number | undefined;
+        } | undefined;
+        readonly metrics?: unknown;
+    } | undefined;
+    readonly messageStart?: {
+        readonly role: string;
+    } | undefined;
+    readonly contentBlockStart?: {
+        readonly contentBlockIndex: number;
+        readonly start?: {
+            readonly toolUse?: {
+                readonly toolUseId: string;
+                readonly name: string;
+            } | undefined;
+        } | undefined;
+    } | undefined;
+    readonly contentBlockDelta?: {
+        readonly contentBlockIndex: number;
+        readonly delta?: {
+            readonly text?: string | undefined;
+            readonly toolUse?: {
+                readonly input: string;
+            } | undefined;
+            readonly reasoningContent?: {
+                readonly data?: string | undefined;
+                readonly text?: string | undefined;
+                readonly signature?: string | undefined;
+                readonly redactedContent?: string | undefined;
+            } | undefined;
+        } | undefined;
+    } | undefined;
+    readonly contentBlockStop?: {
+        readonly contentBlockIndex: number;
+    } | undefined;
+    readonly messageStop?: {
+        readonly stopReason: string;
+        readonly additionalModelResponseFields?: unknown;
+    } | undefined;
+    readonly internalServerException?: {
+        readonly message?: string | undefined;
+        readonly originalMessage?: string | undefined;
+        readonly originalStatusCode?: number | undefined;
+    } | undefined;
+    readonly modelStreamErrorException?: {
+        readonly message?: string | undefined;
+        readonly originalMessage?: string | undefined;
+        readonly originalStatusCode?: number | undefined;
+    } | undefined;
+    readonly validationException?: {
+        readonly message?: string | undefined;
+        readonly originalMessage?: string | undefined;
+        readonly originalStatusCode?: number | undefined;
+    } | undefined;
+    readonly throttlingException?: {
+        readonly message?: string | undefined;
+        readonly originalMessage?: string | undefined;
+        readonly originalStatusCode?: number | undefined;
+    } | undefined;
+    readonly serviceUnavailableException?: {
+        readonly message?: string | undefined;
+        readonly originalMessage?: string | undefined;
+        readonly originalStatusCode?: number | undefined;
+    } | undefined;
+}, ParserState>;
+export declare const route: Route<{
+    readonly messages: readonly ({
+        readonly role: "user";
+        readonly content: readonly ({
+            readonly cachePoint: {
+                readonly type: "default";
+                readonly ttl?: "1h" | "5m" | undefined;
+            };
+        } | {
+            readonly image: {
+                readonly format: "png" | "jpeg" | "gif" | "webp";
+                readonly source: {
+                    readonly bytes: string;
+                };
+            };
+        } | {
+            readonly document: {
+                readonly format: "pdf" | "csv" | "doc" | "docx" | "xls" | "xlsx" | "html" | "txt" | "md";
+                readonly name: string;
+                readonly source: {
+                    readonly bytes: string;
+                };
+            };
+        } | {
+            readonly text: string;
+        } | {
+            readonly toolResult: {
+                readonly content: readonly ({
+                    readonly image: {
+                        readonly format: "png" | "jpeg" | "gif" | "webp";
+                        readonly source: {
+                            readonly bytes: string;
+                        };
+                    };
+                } | {
+                    readonly document: {
+                        readonly format: "pdf" | "csv" | "doc" | "docx" | "xls" | "xlsx" | "html" | "txt" | "md";
+                        readonly name: string;
+                        readonly source: {
+                            readonly bytes: string;
+                        };
+                    };
+                } | {
+                    readonly text: string;
+                } | {
+                    readonly json: unknown;
+                })[];
+                readonly toolUseId: string;
+                readonly status?: "error" | "success" | undefined;
+            };
+        })[];
+    } | {
+        readonly role: "assistant";
+        readonly content: readonly ({
+            readonly cachePoint: {
+                readonly type: "default";
+                readonly ttl?: "1h" | "5m" | undefined;
+            };
+        } | {
+            readonly text: string;
+        } | {
+            readonly toolUse: {
+                readonly toolUseId: string;
+                readonly name: string;
+                readonly input: unknown;
+            };
+        } | {
+            readonly reasoningContent: {
+                readonly reasoningText: {
+                    readonly text: string;
+                    readonly signature?: string | undefined;
+                };
+            } | {
+                readonly redactedContent: string;
+            };
+        })[];
+    })[];
+    readonly modelId: string;
+    readonly system?: readonly ({
+        readonly cachePoint: {
+            readonly type: "default";
+            readonly ttl?: "1h" | "5m" | undefined;
+        };
+    } | {
+        readonly text: string;
+    })[] | undefined;
+    readonly inferenceConfig?: {
+        readonly maxTokens?: number | undefined;
+        readonly temperature?: number | undefined;
+        readonly topP?: number | undefined;
+        readonly stopSequences?: readonly string[] | undefined;
+    } | undefined;
+    readonly toolConfig?: {
+        readonly tools: readonly ({
+            readonly cachePoint: {
+                readonly type: "default";
+                readonly ttl?: "1h" | "5m" | undefined;
+            };
+        } | {
+            readonly toolSpec: {
+                readonly name: string;
+                readonly description: string;
+                readonly inputSchema: {
+                    readonly json: {
+                        readonly [x: string]: unknown;
+                    };
+                };
+            };
+        })[];
+        readonly toolChoice?: {
+            readonly auto: {};
+        } | {
+            readonly any: {};
+        } | {
+            readonly tool: {
+                readonly name: string;
+            };
+        } | undefined;
+    } | undefined;
+    readonly additionalModelRequestFields?: {
+        readonly [x: string]: unknown;
+    } | undefined;
+}, import("../route/transport/http.js").HttpPrepared<object>>;
+export declare const sigV4Auth: (credentials: BedrockAuth.Credentials | undefined, options?: {
+    readonly service?: string;
+    readonly name?: string;
+}) => import("../route.js").AuthShape;
+export * as BedrockConverse from "./bedrock-converse.js";