Class: Aws::Kendra::Types::DescribeFeaturedResultsSetResponse

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_timestamp ⇒ Integer

The Unix timestamp when the set of the featured results was created.

Returns:

  • (Integer) 


3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
 
# File 'lib/aws-sdk-kendra/types.rb', line 3742

class DescribeFeaturedResultsSetResponse < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents_with_metadata,
  :featured_documents_missing,
  :last_updated_timestamp,
  :creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description for the set of featured results.

Returns:

  • (String) 


3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
 
# File 'lib/aws-sdk-kendra/types.rb', line 3742

class DescribeFeaturedResultsSetResponse < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents_with_metadata,
  :featured_documents_missing,
  :last_updated_timestamp,
  :creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#featured_documents_missing ⇒ Array<Types::FeaturedDocumentMissing>

The list of document IDs that don’t exist but you have specified as featured documents. Amazon Kendra cannot feature these documents if they don’t exist in the index. You can check the status of a document and its ID or check for documents with status errors using the [BatchGetDocumentStatus] API.

[1]: docs.aws.amazon.com/kendra/latest/dg/API_BatchGetDocumentStatus.html

Returns:



3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
 
# File 'lib/aws-sdk-kendra/types.rb', line 3742

class DescribeFeaturedResultsSetResponse < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents_with_metadata,
  :featured_documents_missing,
  :last_updated_timestamp,
  :creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#featured_documents_with_metadata ⇒ Array<Types::FeaturedDocumentWithMetadata>

The list of document IDs for the documents you want to feature with their metadata information. For more information on the list of featured documents, see [FeaturedResultsSet].

[1]: docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html

Returns:



3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
 
# File 'lib/aws-sdk-kendra/types.rb', line 3742

class DescribeFeaturedResultsSetResponse < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents_with_metadata,
  :featured_documents_missing,
  :last_updated_timestamp,
  :creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#featured_results_set_id ⇒ String

The identifier of the set of featured results.

Returns:

  • (String) 


3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
 
# File 'lib/aws-sdk-kendra/types.rb', line 3742

class DescribeFeaturedResultsSetResponse < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents_with_metadata,
  :featured_documents_missing,
  :last_updated_timestamp,
  :creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#featured_results_set_name ⇒ String

The name for the set of featured results.

Returns:

  • (String) 


3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
 
# File 'lib/aws-sdk-kendra/types.rb', line 3742

class DescribeFeaturedResultsSetResponse < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents_with_metadata,
  :featured_documents_missing,
  :last_updated_timestamp,
  :creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_timestamp ⇒ Integer

The timestamp when the set of featured results was last updated.

Returns:

  • (Integer) 


3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
 
# File 'lib/aws-sdk-kendra/types.rb', line 3742

class DescribeFeaturedResultsSetResponse < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents_with_metadata,
  :featured_documents_missing,
  :last_updated_timestamp,
  :creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#query_texts ⇒ Array<String>

The list of queries for featuring results. For more information on the list of queries, see [FeaturedResultsSet].

[1]: docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html

Returns:

  • (Array<String>) 


3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
 
# File 'lib/aws-sdk-kendra/types.rb', line 3742

class DescribeFeaturedResultsSetResponse < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents_with_metadata,
  :featured_documents_missing,
  :last_updated_timestamp,
  :creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the set of featured results. When the value is ‘ACTIVE`, featured results are ready for use. You can still configure your settings before setting the status to `ACTIVE`. You can set the status to `ACTIVE` or `INACTIVE` using the

UpdateFeaturedResultsSet][1

API. The queries you specify for

featured results must be unique per featured results set for each index, whether the status is ‘ACTIVE` or `INACTIVE`.

[1]: docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html

Returns:

  • (String) 


3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
 
# File 'lib/aws-sdk-kendra/types.rb', line 3742

class DescribeFeaturedResultsSetResponse < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents_with_metadata,
  :featured_documents_missing,
  :last_updated_timestamp,
  :creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end