effect-io-ai

Package: @effect/ai-openai-compat
Module: OpenAiClient

OpenAiClient.Embedding

Represents one embedding item returned by an OpenAI-compatible embeddings API.

Details

The embedding can be returned either as a numeric vector or as a base64-encoded string. The index field identifies the input item that produced this embedding.

Signature

type Embedding = {
  readonly embedding: ReadonlyArray<number> | string
  readonly index: number
  readonly object?: string | undefined
}

Source

Since v4.0.0