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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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 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 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.

Returns:

• (Time)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2296

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.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2296

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.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2296

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 ARN of the knowledge base.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2296

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.

Returns:

• (Types::KnowledgeBaseConfiguration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2296

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.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2296

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.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2296

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 ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with ‘AmazonBedrockExecutionRoleForKnowledgeBase_`.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2296

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.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2296

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.

Returns:

• (Types::StorageConfiguration)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2296

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.

Returns:

• (Time)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2296

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