langchain.retrievers.zilliz.ZillizRetriever¶
class langchain.retrievers.zilliz.ZillizRetriever[source]¶
Bases: BaseRetriever
Zilliz API retriever.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
param collection_name: str = 'LangChainCollection'¶
The name of the collection in Zilliz.
param connection_args: Optional[Dict[str, Any]] = None¶
The connection arguments for the Zilliz client.
param consistency_level: str = 'Session'¶
The consistency level for the Zilliz client.
param embedding_function: langchain.schema.embeddings.Embeddings [Required]¶
The underlying embedding function from which documents will be retrieved.
param metadata: Optional[Dict[str, Any]] = None¶
Optional metadata associated with the retriever. Defaults to None
This metadata will be associated with each call to this retriever,
and passed as arguments to the handlers defined in callbacks.
You can use these to eg identify a specific instance of a retriever with its
use case.
param retriever: langchain.schema.retriever.BaseRetriever [Required]¶
The underlying retriever.
param search_params: Optional[dict] = None¶
The search parameters for the Zilliz client.
param store: langchain.vectorstores.zilliz.Zilliz [Required]¶
The underlying Zilliz store.
param tags: Optional[List[str]] = None¶
Optional list of tags associated with the retriever. Defaults to None
These tags will be associated with each call to this retriever,
and passed as arguments to the handlers defined in callbacks.
You can use these to eg identify a specific instance of a retriever with its
use case.