Revert "Merge pull request #409 from symblai/reverting"

This reverts commit 9a47075, reversing changes made to 5d54f79.
symblai · Mar 3, 2022 · 61ec9de · 61ec9de
1 parent 9a47075
commit 61ec9de
Show file tree

Hide file tree

Showing 17 changed files with 2,266 additions and 1,396 deletions.
diff --git a/docs/async-api/introduction.md b/docs/async-api/introduction.md
@@ -69,3 +69,33 @@ It can be useful in any use case where you have access to a video file of any ty
 
 * [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)
+
+
+### 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)
+
+
+### 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)
diff --git a/docs/async-api/overview/async-api-supported-languages.md b/docs/async-api/overview/async-api-supported-languages.md
@@ -42,9 +42,9 @@ The following list of languages(with their [BCP-47](https://en.wikipedia.org/wik
 
 ### Passing the Parameters
 
-* In Submit File Async **POST** ([Async Audio](/docs/async-api/overview/audio/post-audio), [Async Video](/docs/async-api/overview/video/post-video)) & **PUT** ([Async Audio](/docs/async-api/overview/audio/put-audio), [Async Video](/docs/async-api/overview/video/put-video)) we pass the `languageCode` in **query parameter**.  
+* In Submit File Async **POST** ([Async Audio](/docs/async-api/overview/audio/post-audio), [Async Video](/docs/async-api/overview/video/post-video)) & **PUT** ([Async Audio](/docs/async-api/overview/audio/put-audio), [Async Video](/docs/async-api/overview/video/put-video)) you have to pass the `languageCode` in **query parameter**.  
 
-* In Async URL APIs **POST** ([Async Audio URL](/docs/async-api/overview/audio/post-audio-url), [Async Video URL](/docs/async-api/overview/video/post-video-url)) & **PUT** ([Async Audio URL](/docs/async-api/overview/audio/put-audio-url), [Async Video URL](/docs/async-api/overview/video/put-video-url)) we pass the `languageCode` in **request body**.
+* In Async URL APIs **POST** ([Async Audio URL](/docs/async-api/overview/audio/post-audio-url), [Async Video URL](/docs/async-api/overview/video/post-video-url)) & **PUT** ([Async Audio URL](/docs/async-api/overview/audio/put-audio-url), [Async Video URL](/docs/async-api/overview/video/put-video-url)) you have to pass the `languageCode` in **request body**.
 
 <!--
 :::info

diff --git a/docs/async-api/reference/reference.md → ...sync-api/reference/supported-languages.md b/docs/async-api/reference/reference.md → ...sync-api/reference/supported-languages.md
@@ -1,37 +1,9 @@
 ---
-id: reference
-title: Async API Reference
+id: supported-languages
+title: Supported Languages
+sidebar_label: Supported Languages
 ---
 
-## 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)
-
-
-### 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)
-
-
-### 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)
-
 ## Supported Languages
 
 The Async Audio and Async Video APIs can work with languages other than English.

diff --git a/docs/developer-tools/errors.md b/docs/developer-tools/errors.md
@@ -16,7 +16,7 @@ Find details on common error codes and how to resolve them below.
 Error Code | Meaning
 ---------- | -------
 200 | OK -- Success.
-201 | Accepted -- Your request is successfully accepted.
+201 | Created -- Your request successfully led to the creation of a resource.
 400 | Bad Request -- Your request is invalid.
 401 | Unauthorized -- Your API key is invalid.
 403 | Forbidden

diff --git a/docs/streamingapi/code-snippets/receive-live-captioning.md b/docs/streamingapi/code-snippets/receive-live-captioning.md
@@ -1,6 +1,7 @@
 ---
 id: receive-live-captioning
 title: Receive Live Captioning
+slug: /streamingapi/code-snippets/receive-live-captioning
 ---
 
 import Tabs from '@theme/Tabs';
@@ -333,7 +334,7 @@ If successful you should receive a response in the console.
   }]
   ```
 
+## See Also
 
-
-
-
+- [Receive live insights](/docs/streamingapi/code-snippets/receive-live-insights)
+- [Receive live topics](/docs/streamingapi/code-snippets/receive-live-topics)
diff --git a/docs/streamingapi/code-snippets/receive-live-insights.md b/docs/streamingapi/code-snippets/receive-live-insights.md
@@ -1,6 +1,7 @@
 ---
 id: receive-ai-insights
 title: Receive Live AI Insights
+slug: /streamingapi/code-snippets/receive-live-insights
 ---
 
 import Tabs from '@theme/Tabs';
@@ -300,7 +301,7 @@ If successful you should receive a response in the console.
     }]
     ```
 
+## See Also
 
-
-
-
+- [Receive live captioning](/docs/streamingapi/code-snippets/receive-live-captioning)
+- [Receive live topics](/docs/streamingapi/code-snippets/receive-live-topics)
diff --git a/docs/streamingapi/code-snippets/receive-live-topics.md b/docs/streamingapi/code-snippets/receive-live-topics.md
@@ -1,6 +1,7 @@
 ---
 id: receive-live-topics
 title: Receive Live Topics
+slug: /streamingapi/code-snippets/receive-live-topics
 ---
 
 import Tabs from '@theme/Tabs';
@@ -258,3 +259,8 @@ If successful you should receive a response in the console.
       "type": "topic"
     }]
     ```
+
+## See Also
+
+- [Receive live captioning](/docs/streamingapi/code-snippets/receive-live-captioning)
+- [Receive live insights](/docs/streamingapi/code-snippets/receive-live-insights)
diff --git a/docs/streamingapi/reference/reference.md b/docs/streamingapi/reference/reference.md
@@ -16,10 +16,6 @@ Symbl's Streaming API is based on the WebSocket protocol and can be used for rea
 Currently, Streaming API is supported in English only. However, the support for Spanish is available as a part of Symbl Labs. 
 ::: 
 
-:::note Opus codec
-Streaming API supports Opus with 48000 Hz sample rate.
-:::
-
 ## Request Parameters
 
 #### Endpoint
@@ -81,17 +77,17 @@ Field | Required | Supported value | Default Value | Description
 
 Field | Required | Supported value | Default Value | Description
 ---------- | ------- | ------- |  ------- |  -------
-```encoding``` | false  | LINEAR16, FLAC, MULAW | LINEAR16 | Audio Encoding in which the audio will be sent over the WebSocket.
-```sampleRateHertz	``` | false  |  | 16000 | The rate of the incoming audio stream.
-
+```encoding``` | false  | `LINEAR16`, `FLAC`, `MULAW`, `Opus` | `LINEAR16` | Audio Encoding in which the audio will be sent over the WebSocket.
+```sampleRateHertz	``` | false  |  | `16000` | The rate of the incoming audio stream. The following are supported with the sample rates: <br/> encoding `LINEAR16` for sample rates `8000` to `48000`, <br/> encoding `FLAC` for sample rates `16000 ` and above, <br/> encoding `MULAW` for sample rates `8000`, <br/> encoding `Opus` for sample rates `16000` to `48000`.
+ 
 
 ##### Code Example
 
 ```js
 {
   "speechRecognition": {
     "encoding": "LINEAR16",
-    "sampleRateHertz": 44100 // Make sure the correct sample rate is provided for best results
+    "sampleRateHertz": 16000 // Make sure the correct sample rate is provided for best results
   }
 }
 ```

diff --git a/docs/streamingapi/tutorials/get-real-time-sentiment-analysis.md b/docs/streamingapi/tutorials/get-real-time-sentiment-analysis.md
@@ -346,7 +346,6 @@ if (data.type === 'message' && data.message.hasOwnProperty('data')) {
     request.send()
     }
 
-};
   if (data.type === 'message_response') {
     for (let message of data.messages) {
       console.log('Transcript (more accurate): ', message.payload.content);
@@ -433,4 +432,4 @@ const handleSuccess = (stream) => {
 handleSuccess(stream);
 ```
 
-If you properly implemented the code, the code runs successfully in the browser!
+If you properly implemented the code, the code runs successfully in the browser!