AWS::QuickSight::Agent CustomPromptInterface

The custom prompt interface configuration that defines how an agent's prompt is configured.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "CustomInstructions" : String,
  "Identity" : String,
  "ModelProfileId" : String,
  "OutputStyle" : String,
  "PromptSummary" : String,
  "QbsAwsAccountId" : String,
  "ResponseLength" : String,
  "SubscriptionId" : String,
  "Tone" : String
}

YAML

  CustomInstructions: String
  Identity: String
  ModelProfileId: String
  OutputStyle: String
  PromptSummary: String
  QbsAwsAccountId: String
  ResponseLength: String
  SubscriptionId: String
  Tone: String

Properties

CustomInstructions

Custom instructions for the agent's behavior.

Required: No

Type: String

Minimum: 5

Maximum: 350000

Update requires: No interruption

Identity

Instructions that define the agent's identity and persona.

Required: No

Type: String

Minimum: 5

Maximum: 350000

Update requires: No interruption

ModelProfileId

The identifier of the model profile.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$

Minimum: 36

Maximum: 36

Update requires: No interruption

OutputStyle

Instructions for the desired output style.

Required: No

Type: String

Minimum: 5

Maximum: 350000

Update requires: No interruption

PromptSummary

A summary of the custom prompt configuration.

Required: No

Type: String

Update requires: No interruption

QbsAwsAccountId

The AWS account ID for the Q Business service.

Required: No

Type: String

Pattern: ^QBS[0-9]{12}$

Minimum: 15

Maximum: 15

Update requires: No interruption

ResponseLength

Instructions for the desired response length.

Required: No

Type: String

Minimum: 5

Maximum: 350000

Update requires: No interruption

SubscriptionId

The subscription identifier.

Required: No

Type: String

Pattern: ^[a-z0-9]+$

Minimum: 32

Maximum: 32

Update requires: No interruption

Tone

Instructions for the desired tone of responses.

Required: No

Type: String

Minimum: 5

Maximum: 350000

Update requires: No interruption