Class: Aws::Kendra::Types::FeaturedResultsItem

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

Overview

A single featured result item. A featured result is displayed at the top of the search results page, placed above all other results for certain queries. If there’s an exact match of a query, then certain documents are featured in the search results.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_attributesArray<Types::AdditionalResultAttribute>

One or more additional attributes associated with the featured result.



5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
# File 'lib/aws-sdk-kendra/types.rb', line 5444

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

#document_attributesArray<Types::DocumentAttribute>

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

Returns:



5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
# File 'lib/aws-sdk-kendra/types.rb', line 5444

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

#document_excerptTypes::TextWithHighlights

Provides text and information about where to highlight the text.



5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
# File 'lib/aws-sdk-kendra/types.rb', line 5444

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

#document_idString

The identifier of the featured document.

Returns:

  • (String)


5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
# File 'lib/aws-sdk-kendra/types.rb', line 5444

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

#document_titleTypes::TextWithHighlights

Provides text and information about where to highlight the text.



5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
# File 'lib/aws-sdk-kendra/types.rb', line 5444

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

#document_uriString

The source URI location of the featured document.

Returns:

  • (String)


5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
# File 'lib/aws-sdk-kendra/types.rb', line 5444

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

#feedback_tokenString

A token that identifies a particular featured result from a particular query. Use this token to provide click-through feedback for the result. For more information, see [Submitting feedback].

[1]: docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html

Returns:

  • (String)


5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
# File 'lib/aws-sdk-kendra/types.rb', line 5444

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

#idString

The identifier of the featured result.

Returns:

  • (String)


5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
# File 'lib/aws-sdk-kendra/types.rb', line 5444

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

#typeString

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

Returns:

  • (String)


5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
# File 'lib/aws-sdk-kendra/types.rb', line 5444

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