ServiceNowKnowledgeArticleConfiguration
Provides the configuration information for crawling knowledge articles in the ServiceNow site.
Contents
- DocumentDataFieldName
-
The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[a-zA-Z][a-zA-Z0-9_.]*$Required: Yes
- CrawlAttachments
-
TRUEto index attachments to knowledge articles.Type: Boolean
Required: No
- DocumentTitleFieldName
-
The name of the ServiceNow field that is mapped to the index document title field.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[a-zA-Z][a-zA-Z0-9_.]*$Required: No
- ExcludeAttachmentFilePatterns
-
A list of regular expression patterns applied to exclude certain knowledge article attachments. Attachments that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
- FieldMappings
-
Maps attributes or field names of knoweldge articles to Amazon Kendra index field names. To create custom fields, use the
UpdateIndexAPI before you map to ServiceNow fields. For more information, see Mapping data source fields. The ServiceNow data source field names must exist in your ServiceNow custom metadata.Type: Array of DataSourceToIndexFieldMapping objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
- FilterQuery
-
A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.
The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^\P{C}*$Required: No
- IncludeAttachmentFilePatterns
-
A list of regular expression patterns applied to include knowledge article attachments. Attachments that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
