langchain_community.retrievers.arcee.ArceeRetriever¶
class langchain_community.retrievers.arcee.ArceeRetriever[source]¶
Bases: BaseRetriever
Document retriever for Arcee’s Domain Adapted Language Models (DALMs).
To use, set the ARCEE_API_KEY environment variable with your Arcee API key,
or pass arcee_api_key as a named parameter.
Example
from langchain_community.retrievers import ArceeRetriever
retriever = ArceeRetriever(
    model="DALM-PubMed",
    arcee_api_key="ARCEE-API-KEY"
)
documents = retriever.get_relevant_documents("AI-driven music therapy")
Initializes private fields.
param arcee_api_key: pydantic.types.SecretStr [Required]¶
Arcee API Key
Constraints
type = string
writeOnly = True
format = password
param arcee_api_url: str = 'https://api.arcee.ai'¶
Arcee API URL
param arcee_api_version: str = 'v2'¶
Arcee API Version
param arcee_app_url: str = 'https://app.arcee.ai'¶
Arcee App URL
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 model: str [Required]¶
Arcee DALM name
param model_kwargs: Optional[Dict[str, Any]] = None¶
Keyword arguments to pass to the model.
param tags: Optional[List[str]] = None¶
Optional list of tags associated with the retriever. Defaults to None