Merge pull request #334 from amritesh-singh/11-01-22

DC-262, DC-281, DC-280
symblai · Jan 11, 2022 · 3674a25 · 3674a25
2 parents d2e2b51 + 1dfc7a8
commit 3674a25
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 30 deletions.
diff --git a/api-reference/experience-api/post-trackers-and-analytics-ui.md b/api-reference/experience-api/post-trackers-and-analytics-ui.md
@@ -38,7 +38,7 @@ curl --location --request POST "https://api.symbl.ai/v1/conversations/$CONVERSAT
 --header "Authorization: Bearer $AUTH_TOKEN" \
 --data-raw '{
   "name": "audio-summary",
-  "audioUrl": "https://storage.googleapis.com/rammer-transcription-bucket/small.mp3",
+  "audioUrl": "https://symbl-test-conversation.s3.amazonaws.com/4_comcast_customer_service_9min03sec.mp3",
 }'
 ```
 
@@ -47,7 +47,7 @@ curl --location --request POST "https://api.symbl.ai/v1/conversations/$CONVERSAT
 ```javascript
 {
     "name": "audio-summary",
-    "url": "https://meetinginsights.symbl.ai/meeting/#/eyJzZXNzaW9uSWQiOiI1ODU5NjczMDg1MzEzMDI0IiwidmlkZW9VcmwiOiJodHRwczovL3N0b3JhZ2UuZ29vZ2xlYXBpcy5jb20vcmFtbWVyLXRyYW5zY3JpcHRpb24tYnVja2V0L3NtYWxsLm1wNCJ9?showVideoSummary=true"
+    "url": "https://meetinginsights-experience.symbl.ai/#/eyJjb252ZXJzYXRpb25JZCI6IjU5NDg0ODUwNDUwNTk1ODQiLCJhdWRpb1VybCI6Imh0dHBzOi8vc3ltYmwtdGVzdC1jb252ZXJzYXRpb24uczMuYW1hem9uYXdzLmNvbS80X2NvbWNhc3RfY3VzdG9tZXJfc2VydmljZV85bWluMDNzZWMubXAzIn0.?o=fb5a99d192b2821a40639c5c7af86021db2ed6c7e32b3a8fccf6967b7e126c4ed6bd1e4636082ba3fc3a3da3980e5b99272c241e9d44c518715bf5c9772fe3bc405efb43e2cd11ef9c6e106215034ee3ac91c8dda4c09263032103519e56c690980c1c3f07604c183b1a4ddbcfca5df6cee1f7841492017eb2bb28b761cf57f218f05e233a2f34d223d4e0e4d8615fb2fca9c31fa534237c82e276ef4c4ec2c77f4fa320a7c00cded9e897d879b0f77d819475c0383f677214fa366d85bd6b99b10e1b7f56410d1c5813fd71d8f7f441de040f0bddfe2253c6161cb9990ca47f69e052ae5553a33b3cb0fd9dff80c009b466953f671d0ddefcf4534a17b56b2a89b671c07f0bc51daa85939494423b394ada8fabd44b91efc1817e77566ead15ab69e61fe2773a4eb4086d3ae0ca6bceda3274c5361e5ad389"
 }
 ```
 

diff --git a/conversation-api/api-reference/trackers.md b/conversation-api/api-reference/trackers.md
@@ -118,30 +118,44 @@ exit()
 ### Response
 
 ```json
-{
-    "type": "vocabulary",
-    "value": "Can you reiterate that one more time",
-    "messageRefs": [
-        {
-            "id": "6428676305453056",
-            "text": "So I am not showing that here but you can have that, you know, for particular sentence and, you know, then aggregate based on the whole conversation.",
-            "offset": -1
-        },
-        {
-            "id": "6035928066818048",
-            "text": "Give that intent and name and that's it.",
-            "offset": -1
-        }
-    ],
-    "insightRefs": [
-        {
-            "text": "Yeah, and you So from sentiment analysis perspective, right?",
-            "offset": -1,
-            "type": "question",
-            "id": "5794360651153408"
-        }
-    ]
-}
+[
+    {
+        "id": "5237067555536896",
+        "name": "PricingMention",
+        "matches": [
+            {
+                "type": "vocabulary",
+                "value": "What is the price",
+                "messageRefs": [
+                    {
+                        "id": "4667009028587520",
+                        "text": "How much does it cost?",
+                        "offset": -1
+                    }
+                ],
+                "insightRefs": [
+                    {
+                        "text": "How much does it cost?",
+                        "offset": -1,
+                        "type": "question",
+                        "id": "5420651570528256"
+                    }
+                ]
+            },
+            {
+                "type": "vocabulary",
+                "value": "Subscription",
+                "messageRefs": [
+                    {
+                        "id": "4527958187311104",
+                        "text": "Our subscription plan which includes the premium suite of services is $500 per month.",
+                        "offset": 4
+                    }
+                ],
+                "insightRefs": []
+            }
+        ]
+    },
 ```
 
 Let’s go over the members of the response body which contains the detected tracker objects:

diff --git a/streamingapi/reference/reference.md b/streamingapi/reference/reference.md
@@ -29,10 +29,10 @@ Field  | Required | Supported Value | Description
 ---------- | ------- |  ------- |  -------
 ```type``` | Mandatory | start_request, stop_request | Type of message
 ```insightTypes``` | Optional | action_item, question | Types of insights to return. If not provided, no insights will be returned.
-```customVocabulary``` | Optional |  | An array of strings containing a vocabulary specific to your company, products, or phrases. 
-```config``` | Optional | | Configuration for this request. [See the config section below for more details](#config).
-```speaker``` | Optional  | | Speaker identity to use for audio in this WebSocket connection. If omitted, no speaker identification will be used for processing. [See the speaker section below for more details](#speaker).
-```noConnectionTimeout``` <br/> <font color="orange"> LABS </font> | Optional | | The buffer time (in seconds) during which the WebSocket API connection stays open even if there’s no Streaming API connection active for that duration. This allows the Speaker to reconnect to the same meeting with the same Subscribers if they lost the connection previously. <br/> For example, <br/><br/>  When this parameter is set to `noConnectionTimeout = 600 secs` and if there is no graceful termination using `stop_request` message sent explicitly when there just one WebSocket connection, the `connectionId` and `conversationId` are kept valid for 600 seconds before finalizing the connection, after which connectionId will be not available to subscribe and `conversationId` will have all the last know information associated with it.
+```customVocabulary``` | Optional | List of String | An array of strings containing a vocabulary specific to your company, products, or phrases. 
+```config``` | Optional | Find the supported value [here](#config) | Configuration for this request. [See the config section below for more details](#config).
+```speaker``` | Optional  | Find the supported value [here](#speaker) | Speaker identity to use for audio in this WebSocket connection. If omitted, no speaker identification will be used for processing. [See the speaker section below for more details](#speaker).
+```noConnectionTimeout``` <br/> <font color="orange"> LABS </font> | Optional |  Between `0` to `3600` seconds | The buffer time (in seconds) during which the WebSocket API connection stays open even if there’s no Streaming API connection active for that duration. This allows the Speaker to reconnect to the same meeting with the same Subscribers if they lost the connection previously. <br/> For example, <br/><br/>  When this parameter is set to `noConnectionTimeout = 600 secs` and if there is no graceful termination using `stop_request` message sent explicitly when there just one WebSocket connection, the `connectionId` and `conversationId` are kept valid for 600 seconds before finalizing the connection, after which connectionId will be not available to subscribe and `conversationId` will have all the last know information associated with it.
 ```disconnectOnStopRequest``` <br/> <font color="orange"> LABS </font> | Optional | `true` or `false` | This parameter allows you to set your Streaming API connection in such a way that even when the `stop_request` is sent. The connection does not drop-off, only the processing is stopped and the `conversationId` and connection is kept live for `1800` seconds by default. You can always override this value by passing the `disconnectOnStopRequest` parameter. <br/> <br/> This allows you to stop and start the Streaming API processing without dropping the WebSocket connection, so that you can stop and resume the processing in the middle of a call and optimize the Streaming API usage costs. <br/> <br/> The default value is `true`. |
 ```disconnectOnStopRequestTimeout```  <br/> <font color="orange"> LABS </font> | Optional | Between `0` to `3600` seconds | This parameter allows you to override the idle time out (if a WebSocket connection is idle for 30 minutes). Set this parameter with a value between `0` to `3600` seconds. If the idle connection needs to be kept alive beyond `3600` seconds, you have to restart the connection at `3600` seconds elapsed. <br/> <br/> If the value is passed as `0`, the WebSocket connection is dropped when `stop_request` is received. The default value is `1800`.