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.

Sign up for GitHub

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-361 #456

Merged
merged 6 commits into from
Mar 31, 2022
Merged

DC-361 #456

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f5cfaf3
DC-358
amritesh-singh Mar 23, 2022
88238c5
Merge branch 'develop' of https://github.com/symblai/symbl-docs into …
amritesh-singh Mar 24, 2022
06086ab
DC-361
amritesh-singh Mar 24, 2022
6ac8c36
Revert "DC-361"
amritesh-singh Mar 24, 2022
c3dec97
DC-361
amritesh-singh Mar 24, 2022
0588baf
DC-361
amritesh-singh Mar 25, 2022
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
7 changes: 3 additions & 4 deletions docs/async-api/code-snippets/how-to-use-sentiment-analysis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,10 @@ You must wait for the job to complete processing before you proceed with getting

While we provide you with a default video URL for the API to process, which can be downloaded [here](https://symbltestdata.s3.us-east-2.amazonaws.com/sample_video_file.mp4), you can replace that with any other video URL.

### Request Example
### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

:::info
Before using the Async API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
:::
### Request Example

<Tabs
defaultValue="cURL"
Expand Down
7 changes: 3 additions & 4 deletions docs/async-api/code-snippets/receive-conversation-analytics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,10 @@ While we provide you with a default video URL for the API to process, which can
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.
:::

### Request Example
### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

:::info
Before using the Async API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
:::
### Request Example

<Tabs
defaultValue="cURL"
Expand Down
7 changes: 3 additions & 4 deletions docs/async-api/code-snippets/receive-entities.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,10 @@ While we provide you with a default video URL for the API to process, which can
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.
:::

### Request Example
### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

:::info
Before using the Async API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
:::
### Request Example

<Tabs
defaultValue="cURL"
Expand Down
7 changes: 3 additions & 4 deletions docs/async-api/code-snippets/receive-speech-to-text-and-ai-insights.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,10 @@ While we provide you with a default video URL for the API to process, which can
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.
:::

### Request Example
### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

:::info
Before using the Async API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
:::
### Request Example

<Tabs
defaultValue="cURL"
Expand Down
3 changes: 3 additions & 0 deletions docs/async-api/code-snippets/sentiment-analysis-on-messages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ In this example, we will process an audio file (in .wav format) via Async Audio

To view the complete reference, see [Async API documentation](/docs/async-api/introduction).

### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

### Example API Endpoint

`POST https://api.symbl.ai/v1/process/audio`
Expand Down
3 changes: 3 additions & 0 deletions docs/async-api/code-snippets/sentiment-analysis-on-topics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ In this example, we will process an audio file (in .wav format) via Async Audio

To view the complete reference, see [Async API documentation](/docs/async-api/introduction).

### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

### Example API Endpoint

`POST https://api.symbl.ai/v1/process/audio`
Expand Down
7 changes: 3 additions & 4 deletions docs/async-api/code-snippets/track-phrases-in-a-conversation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,10 @@ While we provide you with a default textual conversation for the API to process
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.
:::

### Request Example
### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

:::info
Before using the Async API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
:::
### Request Example

<Tabs
defaultValue="cURL"
Expand Down
5 changes: 3 additions & 2 deletions docs/async-api/overview/audio/post-audio-url.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,16 @@ It can be utilized for any use case where you have access to recorded audio stor
The URL provided must be a publicly available URL. Currently, we do not support any redirected links, shortened links (e.g. bit.ly), YouTube, Vimeo, or links from any audio/video platforms.
:::

### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

### API Endpoint

`POST https://api.symbl.ai/v1/process/audio/url`


### Example API Call

Before using the Async Audio API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).

<Tabs
defaultValue="cURL"
values={[
Expand Down
5 changes: 3 additions & 2 deletions docs/async-api/overview/audio/post-audio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ It can be utilized for any use case where you have access to recorded audio and

Use this API to upload your file and generate a Conversation ID. If you want to append additional audio information to the same Conversation ID.

### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

### API Endpoint

`POST https://api.symbl.ai/v1/process/audio`
Expand All @@ -23,8 +26,6 @@ Use this API to upload your file and generate a Conversation ID. If you want to

The sample request accepts just the raw audio file from the data with the MIME typeset in the Content-Type Header. The audio file should only have Mono Channel.

Before using the Async Audio API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).

<Tabs
defaultValue="cURL"
values={[
Expand Down
5 changes: 2 additions & 3 deletions docs/async-api/overview/audio/put-audio-url.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,15 @@ If there are multiple requests are submitted for the same Conversation ID, all t
in order to maintain the order of the requests for the conversation.
:::

### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

### API Endpoint

`PUT https://api.symbl.ai/v1/process/audio/url/:conversationId`


### Example API Call

Before using the Async Audio API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).

<Tabs
defaultValue="cURL"
values={[
Expand Down
4 changes: 2 additions & 2 deletions docs/async-api/overview/audio/put-audio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ The Async Audio API allows you to process an additional audio file to the previo

It can be useful in any use case where you have access to multiple audio files of any type of conversation, and you want to extract the insightful items supported by the [Conversation API](/docs/conversation-api/introduction).

### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

### API Endpoint

`PUT https://api.symbl.ai/v1/process/audio/:conversationId`

### Example API Call

Before using the Async Audio API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).

<Tabs
defaultValue="cURL"
values={[
Expand Down
5 changes: 3 additions & 2 deletions docs/async-api/overview/text/post-text.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,15 @@ import TabItem from '@theme/TabItem';

The Async Text API allows you to process any text payload. This API is useful for when you want to extract Conversation Insights from textual content.

### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

### API Endpoint

`POST https://api.symbl.ai/v1/process/text`

### Example API Call

Before using the Async Text API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).

<Tabs
defaultValue="cURL"
values={[
Expand Down
6 changes: 3 additions & 3 deletions docs/async-api/overview/text/put-text.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ It can be useful in cases where you have new information like chats, emails or m
If there are multiple requests are submitted for the same Conversation ID, all the requests will be processed synchronously in order to maintain the order of the requests for the conversation.
:::

### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

### API Endpoint

`PUT https://api.symbl.ai/v1/process/text/:conversationId`

### Example API Call

Before using the Async Text API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).


<Tabs
defaultValue="cURL"
values={[
Expand Down
5 changes: 2 additions & 3 deletions docs/async-api/overview/video/post-video-url.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,15 @@ The URL provided must be a publicly available URL. Currently we do not support a
This API supports only <b>mp4</b> file formats video. If you have any other type of file, you need to first convert the file to the supported format in order to use the API.
:::

### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

### API Endpoint

`POST https://api.symbl.ai/v1/process/video/url`


### Example API Call

Before using the Async Video API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).

<Tabs
defaultValue="cURL"
values={[
Expand Down
6 changes: 3 additions & 3 deletions docs/async-api/overview/video/post-video.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ It can be useful in any use case where you have access to the video file of any
This API supports only <b>mp4</b> file formats. If you have any other type of file, you need to first convert the file to the supported format in order to use the API.
:::

### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

### API Endpoint
`POST https://api.symbl.ai/v1/process/video`


### Example API Call

Before using the Async Video API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).

<Tabs
defaultValue="cURL"
values={[
Expand Down
5 changes: 3 additions & 2 deletions docs/async-api/overview/video/put-video-url.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,15 @@ If there are multiple requests are submitted for the same Conversation ID all th
in order to maintain the order of the requests for the conversation.
:::

### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

### API Endpoint

`PUT https://api.symbl.ai/v1/process/video/url/:conversationId`

### Example API Call

Before using the Async Video API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).

<Tabs
defaultValue="cURL"
values={[
Expand Down
7 changes: 3 additions & 4 deletions docs/async-api/overview/video/put-video.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,15 @@ If there are multiple requests are submitted for the same Conversation ID, all t
in order to maintain the order of the requests for the conversation.
:::

### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

### API Endpoint

`PUT https://api.symbl.ai/v1/process/video/:conversationId`

### Example API Call

:::info
Before using the Async Video API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
:::

<Tabs
defaultValue="cURL"
values={[
Expand Down
8 changes: 3 additions & 5 deletions docs/async-api/tutorials/generate-pre-built-ui-from-video-recordings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,10 @@ To get the Summary UI, we need to process the video using Symbl's [POST Video Us
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.
:::

### Example API Call

:::info
Before using the Async API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication).
:::
### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

### Example API Call

<Tabs
defaultValue="cURL"
Expand Down
7 changes: 4 additions & 3 deletions docs/async-api/tutorials/get-speaker-separation-audio-video.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,16 @@ This snippet shows a cURL command for consuming the Async Video URL-based API wh
The below example uses the Async Video URL API, but Speaker Separation can be achieved with other Async Audio/Video APIs in the same way.
:::

* `AUTH_TOKEN` needs to be replaced with the Bearer token generated during [our authentication process](/docs/developer-tools/authentication).

* For accuracy, `NUMBER_OF_UNIQUE_SPEAKERS` should match the number of unique speakers in the Audio/Video data.
For accuracy, `NUMBER_OF_UNIQUE_SPEAKERS` should match the number of unique speakers in the Audio/Video data.


:::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.
:::

### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

#### Code Example

<Tabs
Expand Down