Skip to content

CustomPromptInterface

Source code in docs_src/capo_quicksight/types/custom_prompt_interface.py
class CustomPromptInterface(TypedDict, closed=True):
    model_profile_id: "capo_quicksight.types.model_profile_id.ModelProfileId"
    """<p>The identifier of the model profile.</p>"""
    subscription_id: "capo_quicksight.types.subscription_id.SubscriptionId"
    """<p>The subscription identifier.</p>"""
    qbs_aws_account_id: "capo_quicksight.types.qbs_aws_account_id.QbsAwsAccountId"
    """<p>The Amazon Web Services account ID for the Q Business service.</p>"""
    response_length: NotRequired[
        "capo_quicksight.types.style_description.StyleDescription"
    ]
    """<p>Instructions for the desired response length.</p>"""
    output_style: NotRequired[
        "capo_quicksight.types.style_description.StyleDescription"
    ]
    """<p>Instructions for the desired output style.</p>"""
    identity: NotRequired["capo_quicksight.types.style_description.StyleDescription"]
    """<p>Instructions that define the agent's identity and persona.</p>"""
    tone: NotRequired["capo_quicksight.types.style_description.StyleDescription"]
    """<p>Instructions for the desired tone of responses.</p>"""
    custom_instructions: NotRequired[
        "capo_quicksight.types.style_description.StyleDescription"
    ]
    """<p>Custom instructions for the agent's behavior.</p>"""
    prompt_summary: NotRequired["capo_quicksight.types.sensitive_text.SensitiveText"]
    """<p>A summary of the custom prompt configuration.</p>"""

custom_instructions instance-attribute

custom_instructions: NotRequired[StyleDescription]

Custom instructions for the agent's behavior.

identity instance-attribute

identity: NotRequired[StyleDescription]

Instructions that define the agent's identity and persona.

model_profile_id instance-attribute

model_profile_id: ModelProfileId

The identifier of the model profile.

output_style instance-attribute

output_style: NotRequired[StyleDescription]

Instructions for the desired output style.

prompt_summary instance-attribute

prompt_summary: NotRequired[SensitiveText]

A summary of the custom prompt configuration.

qbs_aws_account_id instance-attribute

qbs_aws_account_id: QbsAwsAccountId

The Amazon Web Services account ID for the Q Business service.

response_length instance-attribute

response_length: NotRequired[StyleDescription]

Instructions for the desired response length.

subscription_id instance-attribute

subscription_id: SubscriptionId

The subscription identifier.

tone instance-attribute

tone: NotRequired[StyleDescription]

Instructions for the desired tone of responses.