|
| 1 | +/** |
| 2 | + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. |
| 3 | + * SPDX-License-Identifier: Apache-2.0. |
| 4 | + */ |
| 5 | + |
| 6 | +#pragma once |
| 7 | +#include <aws/bedrock-agent-runtime/BedrockAgentRuntime_EXPORTS.h> |
| 8 | +#include <aws/core/utils/memory/stl/AWSVector.h> |
| 9 | +#include <aws/bedrock-agent-runtime/model/AgentCollaboration.h> |
| 10 | +#include <aws/core/utils/memory/stl/AWSString.h> |
| 11 | +#include <aws/bedrock-agent-runtime/model/GuardrailConfigurationWithArn.h> |
| 12 | +#include <aws/bedrock-agent-runtime/model/PromptOverrideConfiguration.h> |
| 13 | +#include <aws/bedrock-agent-runtime/model/AgentActionGroup.h> |
| 14 | +#include <aws/bedrock-agent-runtime/model/CollaboratorConfiguration.h> |
| 15 | +#include <aws/bedrock-agent-runtime/model/KnowledgeBase.h> |
| 16 | +#include <utility> |
| 17 | + |
| 18 | +namespace Aws |
| 19 | +{ |
| 20 | +namespace Utils |
| 21 | +{ |
| 22 | +namespace Json |
| 23 | +{ |
| 24 | + class JsonValue; |
| 25 | + class JsonView; |
| 26 | +} // namespace Json |
| 27 | +} // namespace Utils |
| 28 | +namespace BedrockAgentRuntime |
| 29 | +{ |
| 30 | +namespace Model |
| 31 | +{ |
| 32 | + |
| 33 | + /** |
| 34 | + * <p> List of inline collaborators. </p><p><h3>See Also:</h3> <a |
| 35 | + * href="http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/Collaborator">AWS |
| 36 | + * API Reference</a></p> |
| 37 | + */ |
| 38 | + class Collaborator |
| 39 | + { |
| 40 | + public: |
| 41 | + AWS_BEDROCKAGENTRUNTIME_API Collaborator(); |
| 42 | + AWS_BEDROCKAGENTRUNTIME_API Collaborator(Aws::Utils::Json::JsonView jsonValue); |
| 43 | + AWS_BEDROCKAGENTRUNTIME_API Collaborator& operator=(Aws::Utils::Json::JsonView jsonValue); |
| 44 | + AWS_BEDROCKAGENTRUNTIME_API Aws::Utils::Json::JsonValue Jsonize() const; |
| 45 | + |
| 46 | + |
| 47 | + ///@{ |
| 48 | + /** |
| 49 | + * <p> List of action groups with each action group defining tasks the inline |
| 50 | + * collaborator agent needs to carry out. </p> |
| 51 | + */ |
| 52 | + inline const Aws::Vector<AgentActionGroup>& GetActionGroups() const{ return m_actionGroups; } |
| 53 | + inline bool ActionGroupsHasBeenSet() const { return m_actionGroupsHasBeenSet; } |
| 54 | + inline void SetActionGroups(const Aws::Vector<AgentActionGroup>& value) { m_actionGroupsHasBeenSet = true; m_actionGroups = value; } |
| 55 | + inline void SetActionGroups(Aws::Vector<AgentActionGroup>&& value) { m_actionGroupsHasBeenSet = true; m_actionGroups = std::move(value); } |
| 56 | + inline Collaborator& WithActionGroups(const Aws::Vector<AgentActionGroup>& value) { SetActionGroups(value); return *this;} |
| 57 | + inline Collaborator& WithActionGroups(Aws::Vector<AgentActionGroup>&& value) { SetActionGroups(std::move(value)); return *this;} |
| 58 | + inline Collaborator& AddActionGroups(const AgentActionGroup& value) { m_actionGroupsHasBeenSet = true; m_actionGroups.push_back(value); return *this; } |
| 59 | + inline Collaborator& AddActionGroups(AgentActionGroup&& value) { m_actionGroupsHasBeenSet = true; m_actionGroups.push_back(std::move(value)); return *this; } |
| 60 | + ///@} |
| 61 | + |
| 62 | + ///@{ |
| 63 | + /** |
| 64 | + * <p> Defines how the inline supervisor agent handles information across multiple |
| 65 | + * collaborator agents to coordinate a final response. </p> |
| 66 | + */ |
| 67 | + inline const AgentCollaboration& GetAgentCollaboration() const{ return m_agentCollaboration; } |
| 68 | + inline bool AgentCollaborationHasBeenSet() const { return m_agentCollaborationHasBeenSet; } |
| 69 | + inline void SetAgentCollaboration(const AgentCollaboration& value) { m_agentCollaborationHasBeenSet = true; m_agentCollaboration = value; } |
| 70 | + inline void SetAgentCollaboration(AgentCollaboration&& value) { m_agentCollaborationHasBeenSet = true; m_agentCollaboration = std::move(value); } |
| 71 | + inline Collaborator& WithAgentCollaboration(const AgentCollaboration& value) { SetAgentCollaboration(value); return *this;} |
| 72 | + inline Collaborator& WithAgentCollaboration(AgentCollaboration&& value) { SetAgentCollaboration(std::move(value)); return *this;} |
| 73 | + ///@} |
| 74 | + |
| 75 | + ///@{ |
| 76 | + /** |
| 77 | + * <p> Name of the inline collaborator agent which must be the same name as |
| 78 | + * specified for <code>collaboratorName</code>. </p> |
| 79 | + */ |
| 80 | + inline const Aws::String& GetAgentName() const{ return m_agentName; } |
| 81 | + inline bool AgentNameHasBeenSet() const { return m_agentNameHasBeenSet; } |
| 82 | + inline void SetAgentName(const Aws::String& value) { m_agentNameHasBeenSet = true; m_agentName = value; } |
| 83 | + inline void SetAgentName(Aws::String&& value) { m_agentNameHasBeenSet = true; m_agentName = std::move(value); } |
| 84 | + inline void SetAgentName(const char* value) { m_agentNameHasBeenSet = true; m_agentName.assign(value); } |
| 85 | + inline Collaborator& WithAgentName(const Aws::String& value) { SetAgentName(value); return *this;} |
| 86 | + inline Collaborator& WithAgentName(Aws::String&& value) { SetAgentName(std::move(value)); return *this;} |
| 87 | + inline Collaborator& WithAgentName(const char* value) { SetAgentName(value); return *this;} |
| 88 | + ///@} |
| 89 | + |
| 90 | + ///@{ |
| 91 | + /** |
| 92 | + * <p> Settings of the collaborator agent. </p> |
| 93 | + */ |
| 94 | + inline const Aws::Vector<CollaboratorConfiguration>& GetCollaboratorConfigurations() const{ return m_collaboratorConfigurations; } |
| 95 | + inline bool CollaboratorConfigurationsHasBeenSet() const { return m_collaboratorConfigurationsHasBeenSet; } |
| 96 | + inline void SetCollaboratorConfigurations(const Aws::Vector<CollaboratorConfiguration>& value) { m_collaboratorConfigurationsHasBeenSet = true; m_collaboratorConfigurations = value; } |
| 97 | + inline void SetCollaboratorConfigurations(Aws::Vector<CollaboratorConfiguration>&& value) { m_collaboratorConfigurationsHasBeenSet = true; m_collaboratorConfigurations = std::move(value); } |
| 98 | + inline Collaborator& WithCollaboratorConfigurations(const Aws::Vector<CollaboratorConfiguration>& value) { SetCollaboratorConfigurations(value); return *this;} |
| 99 | + inline Collaborator& WithCollaboratorConfigurations(Aws::Vector<CollaboratorConfiguration>&& value) { SetCollaboratorConfigurations(std::move(value)); return *this;} |
| 100 | + inline Collaborator& AddCollaboratorConfigurations(const CollaboratorConfiguration& value) { m_collaboratorConfigurationsHasBeenSet = true; m_collaboratorConfigurations.push_back(value); return *this; } |
| 101 | + inline Collaborator& AddCollaboratorConfigurations(CollaboratorConfiguration&& value) { m_collaboratorConfigurationsHasBeenSet = true; m_collaboratorConfigurations.push_back(std::move(value)); return *this; } |
| 102 | + ///@} |
| 103 | + |
| 104 | + ///@{ |
| 105 | + /** |
| 106 | + * <p> The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the inline |
| 107 | + * collaborator. </p> |
| 108 | + */ |
| 109 | + inline const Aws::String& GetCustomerEncryptionKeyArn() const{ return m_customerEncryptionKeyArn; } |
| 110 | + inline bool CustomerEncryptionKeyArnHasBeenSet() const { return m_customerEncryptionKeyArnHasBeenSet; } |
| 111 | + inline void SetCustomerEncryptionKeyArn(const Aws::String& value) { m_customerEncryptionKeyArnHasBeenSet = true; m_customerEncryptionKeyArn = value; } |
| 112 | + inline void SetCustomerEncryptionKeyArn(Aws::String&& value) { m_customerEncryptionKeyArnHasBeenSet = true; m_customerEncryptionKeyArn = std::move(value); } |
| 113 | + inline void SetCustomerEncryptionKeyArn(const char* value) { m_customerEncryptionKeyArnHasBeenSet = true; m_customerEncryptionKeyArn.assign(value); } |
| 114 | + inline Collaborator& WithCustomerEncryptionKeyArn(const Aws::String& value) { SetCustomerEncryptionKeyArn(value); return *this;} |
| 115 | + inline Collaborator& WithCustomerEncryptionKeyArn(Aws::String&& value) { SetCustomerEncryptionKeyArn(std::move(value)); return *this;} |
| 116 | + inline Collaborator& WithCustomerEncryptionKeyArn(const char* value) { SetCustomerEncryptionKeyArn(value); return *this;} |
| 117 | + ///@} |
| 118 | + |
| 119 | + ///@{ |
| 120 | + /** |
| 121 | + * <p> The foundation model used by the inline collaborator agent. </p> |
| 122 | + */ |
| 123 | + inline const Aws::String& GetFoundationModel() const{ return m_foundationModel; } |
| 124 | + inline bool FoundationModelHasBeenSet() const { return m_foundationModelHasBeenSet; } |
| 125 | + inline void SetFoundationModel(const Aws::String& value) { m_foundationModelHasBeenSet = true; m_foundationModel = value; } |
| 126 | + inline void SetFoundationModel(Aws::String&& value) { m_foundationModelHasBeenSet = true; m_foundationModel = std::move(value); } |
| 127 | + inline void SetFoundationModel(const char* value) { m_foundationModelHasBeenSet = true; m_foundationModel.assign(value); } |
| 128 | + inline Collaborator& WithFoundationModel(const Aws::String& value) { SetFoundationModel(value); return *this;} |
| 129 | + inline Collaborator& WithFoundationModel(Aws::String&& value) { SetFoundationModel(std::move(value)); return *this;} |
| 130 | + inline Collaborator& WithFoundationModel(const char* value) { SetFoundationModel(value); return *this;} |
| 131 | + ///@} |
| 132 | + |
| 133 | + ///@{ |
| 134 | + /** |
| 135 | + * <p> Details of the guardwrail associated with the inline collaborator. </p> |
| 136 | + */ |
| 137 | + inline const GuardrailConfigurationWithArn& GetGuardrailConfiguration() const{ return m_guardrailConfiguration; } |
| 138 | + inline bool GuardrailConfigurationHasBeenSet() const { return m_guardrailConfigurationHasBeenSet; } |
| 139 | + inline void SetGuardrailConfiguration(const GuardrailConfigurationWithArn& value) { m_guardrailConfigurationHasBeenSet = true; m_guardrailConfiguration = value; } |
| 140 | + inline void SetGuardrailConfiguration(GuardrailConfigurationWithArn&& value) { m_guardrailConfigurationHasBeenSet = true; m_guardrailConfiguration = std::move(value); } |
| 141 | + inline Collaborator& WithGuardrailConfiguration(const GuardrailConfigurationWithArn& value) { SetGuardrailConfiguration(value); return *this;} |
| 142 | + inline Collaborator& WithGuardrailConfiguration(GuardrailConfigurationWithArn&& value) { SetGuardrailConfiguration(std::move(value)); return *this;} |
| 143 | + ///@} |
| 144 | + |
| 145 | + ///@{ |
| 146 | + /** |
| 147 | + * <p> The number of seconds for which the Amazon Bedrock keeps information about |
| 148 | + * the user's conversation with the inline collaborator agent.</p> <p>A user |
| 149 | + * interaction remains active for the amount of time specified. If no conversation |
| 150 | + * occurs during this time, the session expires and Amazon Bedrock deletes any data |
| 151 | + * provided before the timeout. </p> |
| 152 | + */ |
| 153 | + inline int GetIdleSessionTTLInSeconds() const{ return m_idleSessionTTLInSeconds; } |
| 154 | + inline bool IdleSessionTTLInSecondsHasBeenSet() const { return m_idleSessionTTLInSecondsHasBeenSet; } |
| 155 | + inline void SetIdleSessionTTLInSeconds(int value) { m_idleSessionTTLInSecondsHasBeenSet = true; m_idleSessionTTLInSeconds = value; } |
| 156 | + inline Collaborator& WithIdleSessionTTLInSeconds(int value) { SetIdleSessionTTLInSeconds(value); return *this;} |
| 157 | + ///@} |
| 158 | + |
| 159 | + ///@{ |
| 160 | + /** |
| 161 | + * <p> Instruction that tell the inline collaborator agent what it should do and |
| 162 | + * how it should interact with users. </p> |
| 163 | + */ |
| 164 | + inline const Aws::String& GetInstruction() const{ return m_instruction; } |
| 165 | + inline bool InstructionHasBeenSet() const { return m_instructionHasBeenSet; } |
| 166 | + inline void SetInstruction(const Aws::String& value) { m_instructionHasBeenSet = true; m_instruction = value; } |
| 167 | + inline void SetInstruction(Aws::String&& value) { m_instructionHasBeenSet = true; m_instruction = std::move(value); } |
| 168 | + inline void SetInstruction(const char* value) { m_instructionHasBeenSet = true; m_instruction.assign(value); } |
| 169 | + inline Collaborator& WithInstruction(const Aws::String& value) { SetInstruction(value); return *this;} |
| 170 | + inline Collaborator& WithInstruction(Aws::String&& value) { SetInstruction(std::move(value)); return *this;} |
| 171 | + inline Collaborator& WithInstruction(const char* value) { SetInstruction(value); return *this;} |
| 172 | + ///@} |
| 173 | + |
| 174 | + ///@{ |
| 175 | + /** |
| 176 | + * <p> Knowledge base associated with the inline collaborator agent. </p> |
| 177 | + */ |
| 178 | + inline const Aws::Vector<KnowledgeBase>& GetKnowledgeBases() const{ return m_knowledgeBases; } |
| 179 | + inline bool KnowledgeBasesHasBeenSet() const { return m_knowledgeBasesHasBeenSet; } |
| 180 | + inline void SetKnowledgeBases(const Aws::Vector<KnowledgeBase>& value) { m_knowledgeBasesHasBeenSet = true; m_knowledgeBases = value; } |
| 181 | + inline void SetKnowledgeBases(Aws::Vector<KnowledgeBase>&& value) { m_knowledgeBasesHasBeenSet = true; m_knowledgeBases = std::move(value); } |
| 182 | + inline Collaborator& WithKnowledgeBases(const Aws::Vector<KnowledgeBase>& value) { SetKnowledgeBases(value); return *this;} |
| 183 | + inline Collaborator& WithKnowledgeBases(Aws::Vector<KnowledgeBase>&& value) { SetKnowledgeBases(std::move(value)); return *this;} |
| 184 | + inline Collaborator& AddKnowledgeBases(const KnowledgeBase& value) { m_knowledgeBasesHasBeenSet = true; m_knowledgeBases.push_back(value); return *this; } |
| 185 | + inline Collaborator& AddKnowledgeBases(KnowledgeBase&& value) { m_knowledgeBasesHasBeenSet = true; m_knowledgeBases.push_back(std::move(value)); return *this; } |
| 186 | + ///@} |
| 187 | + |
| 188 | + ///@{ |
| 189 | + /** |
| 190 | + * <p> Contains configurations to override prompt templates in different parts of |
| 191 | + * an inline collaborator sequence. For more information, see <a |
| 192 | + * href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced |
| 193 | + * prompts</a>. </p> |
| 194 | + */ |
| 195 | + inline const PromptOverrideConfiguration& GetPromptOverrideConfiguration() const{ return m_promptOverrideConfiguration; } |
| 196 | + inline bool PromptOverrideConfigurationHasBeenSet() const { return m_promptOverrideConfigurationHasBeenSet; } |
| 197 | + inline void SetPromptOverrideConfiguration(const PromptOverrideConfiguration& value) { m_promptOverrideConfigurationHasBeenSet = true; m_promptOverrideConfiguration = value; } |
| 198 | + inline void SetPromptOverrideConfiguration(PromptOverrideConfiguration&& value) { m_promptOverrideConfigurationHasBeenSet = true; m_promptOverrideConfiguration = std::move(value); } |
| 199 | + inline Collaborator& WithPromptOverrideConfiguration(const PromptOverrideConfiguration& value) { SetPromptOverrideConfiguration(value); return *this;} |
| 200 | + inline Collaborator& WithPromptOverrideConfiguration(PromptOverrideConfiguration&& value) { SetPromptOverrideConfiguration(std::move(value)); return *this;} |
| 201 | + ///@} |
| 202 | + private: |
| 203 | + |
| 204 | + Aws::Vector<AgentActionGroup> m_actionGroups; |
| 205 | + bool m_actionGroupsHasBeenSet = false; |
| 206 | + |
| 207 | + AgentCollaboration m_agentCollaboration; |
| 208 | + bool m_agentCollaborationHasBeenSet = false; |
| 209 | + |
| 210 | + Aws::String m_agentName; |
| 211 | + bool m_agentNameHasBeenSet = false; |
| 212 | + |
| 213 | + Aws::Vector<CollaboratorConfiguration> m_collaboratorConfigurations; |
| 214 | + bool m_collaboratorConfigurationsHasBeenSet = false; |
| 215 | + |
| 216 | + Aws::String m_customerEncryptionKeyArn; |
| 217 | + bool m_customerEncryptionKeyArnHasBeenSet = false; |
| 218 | + |
| 219 | + Aws::String m_foundationModel; |
| 220 | + bool m_foundationModelHasBeenSet = false; |
| 221 | + |
| 222 | + GuardrailConfigurationWithArn m_guardrailConfiguration; |
| 223 | + bool m_guardrailConfigurationHasBeenSet = false; |
| 224 | + |
| 225 | + int m_idleSessionTTLInSeconds; |
| 226 | + bool m_idleSessionTTLInSecondsHasBeenSet = false; |
| 227 | + |
| 228 | + Aws::String m_instruction; |
| 229 | + bool m_instructionHasBeenSet = false; |
| 230 | + |
| 231 | + Aws::Vector<KnowledgeBase> m_knowledgeBases; |
| 232 | + bool m_knowledgeBasesHasBeenSet = false; |
| 233 | + |
| 234 | + PromptOverrideConfiguration m_promptOverrideConfiguration; |
| 235 | + bool m_promptOverrideConfigurationHasBeenSet = false; |
| 236 | + }; |
| 237 | + |
| 238 | +} // namespace Model |
| 239 | +} // namespace BedrockAgentRuntime |
| 240 | +} // namespace Aws |
0 commit comments