查询结果项#

class langchain_aws.retrievers.kendra.QueryResultItem[来源]#

基础类：ResultItem

查询API结果项。

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

如果输入数据无法验证以形成有效模型，则引发 [ValidationError][pydantic_core.ValidationError]。

self 被显式地设为仅位置参数，以允许 self 作为字段名称。

param AdditionalAttributes: List[AdditionalResultAttribute] | None = []#

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

param DocumentAttributes: List[DocumentAttribute] | None = []#

文档属性。

param DocumentExcerpt: TextWithHighLights | None = None#

文档文本的摘录。

param DocumentId: str | None = None#

文档ID。

param DocumentTitle: TextWithHighLights [Required]#

文档标题。

param DocumentURI: str | None = None#

文档的URI。

param FeedbackToken: str | None = None#

标识来自特定查询的特定结果。

param Format: str | None = None#
If the Type is ANSWER, then format is either:

  • 表：表摘录在TableExcerpt中返回；

  • 文本：在DocumentExcerpt中返回一个文本摘录。

param Id: str | None = None#

相关结果项的ID。

param ScoreAttributes: dict | None = None#

Kendra 分数置信度

param Type: str | None = None#

结果类型：DOCUMENT 或 QUESTION_ANSWER 或 ANSWER

get_additional_metadata() → dict[source]#

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

  • 结果ID

  • 文档ID

  • 来源

  • 标题

  • 摘要

  • 文档属性

Return type:

字典

get_attribute_value() → str[source]#
Return type:

字符串

get_document_attributes_dict() → Dict[str, str | int | List[str] | None]#

文档属性字典。

Return type:

Dict[str, str | int | List[str] | None]

get_excerpt() → str[source]#

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

Return type:

字符串

get_score_attribute() → str#

文档评分置信度

Return type:

字符串

get_title() → str[source]#

文档标题。

Return type:

字符串

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

将此项目转换为文档。

Parameters:

page_content_formatter (Callable[[ResultItem], str])

Return type:

Document