langchain.retrievers.document_compressors.cross_encoder_rerank.CrossEncoderReranker¶
- class langchain.retrievers.document_compressors.cross_encoder_rerank.CrossEncoderReranker[source]¶
-
使用CrossEncoder进行重排序的文档压缩器。
通过解析和验证关键字参数中的输入数据来创建一个新模型。
如果输入数据无法解析为有效模型，则抛出ValidationError。
- 参数model: BaseCrossEncoder [必填]¶
用于评分查询与文档之间相似性的CrossEncoder模型。
- 参数top_n: int = 3¶
返回的文档数量。
- async acompress_documents(documents: Sequence[Document], query: str, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None) Sequence[Document]¶
根据查询上下文异步压缩检索到的文档。
- 参数
documents (Sequence[Document]) – 检索到的文档。
query (str) – 查询上下文。
回调函数 (可选：联合：列表：BaseCallbackHandler， BaseCallbackManager]) – 压缩过程中可选的回调函数。
- 返回值
压缩后的文档。
- 返回类型
序列[Document]
- compress_documents(documents: Sequence[Document], query: str, callbacks: Optional[Union[列表[BaseCallbackHandler], BaseCallbackManager]]] = None) Sequence[Document][source]¶
使用CrossEncoder重新排序文档。
- 参数
documents (Sequence：列表：Document) – 要压缩的文档序列。
query (str) – 用于压缩文档的查询。
callbacks (Optional：联合：列表：BaseCallbackHandler， BaseCallbackManager]) – 压缩过程中的回调函数。
- 返回值
压缩文档序列。
- 返回类型
序列[Document]