Class: Aws::BedrockAgent::Types::AgentVersion
- Inherits:
-
Struct
- Object
- Struct
- Aws::BedrockAgent::Types::AgentVersion
- Defined in:
- gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb
Overview
Contains details about a version of an agent.
Constant Summary collapse
- SENSITIVE =
[:instruction, :prompt_override_configuration]
Instance Attribute Summary collapse
-
#agent_arn ⇒ String
The Amazon Resource Name (ARN) of the agent that the version belongs to.
-
#agent_collaboration ⇒ String
The agent's collaboration settings.
-
#agent_id ⇒ String
The unique identifier of the agent that the version belongs to.
-
#agent_name ⇒ String
The name of the agent that the version belongs to.
-
#agent_resource_role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
-
#agent_status ⇒ String
The status of the agent that the version belongs to.
-
#created_at ⇒ Time
The time at which the version was created.
-
#customer_encryption_key_arn ⇒ String
The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
-
#description ⇒ String
The description of the version.
-
#failure_reasons ⇒ Array<String>
A list of reasons that the API operation on the version failed.
-
#foundation_model ⇒ String
The foundation model that the version invokes.
-
#guardrail_configuration ⇒ Types::GuardrailConfiguration
Details about the guardrail associated with the agent.
-
#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
The instructions provided to the agent.
-
#memory_configuration ⇒ Types::MemoryConfiguration
Contains details of the memory configuration on the version of the agent.
-
#prompt_override_configuration ⇒ Types::PromptOverrideConfiguration
Contains configurations to override prompt templates in different parts of an agent sequence.
-
#recommended_actions ⇒ Array<String>
A list of recommended actions to take for the failed API operation on the version to succeed.
-
#updated_at ⇒ Time
The time at which the version was last updated.
-
#version ⇒ String
The version number.
Instance Attribute Details
#agent_arn ⇒ String
The Amazon Resource Name (ARN) of the agent that the version belongs to.
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 982 class AgentVersion < Struct.new( :agent_arn, :agent_collaboration, :agent_id, :agent_name, :agent_resource_role_arn, :agent_status, :created_at, :customer_encryption_key_arn, :description, :failure_reasons, :foundation_model, :guardrail_configuration, :idle_session_ttl_in_seconds, :instruction, :memory_configuration, :prompt_override_configuration, :recommended_actions, :updated_at, :version) SENSITIVE = [:instruction, :prompt_override_configuration] include Aws::Structure end |
#agent_collaboration ⇒ String
The agent's collaboration settings.
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 982 class AgentVersion < Struct.new( :agent_arn, :agent_collaboration, :agent_id, :agent_name, :agent_resource_role_arn, :agent_status, :created_at, :customer_encryption_key_arn, :description, :failure_reasons, :foundation_model, :guardrail_configuration, :idle_session_ttl_in_seconds, :instruction, :memory_configuration, :prompt_override_configuration, :recommended_actions, :updated_at, :version) SENSITIVE = [:instruction, :prompt_override_configuration] include Aws::Structure end |
#agent_id ⇒ String
The unique identifier of the agent that the version belongs to.
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 982 class AgentVersion < Struct.new( :agent_arn, :agent_collaboration, :agent_id, :agent_name, :agent_resource_role_arn, :agent_status, :created_at, :customer_encryption_key_arn, :description, :failure_reasons, :foundation_model, :guardrail_configuration, :idle_session_ttl_in_seconds, :instruction, :memory_configuration, :prompt_override_configuration, :recommended_actions, :updated_at, :version) SENSITIVE = [:instruction, :prompt_override_configuration] include Aws::Structure end |
#agent_name ⇒ String
The name of the agent that the version belongs to.
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 982 class AgentVersion < Struct.new( :agent_arn, :agent_collaboration, :agent_id, :agent_name, :agent_resource_role_arn, :agent_status, :created_at, :customer_encryption_key_arn, :description, :failure_reasons, :foundation_model, :guardrail_configuration, :idle_session_ttl_in_seconds, :instruction, :memory_configuration, :prompt_override_configuration, :recommended_actions, :updated_at, :version) 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.
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 982 class AgentVersion < Struct.new( :agent_arn, :agent_collaboration, :agent_id, :agent_name, :agent_resource_role_arn, :agent_status, :created_at, :customer_encryption_key_arn, :description, :failure_reasons, :foundation_model, :guardrail_configuration, :idle_session_ttl_in_seconds, :instruction, :memory_configuration, :prompt_override_configuration, :recommended_actions, :updated_at, :version) SENSITIVE = [:instruction, :prompt_override_configuration] include Aws::Structure end |
#agent_status ⇒ String
The status of the agent that the version belongs to.
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 982 class AgentVersion < Struct.new( :agent_arn, :agent_collaboration, :agent_id, :agent_name, :agent_resource_role_arn, :agent_status, :created_at, :customer_encryption_key_arn, :description, :failure_reasons, :foundation_model, :guardrail_configuration, :idle_session_ttl_in_seconds, :instruction, :memory_configuration, :prompt_override_configuration, :recommended_actions, :updated_at, :version) SENSITIVE = [:instruction, :prompt_override_configuration] include Aws::Structure end |
#created_at ⇒ Time
The time at which the version was created.
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 982 class AgentVersion < Struct.new( :agent_arn, :agent_collaboration, :agent_id, :agent_name, :agent_resource_role_arn, :agent_status, :created_at, :customer_encryption_key_arn, :description, :failure_reasons, :foundation_model, :guardrail_configuration, :idle_session_ttl_in_seconds, :instruction, :memory_configuration, :prompt_override_configuration, :recommended_actions, :updated_at, :version) SENSITIVE = [:instruction, :prompt_override_configuration] include Aws::Structure end |
#customer_encryption_key_arn ⇒ String
The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 982 class AgentVersion < Struct.new( :agent_arn, :agent_collaboration, :agent_id, :agent_name, :agent_resource_role_arn, :agent_status, :created_at, :customer_encryption_key_arn, :description, :failure_reasons, :foundation_model, :guardrail_configuration, :idle_session_ttl_in_seconds, :instruction, :memory_configuration, :prompt_override_configuration, :recommended_actions, :updated_at, :version) SENSITIVE = [:instruction, :prompt_override_configuration] include Aws::Structure end |
#description ⇒ String
The description of the version.
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 982 class AgentVersion < Struct.new( :agent_arn, :agent_collaboration, :agent_id, :agent_name, :agent_resource_role_arn, :agent_status, :created_at, :customer_encryption_key_arn, :description, :failure_reasons, :foundation_model, :guardrail_configuration, :idle_session_ttl_in_seconds, :instruction, :memory_configuration, :prompt_override_configuration, :recommended_actions, :updated_at, :version) SENSITIVE = [:instruction, :prompt_override_configuration] include Aws::Structure end |
#failure_reasons ⇒ Array<String>
A list of reasons that the API operation on the version failed.
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 982 class AgentVersion < Struct.new( :agent_arn, :agent_collaboration, :agent_id, :agent_name, :agent_resource_role_arn, :agent_status, :created_at, :customer_encryption_key_arn, :description, :failure_reasons, :foundation_model, :guardrail_configuration, :idle_session_ttl_in_seconds, :instruction, :memory_configuration, :prompt_override_configuration, :recommended_actions, :updated_at, :version) SENSITIVE = [:instruction, :prompt_override_configuration] include Aws::Structure end |
#foundation_model ⇒ String
The foundation model that the version invokes.
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 982 class AgentVersion < Struct.new( :agent_arn, :agent_collaboration, :agent_id, :agent_name, :agent_resource_role_arn, :agent_status, :created_at, :customer_encryption_key_arn, :description, :failure_reasons, :foundation_model, :guardrail_configuration, :idle_session_ttl_in_seconds, :instruction, :memory_configuration, :prompt_override_configuration, :recommended_actions, :updated_at, :version) SENSITIVE = [:instruction, :prompt_override_configuration] include Aws::Structure end |
#guardrail_configuration ⇒ Types::GuardrailConfiguration
Details about the guardrail associated with the agent.
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 982 class AgentVersion < Struct.new( :agent_arn, :agent_collaboration, :agent_id, :agent_name, :agent_resource_role_arn, :agent_status, :created_at, :customer_encryption_key_arn, :description, :failure_reasons, :foundation_model, :guardrail_configuration, :idle_session_ttl_in_seconds, :instruction, :memory_configuration, :prompt_override_configuration, :recommended_actions, :updated_at, :version) 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.
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 982 class AgentVersion < Struct.new( :agent_arn, :agent_collaboration, :agent_id, :agent_name, :agent_resource_role_arn, :agent_status, :created_at, :customer_encryption_key_arn, :description, :failure_reasons, :foundation_model, :guardrail_configuration, :idle_session_ttl_in_seconds, :instruction, :memory_configuration, :prompt_override_configuration, :recommended_actions, :updated_at, :version) SENSITIVE = [:instruction, :prompt_override_configuration] include Aws::Structure end |
#instruction ⇒ String
The instructions provided to the agent.
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 982 class AgentVersion < Struct.new( :agent_arn, :agent_collaboration, :agent_id, :agent_name, :agent_resource_role_arn, :agent_status, :created_at, :customer_encryption_key_arn, :description, :failure_reasons, :foundation_model, :guardrail_configuration, :idle_session_ttl_in_seconds, :instruction, :memory_configuration, :prompt_override_configuration, :recommended_actions, :updated_at, :version) SENSITIVE = [:instruction, :prompt_override_configuration] include Aws::Structure end |
#memory_configuration ⇒ Types::MemoryConfiguration
Contains details of the memory configuration on the version of the agent.
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 982 class AgentVersion < Struct.new( :agent_arn, :agent_collaboration, :agent_id, :agent_name, :agent_resource_role_arn, :agent_status, :created_at, :customer_encryption_key_arn, :description, :failure_reasons, :foundation_model, :guardrail_configuration, :idle_session_ttl_in_seconds, :instruction, :memory_configuration, :prompt_override_configuration, :recommended_actions, :updated_at, :version) SENSITIVE = [:instruction, :prompt_override_configuration] include Aws::Structure end |
#prompt_override_configuration ⇒ Types::PromptOverrideConfiguration
Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 982 class AgentVersion < Struct.new( :agent_arn, :agent_collaboration, :agent_id, :agent_name, :agent_resource_role_arn, :agent_status, :created_at, :customer_encryption_key_arn, :description, :failure_reasons, :foundation_model, :guardrail_configuration, :idle_session_ttl_in_seconds, :instruction, :memory_configuration, :prompt_override_configuration, :recommended_actions, :updated_at, :version) SENSITIVE = [:instruction, :prompt_override_configuration] include Aws::Structure end |
#recommended_actions ⇒ Array<String>
A list of recommended actions to take for the failed API operation on the version to succeed.
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 982 class AgentVersion < Struct.new( :agent_arn, :agent_collaboration, :agent_id, :agent_name, :agent_resource_role_arn, :agent_status, :created_at, :customer_encryption_key_arn, :description, :failure_reasons, :foundation_model, :guardrail_configuration, :idle_session_ttl_in_seconds, :instruction, :memory_configuration, :prompt_override_configuration, :recommended_actions, :updated_at, :version) SENSITIVE = [:instruction, :prompt_override_configuration] include Aws::Structure end |
#updated_at ⇒ Time
The time at which the version was last updated.
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 982 class AgentVersion < Struct.new( :agent_arn, :agent_collaboration, :agent_id, :agent_name, :agent_resource_role_arn, :agent_status, :created_at, :customer_encryption_key_arn, :description, :failure_reasons, :foundation_model, :guardrail_configuration, :idle_session_ttl_in_seconds, :instruction, :memory_configuration, :prompt_override_configuration, :recommended_actions, :updated_at, :version) SENSITIVE = [:instruction, :prompt_override_configuration] include Aws::Structure end |
#version ⇒ String
The version number.
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 982 class AgentVersion < Struct.new( :agent_arn, :agent_collaboration, :agent_id, :agent_name, :agent_resource_role_arn, :agent_status, :created_at, :customer_encryption_key_arn, :description, :failure_reasons, :foundation_model, :guardrail_configuration, :idle_session_ttl_in_seconds, :instruction, :memory_configuration, :prompt_override_configuration, :recommended_actions, :updated_at, :version) SENSITIVE = [:instruction, :prompt_override_configuration] include Aws::Structure end |