-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #321 from amritesh-singh/21-12
DC-270 + Links Fix + Tags Fix
- Loading branch information
Showing
17 changed files
with
60 additions
and
80 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,20 @@ | ||
--- | ||
id: how-to-use-sentiment-analysis | ||
title: How To Use Sentiment Analysis | ||
title: How To Use Sentiment Analysis (Beta) | ||
--- | ||
|
||
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 [email protected]. | ||
::: | ||
|
||
## Process file | ||
|
||
The first thing you need to do before getting your Sentiment Analysis is to process your audio, video or text file. This code is taken directly from our [POST Video URL](/docs/async-api/overview/video/post-video) page. If you want to use an audio or text file you can use the code from the [POST Audio URL](/docs/async-api/overview/audio/post-audio) or [POST Text File](/docs/async-api/overview/text/post-text) pages. | ||
The first thing you need to do before getting your Sentiment Analysis is to process your audio, video or text file. This code is taken directly from our [POST Video URL](/docs/async-api/overview/video/post-video-url) page. If you want to use an audio or text file you can use the code from the [POST Audio URL](/docs/async-api/overview/audio/post-audio-url) or [POST Text File](/docs/async-api/overview/text/post-text) pages. | ||
|
||
:::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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,17 @@ | ||
--- | ||
id: sentiment-analysis-on-messages | ||
title: Sentiment Analysis on Messages | ||
title: Sentiment Analysis on Messages (Beta) | ||
--- | ||
|
||
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 [email protected]. | ||
::: | ||
|
||
Sentiment Analysis is the process of determining whether each message/line in a conversation is positive, negative, or neutral. Sentiment analysis on messages combines natural language processing and machine learning procedures to allot sentiment scores to the message. | ||
|
||
:::note | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,17 @@ | ||
--- | ||
id: sentiment-analysis-on-topics | ||
title: Sentiment Analysis on Topics | ||
title: Sentiment Analysis on Topics (Beta) | ||
--- | ||
|
||
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 [email protected]. | ||
::: | ||
|
||
Topics are key drivers of the conversation. They're the most important keywords or phrases used. The topics algorithm provides a framework for the user to calibrate and precisely model the relationship among the concepts and understand how the semantics of the meetings is talked upon. Sentiment Analysis on topics determines whether the Topics resulting from the conversation are positive, negative, or neutral. | ||
|
||
:::note | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,6 +6,8 @@ title: Track Phrases In A Conversation | |
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 [email protected]. | ||
::: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,18 @@ | ||
--- | ||
id: summary | ||
title: GET Summary | ||
sidebar_label: GET Summary | ||
title: GET Summary (Beta) | ||
sidebar_label: GET Summary (Beta) | ||
slug: /conversation-api/summary | ||
--- | ||
import Tabs from '@theme/Tabs'; | ||
import TabItem from '@theme/TabItem'; | ||
|
||
--- | ||
|
||
:::info Symbl Labs | ||
This feature is a part of the 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 [email protected]. | ||
:::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 [email protected]. | ||
::: | ||
|
||
|
||
This API allows you to get a [Summary](/docs/concepts/summarization) of important contextual messages in a conversation. | ||
|
||
Currently, Summaries cannot be generated in real-time. Support for creating Summary in real-time will be added soon. | ||
|
@@ -33,7 +25,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-labs.symbl.ai/v1/conversations/{conversationId}/summary`** | ||
**<font color="orange">GET</font> `https://api.symbl.ai/v1/conversations/{conversationId}/summary`** | ||
|
||
### Request Headers | ||
|
||
|
@@ -58,7 +50,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-labs.symbl.ai/v1/conversations/{conversationId}/summary' \ | ||
curl --location --request GET 'https://api.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' \ | ||
|
@@ -73,7 +65,7 @@ const request = require('request'); | |
const authToken = AUTH_TOKEN;; | ||
|
||
request.get({ | ||
url: `https://api-labs.symbl.ai/v1/conversations/{conversationId}/summary`, | ||
url: `https://api.symbl.ai/v1/conversations/{conversationId}/summary`, | ||
headers: { 'Authorization': `Bearer ${authToken}` }, | ||
json: true | ||
}, (err, response, body) => { | ||
|
@@ -83,11 +75,6 @@ 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: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
--- | ||
id: summarization | ||
title: Summarization API- Capturing Key Points | ||
title: Summarization API- Capturing Key Points (Beta) | ||
description: Use Symbl.ai’s summarization API to capture key points in a conversation and create succinct summaries. Learn more. | ||
sidebar_label: Introduction | ||
slug: /concepts/summarization | ||
|
@@ -11,15 +11,8 @@ import TabItem from '@theme/TabItem'; | |
|
||
--- | ||
|
||
:::info Symbl Labs | ||
This feature is a part of the 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 [email protected]. | ||
:::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 [email protected]. | ||
::: | ||
|
||
Symbl distills important messages and creates succinct Summaries for long conversations. You can get these Summaries using the [Summary API](/docs/conversation-api/summary). | ||
|
@@ -46,15 +39,13 @@ If the number of words in a conversation is below 50 or the number of sentences | |
|
||
You can enable the Summary API for Async APIs using the following endpoints: <br/> | ||
|
||
Note that the base URL for Symbl Labs is always `https://api-labs.symbl.ai` | ||
|
||
API | Summary Endpoint | ||
---------- | ------- | ||
[Async Text API (POST/PUT)](/docs/async-api/overview/text/post-text)| ```https://api-labs.symbl.ai/v1/process/text?enableSummary=true ``` | ||
[Async Audio API (POST/PUT)](/docs/async-api/overview/audio/post-audio)| ```https://api-labs.symbl.ai/v1/process/audio?enableSummary=true``` | ||
[Async Audio URL API (POST/PUT)](/docs/async-api/overview/audio/post-audio-url)| ```https://api-labs.symbl.ai/v1/process/audio/url?enableSummary=true``` | ||
[Async Video API (POST/PUT)](/docs/async-api/overview/video/post-video)| ```https://api-labs.symbl.ai/v1/process/video?enableSummary=true``` | ||
[Async Video URL API (POST/PUT)](/docs/async-api/overview/video/post-video-url)| ```https://api-labs.symbl.ai/v1/process/video/url?enableSummary=true``` | ||
[Async Text API (POST/PUT)](/docs/async-api/overview/text/post-text)| ```https://api.symbl.ai/v1/process/text?enableSummary=true ``` | ||
[Async Audio API (POST/PUT)](/docs/async-api/overview/audio/post-audio)| ```https://api.symbl.ai/v1/process/audio?enableSummary=true``` | ||
[Async Audio URL API (POST/PUT)](/docs/async-api/overview/audio/post-audio-url)| ```https://api.symbl.ai/v1/process/audio/url?enableSummary=true``` | ||
[Async Video API (POST/PUT)](/docs/async-api/overview/video/post-video)| ```https://api.symbl.ai/v1/process/video?enableSummary=true``` | ||
[Async Video URL API (POST/PUT)](/docs/async-api/overview/video/post-video-url)| ```https://api.symbl.ai/v1/process/video/url?enableSummary=true``` | ||
|
||
Once the above API job is complete, the corresponding Summary can be obtained by sending a GET request to the Summary API. See the [**Summary API Documentation**](/docs/conversation-api/summary) for details. | ||
|
||
|
@@ -63,5 +54,4 @@ Once the above API job is complete, the corresponding Summary can be obtained by | |
## Tutorials | ||
- [How to get a Summary using Async APIs](/docs/tutorials/summarization/getting-summary) | ||
- [How to Refresh a Summary](/docs/tutorials/summarization/refreshing-summary) | ||
- [Providing Speaker Information to generate Summary](/docs/tutorials/summarization/adding-speaker-info) | ||
|
||
- [Providing Speaker Information to generate Summary](/docs/tutorials/summarization/adding-speaker-info) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
--- | ||
id: adding-speaker-info | ||
title: Providing Speaker Information to generate Summary | ||
title: Providing Speaker Information to generate Summary (Beta) | ||
sidebar_label: Providing Speaker Information to generate Summary | ||
slug: /tutorials/summarization/adding-speaker-info | ||
--- | ||
|
@@ -10,15 +10,8 @@ import TabItem from '@theme/TabItem'; | |
|
||
--- | ||
|
||
:::info Symbl Labs | ||
This feature is a part of the 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 [email protected]. | ||
:::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 [email protected]. | ||
::: | ||
|
||
Summaries are generated best when used with Speaker information captured in the conversation. It is highly recommended that you send us the speaker information to use this feature effectively. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
--- | ||
id: getting-summary | ||
title: How to get a Summary using Async API | ||
title: How to get a Summary using Async API (Beta) | ||
sidebar_label: Get Summary using Async API | ||
slug: /tutorials/summarization/getting-summary | ||
--- | ||
|
@@ -9,15 +9,8 @@ import TabItem from '@theme/TabItem'; | |
|
||
--- | ||
|
||
:::info Symbl Labs | ||
This feature is a part of the 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 [email protected]. | ||
:::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 [email protected]. | ||
::: | ||
|
||
This tutorial provides a step-by-step instructions on how to get a Summary using Async APIs. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,15 @@ | ||
--- | ||
id: refreshing-summary | ||
title: How to Refresh a Summary | ||
title: How to Refresh a Summary (Beta) | ||
sidebar_label: Refreshing a Summary | ||
slug: /tutorials/summarization/refreshing-summary | ||
--- | ||
import Tabs from '@theme/Tabs'; | ||
import TabItem from '@theme/TabItem'; | ||
|
||
--- | ||
:::info Symbl Labs | ||
This feature is a part of the 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 [email protected]. | ||
:::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 [email protected]. | ||
::: | ||
|
||
When you wish to renegerate a Summary that you generated earlier, you can do so in two ways: | ||
|