Class: Aws::Kendra::Types::FeaturedDocumentWithMetadata

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

Overview

A featured document with its metadata information. This document 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 the document is featured in the search results.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#id ⇒ String

The identifier of the featured document with its metadata. You can use the [Query] API to search for specific documents with their document IDs included in the result items, or you can use the console.

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

Returns:

  • (String) 


5391
5392
5393
5394
5395
5396
5397
 
# File 'lib/aws-sdk-kendra/types.rb', line 5391

class FeaturedDocumentWithMetadata < Struct.new(
  :id,
  :title,
  :uri)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The main title of the featured document.

Returns:

  • (String) 


5391
5392
5393
5394
5395
5396
5397
 
# File 'lib/aws-sdk-kendra/types.rb', line 5391

class FeaturedDocumentWithMetadata < Struct.new(
  :id,
  :title,
  :uri)
  SENSITIVE = []
  include Aws::Structure
end

#uri ⇒ String

The source URI location of the featured document.

Returns:

  • (String) 


5391
5392
5393
5394
5395
5396
5397
 
# File 'lib/aws-sdk-kendra/types.rb', line 5391

class FeaturedDocumentWithMetadata < Struct.new(
  :id,
  :title,
  :uri)
  SENSITIVE = []
  include Aws::Structure
end