EmbeddingResponse

org.llm4s.llmconnect.model.EmbeddingResponse

See theEmbeddingResponse companion object

@Stable

final case class EmbeddingResponse

Successful response carrying embedding vectors and lightweight metadata.

Value parameters

dim: Optional dimensionality, if convenient to surface at response-level.
embeddings: One vector per input text/chunk (or per item).
metadata: Provider/model info etc. (e.g., "provider" -> "openai", "model" -> "...").
modality: Optional overall modality tag (Text, Audio, Video) when known.
usage: Optional token usage statistics (available from providers like OpenAI). Providers can set modality/dim/usage when they know it; callers can ignore safely. Build one with EmbeddingResponse.apply and change it with the with* setters (an Option field's setter takes the value or an Option); the constructor and copy are private, so a new field never breaks callers.

Companion: object
Graph
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Sets the vector dimensionality.

Sets, or with None clears, the vector dimensionality.

Sets the embedding vectors, one per input.

Sets the provider and model metadata.

Sets the overall modality.

Sets, or with None clears, the overall modality.

Sets the token usage.

Sets, or with None clears, the token usage.

In this article

Generated with