release note for 0.8.2 and soniox docs (#61)

2026-07-04 19:21:55 +00:00 · 2023-04-13 10:14:30 -04:00
parent 6a8e43abd5
commit 8b6847b572
2 changed files with 56 additions and 3 deletions
@@ -29,8 +29,44 @@
 #### SQL changes
 None.

+#### Known issues and workarounds
+Creating a carrier that requires outbound registration does not work because the sip_gateways rows associated with the carrier are incorrectly set to inactive when first created.  The workaround is to first create and configure the carrier in the jambonz web portal, including the outbound registration configuration, and then applying the SQL update below. 
+
+> Note: this bug only affects carriers configured with outbound registration. There is no need to apply the fix below when configuring a carrier that does not require outbound registration.
+
+*on VM installs*
+
+Use an ssh client to log into the jambonz webserver as 'admin' user.  Find the mysql password in the apps/ecosystem.config.js file  - look for the environment variable named JAMBONES_MYSQL_PASSWORD.  Then, using the mysql client log into the database and apply the update statement as shown below.
+
+*on k8s installs*
+
+Use kubectl or [Lens](https://k8slens.dev/) to exec a shell into the mysql container.  Find the mysql password from the env vars for the api-server container.  In the shell on the mysql container log into the database and apply the update below:
+
+```
+$ mysql -u admin -D jambones -p
+Enter password:
+Reading table information for completion of table and column names
+You can turn off this feature to get a quicker startup with -A
+
+Welcome to the MariaDB monitor.  Commands end with ; or \g.
+Your MariaDB connection id is 91974
+Server version: 10.5.18-MariaDB-0+deb11u1 Debian 11
+
+Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others.
+
+Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
+
+MariaDB [jambones]> update sip_gateways set is_active=1;
+Query OK, 2 rows affected (0.001 sec)
+Rows matched: 26  Changed: 2  Warnings: 0
+
+MariaDB [jambones]> quit
+```
+
+This bug will be fixed in 0.8.3 but while running on 0.8.2 you will need to repeat the update sequence above after adding any carrier that requires outbound registration.
+
 #### Availability
- Available shortly on AWS Marketplace
+- Available now on AWS Marketplace
 - Deploy to Kubernetes using [this Helm chart](https://github.com/jambonz/helm-charts)

 **Questions?** Contact us at <a href="mailto:support@jambonz.org">support@jambonz.org</a>
@@ -3,10 +3,10 @@ The `recognizer` property is used in multiple verbs ([gather](/docs/webhooks/gat

 | option        | description | required  |
 | ------------- |-------------| -----|
-| vendor | Speech vendor to use (google, aws, microsoft, deepgram, nuance, nvidia, and ibm are supported, along with any others you add via the [custom speech API](/docs/speech-api/overview/)) | no |
+| vendor | Speech vendor to use (google, aws, microsoft, deepgram, nuance, nvidia, soniox, and ibm are supported, along with any others you add via the [custom speech API](/docs/speech-api/overview/)) | no |
 | language | Language code to use for speech detection.  Defaults to the application level setting | no |
 | interim | If true, interim transcriptions are sent | no (default: false) |
-| hints | (google, microsoft, deepgram, nvidia) Array of words or phrases to assist speech detection.  See [examples](#hints) below. | no |
+| hints | (google, microsoft, deepgram, nvidia, soniox) Array of words or phrases to assist speech detection.  See [examples](#hints) below. | no |
 | hintsBoost | (google, nvidia) Number indicating the strength to assign to the configured hints.  See examples below. | no |
 | profanityFilter | (google, deepgram, nuance, nvidia) If true, filter profanity from speech transcription .  Default:  no| no |
 | singleUtterance | (google) If true, return only a single utterance/transcript | no (default: true for gather)|
@@ -40,6 +40,7 @@ The `recognizer` property is used in multiple verbs ([gather](/docs/webhooks/gat
 | deepgramOptions (added in 0.8.0)|Deepgram-specific speech recognition options (see below)| no |
 | nvidiaOptions (added in 0.8.0)|Nvidia-specific speech recognition options (see below)| no |
 | ibmOptions (added in 0.8.0)|IBM Watson-specific speech recognition options (see below)| no |
+| sonioxOptions (added in 0.8.2)|Soniox-specific speech recognition options (see below)| no |

 <h2 id="hints">Providing speech hints</h2>

@@ -160,3 +161,19 @@ Additionally, google and nvidia allow a boost factor to be specified at the phra
 | wordTimeOffsets | indicates whether to provide word-level detail | no |
 | verbatimTranscripts | Indicates whether to provide verbatim transcripts| no |
 | customConfiguration | An object of key-value pairs that can be sent to Nvidia for custom configuration | no |
+
+<h2 id="sonioxOptions">sonioxOptions</h2>
+
+`sonioxOptions` is an object with the following properties. Please refer to the [Soniox Documentation](https://soniox.com/docs/) for detailed descriptions. This option is available in jambonz 0.8.2 or above.
+
+| option        | description | required  |
+| ------------- |-------------| -----|
+| api_key | Soniox api key  | no |
+| model | Soniox [model](https://soniox.com/docs/models) to use | no (default: precision_ivr) |
+| profanityFilter | Indicates whether to [remove profanity](https://soniox.com/docs/profanity_filter) from the transcript  | no |
+| storage | properties that dictate whether to audio and/or transcripts.  Can be useful for debugging purposes. | no |
+| storage.id | storage identifier | no |
+| storage.title | storage title | no |
+| storage.disableStoreAudio | if true do not store audio | no (default: false) |
+| storage.disableStoreTranscript | if true do not store transcript | no (default: false)  |
+| storage.disableSearch |  if true do not allow search | no (default: false)  |