OrkaJS
Orka.JS

TypeScript Types

Complete TypeScript reference for every interface, type, and function exported by Orka AI.

Core Interfaces

interface LLMAdapter {
readonly name: string;
generate(prompt: string, options?: LLMGenerateOptions): Promise<LLMResult>;
embed(text: string | string[]): Promise<number[][]>;
}
 
interface VectorDBAdapter {
readonly name: string;
createCollection(name: string, options?: CreateCollectionOptions): Promise<void>;
deleteCollection(name: string): Promise<void>;
upsert(collection: string, vectors: VectorRecord[]): Promise<void>;
search(collection: string, vector: number[], options?: VectorSearchOptions): Promise<VectorSearchResult[]>;
delete(collection: string, ids: string[]): Promise<void>;
}
 
interface AskResult {
answer: string;
context?: RetrievedContext[];
usage: { promptTokens: number; completionTokens: number; totalTokens: number };
latencyMs: number;
}

Exported Functions

FunctionDescription
createOrka(config)Create an Orka instance
plan(), retrieve(), generate(), verify(), improve()Workflow steps
startNode(), endNode(), actionNode(), conditionNode()Graph nodes
withRetry(fn, options)Retry with exponential backoff
minScore(), maxScore(), maxLatency(), contains()Test assertions

Adapters

OpenAIAdapter

GPT-4o, embeddings

AnthropicAdapter

Claude 3.5 Sonnet

MistralAdapter

Mistral AI models

OllamaAdapter

Local models

MemoryVectorAdapter

In-memory vector store

PineconeAdapter

Pinecone cloud

QdrantAdapter

Qdrant vector DB

ChromaAdapter

ChromaDB

💡 Full Types

Orka AI exports full TypeScript declarations. Your IDE will autocomplete all interfaces, types, and function signatures.