Class: Aws::Kendra::Types::QueryResultItem

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_attributesArray<Types::AdditionalResultAttribute>

One or more additional attributes associated with the query result.



10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10385

class QueryResultItem < Struct.new(
  :id,
  :type,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token)
  SENSITIVE = []
  include Aws::Structure
end

#document_attributesArray<Types::DocumentAttribute>

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

Returns:



10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10385

class QueryResultItem < Struct.new(
  :id,
  :type,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token)
  SENSITIVE = []
  include Aws::Structure
end

#document_excerptTypes::TextWithHighlights

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



10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10385

class QueryResultItem < Struct.new(
  :id,
  :type,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token)
  SENSITIVE = []
  include Aws::Structure
end

#document_idString

The unique identifier for the document.

Returns:

  • (String)


10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10385

class QueryResultItem < Struct.new(
  :id,
  :type,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token)
  SENSITIVE = []
  include Aws::Structure
end

#document_titleTypes::TextWithHighlights

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



10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10385

class QueryResultItem < Struct.new(
  :id,
  :type,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token)
  SENSITIVE = []
  include Aws::Structure
end

#document_uriString

The URI of the original location of the document.

Returns:

  • (String)


10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10385

class QueryResultItem < Struct.new(
  :id,
  :type,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token)
  SENSITIVE = []
  include Aws::Structure
end

#feedback_tokenString

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 .

Returns:

  • (String)


10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10385

class QueryResultItem < Struct.new(
  :id,
  :type,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The unique identifier for the query result.

Returns:

  • (String)


10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10385

class QueryResultItem < Struct.new(
  :id,
  :type,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token)
  SENSITIVE = []
  include Aws::Structure
end

#score_attributesTypes::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 and LOW. You can use the score to determine if a response meets the confidence needed for your application.

The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result matches the query.



10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10385

class QueryResultItem < Struct.new(
  :id,
  :type,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The type of document.

Returns:

  • (String)


10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10385

class QueryResultItem < Struct.new(
  :id,
  :type,
  :additional_attributes,
  :document_id,
  :document_title,
  :document_excerpt,
  :document_uri,
  :document_attributes,
  :score_attributes,
  :feedback_token)
  SENSITIVE = []
  include Aws::Structure
end