1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::retrieve_and_generate_stream::_retrieve_and_generate_stream_input::RetrieveAndGenerateStreamInputBuilder;
pub use crate::operation::retrieve_and_generate_stream::_retrieve_and_generate_stream_output::RetrieveAndGenerateStreamOutputBuilder;
impl crate::operation::retrieve_and_generate_stream::builders::RetrieveAndGenerateStreamInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::retrieve_and_generate_stream::RetrieveAndGenerateStreamOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::retrieve_and_generate_stream::RetrieveAndGenerateStreamError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.retrieve_and_generate_stream();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `RetrieveAndGenerateStream`.
///
/// <p>Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format.</p><note>
/// <p>This API cannot be used with managed knowledge bases. Use <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_AgenticRetrieveStream.html">AgenticRetrieveStream</a> or <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html">Retrieve</a> with managed knowledge bases.</p>
/// </note> <note>
/// <p>The CLI doesn't support streaming operations in Amazon Bedrock, including <code>InvokeModelWithResponseStream</code>.</p>
/// </note>
/// <p>This operation requires permission for the <code> bedrock:RetrieveAndGenerate</code> action.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct RetrieveAndGenerateStreamFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::retrieve_and_generate_stream::builders::RetrieveAndGenerateStreamInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::retrieve_and_generate_stream::RetrieveAndGenerateStreamOutput,
crate::operation::retrieve_and_generate_stream::RetrieveAndGenerateStreamError,
> for RetrieveAndGenerateStreamFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::retrieve_and_generate_stream::RetrieveAndGenerateStreamOutput,
crate::operation::retrieve_and_generate_stream::RetrieveAndGenerateStreamError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl RetrieveAndGenerateStreamFluentBuilder {
/// Creates a new `RetrieveAndGenerateStreamFluentBuilder`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the RetrieveAndGenerateStream as a reference.
pub fn as_input(&self) -> &crate::operation::retrieve_and_generate_stream::builders::RetrieveAndGenerateStreamInputBuilder {
&self.inner
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::retrieve_and_generate_stream::RetrieveAndGenerateStreamOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::retrieve_and_generate_stream::RetrieveAndGenerateStreamError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::retrieve_and_generate_stream::RetrieveAndGenerateStream::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
let mut output = crate::operation::retrieve_and_generate_stream::RetrieveAndGenerateStream::orchestrate(&runtime_plugins, input).await?;
// Converts any error encountered beyond this point into an `SdkError` response error
// with an `HttpResponse`. However, since we have already exited the `orchestrate`
// function, the original `HttpResponse` is no longer available and cannot be restored.
// This means that header information from the original response has been lost.
//
// Note that the response body would have been consumed by the deserializer
// regardless, even if the initial message was hypothetically processed during
// the orchestrator's deserialization phase but later resulted in an error.
fn response_error(
err: impl ::std::convert::Into<::aws_smithy_runtime_api::box_error::BoxError>,
) -> ::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::retrieve_and_generate_stream::RetrieveAndGenerateStreamError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
> {
::aws_smithy_runtime_api::client::result::SdkError::response_error(
err,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse::new(
::aws_smithy_runtime_api::http::StatusCode::try_from(200).expect("valid successful code"),
::aws_smithy_types::body::SdkBody::empty(),
),
)
}
let message = output.stream.try_recv_initial_response().await.map_err(response_error)?;
match message {
::std::option::Option::Some(_message) => ::std::result::Result::Ok(output),
::std::option::Option::None => ::std::result::Result::Ok(output),
}
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::retrieve_and_generate_stream::RetrieveAndGenerateStreamOutput,
crate::operation::retrieve_and_generate_stream::RetrieveAndGenerateStreamError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>The unique identifier of the session. When you first make a <code>RetrieveAndGenerate</code> request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the <code>sessionId</code> yourself.</p>
pub fn session_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.session_id(input.into());
self
}
/// <p>The unique identifier of the session. When you first make a <code>RetrieveAndGenerate</code> request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the <code>sessionId</code> yourself.</p>
pub fn set_session_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_session_id(input);
self
}
/// <p>The unique identifier of the session. When you first make a <code>RetrieveAndGenerate</code> request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the <code>sessionId</code> yourself.</p>
pub fn get_session_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_session_id()
}
/// <p>Contains the query to be made to the knowledge base.</p>
pub fn input(mut self, input: crate::types::RetrieveAndGenerateInput) -> Self {
self.inner = self.inner.input(input);
self
}
/// <p>Contains the query to be made to the knowledge base.</p>
pub fn set_input(mut self, input: ::std::option::Option<crate::types::RetrieveAndGenerateInput>) -> Self {
self.inner = self.inner.set_input(input);
self
}
/// <p>Contains the query to be made to the knowledge base.</p>
pub fn get_input(&self) -> &::std::option::Option<crate::types::RetrieveAndGenerateInput> {
self.inner.get_input()
}
/// <p>Contains configurations for the knowledge base query and retrieval process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
pub fn retrieve_and_generate_configuration(mut self, input: crate::types::RetrieveAndGenerateConfiguration) -> Self {
self.inner = self.inner.retrieve_and_generate_configuration(input);
self
}
/// <p>Contains configurations for the knowledge base query and retrieval process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
pub fn set_retrieve_and_generate_configuration(mut self, input: ::std::option::Option<crate::types::RetrieveAndGenerateConfiguration>) -> Self {
self.inner = self.inner.set_retrieve_and_generate_configuration(input);
self
}
/// <p>Contains configurations for the knowledge base query and retrieval process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
pub fn get_retrieve_and_generate_configuration(&self) -> &::std::option::Option<crate::types::RetrieveAndGenerateConfiguration> {
self.inner.get_retrieve_and_generate_configuration()
}
/// <p>Contains details about the session with the knowledge base.</p>
pub fn session_configuration(mut self, input: crate::types::RetrieveAndGenerateSessionConfiguration) -> Self {
self.inner = self.inner.session_configuration(input);
self
}
/// <p>Contains details about the session with the knowledge base.</p>
pub fn set_session_configuration(mut self, input: ::std::option::Option<crate::types::RetrieveAndGenerateSessionConfiguration>) -> Self {
self.inner = self.inner.set_session_configuration(input);
self
}
/// <p>Contains details about the session with the knowledge base.</p>
pub fn get_session_configuration(&self) -> &::std::option::Option<crate::types::RetrieveAndGenerateSessionConfiguration> {
self.inner.get_session_configuration()
}
/// <p>Contains information about the user making the request. Use this to pass user identity information for access control filtering, so that retrieval results only include documents the user is authorized to access.</p>
pub fn user_context(mut self, input: crate::types::UserContext) -> Self {
self.inner = self.inner.user_context(input);
self
}
/// <p>Contains information about the user making the request. Use this to pass user identity information for access control filtering, so that retrieval results only include documents the user is authorized to access.</p>
pub fn set_user_context(mut self, input: ::std::option::Option<crate::types::UserContext>) -> Self {
self.inner = self.inner.set_user_context(input);
self
}
/// <p>Contains information about the user making the request. Use this to pass user identity information for access control filtering, so that retrieval results only include documents the user is authorized to access.</p>
pub fn get_user_context(&self) -> &::std::option::Option<crate::types::UserContext> {
self.inner.get_user_context()
}
}