langchain_aws.retrievers.kendra.RetrieveResultItem

class langchain_aws.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。

param ScoreAttributes: Optional[dict] = None

Kendra 评分置信度

get_additional_metadata() → dict

文档附加元数据字典。此函数返回除以下内容之外的任何额外元数据：

• 结果ID

• 文档ID

• 来源

• 标题

• 摘要

• 文档属性

返回类型

dict

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

文档属性字典。

返回类型

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

get_excerpt() → str

由Kendra检索到的文档摘录或原文内容。

返回类型

str

get_score_attribute() → str

文档评分置信度

返回类型

str

get_title() → str

文档标题。

返回类型

str

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

将此项目转换为文档。

参数

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

返回类型

文档