Package software.amazon.awscdk.services.quicksight

Interface CfnAgent.CustomPromptInterfaceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAgent.CustomPromptInterfaceProperty.Jsii$Proxy

Enclosing class:

CfnAgent

@Stability(Stable)
public static interface CfnAgent.CustomPromptInterfaceProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 CustomPromptInterfaceProperty customPromptInterfaceProperty = CustomPromptInterfaceProperty.builder()
         .customInstructions("customInstructions")
         .identity("identity")
         .modelProfileId("modelProfileId")
         .outputStyle("outputStyle")
         .promptSummary("promptSummary")
         .qbsAwsAccountId("qbsAwsAccountId")
         .responseLength("responseLength")
         .subscriptionId("subscriptionId")
         .tone("tone")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAgent.CustomPromptInterfaceProperty.Builder	A builder for CfnAgent.CustomPromptInterfaceProperty
static final class	CfnAgent.CustomPromptInterfaceProperty.Jsii$Proxy	An implementation for CfnAgent.CustomPromptInterfaceProperty

Method Summary

Modifier and Type	Method	Description
static CfnAgent.CustomPromptInterfaceProperty.Builder	builder()
default String	getCustomInstructions()	Custom instructions for the agent behavior.
default String	getIdentity()	The identity or persona of the agent.
default String	getModelProfileId()	The identifier of the model profile.
default String	getOutputStyle()	The output style for the agent responses.
default String	getPromptSummary()	A summary of the resolved prompt.
default String	getQbsAwsAccountId()	The QBS AWS account identifier.
default String	getResponseLength()	The desired response length for the agent.
default String	getSubscriptionId()	The subscription identifier.
default String	getTone()	The tone used in agent responses.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCustomInstructions

@Stability(Stable)
@Nullable
default String getCustomInstructions()

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

getIdentity

@Stability(Stable)
@Nullable
default String getIdentity()

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

getModelProfileId

@Stability(Stable)
@Nullable
default String getModelProfileId()

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

getOutputStyle

@Stability(Stable)
@Nullable
default String getOutputStyle()

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

getPromptSummary

@Stability(Stable)
@Nullable
default String getPromptSummary()

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

getQbsAwsAccountId

@Stability(Stable)
@Nullable
default String getQbsAwsAccountId()

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

getResponseLength

@Stability(Stable)
@Nullable
default String getResponseLength()

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

getSubscriptionId

@Stability(Stable)
@Nullable
default String getSubscriptionId()

The subscription identifier.

See Also:

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

getTone

@Stability(Stable)
@Nullable
default String getTone()

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

builder

@Stability(Stable)
static CfnAgent.CustomPromptInterfaceProperty.Builder builder()

Returns:

a CfnAgent.CustomPromptInterfaceProperty.Builder of CfnAgent.CustomPromptInterfaceProperty