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

Merging master conflicts #451

Merged
merged 22 commits into from
Mar 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
6186dad
DC-347 (#416)
amritesh-singh Mar 10, 2022
70e0bda
Added forward slash to every redirect from Top and Navbar. (DC-307) (…
harshalkaigaonkar Mar 10, 2022
850618c
DC-349 (#424)
amritesh-singh Mar 10, 2022
67f0a17
Fix redirects. (#425)
Mar 11, 2022
528b712
Fix redirects (#426)
Mar 11, 2022
b079d4c
Fixes moesif issue (#427)
pema-s Mar 14, 2022
bd15017
DC-88 (#415)
amritesh-singh Mar 14, 2022
378fd02
DC-183 (#423)
amritesh-singh Mar 15, 2022
e686fb8
DC-286 Added snippet for stopping connection in sample (#406)
Mukulikaa Mar 15, 2022
93dcc97
Enable all trackers (#436)
pema-s Mar 17, 2022
5fd0dde
Updated/Added slugs for every Page required (DC-307) (#439)
harshalkaigaonkar Mar 21, 2022
8999f24
DC-127 (#432)
amritesh-singh Mar 21, 2022
f6cc933
DC-209 Consolidated two trackers with streaming api tutorials (#429)
Mukulikaa Mar 21, 2022
7483c23
DC-225 Further explanation for the `score` and `definitive` parameter…
Mukulikaa Mar 22, 2022
acef550
Revert "Updated/Added slugs for every Page required (DC-307) (#439)" …
pema-s Mar 22, 2022
5bc0c8e
DC 356 implement the title tags for seo (#435)
kushv16 Mar 22, 2022
9065719
Adds changes to Tracker Tutorials (#444)
pema-s Mar 23, 2022
122c3bb
fix: build errors due to #439 , resolved. (#445)
harshalkaigaonkar Mar 23, 2022
cff35c2
DC-358 (#447)
amritesh-singh Mar 23, 2022
b2a3650
Added the styleguide and moved readme, CoC (#446)
Mukulikaa Mar 23, 2022
598f64f
Adds authentication info (#448)
pema-s Mar 23, 2022
681374e
Merge branch 'master' into merging-master-conflicts
pema-s Mar 24, 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
2 changes: 1 addition & 1 deletion docs/api-reference/experience-api/post-text-summary-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: post-text-summary-ui
title: POST Text Summary UI
sidebar_label: POST Text Summary UI

slug: /api-reference/experience-api/post-text-summary-ui/
---

import Tabs from '@theme/Tabs';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: post-trackers-and-analytics-ui
title: POST Trackers and Analytics UI
sidebar_label: POST Trackers and Analytics UI

slug: /api-reference/experience-api/post-trackers-and-analytics-ui/
---

import Tabs from '@theme/Tabs';
Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/experience-api/post-video-summary-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: post-video-summary-ui
title: POST Video Summary UI
sidebar_label: POST Video Summary UI

slug: /api-reference/experience-api/post-video-summary-ui/
---

import Tabs from '@theme/Tabs';
Expand Down
3 changes: 3 additions & 0 deletions docs/api-reference/get-abstract-topics.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ The Abstract Topics are suitable for scenarios where you want to determine recur
Currently, Abstract Topics are not supported in real-time.
:::

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

### HTTP Request

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: how-to-use-sentiment-analysis
title: How To Use Sentiment Analysis (Beta)
slug: /async-api/code-snippets/how-to-use-sentiment-analysis/
---

import Tabs from '@theme/Tabs';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: receive-conversation-analytics
title: Receive Conversation Analytics
slug: /async-api/code-snippets/receive-conversation-analytics/
---

import Tabs from '@theme/Tabs';
Expand Down
1 change: 1 addition & 0 deletions docs/async-api/code-snippets/receive-entities.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: receive-entities
title: Receive Entities From Conversation
slug: /async-api/code-snippets/receive-entities/
---

import Tabs from '@theme/Tabs';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: receive-speech-to-text-and-ai-insights
title: Receive Speech-to-Text and AI Insights
slug: /async-api/code-snippets/receive-speech-to-text-and-ai-insights/
---

import Tabs from '@theme/Tabs';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: sentiment-analysis-on-messages
title: Sentiment Analysis on Messages (Beta)
slug: /async-api/code-snippets/sentiment-analysis-on-messages/
---

import Tabs from '@theme/Tabs';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: sentiment-analysis-on-topics
title: Sentiment Analysis on Topics (Beta)
slug: /async-api/code-snippets/sentiment-analysis-on-topics/
---

import Tabs from '@theme/Tabs';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: track-phrases-in-a-conversation
title: Track Phrases In A Conversation
slug: /async-api/code-snippets/track-phrases-in-a-conversation/
---

import Tabs from '@theme/Tabs';
Expand Down
67 changes: 32 additions & 35 deletions docs/async-api/introduction.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
---
id: introduction
title: Async API Documentation
title: Async API
description: Symbl.ai Async APIs provides a REST interface for submitting any recorded or saved conversations for transcription. Check out our Async APIs documentation to get started.
sidebar_label: Introduction
slug: /async-api/introduction/
---

<head>
<title>Async API Documentation</title>
</head>

---

The Async API provides a REST interface that helps you to submit any recorded or saved conversations to Symbl. When you submit a conversation, you'll receive a Conversation ID (`conversationId`), which is unique to your conversation.
Expand All @@ -20,23 +24,19 @@ You must wait for the job to complete processing before you proceed with getting

#### `conversationId` helps you with:

1. Helps you append the transcription of an existing file using `PUT` (also known as `append file`) Async APIs.
1. Helps you append the transcription of an existing file using `PUT` (also known as `append file`) Async APIs.
2. Using [Conversation API](/docs/conversation-api/introduction) you can receive Speech to Text data and conversational insights.



## Async API Types


### Text API

The Async Text API allows you to process any text payload.

It can be useful for any use case where you have access to textual content and want to extract insights and other conversational attributes supported by Symbl's [Conversation API](/docs/conversation-api/introduction).

* [Submit Text File](/docs/async-api/overview/text/post-text)
* [Append Text File To Existing Conversation](/docs/async-api/overview/text/put-text)

- [Submit Text File](/docs/async-api/overview/text/post-text)
- [Append Text File To Existing Conversation](/docs/async-api/overview/text/put-text)

### Audio API

Expand All @@ -46,13 +46,13 @@ It can be useful for any use case where you have access to recorded audio and wa

#### Audio File Endpoints

* [Submit Audio File](/docs/async-api/overview/audio/post-audio)
* [Append Audio File To Existing Conversation](/docs/async-api/overview/audio/post-audio)
- [Submit Audio File](/docs/async-api/overview/audio/post-audio)
- [Append Audio File To Existing Conversation](/docs/async-api/overview/audio/post-audio)

#### Audio URL Endpoints

* [Submit Audio URL](/docs/async-api/overview/audio/post-audio-url)
* [Append Audio URL To Existing Conversation](/docs/async-api/overview/audio/put-audio-url)
- [Submit Audio URL](/docs/async-api/overview/audio/post-audio-url)
- [Append Audio URL To Existing Conversation](/docs/async-api/overview/audio/put-audio-url)

### Video API

Expand All @@ -62,40 +62,37 @@ It can be useful in any use case where you have access to a video file of any ty

#### Video File Endpoints

* [Submit Video File](/docs/async-api/overview/video/post-video)
* [Append Video File To Existing Conversation](/docs/async-api/overview/video/post-video)
- [Submit Video File](/docs/async-api/overview/video/post-video)
- [Append Video File To Existing Conversation](/docs/async-api/overview/video/post-video)

#### Video URL Endpoints

* [Submit Video URL](/docs/async-api/overview/video/post-video-url)
* [Append Video URL To Existing Conversation](/docs/async-api/overview/video/put-video-url)

- [Submit Video URL](/docs/async-api/overview/video/post-video-url)
- [Append Video URL To Existing Conversation](/docs/async-api/overview/video/put-video-url)

## Endpoints

### Text API

| Method | Endpoint | |
|--------|----------|-|
|`POST` | `https://api.symbl.ai/v1/process/text` | [Reference](/docs/async-api/overview/text/post-text)
|`PUT` | `https://api.symbl.ai/v1/process/text/{conversationId}` | [Reference](/docs/async-api/overview/text/put-text)

| Method | Endpoint | |
| ------ | ------------------------------------------------------- | ---------------------------------------------------- |
| `POST` | `https://api.symbl.ai/v1/process/text` | [Reference](/docs/async-api/overview/text/post-text) |
| `PUT` | `https://api.symbl.ai/v1/process/text/{conversationId}` | [Reference](/docs/async-api/overview/text/put-text) |

### Audio API

| Method | Endpoint | |
|--------|----------|-|
|`POST` | `https://api.symbl.ai/v1/process/audio` | [Reference](/docs/async-api/overview/audio/post-audio)
|`POST` | `https://api.symbl.ai/v1/process/audio/url` | [Reference](/docs/async-api/overview/audio/post-audio-url)
|`PUT` | `https://api.symbl.ai/v1/process/audio/{conversationId}` | [Reference](/docs/async-api/overview/audio/put-audio)
|`PUT` | `https://api.symbl.ai/v1/process/audio/url/{conversationId}` | [Reference](/docs/async-api/overview/audio/put-audio-url)

| Method | Endpoint | |
| ------ | ------------------------------------------------------------ | ---------------------------------------------------------- |
| `POST` | `https://api.symbl.ai/v1/process/audio` | [Reference](/docs/async-api/overview/audio/post-audio) |
| `POST` | `https://api.symbl.ai/v1/process/audio/url` | [Reference](/docs/async-api/overview/audio/post-audio-url) |
| `PUT` | `https://api.symbl.ai/v1/process/audio/{conversationId}` | [Reference](/docs/async-api/overview/audio/put-audio) |
| `PUT` | `https://api.symbl.ai/v1/process/audio/url/{conversationId}` | [Reference](/docs/async-api/overview/audio/put-audio-url) |

### Video API

| Method | Endpoint | |
|--------|----------|-|
|`POST` | `https://api.symbl.ai/v1/process/video` | [Reference](/docs/async-api/overview/video/post-video)
|`POST` | `https://api.symbl.ai/v1/process/video/url` | [Reference](/docs/async-api/overview/video/post-video-url)
|`PUT` | `https://api.symbl.ai/v1/process/video/{conversationId}` | [Reference](/docs/async-api/overview/video/put-video)
|`PUT` | `https://api.symbl.ai/v1/process/video/url/{conversationId}` | [Reference](/docs/async-api/overview/video/put-video-url)
| Method | Endpoint | |
| ------ | ------------------------------------------------------------ | ---------------------------------------------------------- |
| `POST` | `https://api.symbl.ai/v1/process/video` | [Reference](/docs/async-api/overview/video/post-video) |
| `POST` | `https://api.symbl.ai/v1/process/video/url` | [Reference](/docs/async-api/overview/video/post-video-url) |
| `PUT` | `https://api.symbl.ai/v1/process/video/{conversationId}` | [Reference](/docs/async-api/overview/video/put-video) |
| `PUT` | `https://api.symbl.ai/v1/process/video/url/{conversationId}` | [Reference](/docs/async-api/overview/video/put-video-url) |
1 change: 1 addition & 0 deletions docs/async-api/overview/audio/post-audio-url.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: post-audio-url
title: POST Audio URL API
slug: /async-api/overview/audio/post-audio-url/
---

import Tabs from '@theme/Tabs';
Expand Down
1 change: 1 addition & 0 deletions docs/async-api/overview/audio/post-audio.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: post-audio
title: POST Audio API
slug: /async-api/overview/audio/post-audio/
---

import Tabs from '@theme/Tabs';
Expand Down
1 change: 1 addition & 0 deletions docs/async-api/overview/audio/put-audio-url.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: put-audio-url
title: PUT Audio URL API
slug: /async-api/overview/audio/put-audio-url/
---

import Tabs from '@theme/Tabs';
Expand Down
1 change: 1 addition & 0 deletions docs/async-api/overview/audio/put-audio.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: put-audio
title: PUT Audio API
slug: /async-api/overview/audio/put-audio/
---

import Tabs from '@theme/Tabs';
Expand Down
1 change: 1 addition & 0 deletions docs/async-api/overview/jobs-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: jobs-api
title: What is the Job API?
sidebar_label: Get Job Status
slug: /async-api/overview/jobs-api/
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Expand Down
1 change: 1 addition & 0 deletions docs/async-api/overview/text/post-text.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: post-text
title: POST Text API
slug: /async-api/overview/text/post-text/
---

import Tabs from '@theme/Tabs';
Expand Down
1 change: 1 addition & 0 deletions docs/async-api/overview/text/put-text.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: put-text
title: PUT Text API
slug: /async-api/overview/text/put-text/
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Expand Down
1 change: 1 addition & 0 deletions docs/async-api/overview/video/post-video-url.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: post-video-url
title: POST Video URL API
slug: /async-api/overview/video/post-video-url/
---

import Tabs from '@theme/Tabs';
Expand Down
1 change: 1 addition & 0 deletions docs/async-api/overview/video/post-video.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: post-video
title: POST Video API
slug: /async-api/overview/video/post-video/
---

import Tabs from '@theme/Tabs';
Expand Down
1 change: 1 addition & 0 deletions docs/async-api/overview/video/put-video-url.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: put-video-url
title: PUT Video URL API
slug: /async-api/overview/video/put-video-url/
---

import Tabs from '@theme/Tabs';
Expand Down
1 change: 1 addition & 0 deletions docs/async-api/overview/video/put-video.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: put-video
title: PUT Video API
slug: /async-api/overview/video/put-video/
---

import Tabs from '@theme/Tabs';
Expand Down
1 change: 1 addition & 0 deletions docs/async-api/reference/supported-languages.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: supported-languages
title: Supported Languages
sidebar_label: Supported Languages
slug: /async-api/reference/supported-languages/
---

## Supported Languages
Expand Down
48 changes: 48 additions & 0 deletions docs/best-practices/best-practices-trackers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
id: best-practices-trackers
title: Trackers Best Practice
sidebar_label: Trackers Best Practice
slug: /best-practices/best-practices-trackers/
---

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

Some of the best practices to keep in mind while creating the Trackers vocabulary are given below:

## Using Keywords

**Dos** <br/>
Densely pack the vocabulary with keywords. Each keyword should add meaning to the sentence.
For example, using “subscription fees” is a good practice because both the words “subscription” and “fees” contain keywords.

**Don’ts** <br/>
Do not preface a keyword with words that don’t add meaning.
For example, using “Could you please kindly inform me about your subscription fees?” is not a good vocabulary item because the first part of the sentence conveys very little information. Only the last two words in the sentence contain useful information, which is “subscription fees”.


## Sentence Structure

**Dos** <br/>
Structure the sentences in a simple way avoiding words that do not add to the meaning.
For example, “I can’t afford this” is a simple sentence where all the four words contribute to the meaning.

**Don’ts**<br/>
Do not use complex sentence structures that do not add meaning such as “I think”, “I feel”, etc.
For example, “I am thinking that I can’t afford this”. Here, the words “I am thinking that ” do not contribute to the meaning of this sentence since “I can’t afford this” is the key meaning of this sentence.

## One meaning per vocabulary phrase

**Dos**<br/>
Each phrase in the vocabulary should convey only one meaning.
For example,
“I used to like chocolate” and “I don’t like chocolate anymore” are conveying two different meanings and are constructed as different phrases.

**Don’ts**<br/>
Do not use two different meanings or thoughts in a single phrase.
For example,
“I used to like chocolate, but I don’t anymore”. This vocabulary phrase is combining two meanings into one sentence and is not a good practice.


4 changes: 4 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ 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.

### 14 March 2022

![api update](/img/api-update.png)
- **Enabling All Trackers with Streaming API**: Streaming API now supports enabling all the Trackers associated with an account. [Read more here](/docs/streaming-api/api-reference/#using-trackers). <br/>

### 8 Feb 2022

Expand Down
Loading