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

DC-287 + DC-290 #358

Merged
merged 1 commit into from
Feb 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
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
14 changes: 13 additions & 1 deletion docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,19 @@ We continuously add new features and enhancements, fix critical bugs, and regula

![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#manage-trackers-via-trackers-management-ui).
[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

Expand Down
12 changes: 7 additions & 5 deletions docs/conversation-api/concepts/trackers.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Operation | Endpoint
---------- | -------
Create Tracker | [`POST` v1/manage/tracker](/management-api/trackers/create-tracker)
Create Trackers in Bulk | [`POST` v1/manage/trackers](/management-api/trackers/create-tracker#bulk-create-trackers-api)
Get Tracker with ID| [`GET`v1/manage/tracker/{trackerId}](/management-api/trackers/get-tracker#get-tracker-by-id)
Get Tracker with ID| [`GET` v1/manage/tracker/{trackerId}](/management-api/trackers/get-tracker#get-tracker-by-id)
Get Tracker with name | [`GET` v1/manage/trackers?&name={trackerName}](/management-api/trackers/get-tracker#get-tracker)
Update Tracker| [`PUT`v1/manage/tracker/{trackerId}](/management-api/trackers/update-tracker)
Delete Tracker| [`DELETE`v1/manage/tracker/{trackerId}](/management-api/trackers/delete-tracker)
Expand All @@ -100,12 +100,14 @@ The following capabilities are supported in the Trackers Management UI:
- Edit Trackers
- Delete Trackers

![img-tracker-ui](/img/tracker-management-ui.png)
![img-tracker-ui](/img/tracker-ui-1.png)

The UI allows you to copy the

:::note
**Using punctuations**: You can only pass periods `.`, apostrophes `'` and dashes `-` in the trackers vocabulary. Other punctuations like `?`, `,`, `!`, `:`are not allowed.
**Vocabulary terms**: You must add atleast 5 and a maximum of 50 vocabulary terms per Tracker.
**Trackers limitation**: You can create upto 200 trackers per account.
**Using punctuations**: You can only pass periods `.`, apostrophes `'` and dashes `-` in the Trackers vocabulary. Other punctuations like `?`, `,`, `!`, `:` are not allowed.<br/>
**Vocabulary terms**: We recommend that you add at least 5 and a maximum of 50 vocabulary terms per Tracker.<br/>
**Trackers limitation**: You can create up to 200 Trackers per account.
:::

## Tutorials
Expand Down
7 changes: 5 additions & 2 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,10 @@ You can only pass periods `.`, apostrophes `'` and dashes `-` in the trackers vo
You can create Trackers using the Management API. You can also use the Tracker UI via the [Symbl Platform](https://platform.symbl.ai/#/login) to create, view, edit and delete Trackers.

### How many vocabulary terms can I add in a Tracker?
You must add at least 5 vocabulary terms and a maximum of 50 per Tracker.
We recommend that you add at least 5 vocabulary terms and a maximum of 50 per Tracker.

### How many Trackers can I create?
You can create upto 200 trackers per account.
You can create up to 200 Trackers per account.

### Can I view the logs of Streaming API?
Yes, you can view the Streaming API logs via the [Symbl Platform](https://platform.symbl.ai/#/login).
24 changes: 23 additions & 1 deletion docs/streamingapi/reference/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';

---

Symbl's Streaming API is based on WebSocket protocol and can be used for real-time use-cases where both the audio and its results from Symbl's back-end need to be available in real-time.
Symbl's Streaming API is based on the WebSocket protocol and can be used for real-time use-cases where both the audio and its results need to be available in real-time.

:::info
Currently, Streaming API is supported in English language. The support for Spanish language is also available in the Labs environment.
Expand Down Expand Up @@ -419,3 +419,25 @@ Let’s go over all the parameters passed in the configuration object in the abo
6. `handlers`: The object encapsulating the call-back functions to be invoked on detection of those specific entities. For more information on various other handlers, check out the [Javascript SDK Reference](/docs/javascript-sdk/reference#event-handlers-1).

a. `onTrackerResponse`: This function is invoked when Symbl detects a Tracker in real-time. The structure of the **Tracker** object is shown in the above code snippet.

### Streaming API Logs

You can view the logs of your Streaming API request on your Symbl Platform account. To view the logs, sign in to [Symbl Platform](https://platform.symbl.ai/#/login). The logs provide the following:

- Connection ID

- Conversation ID

- Log details

- Date of Creation

- Log Type (Start request, Conversation created, Started listening, Recognition started, Stop request, etc.)

- Ability to search for old logs

- Ability to filter logs with dates

- Ability to filter logs with only errors.

![image-api-logs](/img/streaming-api-logs.png)
20 changes: 18 additions & 2 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -725,15 +725,31 @@ ChangelogSidebar: [{
id: 'changelog',
customProps: {
hash: '#31-jan-2022',
label: '31 jan 2022',
label: '31 Jan 2022',
}
},
{
type: 'doc',
id: 'changelog',
customProps: {
hash: '#11-jan-2022',
label: '11 Jan 2022',
}
},
{
type: 'doc',
id: 'changelog',
customProps: {
hash: '#10-jan-2022',
label: '10 Jan 2022',
}
},
{
type: 'doc',
id: 'changelog',
customProps: {
hash: '#28-dec-2021',
label: '28 dec 2021',
label: '28 Dec 2021',
}
},
{
Expand Down
Binary file added static/img/streaming-api-logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/tracker-management-ui-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/tracker-ui-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.