aws_sdk_qconnect/client/
query_assistant.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 [`QueryAssistant`](crate::operation::query_assistant::builders::QueryAssistantFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::query_assistant::builders::QueryAssistantFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`assistant_id(impl Into<String>)`](crate::operation::query_assistant::builders::QueryAssistantFluentBuilder::assistant_id) / [`set_assistant_id(Option<String>)`](crate::operation::query_assistant::builders::QueryAssistantFluentBuilder::set_assistant_id):<br>required: **true**<br><p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p><br>
8    ///   - [`query_text(impl Into<String>)`](crate::operation::query_assistant::builders::QueryAssistantFluentBuilder::query_text) / [`set_query_text(Option<String>)`](crate::operation::query_assistant::builders::QueryAssistantFluentBuilder::set_query_text):<br>required: **false**<br><p>The text to search for.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::query_assistant::builders::QueryAssistantFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::query_assistant::builders::QueryAssistantFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::query_assistant::builders::QueryAssistantFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::query_assistant::builders::QueryAssistantFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per page.</p><br>
11    ///   - [`session_id(impl Into<String>)`](crate::operation::query_assistant::builders::QueryAssistantFluentBuilder::session_id) / [`set_session_id(Option<String>)`](crate::operation::query_assistant::builders::QueryAssistantFluentBuilder::set_session_id):<br>required: **false**<br><p>The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p><br>
12    ///   - [`query_condition(QueryCondition)`](crate::operation::query_assistant::builders::QueryAssistantFluentBuilder::query_condition) / [`set_query_condition(Option<Vec::<QueryCondition>>)`](crate::operation::query_assistant::builders::QueryAssistantFluentBuilder::set_query_condition):<br>required: **false**<br><p>Information about how to query content.</p><br>
13    ///   - [`query_input_data(QueryInputData)`](crate::operation::query_assistant::builders::QueryAssistantFluentBuilder::query_input_data) / [`set_query_input_data(Option<QueryInputData>)`](crate::operation::query_assistant::builders::QueryAssistantFluentBuilder::set_query_input_data):<br>required: **false**<br><p>Information about the query.</p><br>
14    ///   - [`override_knowledge_base_search_type(KnowledgeBaseSearchType)`](crate::operation::query_assistant::builders::QueryAssistantFluentBuilder::override_knowledge_base_search_type) / [`set_override_knowledge_base_search_type(Option<KnowledgeBaseSearchType>)`](crate::operation::query_assistant::builders::QueryAssistantFluentBuilder::set_override_knowledge_base_search_type):<br>required: **false**<br><p>The search type to be used against the Knowledge Base for this request. The values can be <code>SEMANTIC</code> which uses vector embeddings or <code>HYBRID</code> which use vector embeddings and raw text.</p><br>
15    /// - On success, responds with [`QueryAssistantOutput`](crate::operation::query_assistant::QueryAssistantOutput) with field(s):
16    ///   - [`results(Vec::<ResultData>)`](crate::operation::query_assistant::QueryAssistantOutput::results): <p>The results of the query.</p>
17    ///   - [`next_token(Option<String>)`](crate::operation::query_assistant::QueryAssistantOutput::next_token): <p>If there are additional results, this is the token for the next set of results.</p>
18    /// - On failure, responds with [`SdkError<QueryAssistantError>`](crate::operation::query_assistant::QueryAssistantError)
19    #[deprecated(
20        note = "QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications."
21    )]
22    pub fn query_assistant(&self) -> crate::operation::query_assistant::builders::QueryAssistantFluentBuilder {
23        crate::operation::query_assistant::builders::QueryAssistantFluentBuilder::new(self.handle.clone())
24    }
25}
aws_sdk_qconnect/client/query_assistant.rs

aws_sdk_qconnect/client/
query_assistant.rs
