Orchestration (optional)

The Soul Machines Orchestration Layer is an additional layer of logic (hosted on a separate server from the Soul Machines Digital Person, operated by the customer), use cases include but are not limited to the following:

  1. Connecting to an unsupported NLP (see Natural Language Processing and Conversational Content section).

  2. To provide user-specific data based on the authenticated user specified in your JWT or an additional authentication mechanism.

  3. Integrating with other systems to retrieve or save data.

  4. Collecting and saving system data, such as conversation transcripts and EQ data.

Note: Transcript data is not saved and only passed to clients via the Orchestration server for analytics purposes.

Upon instantiation of the Digital Person session, the Persona server connects to the Orchestration server via the nominated (specified in the JWT) Web Socket Server URI over HTTPS.

Sample code templates can be provided, written in ​Node.js​​. Your Soul Machines Customer Success team can assist you in determining if there is a need for Orchestration for your use cases.

The following diagram provides a sample Orchestration server configuration:

Sample Orchestration Server Configuration

Refer to the Orchestration Server Configuration Guide for more information.