Skip to content

UpdateAIPromptRequest

Source code in docs_src/capo_qconnect/types/update_ai_prompt_request.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
class UpdateAIPromptRequest(TypedDict, closed=True):
    client_token: NotRequired["capo_qconnect.types.client_token.ClientToken"]
    """<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>"""
    assistant_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn"
    """<p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>"""
    ai_prompt_id: "capo_qconnect.types.uuid_or_arn_or_either_with_qualifier.UuidOrArnOrEitherWithQualifier"
    """<p>The identifier of the Amazon Q in Connect AI Prompt.</p>"""
    visibility_status: "capo_qconnect.types.visibility_status.VisibilityStatus"
    """<p>The visibility status of the Amazon Q in Connect AI prompt.</p>"""
    template_configuration: NotRequired[
        "capo_qconnect.types.ai_prompt_template_configuration.AIPromptTemplateConfiguration"
    ]
    """<p>The configuration of the prompt template for this AI Prompt.</p>"""
    description: NotRequired["capo_qconnect.types.description.Description"]
    """<p>The description of the Amazon Q in Connect AI Prompt.</p>"""
    model_id: NotRequired[
        "capo_qconnect.types.ai_prompt_model_identifier.AIPromptModelIdentifier"
    ]
    """<p>The identifier of the model used for this AI Prompt.</p> <note> <p>For information about which models are supported in each Amazon Web Services Region, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-ai-prompts.html#cli-create-aiprompt">Supported models for system/custom prompts</a>.</p> </note>"""
    inference_configuration: NotRequired[
        "capo_qconnect.types.ai_prompt_inference_configuration.AIPromptInferenceConfiguration"
    ]
    """<p>The updated inference configuration for the AI Prompt.</p>"""

ai_prompt_id instance-attribute 

ai_prompt_id: UuidOrArnOrEitherWithQualifier

The identifier of the Amazon Q in Connect AI Prompt.

assistant_id instance-attribute 

assistant_id: UuidOrArn

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

client_token instance-attribute 

client_token: NotRequired[ClientToken]

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 Making retries safe with idempotent APIs..

description instance-attribute 

description: NotRequired[Description]

The description of the Amazon Q in Connect AI Prompt.

inference_configuration instance-attribute 

inference_configuration: NotRequired[AIPromptInferenceConfiguration]

The updated inference configuration for the AI Prompt.

model_id instance-attribute 

model_id: NotRequired[AIPromptModelIdentifier]

The identifier of the model used for this AI Prompt.

For information about which models are supported in each Amazon Web Services Region, see Supported models for system/custom prompts.

template_configuration instance-attribute 

template_configuration: NotRequired[AIPromptTemplateConfiguration]

The configuration of the prompt template for this AI Prompt.

visibility_status instance-attribute 

visibility_status: VisibilityStatus

The visibility status of the Amazon Q in Connect AI prompt.