Skip to main content
Contextual AI 的指令跟随重排序器是世界上第一个旨在根据具体标准(如时效性、来源和元数据)跟随自定义指令来优先化文档的重排序器。凭借在 BEIR 基准上的卓越表现(得分 61.2,大幅领先竞争对手),它为企业 RAG 应用提供了前所未有的控制力和准确性。

核心能力

  • 指令跟随:通过自然语言命令动态控制文档排名
  • 冲突解决:智能处理来自多个知识源的矛盾信息
  • 卓越准确性:在行业基准上实现最先进的性能
  • 无缝集成:可直接替换你 RAG 流水线中现有的重排序器
该重排序器擅长解决企业知识库中的真实世界挑战,例如优先考虑近期文档而非过时文档,或优先使用内部文档而非外部来源。 要了解更多关于我们的指令跟随重排序器及其实际使用示例,请访问我们的产品概览 有关 Contextual AI 产品的完整文档,请访问我们的开发者门户 该集成需要 contextual-client Python SDK。在此处了解更多。

概述

此集成调用 Contextual AI 的基础语言模型。

集成详情

本地可序列化JS 支持下载量版本
ContextualReranklangchain-contextualbetaPyPI - DownloadsPyPI - Version

设置

要访问 Contextual 的重排序模型,你需要创建一个 Contextual AI 账户,获取 API 密钥,并安装 langchain-contextual 集成包。

凭据

访问 app.contextual.ai 注册 Contextual 并生成 API 密钥。完成后设置 CONTEXTUAL_AI_API_KEY 环境变量:
import getpass
import os

if not os.getenv("CONTEXTUAL_AI_API_KEY"):
    os.environ["CONTEXTUAL_AI_API_KEY"] = getpass.getpass(
        "Enter your Contextual API key: "
    )

安装

LangChain Contextual 集成位于 langchain-contextual 包中:
pip install -qU langchain-contextual

实例化

Contextual Reranker 的参数如下:
参数类型描述
documentslist[Document]要重排序的文档序列。文档中包含的任何元数据也将用于重排序。
querystr用于重排序的查询。
modelstr要使用的重排序器版本。目前只有 “ctxl-rerank-en-v1-instruct”。
top_nOptional[int]要返回的结果数量。如果为 None,则返回所有结果。默认为 self.top_n。
instructionOptional[str]用于重排序器的指令。
callbacksOptional[Callbacks]在压缩过程中运行的回调。
from langchain_contextual import ContextualRerank

api_key = ""
model = "ctxl-rerank-en-v1-instruct"

compressor = ContextualRerank(
    model=model,
    api_key=api_key,
)

使用方法

首先,我们将设置全局变量和将使用的示例,并实例化我们的重排序器客户端。
from langchain_core.documents import Document

query = "What is the current enterprise pricing for the RTX 5090 GPU for bulk orders?"
instruction = "Prioritize internal sales documents over market analysis reports. More recent documents should be weighted higher. Enterprise portal content supersedes distributor communications."

document_contents = [
    "Following detailed cost analysis and market research, we have implemented the following changes: AI training clusters will see a 15% uplift in raw compute performance, enterprise support packages are being restructured, and bulk procurement programs (100+ units) for the RTX 5090 Enterprise series will operate on a $2,899 baseline.",
    "Enterprise pricing for the RTX 5090 GPU bulk orders (100+ units) is currently set at $3,100-$3,300 per unit. This pricing for RTX 5090 enterprise bulk orders has been confirmed across all major distribution channels.",
    "RTX 5090 Enterprise GPU requires 450W TDP and 20% cooling overhead.",
]

metadata = [
    {
        "Date": "January 15, 2025",
        "Source": "NVIDIA Enterprise Sales Portal",
        "Classification": "Internal Use Only",
    },
    {"Date": "11/30/2023", "Source": "TechAnalytics Research Group"},
    {
        "Date": "January 25, 2025",
        "Source": "NVIDIA Enterprise Sales Portal",
        "Classification": "Internal Use Only",
    },
]

documents = [
    Document(page_content=content, metadata=metadata[i])
    for i, content in enumerate(document_contents)
]
reranked_documents = compressor.compress_documents(
    query=query,
    instruction=instruction,
    documents=documents,
)

在链中使用

示例即将推出。

API 参考

有关所有 ChatContextual 功能和配置的详细文档,请参阅 GitHub 页面:github.com/ContextualAI//langchain-contextual