ServiceNowKnowledgeArticleConfiguration

import type { ServiceNowKnowledgeArticleConfiguration } from "https://aws-api.deno.dev/v0.3/services/kendra.ts?docs=full";

Provides configuration information for crawling knowledge articles in the ServiceNow site.

interface ServiceNowKnowledgeArticleConfiguration {

CrawlAttachments?: boolean | null;

DocumentDataFieldName: string;

DocumentTitleFieldName?: string | null;

ExcludeAttachmentFilePatterns?: string[] | null;

FieldMappings?: DataSourceToIndexFieldMapping[] | null;

FilterQuery?: string | null;

IncludeAttachmentFilePatterns?: string[] | null;

}

§Properties

CrawlAttachments?: boolean | null

[src]

Indicates whether Amazon Kendra should index attachments to knowledge articles.

DocumentDataFieldName: string

[src]

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

DocumentTitleFieldName?: string | null

[src]

The name of the ServiceNow field that is mapped to the index document title field.

ExcludeAttachmentFilePatterns?: string[] | null

[src]

List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField

FieldMappings?: DataSourceToIndexFieldMapping[] | null

[src]

Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.

FilterQuery?: string | null

[src]

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.

IncludeAttachmentFilePatterns?: string[] | null

[src]

List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField.