Class: Aws::Kendra::Types::ServiceNowKnowledgeArticleConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::ServiceNowKnowledgeArticleConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #crawl_attachments ⇒ Boolean

  ‘TRUE` to index attachments to knowledge articles.

• #document_data_field_name ⇒ String

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

• #document_title_field_name ⇒ String

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

• #exclude_attachment_file_patterns ⇒ Array<String>

  A list of regular expression patterns applied to exclude certain knowledge article attachments.

• #field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

  Maps attributes or field names of knoweldge articles to Amazon Kendra index field names.

• #filter_query ⇒ String

  A query that selects the knowledge articles to index.

• #include_attachment_file_patterns ⇒ Array<String>

  A list of regular expression patterns applied to include knowledge article attachments.

Instance Attribute Details

#crawl_attachments ⇒ Boolean

‘TRUE` to index attachments to knowledge articles.

Returns:

• (Boolean)

# File 'lib/aws-sdk-kendra/types.rb', line 9161

class ServiceNowKnowledgeArticleConfiguration < Struct.new(
  :crawl_attachments,
  :include_attachment_file_patterns,
  :exclude_attachment_file_patterns,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings,
  :filter_query)
  SENSITIVE = []
  include Aws::Structure
end

#document_data_field_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 9161

class ServiceNowKnowledgeArticleConfiguration < Struct.new(
  :crawl_attachments,
  :include_attachment_file_patterns,
  :exclude_attachment_file_patterns,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings,
  :filter_query)
  SENSITIVE = []
  include Aws::Structure
end

#document_title_field_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 9161

class ServiceNowKnowledgeArticleConfiguration < Struct.new(
  :crawl_attachments,
  :include_attachment_file_patterns,
  :exclude_attachment_file_patterns,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings,
  :filter_query)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_attachment_file_patterns ⇒ Array<String>

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.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-kendra/types.rb', line 9161

class ServiceNowKnowledgeArticleConfiguration < Struct.new(
  :crawl_attachments,
  :include_attachment_file_patterns,
  :exclude_attachment_file_patterns,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings,
  :filter_query)
  SENSITIVE = []
  include Aws::Structure
end

#field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

Maps attributes or field names of knoweldge articles to Amazon Kendra index field names. 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.

[1]: docs.aws.amazon.com/kendra/latest/dg/field-mapping.html

Returns:

• (Array<Types::DataSourceToIndexFieldMapping>)

# File 'lib/aws-sdk-kendra/types.rb', line 9161

class ServiceNowKnowledgeArticleConfiguration < Struct.new(
  :crawl_attachments,
  :include_attachment_file_patterns,
  :exclude_attachment_file_patterns,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings,
  :filter_query)
  SENSITIVE = []
  include Aws::Structure
end

#filter_query ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 9161

class ServiceNowKnowledgeArticleConfiguration < Struct.new(
  :crawl_attachments,
  :include_attachment_file_patterns,
  :exclude_attachment_file_patterns,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings,
  :filter_query)
  SENSITIVE = []
  include Aws::Structure
end

#include_attachment_file_patterns ⇒ Array<String>

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.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-kendra/types.rb', line 9161

class ServiceNowKnowledgeArticleConfiguration < Struct.new(
  :crawl_attachments,
  :include_attachment_file_patterns,
  :exclude_attachment_file_patterns,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings,
  :filter_query)
  SENSITIVE = []
  include Aws::Structure
end