AWS CDK

2.264.0

interface CustomPromptInterfaceProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnAgent.CustomPromptInterfaceProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnAgent_CustomPromptInterfaceProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnAgent.CustomPromptInterfaceProperty`
Python	`aws_cdk.aws_quicksight.CfnAgent.CustomPromptInterfaceProperty`
TypeScript	`aws-cdk-lib` » `aws_quicksight` » `CfnAgent` » `CustomPromptInterfaceProperty`

Read-only view of the resolved custom prompt interface for the agent.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinterface.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const customPromptInterfaceProperty: quicksight.CfnAgent.CustomPromptInterfaceProperty = {
  customInstructions: 'customInstructions',
  identity: 'identity',
  modelProfileId: 'modelProfileId',
  outputStyle: 'outputStyle',
  promptSummary: 'promptSummary',
  qbsAwsAccountId: 'qbsAwsAccountId',
  responseLength: 'responseLength',
  subscriptionId: 'subscriptionId',
  tone: 'tone',
};

Properties

Name	Type	Description
customInstructions?	`string`	Custom instructions for the agent behavior.
identity?	`string`	The identity or persona of the agent.
modelProfileId?	`string`	The identifier of the model profile.
outputStyle?	`string`	The output style for the agent responses.
promptSummary?	`string`	A summary of the resolved prompt.
qbsAwsAccountId?	`string`	The QBS AWS account identifier.
responseLength?	`string`	The desired response length for the agent.
subscriptionId?	`string`	The subscription identifier.
tone?	`string`	The tone used in agent responses.

customInstructions?

Type: string (optional)

Custom instructions for the agent behavior.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinterface.html#cfn-quicksight-agent-custompromptinterface-custominstructions

identity?

Type: string (optional)

The identity or persona of the agent.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinterface.html#cfn-quicksight-agent-custompromptinterface-identity

modelProfileId?

Type: string (optional)

The identifier of the model profile.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinterface.html#cfn-quicksight-agent-custompromptinterface-modelprofileid

outputStyle?

Type: string (optional)

The output style for the agent responses.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinterface.html#cfn-quicksight-agent-custompromptinterface-outputstyle

promptSummary?

Type: string (optional)

A summary of the resolved prompt.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinterface.html#cfn-quicksight-agent-custompromptinterface-promptsummary

qbsAwsAccountId?

Type: string (optional)

The QBS AWS account identifier.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinterface.html#cfn-quicksight-agent-custompromptinterface-qbsawsaccountid

responseLength?

Type: string (optional)

The desired response length for the agent.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinterface.html#cfn-quicksight-agent-custompromptinterface-responselength

subscriptionId?

Type: string (optional)

The subscription identifier.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinterface.html#cfn-quicksight-agent-custompromptinterface-subscriptionid

tone?

Type: string (optional)

The tone used in agent responses.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinterface.html#cfn-quicksight-agent-custompromptinterface-tone

← Previous Next →