aws_sdk_qconnect/client/
create_ai_prompt.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 [`CreateAIPrompt`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`client_token(impl Into<String>)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p><br>
7    ///   - [`assistant_id(impl Into<String>)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::assistant_id) / [`set_assistant_id(Option<String>)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::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    ///   - [`name(impl Into<String>)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::set_name):<br>required: **true**<br><p>The name of the AI Prompt.</p><br>
9    ///   - [`r#type(AiPromptType)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::type) / [`set_type(Option<AiPromptType>)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::set_type):<br>required: **true**<br><p>The type of this AI Prompt.</p><br>
10    ///   - [`template_configuration(AiPromptTemplateConfiguration)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::template_configuration) / [`set_template_configuration(Option<AiPromptTemplateConfiguration>)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::set_template_configuration):<br>required: **true**<br><p>The configuration of the prompt template for this AI Prompt.</p><br>
11    ///   - [`visibility_status(VisibilityStatus)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::visibility_status) / [`set_visibility_status(Option<VisibilityStatus>)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::set_visibility_status):<br>required: **true**<br><p>The visibility status of the AI Prompt.</p><br>
12    ///   - [`template_type(AiPromptTemplateType)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::template_type) / [`set_template_type(Option<AiPromptTemplateType>)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::set_template_type):<br>required: **true**<br><p>The type of the prompt template for this AI Prompt.</p><br>
13    ///   - [`model_id(impl Into<String>)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::model_id) / [`set_model_id(Option<String>)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::set_model_id):<br>required: **true**<br><p>The identifier of the model used for this AI Prompt.</p><br>
14    ///   - [`api_format(AiPromptApiFormat)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::api_format) / [`set_api_format(Option<AiPromptApiFormat>)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::set_api_format):<br>required: **true**<br><p>The API Format of the AI Prompt.</p> <p>Recommended values: <code>MESSAGES | TEXT_COMPLETIONS</code></p><note>  <p>The values <code>ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS</code> will be deprecated.</p> </note><br>
15    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::set_tags):<br>required: **false**<br><p>The tags used to organize, track, or control access for this resource.</p><br>
16    ///   - [`description(impl Into<String>)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::set_description):<br>required: **false**<br><p>The description of the AI Prompt.</p><br>
17    /// - On success, responds with [`CreateAiPromptOutput`](crate::operation::create_ai_prompt::CreateAiPromptOutput) with field(s):
18    ///   - [`ai_prompt(Option<AiPromptData>)`](crate::operation::create_ai_prompt::CreateAiPromptOutput::ai_prompt): <p>The data of the AI Prompt.</p>
19    /// - On failure, responds with [`SdkError<CreateAIPromptError>`](crate::operation::create_ai_prompt::CreateAIPromptError)
20    pub fn create_ai_prompt(&self) -> crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder {
21        crate::operation::create_ai_prompt::builders::CreateAIPromptFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_qconnect/client/create_ai_prompt.rs

aws_sdk_qconnect/client/
create_ai_prompt.rs
