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

Publish Web SDK doc #485

Merged
merged 59 commits into from
Apr 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
59 commits
Select commit Hold shift + click to select a range
dcf2995
change for exp branch
Jan 11, 2022
fd2f352
merge-docs-v1 added for build to workflow
Jan 11, 2022
63a2ff0
changes for dev and prod dispatch events
Jan 12, 2022
5829bef
Merge pull request #333 from symblai/merge-docs-v1
Jan 12, 2022
19cd7c8
Testing changes
amritesh-singh Jan 14, 2022
d7ed975
Merge pull request #335 from amritesh-singh/14-01-22
amritesh-singh Jan 14, 2022
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
63f58c5
DC-149 (#419)
amritesh-singh Mar 24, 2022
8565ded
Add logos to sdk (#452)
kushv16 Mar 24, 2022
1ebdae6
Update README.md (#326)
Mar 24, 2022
51dd29e
fix: TopBar highlighting bug fixed, hardcoded the slugs. (#449)
harshalkaigaonkar Mar 24, 2022
5a43aa0
Corrects grammar (#453)
pema-s Mar 24, 2022
88decef
DC-377 (#458)
amritesh-singh Mar 29, 2022
be56cca
Update homepage cards (#459)
pema-s Mar 29, 2022
5906cea
DC-380 (#460)
pema-s Mar 29, 2022
b11a2d6
DC-365 (#462)
amritesh-singh Mar 31, 2022
8190fdc
DC-361 (#456)
amritesh-singh Mar 31, 2022
7a452b0
DC-381, DC-382 (#465)
pema-s Apr 4, 2022
c7e03df
Bug fixes 04 04 (#466)
pema-s Apr 4, 2022
a4dc297
Merge branch 'develop' of https://github.com/symblai/symbl-docs into …
Apr 4, 2022
76b3cfe
PUT text sample (#464)
warunawijesinhaarachchige Apr 8, 2022
374f2d0
DC-198, DC-395, DC-158, DC-400, DC- 379, DC-398 (#471)
pema-s Apr 11, 2022
361d680
DC-218 Add closing bracket (#473)
Mukulikaa Apr 12, 2022
347add3
Python code sample fixed (#463)
warunawijesinhaarachchige Apr 12, 2022
2f95515
DC-399 (#476)
pema-s Apr 12, 2022
ecff5c4
Fix issue with intro.
Apr 12, 2022
d0bccd2
Merge pull request #478 from symblai/web-sdk-doc-fixes
Apr 12, 2022
b1b1783
Start on rewrite and reformatting of docs. (#481)
Apr 13, 2022
a01080b
Docs rewrite (#482)
Apr 13, 2022
e425076
Add more docs changes. (#487)
Apr 14, 2022
7d6dc9e
DC-398 (#490)
amritesh-singh Apr 18, 2022
29db75f
DC-213 Separated part of speaker separation tutorial into a new page …
Mukulikaa Apr 18, 2022
67dadea
DC-362 Modify entities example (#469)
Mukulikaa Apr 18, 2022
485892e
DC-394 (#493)
pema-s Apr 18, 2022
75e06c9
Update introduction.md (#489)
Apr 18, 2022
f325bf7
DC-176 (#477)
amritesh-singh Apr 20, 2022
1b7fe2c
DC-212 Added crosslinking for better understanding (#491)
Mukulikaa Apr 20, 2022
21c9102
DC-384 (#474)
amritesh-singh Apr 20, 2022
af15276
Fix image sizes (#496)
Apr 21, 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
59 changes: 0 additions & 59 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,62 +35,3 @@ The PRs are reviewed every Thursday by our team.

If you wish to suggest a new topic, want to request additional details, or raise any other issues, you can [Open an Issue](https://github.com/symblai/symbl-docs/issues/new). The resolution time for issues reported is the same as for PRs.


## Setting up Docs locally

1. Clone the Symbl Docs Repo

- Using SSH:

```js
$ git clone [email protected]:symblai/symbl-docs.git
```

OR

- Using HTTPS:

```js
$ git clone https://github.com/symblai/symbl-docs.git
```

2. Open your local directory where you cloned the docs

```js
$ cd symbl-docs
```

3. Switch to develop branch to make changes

```js
$ git checkout develop
```
### Installation

```js
$ yarn
```

### Local Development

```js
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```js
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static content hosting service.

### Deployment

```js
$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
```

If you are using GitHub Pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
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
5 changes: 4 additions & 1 deletion docs/api-reference/get-abstract-topics.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: get-abstract-topics
title: GET Abstract Topics (Labs)
sidebar_label: GET Abstract Topics (Labs)
slug: /api-reference/abstract-topics
slug: /api-reference/abstract-topics/
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Expand All @@ -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
2 changes: 1 addition & 1 deletion docs/api-reference/getting-conversation-intelligence.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: getting-conversation-intelligence
title: Getting Started
sidebar_label: Getting Started
slug: /api-reference/getting-conversation-intelligence
slug: /api-reference/getting-conversation-intelligence/
---
---

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: api-getting-started
title: Symbl APIs
sidebar_label: Introduction
slug: /api-reference/getting-started
slug: /api-reference/getting-started/
---
---

Expand Down
12 changes: 7 additions & 5 deletions docs/async-api/code-snippets/how-to-use-sentiment-analysis.md
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 All @@ -22,11 +23,12 @@ 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).
:::
For Node.js sample you need to install the node package `request`. You can do that via with `npm install request`.

### Request Example

<Tabs
defaultValue="cURL"
Expand Down Expand Up @@ -153,7 +155,7 @@ const responses = {

request.post(videoOption, (err, response, body) => {
const statusCode = response.statusCode;
if (error || Object.keys(responses).indexOf(statusCode.toString()) !== -1) {
if (err || Object.keys(responses).indexOf(statusCode.toString()) !== -1) {
throw new Error(responses[statusCode]);
}
console.log('Status code: ', statusCode);
Expand Down
10 changes: 5 additions & 5 deletions docs/async-api/code-snippets/receive-conversation-analytics.md
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 All @@ -18,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 Expand Up @@ -149,7 +149,7 @@ const responses = {

request.post(videoOption, (err, response, body) => {
const statusCode = response.statusCode;
if (error || Object.keys(responses).indexOf(statusCode.toString()) !== -1) {
if (err || Object.keys(responses).indexOf(statusCode.toString()) !== -1) {
throw new Error(responses[statusCode]);
}
console.log('Status code: ', statusCode);
Expand Down
8 changes: 4 additions & 4 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 All @@ -18,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
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 All @@ -20,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 Expand Up @@ -151,7 +151,7 @@ const responses = {

request.post(videoOption, (err, response, body) => {
const statusCode = response.statusCode;
if (error || Object.keys(responses).indexOf(statusCode.toString()) !== -1) {
if (err || Object.keys(responses).indexOf(statusCode.toString()) !== -1) {
throw new Error(responses[statusCode]);
}
console.log('Status code: ', statusCode);
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 Expand Up @@ -35,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
4 changes: 4 additions & 0 deletions docs/async-api/code-snippets/sentiment-analysis-on-topics.md
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 Expand Up @@ -33,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
10 changes: 5 additions & 5 deletions docs/async-api/code-snippets/track-phrases-in-a-conversation.md
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 All @@ -22,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 Expand Up @@ -158,7 +158,7 @@ const responses = {

request.post(videoOption, (err, response, body) => {
const statusCode = response.statusCode;
if (error || Object.keys(responses).indexOf(statusCode.toString()) !== -1) {
if (err || Object.keys(responses).indexOf(statusCode.toString()) !== -1) {
throw new Error(responses[statusCode]);
}
console.log('Status code: ', statusCode);
Expand Down
Loading