Graphlogic.ai documentation

Messaging API

Voice Box API

Voice Box API is a connector with a public API designed to deploy the

@Agent⁠

to voice channels, for example, creating a

@Bot⁠

that works through phone calls.

Connecting

Bot Configuration on the client’s side

Channel configuration on the client’s side is implemented using this API:

https://docs.google.com/document/d/1Vpv8jWw_vtVkNKpM4j8iXmDK6qRPAlwIAjf85AO1d0o/edit?usp=sharing⁠

⁠

Project Channel Configuration on the Platform

You need to create and configure a

@End Channel⁠

with a Voice Box API connector.

Go to the

@Project Channel⁠

s tab inside the

@Project⁠

⁠

Click the Create channel button.

⁠

The

@End Channel⁠

selection panel will open.

⁠

Select

@Voice Box API⁠

The

@Project Channel⁠

creation panel will open.

⁠

Optionally, enter a title for this

@Project Channel⁠

in the Name field with the placeholder New channel.

⁠

The token in the Channel token field is needed to deploy the

@Project⁠

to the voice channel. You can copy it by clicking the Copy this token button.

⁠

Go to the ASR Settings tab. The settings for receiving the

@Bot User⁠

's voice are set on this tab.

⁠

Choose an ASR provider in the ATS provider field. It can be either Graphlogic or Google.

⁠

If you choose Graphlogic, fill the following fields:

Choose the language that the

@Bot⁠

will recognize in the Language field.

⁠

Choose the voice sampling frequency in the Sample rate, Hz field.

⁠

If you choose Google:

First of all you need to

create a Google service account⁠

After creating an account, you need to enable the API for

TTS⁠

and

STT⁠

on it. To do this, follow the links and click Enable.

Get a json, which allows you to contact Google API. To get json, go to the Keys tab in the service account settings, click ADD KEY -> Create new key -> JSON.

⁠

Then go back to the

@Platform⁠

and fill the following fields:

Upload the received json in the Google credentials field.

⁠

Choose the language that the

@Bot⁠

will recognize in the Language field.

⁠

Choose the voice sampling frequency in the Sample rate, Hz field.

⁠

In the ASR Model field:

⁠

Short — use this model for short utterances that are a few seconds in length. It is useful for trying to capture commands or other single shot directed speech use cases.

Long — use this model for any kind of long form content such as media or spontaneous speech and conversations.

Go to the TTS Settings tab. This tab contains the bot's voice generation settings.

⁠

If you chose Graphlogic, fill the following fields:

Choose the voice that the

@Bot⁠

will speak in the Voice field.

⁠

Female is an option for English language;

Arabic is an option for Arabic language;

UK Lada is an option for Ukranian language.

Choose the voice sampling frequency in the Sample rate, Hz field.

⁠

If you chose Google, fill the following fields:

Upload the received json in the Google credentials field.

⁠

Choose the language that the

@Bot⁠

will speak in the Language field.

⁠

Choose the voice sampling frequency in the Sample rate, Hz field.

⁠

To save the

@Project Channel⁠

without activating it, click the CREATE button.

⁠

To save and activate the

@Project Channel⁠

, click the CREATE & ACTIVATE button.

⁠

The

@Project Channel⁠

will be saved and activated if:

The

@Agent⁠

is trained;

The channel address is accessible;

The channel webhook is registered succesfully.

The

@Project Channel⁠

will be saved but not activated if one or more conditions are not met.

To cancel

@Project Channel⁠

creation, click the CANCEL button.

⁠

Editing and Deleting Agent Channel

To edit an

@Project Channel⁠

, click on its card in the

@Project Channel⁠

s list.

⁠

To edit any field, click the field and enter a new value.

To apply changes to an activated

@Project Channel⁠

, click the APPLY button.

⁠

Changes will be applied if:

The

@Agent⁠

is trained;

The channel address is accessible;

The channel webhook is registered succesfully.

Changes will not be applied if one or more conditions are not met.

To deactivate the

@Project Channel⁠

, click the DEACTIVATE button.

⁠

To apply changes to a non-activated

@Project Channel⁠

, click the SAVE button.

⁠

To apply changes and activate the

@Project Channel⁠

, click the SAVE & ACTIVATE button.

⁠

Changes will be applied and the

@Project Channel⁠

will be activated if:

The

@Agent⁠

is trained;

The channel address is accessible;

The channel webhook can be registered.

Changes will be applied but the

@Project Channel⁠

will not be activated if one or more conditions are not met.

To cancel making changes, click the CANCEL button.

⁠

To delete the

@Project Channel⁠

, click the DELETE button.

⁠

Communication

There are some features of communication in the

@Voice Box API⁠

channel:

Only text messages from the

@Text⁠

and

@Slot Filling⁠

@Slot⁠

s are supported;

Passing through

@button⁠

and

@Attachment⁠

@Slot⁠

s in the

@Script⁠

is recorded in the analytics, but none of this

@Slot⁠

s are sent to the channel.

⁠

@Change Chat Mode⁠

@Slot⁠

only closes the

@Dialog⁠

and does nothing in the channel.

Mapping of Channel variables

Currently no mapping of

@Channel Variables⁠

is supported from the

@Voice Box API⁠

channel.

Connecting

Bot Configuration on the client’s side

Project Channel Configuration on the Platform

Editing and Deleting Agent Channel

Communication

Mapping of Channel variables

Want to print your doc?
This is not the way.

Try clicking the ⋯ next to your doc name or using a keyboard shortcut (

CtrlP

) instead.