aws_sdk_qbusiness/client/
search_relevant_content.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 [`SearchRelevantContent`](crate::operation::search_relevant_content::builders::SearchRelevantContentFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::search_relevant_content::builders::SearchRelevantContentFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`application_id(impl Into<String>)`](crate::operation::search_relevant_content::builders::SearchRelevantContentFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::search_relevant_content::builders::SearchRelevantContentFluentBuilder::set_application_id):<br>required: **true**<br><p>The unique identifier of the Amazon Q Business application to search.</p><br>
8    ///   - [`query_text(impl Into<String>)`](crate::operation::search_relevant_content::builders::SearchRelevantContentFluentBuilder::query_text) / [`set_query_text(Option<String>)`](crate::operation::search_relevant_content::builders::SearchRelevantContentFluentBuilder::set_query_text):<br>required: **true**<br><p>The text to search for.</p><br>
9    ///   - [`content_source(ContentSource)`](crate::operation::search_relevant_content::builders::SearchRelevantContentFluentBuilder::content_source) / [`set_content_source(Option<ContentSource>)`](crate::operation::search_relevant_content::builders::SearchRelevantContentFluentBuilder::set_content_source):<br>required: **true**<br><p>The source of content to search in.</p><br>
10    ///   - [`attribute_filter(AttributeFilter)`](crate::operation::search_relevant_content::builders::SearchRelevantContentFluentBuilder::attribute_filter) / [`set_attribute_filter(Option<AttributeFilter>)`](crate::operation::search_relevant_content::builders::SearchRelevantContentFluentBuilder::set_attribute_filter):<br>required: **false**<br><p>Enables filtering of responses based on document attributes or metadata fields.</p><br>
11    ///   - [`max_results(i32)`](crate::operation::search_relevant_content::builders::SearchRelevantContentFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_relevant_content::builders::SearchRelevantContentFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return.</p><br>
12    ///   - [`next_token(impl Into<String>)`](crate::operation::search_relevant_content::builders::SearchRelevantContentFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search_relevant_content::builders::SearchRelevantContentFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of results. (You received this token from a previous call.)</p><br>
13    /// - On success, responds with [`SearchRelevantContentOutput`](crate::operation::search_relevant_content::SearchRelevantContentOutput) with field(s):
14    ///   - [`relevant_content(Option<Vec::<RelevantContent>>)`](crate::operation::search_relevant_content::SearchRelevantContentOutput::relevant_content): <p>The list of relevant content items found.</p>
15    ///   - [`next_token(Option<String>)`](crate::operation::search_relevant_content::SearchRelevantContentOutput::next_token): <p>The token to use to retrieve the next set of results, if there are any.</p>
16    /// - On failure, responds with [`SdkError<SearchRelevantContentError>`](crate::operation::search_relevant_content::SearchRelevantContentError)
17    pub fn search_relevant_content(&self) -> crate::operation::search_relevant_content::builders::SearchRelevantContentFluentBuilder {
18        crate::operation::search_relevant_content::builders::SearchRelevantContentFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_qbusiness/client/search_relevant_content.rs

aws_sdk_qbusiness/client/
search_relevant_content.rs
