AWS SDK for C++

AWS SDK for C++ Version 1.11.509

Loading...
Searching...
No Matches
ConverseStreamRequest.h
1
6#pragma once
7#include <aws/bedrock-runtime/BedrockRuntime_EXPORTS.h>
8#include <aws/bedrock-runtime/BedrockRuntimeRequest.h>
9#include <aws/bedrock-runtime/model/ConverseStreamHandler.h>
10#include <aws/core/utils/event/EventStreamDecoder.h>
11#include <aws/core/utils/memory/stl/AWSString.h>
12#include <aws/core/utils/memory/stl/AWSVector.h>
13#include <aws/bedrock-runtime/model/InferenceConfiguration.h>
14#include <aws/bedrock-runtime/model/ToolConfiguration.h>
15#include <aws/bedrock-runtime/model/GuardrailStreamConfiguration.h>
16#include <aws/core/utils/Document.h>
17#include <aws/core/utils/memory/stl/AWSMap.h>
18#include <aws/bedrock-runtime/model/PerformanceConfiguration.h>
19#include <aws/bedrock-runtime/model/Message.h>
20#include <aws/bedrock-runtime/model/SystemContentBlock.h>
21#include <aws/bedrock-runtime/model/PromptVariableValues.h>
22#include <utility>
23
24namespace Aws
25{
26namespace BedrockRuntime
27{
28namespace Model
29{
30
34 {
35 public:
36 AWS_BEDROCKRUNTIME_API ConverseStreamRequest();
37
38 // Service request name is the Operation name which will send this request out,
39 // each operation should has unique request name, so that we can get operation's name from this request.
40 // Note: this is not true for response, multiple operations may have the same response name,
41 // so we can not get operation's name from response.
42 inline virtual const char* GetServiceRequestName() const override { return "ConverseStream"; }
43
44 inline virtual bool HasEventStreamResponse() const override { return true; }
45 AWS_BEDROCKRUNTIME_API Aws::String SerializePayload() const override;
46
51
55 inline const ConverseStreamHandler& GetEventStreamHandler() const { return m_handler; }
56
60 inline void SetEventStreamHandler(const ConverseStreamHandler& value) { m_handler = value; m_decoder.ResetEventStreamHandler(&m_handler); }
61
66
67
69
96 inline const Aws::String& GetModelId() const{ return m_modelId; }
97 inline bool ModelIdHasBeenSet() const { return m_modelIdHasBeenSet; }
98 inline void SetModelId(const Aws::String& value) { m_modelIdHasBeenSet = true; m_modelId = value; }
99 inline void SetModelId(Aws::String&& value) { m_modelIdHasBeenSet = true; m_modelId = std::move(value); }
100 inline void SetModelId(const char* value) { m_modelIdHasBeenSet = true; m_modelId.assign(value); }
101 inline ConverseStreamRequest& WithModelId(const Aws::String& value) { SetModelId(value); return *this;}
102 inline ConverseStreamRequest& WithModelId(Aws::String&& value) { SetModelId(std::move(value)); return *this;}
103 inline ConverseStreamRequest& WithModelId(const char* value) { SetModelId(value); return *this;}
105
107
110 inline const Aws::Vector<Message>& GetMessages() const{ return m_messages; }
111 inline bool MessagesHasBeenSet() const { return m_messagesHasBeenSet; }
112 inline void SetMessages(const Aws::Vector<Message>& value) { m_messagesHasBeenSet = true; m_messages = value; }
113 inline void SetMessages(Aws::Vector<Message>&& value) { m_messagesHasBeenSet = true; m_messages = std::move(value); }
114 inline ConverseStreamRequest& WithMessages(const Aws::Vector<Message>& value) { SetMessages(value); return *this;}
115 inline ConverseStreamRequest& WithMessages(Aws::Vector<Message>&& value) { SetMessages(std::move(value)); return *this;}
116 inline ConverseStreamRequest& AddMessages(const Message& value) { m_messagesHasBeenSet = true; m_messages.push_back(value); return *this; }
117 inline ConverseStreamRequest& AddMessages(Message&& value) { m_messagesHasBeenSet = true; m_messages.push_back(std::move(value)); return *this; }
119
121
125 inline const Aws::Vector<SystemContentBlock>& GetSystem() const{ return m_system; }
126 inline bool SystemHasBeenSet() const { return m_systemHasBeenSet; }
127 inline void SetSystem(const Aws::Vector<SystemContentBlock>& value) { m_systemHasBeenSet = true; m_system = value; }
128 inline void SetSystem(Aws::Vector<SystemContentBlock>&& value) { m_systemHasBeenSet = true; m_system = std::move(value); }
129 inline ConverseStreamRequest& WithSystem(const Aws::Vector<SystemContentBlock>& value) { SetSystem(value); return *this;}
130 inline ConverseStreamRequest& WithSystem(Aws::Vector<SystemContentBlock>&& value) { SetSystem(std::move(value)); return *this;}
131 inline ConverseStreamRequest& AddSystem(const SystemContentBlock& value) { m_systemHasBeenSet = true; m_system.push_back(value); return *this; }
132 inline ConverseStreamRequest& AddSystem(SystemContentBlock&& value) { m_systemHasBeenSet = true; m_system.push_back(std::move(value)); return *this; }
134
136
142 inline const InferenceConfiguration& GetInferenceConfig() const{ return m_inferenceConfig; }
143 inline bool InferenceConfigHasBeenSet() const { return m_inferenceConfigHasBeenSet; }
144 inline void SetInferenceConfig(const InferenceConfiguration& value) { m_inferenceConfigHasBeenSet = true; m_inferenceConfig = value; }
145 inline void SetInferenceConfig(InferenceConfiguration&& value) { m_inferenceConfigHasBeenSet = true; m_inferenceConfig = std::move(value); }
147 inline ConverseStreamRequest& WithInferenceConfig(InferenceConfiguration&& value) { SetInferenceConfig(std::move(value)); return *this;}
149
151
158 inline const ToolConfiguration& GetToolConfig() const{ return m_toolConfig; }
159 inline bool ToolConfigHasBeenSet() const { return m_toolConfigHasBeenSet; }
160 inline void SetToolConfig(const ToolConfiguration& value) { m_toolConfigHasBeenSet = true; m_toolConfig = value; }
161 inline void SetToolConfig(ToolConfiguration&& value) { m_toolConfigHasBeenSet = true; m_toolConfig = std::move(value); }
162 inline ConverseStreamRequest& WithToolConfig(const ToolConfiguration& value) { SetToolConfig(value); return *this;}
163 inline ConverseStreamRequest& WithToolConfig(ToolConfiguration&& value) { SetToolConfig(std::move(value)); return *this;}
165
167
175 inline const GuardrailStreamConfiguration& GetGuardrailConfig() const{ return m_guardrailConfig; }
176 inline bool GuardrailConfigHasBeenSet() const { return m_guardrailConfigHasBeenSet; }
177 inline void SetGuardrailConfig(const GuardrailStreamConfiguration& value) { m_guardrailConfigHasBeenSet = true; m_guardrailConfig = value; }
178 inline void SetGuardrailConfig(GuardrailStreamConfiguration&& value) { m_guardrailConfigHasBeenSet = true; m_guardrailConfig = std::move(value); }
182
184
192 inline Aws::Utils::DocumentView GetAdditionalModelRequestFields() const{ return m_additionalModelRequestFields; }
193 inline bool AdditionalModelRequestFieldsHasBeenSet() const { return m_additionalModelRequestFieldsHasBeenSet; }
194 inline void SetAdditionalModelRequestFields(const Aws::Utils::Document& value) { m_additionalModelRequestFieldsHasBeenSet = true; m_additionalModelRequestFields = value; }
195 inline void SetAdditionalModelRequestFields(Aws::Utils::Document&& value) { m_additionalModelRequestFieldsHasBeenSet = true; m_additionalModelRequestFields = std::move(value); }
199
201
207 inline const Aws::Map<Aws::String, PromptVariableValues>& GetPromptVariables() const{ return m_promptVariables; }
208 inline bool PromptVariablesHasBeenSet() const { return m_promptVariablesHasBeenSet; }
209 inline void SetPromptVariables(const Aws::Map<Aws::String, PromptVariableValues>& value) { m_promptVariablesHasBeenSet = true; m_promptVariables = value; }
210 inline void SetPromptVariables(Aws::Map<Aws::String, PromptVariableValues>&& value) { m_promptVariablesHasBeenSet = true; m_promptVariables = std::move(value); }
213 inline ConverseStreamRequest& AddPromptVariables(const Aws::String& key, const PromptVariableValues& value) { m_promptVariablesHasBeenSet = true; m_promptVariables.emplace(key, value); return *this; }
214 inline ConverseStreamRequest& AddPromptVariables(Aws::String&& key, const PromptVariableValues& value) { m_promptVariablesHasBeenSet = true; m_promptVariables.emplace(std::move(key), value); return *this; }
215 inline ConverseStreamRequest& AddPromptVariables(const Aws::String& key, PromptVariableValues&& value) { m_promptVariablesHasBeenSet = true; m_promptVariables.emplace(key, std::move(value)); return *this; }
216 inline ConverseStreamRequest& AddPromptVariables(Aws::String&& key, PromptVariableValues&& value) { m_promptVariablesHasBeenSet = true; m_promptVariables.emplace(std::move(key), std::move(value)); return *this; }
217 inline ConverseStreamRequest& AddPromptVariables(const char* key, PromptVariableValues&& value) { m_promptVariablesHasBeenSet = true; m_promptVariables.emplace(key, std::move(value)); return *this; }
218 inline ConverseStreamRequest& AddPromptVariables(const char* key, const PromptVariableValues& value) { m_promptVariablesHasBeenSet = true; m_promptVariables.emplace(key, value); return *this; }
220
222
236 inline const Aws::Vector<Aws::String>& GetAdditionalModelResponseFieldPaths() const{ return m_additionalModelResponseFieldPaths; }
237 inline bool AdditionalModelResponseFieldPathsHasBeenSet() const { return m_additionalModelResponseFieldPathsHasBeenSet; }
238 inline void SetAdditionalModelResponseFieldPaths(const Aws::Vector<Aws::String>& value) { m_additionalModelResponseFieldPathsHasBeenSet = true; m_additionalModelResponseFieldPaths = value; }
239 inline void SetAdditionalModelResponseFieldPaths(Aws::Vector<Aws::String>&& value) { m_additionalModelResponseFieldPathsHasBeenSet = true; m_additionalModelResponseFieldPaths = std::move(value); }
242 inline ConverseStreamRequest& AddAdditionalModelResponseFieldPaths(const Aws::String& value) { m_additionalModelResponseFieldPathsHasBeenSet = true; m_additionalModelResponseFieldPaths.push_back(value); return *this; }
243 inline ConverseStreamRequest& AddAdditionalModelResponseFieldPaths(Aws::String&& value) { m_additionalModelResponseFieldPathsHasBeenSet = true; m_additionalModelResponseFieldPaths.push_back(std::move(value)); return *this; }
244 inline ConverseStreamRequest& AddAdditionalModelResponseFieldPaths(const char* value) { m_additionalModelResponseFieldPathsHasBeenSet = true; m_additionalModelResponseFieldPaths.push_back(value); return *this; }
246
248
251 inline const Aws::Map<Aws::String, Aws::String>& GetRequestMetadata() const{ return m_requestMetadata; }
252 inline bool RequestMetadataHasBeenSet() const { return m_requestMetadataHasBeenSet; }
253 inline void SetRequestMetadata(const Aws::Map<Aws::String, Aws::String>& value) { m_requestMetadataHasBeenSet = true; m_requestMetadata = value; }
254 inline void SetRequestMetadata(Aws::Map<Aws::String, Aws::String>&& value) { m_requestMetadataHasBeenSet = true; m_requestMetadata = std::move(value); }
257 inline ConverseStreamRequest& AddRequestMetadata(const Aws::String& key, const Aws::String& value) { m_requestMetadataHasBeenSet = true; m_requestMetadata.emplace(key, value); return *this; }
258 inline ConverseStreamRequest& AddRequestMetadata(Aws::String&& key, const Aws::String& value) { m_requestMetadataHasBeenSet = true; m_requestMetadata.emplace(std::move(key), value); return *this; }
259 inline ConverseStreamRequest& AddRequestMetadata(const Aws::String& key, Aws::String&& value) { m_requestMetadataHasBeenSet = true; m_requestMetadata.emplace(key, std::move(value)); return *this; }
260 inline ConverseStreamRequest& AddRequestMetadata(Aws::String&& key, Aws::String&& value) { m_requestMetadataHasBeenSet = true; m_requestMetadata.emplace(std::move(key), std::move(value)); return *this; }
261 inline ConverseStreamRequest& AddRequestMetadata(const char* key, Aws::String&& value) { m_requestMetadataHasBeenSet = true; m_requestMetadata.emplace(key, std::move(value)); return *this; }
262 inline ConverseStreamRequest& AddRequestMetadata(Aws::String&& key, const char* value) { m_requestMetadataHasBeenSet = true; m_requestMetadata.emplace(std::move(key), value); return *this; }
263 inline ConverseStreamRequest& AddRequestMetadata(const char* key, const char* value) { m_requestMetadataHasBeenSet = true; m_requestMetadata.emplace(key, value); return *this; }
265
267
270 inline const PerformanceConfiguration& GetPerformanceConfig() const{ return m_performanceConfig; }
271 inline bool PerformanceConfigHasBeenSet() const { return m_performanceConfigHasBeenSet; }
272 inline void SetPerformanceConfig(const PerformanceConfiguration& value) { m_performanceConfigHasBeenSet = true; m_performanceConfig = value; }
273 inline void SetPerformanceConfig(PerformanceConfiguration&& value) { m_performanceConfigHasBeenSet = true; m_performanceConfig = std::move(value); }
277 private:
278
279 Aws::String m_modelId;
280 bool m_modelIdHasBeenSet = false;
281
282 Aws::Vector<Message> m_messages;
283 bool m_messagesHasBeenSet = false;
284
286 bool m_systemHasBeenSet = false;
287
288 InferenceConfiguration m_inferenceConfig;
289 bool m_inferenceConfigHasBeenSet = false;
290
291 ToolConfiguration m_toolConfig;
292 bool m_toolConfigHasBeenSet = false;
293
294 GuardrailStreamConfiguration m_guardrailConfig;
295 bool m_guardrailConfigHasBeenSet = false;
296
297 Aws::Utils::Document m_additionalModelRequestFields;
298 bool m_additionalModelRequestFieldsHasBeenSet = false;
299
301 bool m_promptVariablesHasBeenSet = false;
302
303 Aws::Vector<Aws::String> m_additionalModelResponseFieldPaths;
304 bool m_additionalModelResponseFieldPathsHasBeenSet = false;
305
306 Aws::Map<Aws::String, Aws::String> m_requestMetadata;
307 bool m_requestMetadataHasBeenSet = false;
308
309 PerformanceConfiguration m_performanceConfig;
310 bool m_performanceConfigHasBeenSet = false;
311 ConverseStreamHandler m_handler;
313
314 };
315
316} // namespace Model
317} // namespace BedrockRuntime
318} // namespace Aws
ConverseStreamRequest & WithEventStreamHandler(const ConverseStreamHandler &value)
ConverseStreamRequest & WithAdditionalModelResponseFieldPaths(Aws::Vector< Aws::String > &&value)
ConverseStreamRequest & AddPromptVariables(const char *key, PromptVariableValues &&value)
const Aws::Vector< SystemContentBlock > & GetSystem() const
const Aws::Map< Aws::String, Aws::String > & GetRequestMetadata() const
ConverseStreamRequest & WithPromptVariables(Aws::Map< Aws::String, PromptVariableValues > &&value)
void SetMessages(const Aws::Vector< Message > &value)
void SetRequestMetadata(Aws::Map< Aws::String, Aws::String > &&value)
void SetSystem(Aws::Vector< SystemContentBlock > &&value)
void SetEventStreamHandler(const ConverseStreamHandler &value)
void SetInferenceConfig(InferenceConfiguration &&value)
ConverseStreamRequest & WithRequestMetadata(Aws::Map< Aws::String, Aws::String > &&value)
ConverseStreamRequest & WithAdditionalModelRequestFields(Aws::Utils::Document &&value)
ConverseStreamRequest & AddSystem(const SystemContentBlock &value)
const Aws::Vector< Aws::String > & GetAdditionalModelResponseFieldPaths() const
void SetAdditionalModelResponseFieldPaths(Aws::Vector< Aws::String > &&value)
ConverseStreamRequest & WithPerformanceConfig(const PerformanceConfiguration &value)
ConverseStreamRequest & WithMessages(Aws::Vector< Message > &&value)
ConverseStreamRequest & WithGuardrailConfig(const GuardrailStreamConfiguration &value)
void SetSystem(const Aws::Vector< SystemContentBlock > &value)
ConverseStreamRequest & WithMessages(const Aws::Vector< Message > &value)
Aws::Utils::Event::EventStreamDecoder & GetEventStreamDecoder()
void SetPromptVariables(const Aws::Map< Aws::String, PromptVariableValues > &value)
ConverseStreamRequest & WithAdditionalModelResponseFieldPaths(const Aws::Vector< Aws::String > &value)
ConverseStreamRequest & WithSystem(const Aws::Vector< SystemContentBlock > &value)
ConverseStreamRequest & WithToolConfig(ToolConfiguration &&value)
ConverseStreamRequest & AddAdditionalModelResponseFieldPaths(const char *value)
ConverseStreamRequest & WithAdditionalModelRequestFields(const Aws::Utils::Document &value)
ConverseStreamRequest & WithToolConfig(const ToolConfiguration &value)
ConverseStreamRequest & WithModelId(const Aws::String &value)
void SetPromptVariables(Aws::Map< Aws::String, PromptVariableValues > &&value)
ConverseStreamRequest & AddPromptVariables(const Aws::String &key, PromptVariableValues &&value)
ConverseStreamRequest & WithInferenceConfig(InferenceConfiguration &&value)
const Aws::Map< Aws::String, PromptVariableValues > & GetPromptVariables() const
const ConverseStreamHandler & GetEventStreamHandler() const
ConverseStreamRequest & WithGuardrailConfig(GuardrailStreamConfiguration &&value)
void SetInferenceConfig(const InferenceConfiguration &value)
ConverseStreamRequest & AddPromptVariables(const Aws::String &key, const PromptVariableValues &value)
void SetGuardrailConfig(const GuardrailStreamConfiguration &value)
const PerformanceConfiguration & GetPerformanceConfig() const
ConverseStreamRequest & WithPromptVariables(const Aws::Map< Aws::String, PromptVariableValues > &value)
const GuardrailStreamConfiguration & GetGuardrailConfig() const
void SetAdditionalModelRequestFields(const Aws::Utils::Document &value)
const Aws::Vector< Message > & GetMessages() const
ConverseStreamRequest & WithModelId(Aws::String &&value)
ConverseStreamRequest & AddRequestMetadata(const char *key, const char *value)
ConverseStreamRequest & AddRequestMetadata(Aws::String &&key, Aws::String &&value)
virtual const char * GetServiceRequestName() const override
ConverseStreamRequest & AddAdditionalModelResponseFieldPaths(const Aws::String &value)
void SetAdditionalModelResponseFieldPaths(const Aws::Vector< Aws::String > &value)
const InferenceConfiguration & GetInferenceConfig() const
ConverseStreamRequest & AddMessages(const Message &value)
ConverseStreamRequest & AddAdditionalModelResponseFieldPaths(Aws::String &&value)
ConverseStreamRequest & AddPromptVariables(Aws::String &&key, PromptVariableValues &&value)
void SetToolConfig(const ToolConfiguration &value)
ConverseStreamRequest & WithRequestMetadata(const Aws::Map< Aws::String, Aws::String > &value)
ConverseStreamRequest & AddMessages(Message &&value)
ConverseStreamRequest & AddRequestMetadata(const char *key, Aws::String &&value)
ConverseStreamRequest & AddRequestMetadata(Aws::String &&key, const Aws::String &value)
ConverseStreamRequest & WithSystem(Aws::Vector< SystemContentBlock > &&value)
ConverseStreamRequest & WithInferenceConfig(const InferenceConfiguration &value)
AWS_BEDROCKRUNTIME_API Aws::String SerializePayload() const override
ConverseStreamRequest & AddPromptVariables(Aws::String &&key, const PromptVariableValues &value)
ConverseStreamRequest & AddRequestMetadata(const Aws::String &key, Aws::String &&value)
void SetRequestMetadata(const Aws::Map< Aws::String, Aws::String > &value)
ConverseStreamRequest & WithModelId(const char *value)
void SetPerformanceConfig(const PerformanceConfiguration &value)
void SetPerformanceConfig(PerformanceConfiguration &&value)
ConverseStreamRequest & AddPromptVariables(const char *key, const PromptVariableValues &value)
ConverseStreamRequest & AddRequestMetadata(const Aws::String &key, const Aws::String &value)
void SetAdditionalModelRequestFields(Aws::Utils::Document &&value)
ConverseStreamRequest & AddSystem(SystemContentBlock &&value)
void SetGuardrailConfig(GuardrailStreamConfiguration &&value)
Aws::Utils::DocumentView GetAdditionalModelRequestFields() const
ConverseStreamRequest & WithPerformanceConfig(PerformanceConfiguration &&value)
ConverseStreamRequest & AddRequestMetadata(Aws::String &&key, const char *value)
void ResetEventStreamHandler(EventStreamHandler *handler)
std::map< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > > Map
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector