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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kendra/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 the configuration information for indexing Salesforce custom articles.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_data_field_nameString

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

Returns:

  • (String)


11212
11213
11214
11215
11216
11217
11218
11219
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 11212

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

#document_title_field_nameString

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

Returns:

  • (String)


11212
11213
11214
11215
11216
11217
11218
11219
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 11212

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

#field_mappingsArray<Types::DataSourceToIndexFieldMapping>

Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.



11212
11213
11214
11215
11216
11217
11218
11219
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 11212

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

#nameString

The name of the configuration.

Returns:

  • (String)


11212
11213
11214
11215
11216
11217
11218
11219
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 11212

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