Class: Aws::BedrockAgent::Types::CreateAgentRequest

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgent::Types::CreateAgentRequest

Defined in:

gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:instruction, :prompt_override_configuration]

Instance Attribute Summary

• #agent_collaboration ⇒ String

  The agent's collaboration role.

• #agent_name ⇒ String

  A name for the agent that you create.

• #agent_resource_role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

• #client_token ⇒ String

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

• #custom_orchestration ⇒ Types::CustomOrchestration

  Contains details of the custom orchestration configured for the agent.

• #customer_encryption_key_arn ⇒ String

  The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

• #description ⇒ String

  A description of the agent.

• #foundation_model ⇒ String

  The identifier for the model that you want to be used for orchestration by the agent you create.

• #guardrail_configuration ⇒ Types::GuardrailConfiguration

  The unique Guardrail configuration assigned to the agent when it is created.

• #idle_session_ttl_in_seconds ⇒ Integer

  The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

• #instruction ⇒ String

  Instructions that tell the agent what it should do and how it should interact with users.

• #memory_configuration ⇒ Types::MemoryConfiguration

  Contains the details of the memory configured for the agent.

• #orchestration_type ⇒ String

  Specifies the type of orchestration strategy for the agent.

• #prompt_override_configuration ⇒ Types::PromptOverrideConfiguration

  Contains configurations to override prompts in different parts of an agent sequence.

• #tags ⇒ Hash<String,String>

  Any tags that you want to attach to the agent.

Instance Attribute Details

#agent_collaboration ⇒ String

The agent's collaboration role.

Returns:

• (String)

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

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :orchestration_type,
  :custom_orchestration,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#agent_name ⇒ String

A name for the agent that you create.

Returns:

• (String)

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

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :orchestration_type,
  :custom_orchestration,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#agent_resource_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

Returns:

• (String)

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

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :orchestration_type,
  :custom_orchestration,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

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

Returns:

• (String)

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

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :orchestration_type,
  :custom_orchestration,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#custom_orchestration ⇒ Types::CustomOrchestration

Contains details of the custom orchestration configured for the agent.

Returns:

• (Types::CustomOrchestration)

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

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :orchestration_type,
  :custom_orchestration,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#customer_encryption_key_arn ⇒ String

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

Returns:

• (String)

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

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :orchestration_type,
  :custom_orchestration,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#description ⇒ String

A description of the agent.

Returns:

• (String)

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

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :orchestration_type,
  :custom_orchestration,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#foundation_model ⇒ String

The identifier for the model that you want to be used for orchestration by the agent you create.

The modelId to provide depends on the type of model or throughput that you use:

• If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.

• If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.

• If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.

• If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.

• If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.

Returns:

• (String)

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

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :orchestration_type,
  :custom_orchestration,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#guardrail_configuration ⇒ Types::GuardrailConfiguration

The unique Guardrail configuration assigned to the agent when it is created.

Returns:

• (Types::GuardrailConfiguration)

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

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :orchestration_type,
  :custom_orchestration,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#idle_session_ttl_in_seconds ⇒ Integer

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

Returns:

• (Integer)

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

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :orchestration_type,
  :custom_orchestration,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#instruction ⇒ String

Instructions that tell the agent what it should do and how it should interact with users.

Returns:

• (String)

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

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :orchestration_type,
  :custom_orchestration,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#memory_configuration ⇒ Types::MemoryConfiguration

Contains the details of the memory configured for the agent.

Returns:

• (Types::MemoryConfiguration)

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

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :orchestration_type,
  :custom_orchestration,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#orchestration_type ⇒ String

Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.

Returns:

• (String)

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

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :orchestration_type,
  :custom_orchestration,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#prompt_override_configuration ⇒ Types::PromptOverrideConfiguration

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

Returns:

• (Types::PromptOverrideConfiguration)

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

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :orchestration_type,
  :custom_orchestration,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Any tags that you want to attach to the agent.

Returns:

• (Hash<String,String>)

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

class CreateAgentRequest < Struct.new(
  :agent_name,
  :client_token,
  :instruction,
  :foundation_model,
  :description,
  :orchestration_type,
  :custom_orchestration,
  :idle_session_ttl_in_seconds,
  :agent_resource_role_arn,
  :customer_encryption_key_arn,
  :tags,
  :prompt_override_configuration,
  :guardrail_configuration,
  :memory_configuration,
  :agent_collaboration)
  SENSITIVE = [:instruction, :prompt_override_configuration]
  include Aws::Structure
end