Skip to main content
Open In ColabOpen on GitHub

阿西斯

Arcee helps with the development of the SLMs—small, specialized, secure, and scalable language models.

本笔记本演示了如何使用 ArceeRetriever 类来检索与 Arcee 的 Domain Adapted Language Models (DALMs) 相关的文档。

设置​

在使用 ArceeRetriever 之前，请确保已将 Arcee API 密钥设置为 ARCEE_API_KEY 环境变量。您也可以将 API 密钥作为命名参数传递。

from langchain_community.retrievers import ArceeRetriever

retriever = ArceeRetriever(
    model="DALM-PubMed",
    # arcee_api_key="ARCEE-API-KEY" # if not already set in the environment
)
API 参考：ArceeRetriever

附加配置​

您还可以根据需要配置 ArceeRetriever 的参数，例如 arcee_api_url、arcee_app_url 和 model_kwargs。 在对象初始化时设置 model_kwargs 会将过滤器和大小作为默认值用于所有后续检索。

retriever = ArceeRetriever(
    model="DALM-PubMed",
    # arcee_api_key="ARCEE-API-KEY", # if not already set in the environment
    arcee_api_url="https://custom-api.arcee.ai",  # default is https://api.arcee.ai
    arcee_app_url="https://custom-app.arcee.ai",  # default is https://app.arcee.ai
    model_kwargs={
        "size": 5,
        "filters": [
            {
                "field_name": "document",
                "filter_type": "fuzzy_search",
                "value": "Einstein",
            }
        ],
    },
)

检索文档​

你可以通过提供查询从上传的上下文中检索相关文档。以下是一个示例：

query = "Can AI-driven music therapy contribute to the rehabilitation of patients with disorders of consciousness?"
documents = retriever.invoke(query)

附加参数​

Arcee允许您应用filters并设置检索到的文档数量（以计数为单位）的size。过滤器有助于缩小结果范围。以下是使用这些参数的方法：

# Define filters
filters = [
    {"field_name": "document", "filter_type": "fuzzy_search", "value": "Music"},
    {"field_name": "year", "filter_type": "strict_search", "value": "1905"},
]

# Retrieve documents with filters and size params
documents = retriever.invoke(query, size=5, filters=filters)