From 975e9ecce61f6950a4511142b59785f25d4f5c24 Mon Sep 17 00:00:00 2001 From: amritesh-singh <88492460+amritesh-singh@users.noreply.github.com> Date: Fri, 29 Apr 2022 14:29:39 +0530 Subject: [PATCH] DC-65 --- .../tutorials/push-audio-get-realtime-data.md | 10 +++++++++- docs/streamingapi/code-snippets/receive-live-topics.md | 9 +++++++++ .../tutorials/get-realtime-transcription.md | 9 ++++++++- .../tutorials/connect-to-zoom-with-telephony-api.md | 9 +++++++++ 4 files changed, 35 insertions(+), 2 deletions(-) diff --git a/docs/javascript-sdk/tutorials/push-audio-get-realtime-data.md b/docs/javascript-sdk/tutorials/push-audio-get-realtime-data.md index 9ae7ce20..207e8abb 100644 --- a/docs/javascript-sdk/tutorials/push-audio-get-realtime-data.md +++ b/docs/javascript-sdk/tutorials/push-audio-get-realtime-data.md @@ -40,6 +40,7 @@ In this guide you will learn the following: * [Test](#test) * [Grabbing the Conversation ID](#grabbing-the-conversation-id) * [Full Code Sample](#full-code-sample) +* [Query Params](#query-params) ## Getting started @@ -70,7 +71,6 @@ const micInstance = mic({ ## Initialize SDK - You can get the `appId` and `appSecret` values from the [Symbl Platform](https://platform.symbl.ai). ```javascript @@ -707,3 +707,11 @@ const micInstance = mic({ } })(); ``` +### Query Params + +Following are the optional query parameters that you can pass in this API: + +Parameter | Required | Value |Description | +--------- | --------- | ------- | ------- +```verbose``` | Optional | true | Gives you word level timestamps and score of each sentence. +```sentiment```| Optional | true | Give you [Sentiment Analysis](/docs/concepts/sentiment-analysis) on each message. \ No newline at end of file diff --git a/docs/streamingapi/code-snippets/receive-live-topics.md b/docs/streamingapi/code-snippets/receive-live-topics.md index 4f65f623..a18cfe74 100644 --- a/docs/streamingapi/code-snippets/receive-live-topics.md +++ b/docs/streamingapi/code-snippets/receive-live-topics.md @@ -236,6 +236,15 @@ If successful you should receive a response in the console. +### Query Params + +Following are the optional query parameters that you can pass in this API: + +Parameter | Required | Value |Description | +--------- | --------- | ------- | ------- +```verbose``` | Optional | true | Gives you word level timestamps and score of each sentence. +```sentiment```| Optional | true | Give you [Sentiment Analysis](/docs/concepts/sentiment-analysis) on each message. + ### Handlers Reference * `handlers`: This object has the callback functions for different events diff --git a/docs/streamingapi/tutorials/get-realtime-transcription.md b/docs/streamingapi/tutorials/get-realtime-transcription.md index e524c7aa..73cec932 100644 --- a/docs/streamingapi/tutorials/get-realtime-transcription.md +++ b/docs/streamingapi/tutorials/get-realtime-transcription.md @@ -34,7 +34,7 @@ In this guide you will learn the following: * [Test](#test) * [Grabbing the Conversation ID](#grabbing-the-conversation-id) * [Full Code Sample](#full-code-sample) - +* [Query Params](#query-params) ## Getting Started @@ -376,4 +376,11 @@ handleSuccess(stream); If you properly implemented the code, the code runs in the browser without anything else. +### Query Params + +Following are the optional query parameters that you can pass in this API: +Parameter | Required | Value |Description | +--------- | --------- | ------- | ------- +```verbose``` | Optional | true | Gives you word level timestamps and score of each sentence. +```sentiment```| Optional | true | Give you [Sentiment Analysis](/docs/concepts/sentiment-analysis) on each message. diff --git a/docs/telephony/tutorials/connect-to-zoom-with-telephony-api.md b/docs/telephony/tutorials/connect-to-zoom-with-telephony-api.md index 86aa51be..46e956e0 100644 --- a/docs/telephony/tutorials/connect-to-zoom-with-telephony-api.md +++ b/docs/telephony/tutorials/connect-to-zoom-with-telephony-api.md @@ -30,6 +30,7 @@ You must make sure your Zoom call allows phone dial-in for this example to work * [Grabbing the Conversation ID](#grabbing-the-conversation-id) * [Full Code Sample](#full-code-sample) * [Test](#test) +* [Query Params](#query-params) * [Conclusion](#conclusion) @@ -275,6 +276,14 @@ Run your code: ```bash $ node index.js ``` +### Query Params + +Following are the optional query parameters that you can pass in this API: + +Parameter | Required | Value |Description | +--------- | --------- | ------- | ------- +```verbose``` | Optional | true | Gives you word level timestamps and score of each sentence. +```sentiment```| Optional | true | Give you [Sentiment Analysis](/docs/concepts/sentiment-analysis) on each message. ## Conclusion