AWS SDK for C++

AWS SDK for C++ Version 1.11.606

Loading...
Searching...
No Matches
RetrieveRequest.h
1
6#pragma once
7#include <aws/bedrock-agent-runtime/BedrockAgentRuntime_EXPORTS.h>
8#include <aws/bedrock-agent-runtime/BedrockAgentRuntimeRequest.h>
9#include <aws/bedrock-agent-runtime/model/GuardrailConfiguration.h>
10#include <aws/core/utils/memory/stl/AWSString.h>
11#include <aws/bedrock-agent-runtime/model/KnowledgeBaseRetrievalConfiguration.h>
12#include <aws/bedrock-agent-runtime/model/KnowledgeBaseQuery.h>
13#include <utility>
14
15namespace Aws
16{
17namespace BedrockAgentRuntime
18{
19namespace Model
20{
21
25 {
26 public:
27 AWS_BEDROCKAGENTRUNTIME_API RetrieveRequest() = default;
28
29 // Service request name is the Operation name which will send this request out,
30 // each operation should has unique request name, so that we can get operation's name from this request.
31 // Note: this is not true for response, multiple operations may have the same response name,
32 // so we can not get operation's name from response.
33 inline virtual const char* GetServiceRequestName() const override { return "Retrieve"; }
34
35 AWS_BEDROCKAGENTRUNTIME_API Aws::String SerializePayload() const override;
36
37
39
42 inline const GuardrailConfiguration& GetGuardrailConfiguration() const { return m_guardrailConfiguration; }
43 inline bool GuardrailConfigurationHasBeenSet() const { return m_guardrailConfigurationHasBeenSet; }
44 template<typename GuardrailConfigurationT = GuardrailConfiguration>
45 void SetGuardrailConfiguration(GuardrailConfigurationT&& value) { m_guardrailConfigurationHasBeenSet = true; m_guardrailConfiguration = std::forward<GuardrailConfigurationT>(value); }
46 template<typename GuardrailConfigurationT = GuardrailConfiguration>
47 RetrieveRequest& WithGuardrailConfiguration(GuardrailConfigurationT&& value) { SetGuardrailConfiguration(std::forward<GuardrailConfigurationT>(value)); return *this;}
49
51
54 inline const Aws::String& GetKnowledgeBaseId() const { return m_knowledgeBaseId; }
55 inline bool KnowledgeBaseIdHasBeenSet() const { return m_knowledgeBaseIdHasBeenSet; }
56 template<typename KnowledgeBaseIdT = Aws::String>
57 void SetKnowledgeBaseId(KnowledgeBaseIdT&& value) { m_knowledgeBaseIdHasBeenSet = true; m_knowledgeBaseId = std::forward<KnowledgeBaseIdT>(value); }
58 template<typename KnowledgeBaseIdT = Aws::String>
59 RetrieveRequest& WithKnowledgeBaseId(KnowledgeBaseIdT&& value) { SetKnowledgeBaseId(std::forward<KnowledgeBaseIdT>(value)); return *this;}
61
63
68 inline const Aws::String& GetNextToken() const { return m_nextToken; }
69 inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
70 template<typename NextTokenT = Aws::String>
71 void SetNextToken(NextTokenT&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::forward<NextTokenT>(value); }
72 template<typename NextTokenT = Aws::String>
73 RetrieveRequest& WithNextToken(NextTokenT&& value) { SetNextToken(std::forward<NextTokenT>(value)); return *this;}
75
77
83 inline const KnowledgeBaseRetrievalConfiguration& GetRetrievalConfiguration() const { return m_retrievalConfiguration; }
84 inline bool RetrievalConfigurationHasBeenSet() const { return m_retrievalConfigurationHasBeenSet; }
85 template<typename RetrievalConfigurationT = KnowledgeBaseRetrievalConfiguration>
86 void SetRetrievalConfiguration(RetrievalConfigurationT&& value) { m_retrievalConfigurationHasBeenSet = true; m_retrievalConfiguration = std::forward<RetrievalConfigurationT>(value); }
87 template<typename RetrievalConfigurationT = KnowledgeBaseRetrievalConfiguration>
88 RetrieveRequest& WithRetrievalConfiguration(RetrievalConfigurationT&& value) { SetRetrievalConfiguration(std::forward<RetrievalConfigurationT>(value)); return *this;}
90
92
95 inline const KnowledgeBaseQuery& GetRetrievalQuery() const { return m_retrievalQuery; }
96 inline bool RetrievalQueryHasBeenSet() const { return m_retrievalQueryHasBeenSet; }
97 template<typename RetrievalQueryT = KnowledgeBaseQuery>
98 void SetRetrievalQuery(RetrievalQueryT&& value) { m_retrievalQueryHasBeenSet = true; m_retrievalQuery = std::forward<RetrievalQueryT>(value); }
99 template<typename RetrievalQueryT = KnowledgeBaseQuery>
100 RetrieveRequest& WithRetrievalQuery(RetrievalQueryT&& value) { SetRetrievalQuery(std::forward<RetrievalQueryT>(value)); return *this;}
102 private:
103
104 GuardrailConfiguration m_guardrailConfiguration;
105 bool m_guardrailConfigurationHasBeenSet = false;
106
107 Aws::String m_knowledgeBaseId;
108 bool m_knowledgeBaseIdHasBeenSet = false;
109
110 Aws::String m_nextToken;
111 bool m_nextTokenHasBeenSet = false;
112
113 KnowledgeBaseRetrievalConfiguration m_retrievalConfiguration;
114 bool m_retrievalConfigurationHasBeenSet = false;
115
116 KnowledgeBaseQuery m_retrievalQuery;
117 bool m_retrievalQueryHasBeenSet = false;
118 };
119
120} // namespace Model
121} // namespace BedrockAgentRuntime
122} // namespace Aws
void SetKnowledgeBaseId(KnowledgeBaseIdT &&value)
void SetRetrievalQuery(RetrievalQueryT &&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::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String