QueryResultItem

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.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

One or more additional fields/attributes associated with the query result.

Link copied to clipboard

Provides details about a collapsed group of search results.

Link copied to clipboard

An array of document fields/attributes assigned to a document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.

Link copied to clipboard

An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.

Link copied to clipboard

The identifier for the document.

Link copied to clipboard

The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.

Link copied to clipboard

The URI of the original location of the document.

Link copied to clipboard

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.

Link copied to clipboard

If the Type of document within the response is ANSWER, then it is either a TABLE answer or TEXT answer. If it's a table answer, a table excerpt is returned in TableExcerpt. If it's a text answer, a text excerpt is returned in DocumentExcerpt.

Link copied to clipboard
val id: String?

The identifier for the query result.

Link copied to clipboard

Indicates the confidence level of Amazon Kendra providing a relevant result for the query. Each result is placed into a bin that indicates the confidence, VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.

Link copied to clipboard

An excerpt from a table within a document.

Link copied to clipboard

The type of document within the response. For example, a response could include a question-answer that's relevant to the query.

Functions

Link copied to clipboard
inline fun copy(block: QueryResultItem.Builder.() -> Unit = {}): QueryResultItem
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String