ArceeWrapper#
- class langchain_community.utilities.arcee.ArceeWrapper(arcee_api_key: str | SecretStr, arcee_api_url: str, arcee_api_version: str, model_kwargs: Dict[str, Any] | None, model_name: str)[source]#
Wrapper for Arcee API.
For more details, see: https://www.arcee.ai/
Initialize ArceeWrapper.
- Parameters:
arcee_api_key (str | SecretStr) – API key for Arcee API.
arcee_api_url (str) – URL for Arcee API.
arcee_api_version (str) – Version of Arcee API.
model_kwargs (Dict[str, Any] | None) – Keyword arguments for Arcee API.
model_name (str) – Name of an Arcee model.
Methods
__init__(arcee_api_key, arcee_api_url, ...)Initialize ArceeWrapper.
generate(prompt, **kwargs)Generate text from Arcee DALM.
retrieve(query, **kwargs)Retrieve {size} contexts with your retriever for a given query
- __init__(arcee_api_key: str | SecretStr, arcee_api_url: str, arcee_api_version: str, model_kwargs: Dict[str, Any] | None, model_name: str)[source]#
Initialize ArceeWrapper.
- Parameters:
arcee_api_key (str | SecretStr) – API key for Arcee API.
arcee_api_url (str) – URL for Arcee API.
arcee_api_version (str) – Version of Arcee API.
model_kwargs (Dict[str, Any] | None) – Keyword arguments for Arcee API.
model_name (str) – Name of an Arcee model.
- generate(prompt: str, **kwargs: Any) str[source]#
Generate text from Arcee DALM.
- Parameters:
prompt (str) – Prompt to generate text from.
size – The max number of context results to retrieve. Defaults to 3. (Can be less if filters are provided).
filters – Filters to apply to the context dataset.
kwargs (Any) –
- Return type:
str
- retrieve(query: str, **kwargs: Any) List[Document][source]#
Retrieve {size} contexts with your retriever for a given query
- Parameters:
query (str) – Query to submit to the model
size – The max number of context results to retrieve. Defaults to 3. (Can be less if filters are provided).
filters – Filters to apply to the context dataset.
kwargs (Any) –
- Return type:
List[Document]