Class: Aws::Kendra::Types::DocumentMetadataConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::DocumentMetadataConfiguration

Defined in:

gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Specifies the properties, such as relevance tuning and searchability, of an index field.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #name ⇒ String

  The name of the index field.

• #relevance ⇒ Types::Relevance

  Provides tuning parameters to determine how the field affects the search results.

• #search ⇒ Types::Search

  Provides information about how the field is used during a search.

• #type ⇒ String

  The data type of the index field.

Instance Attribute Details

#name ⇒ String

The name of the index field.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4772

class DocumentMetadataConfiguration < Struct.new(
  :name,
  :type,
  :relevance,
  :search)
  SENSITIVE = []
  include Aws::Structure
end

#relevance ⇒ Types::Relevance

Provides tuning parameters to determine how the field affects the search results.

Returns:

• (Types::Relevance)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4772

class DocumentMetadataConfiguration < Struct.new(
  :name,
  :type,
  :relevance,
  :search)
  SENSITIVE = []
  include Aws::Structure
end

#search ⇒ Types::Search

Provides information about how the field is used during a search.

Returns:

• (Types::Search)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4772

class DocumentMetadataConfiguration < Struct.new(
  :name,
  :type,
  :relevance,
  :search)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The data type of the index field.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4772

class DocumentMetadataConfiguration < Struct.new(
  :name,
  :type,
  :relevance,
  :search)
  SENSITIVE = []
  include Aws::Structure
end