langchain_aws.retrievers.kendra.QueryResultItem

class langchain_aws.retrievers.kendra.QueryResultItem[source]

基础： ResultItem

查询API结果项。

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

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

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

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

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

文档属性。

参数 DocumentExcerpt: Optional[TextWithHighLights] = None

文档文本摘录。

参数 DocumentId: Optional[str] = None

文档ID。

参数 DocumentTitle: TextWithHighLights [必填]

文档标题。

参数 DocumentURI: Optional[str] = None

文档URI。

参数 FeedbackToken: Optional[str] = None

标识特定查询的结果。

参数 Format: Optional[str] = None
如果类型是ANSWER，则格式为以下之一：

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

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

参数 Id: Optional[str] = None

相关结果项的ID。

参数 ScoreAttributes: Optional[dict] = None

Kendra得分置信度

参数 Type: Optional[str] = None

结果类型：DOCUMENT或QUESTION_ANSWER或ANSWER

get_additional_metadata() → dict[source]

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

  • result_id

  • document_id

  • source

  • title

  • excerpt

  • document_attributes

返回类型

dict

get_attribute_value() → str[source]
返回类型

str

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

文档属性字典。

返回类型

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

get_excerpt() → str[source]

文档摘录或通过Kendra检索的原文段。

返回类型

str

get_score_attribute() → str

文档分数置信度。

返回类型

str

get_title() → str[source]

文档标题。

返回类型

str

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

将此项转换为文档。

参数

page_content_formatter (Callable[[langchain_aws.retrievers.kendra.ResultItem], str]) –

返回类型

文档