aws_sdk_bedrockagentruntime/client/
retrieve.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`Retrieve`](crate::operation::retrieve::builders::RetrieveFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::retrieve::builders::RetrieveFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`knowledge_base_id(impl Into<String>)`](crate::operation::retrieve::builders::RetrieveFluentBuilder::knowledge_base_id) / [`set_knowledge_base_id(Option<String>)`](crate::operation::retrieve::builders::RetrieveFluentBuilder::set_knowledge_base_id):<br>required: **true**<br><p>The unique identifier of the knowledge base to query.</p><br>
8    ///   - [`retrieval_query(KnowledgeBaseQuery)`](crate::operation::retrieve::builders::RetrieveFluentBuilder::retrieval_query) / [`set_retrieval_query(Option<KnowledgeBaseQuery>)`](crate::operation::retrieve::builders::RetrieveFluentBuilder::set_retrieval_query):<br>required: **true**<br><p>Contains the query to send the knowledge base.</p><br>
9    ///   - [`retrieval_configuration(KnowledgeBaseRetrievalConfiguration)`](crate::operation::retrieve::builders::RetrieveFluentBuilder::retrieval_configuration) / [`set_retrieval_configuration(Option<KnowledgeBaseRetrievalConfiguration>)`](crate::operation::retrieve::builders::RetrieveFluentBuilder::set_retrieval_configuration):<br>required: **false**<br><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><br>
10    ///   - [`guardrail_configuration(GuardrailConfiguration)`](crate::operation::retrieve::builders::RetrieveFluentBuilder::guardrail_configuration) / [`set_guardrail_configuration(Option<GuardrailConfiguration>)`](crate::operation::retrieve::builders::RetrieveFluentBuilder::set_guardrail_configuration):<br>required: **false**<br><p>Guardrail settings.</p><br>
11    ///   - [`next_token(impl Into<String>)`](crate::operation::retrieve::builders::RetrieveFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::retrieve::builders::RetrieveFluentBuilder::set_next_token):<br>required: **false**<br><p>If there are more results than can fit in the response, the response returns a <code>nextToken</code>. Use this token in the <code>nextToken</code> field of another request to retrieve the next batch of results.</p><br>
12    /// - On success, responds with [`RetrieveOutput`](crate::operation::retrieve::RetrieveOutput) with field(s):
13    ///   - [`retrieval_results(Vec::<KnowledgeBaseRetrievalResult>)`](crate::operation::retrieve::RetrieveOutput::retrieval_results): <p>A list of results from querying the knowledge base.</p>
14    ///   - [`guardrail_action(Option<GuadrailAction>)`](crate::operation::retrieve::RetrieveOutput::guardrail_action): <p>Specifies if there is a guardrail intervention in the response.</p>
15    ///   - [`next_token(Option<String>)`](crate::operation::retrieve::RetrieveOutput::next_token): <p>If there are more results than can fit in the response, the response returns a <code>nextToken</code>. Use this token in the <code>nextToken</code> field of another request to retrieve the next batch of results.</p>
16    /// - On failure, responds with [`SdkError<RetrieveError>`](crate::operation::retrieve::RetrieveError)
17    pub fn retrieve(&self) -> crate::operation::retrieve::builders::RetrieveFluentBuilder {
18        crate::operation::retrieve::builders::RetrieveFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_bedrockagentruntime/client/retrieve.rs

aws_sdk_bedrockagentruntime/client/
retrieve.rs
