langchain_aws.retrievers.kendra.ResultItem

class langchain_aws.retrievers.kendra.ResultItem[source]

基准：BaseModel，ABC

结果项的基类。

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

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

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

文档属性。

参数 DocumentId: Optional[str] = None

文档ID。

参数 DocumentURI: Optional[str] = None

文档URI。

参数 Id: Optional[str] = None

相关结果项的ID。

参数 ScoreAttributes: Optional[dict] = None

Kendra分数置信度

get_additional_metadata() → dict[source]

文档其他元数据字典。此函数返回除以下之外的任何额外元数据

  • result_id

  • document_id

  • source

  • title

  • excerpt

  • document_attributes

返回类型

dict

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

文档属性字典。

返回类型

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

abstract get_excerpt() → str[source]

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

返回类型

str

get_score_attribute() → str[source]

文档得分置信度

返回类型

str

abstract get_title() → str[source]

文档标题。

返回类型

str

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

将此项转换为文档。

参数

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

返回类型

文档