Query Bundle#

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

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.

property embedding_image: List[Union[str, BytesIO]]#

Use image path for image retrieval.

property embedding_strs: List[str]#

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