Class: Aws::QConnect::Types::KnowledgeBaseData

Inherits:

Struct

Object
Struct
Aws::QConnect::Types::KnowledgeBaseData

show all

Defined in:: gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb

Overview

Information about the knowledge base.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#description ⇒ String
The description.
#ingestion_failure_reasons ⇒ Array<String>
List of failure reasons on ingestion per file.
#ingestion_status ⇒ String
Status of ingestion on data source.
#knowledge_base_arn ⇒ String
The Amazon Resource Name (ARN) of the knowledge base.
#knowledge_base_id ⇒ String
The identifier of the knowledge base.
#knowledge_base_type ⇒ String
The type of knowledge base.
#last_content_modification_time ⇒ Time
An epoch timestamp indicating the most recent content modification inside the knowledge base.
#name ⇒ String
The name of the knowledge base.
#rendering_configuration ⇒ Types::RenderingConfiguration
Information about how to render the content.
#server_side_encryption_configuration ⇒ Types::ServerSideEncryptionConfiguration
The configuration information for the customer managed key used for encryption.
#source_configuration ⇒ Types::SourceConfiguration
Source configuration information about the knowledge base.
#status ⇒ String
The status of the knowledge base.
#tags ⇒ Hash<String,String>
The tags used to organize, track, or control access for this resource.
#vector_ingestion_configuration ⇒ Types::VectorIngestionConfiguration
Contains details about how to ingest the documents in a data source.

Instance Attribute Details

#description ⇒ `String`

The description.

Returns:

(String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5541

class KnowledgeBaseData < Struct.new(
  :description,
  :ingestion_failure_reasons,
  :ingestion_status,
  :knowledge_base_arn,
  :knowledge_base_id,
  :knowledge_base_type,
  :last_content_modification_time,
  :name,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :source_configuration,
  :status,
  :tags,
  :vector_ingestion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#ingestion_failure_reasons ⇒ `Array<String>`

List of failure reasons on ingestion per file.

Returns:

(Array<String>)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5541

class KnowledgeBaseData < Struct.new(
  :description,
  :ingestion_failure_reasons,
  :ingestion_status,
  :knowledge_base_arn,
  :knowledge_base_id,
  :knowledge_base_type,
  :last_content_modification_time,
  :name,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :source_configuration,
  :status,
  :tags,
  :vector_ingestion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#ingestion_status ⇒ `String`

Status of ingestion on data source.

Returns:

(String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5541

class KnowledgeBaseData < Struct.new(
  :description,
  :ingestion_failure_reasons,
  :ingestion_status,
  :knowledge_base_arn,
  :knowledge_base_id,
  :knowledge_base_type,
  :last_content_modification_time,
  :name,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :source_configuration,
  :status,
  :tags,
  :vector_ingestion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_base_arn ⇒ `String`

The Amazon Resource Name (ARN) of the knowledge base.

Returns:

(String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5541

class KnowledgeBaseData < Struct.new(
  :description,
  :ingestion_failure_reasons,
  :ingestion_status,
  :knowledge_base_arn,
  :knowledge_base_id,
  :knowledge_base_type,
  :last_content_modification_time,
  :name,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :source_configuration,
  :status,
  :tags,
  :vector_ingestion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_base_id ⇒ `String`

The identifier of the knowledge base.

Returns:

(String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5541

class KnowledgeBaseData < Struct.new(
  :description,
  :ingestion_failure_reasons,
  :ingestion_status,
  :knowledge_base_arn,
  :knowledge_base_id,
  :knowledge_base_type,
  :last_content_modification_time,
  :name,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :source_configuration,
  :status,
  :tags,
  :vector_ingestion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_base_type ⇒ `String`

The type of knowledge base.

Returns:

(String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5541

class KnowledgeBaseData < Struct.new(
  :description,
  :ingestion_failure_reasons,
  :ingestion_status,
  :knowledge_base_arn,
  :knowledge_base_id,
  :knowledge_base_type,
  :last_content_modification_time,
  :name,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :source_configuration,
  :status,
  :tags,
  :vector_ingestion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#last_content_modification_time ⇒ `Time`

An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.

Returns:

(Time)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5541

class KnowledgeBaseData < Struct.new(
  :description,
  :ingestion_failure_reasons,
  :ingestion_status,
  :knowledge_base_arn,
  :knowledge_base_id,
  :knowledge_base_type,
  :last_content_modification_time,
  :name,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :source_configuration,
  :status,
  :tags,
  :vector_ingestion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The name of the knowledge base.

Returns:

(String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5541

class KnowledgeBaseData < Struct.new(
  :description,
  :ingestion_failure_reasons,
  :ingestion_status,
  :knowledge_base_arn,
  :knowledge_base_id,
  :knowledge_base_type,
  :last_content_modification_time,
  :name,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :source_configuration,
  :status,
  :tags,
  :vector_ingestion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#rendering_configuration ⇒ `Types::RenderingConfiguration`

Information about how to render the content.

Returns:

(Types::RenderingConfiguration)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5541

class KnowledgeBaseData < Struct.new(
  :description,
  :ingestion_failure_reasons,
  :ingestion_status,
  :knowledge_base_arn,
  :knowledge_base_id,
  :knowledge_base_type,
  :last_content_modification_time,
  :name,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :source_configuration,
  :status,
  :tags,
  :vector_ingestion_configuration)
  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.

Returns:

(Types::ServerSideEncryptionConfiguration)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5541

class KnowledgeBaseData < Struct.new(
  :description,
  :ingestion_failure_reasons,
  :ingestion_status,
  :knowledge_base_arn,
  :knowledge_base_id,
  :knowledge_base_type,
  :last_content_modification_time,
  :name,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :source_configuration,
  :status,
  :tags,
  :vector_ingestion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#source_configuration ⇒ `Types::SourceConfiguration`

Source configuration information about the knowledge base.

Returns:

(Types::SourceConfiguration)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5541

class KnowledgeBaseData < Struct.new(
  :description,
  :ingestion_failure_reasons,
  :ingestion_status,
  :knowledge_base_arn,
  :knowledge_base_id,
  :knowledge_base_type,
  :last_content_modification_time,
  :name,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :source_configuration,
  :status,
  :tags,
  :vector_ingestion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The status of the knowledge base.

Returns:

(String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5541

class KnowledgeBaseData < Struct.new(
  :description,
  :ingestion_failure_reasons,
  :ingestion_status,
  :knowledge_base_arn,
  :knowledge_base_id,
  :knowledge_base_type,
  :last_content_modification_time,
  :name,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :source_configuration,
  :status,
  :tags,
  :vector_ingestion_configuration)
  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>)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5541

class KnowledgeBaseData < Struct.new(
  :description,
  :ingestion_failure_reasons,
  :ingestion_status,
  :knowledge_base_arn,
  :knowledge_base_id,
  :knowledge_base_type,
  :last_content_modification_time,
  :name,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :source_configuration,
  :status,
  :tags,
  :vector_ingestion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#vector_ingestion_configuration ⇒ `Types::VectorIngestionConfiguration`

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

Returns:

(Types::VectorIngestionConfiguration)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 5541

class KnowledgeBaseData < Struct.new(
  :description,
  :ingestion_failure_reasons,
  :ingestion_status,
  :knowledge_base_arn,
  :knowledge_base_id,
  :knowledge_base_type,
  :last_content_modification_time,
  :name,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :source_configuration,
  :status,
  :tags,
  :vector_ingestion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::QConnect::Types::KnowledgeBaseData

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

#ingestion_failure_reasons ⇒ Array<String>

#ingestion_status ⇒ String

#knowledge_base_arn ⇒ String

#knowledge_base_id ⇒ String

#knowledge_base_type ⇒ String

#last_content_modification_time ⇒ Time

#name ⇒ String

#rendering_configuration ⇒ Types::RenderingConfiguration

#server_side_encryption_configuration ⇒ Types::ServerSideEncryptionConfiguration

#source_configuration ⇒ Types::SourceConfiguration

#status ⇒ String

#tags ⇒ Hash<String,String>

#vector_ingestion_configuration ⇒ Types::VectorIngestionConfiguration

#description ⇒ `String`

#ingestion_failure_reasons ⇒ `Array<String>`

#ingestion_status ⇒ `String`

#knowledge_base_arn ⇒ `String`

#knowledge_base_id ⇒ `String`

#knowledge_base_type ⇒ `String`

#last_content_modification_time ⇒ `Time`

#name ⇒ `String`

#rendering_configuration ⇒ `Types::RenderingConfiguration`

#server_side_encryption_configuration ⇒ `Types::ServerSideEncryptionConfiguration`

#source_configuration ⇒ `Types::SourceConfiguration`

#status ⇒ `String`

#tags ⇒ `Hash<String,String>`

#vector_ingestion_configuration ⇒ `Types::VectorIngestionConfiguration`