langchain.retrievers.remote_retriever.RemoteLangChainRetriever¶
class langchain.retrievers.remote_retriever.RemoteLangChainRetriever[source]¶
Bases: BaseRetriever
LangChain 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 headers: Optional[dict] = None¶
Headers to use for the request.
param input_key: str = 'message'¶
Key to use for the input in the request.
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 metadata_key: str = 'metadata'¶
Key to use for the metadata in the response.
param page_content_key: str = 'page_content'¶
Key to use for the page content in the response.
param response_key: str = 'response'¶
Key to use for the response in the request.
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.
param url: str [Required]¶
URL of the remote LangChain API.