langchain_community.retrievers.kendra.QueryResultItem

class langchain_community.retrievers.kendra.QueryResultItem

基础: ResultItem

查询API结果项。

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

如果输入数据不能解析为有效的模型，将引发 ValidationError。

参数 AdditionalAttributes: Optional[List[AdditionalResultAttribute]] = []

与结果关联的一个或多个附加属性。

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

文档属性。

参数 DocumentExcerpt: Optional[TextWithHighLights] = None

文档文本摘要。

参数 DocumentId: Optional[str] = None

文档ID。

参数 DocumentTitle: TextWithHighLights [Required]

文档标题。

参数 DocumentURI: Optional[str] = None

文档URI。

参数 FeedbackToken: 可选[str] = None

标识特定查询的结果。

参数 格式: 可选[str] = None

如果类型是ANSWER，则格式是

• 表格：表摘要是通过TableExcerpt返回的；

• 文本：文本摘要是通过DocumentExcerpt返回的。

参数 Id: 可选[str] = None

相关结果项的ID。

参数 ScoreAttributes: 可选[dict] = None

Kendra分数置信度

参数 Type: 可选[str] = None

结果类型：DOCUMENT 或 QUESTION_ANSWER 或 ANSWER

get_additional_metadata() → dict

文档额外元数据字典。此函数返回任何额外的元数据（除了以下这些）

• 结果ID

• 文档ID

• 来源

• 标题

• 摘要

• 文档属性

返回类型

dict

get_attribute_value() → str

返回类型

str

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_community.retrievers.kendra.ResultItem], str] = <function combined_text>) → Document

将此条目转换为文档。

参数

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

返回类型

文档