V-Spark Online Help

Configuring Callbacks in V‑Spark

The callback URL is specified as part of V‑Spark folder configuration, which is accessed within V‑Spark. To modify the settings for a folder:

  1. Move your mouse over the Settings menu at the top left of the V‑Spark screen. The Settings menu displays.

  2. Choose Folders from the Settings menu.

  3. Display the folder whose setting you want to modify. Either select the Company and Organization from the drop-down menus below the V‑Spark logo, or use the Search folders search box to search for and display information about a specified folder.

Figure 1. V‑Spark Folder Settings
V‑Spark Folder Settings


Note

Other aspects of working with V‑Spark folders are discussed in the V‑Spark Management Guide.

To edit the settings for an existing folder, click the edit icon. The Update [Folder Name] dialog displays.

Figure 2. Editing V‑Spark Folder Settings
Editing V‑Spark Folder Settings


Click Next to proceed to the part of this dialog in which you can specify the callback delivery method and select the types of data that V‑Spark sends to it.

Figure 3. Further Customization of V‑Spark Folder Settings
Further Customization of V‑Spark Folder Settings


To display the portion of this dialog in which you can specify the parameters for and the location of the callback server used by V‑Spark and set related options, select the checkbox beside Configure callback delivery method, and click Next.

Other options at the bottom of this dialog are:

Add/remove custom metadata fields

Selecting this checkbox and clicking Next displays a dialog that enables you to identify custom metadata fields that you want to include in transcripts for this folder.

Figure 4. Specifying custom metadata fields to include in output
Specifying custom metadata fields to include in output


Add/remove ASR options

Selecting the checkbox beside this label and clicking Next displays a dialog that enables you to identify Automatic Speech Recognition (ASR) fields that you want to include in output for this folder.

Figure 5. Specifying ASR options
Specifying ASR options


Note

If you have not checked one or more of the checkboxes beside Configure callback delivery method, Add/remove custom metadata fields, or Add/remove ASR options checkboxes and selected Next, select Update to close this dialog and return to V‑Spark.

By default, the callback configuration dialog shown in the next figure displays the information that is required for a callback server which communicates using the HTTP protocol, including an example that identifies the format of a standard URL.

Figure 6. Configuring an HTTP Callback Server and related options
Configuring an HTTP Callback Server and related options


The Callback Delivery Method area consists of a dropdown at left which identifies the supported mechanisms for delivering callbacks, while the right portion of that area enables you to enter the path that V‑Spark must use to deliver transcription and optional information. Supported callback delivery mechanisms are:

http://

The standard Hypertext Transfer Protocol, which means that the callback server is a web server that is listening on a specified (or default) port

https://

The Hypertext Transfer Protocol running over the Secure Sockets Layer, which means that the callback server is a web server that is listening on a specified (or default) port

File System

Transcript info is written to files that are located in a specified directory on the system on which the V‑Spark software is installed. When using this protocol, make sure that the user group is set to vocisrv and that the directory is writable by that group so that V‑Spark is able to write files into the specified directory.

SFTP

Transcripts and other requested information are sent to a server via the Secure File Transfer Protocol (SFTP), which requires additional authorization information, such as the username and password, or an SSH key, as shown in.

AWS S3

Transcript and associated data is written to the Amazon Web Service (AWS) Simple Storage Service (S3). Specifying this callback delivery mechanism causes a dialog that displays fields in which you must specify the AWS access key id and AWS secret access key that are used to securely communicate with AWS S3. See Using the /transcribe API with AWS S3 for information about using the /transcribe API to process archived audio files in zip format that are already stored in S3.

Figure 7. Configuring an SFTP Callback Server and related options
Configuring an SFTP Callback Server and related options


By default, the dialogs for each of these delivery mechanisms enable you to specify the type of transcript data that is being sent. By default, sending a JSON transcript is always enabled. You can also select:

MP3

Checking this box causes V‑Spark to also send an MP3 version of the transcribed audio file to the callback server

Text

Checking this box causes V‑Spark to also send a text version of the transcribed audio file to the callback server

Once you have made any changes that you want to make to the callback information, click Update to close this dialog and return to V‑Spark.

Important

Make sure that the machine and port specified in the callback URL are accessible from the V‑Spark instance that you are using. In some cases, this requires modifying client-side firewall rules.