embed( )
Generates embeddings for a single text using a specified model.
function embed(params: { modelId: string; text: string }, options?: { forceNewConnection?: boolean; profiling?: { enabled?: boolean; includeServerBreakdown?: boolean; mode?: "summary" | "verbose" }; timeout?: number }): PromiseParameters
| Name | Type | Required? | Description |
|---|---|---|---|
params | \{ modelId: string; text: string \} | ✓ | The parameters for the embedding |
options | `{ forceNewConnection?: boolean; profiling?: { enabled?: boolean; includeServerBreakdown?: boolean; mode?: "summary" | "verbose" }; timeout?: number }` | ✗ |
Returns
PromiseThrows
| Error | When |
|---|---|
When the response type is invalid or when the embedding fails |
Example
import { embed } from "@qvac/sdk";
const embedding = await embed({
modelId: "my-embeddings-model",
text: "The quick brown fox jumps over the lazy dog",
});
console.log("Embedding dimensions:", embedding.length);downloadAsset( )
Downloads an asset (model file) without loading it into memory. This function is specifically designed for download-only operations and doesn't accept runtime configuration options like modelConfig or delegate. Use this for download-only operations instead of loadModel for better semantic clarity.
Errors
SDK error codes reference