asyncapi: 2.6.0
info:
  title: UMIM API
  version: 1.3.0
  description: The AsyncAPI version of UMIM is meant for use with Interaction Manager
    (IM) components that communicate through an asynchronous event bus.
defaultContentType: application/json
channels:
  umim_events_system:
    description: UMIM event stream specific to a unique device stream.
    parameters:
      stream_uid:
        $ref: '#/components/parameters/stream_uid'
    publish:
      message:
        oneOf:
        - $ref: '#/components/messages/PipelineAcquired'
        - $ref: '#/components/messages/PipelineReleased'
        - $ref: '#/components/messages/PipelineUpdated'
  umim_events{stream_uid}:
    description: UMIM event stream specific to a unique device stream.
    parameters:
      stream_uid:
        $ref: '#/components/parameters/stream_uid'
    publish:
      message:
        oneOf:
        - $ref: '#/components/messages/AttentionUserActionFinished'
        - $ref: '#/components/messages/AttentionUserActionStarted'
        - $ref: '#/components/messages/AttentionUserActionUpdated'
        - $ref: '#/components/messages/CustomBotActionFinished'
        - $ref: '#/components/messages/CustomBotActionStarted'
        - $ref: '#/components/messages/CustomBotActionUpdated'
        - $ref: '#/components/messages/CustomUserActionFinished'
        - $ref: '#/components/messages/CustomUserActionStarted'
        - $ref: '#/components/messages/CustomUserActionUpdated'
        - $ref: '#/components/messages/ExpectationBotActionFinished'
        - $ref: '#/components/messages/ExpectationBotActionStarted'
        - $ref: '#/components/messages/ExpectationSignalingBotActionFinished'
        - $ref: '#/components/messages/ExpectationSignalingBotActionStarted'
        - $ref: '#/components/messages/FacialGestureBotActionFinished'
        - $ref: '#/components/messages/FacialGestureBotActionStarted'
        - $ref: '#/components/messages/FacialGestureUserActionFinished'
        - $ref: '#/components/messages/FacialGestureUserActionStarted'
        - $ref: '#/components/messages/GestureBotActionFinished'
        - $ref: '#/components/messages/GestureBotActionStarted'
        - $ref: '#/components/messages/GestureUserActionFinished'
        - $ref: '#/components/messages/GestureUserActionStarted'
        - $ref: '#/components/messages/MotionEffectCameraActionFinished'
        - $ref: '#/components/messages/MotionEffectCameraActionStarted'
        - $ref: '#/components/messages/PipelineUpdated'
        - $ref: '#/components/messages/PositionBotActionFinished'
        - $ref: '#/components/messages/PositionBotActionStarted'
        - $ref: '#/components/messages/PositionBotActionUpdated'
        - $ref: '#/components/messages/PostureBotActionFinished'
        - $ref: '#/components/messages/PostureBotActionStarted'
        - $ref: '#/components/messages/PresenceUserActionFinished'
        - $ref: '#/components/messages/PresenceUserActionStarted'
        - $ref: '#/components/messages/RestApiCallBotActionFinished'
        - $ref: '#/components/messages/RestApiCallBotActionStarted'
        - $ref: '#/components/messages/ShotCameraActionFinished'
        - $ref: '#/components/messages/ShotCameraActionStarted'
        - $ref: '#/components/messages/TimerBotActionFinished'
        - $ref: '#/components/messages/TimerBotActionStarted'
        - $ref: '#/components/messages/UtteranceBotActionFinished'
        - $ref: '#/components/messages/UtteranceBotActionScriptUpdated'
        - $ref: '#/components/messages/UtteranceBotActionStarted'
        - $ref: '#/components/messages/UtteranceUserActionFinished'
        - $ref: '#/components/messages/UtteranceUserActionIntensityUpdated'
        - $ref: '#/components/messages/UtteranceUserActionStarted'
        - $ref: '#/components/messages/UtteranceUserActionTranscriptUpdated'
        - $ref: '#/components/messages/VisualChoiceSceneActionChoiceUpdated'
        - $ref: '#/components/messages/VisualChoiceSceneActionConfirmationUpdated'
        - $ref: '#/components/messages/VisualChoiceSceneActionFinished'
        - $ref: '#/components/messages/VisualChoiceSceneActionStarted'
        - $ref: '#/components/messages/VisualFormSceneActionConfirmationUpdated'
        - $ref: '#/components/messages/VisualFormSceneActionFinished'
        - $ref: '#/components/messages/VisualFormSceneActionInputUpdated'
        - $ref: '#/components/messages/VisualFormSceneActionStarted'
        - $ref: '#/components/messages/VisualInformationSceneActionConfirmationUpdated'
        - $ref: '#/components/messages/VisualInformationSceneActionFinished'
        - $ref: '#/components/messages/VisualInformationSceneActionStarted'
    subscribe:
      message:
        oneOf:
        - $ref: '#/components/messages/BotIntent'
        - $ref: '#/components/messages/ChangeCustomBotAction'
        - $ref: '#/components/messages/ChangeCustomUserAction'
        - $ref: '#/components/messages/ChangeTimerBotAction'
        - $ref: '#/components/messages/ChangeUtteranceBotAction'
        - $ref: '#/components/messages/ContextUpdate'
        - $ref: '#/components/messages/CustomEvent'
        - $ref: '#/components/messages/PipelineAcquired'
        - $ref: '#/components/messages/PipelineReleased'
        - $ref: '#/components/messages/StartCustomBotAction'
        - $ref: '#/components/messages/StartExpectationBotAction'
        - $ref: '#/components/messages/StartExpectationSignalingBotAction'
        - $ref: '#/components/messages/StartFacialGestureBotAction'
        - $ref: '#/components/messages/StartGestureBotAction'
        - $ref: '#/components/messages/StartMotionEffectCameraAction'
        - $ref: '#/components/messages/StartPositionBotAction'
        - $ref: '#/components/messages/StartPostureBotAction'
        - $ref: '#/components/messages/StartRestApiCallBotAction'
        - $ref: '#/components/messages/StartShotCameraAction'
        - $ref: '#/components/messages/StartTimerBotAction'
        - $ref: '#/components/messages/StartUtteranceBotAction'
        - $ref: '#/components/messages/StartVisualChoiceSceneAction'
        - $ref: '#/components/messages/StartVisualFormSceneAction'
        - $ref: '#/components/messages/StartVisualInformationSceneAction'
        - $ref: '#/components/messages/StopCustomBotAction'
        - $ref: '#/components/messages/StopExpectationBotAction'
        - $ref: '#/components/messages/StopExpectationSignalingBotAction'
        - $ref: '#/components/messages/StopFacialGestureBotAction'
        - $ref: '#/components/messages/StopGestureBotAction'
        - $ref: '#/components/messages/StopMotionEffectCameraAction'
        - $ref: '#/components/messages/StopPositionBotAction'
        - $ref: '#/components/messages/StopPostureBotAction'
        - $ref: '#/components/messages/StopShotCameraAction'
        - $ref: '#/components/messages/StopTimerBotAction'
        - $ref: '#/components/messages/StopUtteranceBotAction'
        - $ref: '#/components/messages/StopUtteranceUserAction'
        - $ref: '#/components/messages/StopVisualChoiceSceneAction'
        - $ref: '#/components/messages/StopVisualFormSceneAction'
        - $ref: '#/components/messages/StopVisualInformationSceneAction'
        - $ref: '#/components/messages/UserIntent'
        - $ref: '#/components/messages/UserMovement'
components:
  parameters:
    stream_uid:
      description: Unique identifier for the stream.
      schema:
        type: string
  messages:
    AttentionUserActionFinished:
      name: AttentionUserActionFinished
      title: AttentionUserActionFinished
      summary: The system detects the user to be disengaged with the interactive system.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - AttentionUserActionFinished
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - user_engagement
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_finished_at:
            title: Action Finished At
            description: The timestamp of when the action has finished.
            type: string
            format: date-time
          is_success:
            title: Is Success
            description: Did the action finish successfully
            type: boolean
          was_stopped:
            title: Was Stopped
            description: Was the action stopped by a Stop event
            type: boolean
          failure_reason:
            title: Failure Reason
            description: Reason for action failure in case the action did not execute
              successfully
            type: string
          user_id:
            title: User Id
            description: An ID identifying the user performing the action. This field
              is required if you support multi-user interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_finished_at
        - is_success
    AttentionUserActionStarted:
      name: AttentionUserActionStarted
      title: AttentionUserActionStarted
      summary: The interactive system detects some level of engagement of the user.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - AttentionUserActionStarted
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - user_engagement
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_started_at:
            title: Action Started At
            description: The timestamp of when the action has started.
            type: string
            format: date-time
          user_id:
            title: User Id
            description: An ID identifying the user performing the action. This field
              is required if you support multi-user interactions.
            type: string
          attention_level:
            title: Attention Level
            description: 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.
            type: number
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_started_at
    AttentionUserActionUpdated:
      name: AttentionUserActionUpdated
      title: AttentionUserActionUpdated
      summary: The interactive system provides an update to the engagement level.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - AttentionUserActionUpdated
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - user_engagement
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_updated_at:
            title: Action Updated At
            description: The timestamp of when the action has been updated.
            type: string
            format: date-time
          user_id:
            title: User Id
            description: An ID identifying the user performing the action. This field
              is required if you support multi-user interactions.
            type: string
          attention_level:
            title: Attention Level
            description: Optional. Float in the range (0,1] (not including 0). Indicates
              the estimated attention level.
            type: number
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_updated_at
    BotIntent:
      name: BotIntent
      title: BotIntent
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - BotIntent
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          intent:
            title: Intent
            description: Canonical form of the bot's intent
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - intent
    ChangeCustomBotAction:
      name: ChangeCustomBotAction
      title: ChangeCustomBotAction
      summary: Change parameters of the custom action (if supported by the custom
        action)
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - ChangeCustomBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - custom
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          custom_action_name:
            title: Custom Action Name
            description: The name of the custom action.
            type: string
          parameters:
            title: Parameters
            description: Any parameters for the action change.
            type: object
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - custom_action_name
        - parameters
    ChangeCustomUserAction:
      name: ChangeCustomUserAction
      title: ChangeCustomUserAction
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - ChangeCustomUserAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - custom
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          user_id:
            title: User Id
            description: An ID identifying the user performing the action. This field
              is required if you support multi-user interactions.
            type: string
          custom_action_name:
            title: Custom Action Name
            description: The name of the custom action.
            type: string
          parameters:
            title: Parameters
            description: Any parameters for the action change.
            type: object
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - custom_action_name
        - parameters
    ChangeTimerBotAction:
      name: ChangeTimerBotAction
      title: ChangeTimerBotAction
      summary: '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).'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - ChangeTimerBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - time
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          duration:
            title: Duration
            description: 'Change the duration of the Timer with respect to the event_created_at
              timestamp of this StartTimerAction event. '
            type: number
            format: time-delta
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - duration
    ChangeUtteranceBotAction:
      name: ChangeUtteranceBotAction
      title: ChangeUtteranceBotAction
      summary: Adjusts the intended volume while the action has already been started.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - ChangeUtteranceBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_speech
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - replace
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          intensity:
            title: Intensity
            description: "A value from 0-1 that indicates the intensity of the utterance.\
              \ A value of 0.5 means an \u201Caverage\u201D 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."
            type: number
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - intensity
    ContextUpdate:
      name: ContextUpdate
      title: ContextUpdate
      summary: 'An update to the context.


        All specified keys will override the ones in the current context.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - ContextUpdate
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          data:
            title: Data
            description: Any contextual data that has changed.
            type: object
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - data
    CustomBotActionFinished:
      name: CustomBotActionFinished
      title: CustomBotActionFinished
      summary: The custom action has finished its execution.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - CustomBotActionFinished
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - custom
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_finished_at:
            title: Action Finished At
            description: The timestamp of when the action has finished.
            type: string
            format: date-time
          is_success:
            title: Is Success
            description: Did the action finish successfully
            type: boolean
          was_stopped:
            title: Was Stopped
            description: Was the action stopped by a Stop event
            type: boolean
          failure_reason:
            title: Failure Reason
            description: Reason for action failure in case the action did not execute
              successfully
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          custom_action_name:
            title: Custom Action Name
            description: The name of the custom action.
            type: string
          results:
            title: Results
            description: Any results from the action.
            type: object
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_finished_at
        - is_success
        - custom_action_name
        - results
    CustomBotActionStarted:
      name: CustomBotActionStarted
      title: CustomBotActionStarted
      summary: The execution of the custom bot action has started.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - CustomBotActionStarted
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - custom
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_started_at:
            title: Action Started At
            description: The timestamp of when the action has started.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          custom_action_name:
            title: Custom Action Name
            description: The name of the custom action.
            type: string
          parameters:
            title: Parameters
            description: Any parameters for the action.
            type: object
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_started_at
        - custom_action_name
        - parameters
    CustomBotActionUpdated:
      name: CustomBotActionUpdated
      title: CustomBotActionUpdated
      summary: Something happened during the execution of the custom action (if supported
        by the custom action).
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - CustomBotActionUpdated
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - custom
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_updated_at:
            title: Action Updated At
            description: The timestamp of when the action has been updated.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          custom_action_name:
            title: Custom Action Name
            description: The name of the custom action.
            type: string
          updates:
            title: Updates
            description: Any updates from the action.
            type: object
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_updated_at
        - custom_action_name
        - updates
    CustomEvent:
      name: CustomEvent
      title: CustomEvent
      summary: A custom event that can be used in addition to the standardized ones.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - CustomEvent
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          name:
            title: Name
            description: Name of the custom event.
            type: string
          data:
            title: Data
            description: Any data relevant for the event.
            type: object
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - name
        - data
    CustomUserActionFinished:
      name: CustomUserActionFinished
      title: CustomUserActionFinished
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - CustomUserActionFinished
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - custom
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_finished_at:
            title: Action Finished At
            description: The timestamp of when the action has finished.
            type: string
            format: date-time
          is_success:
            title: Is Success
            description: Did the action finish successfully
            type: boolean
          was_stopped:
            title: Was Stopped
            description: Was the action stopped by a Stop event
            type: boolean
          failure_reason:
            title: Failure Reason
            description: Reason for action failure in case the action did not execute
              successfully
            type: string
          user_id:
            title: User Id
            description: An ID identifying the user performing the action. This field
              is required if you support multi-user interactions.
            type: string
          custom_action_name:
            title: Custom Action Name
            description: The name of the custom action.
            type: string
          results:
            title: Results
            description: Any results from the action.
            type: object
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_finished_at
        - is_success
        - custom_action_name
        - results
    CustomUserActionStarted:
      name: CustomUserActionStarted
      title: CustomUserActionStarted
      summary: The execution of the custom user action has started.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - CustomUserActionStarted
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - custom
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_started_at:
            title: Action Started At
            description: The timestamp of when the action has started.
            type: string
            format: date-time
          user_id:
            title: User Id
            description: An ID identifying the user performing the action. This field
              is required if you support multi-user interactions.
            type: string
          custom_action_name:
            title: Custom Action Name
            description: The name of the custom action.
            type: string
          parameters:
            title: Parameters
            description: Any parameters for the action.
            type: object
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_started_at
        - custom_action_name
        - parameters
    CustomUserActionUpdated:
      name: CustomUserActionUpdated
      title: CustomUserActionUpdated
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - CustomUserActionUpdated
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - custom
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_updated_at:
            title: Action Updated At
            description: The timestamp of when the action has been updated.
            type: string
            format: date-time
          user_id:
            title: User Id
            description: An ID identifying the user performing the action. This field
              is required if you support multi-user interactions.
            type: string
          custom_action_name:
            title: Custom Action Name
            description: The name of the custom action.
            type: string
          updates:
            title: Updates
            description: Any updates from the action.
            type: object
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_updated_at
        - custom_action_name
        - updates
    ExpectationBotActionFinished:
      name: ExpectationBotActionFinished
      title: ExpectationBotActionFinished
      summary: The interactive system acknowledges that the bot expectation is finished.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - ExpectationBotActionFinished
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_expectation
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_finished_at:
            title: Action Finished At
            description: The timestamp of when the action has finished.
            type: string
            format: date-time
          is_success:
            title: Is Success
            description: Did the action finish successfully
            type: boolean
          was_stopped:
            title: Was Stopped
            description: Was the action stopped by a Stop event
            type: boolean
          failure_reason:
            title: Failure Reason
            description: Reason for action failure in case the action did not execute
              successfully
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_finished_at
        - is_success
    ExpectationBotActionStarted:
      name: ExpectationBotActionStarted
      title: ExpectationBotActionStarted
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - ExpectationBotActionStarted
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_expectation
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_started_at:
            title: Action Started At
            description: The timestamp of when the action has started.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_started_at
    ExpectationSignalingBotActionFinished:
      name: ExpectationSignalingBotActionFinished
      title: ExpectationSignalingBotActionFinished
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - 'ExpectationSignalingBotActionFinished '
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_expectation
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_finished_at:
            title: Action Finished At
            description: The timestamp of when the action has finished.
            type: string
            format: date-time
          is_success:
            title: Is Success
            description: Did the action finish successfully
            type: boolean
          was_stopped:
            title: Was Stopped
            description: Was the action stopped by a Stop event
            type: boolean
          failure_reason:
            title: Failure Reason
            description: Reason for action failure in case the action did not execute
              successfully
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_finished_at
        - is_success
    ExpectationSignalingBotActionStarted:
      name: ExpectationSignalingBotActionStarted
      title: ExpectationSignalingBotActionStarted
      summary: The bot has started actively waiting for an event on the specified
        modality.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - ExpectationSignalingBotActionStarted
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_expectation
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_started_at:
            title: Action Started At
            description: The timestamp of when the action has started.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_started_at
    FacialGestureBotActionFinished:
      name: FacialGestureBotActionFinished
      title: FacialGestureBotActionFinished
      summary: The facial gesture was performed.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - FacialGestureBotActionFinished
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_face
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - replace
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_finished_at:
            title: Action Finished At
            description: The timestamp of when the action has finished.
            type: string
            format: date-time
          is_success:
            title: Is Success
            description: Did the action finish successfully
            type: boolean
          was_stopped:
            title: Was Stopped
            description: Was the action stopped by a Stop event
            type: boolean
          failure_reason:
            title: Failure Reason
            description: Reason for action failure in case the action did not execute
              successfully
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_finished_at
        - is_success
    FacialGestureBotActionStarted:
      name: FacialGestureBotActionStarted
      title: FacialGestureBotActionStarted
      summary: The bot has started to perform the facial gesture
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - FacialGestureBotActionStarted
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_face
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - replace
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_started_at:
            title: Action Started At
            description: The timestamp of when the action has started.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_started_at
    FacialGestureUserActionFinished:
      name: FacialGestureUserActionFinished
      title: FacialGestureUserActionFinished
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - FacialGestureUserActionFinished
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - user_face
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - replace
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_finished_at:
            title: Action Finished At
            description: The timestamp of when the action has finished.
            type: string
            format: date-time
          is_success:
            title: Is Success
            description: Did the action finish successfully
            type: boolean
          was_stopped:
            title: Was Stopped
            description: Was the action stopped by a Stop event
            type: boolean
          failure_reason:
            title: Failure Reason
            description: Reason for action failure in case the action did not execute
              successfully
            type: string
          user_id:
            title: User Id
            description: An ID identifying the user performing the action. This field
              is required if you support multi-user interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_finished_at
        - is_success
    FacialGestureUserActionStarted:
      name: FacialGestureUserActionStarted
      title: FacialGestureUserActionStarted
      summary: The execution of an action has started.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - FacialGestureUserActionStarted
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - user_face
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - replace
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_started_at:
            title: Action Started At
            description: The timestamp of when the action has started.
            type: string
            format: date-time
          user_id:
            title: User Id
            description: An ID identifying the user performing the action. This field
              is required if you support multi-user interactions.
            type: string
          expression:
            title: Expression
            description: '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

              '
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_started_at
        - expression
    GestureBotActionFinished:
      name: GestureBotActionFinished
      title: GestureBotActionFinished
      summary: The gesture was performed.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - GestureBotActionFinished
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_gesture
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_finished_at:
            title: Action Finished At
            description: The timestamp of when the action has finished.
            type: string
            format: date-time
          is_success:
            title: Is Success
            description: Did the action finish successfully
            type: boolean
          was_stopped:
            title: Was Stopped
            description: Was the action stopped by a Stop event
            type: boolean
          failure_reason:
            title: Failure Reason
            description: Reason for action failure in case the action did not execute
              successfully
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_finished_at
        - is_success
    GestureBotActionStarted:
      name: GestureBotActionStarted
      title: GestureBotActionStarted
      summary: The bot has started to perform the gesture.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - GestureBotActionStarted
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_gesture
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_started_at:
            title: Action Started At
            description: The timestamp of when the action has started.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_started_at
    GestureUserActionFinished:
      name: GestureUserActionFinished
      title: GestureUserActionFinished
      summary: The user performed a gesture.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - GestureUserActionFinished
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - user_upper_body
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_finished_at:
            title: Action Finished At
            description: The timestamp of when the action has finished.
            type: string
            format: date-time
          is_success:
            title: Is Success
            description: Did the action finish successfully
            type: boolean
          was_stopped:
            title: Was Stopped
            description: Was the action stopped by a Stop event
            type: boolean
          failure_reason:
            title: Failure Reason
            description: Reason for action failure in case the action did not execute
              successfully
            type: string
          user_id:
            title: User Id
            description: An ID identifying the user performing the action. This field
              is required if you support multi-user interactions.
            type: string
          gesture:
            title: Gesture
            description: Human readable name of the gesture. Availability of gestures
              depends on the interaction system.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_finished_at
        - is_success
        - gesture
    GestureUserActionStarted:
      name: GestureUserActionStarted
      title: GestureUserActionStarted
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - GestureUserActionStarted
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - user_upper_body
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_started_at:
            title: Action Started At
            description: The timestamp of when the action has started.
            type: string
            format: date-time
          user_id:
            title: User Id
            description: An ID identifying the user performing the action. This field
              is required if you support multi-user interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_started_at
    MotionEffectCameraActionFinished:
      name: MotionEffectCameraActionFinished
      title: MotionEffectCameraActionFinished
      summary: Camera effect finished.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - MotionEffectCameraActionFinished
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - camera_motion_effect
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_finished_at:
            title: Action Finished At
            description: The timestamp of when the action has finished.
            type: string
            format: date-time
          is_success:
            title: Is Success
            description: Did the action finish successfully
            type: boolean
          was_stopped:
            title: Was Stopped
            description: Was the action stopped by a Stop event
            type: boolean
          failure_reason:
            title: Failure Reason
            description: Reason for action failure in case the action did not execute
              successfully
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_finished_at
        - is_success
    MotionEffectCameraActionStarted:
      name: MotionEffectCameraActionStarted
      title: MotionEffectCameraActionStarted
      summary: Camera effect started.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - MotionEffectCameraActionStarted
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - camera_motion_effect
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_started_at:
            title: Action Started At
            description: The timestamp of when the action has started.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_started_at
    PipelineAcquired:
      name: PipelineAcquired
      title: PipelineAcquired
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - PipelineAcquired
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          stream_uid:
            title: Stream Uid
            description: A unique identifier for the stream
            type: string
          session_uid:
            title: Session Uid
            description: A unique identifier for the session
            type: string
          user_uid:
            title: User Uid
            description: A unique identifier for the user
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - stream_uid
    PipelineReleased:
      name: PipelineReleased
      title: PipelineReleased
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - PipelineReleased
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          stream_uid:
            title: Stream Uid
            description: A unique identifier for the stream
            type: string
          session_uid:
            title: Session Uid
            description: A unique identifier for the session
            type: string
          user_uid:
            title: User Uid
            description: A unique identifier for the user
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - stream_uid
    PipelineUpdated:
      name: PipelineUpdated
      title: PipelineUpdated
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - PipelineUpdated
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          stream_uid:
            title: Stream Uid
            description: A unique identifier for the stream
            type: string
          session_uid:
            title: Session Uid
            description: A unique identifier for the session
            type: string
          user_uid:
            title: User Uid
            description: A unique identifier for the user
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - stream_uid
    PositionBotActionFinished:
      name: PositionBotActionFinished
      title: PositionBotActionFinished
      summary: "The bot shifted back to the original position before this action.\n\
        This might be a neutral position or the position of any PositionBotAction\
        \ overwritten\nby this action that now gains the \u201Cfocus\u201D."
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - PositionBotActionFinished
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_position
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_finished_at:
            title: Action Finished At
            description: The timestamp of when the action has finished.
            type: string
            format: date-time
          is_success:
            title: Is Success
            description: Did the action finish successfully
            type: boolean
          was_stopped:
            title: Was Stopped
            description: Was the action stopped by a Stop event
            type: boolean
          failure_reason:
            title: Failure Reason
            description: Reason for action failure in case the action did not execute
              successfully
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_finished_at
        - is_success
    PositionBotActionStarted:
      name: PositionBotActionStarted
      title: PositionBotActionStarted
      summary: The bot has started to transition to the new position
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - PositionBotActionStarted
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_position
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_started_at:
            title: Action Started At
            description: The timestamp of when the action has started.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_started_at
    PositionBotActionUpdated:
      name: PositionBotActionUpdated
      title: PositionBotActionUpdated
      summary: The bot has arrived at the position and is maintaining that position
        for the entire action duration.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - PositionBotActionUpdated
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_position
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_updated_at:
            title: Action Updated At
            description: The timestamp of when the action has been updated.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          position_reached:
            title: Position Reached
            description: The position the bot has reached.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_updated_at
        - position_reached
    PostureBotActionFinished:
      name: PostureBotActionFinished
      title: PostureBotActionFinished
      summary: The posture was stopped.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - PostureBotActionFinished
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_posture
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_finished_at:
            title: Action Finished At
            description: The timestamp of when the action has finished.
            type: string
            format: date-time
          is_success:
            title: Is Success
            description: Did the action finish successfully
            type: boolean
          was_stopped:
            title: Was Stopped
            description: Was the action stopped by a Stop event
            type: boolean
          failure_reason:
            title: Failure Reason
            description: Reason for action failure in case the action did not execute
              successfully
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_finished_at
        - is_success
    PostureBotActionStarted:
      name: PostureBotActionStarted
      title: PostureBotActionStarted
      summary: The bot has attained the posture.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - PostureBotActionStarted
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_posture
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_started_at:
            title: Action Started At
            description: The timestamp of when the action has started.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_started_at
    PresenceUserActionFinished:
      name: PresenceUserActionFinished
      title: PresenceUserActionFinished
      summary: The interactive system detects the user's absence
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - PresenceUserActionFinished
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - user_presence
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_finished_at:
            title: Action Finished At
            description: The timestamp of when the action has finished.
            type: string
            format: date-time
          is_success:
            title: Is Success
            description: Did the action finish successfully
            type: boolean
          was_stopped:
            title: Was Stopped
            description: Was the action stopped by a Stop event
            type: boolean
          failure_reason:
            title: Failure Reason
            description: Reason for action failure in case the action did not execute
              successfully
            type: string
          user_id:
            title: User Id
            description: An ID identifying the user performing the action. This field
              is required if you support multi-user interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_finished_at
        - is_success
    PresenceUserActionStarted:
      name: PresenceUserActionStarted
      title: PresenceUserActionStarted
      summary: The interactive system detects the presence of a user in the system.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - PresenceUserActionStarted
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - user_presence
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_started_at:
            title: Action Started At
            description: The timestamp of when the action has started.
            type: string
            format: date-time
          user_id:
            title: User Id
            description: An ID identifying the user performing the action. This field
              is required if you support multi-user interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_started_at
    RestApiCallBotActionFinished:
      name: RestApiCallBotActionFinished
      title: RestApiCallBotActionFinished
      summary: API call finished
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - RestApiCallBotActionFinished
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - web_request
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_finished_at:
            title: Action Finished At
            description: The timestamp of when the action has finished.
            type: string
            format: date-time
          is_success:
            title: Is Success
            description: Did the action finish successfully
            type: boolean
          was_stopped:
            title: Was Stopped
            description: Was the action stopped by a Stop event
            type: boolean
          failure_reason:
            title: Failure Reason
            description: Reason for action failure in case the action did not execute
              successfully
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          response:
            title: Response
            description: Response of call
            type: object
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_finished_at
        - is_success
        - response
    RestApiCallBotActionStarted:
      name: RestApiCallBotActionStarted
      title: RestApiCallBotActionStarted
      summary: API call started
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - RestApiCallBotActionStarted
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - web_request
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_started_at:
            title: Action Started At
            description: The timestamp of when the action has started.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_started_at
    ShotCameraActionFinished:
      name: ShotCameraActionFinished
      title: ShotCameraActionFinished
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - ShotCameraActionFinished
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - camera_shot
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_finished_at:
            title: Action Finished At
            description: The timestamp of when the action has finished.
            type: string
            format: date-time
          is_success:
            title: Is Success
            description: Did the action finish successfully
            type: boolean
          was_stopped:
            title: Was Stopped
            description: Was the action stopped by a Stop event
            type: boolean
          failure_reason:
            title: Failure Reason
            description: Reason for action failure in case the action did not execute
              successfully
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_finished_at
        - is_success
    ShotCameraActionStarted:
      name: ShotCameraActionStarted
      title: ShotCameraActionStarted
      summary: The camera shot started
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - ShotCameraActionStarted
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - camera_shot
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_started_at:
            title: Action Started At
            description: The timestamp of when the action has started.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_started_at
    StartCustomBotAction:
      name: StartCustomBotAction
      title: StartCustomBotAction
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StartCustomBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - custom
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          custom_action_name:
            title: Custom Action Name
            description: The name of the custom action.
            type: string
          parameters:
            title: Parameters
            description: Any parameters for the action.
            type: object
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - custom_action_name
        - parameters
    StartExpectationBotAction:
      name: StartExpectationBotAction
      title: StartExpectationBotAction
      summary: '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.)'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StartExpectationBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_expectation
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          expected_event:
            title: Expected Event
            oneOf:
            - $ref: '#/components/messages/ChangeUtteranceBotAction'
            - $ref: '#/components/messages/StartUtteranceBotAction'
            - $ref: '#/components/messages/StopUtteranceBotAction'
            - $ref: '#/components/messages/UtteranceBotActionFinished'
            - $ref: '#/components/messages/UtteranceBotActionStarted'
            - $ref: '#/components/messages/UtteranceBotActionScriptUpdated'
            - $ref: '#/components/messages/UtteranceUserActionFinished'
            - $ref: '#/components/messages/UtteranceUserActionStarted'
            - $ref: '#/components/messages/UtteranceUserActionTranscriptUpdated'
            - $ref: '#/components/messages/UtteranceUserActionIntensityUpdated'
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - expected_event
    StartExpectationSignalingBotAction:
      name: StartExpectationSignalingBotAction
      title: StartExpectationSignalingBotAction
      summary: The bot is waiting for an event for a specific modality.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StartExpectationSignalingBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_expectation
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          modality:
            $ref: '#/components/schemas/ActionModality'
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - modality
    StartFacialGestureBotAction:
      name: StartFacialGestureBotAction
      title: StartFacialGestureBotAction
      summary: The bot should start making a facial gesture.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StartFacialGestureBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_face
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - replace
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          facial_gesture:
            title: Facial Gesture
            description: '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

              '
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - facial_gesture
    StartGestureBotAction:
      name: StartGestureBotAction
      title: StartGestureBotAction
      summary: The bot should start making a specific gesture.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StartGestureBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_gesture
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          gesture:
            title: Gesture
            description: '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`'
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - gesture
    StartMotionEffectCameraAction:
      name: StartMotionEffectCameraAction
      title: StartMotionEffectCameraAction
      summary: Perform the described camera motion effect.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StartMotionEffectCameraAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - camera_motion_effect
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          effect:
            title: Effect
            description: '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

              '
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - effect
    StartPositionBotAction:
      name: StartPositionBotAction
      title: StartPositionBotAction
      summary: The bot needs to hold a new position.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StartPositionBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_position
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          position:
            title: Position
            description: "Specify the position the bot needs to move to and maintain.\n\
              Availability of positions depends on the interactive system. Positions\
              \ are typically structured hierarchically into base position and position\
              \ modifiers (\u201Coff center\u201D).\n\nMinimal NLD set:\nThe following\
              \ base positions are supported by all interactive systems (that support\
              \ this action):\ncenter : Default position of the bot\nleft : Bot should\
              \ be positioned to the left (from the point of view of the bot)\nright:\
              \ Bot should be positioned to the right (from the point of view of the\
              \ bot)\n"
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - position
    StartPostureBotAction:
      name: StartPostureBotAction
      title: StartPostureBotAction
      summary: The bot should start adopting the specified posture.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StartPostureBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_posture
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          posture:
            title: Posture
            description: "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.:  \u201Cidle\u201D, \u201Cattentive\u201D"
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - posture
    StartRestApiCallBotAction:
      name: StartRestApiCallBotAction
      title: StartRestApiCallBotAction
      summary: Start an API call.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StartRestApiCallBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - web_request
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          request_type:
            description: Request type
            allOf:
            - $ref: '#/components/schemas/RequestType'
          url:
            title: Url
            description: REST API endpoint
            type: string
          headers:
            title: Headers
            description: Custom headers
            type: object
          payload:
            title: Payload
            description: Dict that will be converted to JSON and Content-Type header
              set to application/json
            type: object
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - request_type
        - url
    StartShotCameraAction:
      name: StartShotCameraAction
      title: StartShotCameraAction
      summary: Start a new shot.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StartShotCameraAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - camera_shot
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          shot:
            title: Shot
            description: '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

              '
            type: string
          start_transition:
            title: Start Transition
            description: '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

              '
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - shot
        - start_transition
    StartTimerBotAction:
      name: StartTimerBotAction
      title: StartTimerBotAction
      summary: Start a timer.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StartTimerBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - time
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          duration:
            title: Duration
            description: 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).
            type: number
            format: time-delta
          timer_name:
            title: Timer Name
            description: Name for the timer
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - duration
    StartUtteranceBotAction:
      name: StartUtteranceBotAction
      title: StartUtteranceBotAction
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StartUtteranceBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_speech
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - replace
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          script:
            title: Script
            description: The utterance of the bot, supporting SSML
            type: string
          intensity:
            title: Intensity
            description: "A value from 0-1 that indicates the intensity of the utterance.\
              \ A value of 0.5 means an \u201Caverage\u201D 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."
            type: number
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - script
    StartVisualChoiceSceneAction:
      name: StartVisualChoiceSceneAction
      title: StartVisualChoiceSceneAction
      summary: Present a choice in the scene to the user.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StartVisualChoiceSceneAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - information
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          prompt:
            title: Prompt
            description: Describes the choice you are offering to the user
            type: string
          image:
            title: Image
            description: Description of an image that should be shown alongside the
              choice.
            type: string
          support_prompts:
            title: Support Prompts
            description: List of prompts supporting the user in making a choice
            type: array
            items:
              type: string
          options:
            title: Options
            description: List of options for the user to choose from
            type: array
            items:
              $ref: '#/components/schemas/VisualChoiceOption'
          choice_type:
            description: Configures the type of choice the user can make.
            allOf:
            - $ref: '#/components/schemas/ChoiceType'
          allow_multiple_choices:
            title: Allow Multiple Choices
            description: Indicate if the user should be able to select multiple choices
              from the presented options
            type: boolean
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - prompt
        - options
        - choice_type
        - allow_multiple_choices
    StartVisualFormSceneAction:
      name: StartVisualFormSceneAction
      title: StartVisualFormSceneAction
      summary: Present a visual form that is requesting certain inputs from the user
        in the scene to the user.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StartVisualFormSceneAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - information
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          prompt:
            title: Prompt
            description: Describes the inputs you are requesting from the user
            type: string
          image:
            title: Image
            description: Description of an image that should be shown alongside the
              prompt.
            type: string
          support_prompts:
            title: Support Prompts
            description: List of prompts supporting the user in making a choice
            type: array
            items:
              type: string
          inputs:
            title: Inputs
            description: List of inputs required.
            type: array
            items:
              $ref: '#/components/schemas/VisualFormInputs'
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - prompt
        - inputs
    StartVisualInformationSceneAction:
      name: StartVisualInformationSceneAction
      title: StartVisualInformationSceneAction
      summary: Present information in the scene to the user.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StartVisualInformationSceneAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - information
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          title:
            title: Title
            description: Describes the choice you are offering to the user
            type: string
          summary:
            title: Summary
            description: Summary of the information to be shown to the user
            type: string
          support_prompts:
            title: Support Prompts
            description: List of prompts supporting the user in making a choice
            type: array
            items:
              type: string
          content:
            title: Content
            description: List of options for the user to choose from
            type: array
            items:
              $ref: '#/components/schemas/VisualInformationContent'
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - title
        - content
    StopCustomBotAction:
      name: StopCustomBotAction
      title: StopCustomBotAction
      summary: An action needs to be stopped.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StopCustomBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - custom
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          custom_action_name:
            title: Custom Action Name
            description: The name of the custom action.
            type: string
          parameters:
            title: Parameters
            description: Any parameters for the action.
            type: object
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - custom_action_name
        - parameters
    StopExpectationBotAction:
      name: StopExpectationBotAction
      title: StopExpectationBotAction
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StopExpectationBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_expectation
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
    StopExpectationSignalingBotAction:
      name: StopExpectationSignalingBotAction
      title: StopExpectationSignalingBotAction
      summary: Stop waiting for an event on the modality.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StopExpectationSignalingBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_expectation
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
    StopFacialGestureBotAction:
      name: StopFacialGestureBotAction
      title: StopFacialGestureBotAction
      summary: "Stop the facial gesture or expression.\nAll gestures have a limited\
        \ lifetime and finish on \u201Ctheir own\u201D\n(e.g., in an interactive avatar\
        \ system a \u201Csmile\u201D gesture could be implemented by a 1 second animation\
        \ clip where\nsome facial bones are animated). The IM can use this action\
        \ to stop an expression\nbefore it would be naturally done."
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StopFacialGestureBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_face
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - replace
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
    StopGestureBotAction:
      name: StopGestureBotAction
      title: StopGestureBotAction
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StopGestureBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_gesture
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
    StopMotionEffectCameraAction:
      name: StopMotionEffectCameraAction
      title: StopMotionEffectCameraAction
      summary: "Stop the camera effect . All effects have a limited lifetime and finish\
        \ \u201Con their own\u201D\n(e.g., in an interactive avatar system a \u201C\
        shake\u201D effect could be implemented by a 1 second camera motion).\nThe\
        \ IM can use this action to stop a camera effect before it would be naturally\
        \ done."
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StopMotionEffectCameraAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - camera_motion_effect
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
    StopPositionBotAction:
      name: StopPositionBotAction
      title: StopPositionBotAction
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StopPositionBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_position
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
    StopPostureBotAction:
      name: StopPostureBotAction
      title: StopPostureBotAction
      summary: 'Stop the posture. Postures have no lifetime,

        so unless the IM calls the Stop action the bot will keep the posture indefinitely.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StopPostureBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_posture
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
    StopShotCameraAction:
      name: StopShotCameraAction
      title: StopShotCameraAction
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StopShotCameraAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - camera_shot
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          stop_transition:
            title: Stop Transition
            description: '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'
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - stop_transition
    StopTimerBotAction:
      name: StopTimerBotAction
      title: StopTimerBotAction
      summary: Stop the timer.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StopTimerBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - time
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
    StopUtteranceBotAction:
      name: StopUtteranceBotAction
      title: StopUtteranceBotAction
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StopUtteranceBotAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_speech
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - replace
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
    StopUtteranceUserAction:
      name: StopUtteranceUserAction
      title: StopUtteranceUserAction
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StopUtteranceUserAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - user_speech
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - replace
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          user_id:
            title: User Id
            description: An ID identifying the user performing the action. This field
              is required if you support multi-user interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
    StopVisualChoiceSceneAction:
      name: StopVisualChoiceSceneAction
      title: StopVisualChoiceSceneAction
      summary: Stop presenting the choice to the user.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StopVisualChoiceSceneAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - information
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
    StopVisualFormSceneAction:
      name: StopVisualFormSceneAction
      title: StopVisualFormSceneAction
      summary: Stop presenting the form to the user.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StopVisualFormSceneAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - information
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
    StopVisualInformationSceneAction:
      name: StopVisualInformationSceneAction
      title: StopVisualInformationSceneAction
      summary: Stop presenting the information to the user
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - StopVisualInformationSceneAction
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - information
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
    TimerBotActionFinished:
      name: TimerBotActionFinished
      title: TimerBotActionFinished
      summary: Timer finished.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - TimerBotActionFinished
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - time
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_finished_at:
            title: Action Finished At
            description: The timestamp of when the action has finished.
            type: string
            format: date-time
          is_success:
            title: Is Success
            description: Did the action finish successfully
            type: boolean
          was_stopped:
            title: Was Stopped
            description: Was the action stopped by a Stop event
            type: boolean
          failure_reason:
            title: Failure Reason
            description: Reason for action failure in case the action did not execute
              successfully
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_finished_at
        - is_success
    TimerBotActionStarted:
      name: TimerBotActionStarted
      title: TimerBotActionStarted
      summary: Timer started.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - TimerBotActionStarted
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - time
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - parallel
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_started_at:
            title: Action Started At
            description: The timestamp of when the action has started.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_started_at
    UserIntent:
      name: UserIntent
      title: UserIntent
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - UserIntent
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          intent:
            title: Intent
            description: Canonical form of the user's intent
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - intent
    UserMovement:
      name: UserMovement
      title: UserMovement
      summary: A specific user movement was detected.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - UserMovement
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          movement:
            title: Movement
            description: e.g. 'move', 'lean', 'blink', 'point to', 'nod', 'shake head'
            type: string
          parameters:
            title: Parameters
            description: Specific movement parameters.
            type: object
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - movement
        - parameters
    UtteranceBotActionFinished:
      name: UtteranceBotActionFinished
      title: UtteranceBotActionFinished
      summary: The bot utterance finished, either because the utterance has been delivered
        to the user or the action was stopped.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - UtteranceBotActionFinished
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_speech
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - replace
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_finished_at:
            title: Action Finished At
            description: The timestamp of when the action has finished.
            type: string
            format: date-time
          is_success:
            title: Is Success
            description: Did the action finish successfully
            type: boolean
          was_stopped:
            title: Was Stopped
            description: Was the action stopped by a Stop event
            type: boolean
          failure_reason:
            title: Failure Reason
            description: Reason for action failure in case the action did not execute
              successfully
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          final_script:
            title: Final Script
            description: Final transcript of the bot utterance
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_finished_at
        - is_success
        - final_script
    UtteranceBotActionScriptUpdated:
      name: UtteranceBotActionScriptUpdated
      title: UtteranceBotActionScriptUpdated
      summary: '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'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - UtteranceBotActionScriptUpdated
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_speech
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - replace
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_updated_at:
            title: Action Updated At
            description: The timestamp of when the action has been updated.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          interim_script:
            title: Interim Script
            description: Partial script of the bot utterance up to this point in time
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_updated_at
        - interim_script
    UtteranceBotActionStarted:
      name: UtteranceBotActionStarted
      title: UtteranceBotActionStarted
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - UtteranceBotActionStarted
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - bot_speech
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - replace
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_started_at:
            title: Action Started At
            description: The timestamp of when the action has started.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_started_at
    UtteranceUserActionFinished:
      name: UtteranceUserActionFinished
      title: UtteranceUserActionFinished
      summary: The user utterance has finished.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - UtteranceUserActionFinished
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - user_speech
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - replace
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_finished_at:
            title: Action Finished At
            description: The timestamp of when the action has finished.
            type: string
            format: date-time
          is_success:
            title: Is Success
            description: Did the action finish successfully
            type: boolean
          was_stopped:
            title: Was Stopped
            description: Was the action stopped by a Stop event
            type: boolean
          failure_reason:
            title: Failure Reason
            description: Reason for action failure in case the action did not execute
              successfully
            type: string
          user_id:
            title: User Id
            description: An ID identifying the user performing the action. This field
              is required if you support multi-user interactions.
            type: string
          final_transcript:
            title: Final Transcript
            description: Final transcript of the user utterance
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_finished_at
        - is_success
        - final_transcript
    UtteranceUserActionIntensityUpdated:
      name: UtteranceUserActionIntensityUpdated
      title: UtteranceUserActionIntensityUpdated
      summary: Provides updated speaking intensity levels if the interactive system
        supports it.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - UtteranceUserActionIntensityUpdated
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - user_speech
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - replace
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_updated_at:
            title: Action Updated At
            description: The timestamp of when the action has been updated.
            type: string
            format: date-time
          user_id:
            title: User Id
            description: An ID identifying the user performing the action. This field
              is required if you support multi-user interactions.
            type: string
          intensity:
            title: Intensity
            description: "A value from 0-1 that indicates the intensity of the utterance.\
              \ A value of 0.5 means an \u201Caverage\u201D 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\u2019\
              s voice."
            type: number
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_updated_at
        - intensity
    UtteranceUserActionStarted:
      name: UtteranceUserActionStarted
      title: UtteranceUserActionStarted
      summary: The user started to produce an utterance. The user could have started
        talking or typing for example.
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - UtteranceUserActionStarted
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - user_speech
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - replace
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_started_at:
            title: Action Started At
            description: The timestamp of when the action has started.
            type: string
            format: date-time
          user_id:
            title: User Id
            description: An ID identifying the user performing the action. This field
              is required if you support multi-user interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_started_at
    UtteranceUserActionTranscriptUpdated:
      name: UtteranceUserActionTranscriptUpdated
      title: UtteranceUserActionTranscriptUpdated
      summary: Provides updated transcripts during a UtteranceUserAction
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - UtteranceUserActionTranscriptUpdated
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - user_speech
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - replace
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - limited
            type: string
          action_updated_at:
            title: Action Updated At
            description: The timestamp of when the action has been updated.
            type: string
            format: date-time
          user_id:
            title: User Id
            description: An ID identifying the user performing the action. This field
              is required if you support multi-user interactions.
            type: string
          interim_transcript:
            title: Interim Transcript
            description: Partial transcript of the user utterance up to this point
              in time
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_updated_at
        - interim_transcript
    VisualChoiceSceneActionChoiceUpdated:
      name: VisualChoiceSceneActionChoiceUpdated
      title: VisualChoiceSceneActionChoiceUpdated
      summary: '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.'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - VisualChoiceSceneActionChoiceUpdated
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - information
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_updated_at:
            title: Action Updated At
            description: The timestamp of when the action has been updated.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          current_choice:
            title: Current Choice
            description: List of Option IDs if the user made a choice
            type: array
            items:
              type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_updated_at
        - current_choice
    VisualChoiceSceneActionConfirmationUpdated:
      name: VisualChoiceSceneActionConfirmationUpdated
      title: VisualChoiceSceneActionConfirmationUpdated
      summary: "Whenever the user confirms or tries to abort the choice when interacting\
        \ with the visual representation\nof the choice.\nExamples of this include:\
        \ clicking a \u201Cconfirm\u201D button, \u201Cclicking on close\u201D"
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - VisualChoiceSceneActionConfirmationUpdated
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - information
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_updated_at:
            title: Action Updated At
            description: The timestamp of when the action has been updated.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          confirmation_status:
            description: Status of the choice confirmation by the user.
            allOf:
            - $ref: '#/components/schemas/ConfirmationStatus'
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_updated_at
        - confirmation_status
    VisualChoiceSceneActionFinished:
      name: VisualChoiceSceneActionFinished
      title: VisualChoiceSceneActionFinished
      summary: The choice action was stopped by the IM. (no user action will cause
        the action to be finished by the Action Server).
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - VisualChoiceSceneActionFinished
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - information
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_finished_at:
            title: Action Finished At
            description: The timestamp of when the action has finished.
            type: string
            format: date-time
          is_success:
            title: Is Success
            description: Did the action finish successfully
            type: boolean
          was_stopped:
            title: Was Stopped
            description: Was the action stopped by a Stop event
            type: boolean
          failure_reason:
            title: Failure Reason
            description: Reason for action failure in case the action did not execute
              successfully
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          final_choice:
            title: Final Choice
            description: List of options for the user to choose from
            type: array
            items:
              type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_finished_at
        - is_success
        - final_choice
    VisualChoiceSceneActionStarted:
      name: VisualChoiceSceneActionStarted
      title: VisualChoiceSceneActionStarted
      summary: The system has started presenting the choice to the user
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - VisualChoiceSceneActionStarted
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - information
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_started_at:
            title: Action Started At
            description: The timestamp of when the action has started.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_started_at
    VisualFormSceneActionConfirmationUpdated:
      name: VisualFormSceneActionConfirmationUpdated
      title: VisualFormSceneActionConfirmationUpdated
      summary: "Whenever the user confirms or tries to abort the form input when interacting\
        \ with the visual representation\nof the form. Examples of this include: clicking\
        \ a \u201Cconfirm\u201D button, \u201Cclicking on close\u201D"
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - VisualFormSceneActionConfirmationUpdated
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - information
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_updated_at:
            title: Action Updated At
            description: The timestamp of when the action has been updated.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          confirmation_status:
            description: Status of the form input confirmation by the user.
            allOf:
            - $ref: '#/components/schemas/ConfirmationStatus'
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_updated_at
        - confirmation_status
    VisualFormSceneActionFinished:
      name: VisualFormSceneActionFinished
      title: VisualFormSceneActionFinished
      summary: Form action was stopped by the IM (no user action will cause the action
        to be finished by the Action Server).
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - VisualFormSceneActionFinished
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - information
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_finished_at:
            title: Action Finished At
            description: The timestamp of when the action has finished.
            type: string
            format: date-time
          is_success:
            title: Is Success
            description: Did the action finish successfully
            type: boolean
          was_stopped:
            title: Was Stopped
            description: Was the action stopped by a Stop event
            type: boolean
          failure_reason:
            title: Failure Reason
            description: Reason for action failure in case the action did not execute
              successfully
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          final_inputs:
            title: Final Inputs
            description: Final state of all inputs.
            type: array
            items:
              $ref: '#/components/schemas/VisualFormInputs'
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_finished_at
        - is_success
        - final_inputs
    VisualFormSceneActionInputUpdated:
      name: VisualFormSceneActionInputUpdated
      title: VisualFormSceneActionInputUpdated
      summary: '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).'
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - VisualFormSceneActionInputUpdated
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - information
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_updated_at:
            title: Action Updated At
            description: The timestamp of when the action has been updated.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          interim_inputs:
            title: Interim Inputs
            description: Final state of all inputs.
            type: array
            items:
              $ref: '#/components/schemas/VisualFormInputs'
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_updated_at
        - interim_inputs
    VisualFormSceneActionStarted:
      name: VisualFormSceneActionStarted
      title: VisualFormSceneActionStarted
      summary: The system has started presenting the the form to the user..
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - VisualFormSceneActionStarted
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - information
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_started_at:
            title: Action Started At
            description: The timestamp of when the action has started.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_started_at
    VisualInformationSceneActionConfirmationUpdated:
      name: VisualInformationSceneActionConfirmationUpdated
      title: VisualInformationSceneActionConfirmationUpdated
      summary: "Whenever the user confirms or tries to abort the visual information\
        \ shown in the screen.\nExamples of this include: clicking a \u201Cconfirm\u201D\
        \ button, \u201Cclicking on close\u201D"
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - VisualInformationSceneActionConfirmationUpdated
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - information
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_updated_at:
            title: Action Updated At
            description: The timestamp of when the action has been updated.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
          confirmation_status:
            description: Update on the confirmation status. User indicating to have
              understood or to cancel the visual information
            allOf:
            - $ref: '#/components/schemas/ConfirmationStatus'
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_updated_at
        - confirmation_status
    VisualInformationSceneActionFinished:
      name: VisualInformationSceneActionFinished
      title: VisualInformationSceneActionFinished
      summary: Information action was stopped by the IM (no user action will cause
        the action to be finished by the Action Server).
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - VisualInformationSceneActionFinished
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - information
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_finished_at:
            title: Action Finished At
            description: The timestamp of when the action has finished.
            type: string
            format: date-time
          is_success:
            title: Is Success
            description: Did the action finish successfully
            type: boolean
          was_stopped:
            title: Was Stopped
            description: Was the action stopped by a Stop event
            type: boolean
          failure_reason:
            title: Failure Reason
            description: Reason for action failure in case the action did not execute
              successfully
            type: string
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_finished_at
        - is_success
    VisualInformationSceneActionStarted:
      name: VisualInformationSceneActionStarted
      title: VisualInformationSceneActionStarted
      summary: The system has started presenting the information to the user..
      contentType: application/json
      payload:
        type: object
        properties:
          type:
            title: Type
            enum:
            - VisualInformationSceneActionStarted
            type: string
          uid:
            title: Uid
            description: A unique identifier for the event.
            type: string
          event_created_at:
            title: Event Created At
            description: The timestamp of when the event was created.
            type: string
            format: date-time
          source_uid:
            title: Source Uid
            description: A unique id of the source component that generated the event.
            type: string
          tags:
            title: Tags
            description: A list of key-value pairs associated with the event.Tags
              are propagated from input events to output events.
            type: object
          action_uid:
            title: Action Uid
            description: A unique id for the action.
            type: string
          action_info_modality:
            title: Action Info Modality
            enum:
            - information
            type: string
          action_info_modality_policy:
            title: Action Info Modality Policy
            enum:
            - override
            type: string
          action_info_lifetime:
            title: Action Info Lifetime
            enum:
            - indefinite
            type: string
          action_started_at:
            title: Action Started At
            description: The timestamp of when the action has started.
            type: string
            format: date-time
          bot_id:
            title: Bot Id
            description: An ID identifying the bot performing the action. This field
              is required if you support multi-bot interactions.
            type: string
        required:
        - type
        - uid
        - event_created_at
        - source_uid
        - action_uid
        - action_info_modality
        - action_info_modality_policy
        - action_started_at
  schemas:
    VisualChoiceOption:
      title: VisualChoiceOption
      type: object
      properties:
        id:
          title: Id
          description: ID of the option
          type: string
        text:
          title: Text
          description: Text to represent the option
          type: string
        image:
          title: Image
          description: NLD of image
          type: string
      required:
      - id
    ChoiceType:
      title: ChoiceType
      description: An enumeration.
      enum:
      - selection
      - search
      type: string
    RequestType:
      title: RequestType
      description: Request Type
      enum:
      - get
      - post
      - put
      type: string
    VisualFormInputs:
      title: VisualFormInputs
      type: object
      properties:
        id:
          title: Id
          type: string
        value:
          title: Value
          description: NLD of the type of input required
          type: string
        description:
          title: Description
          description: NLD of the type of input required
          type: string
      required:
      - id
      - value
      - description
    VisualInformationContent:
      title: VisualInformationContent
      type: object
      properties:
        text:
          title: Text
          description: Text to represent the option
          type: string
        image:
          title: Image
          description: NLD of image
          type: string
    ConfirmationStatus:
      title: ConfirmationStatus
      description: An enumeration.
      enum:
      - confirm
      - cancel
      - unknown
      type: string
    ActionModality:
      title: ActionModality
      description: An enumeration.
      enum:
      - 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
      type: string
