Speech to Text: get result

GET /api/technology/speech-to-text-whisper-enhanced/:task_id

Retrieve the result of an Enhanced Speech to Text Built on Whisper 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 an Enhanced Speech to Text Built on Whisper task.

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

application/json

Schema
Example (from schema)
task done
task rejected
task failed

Schema

task

object

required

task_id uuidrequired

state TaskInfoState (string)required

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

result

object

anyOf

SpeechToTextWhisperEnhancedResult

Result of an Enhanced Speech to Text Built on Whisper task.

one_best

object

required

One-best result of an Enhanced Speech to Text Built on Whisper.

segments

object[]

required

Array [

channel_number Channel Number (integer)required

Channel number (0-base indexed).

start_time Start Time (number)required

Start time of the segment

end_time End Time (number)required

End time of the segment

language Language (string)required

Language of the transcription

text Text (string)required

Transcription of the segment

words

object[]

required

Detailed per-word segmentation of the segment

Array [

start_time Start Time (number)required

Start time of the word (seconds)

end_time End Time (number)required

End time of the word (seconds)

text Text (string)required

Transcription of the word

]

error

object

anyOf

TaskErrorResult

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

MOD1
MOD2

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

MOD1
MOD2
MOD3
MOD4
MOD5

string

]

{
  "task": {
    "task_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "state": "pending"
  },
  "result": {},
  "error": {}
}

Enhanced Speech to Text Built on Whisper task done

{
  "task": {
    "task_id": "123e4567-e89b-12d3-a456-426614174000",
    "state": "done"
  },
  "result": {
    "one_best": {
      "segments": [
        {
          "channel_number": 0,
          "start_time": 0.61,
          "end_time": 1.67,
          "language": "en",
          "text": "Hi, how are you doing?",
          "words": [
            {
              "start_time": 0.61,
              "end_time": 0.96,
              "text": "Hi,"
            },
            {
              "start_time": 0.96,
              "end_time": 1.13,
              "text": "how"
            },
            {
              "start_time": 1.13,
              "end_time": 1.21,
              "text": "are"
            },
            {
              "start_time": 1.21,
              "end_time": 1.33,
              "text": "you"
            },
            {
              "start_time": 1.33,
              "end_time": 1.67,
              "text": "doing?"
            }
          ]
        },
        {
          "channel_number": 1,
          "start_time": 2.23,
          "end_time": 3.21,
          "language": "es",
          "text": "Hola, ¿cómo estás?",
          "words": [
            {
              "start_time": 2.23,
              "end_time": 2.51,
              "text": "Hola,"
            },
            {
              "start_time": 2.55,
              "end_time": 2.72,
              "text": "¿cómo"
            },
            {
              "start_time": 2.72,
              "end_time": 3.21,
              "text": "estás?"
            }
          ]
        }
      ]
    }
  }
}

Enhanced Speech to Text Built on Whisper task rejected

{
  "task": {
    "task_id": "123e4567-e89b-12d3-a456-426614174000",
    "state": "rejected"
  },
  "error": {
    "type": "task.validation-error",
    "message": "Task validation error.",
    "detail": []
  }
}

Enhanced Speech to Text Built on Whisper task failed

{
  "task": {
    "task_id": "123e4567-e89b-12d3-a456-426614174000",
    "state": "failed"
  },
  "error": {
    "type": "internal",
    "message": "Service error.",
    "detail": []
  }
}

Request payload data was invalid and could not be parsed.

application/json

Schema
Example (from schema)
request.invalid

Schema

type RequestErrorType (string)required

Possible values: [internal, resource.not-found, method.invalid, request.forbidden, request.invalid, request.validation-error, request.rate-limit-exceeded, request.size-limit-exceeded, storage.capacity-exceeded]

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

MOD1
MOD2

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

MOD1
MOD2
MOD3
MOD4
MOD5

string

]

{
  "type": "internal",
  "message": "string",
  "detail": [
    {
      "location": [
        0,
        "string"
      ],
      "message": "string",
      "type": "string",
      "context": {}
    }
  ]
}

Invalid request.

{
  "type": "request.invalid",
  "message": "Invalid request.",
  "detail": []
}

The requested task does not exist.

The provided task_id may be wrong or the task may have expired already.

application/json

Schema
Example (from schema)
not found

Schema

type RequestErrorType (string)required

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

MOD1
MOD2

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

MOD1
MOD2
MOD3
MOD4
MOD5

string

]

{
  "type": "internal",
  "message": "string",
  "detail": [
    {
      "location": [
        0,
        "string"
      ],
      "message": "string",
      "type": "string",
      "context": {}
    }
  ]
}

Task not found.

{
  "type": "resource.not-found",
  "message": "Resource not found.",
  "detail": [
    {
      "location": [
        "root"
      ],
      "message": "Task not found.",
      "type": "task.not-found",
      "context": {
        "task_id": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ]
}

Error during validation of request payload data occurred.

application/json

Schema
Example (from schema)
request validation error

Schema

type RequestErrorType (string)required

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

MOD1
MOD2

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

MOD1
MOD2
MOD3
MOD4
MOD5

string

]

{
  "type": "internal",
  "message": "string",
  "detail": [
    {
      "location": [
        0,
        "string"
      ],
      "message": "string",
      "type": "string",
      "context": {}
    }
  ]
}

Request validation error.

{
  "type": "request.validation-error",
  "message": "Request validation error.",
  "detail": []
}

Request rate limit exceeded.

The request may be retried after a while. The following response headers may be checked for details: retry-after, x-ratelimit-limit, x-ratelimit-remaining, x-ratelimit-reset.

Response Headers

retry-after
number
Header indicates how long the user agent should wait before making a follow-up request.
x-ratelimit-limit
number
Size of the current rate limiting window.
x-ratelimit-remaining
number
Remaining number of requests in the current rate limiting window.
x-ratelimit-reset
number
Time at which the current rate limiting window resets (in UTC epoch).

application/json

Schema
Example (from schema)
request.rate-limit-exceeded

Schema

type RequestErrorType (string)required

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

MOD1
MOD2

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

MOD1
MOD2
MOD3
MOD4
MOD5

string

]

{
  "type": "internal",
  "message": "string",
  "detail": [
    {
      "location": [
        0,
        "string"
      ],
      "message": "string",
      "type": "string",
      "context": {}
    }
  ]
}

Rate limit exceeded.

{
  "type": "request.rate-limit-exceeded",
  "message": "Rate limit exceeded: 1 per 5 second.",
  "detail": []
}

Speech to Text: get result

/api/technology/speech-to-text-whisper-enhanced/:task_id

Request​

Path Parameters

Header Parameters

Responses​

Request

Responses