QueryResultItem class
A single query result.
A query result contains information about a document returned by the query. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.
Constructors
-
QueryResultItem({List<
AdditionalResultAttribute> ? additionalAttributes, List<DocumentAttribute> ? documentAttributes, TextWithHighlights? documentExcerpt, String? documentId, TextWithHighlights? documentTitle, String? documentURI, String? feedbackToken, String? id, ScoreAttributes? scoreAttributes, QueryResultType? type}) -
QueryResultItem.fromJson(Map<
String, dynamic> json) -
factory
Properties
-
additionalAttributes
→ List<
AdditionalResultAttribute> ? -
One or more additional attributes associated with the query result.
final
-
documentAttributes
→ List<
DocumentAttribute> ? -
An array of document attributes for the document that the query result maps
to. For example, the document author (Author) or the source URI (SourceUri)
of the document.
final
- documentExcerpt → TextWithHighlights?
-
An extract of the text in the document. Contains information about
highlighting the relevant terms in the excerpt.
final
- documentId → String?
-
The unique identifier for the document.
final
- documentTitle → TextWithHighlights?
-
The title of the document. Contains the text of the title and information
for highlighting the relevant terms in the title.
final
- documentURI → String?
-
The URI of the original location of the document.
final
- feedbackToken → String?
-
A token that identifies a particular result from a particular query. Use
this token to provide click-through feedback for the result. For more
information, see
Submitting feedback .
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String?
-
The unique identifier for the query result.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scoreAttributes → ScoreAttributes?
-
Indicates the confidence that Amazon Kendra has that a result matches the
query that you provided. Each result is placed into a bin that indicates the
confidence,
VERY_HIGH
,HIGH
,MEDIUM
andLOW
. You can use the score to determine if a response meets the confidence needed for your application.final - type → QueryResultType?
-
The type of document.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited