Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Full code sample is missing #389

Open
wants to merge 10 commits into
base: develop
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Master (#366)
* DC-252

* Update async-audio.md

* fix: remove extra ")" from the code (#328)

* fix: removed extra ")" from the file (#329)

* DC-262, DC-281, DC-280

* Summary Labs Tag Fix

* Web-sdk-docs

* CustomVocabulary update

* Update master.yaml

harshad-symbl-circle-master-patch

* Update master.yaml

* DC-268

* Update messages.md

* Update merge.

* Move Contributing file.

* Removed ci image build files

* Latest changes to master

* Update getting-started.md

* Update getting-started.md

* Update master.yaml

* Revert "Merge master"

* For docs public repo - restore docs folder (#344)

Co-authored-by: harshad-symbl <harshad@Harshads-MacBook-Pro.local>

* Revert "Merge pull request #341 from symblai/merge-master"

This reverts commit d34e491, reversing
changes made to ca9983f.

* Createing master from fix/restore branch

* Removes web sdk folder (#349)

* Fixes links (#350)

* Update docusaurus.config.js

* Update docusaurus.config.js

* Update docusaurus.config.js

* Delete hotjar.js

* Delete moesif.js

* Delete munchkin.js

* Add packages.

* Test config.

* Trigger build.

* Trigger build.

* DC-292 + DC-291 + DC-186 + DC-197 + DC-177 (#351)

* Adds trackers UI changes (#354)

* Tracker UI (#355)

* Adds trackers UI changes

* Adds image for trackers ui

* DC-198, DC-293 (#356)

* 02 02 22 (#357)

* DC-198, DC-293

* DC-293

* DC-287 + DC-290 (#358)

* Adds more changes to Trackers UI (#359)

* DC-287 + DC-290

* More changes to Trackers UI

* DC-297, DC-59 (#362)

Co-authored-by: amritesh-singh <88492460+amritesh-singh@users.noreply.github.com>
Co-authored-by: Pankaj Singh <64253632+PankajSingh1010@users.noreply.github.com>
Co-authored-by: harshad-symbl <86946393+harshad-symbl@users.noreply.github.com>
Co-authored-by: avoliva <adam.voliva@symbl.ai>
Co-authored-by: harshad-symbl <harshad@Harshads-MacBook-Pro.local>
6 people authored Feb 9, 2022
commit bd5cf4e7203fa8abddfe44b6e546bfaee58cbfb2
1 change: 0 additions & 1 deletion .github/workflows/master.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

on:
push:
branches:
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

# Dependencies
/node_modules

@@ -18,5 +19,4 @@ config.json
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
yarn-debug.log*
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -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"
}
```

4 changes: 2 additions & 2 deletions docs/api-reference/getting-started.md
Original file line number Diff line number Diff line change
@@ -13,10 +13,10 @@ Our REST APIs support all HTTP verbs (or methods, as they are referred to in RES

Symbl provides a suite of APIs for different usecases. Some of them are listed below: <br/>

&nbsp; &nbsp; 👉 &nbsp; [Async APIs](/docs/async-api/reference/reference) allow you to send text, audio or video conversations in recorded format. <br/>
&nbsp; &nbsp; 👉 &nbsp; [Async APIs](/docs/async-api/introduction) allow you to send text, audio or video conversations in recorded format. <br/>
&nbsp; &nbsp; 👉 &nbsp; [Streaming APIs](/docs/streamingapi/introduction) allow you to connect Symbl on a live call via WebSocket protocol.<br/>
&nbsp; &nbsp; 👉 &nbsp; [Telephony APIs](/docs/telephony/introduction) allow you to connect Symbl on an live audio conversation via SIP and PSTN.<br/>
&nbsp; &nbsp; 👉 &nbsp; [Conversation API](/docs/async-api/reference/reference) allows you to get Conversation Intelligence such as Sentiment Analysis, Action Items, Topics, Trackers, Summary and more. <br/>
&nbsp; &nbsp; 👉 &nbsp; [Conversation API](/docs/conversation-api/introduction) allows you to get Conversation Intelligence such as Sentiment Analysis, Action Items, Topics, Trackers, Summary and more. <br/>


[![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/13497402-108cafc3-da45-4b00-97fe-4819894f58bb?action=collection%2Ffork&collection-url=entityId%3D13497402-108cafc3-da45-4b00-97fe-4819894f58bb%26entityType%3Dcollection%26workspaceId%3D5f563cfe-42ef-4344-a98a-eae13183fb7c)
2 changes: 1 addition & 1 deletion docs/async-api/overview/audio/post-audio-url.md
Original file line number Diff line number Diff line change
@@ -229,7 +229,7 @@ responses = {
500: 'Something went wrong! Please contact support@symbl.ai'
}

response = requests.request("POST", url, headers=headers, data=json.dumps(payload), params=json.dumps(params)))
response = requests.request("POST", url, headers=headers, data=json.dumps(payload), params=json.dumps(params))

if response.status_code == 201:
# Successful API execution
4 changes: 2 additions & 2 deletions docs/async-api/overview/audio/put-audio-url.md
Original file line number Diff line number Diff line change
@@ -239,7 +239,7 @@ responses = {
500: 'Something went wrong! Please contact support@symbl.ai'
}

response = requests.request("PUT", url, headers=headers, data=json.dumps(payload), params=json.dumps(params)))
response = requests.request("PUT", url, headers=headers, data=json.dumps(payload), params=json.dumps(params))

if response.status_code == 201:
# Successful API execution
@@ -442,4 +442,4 @@ Here value of `X` can be found in [FAQ](/docs/faq).

:::caution
You must wait for the job to complete processing before you proceed with getting the Conversation Intelligence. If you immediately make a GET request to Conversation API, it is possible that you'll receive incomplete insights. Therefore, ensure that you wait for the job to complete.
:::
:::
4 changes: 2 additions & 2 deletions docs/async-api/overview/text/post-text.md
Original file line number Diff line number Diff line change
@@ -36,7 +36,7 @@ curl --location --request POST 'https://api.symbl.ai/v1/process/text' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Business Meeting",
"detectPhrases": "True",
"detectPhrases": "true",
"confidenceThreshold": 0.6,
"messages": [
{
@@ -199,7 +199,7 @@ payload = {
"confidenceThreshold": 0.6,
# <Optional,double| Minimum required confidence for the insight to be recognized. Value ranges between 0.0 to 1.0. Default value is 0.5.>

"detectPhrases": True,
"detectPhrases": true,
# <Optional,boolean| It shows Actionable Phrases in each sentence of conversation. These sentences can be found using the Conversation's Messages API. Default value is false.>

"messages": [
5 changes: 2 additions & 3 deletions docs/async-api/overview/text/put-text.md
Original file line number Diff line number Diff line change
@@ -40,8 +40,7 @@ curl --location --request PUT "https://api.symbl.ai/v1/process/text/$CONVERSATIO
--header "Authorization: Bearer $AUTH_TOKEN" \
--header 'Content-Type: application/json' \
--data-raw '{
"customEntities": [{"customType": "Hiring Process", "text": "internships"}],
"detectPhrases": "True",
"detectPhrases": "true",
"messages": [
{
"payload": {
@@ -218,7 +217,7 @@ payload = {

"confidenceThreshold": 0.6, # <Optional,double| Minimum required confidence for the insight to be recognized. Value ranges between 0.0 to 1.0. Default value is 0.5.>

"detectPhrases": True, # <Optional,boolean| It shows Actionable Phrases in each sentence of conversation. These sentences can be found using the Conversation's Messages API. Default value is false.>
"detectPhrases": true, # <Optional,boolean| It shows Actionable Phrases in each sentence of conversation. These sentences can be found using the Conversation's Messages API. Default value is false.>
"messages": [
{
"payload": {
2 changes: 1 addition & 1 deletion docs/async-api/overview/video/post-video-url.md
Original file line number Diff line number Diff line change
@@ -193,7 +193,7 @@ payload = {
# <Optional, string| your_webhook_url| Webhook url on which job updates to be sent. (This should be post API)>
# 'customVocabulary': ['Platform', 'Discussion', 'Targets'],
# <Optional, list| custom_vocabulary_list> |Contains a list of words and phrases that provide hints to the speech recognition task.
# 'detectPhrases': True,
# 'detectPhrases': true,
# <Optional, boolean| detect_phrases |Accepted values are true & false. It shows Actionable Phrases in each sentence of conversation. These sentences can be found in the Conversation's Messages API.>
# 'languageCode': "en-US"
# <Optional, boolean| language_code> |code of language of recording.>
4 changes: 2 additions & 2 deletions docs/async-api/overview/video/post-video.md
Original file line number Diff line number Diff line change
@@ -65,7 +65,7 @@ const params = {
// 'customVocabulary': ['Platform', 'Discussion', 'Targets'],
// <Optional, list| custom_vocabulary_list> |Contains a list of words and phrases that provide hints to the speech recognition task.

// 'detectPhrases': True,
// 'detectPhrases': true,
// <Optional, boolean| detect_phrases> |Accepted values are true & false. It shows Actionable Phrases in each sentence of conversation. These sentences can be found in the Conversation's Messages API.

// 'languageCode': "en-US"
@@ -139,7 +139,7 @@ params = {
# 'customVocabulary': ['Platform', 'Discussion', 'Targets'],
# <Optional, list| custom_vocabulary_list> |Contains a list of words and phrases that provide hints to the speech recognition task.

# 'detectPhrases': True,
# 'detectPhrases': true,
# <Optional, boolean| detect_phrases> |Accepted values are true & false. It shows Actionable Phrases in each sentence of conversation. These sentences can be found in the Conversation's Messages API.

# 'languageCode': "en-US"
2 changes: 1 addition & 1 deletion docs/async-api/overview/video/put-video-url.md
Original file line number Diff line number Diff line change
@@ -203,7 +203,7 @@ payload = {
# 'customVocabulary': ['Platform', 'Discussion', 'Targets'],
# <Optional, list| custom_vocabulary_list> |Contains a list of words and phrases that provide hints to the speech recognition task.

# 'detectPhrases': True,
# 'detectPhrases': true,
# <Optional, boolean| detect_phrases> |Accepted values are true & false. It shows Actionable Phrases in each sentence of conversation. These sentences can be found in the Conversation's Messages API.

# 'languageCode': "en-US"
4 changes: 2 additions & 2 deletions docs/async-api/overview/video/put-video.md
Original file line number Diff line number Diff line change
@@ -74,7 +74,7 @@ const params = {
// 'customVocabulary': ['Platform', 'Discussion', 'Targets'],
// <Optional, list| custom_vocabulary_list> |Contains a list of words and phrases that provide hints to the speech recognition task.

// 'detectPhrases': True,
// 'detectPhrases': true,
// "<Optional, boolean| detect_phrases> |Accepted values are true & false. It shows Actionable Phrases in each sentence of conversation. These sentences can be found in the Conversation's Messages API.>

// 'languageCode': "en-US"
@@ -151,7 +151,7 @@ params = {
# 'customVocabulary': ['Platform', 'Discussion', 'Targets'],
# <Optional, list| custom_vocabulary_list> |Contains a list of words and phrases that provide hints to the speech recognition task.

# 'detectPhrases': True,
# 'detectPhrases': true,
# "<Optional, boolean| detect_phrases> |Accepted values are true & false. It shows Actionable Phrases in each sentence of conversation. These sentences can be found in the Conversation's Messages API.>

# 'languageCode': "en-US"
24 changes: 24 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -11,6 +11,30 @@ import TabItem from '@theme/TabItem';

We continuously add new features and enhancements, fix critical bugs, and regularly deploy changes to improve performance. Keep a tab of our latest updates on this page.

### 31 Jan 2022

![api update](/img/api-update.png)
- **Trackers Management UI**: You can create, view, edit, and delete Trackers via the Trackers Management UI. To access this feature, log in to [Symbl Platform](https://platform.symbl.ai/#/login). <br/>
[Read more here](/docs/concepts/trackers#trackers-management-ui).

### 11 Jan 2022

![api update](/img/api-update.png)
- **Streaming API Logs**: You can view the log details of all your Streaming API requests. To access this feature, log in to [Symbl Platform](https://platform.symbl.ai/#/login). <br/>
[Read more here](/docs/streaming-api/api-reference#streaming-api-logs).

### 10 Jan 2022

![api update](/img/api-update.png)
- **Word level confidence score**: You can get word-level confidence score in messages API. <br/>
[Read more here](/docs/conversation-api/messages#word-level-confidence-score--labs).

### 28 Dec 2021

![api update](/img/api-update.png)
- **Added custom vocabulary support in Topics API.** <font color="orange"> (LABS) </font><br/>
[Read more here](/docs/conversation-api/get-topics#custom-vocabulary-for-topics-labs).

### 26 Nov 2021

![api update](/img/api-update.png)
31 changes: 25 additions & 6 deletions docs/conversation-api/api-reference/messages.md
Original file line number Diff line number Diff line change
@@ -14,13 +14,19 @@ The Messages API returns a list of all the messages in a conversation. You can u

Here message refer to a continuous sentence spoken by a speaker.

### Word-level Confidence Score <font color="orange"> LABS</font>

This API provides word-level confidence score that represents the confidence level of individual words within the message or transcript. The confidence score shows the relevancy of the word in the transcript which means higher the word-level confidence score, the more relevant it is to the message.

When you pass `verbose=true`, the word-level confidence score is by default returned in the response body.


### Sentiment Analysis in messages <font color="orange"> BETA</font>

Here you can enable sentiment analysis over each message which is being spoken in the conversation.

All you need to do is pass `sentiment=true` as a query parameter. [Read more about it](/docs/concepts/sentiment-analysis).


### HTTP Request

`GET https://api.symbl.ai/v1/conversations/{conversationId}/messages`
@@ -121,10 +127,10 @@ Header Name | Required | Description

### Query Params

Parameter | Required | Value |Description|
Parameter | Required | Value |Description |
--------- | --------- | ------- | -------
```verbose``` | No | true |Gives you word level timestamps of each sentence.
```sentiment```| No | true | Give you [Sentiment Analysis](/docs/concepts/sentiment-analysis) on each message.
```verbose``` | Optional | true | Gives you word level timestamps and score of each sentence.
```sentiment```| Optional | true | Give you [Sentiment Analysis](/docs/concepts/sentiment-analysis) on each message.

### Response

@@ -158,41 +164,49 @@ Parameter | Required | Value |Description|
"word": "Best",
"startTime": "2020-08-18T11:10:14.536Z",
"endTime": "2020-08-18T11:10:15.536Z",
"score": 0.91
},
{
"word": "package",
"startTime": "2020-08-18T11:10:16.536Z",
"endTime": "2020-08-18T11:10:17.536Z",
"score": 0.80
},
{
"word": "for",
"startTime": "2020-08-18T11:10:18.536Z",
"endTime": "2020-08-18T11:10:19.536Z",
"score": 0.79
},
{
"word": "you",
"startTime": "2020-08-18T11:10:20.536Z",
"endTime": "2020-08-18T11:10:22.536Z",
"score": 0.85
},
{
"word": "is",
"startTime": "2020-08-18T11:10:22.536Z",
"endTime": "2020-08-18T11:10:25.536Z",
"score": 0.89
},
{
"word": "$69.99",
"startTime": "2020-08-18T11:10:25.536Z",
"endTime": "2020-08-18T11:10:27.536Z",
"score": 0.86
},
{
"word": "per",
"startTime": "2020-08-18T11:10:27.536Z",
"endTime": "2020-08-18T11:10:29.536Z",
"score": 0.82
},
{
"word": "month.",
"startTime": "2020-08-18T11:10:30.536Z",
"endTime": "2020-08-18T11:10:32.536Z",
"score": 0.90
}]
},
{
@@ -217,26 +231,31 @@ Parameter | Required | Value |Description|
"word": "Okay,",
"startTime": "2020-08-18T11:11:14.536Z",
"endTime": "2020-08-18T11:11:14.936Z"
"score": 0.91
},
{
"word": "Where",
"startTime": "2020-08-18T11:11:14.936Z",
"endTime": "2020-08-18T11:11:15.436Z"
"score": 0.91
},
{
"word": "is",
"startTime": "2020-08-18T11:11:16.236Z",
"endTime": "2020-08-18T11:11:16.536Z"
"score": 0.88
},
{
"word": "the",
"startTime": "2020-08-18T11:11:16.536Z",
"endTime": "2020-08-18T11:11:16.936Z"
"score": 0.85
},
{
"word": "file?",
"startTime": "2020-08-18T11:11:16.936Z",
"endTime": "2020-08-18T11:11:17.236Z"
"score": 0.89
}
]
}
@@ -252,6 +271,6 @@ Field | Description
```startTime``` | DateTime value.
```endTime``` | DateTime value.
```conversationId``` | Unique conversation identifier.
```words``` | Words object with properties `word`, `startTime` and `endTime`.
```words``` | Words object with properties `word`, `startTime`, `endTime` and `score`. The `score` represents the word level confidence score. The value that is accepted for the data type is float.
```phrases``` | It shows the most important action phrases in each sentence. It's enabled when you pass `detectPhrases=true` during submiting the request in Async and Websocket API.
```sentiment```| Shows the sentiment polarity(intensity of negativity or positivity of a sentence) and suggested sentiment type (positive, negative and neutral).
```sentiment```| Shows the sentiment polarity(intensity of negativity or positivity of a sentence) and suggested sentiment type (positive, negative and neutral).
26 changes: 19 additions & 7 deletions docs/conversation-api/api-reference/summary.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,23 @@
---
id: summary
title: GET Summary (Beta)
sidebar_label: GET Summary (Beta)
title: GET Summary
sidebar_label: GET Summary
slug: /conversation-api/summary
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

:::note In Beta Phase
This feature is in the Beta phase. If you have any questions, ideas or suggestions please reach out to us at devrelations@symbl.ai.
:::info Symbl Labs
This feature is a part of Symbl Labs. Symbl Labs is our experimental wing designed to share our bleeding edge AI research on human conversations with anyone who wants to explore its limits.


You can access the Labs features using your Symbl App Id and Secret. If you don't already have it, sign up on [platform](https://platform.symbl.ai/#/login) to get your credentials.

**Note**: The usage of data for Labs projects is stored for enhancing our research. We may continue to build, iterate, mutate or discontinue any of the below given features on the sole discretion of our team as deemed necessary.

For any queries or feedback, please contact us at labs@symbl.ai.
:::

This API allows you to get a [Summary](/docs/concepts/summarization) of important contextual messages in a conversation.
@@ -25,7 +32,7 @@ If the number of words in a conversation is below 50 or the number of sentences


### API Endpoint
**<font color="orange">GET</font> `https://api.symbl.ai/v1/conversations/{conversationId}/summary`**
**<font color="orange">GET</font> `https://api-labs.symbl.ai/v1/conversations/{conversationId}/summary`**

### Request Headers

@@ -50,7 +57,7 @@ If you are using `x-api-key` we recommend that you use `Authorization` header in
<TabItem value="cURL">

```shell
curl --location --request GET 'https://api.symbl.ai/v1/conversations/{conversationId}/summary' \
curl --location --request GET 'https:///api-labs.symbl.ai/v1/conversations/{conversationId}/summary' \
--header "Authorization: Bearer $AUTH_TOKEN" \
# Set your access token here. See https://docs.symbl.ai/docs/developer-tools/authentication
--header 'Content-Type: application/json' \
@@ -65,7 +72,7 @@ const request = require('request');
const authToken = AUTH_TOKEN;;

request.get({
url: `https://api.symbl.ai/v1/conversations/{conversationId}/summary`,
url: `https:///api-labs.symbl.ai/v1/conversations/{conversationId}/summary`,
headers: { 'Authorization': `Bearer ${authToken}` },
json: true
}, (err, response, body) => {
@@ -75,6 +82,11 @@ request.get({
</TabItem>
</Tabs>

:::important

The Conversation ID you receive after processing conversations with production Endpoint can be used to process Summary using the Labs Endpoint.
:::

### Using Refresh Parameter

You can use the `refresh=true` as query parameter in the Summary API for any of the following use-cases:
Loading