Class: Aws::QConnect::Types::CreateKnowledgeBaseRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-qconnect/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

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

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/

Returns:

  • (String) 


2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2956

class CreateKnowledgeBaseRequest < Struct.new(
  :client_token,
  :name,
  :knowledge_base_type,
  :source_configuration,
  :rendering_configuration,
  :vector_ingestion_configuration,
  :server_side_encryption_configuration,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description.

Returns:

  • (String) 


2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2956

class CreateKnowledgeBaseRequest < Struct.new(
  :client_token,
  :name,
  :knowledge_base_type,
  :source_configuration,
  :rendering_configuration,
  :vector_ingestion_configuration,
  :server_side_encryption_configuration,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_base_type ⇒ String

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.

Returns:

  • (String) 


2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2956

class CreateKnowledgeBaseRequest < Struct.new(
  :client_token,
  :name,
  :knowledge_base_type,
  :source_configuration,
  :rendering_configuration,
  :vector_ingestion_configuration,
  :server_side_encryption_configuration,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the knowledge base.

Returns:

  • (String) 


2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2956

class CreateKnowledgeBaseRequest < Struct.new(
  :client_token,
  :name,
  :knowledge_base_type,
  :source_configuration,
  :rendering_configuration,
  :vector_ingestion_configuration,
  :server_side_encryption_configuration,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#rendering_configuration ⇒ Types::RenderingConfiguration

Information about how to render the content.

Returns:



2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2956

class CreateKnowledgeBaseRequest < Struct.new(
  :client_token,
  :name,
  :knowledge_base_type,
  :source_configuration,
  :rendering_configuration,
  :vector_ingestion_configuration,
  :server_side_encryption_configuration,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#server_side_encryption_configuration ⇒ Types::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`, `kms:Decrypt`, and `kms:GenerateDataKey*` permissions to the IAM identity using the key to invoke Amazon Q in Connect.

For more information about setting up a customer managed key for Amazon Q in Connect, see [Enable Amazon Q in Connect for your instance].

[1]: docs.aws.amazon.com/connect/latest/adminguide/enable-q.html

Returns:



2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2956

class CreateKnowledgeBaseRequest < Struct.new(
  :client_token,
  :name,
  :knowledge_base_type,
  :source_configuration,
  :rendering_configuration,
  :vector_ingestion_configuration,
  :server_side_encryption_configuration,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#source_configuration ⇒ Types::SourceConfiguration

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

Returns:



2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2956

class CreateKnowledgeBaseRequest < Struct.new(
  :client_token,
  :name,
  :knowledge_base_type,
  :source_configuration,
  :rendering_configuration,
  :vector_ingestion_configuration,
  :server_side_encryption_configuration,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2956

class CreateKnowledgeBaseRequest < Struct.new(
  :client_token,
  :name,
  :knowledge_base_type,
  :source_configuration,
  :rendering_configuration,
  :vector_ingestion_configuration,
  :server_side_encryption_configuration,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#vector_ingestion_configuration ⇒ Types::VectorIngestionConfiguration

Contains details about how to ingest the documents in a data source.

Returns:



2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2956

class CreateKnowledgeBaseRequest < Struct.new(
  :client_token,
  :name,
  :knowledge_base_type,
  :source_configuration,
  :rendering_configuration,
  :vector_ingestion_configuration,
  :server_side_encryption_configuration,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end