QueryBundle#

class llama_index.schema.QueryBundle(query_str: str, image_path: Optional[str] = None, custom_embedding_strs: Optional[List[str]] = None, embedding: Optional[List[float]] = None)#

Bases: DataClassJsonMixin

Query bundle.

This dataclass contains the original query string and associated transformations.

Parameters

query_str (str) – the original user-specified query string. This is currently used by all non embedding-based queries.
custom_embedding_strs (list[str]) – list of strings used for embedding the query. This is currently used by all embedding-based queries.
embedding (list[float]) – the stored embedding for the query.

Attributes Summary

`custom_embedding_strs`
`embedding`
`embedding_image`	Use image path for image retrieval.
`embedding_strs`	Use custom embedding strs if specified, otherwise use query str.
`image_path`

Attributes Documentation

custom_embedding_strs: Optional[List[str]] = None#

embedding: Optional[List[float]] = None#

embedding_image#: Use image path for image retrieval.

embedding_strs#: Use custom embedding strs if specified, otherwise use query str.

image_path: Optional[str] = None#