class Aws::Kendra::Types::ServiceNowKnowledgeArticleConfiguration

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

@note When making an API call, you may pass ServiceNowKnowledgeArticleConfiguration

data as a hash:

    {
      crawl_attachments: false,
      include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
      exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
      document_data_field_name: "DataSourceFieldName", # required
      document_title_field_name: "DataSourceFieldName",
      field_mappings: [
        {
          data_source_field_name: "DataSourceFieldName", # required
          date_field_format: "DataSourceDateFieldFormat",
          index_field_name: "IndexFieldName", # required
        },
      ],
      filter_query: "ServiceNowKnowledgeArticleFilterQuery",
    }

@!attribute [rw] crawl_attachments

Indicates whether Amazon Kendra should index attachments to
knowledge articles.
@return [Boolean]

@!attribute [rw] include_attachment_file_patterns

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`.
@return [Array<String>]

@!attribute [rw] exclude_attachment_file_patterns

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`
@return [Array<String>]

@!attribute [rw] document_data_field_name

The name of the ServiceNow field that is mapped to the index
document contents field in the Amazon Kendra index.
@return [String]

@!attribute [rw] document_title_field_name

The name of the ServiceNow field that is mapped to the index
document title field.
@return [String]

@!attribute [rw] field_mappings

Mapping between ServiceNow fields and Amazon Kendra index fields.
You must create the index field before you map the field.
@return [Array<Types::DataSourceToIndexFieldMapping>]

@!attribute [rw] filter_query

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][1].

[1]: https://docs.aws.amazon.com/kendra/latest/dg/servicenow-query.html
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowKnowledgeArticleConfiguration AWS API Documentation

Constants

SENSITIVE