Class: Aws::QConnect::Types::KnowledgeBaseSummary
- Inherits:
-
Struct
- Object
- Struct
- Aws::QConnect::Types::KnowledgeBaseSummary
- Defined in:
- gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb
Overview
Summary information about the knowledge base.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#description ⇒ String
The description of the knowledge base.
-
#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_modified_region ⇒ String
The Amazon Web Services Region where the knowledge base was last modified.
-
#last_modified_time ⇒ Time
The timestamp when the knowledge base was last modified.
-
#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
Configuration information about the external data source.
-
#status ⇒ String
The status of the knowledge base summary.
-
#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 of the knowledge base.
6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 6587 class KnowledgeBaseSummary < Struct.new( :knowledge_base_id, :knowledge_base_arn, :name, :knowledge_base_type, :status, :source_configuration, :vector_ingestion_configuration, :rendering_configuration, :server_side_encryption_configuration, :description, :tags, :last_modified_time, :last_modified_region) SENSITIVE = [] include Aws::Structure end |
#knowledge_base_arn ⇒ String
The Amazon Resource Name (ARN) of the knowledge base.
6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 6587 class KnowledgeBaseSummary < Struct.new( :knowledge_base_id, :knowledge_base_arn, :name, :knowledge_base_type, :status, :source_configuration, :vector_ingestion_configuration, :rendering_configuration, :server_side_encryption_configuration, :description, :tags, :last_modified_time, :last_modified_region) SENSITIVE = [] include Aws::Structure end |
#knowledge_base_id ⇒ String
The identifier of the knowledge base.
6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 6587 class KnowledgeBaseSummary < Struct.new( :knowledge_base_id, :knowledge_base_arn, :name, :knowledge_base_type, :status, :source_configuration, :vector_ingestion_configuration, :rendering_configuration, :server_side_encryption_configuration, :description, :tags, :last_modified_time, :last_modified_region) SENSITIVE = [] include Aws::Structure end |
#knowledge_base_type ⇒ String
The type of knowledge base.
6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 6587 class KnowledgeBaseSummary < Struct.new( :knowledge_base_id, :knowledge_base_arn, :name, :knowledge_base_type, :status, :source_configuration, :vector_ingestion_configuration, :rendering_configuration, :server_side_encryption_configuration, :description, :tags, :last_modified_time, :last_modified_region) SENSITIVE = [] include Aws::Structure end |
#last_modified_region ⇒ String
The Amazon Web Services Region where the knowledge base was last modified.
6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 6587 class KnowledgeBaseSummary < Struct.new( :knowledge_base_id, :knowledge_base_arn, :name, :knowledge_base_type, :status, :source_configuration, :vector_ingestion_configuration, :rendering_configuration, :server_side_encryption_configuration, :description, :tags, :last_modified_time, :last_modified_region) SENSITIVE = [] include Aws::Structure end |
#last_modified_time ⇒ Time
The timestamp when the knowledge base was last modified.
6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 6587 class KnowledgeBaseSummary < Struct.new( :knowledge_base_id, :knowledge_base_arn, :name, :knowledge_base_type, :status, :source_configuration, :vector_ingestion_configuration, :rendering_configuration, :server_side_encryption_configuration, :description, :tags, :last_modified_time, :last_modified_region) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the knowledge base.
6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 6587 class KnowledgeBaseSummary < Struct.new( :knowledge_base_id, :knowledge_base_arn, :name, :knowledge_base_type, :status, :source_configuration, :vector_ingestion_configuration, :rendering_configuration, :server_side_encryption_configuration, :description, :tags, :last_modified_time, :last_modified_region) SENSITIVE = [] include Aws::Structure end |
#rendering_configuration ⇒ Types::RenderingConfiguration
Information about how to render the content.
6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 6587 class KnowledgeBaseSummary < Struct.new( :knowledge_base_id, :knowledge_base_arn, :name, :knowledge_base_type, :status, :source_configuration, :vector_ingestion_configuration, :rendering_configuration, :server_side_encryption_configuration, :description, :tags, :last_modified_time, :last_modified_region) 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.
6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 6587 class KnowledgeBaseSummary < Struct.new( :knowledge_base_id, :knowledge_base_arn, :name, :knowledge_base_type, :status, :source_configuration, :vector_ingestion_configuration, :rendering_configuration, :server_side_encryption_configuration, :description, :tags, :last_modified_time, :last_modified_region) SENSITIVE = [] include Aws::Structure end |
#source_configuration ⇒ Types::SourceConfiguration
Configuration information about the external data source.
6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 6587 class KnowledgeBaseSummary < Struct.new( :knowledge_base_id, :knowledge_base_arn, :name, :knowledge_base_type, :status, :source_configuration, :vector_ingestion_configuration, :rendering_configuration, :server_side_encryption_configuration, :description, :tags, :last_modified_time, :last_modified_region) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
The status of the knowledge base summary.
6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 6587 class KnowledgeBaseSummary < Struct.new( :knowledge_base_id, :knowledge_base_arn, :name, :knowledge_base_type, :status, :source_configuration, :vector_ingestion_configuration, :rendering_configuration, :server_side_encryption_configuration, :description, :tags, :last_modified_time, :last_modified_region) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Hash<String,String>
The tags used to organize, track, or control access for this resource.
6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 6587 class KnowledgeBaseSummary < Struct.new( :knowledge_base_id, :knowledge_base_arn, :name, :knowledge_base_type, :status, :source_configuration, :vector_ingestion_configuration, :rendering_configuration, :server_side_encryption_configuration, :description, :tags, :last_modified_time, :last_modified_region) SENSITIVE = [] include Aws::Structure end |
#vector_ingestion_configuration ⇒ Types::VectorIngestionConfiguration
Contains details about how to ingest the documents in a data source.
6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 6587 class KnowledgeBaseSummary < Struct.new( :knowledge_base_id, :knowledge_base_arn, :name, :knowledge_base_type, :status, :source_configuration, :vector_ingestion_configuration, :rendering_configuration, :server_side_encryption_configuration, :description, :tags, :last_modified_time, :last_modified_region) SENSITIVE = [] include Aws::Structure end |