UMIM API 1.3.0 documentation

UMIM API 1.3.0

application/json

The AsyncAPI version of UMIM is meant for use with Interaction Manager (IM) components that communicate through an asynchronous event bus.

Operations

PUB umim_events_system
UMIM event stream specific to a unique device stream.

stream_uid
required
string
uid: stream_uid
Unique identifier for the stream.
Accepts one of the following messages:
- #0PipelineAcquiredPipelineAcquired
  A new pipeline has been acquired. A pipeline connects the IM to end user devices (stream_uid). This event informs the IM in an event-based implementation about the availability of new pipelines.
  application/json
  object
  type
  required
  string
  Allowed values:
  "PipelineAcquired"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  stream_uid
  required
  string
  A unique identifier for the stream
  
  session_uid
  string
  A unique identifier for the session
  
  user_uid
  string
  A unique identifier for the user
  
  Additional properties are allowed.
  Examples
  { "type": "PipelineAcquired", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "stream_uid": "string", "session_uid": "string", "user_uid": "string" }
  
  This example has been generated automatically.
- #1PipelineReleasedPipelineReleased
  A pipeline has been released and is no longer available. A pipeline connects the IM to end user devices (stream_uid). This event informs the IM in an event-based implementation about pipelines that have been released.
  application/json
  object
  type
  required
  string
  Allowed values:
  "PipelineReleased"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  stream_uid
  required
  string
  A unique identifier for the stream
  
  session_uid
  string
  A unique identifier for the session
  
  user_uid
  string
  A unique identifier for the user
  
  Additional properties are allowed.
  Examples
  { "type": "PipelineReleased", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "stream_uid": "string", "session_uid": "string", "user_uid": "string" }
  
  This example has been generated automatically.
- #2PipelineUpdatedPipelineUpdated
  Information about an existing pipeline has been updated. This means that a new session was started or a new user has been identified as part of the same pipeline.
  application/json
  object
  type
  required
  string
  Allowed values:
  "PipelineUpdated"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  stream_uid
  required
  string
  A unique identifier for the stream
  
  session_uid
  string
  A unique identifier for the session
  
  user_uid
  string
  A unique identifier for the user
  
  Additional properties are allowed.
  Examples
  { "type": "PipelineUpdated", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "stream_uid": "string", "session_uid": "string", "user_uid": "string" }
  
  This example has been generated automatically.
PUB umim_events{stream_uid}
UMIM event stream specific to a unique device stream.

stream_uid
required
string
uid: stream_uid
Unique identifier for the stream.
Accepts one of the following messages:
- #0AttentionUserActionFinishedAttentionUserActionFinished
  The system detects the user to be disengaged with the interactive system.
  application/json
  object
  type
  required
  string
  Allowed values:
  "AttentionUserActionFinished"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "user_engagement"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_finished_at
  required
  string
  format: date-time
  The timestamp of when the action has finished.
  
  is_success
  required
  boolean
  Did the action finish successfully
  
  was_stopped
  boolean
  Was the action stopped by a Stop event
  
  failure_reason
  string
  Reason for action failure in case the action did not execute successfully
  
  user_id
  string
  An ID identifying the user performing the action. This field is required if you support multi-user interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "AttentionUserActionFinished", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "user_engagement", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "action_finished_at": "2019-08-24T14:15:22Z", "is_success": true, "was_stopped": true, "failure_reason": "string", "user_id": "string" }
  
  This example has been generated automatically.
- #1AttentionUserActionStartedAttentionUserActionStarted
  The interactive system detects some level of engagement of the user.
  application/json
  object
  type
  required
  string
  Allowed values:
  "AttentionUserActionStarted"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "user_engagement"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_started_at
  required
  string
  format: date-time
  The timestamp of when the action has started.
  
  user_id
  string
  An ID identifying the user performing the action. This field is required if you support multi-user interactions.
  
  attention_level
  number
  Optional. Float in the range (0,1] (not including 0). Indicates the estimated attention level. The level should represent a statistic for the measured attention of the user. Depending on the interactive system this could for example be the mean engagement level over a sliding window.
  
  Additional properties are allowed.
  Examples
  { "type": "AttentionUserActionStarted", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "user_engagement", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "action_started_at": "2019-08-24T14:15:22Z", "user_id": "string", "attention_level": 0 }
  
  This example has been generated automatically.
- #2AttentionUserActionUpdatedAttentionUserActionUpdated
  The interactive system provides an update to the engagement level.
  application/json
  object
  type
  required
  string
  Allowed values:
  "AttentionUserActionUpdated"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "user_engagement"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_updated_at
  required
  string
  format: date-time
  The timestamp of when the action has been updated.
  
  user_id
  string
  An ID identifying the user performing the action. This field is required if you support multi-user interactions.
  
  attention_level
  number
  Optional. Float in the range (0,1] (not including 0). Indicates the estimated attention level.
  
  Additional properties are allowed.
  Examples
  { "type": "AttentionUserActionUpdated", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "user_engagement", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "action_updated_at": "2019-08-24T14:15:22Z", "user_id": "string", "attention_level": 0 }
  
  This example has been generated automatically.
- #3CustomBotActionFinishedCustomBotActionFinished
  The custom action has finished its execution.
  application/json
  object
  type
  required
  string
  Allowed values:
  "CustomBotActionFinished"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "custom"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_finished_at
  required
  string
  format: date-time
  The timestamp of when the action has finished.
  
  is_success
  required
  boolean
  Did the action finish successfully
  
  was_stopped
  boolean
  Was the action stopped by a Stop event
  
  failure_reason
  string
  Reason for action failure in case the action did not execute successfully
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  custom_action_name
  required
  string
  The name of the custom action.
  
  required
  object
  Any results from the action.
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "type": "CustomBotActionFinished", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "custom", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "action_finished_at": "2019-08-24T14:15:22Z", "is_success": true, "was_stopped": true, "failure_reason": "string", "bot_id": "string", "custom_action_name": "string", "results": {} }
  
  This example has been generated automatically.
- #4CustomBotActionStartedCustomBotActionStarted
  The execution of the custom user action has started.
  application/json
  object
  type
  required
  string
  Allowed values:
  "CustomBotActionStarted"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "custom"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_started_at
  required
  string
  format: date-time
  The timestamp of when the action has started.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  custom_action_name
  required
  string
  The name of the custom action.
  
  required
  object
  Any parameters for the action.
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "type": "CustomBotActionStarted", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "custom", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "action_started_at": "2019-08-24T14:15:22Z", "bot_id": "string", "custom_action_name": "string", "parameters": {} }
  
  This example has been generated automatically.
- #5CustomBotActionUpdatedCustomBotActionUpdated
  Something happened during the execution of the custom action (if supported by the custom action).
  application/json
  object
  type
  required
  string
  Allowed values:
  "CustomBotActionUpdated"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "custom"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_updated_at
  required
  string
  format: date-time
  The timestamp of when the action has been updated.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  custom_action_name
  required
  string
  The name of the custom action.
  
  required
  object
  Any updates from the action.
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "type": "CustomBotActionUpdated", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "custom", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "action_updated_at": "2019-08-24T14:15:22Z", "bot_id": "string", "custom_action_name": "string", "updates": {} }
  
  This example has been generated automatically.
- #6CustomUserActionFinishedCustomUserActionFinished
  An action has finished its execution. An action can finish either because the action has completed or failed (natural completion) or it can finish because it was stopped by the IM. The success (or failure) of the execution is marked using the status_code attribute.
  application/json
  object
  type
  required
  string
  Allowed values:
  "CustomUserActionFinished"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "custom"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_finished_at
  required
  string
  format: date-time
  The timestamp of when the action has finished.
  
  is_success
  required
  boolean
  Did the action finish successfully
  
  was_stopped
  boolean
  Was the action stopped by a Stop event
  
  failure_reason
  string
  Reason for action failure in case the action did not execute successfully
  
  user_id
  string
  An ID identifying the user performing the action. This field is required if you support multi-user interactions.
  
  custom_action_name
  required
  string
  The name of the custom action.
  
  required
  object
  Any results from the action.
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "type": "CustomUserActionFinished", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "custom", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "action_finished_at": "2019-08-24T14:15:22Z", "is_success": true, "was_stopped": true, "failure_reason": "string", "user_id": "string", "custom_action_name": "string", "results": {} }
  
  This example has been generated automatically.
- #7CustomUserActionStartedCustomUserActionStarted
  The execution of the custom user action has started.
  application/json
  object
  type
  required
  string
  Allowed values:
  "CustomUserActionStarted"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "custom"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_started_at
  required
  string
  format: date-time
  The timestamp of when the action has started.
  
  user_id
  string
  An ID identifying the user performing the action. This field is required if you support multi-user interactions.
  
  custom_action_name
  required
  string
  The name of the custom action.
  
  required
  object
  Any parameters for the action.
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "type": "CustomUserActionStarted", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "custom", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "action_started_at": "2019-08-24T14:15:22Z", "user_id": "string", "custom_action_name": "string", "parameters": {} }
  
  This example has been generated automatically.
- #8CustomUserActionUpdatedCustomUserActionUpdated
  A running action provides a (partial) result. Ongoing actions can provide partial updates on the current status of the action. An ActionUpdated should always update the payload of the action object and provide the type of update.
  application/json
  object
  type
  required
  string
  Allowed values:
  "CustomUserActionUpdated"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "custom"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_updated_at
  required
  string
  format: date-time
  The timestamp of when the action has been updated.
  
  user_id
  string
  An ID identifying the user performing the action. This field is required if you support multi-user interactions.
  
  custom_action_name
  required
  string
  The name of the custom action.
  
  required
  object
  Any updates from the action.
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "type": "CustomUserActionUpdated", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "custom", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "action_updated_at": "2019-08-24T14:15:22Z", "user_id": "string", "custom_action_name": "string", "updates": {} }
  
  This example has been generated automatically.
- #9ExpectationBotActionFinishedExpectationBotActionFinished
  The interactive system acknowledges that the bot expectation is finished.
  application/json
  object
  type
  required
  string
  Allowed values:
  "ExpectationBotActionFinished"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_expectation"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_finished_at
  required
  string
  format: date-time
  The timestamp of when the action has finished.
  
  is_success
  required
  boolean
  Did the action finish successfully
  
  was_stopped
  boolean
  Was the action stopped by a Stop event
  
  failure_reason
  string
  Reason for action failure in case the action did not execute successfully
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "ExpectationBotActionFinished", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_expectation", "action_info_modality_policy": "parallel", "action_info_lifetime": "indefinite", "action_finished_at": "2019-08-24T14:15:22Z", "is_success": true, "was_stopped": true, "failure_reason": "string", "bot_id": "string" }
  
  This example has been generated automatically.
- #10ExpectationBotActionStartedExpectationBotActionStarted
  The interactive system communicates to the IM that it is able to handle the expectation for the specified events. In case the system is able to handle the expectation it has to send out the ExpectationBotActionStarted event. Receiving the ActionStarted event does not come with any guarantees on how the expectation is handled, but it provides the IM with a way to know if the system is even capable of handling expectations. For expectations for events that are not supported by any Action Server in the interactive system, no ExpectationBotActionStarted event will be sent out. If a system is not capable of handling certain bot expectations the IM might stop communicating them.
  application/json
  object
  type
  required
  string
  Allowed values:
  "ExpectationBotActionStarted"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_expectation"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_started_at
  required
  string
  format: date-time
  The timestamp of when the action has started.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "ExpectationBotActionStarted", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_expectation", "action_info_modality_policy": "parallel", "action_info_lifetime": "indefinite", "action_started_at": "2019-08-24T14:15:22Z", "bot_id": "string" }
  
  This example has been generated automatically.
- #11ExpectationSignalingBotActionFinishedExpectationSignalingBotActionFinished
  Bot has stopped actively waiting. Note that this action is only stopped on explicit request, by calling the sending the StopExpectationSignalingBotAction . Otherwise the action will continue indefinitely.
  application/json
  object
  type
  required
  string
  Allowed values:
  "ExpectationSignalingBotActionFinished "
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_expectation"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_finished_at
  required
  string
  format: date-time
  The timestamp of when the action has finished.
  
  is_success
  required
  boolean
  Did the action finish successfully
  
  was_stopped
  boolean
  Was the action stopped by a Stop event
  
  failure_reason
  string
  Reason for action failure in case the action did not execute successfully
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "ExpectationSignalingBotActionFinished ", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_expectation", "action_info_modality_policy": "parallel", "action_info_lifetime": "indefinite", "action_finished_at": "2019-08-24T14:15:22Z", "is_success": true, "was_stopped": true, "failure_reason": "string", "bot_id": "string" }
  
  This example has been generated automatically.
- #12ExpectationSignalingBotActionStartedExpectationSignalingBotActionStarted
  The bot has started actively waiting for an event on the specified modality.
  application/json
  object
  type
  required
  string
  Allowed values:
  "ExpectationSignalingBotActionStarted"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_expectation"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_started_at
  required
  string
  format: date-time
  The timestamp of when the action has started.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "ExpectationSignalingBotActionStarted", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_expectation", "action_info_modality_policy": "parallel", "action_info_lifetime": "indefinite", "action_started_at": "2019-08-24T14:15:22Z", "bot_id": "string" }
  
  This example has been generated automatically.
- #13FacialGestureBotActionFinishedFacialGestureBotActionFinished
  The facial gesture was performed.
  application/json
  object
  type
  required
  string
  Allowed values:
  "FacialGestureBotActionFinished"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_face"
  action_info_modality_policy
  required
  string
  Allowed values:
  "replace"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_finished_at
  required
  string
  format: date-time
  The timestamp of when the action has finished.
  
  is_success
  required
  boolean
  Did the action finish successfully
  
  was_stopped
  boolean
  Was the action stopped by a Stop event
  
  failure_reason
  string
  Reason for action failure in case the action did not execute successfully
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "FacialGestureBotActionFinished", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_face", "action_info_modality_policy": "replace", "action_info_lifetime": "limited", "action_finished_at": "2019-08-24T14:15:22Z", "is_success": true, "was_stopped": true, "failure_reason": "string", "bot_id": "string" }
  
  This example has been generated automatically.
- #14FacialGestureBotActionStartedFacialGestureBotActionStarted
  The bot has started to perform the facial gesture
  application/json
  object
  type
  required
  string
  Allowed values:
  "FacialGestureBotActionStarted"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_face"
  action_info_modality_policy
  required
  string
  Allowed values:
  "replace"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_started_at
  required
  string
  format: date-time
  The timestamp of when the action has started.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "FacialGestureBotActionStarted", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_face", "action_info_modality_policy": "replace", "action_info_lifetime": "limited", "action_started_at": "2019-08-24T14:15:22Z", "bot_id": "string" }
  
  This example has been generated automatically.
- #15FacialGestureUserActionFinishedFacialGestureUserActionFinished
  An action has finished its execution. An action can finish either because the action has completed or failed (natural completion) or it can finish because it was stopped by the IM. The success (or failure) of the execution is marked using the status_code attribute.
  application/json
  object
  type
  required
  string
  Allowed values:
  "FacialGestureUserActionFinished"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "user_face"
  action_info_modality_policy
  required
  string
  Allowed values:
  "replace"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_finished_at
  required
  string
  format: date-time
  The timestamp of when the action has finished.
  
  is_success
  required
  boolean
  Did the action finish successfully
  
  was_stopped
  boolean
  Was the action stopped by a Stop event
  
  failure_reason
  string
  Reason for action failure in case the action did not execute successfully
  
  user_id
  string
  An ID identifying the user performing the action. This field is required if you support multi-user interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "FacialGestureUserActionFinished", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "user_face", "action_info_modality_policy": "replace", "action_info_lifetime": "indefinite", "action_finished_at": "2019-08-24T14:15:22Z", "is_success": true, "was_stopped": true, "failure_reason": "string", "user_id": "string" }
  
  This example has been generated automatically.
- #16FacialGestureUserActionStartedFacialGestureUserActionStarted
  The execution of an action has started.
  application/json
  object
  type
  required
  string
  Allowed values:
  "FacialGestureUserActionStarted"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "user_face"
  action_info_modality_policy
  required
  string
  Allowed values:
  "replace"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_started_at
  required
  string
  format: date-time
  The timestamp of when the action has started.
  
  user_id
  string
  An ID identifying the user performing the action. This field is required if you support multi-user interactions.
  
  expression
  required
  string
  Natural language description (NLD) of the facial expression. Detected facial expressions depend on the capabilities of the interactive system.
  
  Minimal NLD set: The following expressions should be supported by every interactive system implementing this action: smile, lough, frown, wink
  
  Additional properties are allowed.
  Examples
  { "type": "FacialGestureUserActionStarted", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "user_face", "action_info_modality_policy": "replace", "action_info_lifetime": "indefinite", "action_started_at": "2019-08-24T14:15:22Z", "user_id": "string", "expression": "string" }
  
  This example has been generated automatically.
- #17GestureBotActionFinishedGestureBotActionFinished
  The gesture was performed.
  application/json
  object
  type
  required
  string
  Allowed values:
  "GestureBotActionFinished"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_gesture"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_finished_at
  required
  string
  format: date-time
  The timestamp of when the action has finished.
  
  is_success
  required
  boolean
  Did the action finish successfully
  
  was_stopped
  boolean
  Was the action stopped by a Stop event
  
  failure_reason
  string
  Reason for action failure in case the action did not execute successfully
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "GestureBotActionFinished", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_gesture", "action_info_modality_policy": "override", "action_info_lifetime": "limited", "action_finished_at": "2019-08-24T14:15:22Z", "is_success": true, "was_stopped": true, "failure_reason": "string", "bot_id": "string" }
  
  This example has been generated automatically.
- #18GestureBotActionStartedGestureBotActionStarted
  The bot has started to perform the gesture.
  application/json
  object
  type
  required
  string
  Allowed values:
  "GestureBotActionStarted"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_gesture"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_started_at
  required
  string
  format: date-time
  The timestamp of when the action has started.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "GestureBotActionStarted", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_gesture", "action_info_modality_policy": "override", "action_info_lifetime": "limited", "action_started_at": "2019-08-24T14:15:22Z", "bot_id": "string" }
  
  This example has been generated automatically.
- #19GestureUserActionFinishedGestureUserActionFinished
  The user performed a gesture.
  application/json
  object
  type
  required
  string
  Allowed values:
  "GestureUserActionFinished"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "user_upper_body"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_finished_at
  required
  string
  format: date-time
  The timestamp of when the action has finished.
  
  is_success
  required
  boolean
  Did the action finish successfully
  
  was_stopped
  boolean
  Was the action stopped by a Stop event
  
  failure_reason
  string
  Reason for action failure in case the action did not execute successfully
  
  user_id
  string
  An ID identifying the user performing the action. This field is required if you support multi-user interactions.
  
  gesture
  required
  string
  Human readable name of the gesture. Availability of gestures depends on the interaction system.
  
  Additional properties are allowed.
  Examples
  { "type": "GestureUserActionFinished", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "user_upper_body", "action_info_modality_policy": "override", "action_info_lifetime": "limited", "action_finished_at": "2019-08-24T14:15:22Z", "is_success": true, "was_stopped": true, "failure_reason": "string", "user_id": "string", "gesture": "string" }
  
  This example has been generated automatically.
- #20GestureUserActionStartedGestureUserActionStarted
  The interactive system detects the start of a user gesture. Note: the time the system detects the gesture might be different from when the user started to perform the gesture.
  application/json
  object
  type
  required
  string
  Allowed values:
  "GestureUserActionStarted"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "user_upper_body"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_started_at
  required
  string
  format: date-time
  The timestamp of when the action has started.
  
  user_id
  string
  An ID identifying the user performing the action. This field is required if you support multi-user interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "GestureUserActionStarted", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "user_upper_body", "action_info_modality_policy": "override", "action_info_lifetime": "limited", "action_started_at": "2019-08-24T14:15:22Z", "user_id": "string" }
  
  This example has been generated automatically.
- #21MotionEffectCameraActionFinishedMotionEffectCameraActionFinished
  Camera effect finished.
  application/json
  object
  type
  required
  string
  Allowed values:
  "MotionEffectCameraActionFinished"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "camera_motion_effect"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_finished_at
  required
  string
  format: date-time
  The timestamp of when the action has finished.
  
  is_success
  required
  boolean
  Did the action finish successfully
  
  was_stopped
  boolean
  Was the action stopped by a Stop event
  
  failure_reason
  string
  Reason for action failure in case the action did not execute successfully
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "MotionEffectCameraActionFinished", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "camera_motion_effect", "action_info_modality_policy": "override", "action_info_lifetime": "limited", "action_finished_at": "2019-08-24T14:15:22Z", "is_success": true, "was_stopped": true, "failure_reason": "string", "bot_id": "string" }
  
  This example has been generated automatically.
- #22MotionEffectCameraActionStartedMotionEffectCameraActionStarted
  Camera effect started.
  application/json
  object
  type
  required
  string
  Allowed values:
  "MotionEffectCameraActionStarted"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "camera_motion_effect"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_started_at
  required
  string
  format: date-time
  The timestamp of when the action has started.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "MotionEffectCameraActionStarted", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "camera_motion_effect", "action_info_modality_policy": "override", "action_info_lifetime": "limited", "action_started_at": "2019-08-24T14:15:22Z", "bot_id": "string" }
  
  This example has been generated automatically.
- #23PipelineUpdatedPipelineUpdated
  Information about an existing pipeline has been updated. This means that a new session was started or a new user has been identified as part of the same pipeline.
  application/json
  object
  type
  required
  string
  Allowed values:
  "PipelineUpdated"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  stream_uid
  required
  string
  A unique identifier for the stream
  
  session_uid
  string
  A unique identifier for the session
  
  user_uid
  string
  A unique identifier for the user
  
  Additional properties are allowed.
  Examples
  { "type": "PipelineUpdated", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "stream_uid": "string", "session_uid": "string", "user_uid": "string" }
  
  This example has been generated automatically.
- #24PositionBotActionFinishedPositionBotActionFinished
  The bot shifted back to the original position before this action. This might be a neutral position or the position of any PositionBotAction overwritten by this action that now gains the “focus”.
  application/json
  object
  type
  required
  string
  Allowed values:
  "PositionBotActionFinished"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_position"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_finished_at
  required
  string
  format: date-time
  The timestamp of when the action has finished.
  
  is_success
  required
  boolean
  Did the action finish successfully
  
  was_stopped
  boolean
  Was the action stopped by a Stop event
  
  failure_reason
  string
  Reason for action failure in case the action did not execute successfully
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "PositionBotActionFinished", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_position", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "action_finished_at": "2019-08-24T14:15:22Z", "is_success": true, "was_stopped": true, "failure_reason": "string", "bot_id": "string" }
  
  This example has been generated automatically.
- #25PositionBotActionStartedPositionBotActionStarted
  The bot has started to transition to the new position
  application/json
  object
  type
  required
  string
  Allowed values:
  "PositionBotActionStarted"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_position"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_started_at
  required
  string
  format: date-time
  The timestamp of when the action has started.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "PositionBotActionStarted", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_position", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "action_started_at": "2019-08-24T14:15:22Z", "bot_id": "string" }
  
  This example has been generated automatically.
- #26PositionBotActionUpdatedPositionBotActionUpdated
  The bot has arrived at the position and is maintaining that position for the entire action duration.
  application/json
  object
  type
  required
  string
  Allowed values:
  "PositionBotActionUpdated"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_position"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_updated_at
  required
  string
  format: date-time
  The timestamp of when the action has been updated.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  position_reached
  required
  string
  The position the bot has reached.
  
  Additional properties are allowed.
  Examples
  { "type": "PositionBotActionUpdated", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_position", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "action_updated_at": "2019-08-24T14:15:22Z", "bot_id": "string", "position_reached": "string" }
  
  This example has been generated automatically.
- #27PostureBotActionFinishedPostureBotActionFinished
  The posture was stopped.
  application/json
  object
  type
  required
  string
  Allowed values:
  "PostureBotActionFinished"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_posture"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_finished_at
  required
  string
  format: date-time
  The timestamp of when the action has finished.
  
  is_success
  required
  boolean
  Did the action finish successfully
  
  was_stopped
  boolean
  Was the action stopped by a Stop event
  
  failure_reason
  string
  Reason for action failure in case the action did not execute successfully
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "PostureBotActionFinished", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_posture", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "action_finished_at": "2019-08-24T14:15:22Z", "is_success": true, "was_stopped": true, "failure_reason": "string", "bot_id": "string" }
  
  This example has been generated automatically.
- #28PostureBotActionStartedPostureBotActionStarted
  The bot has attained the posture.
  application/json
  object
  type
  required
  string
  Allowed values:
  "PostureBotActionStarted"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_posture"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_started_at
  required
  string
  format: date-time
  The timestamp of when the action has started.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "PostureBotActionStarted", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_posture", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "action_started_at": "2019-08-24T14:15:22Z", "bot_id": "string" }
  
  This example has been generated automatically.
- #29PresenceUserActionFinishedPresenceUserActionFinished
  The interactive system detects the user's absence
  application/json
  object
  type
  required
  string
  Allowed values:
  "PresenceUserActionFinished"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "user_presence"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_finished_at
  required
  string
  format: date-time
  The timestamp of when the action has finished.
  
  is_success
  required
  boolean
  Did the action finish successfully
  
  was_stopped
  boolean
  Was the action stopped by a Stop event
  
  failure_reason
  string
  Reason for action failure in case the action did not execute successfully
  
  user_id
  string
  An ID identifying the user performing the action. This field is required if you support multi-user interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "PresenceUserActionFinished", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "user_presence", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "action_finished_at": "2019-08-24T14:15:22Z", "is_success": true, "was_stopped": true, "failure_reason": "string", "user_id": "string" }
  
  This example has been generated automatically.
- #30PresenceUserActionStartedPresenceUserActionStarted
  The interactive system detects the presence of a user in the system.
  application/json
  object
  type
  required
  string
  Allowed values:
  "PresenceUserActionStarted"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "user_presence"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_started_at
  required
  string
  format: date-time
  The timestamp of when the action has started.
  
  user_id
  string
  An ID identifying the user performing the action. This field is required if you support multi-user interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "PresenceUserActionStarted", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "user_presence", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "action_started_at": "2019-08-24T14:15:22Z", "user_id": "string" }
  
  This example has been generated automatically.
- #31RestApiCallBotActionFinishedRestApiCallBotActionFinished
  API call finished
  application/json
  object
  type
  required
  string
  Allowed values:
  "RestApiCallBotActionFinished"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "web_request"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_finished_at
  required
  string
  format: date-time
  The timestamp of when the action has finished.
  
  is_success
  required
  boolean
  Did the action finish successfully
  
  was_stopped
  boolean
  Was the action stopped by a Stop event
  
  failure_reason
  string
  Reason for action failure in case the action did not execute successfully
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  required
  object
  Response of call
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "type": "RestApiCallBotActionFinished", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "web_request", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "action_finished_at": "2019-08-24T14:15:22Z", "is_success": true, "was_stopped": true, "failure_reason": "string", "bot_id": "string", "response": {} }
  
  This example has been generated automatically.
- #32RestApiCallBotActionStartedRestApiCallBotActionStarted
  API call started
  application/json
  object
  type
  required
  string
  Allowed values:
  "RestApiCallBotActionStarted"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "web_request"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_started_at
  required
  string
  format: date-time
  The timestamp of when the action has started.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "RestApiCallBotActionStarted", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "web_request", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "action_started_at": "2019-08-24T14:15:22Z", "bot_id": "string" }
  
  This example has been generated automatically.
- #33ShotCameraActionFinishedShotCameraActionFinished
  The camera shot was stopped. The camera has returned to the shot it had before (either a neutral shot) or the shot specified by any overwritten ShotCameraAction actions.
  application/json
  object
  type
  required
  string
  Allowed values:
  "ShotCameraActionFinished"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "camera_shot"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_finished_at
  required
  string
  format: date-time
  The timestamp of when the action has finished.
  
  is_success
  required
  boolean
  Did the action finish successfully
  
  was_stopped
  boolean
  Was the action stopped by a Stop event
  
  failure_reason
  string
  Reason for action failure in case the action did not execute successfully
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "ShotCameraActionFinished", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "camera_shot", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "action_finished_at": "2019-08-24T14:15:22Z", "is_success": true, "was_stopped": true, "failure_reason": "string", "bot_id": "string" }
  
  This example has been generated automatically.
- #34ShotCameraActionStartedShotCameraActionStarted
  The camera shot started
  application/json
  object
  type
  required
  string
  Allowed values:
  "ShotCameraActionStarted"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "camera_shot"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_started_at
  required
  string
  format: date-time
  The timestamp of when the action has started.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "ShotCameraActionStarted", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "camera_shot", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "action_started_at": "2019-08-24T14:15:22Z", "bot_id": "string" }
  
  This example has been generated automatically.
- #35TimerBotActionFinishedTimerBotActionFinished
  Timer finished.
  application/json
  object
  type
  required
  string
  Allowed values:
  "TimerBotActionFinished"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "time"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_finished_at
  required
  string
  format: date-time
  The timestamp of when the action has finished.
  
  is_success
  required
  boolean
  Did the action finish successfully
  
  was_stopped
  boolean
  Was the action stopped by a Stop event
  
  failure_reason
  string
  Reason for action failure in case the action did not execute successfully
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "TimerBotActionFinished", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "time", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "action_finished_at": "2019-08-24T14:15:22Z", "is_success": true, "was_stopped": true, "failure_reason": "string", "bot_id": "string" }
  
  This example has been generated automatically.
- #36TimerBotActionStartedTimerBotActionStarted
  Timer started.
  application/json
  object
  type
  required
  string
  Allowed values:
  "TimerBotActionStarted"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "time"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_started_at
  required
  string
  format: date-time
  The timestamp of when the action has started.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "TimerBotActionStarted", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "time", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "action_started_at": "2019-08-24T14:15:22Z", "bot_id": "string" }
  
  This example has been generated automatically.
- #37UtteranceBotActionFinishedUtteranceBotActionFinished
  The bot utterance finished, either because the utterance has been delivered to the user or the action was stopped.
  application/json
  object
  type
  required
  string
  Allowed values:
  "UtteranceBotActionFinished"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_speech"
  action_info_modality_policy
  required
  string
  Allowed values:
  "replace"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_finished_at
  required
  string
  format: date-time
  The timestamp of when the action has finished.
  
  is_success
  required
  boolean
  Did the action finish successfully
  
  was_stopped
  boolean
  Was the action stopped by a Stop event
  
  failure_reason
  string
  Reason for action failure in case the action did not execute successfully
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  final_script
  required
  string
  Final transcript of the bot utterance
  
  Additional properties are allowed.
  Examples
  { "type": "UtteranceBotActionFinished", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_speech", "action_info_modality_policy": "replace", "action_info_lifetime": "limited", "action_finished_at": "2019-08-24T14:15:22Z", "is_success": true, "was_stopped": true, "failure_reason": "string", "bot_id": "string", "final_script": "string" }
  
  This example has been generated automatically.
- #38UtteranceBotActionScriptUpdatedUtteranceBotActionScriptUpdated
  Provides updated transcripts during a UtteranceBotAction. These events correspond to the time that a certain part of the utterance is delivered to the user. In a interactive system that supports voice output these events should align with when the user hears the partial transcript
  application/json
  object
  type
  required
  string
  Allowed values:
  "UtteranceBotActionScriptUpdated"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_speech"
  action_info_modality_policy
  required
  string
  Allowed values:
  "replace"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_updated_at
  required
  string
  format: date-time
  The timestamp of when the action has been updated.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  interim_script
  required
  string
  Partial script of the bot utterance up to this point in time
  
  Additional properties are allowed.
  Examples
  { "type": "UtteranceBotActionScriptUpdated", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_speech", "action_info_modality_policy": "replace", "action_info_lifetime": "limited", "action_updated_at": "2019-08-24T14:15:22Z", "bot_id": "string", "interim_script": "string" }
  
  This example has been generated automatically.
- #39UtteranceBotActionStartedUtteranceBotActionStarted
  The bot started to produce the utterance. This event should align as close as possible with the moment in time the user is receiving the utterance. For example in an Interactive Avatar system, the event is sent out by the Action Server once the text-to-speech (TTS) stream is sent to the user.
  application/json
  object
  type
  required
  string
  Allowed values:
  "UtteranceBotActionStarted"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_speech"
  action_info_modality_policy
  required
  string
  Allowed values:
  "replace"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_started_at
  required
  string
  format: date-time
  The timestamp of when the action has started.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "UtteranceBotActionStarted", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_speech", "action_info_modality_policy": "replace", "action_info_lifetime": "limited", "action_started_at": "2019-08-24T14:15:22Z", "bot_id": "string" }
  
  This example has been generated automatically.
- #40UtteranceUserActionFinishedUtteranceUserActionFinished
  The user utterance has finished.
  application/json
  object
  type
  required
  string
  Allowed values:
  "UtteranceUserActionFinished"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "user_speech"
  action_info_modality_policy
  required
  string
  Allowed values:
  "replace"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_finished_at
  required
  string
  format: date-time
  The timestamp of when the action has finished.
  
  is_success
  required
  boolean
  Did the action finish successfully
  
  was_stopped
  boolean
  Was the action stopped by a Stop event
  
  failure_reason
  string
  Reason for action failure in case the action did not execute successfully
  
  user_id
  string
  An ID identifying the user performing the action. This field is required if you support multi-user interactions.
  
  final_transcript
  required
  string
  Final transcript of the user utterance
  
  Additional properties are allowed.
  Examples
  { "type": "UtteranceUserActionFinished", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "user_speech", "action_info_modality_policy": "replace", "action_info_lifetime": "limited", "action_finished_at": "2019-08-24T14:15:22Z", "is_success": true, "was_stopped": true, "failure_reason": "string", "user_id": "string", "final_transcript": "string" }
  
  This example has been generated automatically.
- #41UtteranceUserActionIntensityUpdatedUtteranceUserActionIntensityUpdated
  Provides updated speaking intensity levels if the interactive system supports it.
  application/json
  object
  type
  required
  string
  Allowed values:
  "UtteranceUserActionIntensityUpdated"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "user_speech"
  action_info_modality_policy
  required
  string
  Allowed values:
  "replace"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_updated_at
  required
  string
  format: date-time
  The timestamp of when the action has been updated.
  
  user_id
  string
  An ID identifying the user performing the action. This field is required if you support multi-user interactions.
  
  intensity
  required
  number
  A value from 0-1 that indicates the intensity of the utterance. A value of 0.5 means an “average” intensity. The intensity of an utterance action can correspond to different metrics depending on the interactive system. For a chatbot system the intensity could relate to the typing rate. In a speech-enabled system intensity could be computed based on the volume and pitch variation of the user’s voice.
  
  Additional properties are allowed.
  Examples
  { "type": "UtteranceUserActionIntensityUpdated", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "user_speech", "action_info_modality_policy": "replace", "action_info_lifetime": "limited", "action_updated_at": "2019-08-24T14:15:22Z", "user_id": "string", "intensity": 0 }
  
  This example has been generated automatically.
- #42UtteranceUserActionStartedUtteranceUserActionStarted
  The user started to produce an utterance. The user could have started talking or typing for example.
  application/json
  object
  type
  required
  string
  Allowed values:
  "UtteranceUserActionStarted"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "user_speech"
  action_info_modality_policy
  required
  string
  Allowed values:
  "replace"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_started_at
  required
  string
  format: date-time
  The timestamp of when the action has started.
  
  user_id
  string
  An ID identifying the user performing the action. This field is required if you support multi-user interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "UtteranceUserActionStarted", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "user_speech", "action_info_modality_policy": "replace", "action_info_lifetime": "limited", "action_started_at": "2019-08-24T14:15:22Z", "user_id": "string" }
  
  This example has been generated automatically.
- #43UtteranceUserActionTranscriptUpdatedUtteranceUserActionTranscriptUpdated
  Provides updated transcripts during a UtteranceUserAction
  application/json
  object
  type
  required
  string
  Allowed values:
  "UtteranceUserActionTranscriptUpdated"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "user_speech"
  action_info_modality_policy
  required
  string
  Allowed values:
  "replace"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  action_updated_at
  required
  string
  format: date-time
  The timestamp of when the action has been updated.
  
  user_id
  string
  An ID identifying the user performing the action. This field is required if you support multi-user interactions.
  
  interim_transcript
  required
  string
  Partial transcript of the user utterance up to this point in time
  
  Additional properties are allowed.
  Examples
  { "type": "UtteranceUserActionTranscriptUpdated", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "user_speech", "action_info_modality_policy": "replace", "action_info_lifetime": "limited", "action_updated_at": "2019-08-24T14:15:22Z", "user_id": "string", "interim_transcript": "string" }
  
  This example has been generated automatically.
- #44VisualChoiceSceneActionChoiceUpdatedVisualChoiceSceneActionChoiceUpdated
  Whenever the user interacts directly with the choice presented in the scene but does not confirmed cancel the choice, a ChoiceUpdated event is sent out by the interactive system.
  application/json
  object
  type
  required
  string
  Allowed values:
  "VisualChoiceSceneActionChoiceUpdated"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "information"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_updated_at
  required
  string
  format: date-time
  The timestamp of when the action has been updated.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  required
  array<string>
  List of Option IDs if the user made a choice
  
  Items:
  string
  Additional properties are allowed.
  Examples
  { "type": "VisualChoiceSceneActionChoiceUpdated", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "information", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "action_updated_at": "2019-08-24T14:15:22Z", "bot_id": "string", "current_choice": [ "string" ] }
  
  This example has been generated automatically.
- #45VisualChoiceSceneActionConfirmationUpdatedVisualChoiceSceneActionConfirmationUpdated
  Whenever the user confirms or tries to abort the choice when interacting with the visual representation of the choice. Examples of this include: clicking a “confirm” button, “clicking on close”
  application/json
  object
  type
  required
  string
  Allowed values:
  "VisualChoiceSceneActionConfirmationUpdated"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "information"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_updated_at
  required
  string
  format: date-time
  The timestamp of when the action has been updated.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  required
  allOf
  Status of the choice confirmation by the user.
  
  Consists of:
  string
  uid: ConfirmationStatus
  An enumeration.
  
  Allowed values:
  "confirm"
  "cancel"
  "unknown"
  Additional properties are allowed.
  Examples
  { "type": "VisualChoiceSceneActionConfirmationUpdated", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "information", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "action_updated_at": "2019-08-24T14:15:22Z", "bot_id": "string", "confirmation_status": "confirm" }
  
  This example has been generated automatically.
- #46VisualChoiceSceneActionFinishedVisualChoiceSceneActionFinished
  The choice action was stopped by the IM. (no user action will cause the action to be finished by the Action Server).
  application/json
  object
  type
  required
  string
  Allowed values:
  "VisualChoiceSceneActionFinished"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "information"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_finished_at
  required
  string
  format: date-time
  The timestamp of when the action has finished.
  
  is_success
  required
  boolean
  Did the action finish successfully
  
  was_stopped
  boolean
  Was the action stopped by a Stop event
  
  failure_reason
  string
  Reason for action failure in case the action did not execute successfully
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  required
  array<string>
  List of options for the user to choose from
  
  Items:
  string
  Additional properties are allowed.
  Examples
  { "type": "VisualChoiceSceneActionFinished", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "information", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "action_finished_at": "2019-08-24T14:15:22Z", "is_success": true, "was_stopped": true, "failure_reason": "string", "bot_id": "string", "final_choice": [ "string" ] }
  
  This example has been generated automatically.
- #47VisualChoiceSceneActionStartedVisualChoiceSceneActionStarted
  The system has started presenting the choice to the user
  application/json
  object
  type
  required
  string
  Allowed values:
  "VisualChoiceSceneActionStarted"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "information"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_started_at
  required
  string
  format: date-time
  The timestamp of when the action has started.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "VisualChoiceSceneActionStarted", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "information", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "action_started_at": "2019-08-24T14:15:22Z", "bot_id": "string" }
  
  This example has been generated automatically.
- #48VisualFormSceneActionConfirmationUpdatedVisualFormSceneActionConfirmationUpdated
  Whenever the user confirms or tries to abort the form input when interacting with the visual representation of the form. Examples of this include: clicking a “confirm” button, “clicking on close”
  application/json
  object
  type
  required
  string
  Allowed values:
  "VisualFormSceneActionConfirmationUpdated"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "information"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_updated_at
  required
  string
  format: date-time
  The timestamp of when the action has been updated.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  required
  allOf
  Status of the form input confirmation by the user.
  
  Consists of:
  string
  uid: ConfirmationStatus
  An enumeration.
  
  Allowed values:
  "confirm"
  "cancel"
  "unknown"
  Additional properties are allowed.
  Examples
  { "type": "VisualFormSceneActionConfirmationUpdated", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "information", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "action_updated_at": "2019-08-24T14:15:22Z", "bot_id": "string", "confirmation_status": "confirm" }
  
  This example has been generated automatically.
- #49VisualFormSceneActionFinishedVisualFormSceneActionFinished
  Form action was stopped by the IM (no user action will cause the action to be finished by the Action Server).
  application/json
  object
  type
  required
  string
  Allowed values:
  "VisualFormSceneActionFinished"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "information"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_finished_at
  required
  string
  format: date-time
  The timestamp of when the action has finished.
  
  is_success
  required
  boolean
  Did the action finish successfully
  
  was_stopped
  boolean
  Was the action stopped by a Stop event
  
  failure_reason
  string
  Reason for action failure in case the action did not execute successfully
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  required
  array<object>
  Final state of all inputs.
  
  id
  required
  string
  value
  required
  string
  NLD of the type of input required
  
  description
  required
  string
  NLD of the type of input required
  
  Additional properties are allowed.
  Examples
  { "type": "VisualFormSceneActionFinished", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "information", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "action_finished_at": "2019-08-24T14:15:22Z", "is_success": true, "was_stopped": true, "failure_reason": "string", "bot_id": "string", "final_inputs": [ { "id": "string", "value": "string", "description": "string" } ] }
  
  This example has been generated automatically.
- #50VisualFormSceneActionInputUpdatedVisualFormSceneActionInputUpdated
  Whenever the user interacts directly with the form inputs presented in the scene but has not yet confirmed the input, an Updated action is sent out by the interactive system. This allows the IM to react to partial inputs, e.g. if a user is typing an e-mail address the bot can react to partial inputs (the bot could say "And now only the domain missing" after the user typed "@" in the form field).
  application/json
  object
  type
  required
  string
  Allowed values:
  "VisualFormSceneActionInputUpdated"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "information"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_updated_at
  required
  string
  format: date-time
  The timestamp of when the action has been updated.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  required
  array<object>
  Final state of all inputs.
  
  id
  required
  string
  value
  required
  string
  NLD of the type of input required
  
  description
  required
  string
  NLD of the type of input required
  
  Additional properties are allowed.
  Examples
  { "type": "VisualFormSceneActionInputUpdated", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "information", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "action_updated_at": "2019-08-24T14:15:22Z", "bot_id": "string", "interim_inputs": [ { "id": "string", "value": "string", "description": "string" } ] }
  
  This example has been generated automatically.
- #51VisualFormSceneActionStartedVisualFormSceneActionStarted
  The system has started presenting the the form to the user..
  application/json
  object
  type
  required
  string
  Allowed values:
  "VisualFormSceneActionStarted"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "information"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_started_at
  required
  string
  format: date-time
  The timestamp of when the action has started.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "VisualFormSceneActionStarted", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "information", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "action_started_at": "2019-08-24T14:15:22Z", "bot_id": "string" }
  
  This example has been generated automatically.
- #52VisualInformationSceneActionConfirmationUpdatedVisualInformationSceneActionConfirmationUpdated
  Whenever the user confirms or tries to abort the visual information shown in the screen. Examples of this include: clicking a “confirm” button, “clicking on close”
  application/json
  object
  type
  required
  string
  Allowed values:
  "VisualInformationSceneActionConfirmationUpdated"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "information"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_updated_at
  required
  string
  format: date-time
  The timestamp of when the action has been updated.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  required
  allOf
  Update on the confirmation status. User indicating to have understood or to cancel the visual information
  
  Consists of:
  string
  uid: ConfirmationStatus
  An enumeration.
  
  Allowed values:
  "confirm"
  "cancel"
  "unknown"
  Additional properties are allowed.
  Examples
  { "type": "VisualInformationSceneActionConfirmationUpdated", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "information", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "action_updated_at": "2019-08-24T14:15:22Z", "bot_id": "string", "confirmation_status": "confirm" }
  
  This example has been generated automatically.
- #53VisualInformationSceneActionFinishedVisualInformationSceneActionFinished
  Information action was stopped by the IM (no user action will cause the action to be finished by the Action Server).
  application/json
  object
  type
  required
  string
  Allowed values:
  "VisualInformationSceneActionFinished"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "information"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_finished_at
  required
  string
  format: date-time
  The timestamp of when the action has finished.
  
  is_success
  required
  boolean
  Did the action finish successfully
  
  was_stopped
  boolean
  Was the action stopped by a Stop event
  
  failure_reason
  string
  Reason for action failure in case the action did not execute successfully
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "VisualInformationSceneActionFinished", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "information", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "action_finished_at": "2019-08-24T14:15:22Z", "is_success": true, "was_stopped": true, "failure_reason": "string", "bot_id": "string" }
  
  This example has been generated automatically.
- #54VisualInformationSceneActionStartedVisualInformationSceneActionStarted
  The system has started presenting the information to the user..
  application/json
  object
  type
  required
  string
  Allowed values:
  "VisualInformationSceneActionStarted"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "information"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  action_started_at
  required
  string
  format: date-time
  The timestamp of when the action has started.
  
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "VisualInformationSceneActionStarted", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "information", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "action_started_at": "2019-08-24T14:15:22Z", "bot_id": "string" }
  
  This example has been generated automatically.
SUB umim_events{stream_uid}
UMIM event stream specific to a unique device stream.

stream_uid
required
string
uid: stream_uid
Unique identifier for the stream.
Accepts one of the following messages:
- #0BotIntentBotIntent
  The structured representation of the intent of the bot. This event should be generated by the IM if it communicates the current intent of the bot. A bot intent can lead to different multimodal expressions of that intent.
  application/json
  object
  type
  required
  string
  Allowed values:
  "BotIntent"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  intent
  required
  string
  Canonical form of the bot's intent
  
  Additional properties are allowed.
  Examples
  { "type": "BotIntent", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "intent": "string" }
  
  This example has been generated automatically.
- #1ChangeCustomBotActionChangeCustomBotAction
  Change parameters of the custom action (if supported by the custom action)
  application/json
  object
  type
  required
  string
  Allowed values:
  "ChangeCustomBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "custom"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  custom_action_name
  required
  string
  The name of the custom action.
  
  required
  object
  Any parameters for the action change.
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "type": "ChangeCustomBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "custom", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "bot_id": "string", "custom_action_name": "string", "parameters": {} }
  
  This example has been generated automatically.
- #2ChangeCustomUserActionChangeCustomUserAction
  The parameters of a running action needs to be changed. Updating running actions is useful for longer running actions (e.g. an avatar animation) which can adapt their behavior dynamically. For example, a nodding animation can change its speed depending on the voice activity level.
  application/json
  object
  type
  required
  string
  Allowed values:
  "ChangeCustomUserAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "custom"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  user_id
  string
  An ID identifying the user performing the action. This field is required if you support multi-user interactions.
  
  custom_action_name
  required
  string
  The name of the custom action.
  
  required
  object
  Any parameters for the action change.
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "type": "ChangeCustomUserAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "custom", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "user_id": "string", "custom_action_name": "string", "parameters": {} }
  
  This example has been generated automatically.
- #3ChangeTimerBotActionChangeTimerBotAction
  Change the duration of the timer. If the duration is reduced this can cause the timer to go off immediately (an TimerBotActionFinished event will be sent out).
  application/json
  object
  type
  required
  string
  Allowed values:
  "ChangeTimerBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "time"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  duration
  required
  number
  format: time-delta
  Change the duration of the Timer with respect to the event_created_at timestamp of this StartTimerAction event.
  
  Additional properties are allowed.
  Examples
  { "type": "ChangeTimerBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "time", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "bot_id": "string", "duration": 0 }
  
  This example has been generated automatically.
- #4ChangeUtteranceBotActionChangeUtteranceBotAction
  Adjusts the intended volume while the action has already been started.
  application/json
  object
  type
  required
  string
  Allowed values:
  "ChangeUtteranceBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_speech"
  action_info_modality_policy
  required
  string
  Allowed values:
  "replace"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  intensity
  required
  number
  A value from 0-1 that indicates the intensity of the utterance. A value of 0.5 means an “average” intensity. The intensity of an utterance action should change how the utterance is delivered to the user base on the type of interactive system For a chatbot system the intensity could relate to the typing rate in the UI. In a speech-enabled system intensity could change the volume and pitch variation of generated speech.
  
  Additional properties are allowed.
  Examples
  { "type": "ChangeUtteranceBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_speech", "action_info_modality_policy": "replace", "action_info_lifetime": "limited", "bot_id": "string", "intensity": 0 }
  
  This example has been generated automatically.
- #5ContextUpdateContextUpdate
  An update to the context. All specified keys will override the ones in the current context.
  application/json
  object
  type
  required
  string
  Allowed values:
  "ContextUpdate"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  required
  object
  Any contextual data that has changed.
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "type": "ContextUpdate", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "data": {} }
  
  This example has been generated automatically.
- #6CustomEventCustomEvent
  A custom event that can be used in addition to the standardized ones.
  application/json
  object
  type
  required
  string
  Allowed values:
  "CustomEvent"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  name
  required
  string
  Name of the custom event.
  
  required
  object
  Any data relevant for the event.
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "type": "CustomEvent", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "name": "string", "data": {} }
  
  This example has been generated automatically.
- #7PipelineAcquiredPipelineAcquired
  A new pipeline has been acquired. A pipeline connects the IM to end user devices (stream_uid). This event informs the IM in an event-based implementation about the availability of new pipelines.
  application/json
  object
  type
  required
  string
  Allowed values:
  "PipelineAcquired"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  stream_uid
  required
  string
  A unique identifier for the stream
  
  session_uid
  string
  A unique identifier for the session
  
  user_uid
  string
  A unique identifier for the user
  
  Additional properties are allowed.
  Examples
  { "type": "PipelineAcquired", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "stream_uid": "string", "session_uid": "string", "user_uid": "string" }
  
  This example has been generated automatically.
- #8PipelineReleasedPipelineReleased
  A pipeline has been released and is no longer available. A pipeline connects the IM to end user devices (stream_uid). This event informs the IM in an event-based implementation about pipelines that have been released.
  application/json
  object
  type
  required
  string
  Allowed values:
  "PipelineReleased"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  stream_uid
  required
  string
  A unique identifier for the stream
  
  session_uid
  string
  A unique identifier for the session
  
  user_uid
  string
  A unique identifier for the user
  
  Additional properties are allowed.
  Examples
  { "type": "PipelineReleased", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "stream_uid": "string", "session_uid": "string", "user_uid": "string" }
  
  This example has been generated automatically.
- #9StartCustomBotActionStartCustomBotAction
  Event to start an action. All other actions that can be started inherit from this base spec. The action_uid is used to differentiate between multiple runs of the same action.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StartCustomBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "custom"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  custom_action_name
  required
  string
  The name of the custom action.
  
  required
  object
  Any parameters for the action.
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "type": "StartCustomBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "custom", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "bot_id": "string", "custom_action_name": "string", "parameters": {} }
  
  This example has been generated automatically.
- #10StartExpectationBotActionStartExpectationBotAction
  The bot expects a certain event on the UMIM event bus in the near future. This optional event can allow the Action Servers to optimize their functions. As an example a AS responsible for processing camera frames can enable / disable certain vision algorithms depending on what the IM is expecting (e.g. BotExpectation(event=PositionChangeUserActionStarted) can allow the AS to start a computationally more expensive motion tracker for better resolution/accuracy.)
  application/json
  object
  type
  required
  string
  Allowed values:
  "StartExpectationBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_expectation"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  required
  oneOf
  Adheres to:
  any
  Or to:
  any
  Or to:
  any
  Or to:
  any
  Or to:
  any
  Or to:
  any
  Or to:
  any
  Or to:
  any
  Or to:
  any
  Or to:
  any
  Additional properties are allowed.
  Examples
  { "type": "StartExpectationBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_expectation", "action_info_modality_policy": "parallel", "action_info_lifetime": "indefinite", "bot_id": "string", "expected_event": {} }
  
  This example has been generated automatically.
- #11StartExpectationSignalingBotActionStartExpectationSignalingBotAction
  The bot is waiting for an event for a specific modality.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StartExpectationSignalingBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_expectation"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  modality
  required
  string
  uid: ActionModality
  An enumeration.
  
  Allowed values:
  "bot_speech"
  "bot_posture"
  "bot_gesture"
  "user_speech"
  "bot_face"
  "bot_upper_body"
  "bot_position"
  "user_face"
  "user_upper_body"
  "user_lower_body"
  "user_engagement"
  "sound"
  "environment"
  "camera_shot"
  "camera_motion_effect"
  "information"
  "visual_effect"
  "user_presence"
  "bot_active_waiting"
  "bot_expectation"
  "custom"
  "time"
  "web_request"
  Additional properties are allowed.
  Examples
  { "type": "StartExpectationSignalingBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_expectation", "action_info_modality_policy": "parallel", "action_info_lifetime": "indefinite", "bot_id": "string", "modality": "bot_speech" }
  
  This example has been generated automatically.
- #12StartFacialGestureBotActionStartFacialGestureBotAction
  The bot should start making a facial gesture.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StartFacialGestureBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_face"
  action_info_modality_policy
  required
  string
  Allowed values:
  "replace"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  facial_gesture
  required
  string
  Natural language description (NLD) of the facial gesture or expression. Availability of facial gestures depends on the interactive system.
  
  Minimal NLD set: The following gestures should be supported by every interactive system implementing this action: smile, lough, frown, wink
  
  Additional properties are allowed.
  Examples
  { "type": "StartFacialGestureBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_face", "action_info_modality_policy": "replace", "action_info_lifetime": "limited", "bot_id": "string", "facial_gesture": "string" }
  
  This example has been generated automatically.
- #13StartGestureBotActionStartGestureBotAction
  The bot should start making a specific gesture.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StartGestureBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_gesture"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  gesture
  required
  string
  Natural language description (NLD) of the gesture. Availability of gestures depends on the interaction system. If a system supports this action, the following base gestures need to be supported: affirm, negate, attract
  
  Additional properties are allowed.
  Examples
  { "type": "StartGestureBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_gesture", "action_info_modality_policy": "override", "action_info_lifetime": "limited", "bot_id": "string", "gesture": "string" }
  
  This example has been generated automatically.
- #14StartMotionEffectCameraActionStartMotionEffectCameraAction
  Perform the described camera motion effect.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StartMotionEffectCameraAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "camera_motion_effect"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  effect
  required
  string
  Natural language description (NLD) of the effect. Availability of effects depends on the interactive system.
  
  Minimal NLD set: The following camera effects should be supported by every interactive system implementing this action: shake, jump cut in, jump cut out
  
  Additional properties are allowed.
  Examples
  { "type": "StartMotionEffectCameraAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "camera_motion_effect", "action_info_modality_policy": "override", "action_info_lifetime": "limited", "bot_id": "string", "effect": "string" }
  
  This example has been generated automatically.
- #15StartPositionBotActionStartPositionBotAction
  The bot needs to hold a new position.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StartPositionBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_position"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  position
  required
  string
  Specify the position the bot needs to move to and maintain. Availability of positions depends on the interactive system. Positions are typically structured hierarchically into base position and position modifiers (“off center”).
  
  Minimal NLD set: The following base positions are supported by all interactive systems (that support this action): center : Default position of the bot left : Bot should be positioned to the left (from the point of view of the bot) right: Bot should be positioned to the right (from the point of view of the bot)
  
  Additional properties are allowed.
  Examples
  { "type": "StartPositionBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_position", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "bot_id": "string", "position": "string" }
  
  This example has been generated automatically.
- #16StartPostureBotActionStartPostureBotAction
  The bot should start adopting the specified posture.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StartPostureBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_posture"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  posture
  required
  string
  Natural language description (NLD) of the posture. The availability of postures depends on the interaction system. Postures should be expressed hierarchically such that interactive systems that provide less nuanced postures can fall back onto higher level postures. The following base postures need to be supported by all interactive systems supporting this action.: “idle”, “attentive”
  
  Additional properties are allowed.
  Examples
  { "type": "StartPostureBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_posture", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "bot_id": "string", "posture": "string" }
  
  This example has been generated automatically.
- #17StartRestApiCallBotActionStartRestApiCallBotAction
  Start an API call.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StartRestApiCallBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "web_request"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  required
  allOf
  Request type
  
  Consists of:
  string
  uid: RequestType
  Request Type
  
  Allowed values:
  "get"
  "post"
  "put"
  url
  required
  string
  REST API endpoint
  
  object
  Custom headers
  
  Additional properties are allowed.
  object
  Dict that will be converted to JSON and Content-Type header set to application/json
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "type": "StartRestApiCallBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "web_request", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "bot_id": "string", "request_type": "get", "url": "string", "headers": {}, "payload": {} }
  
  This example has been generated automatically.
- #18StartShotCameraActionStartShotCameraAction
  Start a new shot.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StartShotCameraAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "camera_shot"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  shot
  required
  string
  Natural language description (NLD) of the shot. Availability of shots depends on the interactive system.
  
  Minimal NLD set: The following shots should be supported by every interactive system implementing this action: full, medium, close-up
  
  start_transition
  required
  string
  NLD of the transition to the new shot. This should describe the movement.
  
  Minimal NLD set: The following shots should be supported by every interactive system implementing this action: cut, dolly
  
  Additional properties are allowed.
  Examples
  { "type": "StartShotCameraAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "camera_shot", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "bot_id": "string", "shot": "string", "start_transition": "string" }
  
  This example has been generated automatically.
- #19StartTimerBotActionStartTimerBotAction
  Start a timer.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StartTimerBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "time"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  duration
  required
  number
  format: time-delta
  Time duration with respect to the event_created_at timestamp of this StartTimerAction event. When the duration has passed the timer goes off (TimerBotActionFinished is sent out).
  
  timer_name
  string
  Name for the timer
  
  Additional properties are allowed.
  Examples
  { "type": "StartTimerBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "time", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "bot_id": "string", "duration": 0, "timer_name": "string" }
  
  This example has been generated automatically.
- #20StartUtteranceBotActionStartUtteranceBotAction
  The bot should start to produce an utterance. Depending on the interactive system this could be a bot sending a text message or an avatar talking to the user.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StartUtteranceBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_speech"
  action_info_modality_policy
  required
  string
  Allowed values:
  "replace"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  script
  required
  string
  The utterance of the bot, supporting SSML
  
  intensity
  number
  A value from 0-1 that indicates the intensity of the utterance. A value of 0.5 means an “average” intensity. The intensity of an utterance action should change how the utterance is delivered to the user base on the type of interactive system For a chatbot system the intensity could relate to the typing rate in the UI. In a speech-enabled system intensity could change the volume and pitch variation of generated speech.
  
  Additional properties are allowed.
  Examples
  { "type": "StartUtteranceBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_speech", "action_info_modality_policy": "replace", "action_info_lifetime": "limited", "bot_id": "string", "script": "string", "intensity": 0 }
  
  This example has been generated automatically.
- #21StartVisualChoiceSceneActionStartVisualChoiceSceneAction
  Present a choice in the scene to the user.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StartVisualChoiceSceneAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "information"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  prompt
  required
  string
  Describes the choice you are offering to the user
  
  image
  string
  Description of an image that should be shown alongside the choice.
  
  array<string>
  List of prompts supporting the user in making a choice
  
  Items:
  string
  required
  array<object>
  List of options for the user to choose from
  
  id
  required
  string
  ID of the option
  
  text
  string
  Text to represent the option
  
  image
  string
  NLD of image
  
  required
  allOf
  Configures the type of choice the user can make.
  
  Consists of:
  string
  uid: ChoiceType
  An enumeration.
  
  Allowed values:
  "selection"
  "search"
  allow_multiple_choices
  required
  boolean
  Indicate if the user should be able to select multiple choices from the presented options
  
  Additional properties are allowed.
  Examples
  { "type": "StartVisualChoiceSceneAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "information", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "bot_id": "string", "prompt": "string", "image": "string", "support_prompts": [ "string" ], "options": [ { "id": "string", "text": "string", "image": "string" } ], "choice_type": "selection", "allow_multiple_choices": true }
  
  This example has been generated automatically.
- #22StartVisualFormSceneActionStartVisualFormSceneAction
  Present a visual form that is requesting certain inputs from the user in the scene to the user.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StartVisualFormSceneAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "information"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  prompt
  required
  string
  Describes the inputs you are requesting from the user
  
  image
  string
  Description of an image that should be shown alongside the prompt.
  
  array<string>
  List of prompts supporting the user in making a choice
  
  Items:
  string
  required
  array<object>
  List of inputs required.
  
  id
  required
  string
  value
  required
  string
  NLD of the type of input required
  
  description
  required
  string
  NLD of the type of input required
  
  Additional properties are allowed.
  Examples
  { "type": "StartVisualFormSceneAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "information", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "bot_id": "string", "prompt": "string", "image": "string", "support_prompts": [ "string" ], "inputs": [ { "id": "string", "value": "string", "description": "string" } ] }
  
  This example has been generated automatically.
- #23StartVisualInformationSceneActionStartVisualInformationSceneAction
  Present information in the scene to the user.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StartVisualInformationSceneAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "information"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  title
  required
  string
  Describes the choice you are offering to the user
  
  summary
  string
  Summary of the information to be shown to the user
  
  array<string>
  List of prompts supporting the user in making a choice
  
  Items:
  string
  required
  array<object>
  List of options for the user to choose from
  
  text
  string
  Text to represent the option
  
  image
  string
  NLD of image
  
  Additional properties are allowed.
  Examples
  { "type": "StartVisualInformationSceneAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "information", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "bot_id": "string", "title": "string", "summary": "string", "support_prompts": [ "string" ], "content": [ { "text": "string", "image": "string" } ] }
  
  This example has been generated automatically.
- #24StopCustomBotActionStopCustomBotAction
  An action needs to be stopped.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StopCustomBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "custom"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  custom_action_name
  required
  string
  The name of the custom action.
  
  required
  object
  Any parameters for the action.
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "type": "StopCustomBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "custom", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "bot_id": "string", "custom_action_name": "string", "parameters": {} }
  
  This example has been generated automatically.
- #25StopExpectationBotActionStopExpectationBotAction
  The IM communicates that it stopped its expectations. This normally happens when the expectation has been met (e.g. the event has been received) or something else happened to change the course of the interaction.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StopExpectationBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_expectation"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "StopExpectationBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_expectation", "action_info_modality_policy": "parallel", "action_info_lifetime": "indefinite", "bot_id": "string" }
  
  This example has been generated automatically.
- #26StopExpectationSignalingBotActionStopExpectationSignalingBotAction
  Stop waiting for an event on the modality.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StopExpectationSignalingBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_expectation"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "StopExpectationSignalingBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_expectation", "action_info_modality_policy": "parallel", "action_info_lifetime": "indefinite", "bot_id": "string" }
  
  This example has been generated automatically.
- #27StopFacialGestureBotActionStopFacialGestureBotAction
  Stop the facial gesture or expression. All gestures have a limited lifetime and finish on “their own” (e.g., in an interactive avatar system a “smile” gesture could be implemented by a 1 second animation clip where some facial bones are animated). The IM can use this action to stop an expression before it would be naturally done.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StopFacialGestureBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_face"
  action_info_modality_policy
  required
  string
  Allowed values:
  "replace"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "StopFacialGestureBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_face", "action_info_modality_policy": "replace", "action_info_lifetime": "limited", "bot_id": "string" }
  
  This example has been generated automatically.
- #28StopGestureBotActionStopGestureBotAction
  Stop the gesture. All gestures have a limited lifetime and finish on 'their own'. Gesture are meant to accentuate a certain situation or statement. For example, in an interactive avatar system a `affirm` gesture could be implemented by a 1 second animation clip where the avatar nods twice. The IM can use this action to stop a gesture before it would be naturally done.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StopGestureBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_gesture"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "StopGestureBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_gesture", "action_info_modality_policy": "override", "action_info_lifetime": "limited", "bot_id": "string" }
  
  This example has been generated automatically.
- #29StopMotionEffectCameraActionStopMotionEffectCameraAction
  Stop the camera effect . All effects have a limited lifetime and finish “on their own” (e.g., in an interactive avatar system a “shake” effect could be implemented by a 1 second camera motion). The IM can use this action to stop a camera effect before it would be naturally done.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StopMotionEffectCameraAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "camera_motion_effect"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "StopMotionEffectCameraAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "camera_motion_effect", "action_info_modality_policy": "override", "action_info_lifetime": "limited", "bot_id": "string" }
  
  This example has been generated automatically.
- #30StopPositionBotActionStopPositionBotAction
  Stop holding the position. The bot will return to the position it had before the call. Position holding actions have an infinite lifetime, so unless the IM calls the Stop action the bot maintains the position indefinitely. Alternatively PositionBotAction actions can be overwritten, since the modality policy is Override.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StopPositionBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_position"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "StopPositionBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_position", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "bot_id": "string" }
  
  This example has been generated automatically.
- #31StopPostureBotActionStopPostureBotAction
  Stop the posture. Postures have no lifetime, so unless the IM calls the Stop action the bot will keep the posture indefinitely.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StopPostureBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_posture"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "StopPostureBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_posture", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "bot_id": "string" }
  
  This example has been generated automatically.
- #32StopShotCameraActionStopShotCameraAction
  Stop the camera shot. The camera will return to the shot it had before this action was started. ShotCameraAction actions have an infinite lifetime, so unless the IM calls the Stop action the camera maintains the shot indefinitely.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StopShotCameraAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "camera_shot"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  stop_transition
  required
  string
  NLD of the transition back to the previous shot (override modality). This should describe the movement.
  
  Minimal NLD set: The following shots should be supported by every interactive system implementing this action: cut, dolly
  
  Additional properties are allowed.
  Examples
  { "type": "StopShotCameraAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "camera_shot", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "bot_id": "string", "stop_transition": "string" }
  
  This example has been generated automatically.
- #33StopTimerBotActionStopTimerBotAction
  Stop the timer.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StopTimerBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "time"
  action_info_modality_policy
  required
  string
  Allowed values:
  "parallel"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "StopTimerBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "time", "action_info_modality_policy": "parallel", "action_info_lifetime": "limited", "bot_id": "string" }
  
  This example has been generated automatically.
- #34StopUtteranceBotActionStopUtteranceBotAction
  Stops the bot utterance.The action is stopped only once the UtteranceBotActionFinished has been received. For interactive systems that do not support this event, the action will continue to run normally until finished. The interaction manager is expected to handle arbitrary delays between the time stopping the utterance and the time the utterance actually finished.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StopUtteranceBotAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "bot_speech"
  action_info_modality_policy
  required
  string
  Allowed values:
  "replace"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "StopUtteranceBotAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "bot_speech", "action_info_modality_policy": "replace", "action_info_lifetime": "limited", "bot_id": "string" }
  
  This example has been generated automatically.
- #35StopUtteranceUserActionStopUtteranceUserAction
  Indicate that the IM has received the information needed and that the Action Server should consider the Utterance as finished as soon as possible. This could for example instruct the Action Server to decrease the hold time (duration of silence in the user speech until we consider the end of speech has been reached.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StopUtteranceUserAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "user_speech"
  action_info_modality_policy
  required
  string
  Allowed values:
  "replace"
  action_info_lifetime
  string
  Allowed values:
  "limited"
  user_id
  string
  An ID identifying the user performing the action. This field is required if you support multi-user interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "StopUtteranceUserAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "user_speech", "action_info_modality_policy": "replace", "action_info_lifetime": "limited", "user_id": "string" }
  
  This example has been generated automatically.
- #36StopVisualChoiceSceneActionStopVisualChoiceSceneAction
  Stop presenting the choice to the user.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StopVisualChoiceSceneAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "information"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "StopVisualChoiceSceneAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "information", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "bot_id": "string" }
  
  This example has been generated automatically.
- #37StopVisualFormSceneActionStopVisualFormSceneAction
  Stop presenting the form to the user.
  application/json
  object
  type
  required
  string
  Allowed values:
  "StopVisualFormSceneAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "information"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "StopVisualFormSceneAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "information", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "bot_id": "string" }
  
  This example has been generated automatically.
- #38StopVisualInformationSceneActionStopVisualInformationSceneAction
  Stop presenting the information to the user
  application/json
  object
  type
  required
  string
  Allowed values:
  "StopVisualInformationSceneAction"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  action_uid
  required
  string
  A unique id for the action.
  
  action_info_modality
  required
  string
  Allowed values:
  "information"
  action_info_modality_policy
  required
  string
  Allowed values:
  "override"
  action_info_lifetime
  string
  Allowed values:
  "indefinite"
  bot_id
  string
  An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.
  
  Additional properties are allowed.
  Examples
  { "type": "StopVisualInformationSceneAction", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "action_uid": "string", "action_info_modality": "information", "action_info_modality_policy": "override", "action_info_lifetime": "indefinite", "bot_id": "string" }
  
  This example has been generated automatically.
- #39UserIntentUserIntent
  The structured representation of the intent of the user. This event should be generated by the IM when it has inferred a user's intent. A user intent can be inferred based on verbal or non-verbal communication of the user.
  application/json
  object
  type
  required
  string
  Allowed values:
  "UserIntent"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  intent
  required
  string
  Canonical form of the user's intent
  
  Additional properties are allowed.
  Examples
  { "type": "UserIntent", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "intent": "string" }
  
  This example has been generated automatically.
- #40UserMovementUserMovement
  A specific user movement was detected.
  application/json
  object
  type
  required
  string
  Allowed values:
  "UserMovement"
  uid
  required
  string
  A unique identifier for the event.
  
  event_created_at
  required
  string
  format: date-time
  The timestamp of when the event was created.
  
  source_uid
  required
  string
  A unique id of the source component that generated the event.
  
  object
  A list of key-value pairs associated with the event.Tags are propagated from input events to output events.
  
  Additional properties are allowed.
  movement
  required
  string
  e.g. 'move', 'lean', 'blink', 'point to', 'nod', 'shake head'
  
  required
  object
  Specific movement parameters.
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "type": "UserMovement", "uid": "string", "event_created_at": "2019-08-24T14:15:22Z", "source_uid": "string", "tags": {}, "movement": "string", "parameters": {} }
  
  This example has been generated automatically.

Messages

#1AttentionUserActionFinishedAttentionUserActionFinished
The system detects the user to be disengaged with the interactive system.
- application/json
object
type
required
string
Allowed values:
"AttentionUserActionFinished"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"user_engagement"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
action_finished_at
required
string
format: date-time
The timestamp of when the action has finished.

is_success
required
boolean
Did the action finish successfully

was_stopped
boolean
Was the action stopped by a Stop event

failure_reason
string
Reason for action failure in case the action did not execute successfully

user_id
string
An ID identifying the user performing the action. This field is required if you support multi-user interactions.

Additional properties are allowed.
#2AttentionUserActionStartedAttentionUserActionStarted
The interactive system detects some level of engagement of the user.
- application/json
object
type
required
string
Allowed values:
"AttentionUserActionStarted"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"user_engagement"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
action_started_at
required
string
format: date-time
The timestamp of when the action has started.

user_id
string
An ID identifying the user performing the action. This field is required if you support multi-user interactions.

attention_level
number
Optional. Float in the range (0,1] (not including 0). Indicates the estimated attention level. The level should represent a statistic for the measured attention of the user. Depending on the interactive system this could for example be the mean engagement level over a sliding window.

Additional properties are allowed.
#3AttentionUserActionUpdatedAttentionUserActionUpdated
The interactive system provides an update to the engagement level.
- application/json
object
type
required
string
Allowed values:
"AttentionUserActionUpdated"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"user_engagement"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
action_updated_at
required
string
format: date-time
The timestamp of when the action has been updated.

user_id
string
An ID identifying the user performing the action. This field is required if you support multi-user interactions.

attention_level
number
Optional. Float in the range (0,1] (not including 0). Indicates the estimated attention level.

Additional properties are allowed.
#4BotIntentBotIntent
The structured representation of the intent of the bot. This event should be generated by the IM if it communicates the current intent of the bot. A bot intent can lead to different multimodal expressions of that intent.
- application/json
object
type
required
string
Allowed values:
"BotIntent"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
intent
required
string
Canonical form of the bot's intent

Additional properties are allowed.
#5ChangeCustomBotActionChangeCustomBotAction
Change parameters of the custom action (if supported by the custom action)
- application/json
object
type
required
string
Allowed values:
"ChangeCustomBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"custom"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

custom_action_name
required
string
The name of the custom action.

required
object
Any parameters for the action change.

Additional properties are allowed.
Additional properties are allowed.
#6ChangeCustomUserActionChangeCustomUserAction
The parameters of a running action needs to be changed. Updating running actions is useful for longer running actions (e.g. an avatar animation) which can adapt their behavior dynamically. For example, a nodding animation can change its speed depending on the voice activity level.
- application/json
object
type
required
string
Allowed values:
"ChangeCustomUserAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"custom"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
user_id
string
An ID identifying the user performing the action. This field is required if you support multi-user interactions.

custom_action_name
required
string
The name of the custom action.

required
object
Any parameters for the action change.

Additional properties are allowed.
Additional properties are allowed.
#7ChangeTimerBotActionChangeTimerBotAction
Change the duration of the timer. If the duration is reduced this can cause the timer to go off immediately (an TimerBotActionFinished event will be sent out).
- application/json
object
type
required
string
Allowed values:
"ChangeTimerBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"time"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

duration
required
number
format: time-delta
Change the duration of the Timer with respect to the event_created_at timestamp of this StartTimerAction event.

Additional properties are allowed.
#8ChangeUtteranceBotActionChangeUtteranceBotAction
Adjusts the intended volume while the action has already been started.
- application/json
object
type
required
string
Allowed values:
"ChangeUtteranceBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_speech"
action_info_modality_policy
required
string
Allowed values:
"replace"
action_info_lifetime
string
Allowed values:
"limited"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

intensity
required
number
A value from 0-1 that indicates the intensity of the utterance. A value of 0.5 means an “average” intensity. The intensity of an utterance action should change how the utterance is delivered to the user base on the type of interactive system For a chatbot system the intensity could relate to the typing rate in the UI. In a speech-enabled system intensity could change the volume and pitch variation of generated speech.

Additional properties are allowed.
#9ContextUpdateContextUpdate
An update to the context. All specified keys will override the ones in the current context.
- application/json
object
type
required
string
Allowed values:
"ContextUpdate"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
required
object
Any contextual data that has changed.

Additional properties are allowed.
Additional properties are allowed.
#10CustomBotActionFinishedCustomBotActionFinished
The custom action has finished its execution.
- application/json
object
type
required
string
Allowed values:
"CustomBotActionFinished"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"custom"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
action_finished_at
required
string
format: date-time
The timestamp of when the action has finished.

is_success
required
boolean
Did the action finish successfully

was_stopped
boolean
Was the action stopped by a Stop event

failure_reason
string
Reason for action failure in case the action did not execute successfully

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

custom_action_name
required
string
The name of the custom action.

required
object
Any results from the action.

Additional properties are allowed.
Additional properties are allowed.
#11CustomBotActionStartedCustomBotActionStarted
The execution of the custom user action has started.
- application/json
object
type
required
string
Allowed values:
"CustomBotActionStarted"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"custom"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
action_started_at
required
string
format: date-time
The timestamp of when the action has started.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

custom_action_name
required
string
The name of the custom action.

required
object
Any parameters for the action.

Additional properties are allowed.
Additional properties are allowed.
#12CustomBotActionUpdatedCustomBotActionUpdated
Something happened during the execution of the custom action (if supported by the custom action).
- application/json
object
type
required
string
Allowed values:
"CustomBotActionUpdated"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"custom"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
action_updated_at
required
string
format: date-time
The timestamp of when the action has been updated.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

custom_action_name
required
string
The name of the custom action.

required
object
Any updates from the action.

Additional properties are allowed.
Additional properties are allowed.
#13CustomEventCustomEvent
A custom event that can be used in addition to the standardized ones.
- application/json
object
type
required
string
Allowed values:
"CustomEvent"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
name
required
string
Name of the custom event.

required
object
Any data relevant for the event.

Additional properties are allowed.
Additional properties are allowed.
#14CustomUserActionFinishedCustomUserActionFinished
An action has finished its execution. An action can finish either because the action has completed or failed (natural completion) or it can finish because it was stopped by the IM. The success (or failure) of the execution is marked using the status_code attribute.
- application/json
object
type
required
string
Allowed values:
"CustomUserActionFinished"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"custom"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
action_finished_at
required
string
format: date-time
The timestamp of when the action has finished.

is_success
required
boolean
Did the action finish successfully

was_stopped
boolean
Was the action stopped by a Stop event

failure_reason
string
Reason for action failure in case the action did not execute successfully

user_id
string
An ID identifying the user performing the action. This field is required if you support multi-user interactions.

custom_action_name
required
string
The name of the custom action.

required
object
Any results from the action.

Additional properties are allowed.
Additional properties are allowed.
#15CustomUserActionStartedCustomUserActionStarted
The execution of the custom user action has started.
- application/json
object
type
required
string
Allowed values:
"CustomUserActionStarted"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"custom"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
action_started_at
required
string
format: date-time
The timestamp of when the action has started.

user_id
string
An ID identifying the user performing the action. This field is required if you support multi-user interactions.

custom_action_name
required
string
The name of the custom action.

required
object
Any parameters for the action.

Additional properties are allowed.
Additional properties are allowed.
#16CustomUserActionUpdatedCustomUserActionUpdated
A running action provides a (partial) result. Ongoing actions can provide partial updates on the current status of the action. An ActionUpdated should always update the payload of the action object and provide the type of update.
- application/json
object
type
required
string
Allowed values:
"CustomUserActionUpdated"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"custom"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
action_updated_at
required
string
format: date-time
The timestamp of when the action has been updated.

user_id
string
An ID identifying the user performing the action. This field is required if you support multi-user interactions.

custom_action_name
required
string
The name of the custom action.

required
object
Any updates from the action.

Additional properties are allowed.
Additional properties are allowed.
#17ExpectationBotActionFinishedExpectationBotActionFinished
The interactive system acknowledges that the bot expectation is finished.
- application/json
object
type
required
string
Allowed values:
"ExpectationBotActionFinished"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_expectation"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"indefinite"
action_finished_at
required
string
format: date-time
The timestamp of when the action has finished.

is_success
required
boolean
Did the action finish successfully

was_stopped
boolean
Was the action stopped by a Stop event

failure_reason
string
Reason for action failure in case the action did not execute successfully

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#18ExpectationBotActionStartedExpectationBotActionStarted
The interactive system communicates to the IM that it is able to handle the expectation for the specified events. In case the system is able to handle the expectation it has to send out the ExpectationBotActionStarted event. Receiving the ActionStarted event does not come with any guarantees on how the expectation is handled, but it provides the IM with a way to know if the system is even capable of handling expectations. For expectations for events that are not supported by any Action Server in the interactive system, no ExpectationBotActionStarted event will be sent out. If a system is not capable of handling certain bot expectations the IM might stop communicating them.
- application/json
object
type
required
string
Allowed values:
"ExpectationBotActionStarted"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_expectation"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"indefinite"
action_started_at
required
string
format: date-time
The timestamp of when the action has started.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#19ExpectationSignalingBotActionFinishedExpectationSignalingBotActionFinished
Bot has stopped actively waiting. Note that this action is only stopped on explicit request, by calling the sending the StopExpectationSignalingBotAction . Otherwise the action will continue indefinitely.
- application/json
object
type
required
string
Allowed values:
"ExpectationSignalingBotActionFinished "
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_expectation"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"indefinite"
action_finished_at
required
string
format: date-time
The timestamp of when the action has finished.

is_success
required
boolean
Did the action finish successfully

was_stopped
boolean
Was the action stopped by a Stop event

failure_reason
string
Reason for action failure in case the action did not execute successfully

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#20ExpectationSignalingBotActionStartedExpectationSignalingBotActionStarted
The bot has started actively waiting for an event on the specified modality.
- application/json
object
type
required
string
Allowed values:
"ExpectationSignalingBotActionStarted"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_expectation"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"indefinite"
action_started_at
required
string
format: date-time
The timestamp of when the action has started.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#21FacialGestureBotActionFinishedFacialGestureBotActionFinished
The facial gesture was performed.
- application/json
object
type
required
string
Allowed values:
"FacialGestureBotActionFinished"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_face"
action_info_modality_policy
required
string
Allowed values:
"replace"
action_info_lifetime
string
Allowed values:
"limited"
action_finished_at
required
string
format: date-time
The timestamp of when the action has finished.

is_success
required
boolean
Did the action finish successfully

was_stopped
boolean
Was the action stopped by a Stop event

failure_reason
string
Reason for action failure in case the action did not execute successfully

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#22FacialGestureBotActionStartedFacialGestureBotActionStarted
The bot has started to perform the facial gesture
- application/json
object
type
required
string
Allowed values:
"FacialGestureBotActionStarted"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_face"
action_info_modality_policy
required
string
Allowed values:
"replace"
action_info_lifetime
string
Allowed values:
"limited"
action_started_at
required
string
format: date-time
The timestamp of when the action has started.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#23FacialGestureUserActionFinishedFacialGestureUserActionFinished
An action has finished its execution. An action can finish either because the action has completed or failed (natural completion) or it can finish because it was stopped by the IM. The success (or failure) of the execution is marked using the status_code attribute.
- application/json
object
type
required
string
Allowed values:
"FacialGestureUserActionFinished"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"user_face"
action_info_modality_policy
required
string
Allowed values:
"replace"
action_info_lifetime
string
Allowed values:
"indefinite"
action_finished_at
required
string
format: date-time
The timestamp of when the action has finished.

is_success
required
boolean
Did the action finish successfully

was_stopped
boolean
Was the action stopped by a Stop event

failure_reason
string
Reason for action failure in case the action did not execute successfully

user_id
string
An ID identifying the user performing the action. This field is required if you support multi-user interactions.

Additional properties are allowed.
#24FacialGestureUserActionStartedFacialGestureUserActionStarted
The execution of an action has started.
- application/json
object
type
required
string
Allowed values:
"FacialGestureUserActionStarted"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"user_face"
action_info_modality_policy
required
string
Allowed values:
"replace"
action_info_lifetime
string
Allowed values:
"indefinite"
action_started_at
required
string
format: date-time
The timestamp of when the action has started.

user_id
string
An ID identifying the user performing the action. This field is required if you support multi-user interactions.

expression
required
string
Natural language description (NLD) of the facial expression. Detected facial expressions depend on the capabilities of the interactive system.

Minimal NLD set: The following expressions should be supported by every interactive system implementing this action: smile, lough, frown, wink

Additional properties are allowed.
#25GestureBotActionFinishedGestureBotActionFinished
The gesture was performed.
- application/json
object
type
required
string
Allowed values:
"GestureBotActionFinished"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_gesture"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"limited"
action_finished_at
required
string
format: date-time
The timestamp of when the action has finished.

is_success
required
boolean
Did the action finish successfully

was_stopped
boolean
Was the action stopped by a Stop event

failure_reason
string
Reason for action failure in case the action did not execute successfully

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#26GestureBotActionStartedGestureBotActionStarted
The bot has started to perform the gesture.
- application/json
object
type
required
string
Allowed values:
"GestureBotActionStarted"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_gesture"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"limited"
action_started_at
required
string
format: date-time
The timestamp of when the action has started.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#27GestureUserActionFinishedGestureUserActionFinished
The user performed a gesture.
- application/json
object
type
required
string
Allowed values:
"GestureUserActionFinished"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"user_upper_body"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"limited"
action_finished_at
required
string
format: date-time
The timestamp of when the action has finished.

is_success
required
boolean
Did the action finish successfully

was_stopped
boolean
Was the action stopped by a Stop event

failure_reason
string
Reason for action failure in case the action did not execute successfully

user_id
string
An ID identifying the user performing the action. This field is required if you support multi-user interactions.

gesture
required
string
Human readable name of the gesture. Availability of gestures depends on the interaction system.

Additional properties are allowed.
#28GestureUserActionStartedGestureUserActionStarted
The interactive system detects the start of a user gesture. Note: the time the system detects the gesture might be different from when the user started to perform the gesture.
- application/json
object
type
required
string
Allowed values:
"GestureUserActionStarted"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"user_upper_body"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"limited"
action_started_at
required
string
format: date-time
The timestamp of when the action has started.

user_id
string
An ID identifying the user performing the action. This field is required if you support multi-user interactions.

Additional properties are allowed.
#29MotionEffectCameraActionFinishedMotionEffectCameraActionFinished
Camera effect finished.
- application/json
object
type
required
string
Allowed values:
"MotionEffectCameraActionFinished"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"camera_motion_effect"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"limited"
action_finished_at
required
string
format: date-time
The timestamp of when the action has finished.

is_success
required
boolean
Did the action finish successfully

was_stopped
boolean
Was the action stopped by a Stop event

failure_reason
string
Reason for action failure in case the action did not execute successfully

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#30MotionEffectCameraActionStartedMotionEffectCameraActionStarted
Camera effect started.
- application/json
object
type
required
string
Allowed values:
"MotionEffectCameraActionStarted"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"camera_motion_effect"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"limited"
action_started_at
required
string
format: date-time
The timestamp of when the action has started.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#31PipelineAcquiredPipelineAcquired
A new pipeline has been acquired. A pipeline connects the IM to end user devices (stream_uid). This event informs the IM in an event-based implementation about the availability of new pipelines.
- application/json
object
type
required
string
Allowed values:
"PipelineAcquired"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
stream_uid
required
string
A unique identifier for the stream

session_uid
string
A unique identifier for the session

user_uid
string
A unique identifier for the user

Additional properties are allowed.
#32PipelineReleasedPipelineReleased
A pipeline has been released and is no longer available. A pipeline connects the IM to end user devices (stream_uid). This event informs the IM in an event-based implementation about pipelines that have been released.
- application/json
object
type
required
string
Allowed values:
"PipelineReleased"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
stream_uid
required
string
A unique identifier for the stream

session_uid
string
A unique identifier for the session

user_uid
string
A unique identifier for the user

Additional properties are allowed.
#33PipelineUpdatedPipelineUpdated
Information about an existing pipeline has been updated. This means that a new session was started or a new user has been identified as part of the same pipeline.
- application/json
object
type
required
string
Allowed values:
"PipelineUpdated"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
stream_uid
required
string
A unique identifier for the stream

session_uid
string
A unique identifier for the session

user_uid
string
A unique identifier for the user

Additional properties are allowed.
#34PositionBotActionFinishedPositionBotActionFinished
The bot shifted back to the original position before this action. This might be a neutral position or the position of any PositionBotAction overwritten by this action that now gains the “focus”.
- application/json
object
type
required
string
Allowed values:
"PositionBotActionFinished"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_position"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
action_finished_at
required
string
format: date-time
The timestamp of when the action has finished.

is_success
required
boolean
Did the action finish successfully

was_stopped
boolean
Was the action stopped by a Stop event

failure_reason
string
Reason for action failure in case the action did not execute successfully

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#35PositionBotActionStartedPositionBotActionStarted
The bot has started to transition to the new position
- application/json
object
type
required
string
Allowed values:
"PositionBotActionStarted"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_position"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
action_started_at
required
string
format: date-time
The timestamp of when the action has started.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#36PositionBotActionUpdatedPositionBotActionUpdated
The bot has arrived at the position and is maintaining that position for the entire action duration.
- application/json
object
type
required
string
Allowed values:
"PositionBotActionUpdated"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_position"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
action_updated_at
required
string
format: date-time
The timestamp of when the action has been updated.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

position_reached
required
string
The position the bot has reached.

Additional properties are allowed.
#37PostureBotActionFinishedPostureBotActionFinished
The posture was stopped.
- application/json
object
type
required
string
Allowed values:
"PostureBotActionFinished"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_posture"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
action_finished_at
required
string
format: date-time
The timestamp of when the action has finished.

is_success
required
boolean
Did the action finish successfully

was_stopped
boolean
Was the action stopped by a Stop event

failure_reason
string
Reason for action failure in case the action did not execute successfully

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#38PostureBotActionStartedPostureBotActionStarted
The bot has attained the posture.
- application/json
object
type
required
string
Allowed values:
"PostureBotActionStarted"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_posture"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
action_started_at
required
string
format: date-time
The timestamp of when the action has started.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#39PresenceUserActionFinishedPresenceUserActionFinished
The interactive system detects the user's absence
- application/json
object
type
required
string
Allowed values:
"PresenceUserActionFinished"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"user_presence"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
action_finished_at
required
string
format: date-time
The timestamp of when the action has finished.

is_success
required
boolean
Did the action finish successfully

was_stopped
boolean
Was the action stopped by a Stop event

failure_reason
string
Reason for action failure in case the action did not execute successfully

user_id
string
An ID identifying the user performing the action. This field is required if you support multi-user interactions.

Additional properties are allowed.
#40PresenceUserActionStartedPresenceUserActionStarted
The interactive system detects the presence of a user in the system.
- application/json
object
type
required
string
Allowed values:
"PresenceUserActionStarted"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"user_presence"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
action_started_at
required
string
format: date-time
The timestamp of when the action has started.

user_id
string
An ID identifying the user performing the action. This field is required if you support multi-user interactions.

Additional properties are allowed.
#41RestApiCallBotActionFinishedRestApiCallBotActionFinished
API call finished
- application/json
object
type
required
string
Allowed values:
"RestApiCallBotActionFinished"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"web_request"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
action_finished_at
required
string
format: date-time
The timestamp of when the action has finished.

is_success
required
boolean
Did the action finish successfully

was_stopped
boolean
Was the action stopped by a Stop event

failure_reason
string
Reason for action failure in case the action did not execute successfully

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

required
object
Response of call

Additional properties are allowed.
Additional properties are allowed.
#42RestApiCallBotActionStartedRestApiCallBotActionStarted
API call started
- application/json
object
type
required
string
Allowed values:
"RestApiCallBotActionStarted"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"web_request"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
action_started_at
required
string
format: date-time
The timestamp of when the action has started.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#43ShotCameraActionFinishedShotCameraActionFinished
The camera shot was stopped. The camera has returned to the shot it had before (either a neutral shot) or the shot specified by any overwritten ShotCameraAction actions.
- application/json
object
type
required
string
Allowed values:
"ShotCameraActionFinished"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"camera_shot"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
action_finished_at
required
string
format: date-time
The timestamp of when the action has finished.

is_success
required
boolean
Did the action finish successfully

was_stopped
boolean
Was the action stopped by a Stop event

failure_reason
string
Reason for action failure in case the action did not execute successfully

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#44ShotCameraActionStartedShotCameraActionStarted
The camera shot started
- application/json
object
type
required
string
Allowed values:
"ShotCameraActionStarted"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"camera_shot"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
action_started_at
required
string
format: date-time
The timestamp of when the action has started.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#45StartCustomBotActionStartCustomBotAction
Event to start an action. All other actions that can be started inherit from this base spec. The action_uid is used to differentiate between multiple runs of the same action.
- application/json
object
type
required
string
Allowed values:
"StartCustomBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"custom"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

custom_action_name
required
string
The name of the custom action.

required
object
Any parameters for the action.

Additional properties are allowed.
Additional properties are allowed.
#46StartExpectationBotActionStartExpectationBotAction
The bot expects a certain event on the UMIM event bus in the near future. This optional event can allow the Action Servers to optimize their functions. As an example a AS responsible for processing camera frames can enable / disable certain vision algorithms depending on what the IM is expecting (e.g. BotExpectation(event=PositionChangeUserActionStarted) can allow the AS to start a computationally more expensive motion tracker for better resolution/accuracy.)
- application/json
object
type
required
string
Allowed values:
"StartExpectationBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_expectation"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"indefinite"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

required
oneOf
Adheres to:
any
Or to:
any
Or to:
any
Or to:
any
Or to:
any
Or to:
any
Or to:
any
Or to:
any
Or to:
any
Or to:
any
Additional properties are allowed.
#47StartExpectationSignalingBotActionStartExpectationSignalingBotAction
The bot is waiting for an event for a specific modality.
- application/json
object
type
required
string
Allowed values:
"StartExpectationSignalingBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_expectation"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"indefinite"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

modality
required
string
uid: ActionModality
An enumeration.

Allowed values:
"bot_speech"
"bot_posture"
"bot_gesture"
"user_speech"
"bot_face"
"bot_upper_body"
"bot_position"
"user_face"
"user_upper_body"
"user_lower_body"
"user_engagement"
"sound"
"environment"
"camera_shot"
"camera_motion_effect"
"information"
"visual_effect"
"user_presence"
"bot_active_waiting"
"bot_expectation"
"custom"
"time"
"web_request"
Additional properties are allowed.
#48StartFacialGestureBotActionStartFacialGestureBotAction
The bot should start making a facial gesture.
- application/json
object
type
required
string
Allowed values:
"StartFacialGestureBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_face"
action_info_modality_policy
required
string
Allowed values:
"replace"
action_info_lifetime
string
Allowed values:
"limited"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

facial_gesture
required
string
Natural language description (NLD) of the facial gesture or expression. Availability of facial gestures depends on the interactive system.

Minimal NLD set: The following gestures should be supported by every interactive system implementing this action: smile, lough, frown, wink

Additional properties are allowed.
#49StartGestureBotActionStartGestureBotAction
The bot should start making a specific gesture.
- application/json
object
type
required
string
Allowed values:
"StartGestureBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_gesture"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"limited"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

gesture
required
string
Natural language description (NLD) of the gesture. Availability of gestures depends on the interaction system. If a system supports this action, the following base gestures need to be supported: affirm, negate, attract

Additional properties are allowed.
#50StartMotionEffectCameraActionStartMotionEffectCameraAction
Perform the described camera motion effect.
- application/json
object
type
required
string
Allowed values:
"StartMotionEffectCameraAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"camera_motion_effect"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"limited"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

effect
required
string
Natural language description (NLD) of the effect. Availability of effects depends on the interactive system.

Minimal NLD set: The following camera effects should be supported by every interactive system implementing this action: shake, jump cut in, jump cut out

Additional properties are allowed.
#51StartPositionBotActionStartPositionBotAction
The bot needs to hold a new position.
- application/json
object
type
required
string
Allowed values:
"StartPositionBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_position"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

position
required
string
Specify the position the bot needs to move to and maintain. Availability of positions depends on the interactive system. Positions are typically structured hierarchically into base position and position modifiers (“off center”).

Minimal NLD set: The following base positions are supported by all interactive systems (that support this action): center : Default position of the bot left : Bot should be positioned to the left (from the point of view of the bot) right: Bot should be positioned to the right (from the point of view of the bot)

Additional properties are allowed.
#52StartPostureBotActionStartPostureBotAction
The bot should start adopting the specified posture.
- application/json
object
type
required
string
Allowed values:
"StartPostureBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_posture"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

posture
required
string
Natural language description (NLD) of the posture. The availability of postures depends on the interaction system. Postures should be expressed hierarchically such that interactive systems that provide less nuanced postures can fall back onto higher level postures. The following base postures need to be supported by all interactive systems supporting this action.: “idle”, “attentive”

Additional properties are allowed.
#53StartRestApiCallBotActionStartRestApiCallBotAction
Start an API call.
- application/json
object
type
required
string
Allowed values:
"StartRestApiCallBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"web_request"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

required
allOf
Request type

Consists of:
string
uid: RequestType
Request Type

Allowed values:
"get"
"post"
"put"
url
required
string
REST API endpoint

object
Custom headers

Additional properties are allowed.
object
Dict that will be converted to JSON and Content-Type header set to application/json

Additional properties are allowed.
Additional properties are allowed.
#54StartShotCameraActionStartShotCameraAction
Start a new shot.
- application/json
object
type
required
string
Allowed values:
"StartShotCameraAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"camera_shot"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

shot
required
string
Natural language description (NLD) of the shot. Availability of shots depends on the interactive system.

Minimal NLD set: The following shots should be supported by every interactive system implementing this action: full, medium, close-up

start_transition
required
string
NLD of the transition to the new shot. This should describe the movement.

Minimal NLD set: The following shots should be supported by every interactive system implementing this action: cut, dolly

Additional properties are allowed.
#55StartTimerBotActionStartTimerBotAction
Start a timer.
- application/json
object
type
required
string
Allowed values:
"StartTimerBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"time"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

duration
required
number
format: time-delta
Time duration with respect to the event_created_at timestamp of this StartTimerAction event. When the duration has passed the timer goes off (TimerBotActionFinished is sent out).

timer_name
string
Name for the timer

Additional properties are allowed.
#56StartUtteranceBotActionStartUtteranceBotAction
The bot should start to produce an utterance. Depending on the interactive system this could be a bot sending a text message or an avatar talking to the user.
- application/json
object
type
required
string
Allowed values:
"StartUtteranceBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_speech"
action_info_modality_policy
required
string
Allowed values:
"replace"
action_info_lifetime
string
Allowed values:
"limited"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

script
required
string
The utterance of the bot, supporting SSML

intensity
number
A value from 0-1 that indicates the intensity of the utterance. A value of 0.5 means an “average” intensity. The intensity of an utterance action should change how the utterance is delivered to the user base on the type of interactive system For a chatbot system the intensity could relate to the typing rate in the UI. In a speech-enabled system intensity could change the volume and pitch variation of generated speech.

Additional properties are allowed.
#57StartVisualChoiceSceneActionStartVisualChoiceSceneAction
Present a choice in the scene to the user.
- application/json
object
type
required
string
Allowed values:
"StartVisualChoiceSceneAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"information"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

prompt
required
string
Describes the choice you are offering to the user

image
string
Description of an image that should be shown alongside the choice.

array<string>
List of prompts supporting the user in making a choice

Items:
string
required
array<object>
List of options for the user to choose from

id
required
string
ID of the option

text
string
Text to represent the option

image
string
NLD of image

required
allOf
Configures the type of choice the user can make.

Consists of:
string
uid: ChoiceType
An enumeration.

Allowed values:
"selection"
"search"
allow_multiple_choices
required
boolean
Indicate if the user should be able to select multiple choices from the presented options

Additional properties are allowed.
#58StartVisualFormSceneActionStartVisualFormSceneAction
Present a visual form that is requesting certain inputs from the user in the scene to the user.
- application/json
object
type
required
string
Allowed values:
"StartVisualFormSceneAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"information"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

prompt
required
string
Describes the inputs you are requesting from the user

image
string
Description of an image that should be shown alongside the prompt.

array<string>
List of prompts supporting the user in making a choice

Items:
string
required
array<object>
List of inputs required.

id
required
string
value
required
string
NLD of the type of input required

description
required
string
NLD of the type of input required

Additional properties are allowed.
#59StartVisualInformationSceneActionStartVisualInformationSceneAction
Present information in the scene to the user.
- application/json
object
type
required
string
Allowed values:
"StartVisualInformationSceneAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"information"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

title
required
string
Describes the choice you are offering to the user

summary
string
Summary of the information to be shown to the user

array<string>
List of prompts supporting the user in making a choice

Items:
string
required
array<object>
List of options for the user to choose from

text
string
Text to represent the option

image
string
NLD of image

Additional properties are allowed.
#60StopCustomBotActionStopCustomBotAction
An action needs to be stopped.
- application/json
object
type
required
string
Allowed values:
"StopCustomBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"custom"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

custom_action_name
required
string
The name of the custom action.

required
object
Any parameters for the action.

Additional properties are allowed.
Additional properties are allowed.
#61StopExpectationBotActionStopExpectationBotAction
The IM communicates that it stopped its expectations. This normally happens when the expectation has been met (e.g. the event has been received) or something else happened to change the course of the interaction.
- application/json
object
type
required
string
Allowed values:
"StopExpectationBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_expectation"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"indefinite"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#62StopExpectationSignalingBotActionStopExpectationSignalingBotAction
Stop waiting for an event on the modality.
- application/json
object
type
required
string
Allowed values:
"StopExpectationSignalingBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_expectation"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"indefinite"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#63StopFacialGestureBotActionStopFacialGestureBotAction
Stop the facial gesture or expression. All gestures have a limited lifetime and finish on “their own” (e.g., in an interactive avatar system a “smile” gesture could be implemented by a 1 second animation clip where some facial bones are animated). The IM can use this action to stop an expression before it would be naturally done.
- application/json
object
type
required
string
Allowed values:
"StopFacialGestureBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_face"
action_info_modality_policy
required
string
Allowed values:
"replace"
action_info_lifetime
string
Allowed values:
"limited"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#64StopGestureBotActionStopGestureBotAction
Stop the gesture. All gestures have a limited lifetime and finish on 'their own'. Gesture are meant to accentuate a certain situation or statement. For example, in an interactive avatar system a `affirm` gesture could be implemented by a 1 second animation clip where the avatar nods twice. The IM can use this action to stop a gesture before it would be naturally done.
- application/json
object
type
required
string
Allowed values:
"StopGestureBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_gesture"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"limited"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#65StopMotionEffectCameraActionStopMotionEffectCameraAction
Stop the camera effect . All effects have a limited lifetime and finish “on their own” (e.g., in an interactive avatar system a “shake” effect could be implemented by a 1 second camera motion). The IM can use this action to stop a camera effect before it would be naturally done.
- application/json
object
type
required
string
Allowed values:
"StopMotionEffectCameraAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"camera_motion_effect"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"limited"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#66StopPositionBotActionStopPositionBotAction
Stop holding the position. The bot will return to the position it had before the call. Position holding actions have an infinite lifetime, so unless the IM calls the Stop action the bot maintains the position indefinitely. Alternatively PositionBotAction actions can be overwritten, since the modality policy is Override.
- application/json
object
type
required
string
Allowed values:
"StopPositionBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_position"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#67StopPostureBotActionStopPostureBotAction
Stop the posture. Postures have no lifetime, so unless the IM calls the Stop action the bot will keep the posture indefinitely.
- application/json
object
type
required
string
Allowed values:
"StopPostureBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_posture"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#68StopShotCameraActionStopShotCameraAction
Stop the camera shot. The camera will return to the shot it had before this action was started. ShotCameraAction actions have an infinite lifetime, so unless the IM calls the Stop action the camera maintains the shot indefinitely.
- application/json
object
type
required
string
Allowed values:
"StopShotCameraAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"camera_shot"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

stop_transition
required
string
NLD of the transition back to the previous shot (override modality). This should describe the movement.

Minimal NLD set: The following shots should be supported by every interactive system implementing this action: cut, dolly

Additional properties are allowed.
#69StopTimerBotActionStopTimerBotAction
Stop the timer.
- application/json
object
type
required
string
Allowed values:
"StopTimerBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"time"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#70StopUtteranceBotActionStopUtteranceBotAction
Stops the bot utterance.The action is stopped only once the UtteranceBotActionFinished has been received. For interactive systems that do not support this event, the action will continue to run normally until finished. The interaction manager is expected to handle arbitrary delays between the time stopping the utterance and the time the utterance actually finished.
- application/json
object
type
required
string
Allowed values:
"StopUtteranceBotAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_speech"
action_info_modality_policy
required
string
Allowed values:
"replace"
action_info_lifetime
string
Allowed values:
"limited"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#71StopUtteranceUserActionStopUtteranceUserAction
Indicate that the IM has received the information needed and that the Action Server should consider the Utterance as finished as soon as possible. This could for example instruct the Action Server to decrease the hold time (duration of silence in the user speech until we consider the end of speech has been reached.
- application/json
object
type
required
string
Allowed values:
"StopUtteranceUserAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"user_speech"
action_info_modality_policy
required
string
Allowed values:
"replace"
action_info_lifetime
string
Allowed values:
"limited"
user_id
string
An ID identifying the user performing the action. This field is required if you support multi-user interactions.

Additional properties are allowed.
#72StopVisualChoiceSceneActionStopVisualChoiceSceneAction
Stop presenting the choice to the user.
- application/json
object
type
required
string
Allowed values:
"StopVisualChoiceSceneAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"information"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#73StopVisualFormSceneActionStopVisualFormSceneAction
Stop presenting the form to the user.
- application/json
object
type
required
string
Allowed values:
"StopVisualFormSceneAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"information"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#74StopVisualInformationSceneActionStopVisualInformationSceneAction
Stop presenting the information to the user
- application/json
object
type
required
string
Allowed values:
"StopVisualInformationSceneAction"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"information"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#75TimerBotActionFinishedTimerBotActionFinished
Timer finished.
- application/json
object
type
required
string
Allowed values:
"TimerBotActionFinished"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"time"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
action_finished_at
required
string
format: date-time
The timestamp of when the action has finished.

is_success
required
boolean
Did the action finish successfully

was_stopped
boolean
Was the action stopped by a Stop event

failure_reason
string
Reason for action failure in case the action did not execute successfully

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#76TimerBotActionStartedTimerBotActionStarted
Timer started.
- application/json
object
type
required
string
Allowed values:
"TimerBotActionStarted"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"time"
action_info_modality_policy
required
string
Allowed values:
"parallel"
action_info_lifetime
string
Allowed values:
"limited"
action_started_at
required
string
format: date-time
The timestamp of when the action has started.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#77UserIntentUserIntent
The structured representation of the intent of the user. This event should be generated by the IM when it has inferred a user's intent. A user intent can be inferred based on verbal or non-verbal communication of the user.
- application/json
object
type
required
string
Allowed values:
"UserIntent"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
intent
required
string
Canonical form of the user's intent

Additional properties are allowed.
#78UserMovementUserMovement
A specific user movement was detected.
- application/json
object
type
required
string
Allowed values:
"UserMovement"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
movement
required
string
e.g. 'move', 'lean', 'blink', 'point to', 'nod', 'shake head'

required
object
Specific movement parameters.

Additional properties are allowed.
Additional properties are allowed.
#79UtteranceBotActionFinishedUtteranceBotActionFinished
The bot utterance finished, either because the utterance has been delivered to the user or the action was stopped.
- application/json
object
type
required
string
Allowed values:
"UtteranceBotActionFinished"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_speech"
action_info_modality_policy
required
string
Allowed values:
"replace"
action_info_lifetime
string
Allowed values:
"limited"
action_finished_at
required
string
format: date-time
The timestamp of when the action has finished.

is_success
required
boolean
Did the action finish successfully

was_stopped
boolean
Was the action stopped by a Stop event

failure_reason
string
Reason for action failure in case the action did not execute successfully

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

final_script
required
string
Final transcript of the bot utterance

Additional properties are allowed.
#80UtteranceBotActionScriptUpdatedUtteranceBotActionScriptUpdated
Provides updated transcripts during a UtteranceBotAction. These events correspond to the time that a certain part of the utterance is delivered to the user. In a interactive system that supports voice output these events should align with when the user hears the partial transcript
- application/json
object
type
required
string
Allowed values:
"UtteranceBotActionScriptUpdated"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_speech"
action_info_modality_policy
required
string
Allowed values:
"replace"
action_info_lifetime
string
Allowed values:
"limited"
action_updated_at
required
string
format: date-time
The timestamp of when the action has been updated.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

interim_script
required
string
Partial script of the bot utterance up to this point in time

Additional properties are allowed.
#81UtteranceBotActionStartedUtteranceBotActionStarted
The bot started to produce the utterance. This event should align as close as possible with the moment in time the user is receiving the utterance. For example in an Interactive Avatar system, the event is sent out by the Action Server once the text-to-speech (TTS) stream is sent to the user.
- application/json
object
type
required
string
Allowed values:
"UtteranceBotActionStarted"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"bot_speech"
action_info_modality_policy
required
string
Allowed values:
"replace"
action_info_lifetime
string
Allowed values:
"limited"
action_started_at
required
string
format: date-time
The timestamp of when the action has started.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#82UtteranceUserActionFinishedUtteranceUserActionFinished
The user utterance has finished.
- application/json
object
type
required
string
Allowed values:
"UtteranceUserActionFinished"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"user_speech"
action_info_modality_policy
required
string
Allowed values:
"replace"
action_info_lifetime
string
Allowed values:
"limited"
action_finished_at
required
string
format: date-time
The timestamp of when the action has finished.

is_success
required
boolean
Did the action finish successfully

was_stopped
boolean
Was the action stopped by a Stop event

failure_reason
string
Reason for action failure in case the action did not execute successfully

user_id
string
An ID identifying the user performing the action. This field is required if you support multi-user interactions.

final_transcript
required
string
Final transcript of the user utterance

Additional properties are allowed.
#83UtteranceUserActionIntensityUpdatedUtteranceUserActionIntensityUpdated
Provides updated speaking intensity levels if the interactive system supports it.
- application/json
object
type
required
string
Allowed values:
"UtteranceUserActionIntensityUpdated"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"user_speech"
action_info_modality_policy
required
string
Allowed values:
"replace"
action_info_lifetime
string
Allowed values:
"limited"
action_updated_at
required
string
format: date-time
The timestamp of when the action has been updated.

user_id
string
An ID identifying the user performing the action. This field is required if you support multi-user interactions.

intensity
required
number
A value from 0-1 that indicates the intensity of the utterance. A value of 0.5 means an “average” intensity. The intensity of an utterance action can correspond to different metrics depending on the interactive system. For a chatbot system the intensity could relate to the typing rate. In a speech-enabled system intensity could be computed based on the volume and pitch variation of the user’s voice.

Additional properties are allowed.
#84UtteranceUserActionStartedUtteranceUserActionStarted
The user started to produce an utterance. The user could have started talking or typing for example.
- application/json
object
type
required
string
Allowed values:
"UtteranceUserActionStarted"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"user_speech"
action_info_modality_policy
required
string
Allowed values:
"replace"
action_info_lifetime
string
Allowed values:
"limited"
action_started_at
required
string
format: date-time
The timestamp of when the action has started.

user_id
string
An ID identifying the user performing the action. This field is required if you support multi-user interactions.

Additional properties are allowed.
#85UtteranceUserActionTranscriptUpdatedUtteranceUserActionTranscriptUpdated
Provides updated transcripts during a UtteranceUserAction
- application/json
object
type
required
string
Allowed values:
"UtteranceUserActionTranscriptUpdated"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"user_speech"
action_info_modality_policy
required
string
Allowed values:
"replace"
action_info_lifetime
string
Allowed values:
"limited"
action_updated_at
required
string
format: date-time
The timestamp of when the action has been updated.

user_id
string
An ID identifying the user performing the action. This field is required if you support multi-user interactions.

interim_transcript
required
string
Partial transcript of the user utterance up to this point in time

Additional properties are allowed.
#86VisualChoiceSceneActionChoiceUpdatedVisualChoiceSceneActionChoiceUpdated
Whenever the user interacts directly with the choice presented in the scene but does not confirmed cancel the choice, a ChoiceUpdated event is sent out by the interactive system.
- application/json
object
type
required
string
Allowed values:
"VisualChoiceSceneActionChoiceUpdated"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"information"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
action_updated_at
required
string
format: date-time
The timestamp of when the action has been updated.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

required
array<string>
List of Option IDs if the user made a choice

Items:
string
Additional properties are allowed.
#87VisualChoiceSceneActionConfirmationUpdatedVisualChoiceSceneActionConfirmationUpdated
Whenever the user confirms or tries to abort the choice when interacting with the visual representation of the choice. Examples of this include: clicking a “confirm” button, “clicking on close”
- application/json
object
type
required
string
Allowed values:
"VisualChoiceSceneActionConfirmationUpdated"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"information"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
action_updated_at
required
string
format: date-time
The timestamp of when the action has been updated.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

required
allOf
Status of the choice confirmation by the user.

Consists of:
string
uid: ConfirmationStatus
An enumeration.

Allowed values:
"confirm"
"cancel"
"unknown"
Additional properties are allowed.
#88VisualChoiceSceneActionFinishedVisualChoiceSceneActionFinished
The choice action was stopped by the IM. (no user action will cause the action to be finished by the Action Server).
- application/json
object
type
required
string
Allowed values:
"VisualChoiceSceneActionFinished"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"information"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
action_finished_at
required
string
format: date-time
The timestamp of when the action has finished.

is_success
required
boolean
Did the action finish successfully

was_stopped
boolean
Was the action stopped by a Stop event

failure_reason
string
Reason for action failure in case the action did not execute successfully

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

required
array<string>
List of options for the user to choose from

Items:
string
Additional properties are allowed.
#89VisualChoiceSceneActionStartedVisualChoiceSceneActionStarted
The system has started presenting the choice to the user
- application/json
object
type
required
string
Allowed values:
"VisualChoiceSceneActionStarted"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"information"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
action_started_at
required
string
format: date-time
The timestamp of when the action has started.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#90VisualFormSceneActionConfirmationUpdatedVisualFormSceneActionConfirmationUpdated
Whenever the user confirms or tries to abort the form input when interacting with the visual representation of the form. Examples of this include: clicking a “confirm” button, “clicking on close”
- application/json
object
type
required
string
Allowed values:
"VisualFormSceneActionConfirmationUpdated"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"information"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
action_updated_at
required
string
format: date-time
The timestamp of when the action has been updated.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

required
allOf
Status of the form input confirmation by the user.

Consists of:
string
uid: ConfirmationStatus
An enumeration.

Allowed values:
"confirm"
"cancel"
"unknown"
Additional properties are allowed.
#91VisualFormSceneActionFinishedVisualFormSceneActionFinished
Form action was stopped by the IM (no user action will cause the action to be finished by the Action Server).
- application/json
object
type
required
string
Allowed values:
"VisualFormSceneActionFinished"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"information"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
action_finished_at
required
string
format: date-time
The timestamp of when the action has finished.

is_success
required
boolean
Did the action finish successfully

was_stopped
boolean
Was the action stopped by a Stop event

failure_reason
string
Reason for action failure in case the action did not execute successfully

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

required
array<object>
Final state of all inputs.

id
required
string
value
required
string
NLD of the type of input required

description
required
string
NLD of the type of input required

Additional properties are allowed.
#92VisualFormSceneActionInputUpdatedVisualFormSceneActionInputUpdated
Whenever the user interacts directly with the form inputs presented in the scene but has not yet confirmed the input, an Updated action is sent out by the interactive system. This allows the IM to react to partial inputs, e.g. if a user is typing an e-mail address the bot can react to partial inputs (the bot could say "And now only the domain missing" after the user typed "@" in the form field).
- application/json
object
type
required
string
Allowed values:
"VisualFormSceneActionInputUpdated"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"information"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
action_updated_at
required
string
format: date-time
The timestamp of when the action has been updated.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

required
array<object>
Final state of all inputs.

id
required
string
value
required
string
NLD of the type of input required

description
required
string
NLD of the type of input required

Additional properties are allowed.
#93VisualFormSceneActionStartedVisualFormSceneActionStarted
The system has started presenting the the form to the user..
- application/json
object
type
required
string
Allowed values:
"VisualFormSceneActionStarted"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"information"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
action_started_at
required
string
format: date-time
The timestamp of when the action has started.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#94VisualInformationSceneActionConfirmationUpdatedVisualInformationSceneActionConfirmationUpdated
Whenever the user confirms or tries to abort the visual information shown in the screen. Examples of this include: clicking a “confirm” button, “clicking on close”
- application/json
object
type
required
string
Allowed values:
"VisualInformationSceneActionConfirmationUpdated"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"information"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
action_updated_at
required
string
format: date-time
The timestamp of when the action has been updated.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

required
allOf
Update on the confirmation status. User indicating to have understood or to cancel the visual information

Consists of:
string
uid: ConfirmationStatus
An enumeration.

Allowed values:
"confirm"
"cancel"
"unknown"
Additional properties are allowed.
#95VisualInformationSceneActionFinishedVisualInformationSceneActionFinished
Information action was stopped by the IM (no user action will cause the action to be finished by the Action Server).
- application/json
object
type
required
string
Allowed values:
"VisualInformationSceneActionFinished"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"information"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
action_finished_at
required
string
format: date-time
The timestamp of when the action has finished.

is_success
required
boolean
Did the action finish successfully

was_stopped
boolean
Was the action stopped by a Stop event

failure_reason
string
Reason for action failure in case the action did not execute successfully

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.
#96VisualInformationSceneActionStartedVisualInformationSceneActionStarted
The system has started presenting the information to the user..
- application/json
object
type
required
string
Allowed values:
"VisualInformationSceneActionStarted"
uid
required
string
A unique identifier for the event.

event_created_at
required
string
format: date-time
The timestamp of when the event was created.

source_uid
required
string
A unique id of the source component that generated the event.

object
A list of key-value pairs associated with the event.Tags are propagated from input events to output events.

Additional properties are allowed.
action_uid
required
string
A unique id for the action.

action_info_modality
required
string
Allowed values:
"information"
action_info_modality_policy
required
string
Allowed values:
"override"
action_info_lifetime
string
Allowed values:
"indefinite"
action_started_at
required
string
format: date-time
The timestamp of when the action has started.

bot_id
string
An ID identifying the bot performing the action. This field is required if you support multi-bot interactions.

Additional properties are allowed.

Schemas

object
uid: VisualChoiceOption
id
required
string
ID of the option

text
string
Text to represent the option

image
string
NLD of image

Additional properties are allowed.
ChoiceType
string
uid: ChoiceType
An enumeration.

Allowed values:
"selection"
"search"
RequestType
string
uid: RequestType
Request Type

Allowed values:
"get"
"post"
"put"
object
uid: VisualFormInputs
id
required
string
value
required
string
NLD of the type of input required

description
required
string
NLD of the type of input required

Additional properties are allowed.
object
uid: VisualInformationContent
text
string
Text to represent the option

image
string
NLD of image

Additional properties are allowed.
ConfirmationStatus
string
uid: ConfirmationStatus
An enumeration.

Allowed values:
"confirm"
"cancel"
"unknown"
ActionModality
string
uid: ActionModality
An enumeration.

Allowed values:
"bot_speech"
"bot_posture"
"bot_gesture"
"user_speech"
"bot_face"
"bot_upper_body"
"bot_position"
"user_face"
"user_upper_body"
"user_lower_body"
"user_engagement"
"sound"
"environment"
"camera_shot"
"camera_motion_effect"
"information"
"visual_effect"
"user_presence"
"bot_active_waiting"
"bot_expectation"
"custom"
"time"
"web_request"

UMIM API 1.3.0

Operations

PUB umim_events_system

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

PUB umim_events{stream_uid}

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.