Common tags
Name |
Values |
Description |
---|---|---|
callback (optional) |
URL: |
The URL to which the resultant transcript will POST. A callback is the address and (optionally) method name and parameters of a web application that can receive data via HTTP or HTTPS. Callbacks are usually used to enable another application to receive and directly interact with the produced transcripts. Once a callback returns success (indicated by HTTP code 200), the result is no longer available from V‑Cloud. If a callback fails, it will be retried until it succeeds or until a maximum number of retries is reached. Note:
V‑Cloud supports HTTP basic authentication for callbacks. If a callback server requires authentication information, prepend your access credentials to the hostname of the URL as shown in the following example:
|
callbackurl (optional) |
false (default), true |
Used to contain transcription results within a URL when posting to a callback host. If the value is set to false, the results file is posted directly to the callback host. If the value is set to true, a URL containing the results file is posted instead. Receiving results via URL is much lighter than the alternative (especially if Note:
A few things to consider when using
|
file (required) |
Supported zip file formats are zip (MIME type application/zip) and 7z (MIME type application/x-7z-compressed). The zip file can be password encrypted, with the Supported audio formats are PCM and ITU G.711. |
A single audio file or zip file that contains one or more audio files to process. The Linux
The key compatibility indicators are WAVE LPCM and ITU G.711. The sample rate may be between 8000 and 16000 Hz, where 8000 Hz is preferable. The file may also contain more than one channel. Tip: Transcoding from other audio formats is available as an optional licensed feature. Refer to Adjusting for audio for more information on the transcode parameter.
|
url (alternative to file) |
URL |
Available with V‑Cloud version 1.6 and later: Use The following The
The
The To use AWS as an audio source for the
Note: Voci recommends specifying the audio's MD5 sum with
filemd5=your-MD5-sum-here in requests that use presigned AWS URLs to submit audio data. If getting the MD5 sum is an issue, an alternative option is to disable MD5 verification with filemd5=false . |
filetype (optional) |
Content-Type |
Used to manually specify the
Note: In most cases, setting the
filetype is not necessary because the file type is automatically determined by the filename extension. However, in some situations, such as when a URL source does not contain a file extension, it may be necessary to manually specify the filetype . |
model (optional) |
see language models |
The |
output (optional) |
Values: json (default), jsontop, text |
Indicates the desired output format. Refer to output for more information on this parameter. |
token (required) |
Used to authenticate and authorize the request. You will receive a token from Voci Support to use with requests to the ASR server. All requests made with your token will be tied to your account. Please notify Voci Support immediately if your token is compromised or lost. | |
requestid |
The unique identifier for the request about which you want to retrieve results or status information. This is auto-generated and appears in the JSON output. |