Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MessageParams

Parameters for the message operation.

Hierarchy

  • MessageParams

Index

Properties

Optional alternateIntents

alternateIntents: 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 headers

headers: OutgoingHttpHeaders

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 nodesVisitedDetails

nodesVisitedDetails: boolean

Whether to include additional diagnostic information about the dialog nodes that were visited during processing of the message.

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 userId

userId: 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.

workspaceId

workspaceId: string

Unique identifier of the workspace.

Generated using TypeDoc