Transcribe Files

transcribe_file_async.py

1. Upload File

First we upload the file with the transcribe_file_async() function. Once the request succeeds, the auto-assigned file_id is returned.

from soniox.speech_service import SpeechClient
from soniox.transcribe_file import transcribe_file_async

with SpeechClient() as client:
    file_id = transcribe_file_async(
        "<YOUR-AUDIO-FILE>", client, reference_name="test"
    )

You can use the reference_name to associate your internal file id with the uploaded file. It can be any string not longer than 256 characters, including the empty string, and duplicates are allowed. The service does not use this field, it is only for your reference.

2. Get Status

After the file has been uploaded, it will be in one of 4 states: QUEUED, TRANSCRIBING, COMPLETED or FAILED. We call the GetTranscribeAsyncStatus() function to check the status of the file.

status = client.GetTranscribeAsyncStatus(file_id)

If the file status is FAILED, the error message can be obtained from error_message field.

print(f"Transcription failed with error: {status.error_message}")

3. Get Result

Once the file status is COMPLETED, we call the GetTranscribeAsyncResult() function to retrieve transcription result.

result = client.GetTranscribeAsyncResult(file_id)
print("Words: " + " ".join(w.text for w in result.words))

Note, when using multi-channel audio with separate recognition per channel, the GetTranscribeAsyncResult() function returns a list of results, one for each channel.

4. Delete File

Once the transcription result has been obtained, the file should be deleted using DeleteTranscribeAsyncFile function.

client.DeleteTranscribeAsyncFile(file_id)

Example

Here is a complete code example transcribe_file_async.py on how to transcribe files with our client library.

Run

python3 transcribe_file_async.py

Output

Uploading file.
File ID: 3457
Calling GetTranscribeAsyncStatus.
Status: QUEUED
Calling GetTranscribeAsyncStatus.
Status: TRANSCRIBING
Calling GetTranscribeAsyncStatus.
Status: TRANSCRIBING
Calling GetTranscribeAsyncStatus.
Status: COMPLETED
Calling GetTranscribeAsyncResult
Words: But there is always a stronger sense of life when the sun is ...
Calling DeleteTranscribeAsyncFile.

transcribe_file_async.js

1. Upload File

First we upload the file with the transcribeFileAsync() function. Once the request succeeds, the auto-assigned file_id is returned.

const file_id = await speechClient.transcribeFileAsync(
    "<YOUR-AUDIO-FILE>",
    "test", // reference_name
);

You can use the reference_name to associate your internal file id with the uploaded file. It can be any string not longer than 256 characters, including the empty string, and duplicates are allowed. The service does not use this field, it is only for your reference.

2. Get Status

After the file has been uploaded, it will be in one of 4 states: QUEUED, TRANSCRIBING, COMPLETED or FAILED. We call the getTranscribeAsyncStatus() function to check the status of the file.

const response = await speechClient.getTranscribeAsyncStatus(file_id);

If the file status is FAILED, the error message can be obtained from error_message field.

console.log(`Transcription failed with error: ${response.error_message}`);

3. Get Result

Once the file status is COMPLETED, we call the GetTranscribeAsyncResult() function to retrieve transcription result.

const result = await speechClient.getTranscribeAsyncResult(file_id);
console.log(`Words: ${result.words.map((word) => word.text).join(" ")}`);

Note, when using multi-channel audio with separate recognition per channel, the GetTranscribeAsyncResult() function returns a list of results, one for each channel.

4. Delete File

Once the transcription result has been obtained, the file should be deleted using DeleteTranscribeAsyncFile function.

await speechClient.deleteTranscribeAsyncFile(file_id);

Example

Here is a complete code example transcribe_file_async.js on how to transcribe files with our client library.

Run

node transcribe_file_async.js

Output

Uploading file.
File ID: 3456
Calling getTranscribeAsyncStatus.
Status: QUEUED
Calling getTranscribeAsyncStatus.
Status: QUEUED
Calling getTranscribeAsyncStatus.
Status: TRANSCRIBING
Calling getTranscribeAsyncStatus.
Status: TRANSCRIBING
Calling getTranscribeAsyncStatus.
Status: COMPLETED
Calling getTranscribeAsyncResult
Words: But there is always a stronger sense of life when the sun is ...
Calling deleteTranscribeAsyncFile.

TranscribeFileAsync.cs

using Soniox.Types;
using Soniox.Client;
using Soniox.Client.Proto;

using var client = new SpeechClient();

var fileId = await client.TranscribeFileAsync(
    "../../test_data/test_audio_long.flac",
    new TranscriptionConfig { });

Console.WriteLine($"File ID: {fileId}");

TranscribeAsyncFileStatus status;
while (true)
{
    Console.WriteLine("Calling GetTranscribeAsyncFileStatus.");
    status = await client.GetTranscribeAsyncFileStatus(fileId);
    if (status.Status is "COMPLETED" or "FAILED")
    {
        break;
    }
    await Task.Delay(2000);
}

if (status.Status == "COMPLETED")
{
    Console.WriteLine("Calling GetTranscribeAsyncResult");
    var completeResult = await client.GetTranscribeAsyncResult(fileId);
    Result result = (completeResult as SingleResult)!.Result;
    Console.WriteLine(string.Join(" ", result.Words.Select(word => word.Text).ToList()));
}

Console.WriteLine("Calling DeleteTranscribeAsyncFile.");
await client.DeleteTranscribeAsyncFile(fileId);

1. Upload File

First we upload the file with the transcribeFileAsync() function. Once the request succeeds, the auto-assigned file_id is returned.

You can use the TranscriptionConfig.client_request_reference to associate your internal file id with the uploaded file. It can be any string not longer than 32 characters, including the empty string, and duplicates are allowed. The service does not use this field, it is only for your reference.

2. Get Status

After the file has been uploaded, it will be in one of 4 states: QUEUED, TRANSCRIBING, COMPLETED or FAILED. We call the GetTranscribeAsyncFileStatus() function to check the status of the file.

If the file status is FAILED, the error message can be obtained from status.ErrorMessage field.

3. Get Result

Once the file status is COMPLETED, we call the GetTranscribeAsyncResult() function to retrieve transcription result.

Note, when using multi-channel audio with separate recognition per channel, the GetTranscribeAsyncResult() function returns a list of results, one for each channel.

4. Delete File

Once the transcription result has been obtained, the file should be deleted using DeleteTranscribeAsyncFile function.

Run

cd soniox_examples/csharp/TranscribeFileAsync
dotnet run

Output

File ID: 3456
Calling GetTranscribeAsyncFileStatus.
Calling GetTranscribeAsyncFileStatus.
Calling GetTranscribeAsyncFileStatus.
Calling GetTranscribeAsyncFileStatus.
Calling GetTranscribeAsyncResult.
Words: But there is always a stronger sense of life when the sun is ...
Calling DeleteTranscribeAsyncFile.