View a markdown version of this page

AgentOutputMessage - AWS HealthLake

AgentOutputMessage

Represents a response message from the agent during chat-based profile customization.

Contents

Body

The text of the agent's response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 40960.

Required: Yes

Type

The type of output message, which indicates how to interpret the agent's response.

Type: String

Valid Values: INITIAL_GREETING | normal | confirmation | complete | error | options | choices

Required: Yes

OptionsList

A list of selectable options presented when the response type is options.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: