aws_sdk_bedrockagentruntime/operation/rerank/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::rerank::_rerank_output::RerankOutputBuilder;
3
4pub use crate::operation::rerank::_rerank_input::RerankInputBuilder;
5
6impl crate::operation::rerank::builders::RerankInputBuilder {
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::rerank::RerankOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::rerank::RerankError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.rerank();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `Rerank`.
24///
25/// <p>Reranks the relevance of sources based on queries. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/rerank.html">Improve the relevance of query responses with a reranker model</a>.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct RerankFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::rerank::builders::RerankInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl crate::client::customize::internal::CustomizableSend<crate::operation::rerank::RerankOutput, crate::operation::rerank::RerankError>
33    for RerankFluentBuilder
34{
35    fn send(
36        self,
37        config_override: crate::config::Builder,
38    ) -> crate::client::customize::internal::BoxFuture<
39        crate::client::customize::internal::SendResult<crate::operation::rerank::RerankOutput, crate::operation::rerank::RerankError>,
40    > {
41        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
42    }
43}
44impl RerankFluentBuilder {
45    /// Creates a new `RerankFluentBuilder`.
46    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
47        Self {
48            handle,
49            inner: ::std::default::Default::default(),
50            config_override: ::std::option::Option::None,
51        }
52    }
53    /// Access the Rerank as a reference.
54    pub fn as_input(&self) -> &crate::operation::rerank::builders::RerankInputBuilder {
55        &self.inner
56    }
57    /// Sends the request and returns the response.
58    ///
59    /// If an error occurs, an `SdkError` will be returned with additional details that
60    /// can be matched against.
61    ///
62    /// By default, any retryable failures will be retried twice. Retry behavior
63    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
64    /// set when configuring the client.
65    pub async fn send(
66        self,
67    ) -> ::std::result::Result<
68        crate::operation::rerank::RerankOutput,
69        ::aws_smithy_runtime_api::client::result::SdkError<
70            crate::operation::rerank::RerankError,
71            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
72        >,
73    > {
74        let input = self
75            .inner
76            .build()
77            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
78        let runtime_plugins =
79            crate::operation::rerank::Rerank::operation_runtime_plugins(self.handle.runtime_plugins.clone(), &self.handle.conf, self.config_override);
80        crate::operation::rerank::Rerank::orchestrate(&runtime_plugins, input).await
81    }
82
83    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
84    pub fn customize(
85        self,
86    ) -> crate::client::customize::CustomizableOperation<crate::operation::rerank::RerankOutput, crate::operation::rerank::RerankError, Self> {
87        crate::client::customize::CustomizableOperation::new(self)
88    }
89    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
90        self.set_config_override(::std::option::Option::Some(config_override.into()));
91        self
92    }
93
94    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
95        self.config_override = config_override;
96        self
97    }
98    /// Create a paginator for this request
99    ///
100    /// Paginators are used by calling [`send().await`](crate::operation::rerank::paginator::RerankPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
101    pub fn into_paginator(self) -> crate::operation::rerank::paginator::RerankPaginator {
102        crate::operation::rerank::paginator::RerankPaginator::new(self.handle, self.inner)
103    }
104    ///
105    /// Appends an item to `queries`.
106    ///
107    /// To override the contents of this collection use [`set_queries`](Self::set_queries).
108    ///
109    /// <p>An array of objects, each of which contains information about a query to submit to the reranker model.</p>
110    pub fn queries(mut self, input: crate::types::RerankQuery) -> Self {
111        self.inner = self.inner.queries(input);
112        self
113    }
114    /// <p>An array of objects, each of which contains information about a query to submit to the reranker model.</p>
115    pub fn set_queries(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::RerankQuery>>) -> Self {
116        self.inner = self.inner.set_queries(input);
117        self
118    }
119    /// <p>An array of objects, each of which contains information about a query to submit to the reranker model.</p>
120    pub fn get_queries(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::RerankQuery>> {
121        self.inner.get_queries()
122    }
123    ///
124    /// Appends an item to `sources`.
125    ///
126    /// To override the contents of this collection use [`set_sources`](Self::set_sources).
127    ///
128    /// <p>An array of objects, each of which contains information about the sources to rerank.</p>
129    pub fn sources(mut self, input: crate::types::RerankSource) -> Self {
130        self.inner = self.inner.sources(input);
131        self
132    }
133    /// <p>An array of objects, each of which contains information about the sources to rerank.</p>
134    pub fn set_sources(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::RerankSource>>) -> Self {
135        self.inner = self.inner.set_sources(input);
136        self
137    }
138    /// <p>An array of objects, each of which contains information about the sources to rerank.</p>
139    pub fn get_sources(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::RerankSource>> {
140        self.inner.get_sources()
141    }
142    /// <p>Contains configurations for reranking.</p>
143    pub fn reranking_configuration(mut self, input: crate::types::RerankingConfiguration) -> Self {
144        self.inner = self.inner.reranking_configuration(input);
145        self
146    }
147    /// <p>Contains configurations for reranking.</p>
148    pub fn set_reranking_configuration(mut self, input: ::std::option::Option<crate::types::RerankingConfiguration>) -> Self {
149        self.inner = self.inner.set_reranking_configuration(input);
150        self
151    }
152    /// <p>Contains configurations for reranking.</p>
153    pub fn get_reranking_configuration(&self) -> &::std::option::Option<crate::types::RerankingConfiguration> {
154        self.inner.get_reranking_configuration()
155    }
156    /// <p>If the total number of results was greater than could fit in a response, a token is returned in the <code>nextToken</code> field. You can enter that token in this field to return the next batch of results.</p>
157    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
158        self.inner = self.inner.next_token(input.into());
159        self
160    }
161    /// <p>If the total number of results was greater than could fit in a response, a token is returned in the <code>nextToken</code> field. You can enter that token in this field to return the next batch of results.</p>
162    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
163        self.inner = self.inner.set_next_token(input);
164        self
165    }
166    /// <p>If the total number of results was greater than could fit in a response, a token is returned in the <code>nextToken</code> field. You can enter that token in this field to return the next batch of results.</p>
167    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
168        self.inner.get_next_token()
169    }
170}
aws_sdk_bedrockagentruntime/operation/rerank/builders.rs

aws_sdk_bedrockagentruntime/operation/rerank/
builders.rs
