AWS SDK for C++

AWS SDK for C++ Version 1.11.849

Loading...
Searching...
No Matches
RetrieveRequest.h
1
6#pragma once
7#include <aws/bedrock-agent-runtime/BedrockAgentRuntimeRequest.h>
8#include <aws/bedrock-agent-runtime/BedrockAgentRuntime_EXPORTS.h>
9#include <aws/bedrock-agent-runtime/model/GuardrailConfiguration.h>
10#include <aws/bedrock-agent-runtime/model/KnowledgeBaseQuery.h>
11#include <aws/bedrock-agent-runtime/model/KnowledgeBaseRetrievalConfiguration.h>
12#include <aws/bedrock-agent-runtime/model/UserContext.h>
13#include <aws/core/utils/memory/stl/AWSString.h>
14
15#include <utility>
16
17namespace Aws {
18namespace BedrockAgentRuntime {
19namespace Model {
20
24 public:
25 AWS_BEDROCKAGENTRUNTIME_API RetrieveRequest() = default;
26
27 // Service request name is the Operation name which will send this request out,
28 // each operation should has unique request name, so that we can get operation's name from this request.
29 // Note: this is not true for response, multiple operations may have the same response name,
30 // so we can not get operation's name from response.
31 inline virtual const char* GetServiceRequestName() const override { return "Retrieve"; }
32
33 AWS_BEDROCKAGENTRUNTIME_API Aws::String SerializePayload() const override;
34
36
39 inline const GuardrailConfiguration& GetGuardrailConfiguration() const { return m_guardrailConfiguration; }
40 inline bool GuardrailConfigurationHasBeenSet() const { return m_guardrailConfigurationHasBeenSet; }
41 template <typename GuardrailConfigurationT = GuardrailConfiguration>
43 m_guardrailConfigurationHasBeenSet = true;
44 m_guardrailConfiguration = std::forward<GuardrailConfigurationT>(value);
45 }
46 template <typename GuardrailConfigurationT = GuardrailConfiguration>
48 SetGuardrailConfiguration(std::forward<GuardrailConfigurationT>(value));
49 return *this;
50 }
52
54
57 inline const Aws::String& GetKnowledgeBaseId() const { return m_knowledgeBaseId; }
58 inline bool KnowledgeBaseIdHasBeenSet() const { return m_knowledgeBaseIdHasBeenSet; }
59 template <typename KnowledgeBaseIdT = Aws::String>
61 m_knowledgeBaseIdHasBeenSet = true;
62 m_knowledgeBaseId = std::forward<KnowledgeBaseIdT>(value);
63 }
64 template <typename KnowledgeBaseIdT = Aws::String>
66 SetKnowledgeBaseId(std::forward<KnowledgeBaseIdT>(value));
67 return *this;
68 }
70
72
77 inline const Aws::String& GetNextToken() const { return m_nextToken; }
78 inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
79 template <typename NextTokenT = Aws::String>
80 void SetNextToken(NextTokenT&& value) {
81 m_nextTokenHasBeenSet = true;
82 m_nextToken = std::forward<NextTokenT>(value);
83 }
84 template <typename NextTokenT = Aws::String>
86 SetNextToken(std::forward<NextTokenT>(value));
87 return *this;
88 }
90
92
98 inline const KnowledgeBaseRetrievalConfiguration& GetRetrievalConfiguration() const { return m_retrievalConfiguration; }
99 inline bool RetrievalConfigurationHasBeenSet() const { return m_retrievalConfigurationHasBeenSet; }
100 template <typename RetrievalConfigurationT = KnowledgeBaseRetrievalConfiguration>
102 m_retrievalConfigurationHasBeenSet = true;
103 m_retrievalConfiguration = std::forward<RetrievalConfigurationT>(value);
104 }
105 template <typename RetrievalConfigurationT = KnowledgeBaseRetrievalConfiguration>
107 SetRetrievalConfiguration(std::forward<RetrievalConfigurationT>(value));
108 return *this;
109 }
111
113
116 inline const KnowledgeBaseQuery& GetRetrievalQuery() const { return m_retrievalQuery; }
117 inline bool RetrievalQueryHasBeenSet() const { return m_retrievalQueryHasBeenSet; }
118 template <typename RetrievalQueryT = KnowledgeBaseQuery>
120 m_retrievalQueryHasBeenSet = true;
121 m_retrievalQuery = std::forward<RetrievalQueryT>(value);
122 }
123 template <typename RetrievalQueryT = KnowledgeBaseQuery>
125 SetRetrievalQuery(std::forward<RetrievalQueryT>(value));
126 return *this;
127 }
129
131
132 inline const UserContext& GetUserContext() const { return m_userContext; }
133 inline bool UserContextHasBeenSet() const { return m_userContextHasBeenSet; }
134 template <typename UserContextT = UserContext>
136 m_userContextHasBeenSet = true;
137 m_userContext = std::forward<UserContextT>(value);
138 }
139 template <typename UserContextT = UserContext>
141 SetUserContext(std::forward<UserContextT>(value));
142 return *this;
143 }
145 private:
146 GuardrailConfiguration m_guardrailConfiguration;
147
148 Aws::String m_knowledgeBaseId;
149
150 Aws::String m_nextToken;
151
152 KnowledgeBaseRetrievalConfiguration m_retrievalConfiguration;
153
154 KnowledgeBaseQuery m_retrievalQuery;
155
156 UserContext m_userContext;
157 bool m_guardrailConfigurationHasBeenSet = false;
158 bool m_knowledgeBaseIdHasBeenSet = false;
159 bool m_nextTokenHasBeenSet = false;
160 bool m_retrievalConfigurationHasBeenSet = false;
161 bool m_retrievalQueryHasBeenSet = false;
162 bool m_userContextHasBeenSet = false;
163};
164
165} // namespace Model
166} // namespace BedrockAgentRuntime
167} // namespace Aws
void SetKnowledgeBaseId(KnowledgeBaseIdT &&value)
RetrieveRequest & WithRetrievalQuery(RetrievalQueryT &&value)
AWS_BEDROCKAGENTRUNTIME_API Aws::String SerializePayload() const override
RetrieveRequest & WithGuardrailConfiguration(GuardrailConfigurationT &&value)
const GuardrailConfiguration & GetGuardrailConfiguration() const
RetrieveRequest & WithKnowledgeBaseId(KnowledgeBaseIdT &&value)
RetrieveRequest & WithRetrievalConfiguration(RetrievalConfigurationT &&value)
void SetRetrievalConfiguration(RetrievalConfigurationT &&value)
RetrieveRequest & WithUserContext(UserContextT &&value)
const KnowledgeBaseRetrievalConfiguration & GetRetrievalConfiguration() const
AWS_BEDROCKAGENTRUNTIME_API RetrieveRequest()=default
RetrieveRequest & WithNextToken(NextTokenT &&value)
const KnowledgeBaseQuery & GetRetrievalQuery() const
virtual const char * GetServiceRequestName() const override
void SetGuardrailConfiguration(GuardrailConfigurationT &&value)
std::shared_ptr< T > MakeShared(const char *allocationTag, ArgTypes &&... args)
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String