@0xplaygrounds/rig-wasm/dist/esm/types.d.ts

A TS and WebAssembly-based port of the Rust agentic AI framework Rig.

export type JSONPrimitive = string | number | boolean | null;
export type JSONValue = JSONPrimitive | JSONObject | JSONArray;
export interface JSONObject {
    [key: string]: JSONValue;
}
export interface JSONArray extends Array<JSONValue> {
}
export interface JsToolObject {
    name: () => string;
    definition: (prompt: string) => ToolDefinition;
    call: (args: JSONObject) => Promise<JSONObject>;
}
export interface ToolDefinition {
    name: string;
    description: string;
    parameters: JSONObject;
}
export interface AgentOpts {
    apiKey: string;
    model: string;
    preamble?: string;
    context?: string[];
    temperature?: number;
    tools?: JsToolObject[];
    dynamicContext?: DynamicContextOpts;
    dynamicTools?: DynamicToolsOpts;
}
export interface DynamicContextOpts {
    sample: number;
    dynamicTools: VectorStore;
}
export interface DynamicToolsOpts {
    sample: number;
    dynamicTools: VectorStore;
}
export interface VectorStore {
    topN: (req: VectorSearchOpts) => Promise<TopNResult[]>;
    topNIds: (req: VectorSearchOpts) => Promise<TopNIdsResult[]>;
}
export interface VectorSearchOpts {
    query: string;
    samples: number;
    additionalParams: Map<string, JSONObject>;
}
export type TopNResult = [CosineSimilarity, EmbeddedDocument, Metadata];
export type TopNIdsResult = [CosineSimilarity, DocumentId];
export type Metadata = JSONObject;
export type CosineSimilarity = number;
export type EmbeddedDocument = string;
export type DocumentId = string;
export interface CanEmbed {
    embedText: (query: string) => Promise<Embedding>;
    embedTexts: (texts: Iterable<string>) => Promise<Embedding[]>;
}
export type Embedding = {
    document: string;
    vec: number[];
};
export interface ModelOpts {
    apiKey: string;
    model: string;
    [key: string]: JSONValue;
}
export interface CompletionOpts {
    preamble?: string;
    messages: Message[];
    documents: Document[];
    tools: ToolDefinition[];
    temperature?: number;
    maxTokens?: number;
    additionalParams?: {
        [key: string]: JSONValue;
    };
}
export interface Message {
    role: Role;
    content: UserContent[];
}
export type Role = "user" | "assistant" | "system" | "developer";
export type ContentType = "text";
export interface UserContent {
    text: string;
    type: string;
}
export interface Document {
    id: string;
    text: string;
    [key: string]: string;
}
export interface ToolDefinition {
    name: string;
    description: string;
    parameters: JSONObject;
}
export interface TranscriptionOpts {
    data: Uint8Array;
    filename?: string;
    language: string;
    prompt?: string;
    temperature?: number;
    additionalParams: {
        [key: string]: JSONValue;
    };
}
export interface ImageGenerationOpts {
    prompt: string;
    height: number;
    width: number;
    [key: string]: JSONValue;
}