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

Fixes typos in Web SDK documentation. #489

Merged
merged 1 commit into from
Apr 18, 2022
Merged

Fixes typos in Web SDK documentation. #489

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 8 additions & 7 deletions docs/web-sdk/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ npm i @symblai/symbl-web-sdk

### CDN

You can also import the file into your HTML appliaction using our CDN.\
You can also import the file into your HTML appliaction using our CDN.

#### Versioned CDN

Expand Down Expand Up @@ -178,7 +178,7 @@ try {
await connection.stopProcessing();

// Closes the WebSocket connection.
connection.disconect();
connection.disconnect();
} catch(e) {
// Handle errors here.
}
Expand Down Expand Up @@ -217,7 +217,7 @@ try {
await symbl.wait(60000);;

// Closes the WebSocket connection.
connection.disconect();
connection.disconnect();
} catch(e) {
// Handle errors here.
}
Expand Down Expand Up @@ -277,7 +277,7 @@ try {
await connection.stopProcessing();

// Closes the WebSocket connection.
connection.disconect();
connection.disconnect();
} catch(e) {
// Handle errors here.
}
Expand Down Expand Up @@ -344,7 +344,7 @@ try {
await connection.stopProcessing();

// Closes the WebSocket connection.
connection.disconect();
connection.disconnect();
} catch(e) {
// Handle errors here.
}
Expand Down Expand Up @@ -388,7 +388,7 @@ You can pass any of the following connection configuration parameters:

Field | Required | Supported Value | Description
---------- | ------- | ------- | -------
```id``` | Optional* | Should match this regex: `/^[\da-z]{64,128}$/i` | The ID for the current session. *If not provided, a UUID will be generated for you.
```id``` | Optional* | Should match this regex: `/^[a-zA-Z0-9-]{6,64}$/` | The ID for the current session. *If not provided, a UUID will be generated for you.
```insightTypes``` | Optional | action_item, question | Types of insights to return. If not provided, no insights will be returned.
```customVocabulary``` | Optional | List of String | An array of strings containing vocabulary specific to your company, products, or phrases.
```config``` | Optional | Find the supported value [here](#config) | Configuration for this request. [See the config section below for more details](#config).
Expand Down Expand Up @@ -531,7 +531,7 @@ Field | Required | Supported Value

## Events / Callbacks

Both the conection and audio stream objects have an [`on`](#startprocessingoptions-streamingapiconnectionconfig) method which can be used to subscribe to events and perform callbacks.
Both the connection and audio stream objects have an [`on`](#startprocessingoptions-streamingapiconnectionconfig) method which can be used to subscribe to events and perform callbacks.

### Connection Events

Expand Down Expand Up @@ -1417,3 +1417,4 @@ In this version of the Web SDK, a few Known Issues have been observed. You can s
- [Getting Live Transcripts and Conversation Intelligence](/docs/web-sdk/web-sdk-getting-live-transcripts/)
- [Sending external Audio Streams](/docs/web-sdk/web-sdk-sending-external-audio-streams/)
- [Updating Audio Source Mid-Stream](/docs/web-sdk/web-sdk-updating-audio-streams/)