langchain.retrievers.kendra.RetrieveResultItem

class langchain.retrievers.kendra.RetrieveResultItem(*, Id: Optional[str] = None, DocumentId: Optional[str] = None, DocumentURI: Optional[str] = None, DocumentAttributes: Optional[List[DocumentAttribute]] = [], DocumentTitle: Optional[str] = None, Content: Optional[str] = None, **extra_data: Any)

Bases: ResultItem

A Retrieve API result item.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

param Content: Optional[str] = None

The content of the item.

param DocumentAttributes: Optional[List[langchain.retrievers.kendra.DocumentAttribute]] = []

The document attributes.

param DocumentId: Optional[str] = None

The document ID.

param DocumentTitle: Optional[str] = None

The document title.

param DocumentURI: Optional[str] = None

The document URI.

param Id: Optional[str] = None

The ID of the item.

get_additional_metadata() → dict

Document additional metadata dict. This returns any extra metadata except these values: [‘source’, ‘title’, ‘excerpt’ and ‘document_attributes’].

get_document_attributes_dict() → dict

get_excerpt() → str

Document excerpt or passage.

get_title() → str

Document title.

to_doc() → Document