V-Spark Online Help

Output Field Options

Depending on the output format that you specified in your query, the /search API enables you to identify the fields that you want to display when showing the results of your search. You can specify these parameters when using summary as the /search API's output type.

Field specifications are a comma-separated list of specified fields to include or exclude in output. Fields to exclude are preceded by a - sign. Field specifications are the following:

voci

Fields that are specific to audio data that has been transcribed by V‑Spark software. This is the default behavior if no value for the fields option is specified. voci fields are:

agent_clarity

How clear the agent channel/speech is, expressed as a value between 0 and 1, where 1 is highest

agent_emotion

Overall agent emotional intelligence assessment derived from both acoustic and linguistic information, and having one of the following values: Positive, Worsening, Improving, or Negative

agent_gender

Gender of the agent, one of Male or Female

agentid

Identifier for a specific agent

client_clarity

How clear the client channel/speech is, expressed as a value between 0 and 1, where 1 is highest

client_emotion

Overall agent emotional intelligence assessment derived from both acoustic and linguistic information, and having one of the following values: Positive, Worsening, Improving, or Negative

client_gender

Identification of the gender of the client, one of Male or Female

datetime

Transcript date and time, expressed in Coordinated Universal Time (UTC)

diarization

Only provided in two-speaker, one-channel calls; a value between 0 and 1 identifies how completely the call was divided into individual speakers. A value of 1 is the best possible value for speaker separation. A value of 2 means the call was not diarized.

duration

Duration of the call

es_doc_id

Unique identifier for a transcript in Elasticsearch index. Not included when voci is specified as return field.

filename

Name of the uploaded audio or JSON file in which the search request was matched

folder

Name of the folder where the file was uploaded. Not included when voci is specified as return field.

overall_emotion

Overall emotional intelligence assessment for an audio file, derived from both acoustic and linguistic information, and having one of the following values: Positive, Worsening, Improving, or Negative

overtalk

Percentage of call when the agent talks over or interrupts the client. Equal to the number of turns where the agent initiated overtalk divided by the total number of agent turns.

preview

An excerpt of the transcribed call, in which matched terms are highlighted

requestid

Unique identifier for a transcription request. This value is assigned when an audio file is submitted for transcription.

score

Calculation of how well a transcription matches the terms specified in your search. This is represented as a value between 0 and 1, and can depend on the type of query that you submitted. For example, date range queries always provide a score value of 1 for any transcription that occurred in the specified date range.

silence

Percentage of call duration that is silence. Equal to all non-speech time, this value is calculated as call duration minus the sum of the duration of each word. If music and noise are not decoded to word-events, they would be counted as silence.

tags

Tags added to files in the GUI. Not included when voci is specified as return field.

tid

The unique identifier of transcript

url

URL to visit the file details in the GUI. Not included when voci is specified as return field.

CLIENT-DATA

Custom metadata fields, specified by name, that have been entered within the folder with which the audio files are associated

all

Get all voci and CLIENT-DATA fields in the audio files in the specified folder or in all folders associated with an organization

apps

To get scores for all applications, specify apps. (You may only specify eitherapps or app.APPNAME, not both.)

app.APPNAME

To get scores for a specific application, specify app.APPNAME. (Note that you may only specify eitherapps or app.APPNAME, not both.) To get scores for a specific category in an application, specify the category's full name, which includes its parents' names. For example, app.APPNAME.TOP_CATEGORY.LOWER_CATEGORY.