Skip to content

Commit

Permalink
DC-209 Consolidated two trackers with streaming api tutorials (#429)
Browse files Browse the repository at this point in the history
* DC-209 Consolidated two trackers with streaming api tutorials

* removed trailing white-space
  • Loading branch information
Mukulikaa authored Mar 21, 2022
1 parent 8999f24 commit f6cc933
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 1 deletion.
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
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
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

0 comments on commit f6cc933

Please sign in to comment.