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

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

Merged
merged 2 commits into from
Mar 21, 2022
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e70ac97
DC-209 Consolidated two trackers with streaming api tutorials
Mukulikaa Mar 3, 2022
bc130aa
removed trailing white-space
Mukulikaa Mar 15, 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
8 changes: 8 additions & 0 deletions docs/streamingapi/code-snippets/consume-trackers-with-streaming-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
id: consume-trackers
title: Consume Trackers with Streaming API
sidebar_label: Consume Trackers with Streaming API
slug: /streaming-api/code-snippets/consume-trackers-with-streaming-api/
---

A more complete tutorial is available at [Detect key phrases](/docs/streamingapi/code-snippets/detect-key-phrases).
23 changes: 22 additions & 1 deletion docs/streamingapi/code-snippets/detect-key-phrases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,9 +310,30 @@ If successful you should receive a response in the console.
</TabItem>
</Tabs>


## Parameter Description

Let’s go over all the parameters passed in the configuration object in the above function:

Field | Required |
---------- | ------- |
`id` | A unique UUID that represents this WebSocket API Session.
`insightType` | The types of Insights to be detected for this Conversation.
`trackers`| The Trackers to be detected in real-time for that Conversation. Follows the same structure as described in the [Trackers section](/docs/management-api/trackers/create-tracker#sample-request-body).
`config`| The config object encapsulates the metadata for the WebSocket API’s session.
`meetingTitle`| The title for this conversation/meeting.
`confidenceThreshold` | The insights having confidence scores greater than this threshold will be the ones detected for the Conversation.
`languageCode` | The language-code in BCP-47 format.
`sampleRateHertz`| The sample-rate of the incoming audio data which is being pushed to Symbl.
`trackers: { interimResults }`| The interimResults flag tells Symbl to send the tracker results as soon as they are detected. If false, the tracker results are detected for the finalized transcription responses.
`speaker` | The details of the speaker in this Conversation
`userId`| Unique identifier to represent the User.
`name` | The name of the User.


<a name="ontrackerresponse"></a>

### Handlers Reference
## Handlers Reference

* `handlers`: This object has the callback functions for different events

Expand Down
1 change: 1 addition & 0 deletions docs/streamingapi/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Here is a list of code snippets to help you get started on your journey with the
* [Receive Live Topics](/docs/streamingapi/code-snippets/receive-live-topics)
* [Receive Live AI Insights](/docs/streamingapi/code-snippets/receive-ai-insights)
* [Receive Speech to Text for a different language in a conversation](/docs/streamingapi/code-snippets/receive-speech-to-text-for-different-languages)
* [Detect key phrases](/docs/streamingapi/code-snippets/detect-key-phrases)


### Symbl Javascript SDK
Expand Down