@qvac/sdk
API reference — v0.4.1
| Function | Summary | Signature |
|---|---|---|
cancel() | Cancels an ongoing operation. | cancel(params): Promise<void> |
close() | Closes the RPC connection. | close(): Promise<void> |
completion() | Generates completion from a language model based on conversation history. | completion(params): object |
deleteCache() | Deletes KV cache files. | deleteCache(params): Promise<{ success: boolean }> |
downloadAsset() | Downloads an asset (model file) without loading it into memory. | downloadAsset(options): Promise<string> |
embed() | Generates embeddings for text using a specified model. | embed(params): Promise<number[]> |
getLogger() | Creates a logger instance. | getLogger(namespace, options?): Logger |
getModelByName() | Retrieves a model by its name. | getModelByName(name): HyperdriveItem | undefined |
getModelBySrc() | Retrieves a model by its source. | getModelBySrc(modelId, hyperdriveKey): HyperdriveItem | undefined |
getModelInfo() | Retrieves information about a model. | getModelInfo(params): Promise<object> |
loadModel() | Loads a machine learning model from a local path, remote URL, or Hyperdrive key. | loadModel(options): Promise<string> |
loggingStream() | Streams model logs in real-time. | loggingStream(params): AsyncGenerator<object> |
ping() | Sends a ping request to the server and returns the pong response. | ping(): Promise<{ number: number, type: "pong" }> |
ragDeleteEmbeddings() | Deletes document embeddings from the RAG vector database. | ragDeleteEmbeddings(params): Promise<true> |
ragSaveEmbeddings() | Saves document embeddings in the RAG vector database. | ragSaveEmbeddings(params): Promise<object> |
ragSearch() | Searches for similar documents in the RAG vector database. | ragSearch(params): Promise<object[]> |
startQVACProvider() | Starts a provider service for delegated inference. | startQVACProvider(params): Promise<object> |
stopQVACProvider() | Stops a running provider service and leaves the specified topic. | stopQVACProvider(params): Promise<object> |
textToSpeech() | Converts text to speech audio. | textToSpeech(params): object |
transcribe() | Transcribes audio to text in a single response. | transcribe(params): Promise<string> |
transcribeStream() | Streams audio transcription results in real-time. | transcribeStream(params): AsyncGenerator<string> |
translate() | Translates text from one language to another using a specified translation model. | translate(params): object |
unloadModel() | Unloads a previously loaded model from the server. | unloadModel(params): Promise<void> |