From a85d98cab5f895bf0a6d465d09e9cdadfb9c8b1f Mon Sep 17 00:00:00 2001 From: pema-s <81958801+pema-s@users.noreply.github.com> Date: Wed, 23 Mar 2022 20:51:14 +0530 Subject: [PATCH] Adds authentication info --- docs/api-reference/get-abstract-topics.md | 3 + docs/changelog.md | 4 ++ .../api-reference/action-items.md | 20 +++---- .../api-reference/all-conversations.md | 15 +++-- .../api-reference/analytics.md | 11 ++-- .../comprehensive-action-items.md | 7 +-- .../api-reference/conversation.md | 9 +-- docs/conversation-api/api-reference/delete.md | 10 ++-- .../api-reference/entities.md | 7 +-- .../api-reference/follow-ups.md | 7 +-- .../api-reference/insights.md | 8 +-- .../conversation-api/api-reference/members.md | 8 +-- .../api-reference/messages.md | 21 +++---- .../api-reference/put-all-conversation.md | 9 ++- .../api-reference/questions.md | 8 +-- .../api-reference/speakers.md | 7 +-- .../conversation-api/api-reference/summary.md | 4 ++ docs/conversation-api/api-reference/topics.md | 9 +-- .../api-reference/trackers.md | 10 ++-- .../api-reference/transcript.md | 7 +-- .../api-reference/update-members.md | 9 ++- docs/labs/abstract-topics-labs.md | 41 ++++++++++++++ docs/management-api/trackers/overview.md | 5 +- docs/streamingapi/reference/reference.md | 55 ++++++++++--------- sidebars.js | 11 +++- 25 files changed, 171 insertions(+), 134 deletions(-) create mode 100644 docs/labs/abstract-topics-labs.md diff --git a/docs/api-reference/get-abstract-topics.md b/docs/api-reference/get-abstract-topics.md index ac0bd9fb..e8b43299 100644 --- a/docs/api-reference/get-abstract-topics.md +++ b/docs/api-reference/get-abstract-topics.md @@ -28,6 +28,9 @@ The Abstract Topics are suitable for scenarios where you want to determine recur Currently, Abstract Topics are not supported in real-time. ::: +### Authentication + +Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page. ### HTTP Request diff --git a/docs/changelog.md b/docs/changelog.md index e39bb789..1ddf164a 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -11,6 +11,10 @@ import TabItem from '@theme/TabItem'; We continuously add new features and enhancements, fix critical bugs, and regularly deploy changes to improve performance. Keep a tab of our latest updates on this page. +### 14 March 2022 + +![api update](/img/api-update.png) +- **Enabling All Trackers with Streaming API**: Streaming API now supports enabling all the Trackers associated with an account. [Read more here](/docs/streaming-api/api-reference/#using-trackers).
### 8 Feb 2022 diff --git a/docs/conversation-api/api-reference/action-items.md b/docs/conversation-api/api-reference/action-items.md index 515e0e1a..2fee0128 100644 --- a/docs/conversation-api/api-reference/action-items.md +++ b/docs/conversation-api/api-reference/action-items.md @@ -11,14 +11,13 @@ import TabItem from '@theme/TabItem'; This API returns a list of all the action items generated from the conversation. -An action item is a specific outcome recognized in the conversation that requires one or more people in the conversation to act in the future. - -These actions can be definitive in nature and owned with a commitment to working on a presentation, sharing a file, completing a task, etc. -Or they can be non-definitive like an idea, suggestion or an opinion that could be worked upon. +An action item is a specific outcome recognized in the conversation that requires one or more people in the conversation to act in the future. These actions can be definitive in nature and owned with a commitment to working on a task such as creating the presentation, sharing a file, completing a task, etc. Or they can be non-definitive like an idea, suggestion or an opinion that could be worked upon. All action items are generated with action phrases, assignees and due dates so that you can build workflow automation with your own tools. +### Authentication +Before using the Conversation API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page. ### HTTP Request @@ -27,11 +26,6 @@ All action items are generated with action phrases, assignees and due dates so t ### Example API Call -:::info -Before using the Conversation API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication). -::: - - Value accepted is between `0` to `65536` | -`offset` | Integer (int16) | Specifies a non-negative number of items to skip before applying `limit`. | Optional | 0 | +`limit` | Integer (int16) | Specifies a non-negative integer `count`, to indicate that no more than `count` items in the result will be returned. `limit` set to `0` returns 0 items in the result. | Optional | 20.
Value accepted is between `0` to `65536`. | +`offset` | Integer (int16) | Specifies a non-negative number of items to skip before applying the `limit`. | Optional | 0 | `order` | String / enum | Specifies the order in which the results should be sorted. The `order` is applied on the `startTime` field of the associated Conversation entity. | Optional | `asc`. Values accepted are `asc` and `desc`. `startTime` | String / [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date format | Specifies the start of the datetime range for the results to be returned. This `startTime` is associated with the `startTime` field of the associated Conversation entity. If `startTime` is not mentioned, then `startTime` is calculated as - `startTime = endTime - duration('7 days')`.| Optional | `startTime = endTime - duration('7 days')`. Values accepted are [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) formatted strings with value less than current timestamp and less than `endTime`. | `endTime` | String / [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date format | Specifies the end of the date time range for the results to be returned. This `endTime` is associated with the `endTime` field of the associated Conversation entity. If `endTime` is not mentioned, then the current timestamp is considered as `endTime` automatically. | Optional | `endTime = currentDatetime()`. Values accepted are [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) formatted strings with value less than current timestamp and greater than `startTime`.| diff --git a/docs/conversation-api/api-reference/analytics.md b/docs/conversation-api/api-reference/analytics.md index 6bdc8956..2fbf00e8 100644 --- a/docs/conversation-api/api-reference/analytics.md +++ b/docs/conversation-api/api-reference/analytics.md @@ -34,16 +34,13 @@ For each conversation it returns: 4. Pace - Words per minute spoken in the conversation. 5. Overlap - When more than 1 speaker are speaking the same time, then conversation has overlap. -### HTTP Request - -`GET https://api.symbl.ai/v1/conversations/{conversationId}/analytics` +### Authentication -### Example API Call +Before using the Conversation API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page. -:::info -Before using the Conversation API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication). -::: +### HTTP Request +`GET https://api.symbl.ai/v1/conversations/{conversationId}/analytics` BETA -#### Sentiment Analysis in messages BETA +You can enable sentiment analysis over each message being spoken in the conversation. To do this, pass the query parameter `sentiment=true`. Read more about Sentiment Analysis [here](/docs/concepts/sentiment-analysis). +::: -You can enable sentiment analysis over each message being spoken in the conversation. +### Authentication -To do this, pass the query parameter `sentiment=true`. Read more about Sentiment Analysis [here](/docs/concepts/sentiment-analysis). +Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page. ### HTTP Request @@ -26,10 +27,6 @@ To do this, pass the query parameter `sentiment=true`. Read more about Sentiment ### Example API Call -:::info -Before using the Conversation API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication). -::: - `duration= endTime (of current sentence/ word) - startTime (of current sentence/ word)`.
This variable is currently in Labs. ```conversationId``` | Unique conversation identifier. Read more about the Conversation ID [here](/docs/api-reference/getting-conversation-intelligence#what-is-a-conversation-id). | ```words``` | Words object with properties `word`, `startTime`, `endTime` and `score`. The `score` is the word level confidence score that represents the confidence level of individual words within the transcript. The `score` shows the relevancy of the word in the transcript. Higher the word-level confidence score, the more relevant it is to the transcript message. When you pass `verbose=true`, the word-level confidence score is by default returned.
Note that a processed `text` conversation will not return any confidence score since it is already in the transcript form. `words` also return the `timeOffset` and `duration` variables. The word level confidence score is currently in Labs. | -```phrases``` | It shows the most important action phrases in each sentence. It's enabled when you pass `detectPhrases=true` during submiting the request in Async and Websocket API.| -```sentiment```| Shows the sentiment polarity(intensity of negativity or positivity of a sentence) and suggested sentiment type (positive, negative and neutral). | \ No newline at end of file +```phrases``` | It shows the most important action phrases in each sentence. It is enabled when you pass `detectPhrases=true` while submiting the request in Async and Websocket API.| +```sentiment```| Shows the sentiment polarity (intensity of negativity or positivity of a sentence) and suggested sentiment type (positive, negative and neutral). | \ No newline at end of file diff --git a/docs/conversation-api/api-reference/put-all-conversation.md b/docs/conversation-api/api-reference/put-all-conversation.md index ba53d349..35b5016c 100644 --- a/docs/conversation-api/api-reference/put-all-conversation.md +++ b/docs/conversation-api/api-reference/put-all-conversation.md @@ -11,17 +11,16 @@ import TabItem from '@theme/TabItem'; This API updates an existing Conversation object with any metadata you would like to maintain. +### Authentication + +Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page. + ### API Request `PUT https://api.symbl.ai/v1/conversations/{conversationId}` ### Example API Call -:::info -Before using the Conversation API, you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication). -::: - - GET `https://api.symbl.ai/v1/conversations/{conversationId}/summary`** diff --git a/docs/conversation-api/api-reference/topics.md b/docs/conversation-api/api-reference/topics.md index f14bf171..ca85bf86 100644 --- a/docs/conversation-api/api-reference/topics.md +++ b/docs/conversation-api/api-reference/topics.md @@ -41,6 +41,11 @@ You can enable custom vocabulary in Topics API by passing the query parameter `c :::note Backward Compatibility We recommend you to use the parameter `customTopicVocabulary` instead of `customVocabulary` with the Topics API as we are standardizing our API nomenclature. ::: + +### Authentication + +Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page. + ### HTTP Request `GET https://api.symbl.ai/v1/conversations/{conversationId}/topics` @@ -48,10 +53,6 @@ We recommend you to use the parameter `customTopicVocabulary` instead of `custom ### Example API Call -:::info -Before using the Conversation API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication). -::: -
Speaker 1: It's good to see you again.

Speaker 2: Thanks a lot.

Speaker 1: Start Let us talk about the pricing of your accounting software.

Speaker 1: How much does it cost to the customer?

Speaker 2: The software is sold as a yearly subscription the full cost to the customer is two thousand five hundred dollars per.

Speaker 1: Okay.
+### Authentication + +Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page. ### HTTP Request @@ -51,10 +54,6 @@ Speaker 1: Good morning Mr. Lewis.

Speaker 1: It's good to see you aga ### Request Body Sample -:::info -Before using the Conversation API you must get the authentication token (`AUTH_TOKEN`) from [our authentication process](/docs/developer-tools/authentication). -::: - While you can create Trackers with Async or Streaming APIs, it is recommended that you create Trackers using Management API because Trackers created with Management APIs are saved and can be reused while the same is not possible with Async or Streaming APIs. ::: -## Endpoints +## API Endpoints Operation | Endpoint ---------- | ------- @@ -32,4 +32,5 @@ Create Trackers in Bulk | [`POST` v1/manage/trackers](/management-api/trackers/c Get Tracker with ID| [`GET` v1/manage/tracker/{trackerId}](/management-api/trackers/get-tracker#get-tracker-by-id) Get Tracker with name | [`GET` v1/manage/trackers?&name={trackerName}](/management-api/trackers/get-tracker#get-tracker) Update Tracker| [`PUT`v1/manage/tracker/{trackerId}](/management-api/trackers/update-tracker) -Delete Tracker| [`DELETE`v1/manage/tracker/{trackerId}](/management-api/trackers/delete-tracker) \ No newline at end of file +Delete Tracker| [`DELETE`v1/manage/tracker/{trackerId}](/management-api/trackers/delete-tracker) + diff --git a/docs/streamingapi/reference/reference.md b/docs/streamingapi/reference/reference.md index 87e2d1b7..e5ef3083 100644 --- a/docs/streamingapi/reference/reference.md +++ b/docs/streamingapi/reference/reference.md @@ -13,12 +13,16 @@ import TabItem from '@theme/TabItem'; Symbl's Streaming API is based on the WebSocket protocol and can be used for real-time use-cases where both the audio and its results need to be available in real-time. :::info -Currently, Streaming API is supported in English only. However, the support for Spanish is available as a part of Symbl Labs. +Currently, Streaming API is supported in English only. However, the support for Spanish is available as a part of [Symbl Labs](/docs/labs/). ::: ## Request Parameters -#### Endpoint +### Authentication + +Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page. + +### Endpoint `wss://api.symbl.ai/v1/streaming/{CONVERSATION_ID}?access_token=ACCESS_TOKEN` @@ -30,14 +34,15 @@ The previous endpoint `wss://api.symbl.ai/v1/realtime/insights/` is now updated Field | Required | Supported Value | Description ---------- | ------- | ------- | ------- -```type``` | Optional | start_request, stop_request, modify_request | Type of message +```type``` | Mandatory | `start_request`, `stop_request` | Type of message. +```type``` | Optional | `modify_request` | Type of message. Allows you to modify the request. See the [Modify Request](#modify-request) section below for more details. ```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 a vocabulary specific to your company, products, or phrases. +```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). ```speaker``` | Optional | Find the supported value [here](#speaker) | Speaker identity to use for audio in this WebSocket connection. If omitted, no speaker identification will be used for processing. [See the speaker section below for more details](#speaker). -```noConnectionTimeout``` | Optional | Between `0` to `1800` seconds | The buffer time (in seconds) during which the WebSocket API connection stays open even if there’s no Streaming API connection active for that duration. This allows the Speaker to reconnect to the same meeting with the same Subscribers if they lost the connection previously.

For example, when this parameter is set to `noConnectionTimeout = 600 secs` and if there is no graceful termination using `stop_request` message sent explicitly when there just one WebSocket connection, the `connectionId` and `conversationId` are kept valid for 600 seconds before finalizing the connection, after which connectionId will be not available to subscribe and `conversationId` will have all the last know information associated with it. -```disconnectOnStopRequest``` | Optional | `true` or `false` | This parameter allows you to set your Streaming API connection in such a way that even when the `stop_request` is sent. The connection does not drop-off, only the processing is stopped and the `conversationId` and connection is kept live for `1800` seconds by default. You can always override this value by passing the `disconnectOnStopRequest` parameter.

This allows you to stop and start the Streaming API processing without dropping the WebSocket connection, so that you can stop and resume the processing in the middle of a call and optimize the Streaming API usage costs.

The default value is `true`. | -```disconnectOnStopRequestTimeout``` | Optional | Between `0` to `3600` seconds | This parameter allows you to override the idle time out (if a WebSocket connection is idle for 30 minutes). Set this parameter with a value between `0` to `3600` seconds. If the idle connection needs to be kept alive beyond `3600` seconds, you have to restart the connection at `3600` seconds elapsed.

If the value is passed as `0`, the WebSocket connection is dropped when `stop_request` is received. The default value is `1800`. +```noConnectionTimeout``` | Optional | Between `0` to `1800` seconds. | The buffer time (in seconds) during which the WebSocket API connection stays open even if there’s no Streaming API connection active for that duration. This allows the Speaker to reconnect to the same meeting with the same Subscribers if they lost the connection previously.

For example, when this parameter is set to `noConnectionTimeout = 600 secs` and if there is no graceful termination using `stop_request` message sent explicitly when there just one WebSocket connection, the `connectionId` and `conversationId` are kept valid for 600 seconds before finalizing the connection, after which `connectionId` will be not available to subscribe and `conversationId` will have all the last know information associated with it. +```disconnectOnStopRequest``` | Optional | `true` or `false` | This parameter allows you to set your Streaming API connection in such a way that even when the `stop_request` is sent, the connection does not drop-off. Only the processing is stopped and the `conversationId` and connection is kept live for `1800` seconds by default. You can always override this value by passing the `disconnectOnStopRequest` parameter.

This allows you to stop and start the Streaming API processing without dropping the WebSocket connection, so that you can stop and resume the processing in the middle of a call and optimize the Streaming API usage costs.

The default value is `true`. | +```disconnectOnStopRequestTimeout``` | Optional | Between `0` to `3600` seconds. | This parameter allows you to override the idle time out (if a WebSocket connection is idle for 30 minutes). Set this parameter with a value between `0` to `3600` seconds. If the idle connection needs to be kept alive beyond `3600` seconds, you have to restart the connection at `3600` seconds elapsed.

If the value is passed as `0`, the WebSocket connection is dropped when `stop_request` is received. The default value is `1800`. ##### Code Example @@ -96,8 +101,8 @@ Field | Required | Supported value | Default Value | Description Field | Required | Supported Value ---------- | ------- | ------- -```userId``` | false | Any user identifier for the user. -```name``` | false | Display name of the user. +```userId``` | Optional | Any user identifier for the user. +```name``` | Optional | Display name of the user. ##### Code Example @@ -135,7 +140,7 @@ Field | Required | Supported Value ## Connection Establishment -This is a WebSocket endpoint, and it starts as an HTTP request that contains HTTP headers that indicate the client's desire to upgrade the connection to a WebSocket instead of using HTTP semantics. The server indicates its willingness to participate in the WebSocket connection by returning an HTTP 101 Switching Protocols response. After the exchange of this handshake, both client and service keep the socket open and begin using a message-based protocol to send and receive information. +This is a WebSocket endpoint, and it starts as an HTTP request that contains HTTP headers that indicate the client's desire to upgrade the connection to a WebSocket instead of using HTTP semantics. The server indicates its willingness to participate in the WebSocket connection by returning an HTTP 101 Switching Protocols response. After the exchange of this handshake, both client and server keep the socket open and begin using a message-based protocol to send and receive information. Please refer to [WebSocket Specification RFC 6455](https://tools.ietf.org/html/rfc6455) for a more in-depth understanding of the Handshake process. @@ -161,7 +166,7 @@ Please refer to [WebSocket Specification RFC 6455](https://tools.ietf.org/html/r This is a request to start the processing after the connection is established. Right after this message has been sent, the audio should be streamed, any binary audio streamed before the receipt of this message will be ignored. -To get direct access to the mic, we're going to use an API in the WebRTC specification called `getUserMedia()`. +To get direct access to the mic, we are going to use an API in the WebRTC specification called `getUserMedia()`. Once the code is running, start speaking and you should see the `message_response` and `insight_response` messages getting printed on the console. @@ -223,7 +228,7 @@ setTimeout(() => { ### Modify Request​ The `modify_request` allows you to modify the request during Streaming API call, i.e., after the WebSocket connection has established, if there is a device change event. -Using the `type` field with the supported value `modify_request` you can update the sample rate and encoding based on the new device information in the same conversation itself. +Using the `type` field with the supported value `modify_request`, you can update the sample rate and encoding based on the new device information in the same conversation itself. ```js setTimeout(() => { @@ -249,10 +254,10 @@ Using the `type` field with the supported value `modify_request` you can update ## Messages ### Message Formats -Client and Server both can send messages after the connection is established. According to RFC 6455, WebSocket messages can have either text or a binary encoding. The two encodings use different on-the-wire formats. Each format is optimized for efficient encoding, transmission, and decoding of the message payload. +Client and server can both send messages after the connection is established. According to RFC 6455, WebSocket messages can have either text or a binary encoding. The two encodings use different on-the-wire formats. Each format is optimized for efficient encoding, transmission, and decoding of the message payload. #### Text Message -Text messages over WebSocket must use UTF-8 encoding. Text Message is the serialized JSON message. Every text message has a type field to specify the type or the purpose of the message. +Text messages over WebSocket must use UTF-8 encoding. Text message is the serialized JSON message. Every text message has a type field to specify the type or the purpose of the message. #### Binary Message Binary WebSocket messages carry a binary payload. For the Real-time API, audio is transmitted to the service by using binary messages. All other messages are the Text messages. @@ -271,11 +276,9 @@ This section describes the messages that originate in Service and are sent to th Service sends mainly two types of messages (`message_response`, `insight_response`) to the client as soon as they're available. ### Message Response -The `message_response` contains the processed messages as soon as they're ready and available, in the processing of the continuous audio stream. This message does not contain any insights. - - +The `message_response` contains the processed messages as soon as they are ready and available, in the processing of the continuous audio stream. This message does not contain any insights. -Example of the `message_response` object +Example of the `message_response` object: ```js @@ -354,9 +357,9 @@ Example of the `insight_response` object This feature is in the Beta phase. If you have any questions, ideas or suggestions please reach out to us at devrelations@symbl.ai. ::: -Symbl provides a real-time Streaming API for processing audio content in real time. You can also capture Trackers for a conversation in real time. For more details on Trackers, refer to the documentation [here](/docs/concepts/trackers). +Symbl provides a real-time Streaming API for processing audio content in real-time. You can also capture Trackers for a conversation in real-time. For more details on Trackers, refer to the [Trackers](/docs/concepts/trackers) documentation. -Below is an example that shows how to pass Trackers in the config object for the `startRealtimeRequest` of the Symbl’s JS SDK. This example also shows how to consume the results of the detected Trackers in real-time. +Below is an example that shows how to pass Trackers in the `config` object for the `startRealtimeRequest` of the Symbl’s JavaScript SDK. This example also shows how to consume the results of the detected Trackers in real-time. Below is the code snippet: @@ -430,7 +433,7 @@ Let’s go over all the parameters passed in the configuration object in the abo 3. `trackers`: The **Trackers** to be detected in real-time for that conversation. -4. `config`: The config object encapsulates the metadata for the WebSocket API’s session. +4. `config`: The `config` object encapsulates the metadata for the WebSocket API session. a. `meetingTitle`: The title for this conversation or meeting. @@ -454,7 +457,7 @@ Let’s go over all the parameters passed in the configuration object in the abo ### Tracker Response -The following reponse is returned when Tracker object is passed in the Streaming API: +The following response is returned when Tracker object is passed in the Streaming API: ```js "trackers":[ @@ -481,19 +484,19 @@ The following reponse is returned when Tracker object is passed in the Streaming Field Name | Description ---------- | ------- | -`name` | The name of the Tracker detected | +`name` | The name of the Tracker detected. | `matches` | Array of match objects which contain the references to messages and insights detected in that conversation. | -`type` | The match type for the text. In the above example, the match is of type vocabulary. | +`type` | The match type for the text. In the above example, the match is of type `vocabulary`. | `value` | The textual value of the vocabulary for which this match was detected. | `messageRefs` | Array of messages for which this Tracker was detected. | `messageRefs.id`| The unique identifier of the message. | `messageRefs.text` | The text body of the message. | -`messageRefs.offset`| The closest match of the text in the message. Offset of -1 means that an exact match for that specific vocabulary wasn’t found and this was the similar match. An offset greater than 0 indicates an exact match for the tracker in the payload of the message. +`messageRefs.offset`| The closest match of the text in the message. Offset of -1 means that an exact match for that specific vocabulary wasn’t found and this was the similar match. An offset value greater than 0 indicates an exact match for the tracker in the payload of the message. ### Streaming API Logs -You can view the logs of your Streaming API request on your Symbl Platform account. To view the logs, sign in to [Symbl Platform](https://platform.symbl.ai/#/login). The logs provide the following: +You can view the logs of your Streaming API request on your Symbl Platform account. To view the logs, sign in to [Symbl Platform](https://platform.symbl.ai/#/login). The logs provide the following details: - Connection ID diff --git a/sidebars.js b/sidebars.js index 8cf69ee6..2fcd42ab 100644 --- a/sidebars.js +++ b/sidebars.js @@ -676,7 +676,6 @@ LabsSidebar: [{ type: 'category', collapsed: true, items: [ - 'conversation-api/concepts/comprehensive-action-items', 'conversation-api/api-reference/comprehensive-action-items', ], }, @@ -693,7 +692,7 @@ LabsSidebar: [{ type: 'category', collapsed: true, items: [ - 'guides/abstract-topics', + 'labs/abstract-topics-labs', ], }, @@ -720,6 +719,14 @@ ChangelogSidebar: [{ id: "changelog", type: "doc", }, +{ + type: 'doc', + id: 'changelog', + customProps: { + hash: '#14-march-2022', + label: '14 March 2022', + } +}, { type: 'doc', id: 'changelog',