aws_sdk_bedrockagentruntime/operation/retrieve_and_generate/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::retrieve_and_generate::_retrieve_and_generate_output::RetrieveAndGenerateOutputBuilder;
3
4pub use crate::operation::retrieve_and_generate::_retrieve_and_generate_input::RetrieveAndGenerateInputBuilder;
5
6impl crate::operation::retrieve_and_generate::builders::RetrieveAndGenerateInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::retrieve_and_generate::RetrieveAndGenerateOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::retrieve_and_generate::RetrieveAndGenerateError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.retrieve_and_generate();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `RetrieveAndGenerate`.
24///
25/// <p>Queries a knowledge base and generates responses based on the retrieved results and using the specified foundation model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a>. The response only cites sources that are relevant to the query.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct RetrieveAndGenerateFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::retrieve_and_generate::builders::RetrieveAndGenerateInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::retrieve_and_generate::RetrieveAndGenerateOutput,
35        crate::operation::retrieve_and_generate::RetrieveAndGenerateError,
36    > for RetrieveAndGenerateFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::retrieve_and_generate::RetrieveAndGenerateOutput,
44            crate::operation::retrieve_and_generate::RetrieveAndGenerateError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl RetrieveAndGenerateFluentBuilder {
51    /// Creates a new `RetrieveAndGenerateFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the RetrieveAndGenerate as a reference.
60    pub fn as_input(&self) -> &crate::operation::retrieve_and_generate::builders::RetrieveAndGenerateInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::retrieve_and_generate::RetrieveAndGenerateOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::retrieve_and_generate::RetrieveAndGenerateError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::retrieve_and_generate::RetrieveAndGenerate::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::retrieve_and_generate::RetrieveAndGenerate::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::retrieve_and_generate::RetrieveAndGenerateOutput,
97        crate::operation::retrieve_and_generate::RetrieveAndGenerateError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <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>
112    pub fn session_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.session_id(input.into());
114        self
115    }
116    /// <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>
117    pub fn set_session_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_session_id(input);
119        self
120    }
121    /// <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>
122    pub fn get_session_id(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_session_id()
124    }
125    /// <p>Contains the query to be made to the knowledge base.</p>
126    pub fn input(mut self, input: crate::types::RetrieveAndGenerateInput) -> Self {
127        self.inner = self.inner.input(input);
128        self
129    }
130    /// <p>Contains the query to be made to the knowledge base.</p>
131    pub fn set_input(mut self, input: ::std::option::Option<crate::types::RetrieveAndGenerateInput>) -> Self {
132        self.inner = self.inner.set_input(input);
133        self
134    }
135    /// <p>Contains the query to be made to the knowledge base.</p>
136    pub fn get_input(&self) -> &::std::option::Option<crate::types::RetrieveAndGenerateInput> {
137        self.inner.get_input()
138    }
139    /// <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>
140    pub fn retrieve_and_generate_configuration(mut self, input: crate::types::RetrieveAndGenerateConfiguration) -> Self {
141        self.inner = self.inner.retrieve_and_generate_configuration(input);
142        self
143    }
144    /// <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>
145    pub fn set_retrieve_and_generate_configuration(mut self, input: ::std::option::Option<crate::types::RetrieveAndGenerateConfiguration>) -> Self {
146        self.inner = self.inner.set_retrieve_and_generate_configuration(input);
147        self
148    }
149    /// <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>
150    pub fn get_retrieve_and_generate_configuration(&self) -> &::std::option::Option<crate::types::RetrieveAndGenerateConfiguration> {
151        self.inner.get_retrieve_and_generate_configuration()
152    }
153    /// <p>Contains details about the session with the knowledge base.</p>
154    pub fn session_configuration(mut self, input: crate::types::RetrieveAndGenerateSessionConfiguration) -> Self {
155        self.inner = self.inner.session_configuration(input);
156        self
157    }
158    /// <p>Contains details about the session with the knowledge base.</p>
159    pub fn set_session_configuration(mut self, input: ::std::option::Option<crate::types::RetrieveAndGenerateSessionConfiguration>) -> Self {
160        self.inner = self.inner.set_session_configuration(input);
161        self
162    }
163    /// <p>Contains details about the session with the knowledge base.</p>
164    pub fn get_session_configuration(&self) -> &::std::option::Option<crate::types::RetrieveAndGenerateSessionConfiguration> {
165        self.inner.get_session_configuration()
166    }
167}
aws_sdk_bedrockagentruntime/operation/retrieve_and_generate/builders.rs

aws_sdk_bedrockagentruntime/operation/retrieve_and_generate/
builders.rs
