Sample /config/folders JSON Output for a Folder
The following JSON shows sample output for a single folder from the information retrieved via the /config/folders API.
"DocTestCo": {
"DocTestCo-DocTesting": {
"Test01": {
"apps": [],
"asroptions": {
"billing": "customerX"
},
"audiotype": "Mono",
"callback": {
"aws_id": "123456789012345678901",
"aws_secret": "123456789012345678901/12345678901234567890",
"posturl": "S3:///joeuser/test",
"sendaudio": "no",
"sendtext": "no"
},
"created": "2017-05-18",
"custom_meta": [],
"mode": "active",
"modelchan0": "eng1:callcenter",
"nspeakers": 1,
"purifyaudio": true,
"purifytext": true,
"status": "OK",
"servers": [
"asrsrvr1"
]
},...
},...
},...When creating a new folder using the /config/folders API, all fields that are not read-only are required.
Name | Type | Values | Description | |
|---|---|---|---|---|
| Applications that are linked to this folder that will analyze this folder's content. "apps": [], | |||
| ASR stream tags that have been added to this folder. Tags are parameters that affect transcription requests. "asroptions": {
"billing": "customerX"
}, | |||
| REQUIRED when creating a new folder | Whether the audio is two-channel ("Stereo") or single-channel ("Mono") audio. "audiotype": "Mono", | ||
| Callback options for transcript delivery. For more information on using callbacks, see Using Callbacks in V‑Spark. "callback": {
"aws_id": "123456789012345678901",
"aws_secret": "123456789012345678901/12345678901234567890",
"posturl": "S3:///joeuser/test",
"sendaudio": "no",
"sendtext": "no"
}, | |||
| The path that V‑Spark will use to deliver transcripts and other information. This URL must start with a valid protocol, (such as "http://", "https://", "file://", "sftp://", or "s3://") and include any needed hostname, port number, and file system path. | |||
| REQUIRED if | Your AWS access key id. | ||
| REQUIRED if | Your AWS secret access key. | ||
| REQUIRED if | The username on the remote system that V‑Spark should use to log in. | ||
| REQUIRED if | The login password of the | ||
| REQUIRED | The ssh private key of the | ||
| REQUIRED if | yes, no | If set to "yes," V‑Spark will send an MP3 version of the transcribed audio file to the callback server. | |
| REQUIRED if | yes, no | If set to "yes," V‑Spark will send a plain text version of the transcribed audio file to the callback server. | |
| READ-ONLY Date, in YYYY-MM-DD format | The date that the folder was created. This field is added by V‑Spark when the folder is created, and is read-only. "created": "2017-05-18", | ||
| Custom metadata fields that are associated with this folder. "custom_meta": [
"client name",
"phone number"
], | |||
| active (default), paused | The "mode": "active", | ||
| Acceptable values are limited to the names of the language models you are licensed to use. All language models work with all supported audio formats. | The language model to use when processing audio on Channel 0, which is the left channel if you are processing stereo audio. "modelchan0": "eng1:callcenter", | ||
| Acceptable values are limited to the names of the language models you are licensed to use. All language models work with all supported audio formats. | The language model to use when processing audio on Channel 1, which is the right channel if you are processing stereo audio. If this folder is not configured to process stereo audio, you will not have a "modelchan1": "spa1:callcenter", | ||
| If this folder is configured to process stereo audio, the value of this field must be either "0" or "1," indicating the audio channel that contains agent speech. "agentchan": "0", | |||
| REQUIRED when creating a new folder. | The number of speakers in the audio files that are going to be placed into the folder. This option cannot be modified after the folder is created. "nspeakers": 1, | ||
| Boolean | true, false | If set to "true," processing cleans the generated audio MP3 of any locations where numbers exist for Payment Card Information (PCI) or other sensitive numbers that are in the audio source so that these numbers cannot be heard. If set to "false," audio is not scrubbed. This option cannot be modified after the folder is created. "purifyaudio": true, | |
| Boolean | true, false | If set to "true," processing cleans the text transcript of any numbers for Payment Card Information (PCI) or other sensitive numbers that are in the audio source. If set to "false," text is not scrubbed. This option cannot be modified after the folder is created. "purifytext": true, | |
| High-level status information about the folder, useful for long-running operations such as a DELETE. A status of "OK" indicates that any operations on the folder have completed their work. "status": "OK", | |||
| The name(s) of the V‑Spark servers that will be used for ASR. You must specify at least one server or "servers": [
"asrsrvr1" | |||
For more information about the information that is part of the definition of a folder, see the Creating a Folder section in the V‑Spark Management Guide.
The excerpt from the output of calling the /config/folders API shown previously is very similar to the output that you would have received had you requested information about a single folder by calling an API URL such as the /config/DocTestCo/DocTestCo-DocTesting/Test01 API on a V‑Spark installation where the "Doc Test Co" company, the "Doc Testing" organization, and the folder "Test01" (with the company short name, "DocTestCo," the Organization short name of "DocTestCo-DocTesting," and the folder name of "Test01") had been defined.
The latter call would have returned JSON like the sample below, which differs only from the output shown previously in that it does not need to identify the short name of the company, the short name of the organization, or the name of the folder that it refers to because they are specified in the URL.
{
"apps": [],
"asroptions": {
"billing": "DocTestCo-DocTesting-Test01"
},
"audiotype": "Mono",
"callback": {
"aws_id": "0SAMPLEVALUED0N0TUSE",
"aws_secret": "ThisIsAlsoASample000/NotARealAWSSecret00",
"posturl": "S3:///wvh/test",
"sendaudio": "no",
"sendtext": "no"
},
"created": "2017-05-18",
"custom_meta": [],
"mode": "active",
"modelchan0": "eng1:callcenter",
"nspeakers": 1,
"purifyaudio": true,
"purifytext": true,
"servers": [
"asrsrvr1"
]
}