langchain.retrievers.kendra.QueryResultItem¶
class langchain.retrievers.kendra.QueryResultItem[source]¶
Bases: ResultItem
Query 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 AdditionalAttributes: Optional[List[langchain.retrievers.kendra.AdditionalResultAttribute]] = []¶
One or more additional attributes associated with the result.
param DocumentAttributes: Optional[List[langchain.retrievers.kendra.DocumentAttribute]] = []¶
The document attributes.
param DocumentExcerpt: Optional[langchain.retrievers.kendra.TextWithHighLights] = None¶
Excerpt of the document text.
param DocumentId: Optional[str] = None¶
The document ID.
param DocumentTitle: langchain.retrievers.kendra.TextWithHighLights [Required]¶
The document title.
param DocumentURI: Optional[str] = None¶
The document URI.
param FeedbackToken: Optional[str] = None¶
Identifies a particular result from a particular query.
param Format: Optional[str] = None¶
If the Type is ANSWER, then format is either:
TABLE: a table excerpt is returned in TableExcerpt;
TEXT: a text excerpt is returned in DocumentExcerpt.
param Id: Optional[str] = None¶
The ID of the relevant result item.
param Type: Optional[str] = None¶
Type of result: DOCUMENT or QUESTION_ANSWER or ANSWER
classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model¶
Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.
Default values are respected, but no other validation is performed.