langchain_community.retrievers.kendra.RetrieveResultItem

class langchain_community.retrievers.kendra.RetrieveResultItem

基类: ResultItem

检索API结果项。

通过解析和验证关键字参数中的输入数据来创建一个新模型。

如果输入数据无法解析成有效的模型，将引发ValidationError。

参数 Content: Optional[str] = None

项的内容。

参数 DocumentAttributes: Optional[List[DocumentAttribute]] = []

文档属性。

参数 DocumentId: Optional[str] = None

文档ID。

参数 DocumentTitle: Optional[str] = None

文档标题。

参数 DocumentURI: Optional[str] = None

文档URI。

参数 Id: Optional[str] = None

相关结果项的ID。

参数 ScoreAttributes: Optional[dict] = None

Kendra打分的置信度。

get_additional_metadata() → dict

文档附加元数据字典。此函数返回除了以下元数据之外的所有额外元数据

• result_id

• document_id

• source

• title

• 摘要

• document_attributes

返回类型

dict

get_document_attributes_dict() → Dict[str, Optional[Union[str, int, List[str]]]]

文档属性字典。

返回类型

Dict[str, Optional[Union[str, int, List[str]]]]

get_excerpt() → str

文档摘录或原始内容的段落。

返回类型

str

get_score_attribute() → str

文档得分置信度

返回类型

str

get_title() → str

文档标题。

返回类型

str

to_doc(page_content_formatter: ~typing.Callable[[~langchain_community.retrievers.kendra.ResultItem], str] = <function combined_text>) → Document

将此项目转换为文档。

参数

page_content_formatter (Callable[[ResultItem], str]) –

返回类型

文档