Skip to content

Commit

Permalink
Publish Web SDK doc (#485)
Browse files Browse the repository at this point in the history 
* change for exp branch

* merge-docs-v1 added for build to workflow

* changes for dev and prod dispatch events

* Testing changes

* DC-347 (#416)

* Added forward slash to every redirect from Top and Navbar. (DC-307) (#422)

* DC-307

* added forward slash for every slug of the file

* DC-349 (#424)

* Fix redirects. (#425)

* Fix redirects (#426)

* Fix redirects.

* Fix staging build.

* Fixes moesif issue (#427)

* DC-88 (#415)

* DC-88

* Update reference.md

* DC-183 (#423)

* DC-286 Added snippet for stopping connection in sample (#406)

* change for exp branch

* merge-docs-v1 added for build to workflow

* changes for dev and prod dispatch events

* Testing changes

* DC-286 Added snippet for stopping connection in sample

Co-authored-by: harshad-symbl <[email protected]>
Co-authored-by: Adam Voliva <[email protected]>
Co-authored-by: amritesh-singh <[email protected]>

* Enable all trackers (#436)

* DC-357

Adds enable all trackers + splits docs into logical buckets

* added more content

* Adds more changes

* Updated/Added slugs for every Page required (DC-307) (#439)

* DC-307

* added forward slash for every slug of the file

* '/' added to slug of changelog for topbar

* Added slugs for pages on sidebar of landing page

* slugs for links on sidebars for API reference

* slugs for links on sidebars for Tutorials, No Updates for SDKs

* Adds changes to Labs topics + updates changelog

Co-authored-by: pema-s <[email protected]>

* DC-127 (#432)

* DC-209 Consolidated two trackers with streaming api tutorials (#429)

* DC-209 Consolidated two trackers with streaming api tutorials

* removed trailing white-space

* DC-225 Further explanation for the `score` and `definitive` parameters (#431)

* DC-225 Further explanation for the  and  parameters

* Improved wording

* Revert "Updated/Added slugs for every Page required (DC-307) (#439)" (#441)

This reverts commit 5fd0dde.

* DC 356 implement the title tags for seo (#435)

* DC-356

* DC-356

* DC-356

Co-authored-by: Pema <[email protected]>

* Adds changes to Tracker Tutorials (#444)

* fix: build errors due to #439 , resolved. (#445)

* slugs added/updated as per DC-307

* updated id from `text-summary-ui` to `summary-ui`

* removed redirects, due to using urls for the same version, causing build errors

* Some incorrect changes with the last commit resolved

* DC-358 (#447)

* Added the styleguide and moved readme, CoC (#446)

* Adds authentication info (#448)

* DC-149 (#419)

* DC-149

* DC-149

* Add logos to sdk (#452)

* DC-360

* DC-360

* Update README.md (#326)

* fix: TopBar highlighting bug fixed, hardcoded the slugs. (#449)

* Updated the default routing for all the topbar links

* fix: Active highlighting bug fixed, by hardcoding the slugs on regex

* Handled for `/async-api/introduction` and `/async-api/reference`

* corrects missing pages

* change made on the stagging config for active links

Co-authored-by: pema-s <[email protected]>

* Corrects grammar (#453)

* DC-377 (#458)

* Update homepage cards (#459)

* update ui cards

* Makes dark mode default

Co-authored-by: Kush Vora <[email protected]>

* DC-380 (#460)

* DC-365 (#462)

* DC-361 (#456)

* DC-358

* DC-361

* Revert "DC-361"

This reverts commit 06086ab.

* DC-361

* DC-361

* DC-381, DC-382 (#465)

Adds bug fixes

* Bug fixes 04 04 (#466)

* DC-381, DC-382

Adds bug fixes

* DC-129, DC-372

* PUT text sample (#464)

PUT text python sample fixed

* DC-198, DC-395, DC-158, DC-400, DC- 379, DC-398 (#471)

* DC-218 Add closing bracket (#473)

* Python code sample fixed (#463)

Python code sample was not working. It is fixed now

* DC-399 (#476)

Adds web sdk documentation

* Fix issue with intro.

* Start on rewrite and reformatting of docs. (#481)

* Start on rewrite and reformatting of docs.

* Add more referencs.

* Add more detailed installation instructions.

* Add more thorough CDN example.

* Docs rewrite (#482)

* Start on rewrite and reformatting of docs.

* Add more referencs.

* Add more detailed installation instructions.

* Add more thorough CDN example.

* Add beta wording.

* Add more docs changes. (#487)

* Add more docs changes.

* Add that the application is a typescript application.

* DC-398 (#490)

* DC-213 Separated part of speaker separation tutorial into a new page (#492)

* DC-362 Modify entities example (#469)

* DC-362 Modify entities example

* Added other entity types

* DC-394 (#493)

Corrects incorrect code

* Update introduction.md (#489)

* DC-176 (#477)

* DC-176

* DC-176

* DC-212 Added crosslinking for better understanding (#491)

* DC-384 (#474)

* Fix image sizes (#496)

* Fix image sizes.

* Fix image size issue.

Co-authored-by: harshad-symbl <[email protected]>
Co-authored-by: Adam Voliva <[email protected]>
Co-authored-by: amritesh-singh <[email protected]>
Co-authored-by: harshal kaigaonkar <[email protected]>
Co-authored-by: Mukulika <[email protected]>
Co-authored-by: Kush Vora <[email protected]>
Co-authored-by: warunawijesinhaarachchige <[email protected]>
  • Loading branch information
@pema-s @amritesh-singh
@harshalkaigaonkar @Mukulikaa @kushv16 @warunawijesinhaarachchige
8 people authored Apr 21, 2022
1 parent 241e68b commit aea9079
Show file tree
Hide file tree
Showing 14 changed files with 361 additions and 349 deletions.
64 changes: 32 additions & 32 deletions docs/async-api/overview/audio/post-audio-url.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -298,25 +298,25 @@ Header Name | Required | Description

### Request Body Parameters

Parameters | Required | Type | Description
---------- | ------- | ------- | -------
```url``` | Mandatory | String | A valid url string. The URL must be a publicly accessible url.
```customVocabulary``` | Optional | String[] | Contains a list of words and phrases that provide hints to the speech recognition task.
```confidenceThreshold``` | Optional | Double | Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range >=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`.
```detectPhrases```| Optional | Boolean | It shows Actionable Phrases in each sentence of conversation. These sentences can be found using the Conversation's Messages API. It's a boolean value where the default value is `false`.
```name``` | Optional | String | Your meeting name. Default name set to `conversationId`.
```webhookUrl``` | Optional | String | Webhook URL on which job updates to be sent. This should be after the API call is made. For Webhook payload, refer to the [Using Webhook](#using-webhook) section below.
```entities``` | Optional | Object[] | Input custom entities which can be detected in your conversation using [Entities API](/docs/conversation-api/entities).
```detectEntities``` | Optional | Boolean | Default value is `false`. If not set the [Entities API](/docs/conversation-api/entities) will not return any entities from the conversation.
```languageCode```| Optional | String | We accept different languages. Please [check language Code](/docs/async-api/overview/async-api-supported-languages) as per your requirement.
``` mode``` | Optional | String | Accepts `phone` or `default`. `phone` mode is best for audio that is generated from phone call(which is typically recorded at 8khz sampling rate).<br />`default` mode works best for audio generated from video or online meetings(which is typically recorded at 16khz or more sampling rate).<br />When you don't pass this parameter `default` is selected automatically.
```enableSeparateRecognitionPerChannel``` | Optional | Boolean | Enables Speaker Separated Channel audio processing. Accepts `true` or `false`.
```channelMetadata``` | Optional | Object[] | This object parameter contains two variables `speaker` and `channel` to specific which speaker corresponds to which channel. This object **only** works when `enableSeparateRecognitionPerChannel` is set to `true`. Learn more in the [Channel Metadata](#channel-metadata) section below.
```trackers``` <font color="orange"> BETA</font> | No | List | A `tracker` entity containing `name` and `vocabulary` (a list of key words and/or phrases to be tracked). Read more in the [Tracker API](/docs/management-api/trackers/overview) section.
```enableAllTrackers```<font color="orange"> BETA </font> | Optional | Boolean | Default value is `false`. Setting this parameter to `true` will enable detection of all the Trackers maintained for your account by the Management API.This will allow Symbl to detect all the available Trackers in a specific Conversation. Learn about this parameter [here](/docs/management-api/trackers/overview#step-2-submit-files-using-async-api-with-enablealltrackers-flag).
```enableSummary```<font color="blue"> ALPHA </font> | Optional | Boolean | Setting this parameter to `true` allows you to generate Summaries using [Summary API](/conversation-api/summary). Ensure that you use `https://api.symbl.ai/` as the base URL.
```enableSpeakerDiarization``` | Optional | Boolean | Whether the diarization should be enabled for this conversation. Pass this as `true` to enable Speaker Separation. To learn more, refer to the [Speaker Separation](#speaker-separation) section below.
```diarizationSpeakerCount``` | Optional | String | The number of unique speakers in this conversation. To learn more, refer to the [Speaker Separation](#speaker-separation) section below.
Parameter | Description
---------- | ------- |
```url``` | String, mandatory <br/><br/> A valid url string. The URL must be a publicly accessible url. <br/><br/> Exampple: `"url": "https://symbltestdata.s3.us-east-2.amazonaws.com/sample_audio_file.wav"`
```customVocabulary``` | String, optional <br/><br/> Contains a list of words and phrases that provide hints to the speech recognition task. <br/><br/> Exampple: `"customVocabulary": "Platform", "Discussion"`
```confidenceThreshold``` | Double, optional <br/><br/> Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range <=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`. <br/><br/> Example: `"confidenceThreshold": 0.6`
```detectPhrases```| Boolean, optional <br/><br/> It shows Actionable Phrases in each sentence of conversation. These sentences can be found using the Conversation's Messages API. Default value is `false`. <br/><br/> Example: `"detectPhrases": true`
```name``` | String, optional <br/><br/> Your meeting name. Default name set to `conversationId`. <br/><br/> Example: `name: "Sales call"`, `name: "Customer call"`.
```webhookUrl``` | String, optional <br/><br/> Webhook URL on which job updates to be sent. This should be after making the API request. See the [Webhook section](/docs/async-api/overview/text/post-text#webhookurl) for more. <br/><br/> Example: `"""jobId"": ""9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"", ""status"": ""in_progress"""`
```entities``` | Object, optional <br/><br/> Input custom entities which can be detected in conversation using [Entities API](/docs/conversation-api/entities). <br/><br/> Example: `"entities": "customType": "Company Executives", "value": "Marketing director", "text": "Marketing director"`
```detectEntities``` | Boolean, optional <br/><br/> Default value is `false`. If not set the [Entities API](/docs/conversation-api/entities) will not return any entities from the conversation. <br/><br/> Example: `"detectEntities": true`
```languageCode```| String, optional <br/><br/> We accept different languages. Please [check language Code](/docs/async-api/overview/async-api-supported-languages) as per your requirement. <br/><br/> Example: `"languageCode": "en-US"`
``` mode``` | String, optional <br/><br/> Accepts `phone` or `default`. `phone` mode is best for audio that is generated from phone call(which is typically recorded at 8khz sampling rate).<br />`default` mode works best for audio generated from video or online meetings(which is typically recorded at 16khz or more sampling rate).<br />When you don't pass this parameter `default` is selected automatically. <br/><br/> Example: `"mode": "phone"`
```enableSeparateRecognitionPerChannel``` | Boolean, optional <br/><br/> Enables Speaker Separated Channel audio processing. Accepts `true` or `false`. <br/><br/> Example: `"enableSeparateRecognitionPerChannel": true`
```channelMetadata``` | Object, optional <br/><br/> This object parameter contains two variables `speaker` and `channel` to specific which speaker corresponds to which channel. This object **only** works when `enableSeparateRecognitionPerChannel` is set to `true`. Learn more in the [Channel Metadata](#channel-metadata) section below. <br/><br/> Example: `"channelMetadata": "channel": 1, "speaker": "name": "Robert Bartheon", "email": "[email protected]"`
```trackers```<font color="orange"> BETA </font> | List, optional <br/><br/> A `tracker` entity containing `name` and `vocabulary` (a list of key words and/or phrases to be tracked). Read more in the [Tracker API](/docs/management-api/trackers/overview) section. <br/><br/> Example: `"trackers": "name": "Promotion Mention", "vocabulary": "We have a special promotion going on if you book this before"`
```enableAllTrackers```<font color="orange"> BETA </font> | Boolean, optional <br/><br/> Default value is `false`. Setting this parameter to `true` will enable detection of all the Trackers maintained for your account by the Management API. This will allow Symbl to detect all the available Trackers in a specific Conversation. Learn about this parameter [here](/docs/management-api/trackers/overview#step-2-submit-files-using-async-api-with-enablealltrackers-flag). <br/><br/> Example: `"enableAllTrackers": true`
```enableSummary```<font color="blue"> ALPHA </font> | Boolean, optional <br/><br/> Setting this parameter to `true` allows you to generate Summaries using [Summary API](/conversation-api/summary). Ensure that you use `https://api.symbl.ai/` as the base URL. <br/><br/> Example: `"enableSummary": true`
```enableSpeakerDiarization``` | Boolean, optional <br/><br/> Whether the diarization should be enabled for this conversation. Pass this as `true` to enable Speaker Separation. To learn more, refer to the [Speaker Separation](#speaker-separation) section below. <br/><br/> Example: ` "enableSeparateRecognitionPerChannel": true`
```diarizationSpeakerCount``` | Integer, optional <br/><br/> The number of unique speakers in this conversation. To learn more, refer to the [Speaker Separation](#speaker-separation) section below. <br/><br/> Example: `diarizationSpeakerCount=$NUMBER_OF_UNIQUE_SPEAKERS"`

#### Channel Metadata

Expand Down Expand Up @@ -346,17 +346,17 @@ Given below is an example of a `channelMetadata` object:

`channelMetadata` object has following members:

Field | Required | Type | Description
| ------- | ------- | ------- | --------
```channel``` | Yes | Integer | This denotes the channel number in the audio file. Each channel will contain independent speaker's voice data.
```speaker``` | Yes | String | This is the wrapper object which defines the speaker for this channel.
Field | Description
| ------- | -------
```channel``` | Integer, mandatory <br/><br/> This denotes the channel number in the audio file. Each channel will contain independent speaker's voice data. <br/><br/> Example: `"channel": 1`
```speaker``` | String, mandatory <br/><br/> This is the wrapper object which defines the speaker for this channel. <br/><br/> Example: `"speaker": "name": "Robert Bartheon", "email": "[email protected]"`

`speaker` has the following members:

Field | Required | Type | Description
| ------- | ------- | ------- | ------
```name``` | No | String | Name of the speaker.
```email``` | No | String | Email address of the speaker.
Field | Description
| ------- | -------
```name``` | String, optional <br/><br/> Name of the speaker. <br/><br/> Example: `"name": "Robert Bartheon"`
```email``` | String, optional <br/><br/> Email address of the speaker. <br/><br/> Example: `"email": "[email protected]"`

### Response

Expand All @@ -369,9 +369,9 @@ Field | Required | Type | Description

Field | Description
---------- | ------- |
`conversationId` | ID to be used with [Conversation API](/docs/conversation-api/introduction).
`jobId` | ID to be used with Job API.

`conversationId` | ID to be used with [Conversation API](/docs/conversation-api/introduction). <br/><br/> Example: `"conversationId": "5815170693595136"`
`jobId` | ID to be used with Job API. <br/><br/> Example: `"jobId": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"`
### Speaker Separation
---

Expand Down Expand Up @@ -413,8 +413,8 @@ The `webhookUrl` will be used to send the status of job created for uploaded aud

Field | Description
| ------- | -------
```jobId``` | ID to be used with [Job API](/docs/async-api/overview/jobs-api).
```status``` | Current status of the job. (Valid statuses: [ `scheduled`, `in_progress`, `completed`, `failed` ])
```jobId``` | ID to be used with [Job API](/docs/async-api/overview/jobs-api). <br/><br/> Example: `"jobId": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"`
```status``` | Current status of the job. (Valid statuses: [ `scheduled`, `in_progress`, `completed`, `failed` ]) <br/><br/> Example: `"status": "in_progress"`

### API Limit Error
---
Expand Down
Loading

0 comments on commit aea9079

Please sign in to comment.