Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MessageRequest

A request sent to the workspace, including the user input and context.

Hierarchy

  • MessageRequest

Index

Properties

Optional actions

actions: DialogNodeAction[]

An array of objects describing any actions requested by the dialog node.

Optional alternate_intents

alternate_intents: boolean

Whether to return more than one intent. A value of true indicates that all matching intents are returned.

Optional context

context: Context

State information for the conversation. To maintain state, include the context from the previous response.

Optional entities

entities: RuntimeEntity[]

Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input.

Optional input

An input object that includes the input text.

Optional intents

intents: RuntimeIntent[]

Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input.

Optional output

output: OutputData

An output object that includes the response to the user, the dialog nodes that were triggered, and messages from the log.

Optional user_id

user_id: string

A string value that identifies the user who is interacting with the workspace. The client must provide a unique identifier for each individual end user who accesses the application. For user-based plans, this user ID is used to identify unique users for billing purposes. This string cannot contain carriage return, newline, or tab characters. If no value is specified in the input, user_id is automatically set to the value of context.conversation_id.

Note: This property is the same as the user_id property in the context metadata. If user_id is specified in both locations in a message request, the value specified at the root is used.

Generated using TypeDoc