langchain_community.document_compressors.jina_rerank.JinaRerank¶
- class langchain_community.document_compressors.jina_rerank.JinaRerank[source]¶
-
使用 Jina Rerank API 的文档压缩器。
通过解析和验证关键字参数中的输入数据来创建新模型。
如果输入数据无法解析为有效的模型，将引发 ValidationError。
- 参数jina_api_key : Optional[str] = None¶
Jina API密钥。必须直接指定或通过环境变量JINA_API_KEY。
- 参数model : str = 'jina-reranker-v1-base-en'¶
用于重新排序的模型。
- 参数session : Any = None¶
用于与API通信的请求会话。
- 参数top_n : Optional[int] = 3¶
要返回的文档数量。
- 参数user_agent : str = 'langchain'¶
发起请求的应用程序的标识符。
- async acompress_documents(documents: Sequence[Document], query: str, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None) Sequence[Document]¶
根据查询上下文异步压缩检索到的文档。
- 参数
documents (Sequence[Document]) – 检索到的文档。
query (str) – 查询上下文。
callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) – 压缩过程中的可选回调。
- 返回
压缩后的文档。
- 返回类型
Sequence[Document]
- compress_documents(documents: Sequence[Document], query: str, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None) Sequence[Document][source]¶
使用Jina的重新排序API压缩文档。
- 参数
documents (Sequence[Document]) – 要压缩的文档序列。
query (str) – 用于压缩文档的查询。
callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) – 压缩过程中运行的回调。
- 返回
压缩后的文档序列。
- 返回类型
Sequence[Document]
- rerank(documents: Sequence[Union[str, Document, dict]], query: str, *, model: Optional[str] = None, top_n: Optional[int] = -1, max_chunks_per_doc: Optional[int] = None) List[Dict[str, Any]][源代码]¶
根据查询相关度对提供的文档进行排序。
- 参数
查询 (str) – 用于重新排序的查询。
文档 (Sequence[Union[str, Document, dict]]) – 要重新排序的文档序列。
模型 (Optional[str]) – 用于重新排序的模型。默认为 self.model。
top_n (Optional[int]) – 返回的结果数量。如果为 None，则返回所有结果。默认为 self.top_n。
max_chunks_per_doc (Optional[int]) – 从文档中衍生出的最大块数。
- 返回类型
列表[字典[str, 任何类型]]