indexers.VectorStore.embed

indexers.VectorStore.embed(query)

Converts text into vector embeddings using the vectoriser and returns a VectorStoreEmbedOutput dataframe with columns ‘id’, ‘text’, and ‘embedding’.

Parameters

Name	Type	Description	Default
query	VectorStoreEmbedInput	The VectorStoreEmbedInput object containing the strings to be embedded and their ids.	required

Returns

Name	Type	Description
VectorStoreEmbedOutput	VectorStoreEmbedOutput	The output object containing the embeddings along with their corresponding ids and texts.

Raises

Name	Type	Description
	DataValidationError	Raised if invalid arguments are passed.
	HookError	Raised if user-defined hooks fail.
	ClassifaiError	Raised if embedding operation fails.