Class: Aws::Kendra::Types::SalesforceCustomKnowledgeArticleTypeConfiguration

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

Overview

Note:

When making an API call, you may pass SalesforceCustomKnowledgeArticleTypeConfiguration data as a hash:

{
  name: "SalesforceCustomKnowledgeArticleTypeName", # required
  document_data_field_name: "DataSourceFieldName", # required
  document_title_field_name: "DataSourceFieldName",
  field_mappings: [
    {
      data_source_field_name: "DataSourceFieldName", # required
      date_field_format: "DataSourceDateFieldFormat",
      index_field_name: "IndexFieldName", # required
    },
  ],
}

Provides configuration information for indexing Salesforce custom articles.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_data_field_name ⇒ String

The name of the field in the custom knowledge article that contains the document data to index.

Returns:

  • (String) 

5177
5178
5179
5180
5181
5182
5183
5184
 
# File 'lib/aws-sdk-kendra/types.rb', line 5177

class SalesforceCustomKnowledgeArticleTypeConfiguration < Struct.new(
  :name,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#document_title_field_name ⇒ String

The name of the field in the custom knowledge article that contains the document title.

Returns:

  • (String) 

5177
5178
5179
5180
5181
5182
5183
5184
 
# File 'lib/aws-sdk-kendra/types.rb', line 5177

class SalesforceCustomKnowledgeArticleTypeConfiguration < Struct.new(
  :name,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.

Returns:


5177
5178
5179
5180
5181
5182
5183
5184
 
# File 'lib/aws-sdk-kendra/types.rb', line 5177

class SalesforceCustomKnowledgeArticleTypeConfiguration < Struct.new(
  :name,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the configuration.

Returns:

  • (String) 

5177
5178
5179
5180
5181
5182
5183
5184
 
# File 'lib/aws-sdk-kendra/types.rb', line 5177

class SalesforceCustomKnowledgeArticleTypeConfiguration < Struct.new(
  :name,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end