AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SalesforceCustomKnowledgeArticleTypeConfiguration as input to an Aws::Client method, you can use a vanilla 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.

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)

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

#document_title_field_nameString

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

Returns:

  • (String)

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

#field_mappingsArray<Types::DataSourceToIndexFieldMapping>

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

Returns:

#nameString

The name of the configuration.

Returns:

  • (String)

    The name of the configuration.