Interface CfnDataSource.IServiceNowKnowledgeArticleConfigurationProperty
Provides the configuration information for crawling knowledge articles in the ServiceNow site.
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.AWS.Kendra.dll
Syntax (csharp)
public interface IServiceNowKnowledgeArticleConfigurationProperty
Syntax (vb)
Public Interface IServiceNowKnowledgeArticleConfigurationProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;
var serviceNowKnowledgeArticleConfigurationProperty = new ServiceNowKnowledgeArticleConfigurationProperty {
DocumentDataFieldName = "documentDataFieldName",
// the properties below are optional
CrawlAttachments = false,
DocumentTitleFieldName = "documentTitleFieldName",
ExcludeAttachmentFilePatterns = new [] { "excludeAttachmentFilePatterns" },
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} },
FilterQuery = "filterQuery",
IncludeAttachmentFilePatterns = new [] { "includeAttachmentFilePatterns" }
};
Synopsis
Properties
CrawlAttachments |
|
DocumentDataFieldName | The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index. |
DocumentTitleFieldName | The name of the ServiceNow field that is mapped to the index document title field. |
ExcludeAttachmentFilePatterns | A list of regular expression patterns applied to exclude certain knowledge article attachments. |
FieldMappings | Maps attributes or field names of knoweldge articles to Amazon Kendra index field names. |
FilterQuery | A query that selects the knowledge articles to index. |
IncludeAttachmentFilePatterns | A list of regular expression patterns applied to include knowledge article attachments. |
Properties
CrawlAttachments
TRUE
to index attachments to knowledge articles.
virtual object CrawlAttachments { get; }
Property Value
System.Object
Remarks
DocumentDataFieldName
The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
string DocumentDataFieldName { get; }
Property Value
System.String
Remarks
DocumentTitleFieldName
The name of the ServiceNow field that is mapped to the index document title field.
virtual string DocumentTitleFieldName { get; }
Property Value
System.String
Remarks
ExcludeAttachmentFilePatterns
A list of regular expression patterns applied to exclude certain knowledge article attachments.
virtual string[] ExcludeAttachmentFilePatterns { get; }
Property Value
System.String[]
Remarks
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.
FieldMappings
Maps attributes or field names of knoweldge articles to Amazon Kendra index field names.
virtual object FieldMappings { get; }
Property Value
System.Object
Remarks
To create custom fields, use the UpdateIndex
API 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.
FilterQuery
A query that selects the knowledge articles to index.
virtual string FilterQuery { get; }
Property Value
System.String
Remarks
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 .
IncludeAttachmentFilePatterns
A list of regular expression patterns applied to include knowledge article attachments.
virtual string[] IncludeAttachmentFilePatterns { get; }
Property Value
System.String[]
Remarks
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.