indexers.VectorStore.embed

indexers.VectorStore.embed(query)

Generates vector embeddings from a VectorStoreEmbedInput object.

Accepts a VectorStoreEmbedInput object and generates vector embeddings for its text content using the vectoriser attribute. Any preprocessing hooks set on the instance are applied to the input before embedding, and any postprocessing hooks are applied to the output before it is returned.

Parameters

Name Type Description Default
query VectorStoreEmbedInput Input object containing the text to be embedded and their corresponding ids. required

Returns

Name Type Description
VectorStoreEmbedOutput VectorStoreEmbedOutput Output object containing the generated embeddings together with their corresponding ids and original texts.

Raises

Name Type Description
DataValidationError If invalid arguments are passed.
HookError If a preprocessing or postprocessing hook raises an exception.
ClassifaiError If the embedding operation fails.