结果项#

class langchain_community.retrievers.kendra.ResultItem[source]#

基础类：BaseModel, ABC

结果项的基类。

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

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

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

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

文档属性。

param DocumentId: str | None [Required]#

文档ID。

param DocumentURI: str | None [Required]#

文档的URI。

param Id: str | None [Required]#

相关结果项的ID。

param ScoreAttributes: dict | None [Required]#

Kendra 分数置信度

get_additional_metadata() → dict[source]#

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

  • 结果ID

  • 文档ID

  • 来源

  • 标题

  • 摘要

  • 文档属性

Return type:

字典

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

文档属性字典。

Return type:

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

abstract get_excerpt() → str[source]#

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

Return type:

字符串

get_score_attribute() → str[source]#

文档评分置信度

Return type:

字符串

abstract get_title() → str[source]#

文档标题。

Return type:

字符串

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

将此项目转换为文档。

Parameters:

page_content_formatter (可调用[[ResultItem], str])

Return type:

Document