Skip to content

Create Knowledge Base

connectwisdomservice_create_knowledge_base R Documentation

Creates a knowledge base

Description

Creates a knowledge base.

When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error.

For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:

  1. Call delete_knowledge_base.

  2. Call DeleteDataIntegration.

  3. Call CreateDataIntegration to recreate the DataIntegration or a create different one.

  4. Call CreateKnowledgeBase.

Usage

connectwisdomservice_create_knowledge_base(clientToken, description,
  knowledgeBaseType, name, renderingConfiguration,
  serverSideEncryptionConfiguration, sourceConfiguration, tags)

Arguments

clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
description

The description.
knowledgeBaseType

[required] The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
name

[required] The name of the knowledge base.
renderingConfiguration

Information about how to render the content.
serverSideEncryptionConfiguration

The configuration information for the customer managed key used for encryption.

This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom.

For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
sourceConfiguration

The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.
tags

The tags used to organize, track, or control access for this resource.

Value

A list with the following syntax:

list(
  knowledgeBase = list(
    description = "string",
    knowledgeBaseArn = "string",
    knowledgeBaseId = "string",
    knowledgeBaseType = "EXTERNAL"|"CUSTOM"|"QUICK_RESPONSES",
    lastContentModificationTime = as.POSIXct(
      "2015-01-01"
    ),
    name = "string",
    renderingConfiguration = list(
      templateUri = "string"
    ),
    serverSideEncryptionConfiguration = list(
      kmsKeyId = "string"
    ),
    sourceConfiguration = list(
      appIntegrations = list(
        appIntegrationArn = "string",
        objectFields = list(
          "string"
        )
      )
    ),
    status = "CREATE_IN_PROGRESS"|"CREATE_FAILED"|"ACTIVE"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETED",
    tags = list(
      "string"
    )
  )
)

Request syntax

svc$create_knowledge_base(
  clientToken = "string",
  description = "string",
  knowledgeBaseType = "EXTERNAL"|"CUSTOM"|"QUICK_RESPONSES",
  name = "string",
  renderingConfiguration = list(
    templateUri = "string"
  ),
  serverSideEncryptionConfiguration = list(
    kmsKeyId = "string"
  ),
  sourceConfiguration = list(
    appIntegrations = list(
      appIntegrationArn = "string",
      objectFields = list(
        "string"
      )
    )
  ),
  tags = list(
    "string"
  )
)