Class: Aws::BedrockAgent::Types::KnowledgeBase
- Inherits:
-
Struct
- Object
- Struct
- Aws::BedrockAgent::Types::KnowledgeBase
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-bedrockagent/types.rb
Overview
Contains information about a knowledge base.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#created_at ⇒ Time
The time at which the knowledge base was created.
-
#description ⇒ String
The description of the knowledge base.
-
#failure_reasons ⇒ Array<String>
A list of reasons that the API operation on the knowledge base failed.
-
#knowledge_base_arn ⇒ String
The Amazon Resource Name (ARN) of the knowledge base.
-
#knowledge_base_configuration ⇒ Types::KnowledgeBaseConfiguration
Contains details about the embeddings configuration of the knowledge base.
-
#knowledge_base_id ⇒ String
The unique identifier of the knowledge base.
-
#name ⇒ String
The name of the knowledge base.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
-
#status ⇒ String
The status of the knowledge base.
-
#storage_configuration ⇒ Types::StorageConfiguration
Contains details about the storage configuration of the knowledge base.
-
#updated_at ⇒ Time
The time at which the knowledge base was last updated.
Instance Attribute Details
#created_at ⇒ Time
The time at which the knowledge base was created.
2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 |
# File 'lib/aws-sdk-bedrockagent/types.rb', line 2408 class KnowledgeBase < Struct.new( :created_at, :description, :failure_reasons, :knowledge_base_arn, :knowledge_base_configuration, :knowledge_base_id, :name, :role_arn, :status, :storage_configuration, :updated_at) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The description of the knowledge base.
2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 |
# File 'lib/aws-sdk-bedrockagent/types.rb', line 2408 class KnowledgeBase < Struct.new( :created_at, :description, :failure_reasons, :knowledge_base_arn, :knowledge_base_configuration, :knowledge_base_id, :name, :role_arn, :status, :storage_configuration, :updated_at) SENSITIVE = [] include Aws::Structure end |
#failure_reasons ⇒ Array<String>
A list of reasons that the API operation on the knowledge base failed.
2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 |
# File 'lib/aws-sdk-bedrockagent/types.rb', line 2408 class KnowledgeBase < Struct.new( :created_at, :description, :failure_reasons, :knowledge_base_arn, :knowledge_base_configuration, :knowledge_base_id, :name, :role_arn, :status, :storage_configuration, :updated_at) SENSITIVE = [] include Aws::Structure end |
#knowledge_base_arn ⇒ String
The Amazon Resource Name (ARN) of the knowledge base.
2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 |
# File 'lib/aws-sdk-bedrockagent/types.rb', line 2408 class KnowledgeBase < Struct.new( :created_at, :description, :failure_reasons, :knowledge_base_arn, :knowledge_base_configuration, :knowledge_base_id, :name, :role_arn, :status, :storage_configuration, :updated_at) SENSITIVE = [] include Aws::Structure end |
#knowledge_base_configuration ⇒ Types::KnowledgeBaseConfiguration
Contains details about the embeddings configuration of the knowledge base.
2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 |
# File 'lib/aws-sdk-bedrockagent/types.rb', line 2408 class KnowledgeBase < Struct.new( :created_at, :description, :failure_reasons, :knowledge_base_arn, :knowledge_base_configuration, :knowledge_base_id, :name, :role_arn, :status, :storage_configuration, :updated_at) SENSITIVE = [] include Aws::Structure end |
#knowledge_base_id ⇒ String
The unique identifier of the knowledge base.
2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 |
# File 'lib/aws-sdk-bedrockagent/types.rb', line 2408 class KnowledgeBase < Struct.new( :created_at, :description, :failure_reasons, :knowledge_base_arn, :knowledge_base_configuration, :knowledge_base_id, :name, :role_arn, :status, :storage_configuration, :updated_at) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the knowledge base.
2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 |
# File 'lib/aws-sdk-bedrockagent/types.rb', line 2408 class KnowledgeBase < Struct.new( :created_at, :description, :failure_reasons, :knowledge_base_arn, :knowledge_base_configuration, :knowledge_base_id, :name, :role_arn, :status, :storage_configuration, :updated_at) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 |
# File 'lib/aws-sdk-bedrockagent/types.rb', line 2408 class KnowledgeBase < Struct.new( :created_at, :description, :failure_reasons, :knowledge_base_arn, :knowledge_base_configuration, :knowledge_base_id, :name, :role_arn, :status, :storage_configuration, :updated_at) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
The status of the knowledge base. The following statuses are possible:
-
CREATING – The knowledge base is being created.
-
ACTIVE – The knowledge base is ready to be queried.
-
DELETING – The knowledge base is being deleted.
-
UPDATING – The knowledge base is being updated.
-
FAILED – The knowledge base API operation failed.
2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 |
# File 'lib/aws-sdk-bedrockagent/types.rb', line 2408 class KnowledgeBase < Struct.new( :created_at, :description, :failure_reasons, :knowledge_base_arn, :knowledge_base_configuration, :knowledge_base_id, :name, :role_arn, :status, :storage_configuration, :updated_at) SENSITIVE = [] include Aws::Structure end |
#storage_configuration ⇒ Types::StorageConfiguration
Contains details about the storage configuration of the knowledge base.
2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 |
# File 'lib/aws-sdk-bedrockagent/types.rb', line 2408 class KnowledgeBase < Struct.new( :created_at, :description, :failure_reasons, :knowledge_base_arn, :knowledge_base_configuration, :knowledge_base_id, :name, :role_arn, :status, :storage_configuration, :updated_at) SENSITIVE = [] include Aws::Structure end |
#updated_at ⇒ Time
The time at which the knowledge base was last updated.
2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 |
# File 'lib/aws-sdk-bedrockagent/types.rb', line 2408 class KnowledgeBase < Struct.new( :created_at, :description, :failure_reasons, :knowledge_base_arn, :knowledge_base_configuration, :knowledge_base_id, :name, :role_arn, :status, :storage_configuration, :updated_at) SENSITIVE = [] include Aws::Structure end |