NAME

Paws::Kendra::ServiceNowKnowledgeArticleConfiguration

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Kendra::ServiceNowKnowledgeArticleConfiguration object:

$service_obj->Method(Att1 => { CrawlAttachments => $value, ..., IncludeAttachmentFilePatterns => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::ServiceNowKnowledgeArticleConfiguration object:

$result = $service_obj->Method(...);
$result->Att1->CrawlAttachments

DESCRIPTION

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

ATTRIBUTES

CrawlAttachments => Bool

Indicates whether Amazon Kendra should index attachments to knowledge articles.

REQUIRED DocumentDataFieldName => Str

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

DocumentTitleFieldName => Str

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

ExcludeAttachmentFilePatterns => ArrayRef[Str|Undef]

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 => ArrayRef[Paws::Kendra::DataSourceToIndexFieldMapping]

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

FilterQuery => Str

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 (https://docs.aws.amazon.com/kendra/latest/dg/servicenow-query.html).

IncludeAttachmentFilePatterns => ArrayRef[Str|Undef]

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.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::Kendra

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues