CustomPromptInterface
The custom prompt interface configuration that defines how an agent's prompt is configured.
Contents
Note
In the following list, the required parameters are described first.
- ModelProfileId
-
The identifier of the model profile.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-]{35}Required: Yes
- QbsAwsAccountId
-
The AWS account ID for the Q Business service.
Type: String
Length Constraints: Fixed length of 15.
Pattern:
QBS[0-9]{12}Required: Yes
- SubscriptionId
-
The subscription identifier.
Type: String
Length Constraints: Fixed length of 32.
Pattern:
[a-z0-9]+Required: Yes
- CustomInstructions
-
Custom instructions for the agent's behavior.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 350000.
Pattern:
[\s\S]*Required: No
- Identity
-
Instructions that define the agent's identity and persona.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 350000.
Pattern:
[\s\S]*Required: No
- OutputStyle
-
Instructions for the desired output style.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 350000.
Pattern:
[\s\S]*Required: No
- promptSummary
-
A summary of the custom prompt configuration.
Type: String
Required: No
- ResponseLength
-
Instructions for the desired response length.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 350000.
Pattern:
[\s\S]*Required: No
- Tone
-
Instructions for the desired tone of responses.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 350000.
Pattern:
[\s\S]*Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
