You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ServiceNowKnowledgeArticleConfiguration as input to an Aws::Client method, you can use a vanilla 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
    },
  ],
}

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#crawl_attachmentsBoolean

Indicates whether Amazon Kendra should index attachments to knowledge articles.

Returns:

  • (Boolean)

    Indicates whether Amazon Kendra should index attachments to knowledge articles.

#document_data_field_nameString

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

Returns:

  • (String)

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

#document_title_field_nameString

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

Returns:

  • (String)

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

#exclude_attachment_file_patternsArray<String>

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

Returns:

  • (Array<String>)

    List of regular expressions applied to knowledge articles.

#field_mappingsArray<Types::DataSourceToIndexFieldMapping>

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

Returns:

#include_attachment_file_patternsArray<String>

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.

Returns:

  • (Array<String>)

    List of regular expressions applied to knowledge articles.