Skip to main content

Time Analysis: get result

GET 
/api/technology/time-analysis/:task_id

Request the result of a Time Analysis task.

Request​

Path Parameters

    task_id uuidrequired

    ID of the task to get result of

Header Parameters

    x-correlation-id X-Correlation-Id

    Correlation ID is a special type of request ID which is unique over a series of requests and responses, identifying a transaction in a distributed system. Correlation ID will be generated if not provided.

    x-request-id X-Request-Id

    In distributed system architecture (microservices architecture) it is a unique ID of request and response combination throughout all components of a distributed system. Request ID will be generated if not provided.

Responses​

Result response of Time Analysis task.

The response body contains task info in the task field. Depending on the task processing outcome, either result or error field is populated.

Schema

    task

    object

    required

    task_id uuidrequired
    state TaskInfoState (string)required

    Possible values: [pending, running, rejected, failed, done]

    result

    object

    anyOf

    Result of Time Analysis task.

    Note: reaction_analyses is an empty list if any of the channels contains no speech, or there is only one channel.

    channel_analyses

    object[]

    required

  • Array [

    • channel_number Channel Number (integer)required

    Channel number (0-base indexed).

    speech_duration Speech Duration (number)required

    Duration of speech in the channel (in seconds)

    speech_rate

    object

    required

    anyOf

    Speech rate as the ratio of phonemes per second. Empty if the channel contains no speech.

    number

    Possible values: > 0

    total_duration Total Duration (number)required

    Total duration of audio in the channel (in seconds)

  • ]

    • reaction_analyses

    object[]

    required

  • Array [

    • reacting_channel Reacting Channel (integer)required

    Index of the channel whose reactions are analyzed.

    reactions_count Reactions Count (integer)required

    Number of reactions of this channel to the other channel. A 'reaction' is defined as the act when the speaker in the reacting channel starts speaking AFTER the speaker in the other channel has stopped speaking.

    average_reaction_time Average Reaction Time (number)required

    Average time that elapsed between when the speaker in the other channel stopped speaking and the speaker in the reacting channel started speaking.

    slowest_reaction_position

    object

    required

    Position of this channel's slowest reaction (longest reaction time).

    start_time Start Time (number)required

    Start time of the range (seconds)

    end_time End Time (number)required

    End time of the range (seconds)

    fastest_reaction_position

    object

    required

    Position of this channel's fastest reaction (shortest reaction time).

    start_time Start Time (number)required

    Start time of the range (seconds)

    end_time End Time (number)required

    End time of the range (seconds)

    crosstalks

    object[]

    required

    List of positions of this channel's crosstalks. A 'crosstalk' is defined as the act when the speaker in the reacting channel starts speaking WHILE the speaker in the other channel is still speaking. The crosstalk lasts as long as both speakers are speaking.

  • Array [

    • start_time Start Time (number)required

    Start time of the range (seconds)

    end_time End Time (number)required

    End time of the range (seconds)

  • ]

  • ]

    • error

    object

    anyOf

    Result schema for a failed or rejected task.

    type TaskErrorType (string)required

    Possible values: [internal, task.validation-error]

    Machine-readable error type.

    message Message (string)required

    Human-readable summary of the error.

    detail

    object[]

    Optional higher level of detail. It is intended for better understanding of the error or advanced error handling.

  • Array [

    • location

    object[]

    required

    Location of the error.

  • Array [

    • anyOf

    integer

  • ]

    • message Message (string)required

    Human-readable summary of the error.

    type Type (string)required

    Machine-readable error type.

    context

    object

    Optional key-value object with additional context

    property name*

    object

    anyOf

    string

  • ]

Loading...