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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::FeaturedResultsItem

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #additional_attributes ⇒ Array<Types::AdditionalResultAttribute>

  One or more additional attributes associated with the featured result.

• #document_attributes ⇒ Array<Types::DocumentAttribute>

  An array of document attributes assigned to a featured document in the search results.

• #document_excerpt ⇒ Types::TextWithHighlights

  Provides text and information about where to highlight the text.

• #document_id ⇒ String

  The identifier of the featured document.

• #document_title ⇒ Types::TextWithHighlights

  Provides text and information about where to highlight the text.

• #document_uri ⇒ String

  The source URI location of the featured document.

• #feedback_token ⇒ String

  A token that identifies a particular featured result from a particular query.

• #id ⇒ String

  The identifier of the featured result.

• #type ⇒ String

  The type of document within the featured result response.

Instance Attribute Details

#additional_attributes ⇒ Array<Types::AdditionalResultAttribute>

One or more additional attributes associated with the featured result.

Returns:

• (Array<Types::AdditionalResultAttribute>)

# 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_attributes ⇒ Array<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:

• (Array<Types::DocumentAttribute>)

# 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_excerpt ⇒ Types::TextWithHighlights

Provides text and information about where to highlight the text.

Returns:

• (Types::TextWithHighlights)

# 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_id ⇒ String

The identifier of the featured document.

Returns:

• (String)

# 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_title ⇒ Types::TextWithHighlights

Provides text and information about where to highlight the text.

Returns:

• (Types::TextWithHighlights)

# 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_uri ⇒ String

The source URI location of the featured document.

Returns:

• (String)

# 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_token ⇒ String

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)

# 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

#id ⇒ String

The identifier of the featured result.

Returns:

• (String)

# 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

#type ⇒ String

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)

# 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