SalesforceCustomKnowledgeArticleTypeConfiguration - Amazon Kendra API Reference

SalesforceCustomKnowledgeArticleTypeConfiguration

Provides the configuration information for indexing Salesforce custom articles.

Contents

DocumentDataFieldName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[a-zA-Z][a-zA-Z0-9_.]*$

Required: Yes

Name

The name of the configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$

Required: Yes

DocumentTitleFieldName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[a-zA-Z][a-zA-Z0-9_.]*$

Required: No

FieldMappings

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.

Type: Array of DataSourceToIndexFieldMapping objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: