aws_sdk_iotsitewise/client/
invoke_assistant.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`InvokeAssistant`](crate::operation::invoke_assistant::builders::InvokeAssistantFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`conversation_id(impl Into<String>)`](crate::operation::invoke_assistant::builders::InvokeAssistantFluentBuilder::conversation_id) / [`set_conversation_id(Option<String>)`](crate::operation::invoke_assistant::builders::InvokeAssistantFluentBuilder::set_conversation_id):<br>required: **false**<br><p>The ID assigned to a conversation. IoT SiteWise automatically generates a unique ID for you, and this parameter is never required. However, if you prefer to have your own ID, you must specify it here in UUID format. If you specify your own ID, it must be globally unique.</p><br>
    ///   - [`message(impl Into<String>)`](crate::operation::invoke_assistant::builders::InvokeAssistantFluentBuilder::message) / [`set_message(Option<String>)`](crate::operation::invoke_assistant::builders::InvokeAssistantFluentBuilder::set_message):<br>required: **true**<br><p>A text message sent to the SiteWise Assistant by the user.</p><br>
    ///   - [`enable_trace(bool)`](crate::operation::invoke_assistant::builders::InvokeAssistantFluentBuilder::enable_trace) / [`set_enable_trace(Option<bool>)`](crate::operation::invoke_assistant::builders::InvokeAssistantFluentBuilder::set_enable_trace):<br>required: **false**<br><p>Specifies if to turn trace on or not. It is used to track the SiteWise Assistant's reasoning, and data access process.</p><br>
    /// - On success, responds with [`InvokeAssistantOutput`](crate::operation::invoke_assistant::InvokeAssistantOutput) with field(s):
    ///   - [`body(EventReceiver<ResponseStream, ResponseStreamError>)`](crate::operation::invoke_assistant::InvokeAssistantOutput::body): <p>Contains the response, citation, and trace from the SiteWise Assistant.</p>
    ///   - [`conversation_id(String)`](crate::operation::invoke_assistant::InvokeAssistantOutput::conversation_id): <p>The ID of the conversation, in UUID format. This ID uniquely identifies the conversation within IoT SiteWise.</p>
    /// - On failure, responds with [`SdkError<InvokeAssistantError>`](crate::operation::invoke_assistant::InvokeAssistantError)
    pub fn invoke_assistant(&self) -> crate::operation::invoke_assistant::builders::InvokeAssistantFluentBuilder {
        crate::operation::invoke_assistant::builders::InvokeAssistantFluentBuilder::new(self.handle.clone())
    }
}