@tarkahq/sdk 0.0.0-stage → 0.3.0

package/dist/esm/generated/tarka/inference/v1/inference.d.ts

@@ -0,0 +1,699 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+import { Empty } from "../../../google/protobuf/empty.js";
+export declare const protobufPackage = "tarka.inference.v1";
+/**
+ * OpenAIRequest and OpenAIResponse intentionally carry opaque JSON objects.
+ * This keeps the compatibility boundary forward-compatible as OpenAI adds
+ * request and response union variants without weakening the typed Tarka RPCs.
+ */
+export interface OpenAIRequest {
+    body: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface OpenAIResponse {
+    body: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface OpenAIStreamEvent {
+    type: string;
+    data: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface ResponseIDRequest {
+    responseId: string;
+}
+export interface ListModelsRequest {
+}
+export interface RetrieveModelRequest {
+    model: string;
+}
+export interface ListModelsResponse {
+    object: string;
+    data: Model[];
+}
+export interface Model {
+    id: string;
+    object: string;
+    created: bigint;
+    ownedBy: string;
+    shutdownDate?: string | undefined;
+}
+export interface ChatCompletionRequest {
+    model: string;
+    messages: ChatMessage[];
+    stream: boolean;
+    maxTokens?: number | undefined;
+    temperature?: number | undefined;
+    topP?: number | undefined;
+    topK?: number | undefined;
+    repeatPenalty?: number | undefined;
+    presencePenalty?: number | undefined;
+    frequencyPenalty?: number | undefined;
+    stop: any | undefined;
+    seed?: bigint | undefined;
+    user: string;
+    tools: Tool[];
+    toolChoice: any | undefined;
+    functions: FunctionDefinition[];
+    functionCall: any | undefined;
+    n?: number | undefined;
+    maxCompletionTokens?: number | undefined;
+    responseFormat: {
+        [key: string]: any;
+    } | undefined;
+    logprobs?: boolean | undefined;
+    topLogprobs?: number | undefined;
+    logitBias: {
+        [key: string]: number;
+    };
+    parallelToolCalls?: boolean | undefined;
+    streamOptions: StreamOptions | undefined;
+    modalities: string[];
+    audio: {
+        [key: string]: any;
+    } | undefined;
+    prediction: {
+        [key: string]: any;
+    } | undefined;
+    reasoningEffort: string;
+    serviceTier: string;
+    store?: boolean | undefined;
+    metadata: {
+        [key: string]: any;
+    } | undefined;
+    extraBody: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface ChatCompletionRequest_LogitBiasEntry {
+    key: string;
+    value: number;
+}
+export interface ChatMessage {
+    role: string;
+    content: any | undefined;
+    name: string;
+    toolCalls: ToolCall[];
+    toolCallId: string;
+    functionCall: {
+        [key: string]: any;
+    } | undefined;
+    refusal: string;
+    audio: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface Tool {
+    type: string;
+    function: FunctionDefinition | undefined;
+    custom: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface FunctionDefinition {
+    name: string;
+    description: string;
+    parameters: {
+        [key: string]: any;
+    } | undefined;
+    strict?: boolean | undefined;
+}
+export interface ToolCall {
+    id: string;
+    type: string;
+    function: FunctionCall | undefined;
+    custom: {
+        [key: string]: any;
+    } | undefined;
+    index?: number | undefined;
+}
+export interface FunctionCall {
+    name: string;
+    arguments: string;
+}
+export interface StreamOptions {
+    includeUsage?: boolean | undefined;
+    includeObfuscation?: boolean | undefined;
+}
+export interface ChatCompletion {
+    id: string;
+    object: string;
+    created: bigint;
+    model: string;
+    choices: ChatChoice[];
+    usage: Usage | undefined;
+    systemFingerprint: string;
+    serviceTier: string;
+    extensions: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface ChatChoice {
+    index: number;
+    message: ChatMessage | undefined;
+    finishReason: string;
+    logprobs: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface ChatCompletionChunk {
+    id: string;
+    object: string;
+    created: bigint;
+    model: string;
+    choices: ChatChunkChoice[];
+    usage: Usage | undefined;
+    systemFingerprint: string;
+    serviceTier: string;
+    extensions: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface ChatChunkChoice {
+    index: number;
+    delta: ChatDelta | undefined;
+    finishReason: string;
+    logprobs: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface ChatDelta {
+    role: string;
+    content: any | undefined;
+    toolCalls: ToolCall[];
+    refusal: string;
+    audio: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface Usage {
+    promptTokens: bigint;
+    completionTokens: bigint;
+    totalTokens: bigint;
+    costMicrocents: bigint;
+    promptTokensDetails: {
+        [key: string]: any;
+    } | undefined;
+    completionTokensDetails: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface OCRRequest {
+    model: string;
+    image: string;
+    images: string[];
+    prompt: string;
+    stream: boolean;
+    maxTokens?: number | undefined;
+    temperature?: number | undefined;
+    extraBody: {
+        [key: string]: any;
+    } | undefined;
+    /**
+     * Controls the top-level text representation while structured page data is
+     * returned in OCRResponse.pages when requested.
+     */
+    outputFormat: string;
+    /** Optional bounded expansions. Supported values are "blocks" and "layout". */
+    include: string[];
+    /** Layout geometry used for structured blocks: auto, box, quadrilateral, or polygon. */
+    layoutShape: string;
+}
+export interface OCRResponse {
+    id: string;
+    object: string;
+    created: bigint;
+    model: string;
+    text: string;
+    usage: Usage | undefined;
+    extensions: {
+        [key: string]: any;
+    } | undefined;
+    pages: DocumentPage[];
+}
+export interface OCRChunk {
+    id: string;
+    object: string;
+    created: bigint;
+    model: string;
+    text: string;
+    usage: Usage | undefined;
+    extensions: {
+        [key: string]: any;
+    } | undefined;
+    pages: DocumentPage[];
+}
+/**
+ * DocumentPage is the Tarka structured-document extension to the OCR surface.
+ * text remains the portable representation; markdown and blocks are additive.
+ */
+export interface DocumentPage {
+    index: number;
+    width: number;
+    height: number;
+    text: string;
+    markdown: string;
+    blocks: DocumentBlock[];
+}
+export interface DocumentBlock {
+    id: string;
+    label: string;
+    readingOrder?: number | undefined;
+    bbox: BoundingBox | undefined;
+    polygon: Point[];
+    confidence?: number | undefined;
+    content: string;
+}
+export interface Point {
+    x: number;
+    y: number;
+}
+export interface BoundingBox {
+    xMin: number;
+    yMin: number;
+    xMax: number;
+    yMax: number;
+}
+export interface DocumentLayoutRequest {
+    model: string;
+    image: string;
+    threshold?: number | undefined;
+    /** Geometry returned for regions: auto, box, quadrilateral, or polygon. */
+    shape: string;
+    labels: string[];
+    extraBody: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface DocumentLayoutResponse {
+    id: string;
+    object: string;
+    created: bigint;
+    model: string;
+    width: number;
+    height: number;
+    regions: DocumentRegion[];
+    usage: Usage | undefined;
+    extensions: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface DocumentRegion {
+    id: string;
+    label: string;
+    classId: number;
+    score: number;
+    bbox: BoundingBox | undefined;
+    polygon: Point[];
+    readingOrder: number;
+}
+export interface AudioTranscriptionRequest {
+    file: Buffer;
+    filename: string;
+    contentType: string;
+    model: string;
+    language: string;
+    prompt: string;
+    responseFormat: string;
+    temperature?: number | undefined;
+    timestampGranularities: string[];
+    extraBody: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface AudioTranslationRequest {
+    file: Buffer;
+    filename: string;
+    contentType: string;
+    model: string;
+    prompt: string;
+    responseFormat: string;
+    temperature?: number | undefined;
+    timestampGranularities: string[];
+    extraBody: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface AudioTextResponse {
+    text: string;
+    task: string;
+    language: string;
+    duration: number;
+    words: {
+        [key: string]: any;
+    }[];
+    segments: {
+        [key: string]: any;
+    }[];
+    extensions: {
+        [key: string]: any;
+    } | undefined;
+    usage: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface SpeechRequest {
+    model: string;
+    input: string;
+    voice: string;
+    responseFormat: string;
+    speed?: number | undefined;
+    instructions: string;
+    streamFormat: string;
+    extraBody: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface AudioChunk {
+    data: Buffer;
+    contentType: string;
+}
+export interface VoiceCloneRequest {
+    model: string;
+    name: string;
+    sample: Buffer;
+    filename: string;
+    contentType: string;
+    consentSignedBy: string;
+    consentDate: string;
+    extraBody: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface VoiceClone {
+    id: string;
+    object: string;
+    created: bigint;
+    model: string;
+    name: string;
+    status: string;
+    extensions: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface GetVoiceCloneRequest {
+    voiceId: string;
+}
+export interface DeleteVoiceCloneRequest {
+    voiceId: string;
+}
+export declare const OpenAIRequest: MessageFns<OpenAIRequest>;
+export declare const OpenAIResponse: MessageFns<OpenAIResponse>;
+export declare const OpenAIStreamEvent: MessageFns<OpenAIStreamEvent>;
+export declare const ResponseIDRequest: MessageFns<ResponseIDRequest>;
+export declare const ListModelsRequest: MessageFns<ListModelsRequest>;
+export declare const RetrieveModelRequest: MessageFns<RetrieveModelRequest>;
+export declare const ListModelsResponse: MessageFns<ListModelsResponse>;
+export declare const Model: MessageFns<Model>;
+export declare const ChatCompletionRequest: MessageFns<ChatCompletionRequest>;
+export declare const ChatCompletionRequest_LogitBiasEntry: MessageFns<ChatCompletionRequest_LogitBiasEntry>;
+export declare const ChatMessage: MessageFns<ChatMessage>;
+export declare const Tool: MessageFns<Tool>;
+export declare const FunctionDefinition: MessageFns<FunctionDefinition>;
+export declare const ToolCall: MessageFns<ToolCall>;
+export declare const FunctionCall: MessageFns<FunctionCall>;
+export declare const StreamOptions: MessageFns<StreamOptions>;
+export declare const ChatCompletion: MessageFns<ChatCompletion>;
+export declare const ChatChoice: MessageFns<ChatChoice>;
+export declare const ChatCompletionChunk: MessageFns<ChatCompletionChunk>;
+export declare const ChatChunkChoice: MessageFns<ChatChunkChoice>;
+export declare const ChatDelta: MessageFns<ChatDelta>;
+export declare const Usage: MessageFns<Usage>;
+export declare const OCRRequest: MessageFns<OCRRequest>;
+export declare const OCRResponse: MessageFns<OCRResponse>;
+export declare const OCRChunk: MessageFns<OCRChunk>;
+export declare const DocumentPage: MessageFns<DocumentPage>;
+export declare const DocumentBlock: MessageFns<DocumentBlock>;
+export declare const Point: MessageFns<Point>;
+export declare const BoundingBox: MessageFns<BoundingBox>;
+export declare const DocumentLayoutRequest: MessageFns<DocumentLayoutRequest>;
+export declare const DocumentLayoutResponse: MessageFns<DocumentLayoutResponse>;
+export declare const DocumentRegion: MessageFns<DocumentRegion>;
+export declare const AudioTranscriptionRequest: MessageFns<AudioTranscriptionRequest>;
+export declare const AudioTranslationRequest: MessageFns<AudioTranslationRequest>;
+export declare const AudioTextResponse: MessageFns<AudioTextResponse>;
+export declare const SpeechRequest: MessageFns<SpeechRequest>;
+export declare const AudioChunk: MessageFns<AudioChunk>;
+export declare const VoiceCloneRequest: MessageFns<VoiceCloneRequest>;
+export declare const VoiceClone: MessageFns<VoiceClone>;
+export declare const GetVoiceCloneRequest: MessageFns<GetVoiceCloneRequest>;
+export declare const DeleteVoiceCloneRequest: MessageFns<DeleteVoiceCloneRequest>;
+/**
+ * InferenceService exposes OpenAI-compatible inference and Tarka utility RPCs.
+ * REST /v1 is the canonical compatibility surface. REST /v2 bindings remain as
+ * deprecated migration aliases; the native gRPC package is versioned as v1.
+ */
+export type InferenceServiceDefinition = typeof InferenceServiceDefinition;
+export declare const InferenceServiceDefinition: {
+    readonly name: "InferenceService";
+    readonly fullName: "tarka.inference.v1.InferenceService";
+    readonly methods: {
+        readonly listModels: {
+            readonly name: "ListModels";
+            readonly requestType: typeof ListModelsRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof ListModelsResponse;
+            readonly responseStream: false;
+            readonly options: {
+                readonly _unknownFields: {
+                    readonly 578365826: readonly [Buffer<ArrayBufferLike>];
+                };
+            };
+        };
+        readonly retrieveModel: {
+            readonly name: "RetrieveModel";
+            readonly requestType: typeof RetrieveModelRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof Model;
+            readonly responseStream: false;
+            readonly options: {
+                readonly _unknownFields: {
+                    readonly 578365826: readonly [Buffer<ArrayBufferLike>];
+                };
+            };
+        };
+        readonly createChatCompletion: {
+            readonly name: "CreateChatCompletion";
+            readonly requestType: typeof ChatCompletionRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof ChatCompletion;
+            readonly responseStream: false;
+            readonly options: {
+                readonly _unknownFields: {
+                    readonly 578365826: readonly [Buffer<ArrayBufferLike>];
+                };
+            };
+        };
+        readonly streamChatCompletion: {
+            readonly name: "StreamChatCompletion";
+            readonly requestType: typeof ChatCompletionRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof ChatCompletionChunk;
+            readonly responseStream: true;
+            readonly options: {};
+        };
+        /**
+         * The OpenAI JSON RPCs preserve the complete compatibility payload while
+         * still traversing the same authenticated gRPC service as typed callers.
+         * The REST gateway unwraps body and data at the HTTP boundary.
+         */
+        readonly createOpenAIChatCompletion: {
+            readonly name: "CreateOpenAIChatCompletion";
+            readonly requestType: typeof OpenAIRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof OpenAIResponse;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        readonly streamOpenAIChatCompletion: {
+            readonly name: "StreamOpenAIChatCompletion";
+            readonly requestType: typeof OpenAIRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof OpenAIStreamEvent;
+            readonly responseStream: true;
+            readonly options: {};
+        };
+        readonly createResponse: {
+            readonly name: "CreateResponse";
+            readonly requestType: typeof OpenAIRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof OpenAIResponse;
+            readonly responseStream: false;
+            readonly options: {
+                readonly _unknownFields: {
+                    readonly 578365826: readonly [Buffer<ArrayBufferLike>];
+                };
+            };
+        };
+        readonly streamResponse: {
+            readonly name: "StreamResponse";
+            readonly requestType: typeof OpenAIRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof OpenAIStreamEvent;
+            readonly responseStream: true;
+            readonly options: {};
+        };
+        readonly retrieveResponse: {
+            readonly name: "RetrieveResponse";
+            readonly requestType: typeof ResponseIDRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof OpenAIResponse;
+            readonly responseStream: false;
+            readonly options: {
+                readonly _unknownFields: {
+                    readonly 578365826: readonly [Buffer<ArrayBufferLike>];
+                };
+            };
+        };
+        readonly deleteResponse: {
+            readonly name: "DeleteResponse";
+            readonly requestType: typeof ResponseIDRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof OpenAIResponse;
+            readonly responseStream: false;
+            readonly options: {
+                readonly _unknownFields: {
+                    readonly 578365826: readonly [Buffer<ArrayBufferLike>];
+                };
+            };
+        };
+        readonly cancelResponse: {
+            readonly name: "CancelResponse";
+            readonly requestType: typeof ResponseIDRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof OpenAIResponse;
+            readonly responseStream: false;
+            readonly options: {
+                readonly _unknownFields: {
+                    readonly 578365826: readonly [Buffer<ArrayBufferLike>];
+                };
+            };
+        };
+        readonly createOCR: {
+            readonly name: "CreateOCR";
+            readonly requestType: typeof OCRRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof OCRResponse;
+            readonly responseStream: false;
+            readonly options: {
+                readonly _unknownFields: {
+                    readonly 578365826: readonly [Buffer<ArrayBufferLike>];
+                };
+            };
+        };
+        readonly streamOCR: {
+            readonly name: "StreamOCR";
+            readonly requestType: typeof OCRRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof OCRChunk;
+            readonly responseStream: true;
+            readonly options: {};
+        };
+        readonly createDocumentLayout: {
+            readonly name: "CreateDocumentLayout";
+            readonly requestType: typeof DocumentLayoutRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof DocumentLayoutResponse;
+            readonly responseStream: false;
+            readonly options: {
+                readonly _unknownFields: {
+                    readonly 578365826: readonly [Buffer<ArrayBufferLike>];
+                };
+            };
+        };
+        readonly createTranscription: {
+            readonly name: "CreateTranscription";
+            readonly requestType: typeof AudioTranscriptionRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof AudioTextResponse;
+            readonly responseStream: false;
+            readonly options: {
+                readonly _unknownFields: {
+                    readonly 578365826: readonly [Buffer<ArrayBufferLike>];
+                };
+            };
+        };
+        readonly createTranslation: {
+            readonly name: "CreateTranslation";
+            readonly requestType: typeof AudioTranslationRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof AudioTextResponse;
+            readonly responseStream: false;
+            readonly options: {
+                readonly _unknownFields: {
+                    readonly 578365826: readonly [Buffer<ArrayBufferLike>];
+                };
+            };
+        };
+        readonly createSpeech: {
+            readonly name: "CreateSpeech";
+            readonly requestType: typeof SpeechRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof AudioChunk;
+            readonly responseStream: true;
+            readonly options: {
+                readonly _unknownFields: {
+                    readonly 578365826: readonly [Buffer<ArrayBufferLike>];
+                };
+            };
+        };
+        readonly createVoiceClone: {
+            readonly name: "CreateVoiceClone";
+            readonly requestType: typeof VoiceCloneRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof VoiceClone;
+            readonly responseStream: false;
+            readonly options: {
+                readonly _unknownFields: {
+                    readonly 578365826: readonly [Buffer<ArrayBufferLike>];
+                };
+            };
+        };
+        readonly getVoiceClone: {
+            readonly name: "GetVoiceClone";
+            readonly requestType: typeof GetVoiceCloneRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof VoiceClone;
+            readonly responseStream: false;
+            readonly options: {
+                readonly _unknownFields: {
+                    readonly 578365826: readonly [Buffer<ArrayBufferLike>];
+                };
+            };
+        };
+        readonly deleteVoiceClone: {
+            readonly name: "DeleteVoiceClone";
+            readonly requestType: typeof DeleteVoiceCloneRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof Empty;
+            readonly responseStream: false;
+            readonly options: {
+                readonly _unknownFields: {
+                    readonly 578365826: readonly [Buffer<ArrayBufferLike>];
+                };
+            };
+        };
+    };
+};
+type Builtin = Date | Function | Uint8Array | string | number | boolean | bigint | undefined;
+export type DeepPartial<T> = T extends bigint ? string | number | bigint : T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {
+    $case: string;
+    value: unknown;
+} ? {
+    $case: T["$case"];
+    value?: DeepPartial<T["value"]>;
+} : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+export interface MessageFns<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+    create(base?: DeepPartial<T>): T;
+    fromPartial(object: DeepPartial<T>): T;
+}
+export {};