embed()

Generate an embedding for a single value using an embedding model.

This is ideal for use cases where you need to embed a single value to e.g. retrieve similar items or to use the embedding in a downstream task.

import { embed } from 'ai';


const { embedding } = await embed({
  model: 'openai/text-embedding-3-small',
  value: 'sunny day at the beach',
});

Import 

import { embed } from "ai"

API Signature

Parameters

model:

EmbeddingModel

value:

VALUE

maxRetries?:

number

abortSignal?:

AbortSignal

headers?:

Record<string, string>

experimental_telemetry?:

TelemetrySettings
TelemetrySettings

isEnabled?:

boolean

recordInputs?:

boolean

recordOutputs?:

boolean

functionId?:

string

metadata?:

Record<string, string | number | boolean | Array<null | undefined | string> | Array<null | undefined | number> | Array<null | undefined | boolean>>

tracer?:

Tracer

Returns

value:

VALUE

embedding:

number[]

usage:

EmbeddingModelUsage
EmbeddingModelUsage

tokens:

number

response?:

Response
Response

headers?:

Record<string, string>

body?:

unknown

providerMetadata?:

ProviderMetadata | undefined