AWS SDK for C++

AWS SDK for C++ Version 1.11.754

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/core/utils/memory/stl/AWSString.h>
13
14#include <utility>
15
16namespace Aws {
17namespace BedrockAgentRuntime {
18namespace Model {
19
23 public:
24 AWS_BEDROCKAGENTRUNTIME_API RetrieveRequest() = default;
25
26 // Service request name is the Operation name which will send this request out,
27 // each operation should has unique request name, so that we can get operation's name from this request.
28 // Note: this is not true for response, multiple operations may have the same response name,
29 // so we can not get operation's name from response.
30 inline virtual const char* GetServiceRequestName() const override { return "Retrieve"; }
31
32 AWS_BEDROCKAGENTRUNTIME_API Aws::String SerializePayload() const override;
33
35
38 inline const GuardrailConfiguration& GetGuardrailConfiguration() const { return m_guardrailConfiguration; }
39 inline bool GuardrailConfigurationHasBeenSet() const { return m_guardrailConfigurationHasBeenSet; }
40 template <typename GuardrailConfigurationT = GuardrailConfiguration>
42 m_guardrailConfigurationHasBeenSet = true;
43 m_guardrailConfiguration = std::forward<GuardrailConfigurationT>(value);
44 }
45 template <typename GuardrailConfigurationT = GuardrailConfiguration>
47 SetGuardrailConfiguration(std::forward<GuardrailConfigurationT>(value));
48 return *this;
49 }
51
53
56 inline const Aws::String& GetKnowledgeBaseId() const { return m_knowledgeBaseId; }
57 inline bool KnowledgeBaseIdHasBeenSet() const { return m_knowledgeBaseIdHasBeenSet; }
58 template <typename KnowledgeBaseIdT = Aws::String>
60 m_knowledgeBaseIdHasBeenSet = true;
61 m_knowledgeBaseId = std::forward<KnowledgeBaseIdT>(value);
62 }
63 template <typename KnowledgeBaseIdT = Aws::String>
65 SetKnowledgeBaseId(std::forward<KnowledgeBaseIdT>(value));
66 return *this;
67 }
69
71
76 inline const Aws::String& GetNextToken() const { return m_nextToken; }
77 inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
78 template <typename NextTokenT = Aws::String>
79 void SetNextToken(NextTokenT&& value) {
80 m_nextTokenHasBeenSet = true;
81 m_nextToken = std::forward<NextTokenT>(value);
82 }
83 template <typename NextTokenT = Aws::String>
85 SetNextToken(std::forward<NextTokenT>(value));
86 return *this;
87 }
89
91
97 inline const KnowledgeBaseRetrievalConfiguration& GetRetrievalConfiguration() const { return m_retrievalConfiguration; }
98 inline bool RetrievalConfigurationHasBeenSet() const { return m_retrievalConfigurationHasBeenSet; }
99 template <typename RetrievalConfigurationT = KnowledgeBaseRetrievalConfiguration>
101 m_retrievalConfigurationHasBeenSet = true;
102 m_retrievalConfiguration = std::forward<RetrievalConfigurationT>(value);
103 }
104 template <typename RetrievalConfigurationT = KnowledgeBaseRetrievalConfiguration>
106 SetRetrievalConfiguration(std::forward<RetrievalConfigurationT>(value));
107 return *this;
108 }
110
112
115 inline const KnowledgeBaseQuery& GetRetrievalQuery() const { return m_retrievalQuery; }
116 inline bool RetrievalQueryHasBeenSet() const { return m_retrievalQueryHasBeenSet; }
117 template <typename RetrievalQueryT = KnowledgeBaseQuery>
119 m_retrievalQueryHasBeenSet = true;
120 m_retrievalQuery = std::forward<RetrievalQueryT>(value);
121 }
122 template <typename RetrievalQueryT = KnowledgeBaseQuery>
124 SetRetrievalQuery(std::forward<RetrievalQueryT>(value));
125 return *this;
126 }
128 private:
129 GuardrailConfiguration m_guardrailConfiguration;
130
131 Aws::String m_knowledgeBaseId;
132
133 Aws::String m_nextToken;
134
135 KnowledgeBaseRetrievalConfiguration m_retrievalConfiguration;
136
137 KnowledgeBaseQuery m_retrievalQuery;
138 bool m_guardrailConfigurationHasBeenSet = false;
139 bool m_knowledgeBaseIdHasBeenSet = false;
140 bool m_nextTokenHasBeenSet = false;
141 bool m_retrievalConfigurationHasBeenSet = false;
142 bool m_retrievalQueryHasBeenSet = false;
143};
144
145} // namespace Model
146} // namespace BedrockAgentRuntime
147} // 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)
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