aws_sdk_bedrockagentruntime/operation/rerank/
_rerank_output.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct RerankOutput {
6    /// <p>An array of objects, each of which contains information about the results of reranking.</p>
7    pub results: ::std::vec::Vec<crate::types::RerankResult>,
8    /// <p>If the total number of results is greater than can fit in the response, use this token in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
9    pub next_token: ::std::option::Option<::std::string::String>,
10    _request_id: Option<String>,
11}
12impl RerankOutput {
13    /// <p>An array of objects, each of which contains information about the results of reranking.</p>
14    pub fn results(&self) -> &[crate::types::RerankResult] {
15        use std::ops::Deref;
16        self.results.deref()
17    }
18    /// <p>If the total number of results is greater than can fit in the response, use this token in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
19    pub fn next_token(&self) -> ::std::option::Option<&str> {
20        self.next_token.as_deref()
21    }
22}
23impl ::aws_types::request_id::RequestId for RerankOutput {
24    fn request_id(&self) -> Option<&str> {
25        self._request_id.as_deref()
26    }
27}
28impl RerankOutput {
29    /// Creates a new builder-style object to manufacture [`RerankOutput`](crate::operation::rerank::RerankOutput).
30    pub fn builder() -> crate::operation::rerank::builders::RerankOutputBuilder {
31        crate::operation::rerank::builders::RerankOutputBuilder::default()
32    }
33}
34
35/// A builder for [`RerankOutput`](crate::operation::rerank::RerankOutput).
36#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
37#[non_exhaustive]
38pub struct RerankOutputBuilder {
39    pub(crate) results: ::std::option::Option<::std::vec::Vec<crate::types::RerankResult>>,
40    pub(crate) next_token: ::std::option::Option<::std::string::String>,
41    _request_id: Option<String>,
42}
43impl RerankOutputBuilder {
44    /// Appends an item to `results`.
45    ///
46    /// To override the contents of this collection use [`set_results`](Self::set_results).
47    ///
48    /// <p>An array of objects, each of which contains information about the results of reranking.</p>
49    pub fn results(mut self, input: crate::types::RerankResult) -> Self {
50        let mut v = self.results.unwrap_or_default();
51        v.push(input);
52        self.results = ::std::option::Option::Some(v);
53        self
54    }
55    /// <p>An array of objects, each of which contains information about the results of reranking.</p>
56    pub fn set_results(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::RerankResult>>) -> Self {
57        self.results = input;
58        self
59    }
60    /// <p>An array of objects, each of which contains information about the results of reranking.</p>
61    pub fn get_results(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::RerankResult>> {
62        &self.results
63    }
64    /// <p>If the total number of results is greater than can fit in the response, use this token in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
65    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
66        self.next_token = ::std::option::Option::Some(input.into());
67        self
68    }
69    /// <p>If the total number of results is greater than can fit in the response, use this token in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
70    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
71        self.next_token = input;
72        self
73    }
74    /// <p>If the total number of results is greater than can fit in the response, use this token in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
75    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
76        &self.next_token
77    }
78    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
79        self._request_id = Some(request_id.into());
80        self
81    }
82
83    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
84        self._request_id = request_id;
85        self
86    }
87    /// Consumes the builder and constructs a [`RerankOutput`](crate::operation::rerank::RerankOutput).
88    /// This method will fail if any of the following fields are not set:
89    /// - [`results`](crate::operation::rerank::builders::RerankOutputBuilder::results)
90    pub fn build(self) -> ::std::result::Result<crate::operation::rerank::RerankOutput, ::aws_smithy_types::error::operation::BuildError> {
91        ::std::result::Result::Ok(crate::operation::rerank::RerankOutput {
92            results: self.results.ok_or_else(|| {
93                ::aws_smithy_types::error::operation::BuildError::missing_field(
94                    "results",
95                    "results was not specified but it is required when building RerankOutput",
96                )
97            })?,
98            next_token: self.next_token,
99            _request_id: self._request_id,
100        })
101    }
102}
aws_sdk_bedrockagentruntime/operation/rerank/_rerank_output.rs

aws_sdk_bedrockagentruntime/operation/rerank/
_rerank_output.rs
