Function: embed()
function embed(options: {
abortSignal?: AbortSignal;
model: string;
retries?: number;
text: string;
}): Promise<{
embedding: number[];
}>;Defined in: retrieval/src/embed.ts:18
Embed a single text value.
Parameters
| Parameter | Type |
|---|---|
options | { abortSignal?: AbortSignal; model: string; retries?: number; text: string; } |
options.abortSignal? | AbortSignal |
options.model | string |
options.retries? | number |
options.text | string |
Returns
Promise<{
embedding: number[];
}>
Example
import { embed } from '@kernl-sdk/retrieval';
import { openai } from '@kernl-sdk/ai/openai';
const { embedding } = await embed({
model: 'openai/text-embedding-3-small',
text: 'sunny day at the beach',
retries: 2,
});