Module Values.UtteranceSpecificationSource

An object containing information about a specific utterance.

Sourcetype nonrec t = {
  1. botAliasId : BotAliasId.t option;
    (*

    The identifier of the alias of the bot that the utterance was made to.

    *)
  2. botVersion : NumericalBotVersion.t option;
    (*

    The version of the bot that the utterance was made to.

    *)
  3. localeId : LocaleId.t option;
    (*

    The locale of the bot that the utterance was made to.

    *)
  4. sessionId : AnalyticsSessionId.t option;
    (*

    The identifier of the session that the utterance was made in.

    *)
  5. channel : AnalyticsChannel.t option;
    (*

    The channel that is integrated with the bot that the utterance was made to.

    *)
  6. mode : AnalyticsModality.t option;
    (*

    The mode of the session. The possible values are as follows: Speech – The session consisted of spoken dialogue. Text – The session consisted of written dialogue. DTMF – The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses. MultiMode – The session consisted of multiple modes.

    *)
  7. conversationStartTime : Timestamp.t option;
    (*

    The date and time when the conversation in which the utterance took place began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

    *)
  8. conversationEndTime : Timestamp.t option;
    (*

    The date and time when the conversation in which the utterance took place ended. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

    *)
  9. utterance : String_.t option;
    (*

    The text of the utterance.

    *)
  10. utteranceTimestamp : Timestamp.t option;
    (*

    The date and time when the utterance took place.

    *)
  11. audioVoiceDurationMillis : AnalyticsLongValue.t option;
    (*

    The duration in milliseconds of the audio associated with the utterance.

    *)
  12. utteranceUnderstood : UtteranceUnderstood.t option;
    (*

    Specifies whether the bot understood the utterance or not.

    *)
  13. inputType : String_.t option;
    (*

    The input type of the utterance. The possible values are as follows: PCM format: audio data must be in little-endian byte order. audio/l16; rate=16000; channels=1 audio/x-l16; sample-rate=16000; channel-count=1 audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false Opus format audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4 Text format text/plain; charset=utf-8

    *)
  14. outputType : String_.t option;
    (*

    The output type of the utterance. The possible values are as follows: audio/mpeg audio/ogg audio/pcm (16 KHz) audio/ (defaults to mpeg) text/plain; charset=utf-8

    *)
  15. associatedIntentName : Name.t option;
    (*

    The name of the intent that the utterance is associated to.

    *)
  16. associatedSlotName : Name.t option;
    (*

    The name of the slot that the utterance is associated to.

    *)
  17. intentState : IntentState.t option;
    (*

    The state of the intent that the utterance is associated to.

    *)
  18. dialogActionType : String_.t option;
    (*

    The type of dialog action that the utterance is associated to. See the type field in DialogAction for more information.

    *)
  19. botResponseAudioVoiceId : String_.t option;
    (*

    The identifier for the audio of the bot response.

    *)
  20. slotsFilledInSession : String_.t option;
    (*

    The slots that have been filled in the session by the time of the utterance.

    *)
  21. utteranceRequestId : Id.t option;
    (*

    The identifier of the request associated with the utterance.

    *)
  22. botResponses : UtteranceBotResponses.t option;
    (*

    A list of objects containing information about the bot response to the utterance.

    *)
}
Sourceval make : ?botAliasId:??? -> ?botVersion:??? -> ?localeId:??? -> ?sessionId:??? -> ?channel:??? -> ?mode:??? -> ?conversationStartTime:??? -> ?conversationEndTime:??? -> ?utterance:??? -> ?utteranceTimestamp:??? -> ?audioVoiceDurationMillis:??? -> ?utteranceUnderstood:??? -> ?inputType:??? -> ?outputType:??? -> ?associatedIntentName:??? -> ?associatedSlotName:??? -> ?intentState:??? -> ?dialogActionType:??? -> ?botResponseAudioVoiceId:??? -> ?slotsFilledInSession:??? -> ?utteranceRequestId:??? -> ?botResponses:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of UtteranceUnderstood.t | `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `String of String_.t | `Structure of (string * [> `List of [> `Structure of (string * [> `String of ButtonText.t ]) list ] list | `String of AttachmentTitle.t ]) list ]) list ] list | `Long of AnalyticsLongValue.t | `String of BotAliasId.t | `Timestamp of Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t