Class: Aws::BedrockAgent::Types::CreateKnowledgeBaseRequest

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgent::Types::CreateKnowledgeBaseRequest

Includes:

Structure

Defined in:

lib/aws-sdk-bedrockagent/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  A unique, case-sensitive identifier to ensure that the API request completes no more than one time.

• #description ⇒ String

  A description of the knowledge base.

• #knowledge_base_configuration ⇒ Types::KnowledgeBaseConfiguration

  Contains details about the embeddings model used for the knowledge base.

• #name ⇒ String

  A name for 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.

• #storage_configuration ⇒ Types::StorageConfiguration

  Contains details about the configuration of the vector database used for the knowledge base.

• #tags ⇒ Hash<String,String>

  Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see [Ensuring idempotency].

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

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

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

class CreateKnowledgeBaseRequest < Struct.new(
  :client_token,
  :name,
  :description,
  :role_arn,
  :knowledge_base_configuration,
  :storage_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the knowledge base.

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

class CreateKnowledgeBaseRequest < Struct.new(
  :client_token,
  :name,
  :description,
  :role_arn,
  :knowledge_base_configuration,
  :storage_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_base_configuration ⇒ Types::KnowledgeBaseConfiguration

Contains details about the embeddings model used for the knowledge base.

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

class CreateKnowledgeBaseRequest < Struct.new(
  :client_token,
  :name,
  :description,
  :role_arn,
  :knowledge_base_configuration,
  :storage_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A name for the knowledge base.

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

class CreateKnowledgeBaseRequest < Struct.new(
  :client_token,
  :name,
  :description,
  :role_arn,
  :knowledge_base_configuration,
  :storage_configuration,
  :tags)
  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.

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

class CreateKnowledgeBaseRequest < Struct.new(
  :client_token,
  :name,
  :description,
  :role_arn,
  :knowledge_base_configuration,
  :storage_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#storage_configuration ⇒ Types::StorageConfiguration

Contains details about the configuration of the vector database used for the knowledge base.

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

class CreateKnowledgeBaseRequest < Struct.new(
  :client_token,
  :name,
  :description,
  :role_arn,
  :knowledge_base_configuration,
  :storage_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.

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

class CreateKnowledgeBaseRequest < Struct.new(
  :client_token,
  :name,
  :description,
  :role_arn,
  :knowledge_base_configuration,
  :storage_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end