Skip to main content

aws_sdk_bedrockagentruntime/client/
agentic_retrieve_stream.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 [`AgenticRetrieveStream`](crate::operation::agentic_retrieve_stream::builders::AgenticRetrieveStreamFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`messages(AgenticRetrieveMessage)`](crate::operation::agentic_retrieve_stream::builders::AgenticRetrieveStreamFluentBuilder::messages) / [`set_messages(Option<Vec::<AgenticRetrieveMessage>>)`](crate::operation::agentic_retrieve_stream::builders::AgenticRetrieveStreamFluentBuilder::set_messages):<br>required: **true**<br><p>The list of messages for the agentic retrieval conversation.</p><br>
7    ///   - [`retrievers(AgenticRetriever)`](crate::operation::agentic_retrieve_stream::builders::AgenticRetrieveStreamFluentBuilder::retrievers) / [`set_retrievers(Option<Vec::<AgenticRetriever>>)`](crate::operation::agentic_retrieve_stream::builders::AgenticRetrieveStreamFluentBuilder::set_retrievers):<br>required: **true**<br><p>The list of retrievers to use for agentic retrieval.</p><br>
8    ///   - [`agentic_retrieve_configuration(AgenticRetrieveConfiguration)`](crate::operation::agentic_retrieve_stream::builders::AgenticRetrieveStreamFluentBuilder::agentic_retrieve_configuration) / [`set_agentic_retrieve_configuration(Option<AgenticRetrieveConfiguration>)`](crate::operation::agentic_retrieve_stream::builders::AgenticRetrieveStreamFluentBuilder::set_agentic_retrieve_configuration):<br>required: **true**<br><p>Configuration settings for the agentic retrieval operation.</p><br>
9    ///   - [`policy_configuration(AgenticRetrievePolicyConfiguration)`](crate::operation::agentic_retrieve_stream::builders::AgenticRetrieveStreamFluentBuilder::policy_configuration) / [`set_policy_configuration(Option<AgenticRetrievePolicyConfiguration>)`](crate::operation::agentic_retrieve_stream::builders::AgenticRetrieveStreamFluentBuilder::set_policy_configuration):<br>required: **false**<br><p>Policy configuration for guardrails and content filtering.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::agentic_retrieve_stream::builders::AgenticRetrieveStreamFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::agentic_retrieve_stream::builders::AgenticRetrieveStreamFluentBuilder::set_next_token):<br>required: **false**<br><p>Opaque continuation token for paginated results.</p><br>
11    ///   - [`user_context(UserContext)`](crate::operation::agentic_retrieve_stream::builders::AgenticRetrieveStreamFluentBuilder::user_context) / [`set_user_context(Option<UserContext>)`](crate::operation::agentic_retrieve_stream::builders::AgenticRetrieveStreamFluentBuilder::set_user_context):<br>required: **false**<br><p>Contains information about the user making the request. This is used for access control filtering to ensure that retrieval results only include documents the user is authorized to access.</p><br>
12    ///   - [`generate_response(bool)`](crate::operation::agentic_retrieve_stream::builders::AgenticRetrieveStreamFluentBuilder::generate_response) / [`set_generate_response(Option<bool>)`](crate::operation::agentic_retrieve_stream::builders::AgenticRetrieveStreamFluentBuilder::set_generate_response):<br>required: **false**<br><p>Whether to generate a response based on the retrieved results.</p><br>
13    /// - On success, responds with [`AgenticRetrieveStreamOutput`](crate::operation::agentic_retrieve_stream::AgenticRetrieveStreamOutput) with field(s):
14    ///   - [`stream(EventReceiver<AgenticRetrieveStreamResponseOutput, AgenticRetrieveStreamResponseOutputError>)`](crate::operation::agentic_retrieve_stream::AgenticRetrieveStreamOutput::stream): <p>The output stream containing retrieval results and trace events.</p>
15    /// - On failure, responds with [`SdkError<AgenticRetrieveStreamError>`](crate::operation::agentic_retrieve_stream::AgenticRetrieveStreamError)
16    pub fn agentic_retrieve_stream(&self) -> crate::operation::agentic_retrieve_stream::builders::AgenticRetrieveStreamFluentBuilder {
17        crate::operation::agentic_retrieve_stream::builders::AgenticRetrieveStreamFluentBuilder::new(self.handle.clone())
18    }
19}