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

Corrects grammar #453

Merged
merged 1 commit into from
Mar 24, 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
49 changes: 18 additions & 31 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ our APIs or SDKs, we've got you covered!
<div class="card"><a href="/docs/api-reference/getting-started"><h4>API Reference</h4>Browse through our APIs, learn how they work and get detailed descriptions and sample codes for each endpoint.</a></div>
</div>
<div class="column">
<div class="card"><a href="/docs/sdk-intro"><h4>SDK</h4>Add Symbl capabilities directly to your web and mobile applications with our robust Python and JavaScript SDKs. </a>
<div class="card"><a href="/docs/sdk-intro"><h4>SDK</h4>Add Symbl capabilities directly to your web and mobile applications with our robust SDKs available in popular languages. </a>
</div>
</div>
<div class="column">
Expand All @@ -26,56 +26,43 @@ our APIs or SDKs, we've got you covered!
<div class="card"><a href="/guides"><h4>Guides</h4>Learn about Symbl's capabilities, understand business use-cases and discover Conversation Intelligence applications across industries.</a></div>
</div>
</div>
<br/>

## What is Symbl?
---

[Symbl](https://symbl.ai/) is an AI-powered, API first, Conversation Intelligence platform for natural human conversations that works on audio, video, and textual content in real-time or recorded files. Symbl’s APIs let you generate real-time Sentiment Analysis, Action Items, Topics, Trackers, Summary and much more in your applications.

<div><a href="/docs/what-is-symbl">Learn more ➡️ &nbsp;</a></div>

## Getting Started
### Step 1: Get Symbl API Credentials
## Getting Started with Symbl
### Step 1. Get API Credentials
---

Sign up on the [Symbl Platform](https://platform.symbl.ai/#/login) and grab your API Credentials. <br/>
Using the Symbl credentials, you can [generate the authentication token](/docs/developer-tools/authentication) that you can use everytime you make Symbl API calls.
&nbsp;

### Step 2: Send Recorded Conversation OR Connect Live
### Step 2. Send Recorded Conversation OR Connect Live
---

Using the following APIs, send conversation data in real-time or after the conversation has taken place (async).
Using the APIs given below, send conversation data in real-time or after the conversation has taken place (async) i.e., with recorded data.

&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 a live audio conversation via SIP and PSTN.<br/>


Before getting the Conversation Intelligence, you must wait for the processing job to complete.


### Step 3: Get Conversation Intelligence
### Step 3. Get Conversation Intelligence
---

Step 2 returns a `conversationId` by default. Use this in the **Conversation API** to generate any of the following Conversation Intelligence:
In Step 2, the `conversationId` is returned. Use the Conversation ID in the **Conversation API** to generate Symbl's Conversation Intelligence and insights:

&nbsp; &nbsp;👉 &nbsp; [Speech-to-Text (Transcripts)](/docs/concepts/speech-to-text)<br/>
&nbsp; &nbsp;👉 &nbsp; [Topics](/docs/concepts/topics) <br/>
&nbsp; &nbsp;👉 &nbsp; [Sentiment Analysis](/docs/concepts/sentiment-analysis) <br/>
&nbsp; &nbsp;👉 &nbsp; [Action Items](/docs/concepts/action-items)<br/>
&nbsp; &nbsp;👉 &nbsp; [Follow-Ups](/docs/concepts/follow-ups)<br/>
&nbsp; &nbsp;👉 &nbsp; [Questions](/docs/concepts/questions)<br/>
&nbsp; &nbsp;👉 &nbsp; [Trackers](/docs/concepts/trackers)<br/>
&nbsp; &nbsp;👉 &nbsp; [Conversation Groups](/docs/concepts/conversation-groups)<br/>
&nbsp; &nbsp;👉 &nbsp; [Conversation Analytics](/docs/concepts/conversational-analytics)<br/>
&nbsp; &nbsp;👉 &nbsp; [Topic Hierarchy](/docs/concepts/topic-hierarchy)<br/>
&nbsp; &nbsp;👉 &nbsp; [Get Speech-to-Text (Transcripts)](/docs/concepts/speech-to-text)<br/>
&nbsp; &nbsp;👉 &nbsp; [Get Topics](/docs/concepts/topics) <br/>
&nbsp; &nbsp;👉 &nbsp; [Get Sentiment Analysis](/docs/concepts/sentiment-analysis) <br/>
&nbsp; &nbsp;👉 &nbsp; [Get Action Items](/docs/concepts/action-items)<br/>
&nbsp; &nbsp;👉 &nbsp; [Get Follow-Ups](/docs/concepts/follow-ups)<br/>
&nbsp; &nbsp;👉 &nbsp; [Get Questions](/docs/concepts/questions)<br/>
&nbsp; &nbsp;👉 &nbsp; [Get Trackers](/docs/concepts/trackers)<br/>
&nbsp; &nbsp;👉 &nbsp; [Get Conversation Groups](/docs/concepts/conversation-groups)<br/>
&nbsp; &nbsp;👉 &nbsp; [Get Conversation Analytics](/docs/concepts/conversational-analytics)<br/>
&nbsp; &nbsp;👉 &nbsp; [Get Topic Hierarchy](/docs/concepts/topic-hierarchy)<br/>

... and more.

Also check out our features in Labs such as Summarization, Comprehensive Action Items, Identifying and Redacting PII in the [Labs section](/docs/labs).

Also, check out our features in the [Labs section](/docs/labs) that are currently being . Symbl Labs is an experimental wing that intends to apply and explore AI research on human conversations.

<div class="row">
<div class="column">
Expand Down
4 changes: 2 additions & 2 deletions docs/labs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ slug: /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 the platform to get your credentials.
You can access the Labs features using your Symbl App ID and Secret. If you don't already have it, [sign up](https://platform.symbl.ai/#/signup) on the Symbl Platform to get your credentials.

Note that the base URL for all Symbl Labs feature is always `https://api-labs.symbl.ai`

:::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.
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 Labs features on the sole discretion of our team, as deemed necessary.
:::

For any queries or feedback, please contact us at [email protected].