Transcription Client Command Line Interface Guide

Adding otcli.exe to PATH

How to Add otcli.exe to PATH:

1. Right-click on "This PC" or "My Computer" and select "Properties".
2. Click on "Advanced system settings" on the left side.
3. Click the "Environment Variables" button.
4. Under "System variables", find and select the "Path" variable, then click "Edit".
5. Click "New" and add the full path to the directory containing otcli.exe (e.g., C:\Program Files\360converter Offline Transcriber).
6. Click "OK" to close all dialogs.
7. Restart any open command prompt windows for the changes to take effect.

After adding otcli.exe to your PATH, you can run it from any location without specifying the full path.

Introduction

The Transcription Client Command Line Interface (CLI) is a powerful tool designed to interact with our transcription service. It allows users to send transcription jobs, monitor their status, and retrieve results efficiently. This guide will walk you through the various functionalities and provide examples of how to use the CLI effectively.

Key Features

• Send transcription jobs with various options
• Specify source and target languages
• Define time ranges for transcription
• Add prompts to guide transcription
• Check job status
• Retrieve transcripts in different formats
• Get list of supported languages

Basic Usage

The basic syntax for using the Transcription Client CLI is:

otcli.exe --action <action> [options]

Where <action> is either "send" or "get", followed by various options depending on the action.

Use Cases

1. Basic Transcription Job

otcli.exe --action send --source "E:\audioForTesting\example.mp3"

This command sends a basic transcription job for the specified audio file using default settings.

2. Transcription with Specific Language

otcli.exe --action send --source "E:\audioForTesting\example.mp3" --language "es"

This command specifies that the audio is in Spanish (es).

3. Transcription with Translation to English

otcli.exe --action send --source "E:\audioForTesting\example.mp3" --language "fr" --target-language "English"

This command transcribes French audio and translates the result to English.

4. Transcription with Time Range

otcli.exe --action send --source "E:\audioForTesting\example.mp3" --start-time 30 --end-time 90

This command transcribes only the portion of the audio from 30 seconds to 90 seconds.

5. Transcription with Prompt

otcli.exe --action send --source "E:\audioForTesting\example.mp3" --prompt "This is a lecture about climate change"

This command includes a prompt to guide the transcription process.

6. Comprehensive Transcription Job

otcli.exe --action send --source "E:\audioForTesting\example.mp3" --language "de" --target-language "English" --start-time 60 --end-time 180 --prompt "This is a German podcast about renewable energy"

This command combines multiple options: it specifies German as the source language, requests translation to English, sets a time range from 60 to 180 seconds, and includes a prompt.

7. Get Job Status

otcli.exe --action get --get-type status --jobid JOB_ID_HERE

Replace JOB_ID_HERE with the actual job ID returned when you sent the job.

8. Get Transcript (Text Format)

otcli.exe --action get --get-type transcript --jobid JOB_ID_HERE --format txt

This command retrieves the transcript in plain text format.

9. Get Transcript (JSON Format) with Timestamps

otcli.exe --action get --get-type transcript --jobid JOB_ID_HERE --format json --timestamp

This command retrieves the transcript in JSON format, including timestamp information for each segment.

10. Get Supported Languages

otcli.exe --action get --get-type languages

This command fetches and displays the list of languages supported by the transcription service.

Additional Options

• --verbose: Add this flag to any command for more detailed output.
• --help: Display the help message with all available options.