@opencode-ai/ai 0.0.0-beta-17492

package/dist/protocols/gemini.d.ts

@@ -0,0 +1,300 @@
+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";
+export declare const DEFAULT_BASE_URL = "https://generativelanguage.googleapis.com/v1beta";
+export interface OptionsInput {
+    readonly [key: string]: unknown;
+    readonly cachedContent?: string;
+    readonly safetySettings?: ReadonlyArray<{
+        readonly category: "HARM_CATEGORY_UNSPECIFIED" | "HARM_CATEGORY_HATE_SPEECH" | "HARM_CATEGORY_DANGEROUS_CONTENT" | "HARM_CATEGORY_HARASSMENT" | "HARM_CATEGORY_SEXUALLY_EXPLICIT" | "HARM_CATEGORY_CIVIC_INTEGRITY" | (string & {});
+        readonly threshold: "HARM_BLOCK_THRESHOLD_UNSPECIFIED" | "BLOCK_LOW_AND_ABOVE" | "BLOCK_MEDIUM_AND_ABOVE" | "BLOCK_ONLY_HIGH" | "BLOCK_NONE" | "OFF" | (string & {});
+    }>;
+    readonly serviceTier?: "standard" | "flex" | "priority" | (string & {});
+    readonly thinkingConfig?: {
+        readonly thinkingBudget?: number;
+        readonly includeThoughts?: boolean;
+        readonly thinkingLevel?: "minimal" | "low" | "medium" | "high" | (string & {});
+    };
+}
+export type ProviderOptionsInput = ProviderOptions & {
+    readonly gemini?: OptionsInput;
+};
+declare const GeminiBody: Schema.Struct<{
+    cachedContent: Schema.optional<Schema.String>;
+    contents: Schema.$Array<Schema.Struct<{
+        readonly role: Schema.Literals<readonly ["user", "model"]>;
+        readonly parts: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+            readonly text: Schema.String;
+            readonly thought: Schema.optional<Schema.Boolean>;
+            readonly thoughtSignature: Schema.optional<Schema.String>;
+        }>, Schema.Struct<{
+            readonly inlineData: Schema.Struct<{
+                readonly mimeType: Schema.String;
+                readonly data: Schema.String;
+            }>;
+        }>, Schema.Struct<{
+            readonly functionCall: Schema.Struct<{
+                readonly id: Schema.optional<Schema.String>;
+                readonly name: Schema.String;
+                readonly args: Schema.Unknown;
+            }>;
+            readonly thoughtSignature: Schema.optional<Schema.String>;
+        }>, Schema.Struct<{
+            readonly functionResponse: Schema.Struct<{
+                readonly id: Schema.optional<Schema.String>;
+                readonly name: Schema.String;
+                readonly response: Schema.Unknown;
+                readonly parts: Schema.optional<Schema.$Array<Schema.Struct<{
+                    readonly inlineData: Schema.Struct<{
+                        readonly mimeType: Schema.String;
+                        readonly data: Schema.String;
+                    }>;
+                }>>>;
+            }>;
+        }>]>>;
+    }>>;
+    safetySettings: Schema.optional<Schema.$Array<Schema.Struct<{
+        readonly category: Schema.String;
+        readonly threshold: Schema.String;
+    }>>>;
+    serviceTier: Schema.optional<Schema.String>;
+    systemInstruction: Schema.optional<Schema.Struct<{
+        readonly parts: Schema.$Array<Schema.Struct<{
+            readonly text: Schema.String;
+        }>>;
+    }>>;
+    tools: Schema.optional<Schema.$Array<Schema.Struct<{
+        readonly functionDeclarations: Schema.$Array<Schema.Struct<{
+            readonly name: Schema.String;
+            readonly description: Schema.String;
+            readonly parameters: Schema.optional<Schema.$Record<Schema.String, Schema.Unknown>>;
+        }>>;
+    }>>>;
+    toolConfig: Schema.optional<Schema.Struct<{
+        readonly functionCallingConfig: Schema.Struct<{
+            readonly mode: Schema.Literals<readonly ["AUTO", "NONE", "ANY"]>;
+            readonly allowedFunctionNames: Schema.optional<Schema.$Array<Schema.String>>;
+        }>;
+    }>>;
+    generationConfig: Schema.optional<Schema.Struct<{
+        readonly maxOutputTokens: Schema.optional<Schema.Number>;
+        readonly temperature: Schema.optional<Schema.Number>;
+        readonly topP: Schema.optional<Schema.Number>;
+        readonly topK: Schema.optional<Schema.Number>;
+        readonly frequencyPenalty: Schema.optional<Schema.Number>;
+        readonly presencePenalty: Schema.optional<Schema.Number>;
+        readonly seed: Schema.optional<Schema.Number>;
+        readonly stopSequences: Schema.optional<Schema.$Array<Schema.String>>;
+        readonly thinkingConfig: Schema.optional<Schema.Struct<{
+            readonly thinkingBudget: Schema.optional<Schema.Number>;
+            readonly includeThoughts: Schema.optional<Schema.Boolean>;
+            readonly thinkingLevel: Schema.optional<Schema.String>;
+        }>>;
+    }>>;
+}>;
+export type GeminiBody = Schema.Schema.Type<typeof GeminiBody>;
+/**
+ * The Gemini protocol — request body construction, body schema, and the
+ * streaming-event state machine. Used by Google AI Studio Gemini and (once
+ * registered) Vertex Gemini.
+ */
+export declare const protocol: Protocol<{
+    readonly contents: readonly {
+        readonly role: "user" | "model";
+        readonly parts: readonly ({
+            readonly inlineData: {
+                readonly mimeType: string;
+                readonly data: string;
+            };
+        } | {
+            readonly text: string;
+            readonly thought?: boolean | undefined;
+            readonly thoughtSignature?: string | undefined;
+        } | {
+            readonly functionCall: {
+                readonly name: string;
+                readonly args: unknown;
+                readonly id?: string | undefined;
+            };
+            readonly thoughtSignature?: string | undefined;
+        } | {
+            readonly functionResponse: {
+                readonly name: string;
+                readonly response: unknown;
+                readonly id?: string | undefined;
+                readonly parts?: readonly {
+                    readonly inlineData: {
+                        readonly mimeType: string;
+                        readonly data: string;
+                    };
+                }[] | undefined;
+            };
+        })[];
+    }[];
+    readonly tools?: readonly {
+        readonly functionDeclarations: readonly {
+            readonly description: string;
+            readonly name: string;
+            readonly parameters?: {
+                readonly [x: string]: unknown;
+            } | undefined;
+        }[];
+    }[] | undefined;
+    readonly toolConfig?: {
+        readonly functionCallingConfig: {
+            readonly mode: "AUTO" | "NONE" | "ANY";
+            readonly allowedFunctionNames?: readonly string[] | undefined;
+        };
+    } | undefined;
+    readonly cachedContent?: string | undefined;
+    readonly safetySettings?: readonly {
+        readonly category: string;
+        readonly threshold: string;
+    }[] | undefined;
+    readonly serviceTier?: string | undefined;
+    readonly systemInstruction?: {
+        readonly parts: readonly {
+            readonly text: string;
+        }[];
+    } | undefined;
+    readonly generationConfig?: {
+        readonly temperature?: number | undefined;
+        readonly topP?: number | undefined;
+        readonly topK?: number | undefined;
+        readonly frequencyPenalty?: number | undefined;
+        readonly presencePenalty?: number | undefined;
+        readonly seed?: number | undefined;
+        readonly stopSequences?: readonly string[] | undefined;
+        readonly thinkingConfig?: {
+            readonly thinkingBudget?: number | undefined;
+            readonly includeThoughts?: boolean | undefined;
+            readonly thinkingLevel?: string | undefined;
+        } | undefined;
+        readonly maxOutputTokens?: number | undefined;
+    } | undefined;
+}, string, {
+    readonly candidates?: readonly {
+        readonly content?: {
+            readonly role: "user" | "model";
+            readonly parts: readonly ({
+                readonly inlineData: {
+                    readonly mimeType: string;
+                    readonly data: string;
+                };
+            } | {
+                readonly text: string;
+                readonly thought?: boolean | undefined;
+                readonly thoughtSignature?: string | undefined;
+            } | {
+                readonly functionCall: {
+                    readonly name: string;
+                    readonly args: unknown;
+                    readonly id?: string | undefined;
+                };
+                readonly thoughtSignature?: string | undefined;
+            } | {
+                readonly functionResponse: {
+                    readonly name: string;
+                    readonly response: unknown;
+                    readonly id?: string | undefined;
+                    readonly parts?: readonly {
+                        readonly inlineData: {
+                            readonly mimeType: string;
+                            readonly data: string;
+                        };
+                    }[] | undefined;
+                };
+            })[];
+        } | undefined;
+        readonly finishReason?: string | undefined;
+    }[] | undefined;
+    readonly usageMetadata?: {
+        readonly cachedContentTokenCount?: number | undefined;
+        readonly thoughtsTokenCount?: number | undefined;
+        readonly promptTokenCount?: number | undefined;
+        readonly candidatesTokenCount?: number | undefined;
+        readonly totalTokenCount?: number | undefined;
+    } | undefined;
+}, {
+    hasToolCalls: boolean;
+    nextToolCallId: number;
+    lifecycle: Lifecycle.State;
+}>;
+export declare const route: Route<{
+    readonly contents: readonly {
+        readonly role: "user" | "model";
+        readonly parts: readonly ({
+            readonly inlineData: {
+                readonly mimeType: string;
+                readonly data: string;
+            };
+        } | {
+            readonly text: string;
+            readonly thought?: boolean | undefined;
+            readonly thoughtSignature?: string | undefined;
+        } | {
+            readonly functionCall: {
+                readonly name: string;
+                readonly args: unknown;
+                readonly id?: string | undefined;
+            };
+            readonly thoughtSignature?: string | undefined;
+        } | {
+            readonly functionResponse: {
+                readonly name: string;
+                readonly response: unknown;
+                readonly id?: string | undefined;
+                readonly parts?: readonly {
+                    readonly inlineData: {
+                        readonly mimeType: string;
+                        readonly data: string;
+                    };
+                }[] | undefined;
+            };
+        })[];
+    }[];
+    readonly tools?: readonly {
+        readonly functionDeclarations: readonly {
+            readonly description: string;
+            readonly name: string;
+            readonly parameters?: {
+                readonly [x: string]: unknown;
+            } | undefined;
+        }[];
+    }[] | undefined;
+    readonly toolConfig?: {
+        readonly functionCallingConfig: {
+            readonly mode: "AUTO" | "NONE" | "ANY";
+            readonly allowedFunctionNames?: readonly string[] | undefined;
+        };
+    } | undefined;
+    readonly cachedContent?: string | undefined;
+    readonly safetySettings?: readonly {
+        readonly category: string;
+        readonly threshold: string;
+    }[] | undefined;
+    readonly serviceTier?: string | undefined;
+    readonly systemInstruction?: {
+        readonly parts: readonly {
+            readonly text: string;
+        }[];
+    } | undefined;
+    readonly generationConfig?: {
+        readonly temperature?: number | undefined;
+        readonly topP?: number | undefined;
+        readonly topK?: number | undefined;
+        readonly frequencyPenalty?: number | undefined;
+        readonly presencePenalty?: number | undefined;
+        readonly seed?: number | undefined;
+        readonly stopSequences?: readonly string[] | undefined;
+        readonly thinkingConfig?: {
+            readonly thinkingBudget?: number | undefined;
+            readonly includeThoughts?: boolean | undefined;
+            readonly thinkingLevel?: string | undefined;
+        } | undefined;
+        readonly maxOutputTokens?: number | undefined;
+    } | undefined;
+}, import("../route/transport/http.js").HttpPrepared<string>>;
+export * as Gemini from "./gemini.js";