VIP Version

1 Feature Introduction

The Audio File Transcription service provides a feature that converts audio files into text. It supports two output formats: manuscripts and subtitles.

It supports transcription in languages such as Chinese, English, and Japanese.

For more details, please refer to the Developer Guides.

2 Invocation Limits

The file duration must be less than 5 hours.

The size of the audio file must be less than 1GB.

Supported file formats (mono or stereo): WAV/PCM/OPUS/MP3/AMR/3GP/AAC.

3 Invocation Process

(1) Uploading Files: Request File Transcription: The client sends an HTTP POST method request to the server with the file to be transcribed, and the server returns an HTTP response containing a task ID.

(2) Getting Transcription Results: There are two methods to obtain transcription results: Polling and Callback.

Polling: The client sends an HTTP GET method request to the server with the task ID returned by the Request File Transcription API, and the server returns an HTTP response containing the transcription results.

Callback: When uploading the file, a callback URL is provided. Once the transcription task is completed, the transcription results are automatically sent to the specified callback URL via an HTTP POST request.

4 Request URLs

5 Request File Transcription API

5.1 Request Line

POST /v1/asrfile/upload/vip

5.2 Request Header

5.3 Request Parameters

The client sends a request, in which parameters need to be set in the request body in form-data format. The meaning of each parameter is as follows:

5.4 Response Results

The Content-Type field in the HTTP Headers of all interface responses is always application/json. The response results are in the HTTP Body.

The fields of the response results are as follows:

5.4.1 Successful Response

The status field in the body is 000000.

Example of a successful response:

{
    "status": "000000",
    "message": "success",
    "data": {
        "task_id": "01e57746-5f50-490a-8e36-4ea1110c21cd",
        "duration": 23
    }
}

5.4.2 Error Response

If the status field in the body is not 000000, it indicates an error response. This field can be used as an indicator to determine whether the response was successful.

Example of an error response:

{
    "status": "200001",
    "message": "file Parameter Missing",
    "data": {
        "task_id": "38d19b08-b075-443e-af68-e8b990764b1e",
        "duration": 0
    }
}

6 Get Transcription Results API (Polling)

6.1 Request Line

GET /v1/asrfile/result

6.2 Request Parameters

When the client sends a request, the meaning of the query parameters is as follows:

6.3 Response Results

The Content-Type field in the HTTP Headers of all interface responses is always application/json. The response results are in the HTTP Body.

The fields of the response results are as follows:

6.3.1 Successful Response

When transcription is not completed yet,

the status field in the body is 000000.

the data field in the body is the description of this transcription task.

The data field is defined as follows:

Example of a successful response:

{
    "status": "000000",
    "message": "success",
    "data": {
        "desc": "Transcribing",
        "file_name": "test.mp3",
        "insert_time": "2022-11-11 12:42:04",
        "process_time": "2022-11-11 12:42:04",
        "progress": 67
    }
}

When transcription is completed,

the status field in the body is 000000.

the data.result field in the body is the transcription results of this task.

The transcription result fields are defined as follows:

Among them, the words object:

The data.statistics field in the body contains statistical information for this transcription task:

Among them, the keywords object:

The keywords objects are scored and returned based on a combination of frequency and importance (TF-IDF algorithm).

If you need to sort solely based on the keyword frequency, please use the frequency field.

Example of a successful response:

{
    "status": "000000",
    "message": "Success",
    "data": {
        "result": [
            {
                "begin": "00:00:01,170",
                "end": "00:00:04,610",
                "seg_num": 1,
                "transcript": "こんにちは。あの、お名前は何ですか？",
                "confidence": 0.9,
                "paragraph": 1,
                "lang_type": "ja-JP",
                "cluster_id": 1,
                "words": [
                    {
                        "word": "こんにちは",
                        "start_time": 80,
                        "end_time": 400,
                        "is_punc": false,
                        "keywords_index": 2,
                        "type": "normal"
                    },
                    {
                        "word": "。",
                        "start_time": 80,
                        "end_time": 400,
                        "is_punc": true,
                        "keywords_index": 0,
                        "type": "punc"
                    },
                    {
                        "word": "あの",
                        "start_time": 400,
                        "end_time": 860,
                        "is_punc": false,
                        "keywords_index": 0,
                        "type": "normal"
                    },
                     ……more……
                ]
            },
            {
                "begin": "00:00:04,630",
                "end": "00:00:07,010",
                "seg_num": 2,
                "transcript": "こんにちは。私はあきです，お名前は？",
                "confidence": 0.9,
                "paragraph": 1,
                "lang_type": "ja-JP",
                "cluster_id": 1,
                "words": [
                    ……more……
                ]
            }
        ],
        "statistics": {
            "finish_time": "2022-11-11 12:47:12",
            "insert_time": "2022-11-11 12:42:04",
            "process_time": "2022-11-11 12:46:28",
            "keywords": [
                {
                    "index": 1,
                    "words": "お名前",
                    "frequency": 2,
                    "time": [
                        {
                            "begin": "00:00:05,120",
                            "end": "00:00:05,590"
                        },
                        {
                            "begin": "00:00:13,420",
                            "end": "00:00:13,980"
                        }
                    ]
                }
            ],
            "speed": 210,
            "word_count": 86
        }
    }
}

6.3.2 Error Response

If the status field in the body is not 000000, it indicates an error response. This field can be used as an indicator to determine whether the response was successful.

Example of an error response:

{
    "status": "220404",
    "message": "task_id does not exist"
}

7 Callback of Transcription Results

If the callback_url parameter is specified when calling the Request File Transcription API, the system will automatically send the recognition results to the specified address in the form of an HTTP POST request upon completion (or failure) of the transcription.

The response result fields are as follows:

7.1.1 Successful Transcription

The data field in the transcription results is defined as follows:

{
    "status":"000000",
    "message":"success",
    "data":{
        "result":[
            {
                "begin": "00:00:01,170",
                "end": "00:00:04,610",
                "seg_num": 1,
                "transcript": "こんにちは。あの、お名前は何ですか？"
            },
            {
                "begin": "00:00:04,630",
                "end": "00:00:7,010",
                "seg_num": 2,
                "transcript": "こんにちは。私はあきです，お名前は？"
        	}
        ],
        "statistics": {
            "keywords":[],
            "speed": 210,
            "word_count": 86,
            "finish_time": "2022-11-11 12:47:12",
            "insert_time": "2022-11-11 12:42:04",
            "process_time": "2022-11-11 12:46:28",
        },
        "task_id":"27dc2487-bb02-4585-bd10-b75b445441bc"
    }
}

7.1.2 Transcription Failure

The field format is the same as described above, but the result field will be empty. For specific information about the task failure, please refer to the message field.

8 Task Query Interface

Tasks can be filtered based on certain conditions, and transcription results are only stored on the platform for one month. Please retrieve them as soon as possible.

8.1 Request Line

GET /v1/asrfile/tasks

8.2 Request Parameters

The client sends a request, and the meaning of the query parameters is as follows:

When the above filtering conditions are used in combination, they form an "AND" relationship.

8.3 Response Parameters

The Content-Type field in the HTTP Headers of all interface responses is application/json, and the response results are in the HTTP Body.

The response result fields are as follows: