Adds authentication info (#448)

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
 

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). <br/>
 
 ### 8 Feb 2022
 

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).
-:::
-
-
 <Tabs
   defaultValue="cURL"
   values={[
@@ -155,8 +149,8 @@ Header Name  | Required | Description
             ],
             "from": {
                 "id": "c99e7baf-8d9c-4668-ae08-6bd3384bc642",
-                "name": "Surbhi",
-                "userId": "[email protected]"
+                "name": "Lucy",
+                "userId": "[email protected]"
             },
             "definitive": true,
             "assignee": {
@@ -172,11 +166,11 @@ Field  | Description
 ---------- | ------- |
 ```id``` | Unique conversation identifier.
 ```text``` | The text of the Action Item.
-```type``` | Response type. Default is `action_item`.
+```type``` | Response type. The default value is `action_item`.
 ```score``` | Confidence score of the action item. Value from 0 - 1.
 ```messageIds``` | Unique message identifiers of the corresponding messages.
 ```entities``` | List of detected entity objects in the insight with `type` - entity type and `text` - corresponding text.
-```definitive``` | Boolean indicating if the action-item is definitive or not.
+```definitive``` | Boolean indicating if the action item is definitive or not. Implies that the action item is conclusive and not open-ended. For e.g, ‘I will complete this task today’ is a definitive sentence.
 ```phrases``` | List of detected phrases with `type` - phrase type and `text` - corresponding text. The `action_phrase` type represents the actionable part of an insight.
 ```assignee``` | This field contains the name and email of the person assigned to the Action Item.
 

docs/conversation-api/api-reference/all-conversations.md

@@ -13,18 +13,17 @@ This API returns all conversations and allows you to add query parameters for so
 
 See the complete list of supported query parameters in the [Query Parameters](#query-parameters) section below.
 
+### 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.
+
 ### API Request
 
 `GET https://api.symbl.ai/v1/conversations`
 
 
 ### 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).
-:::
-
-
 <Tabs
   defaultValue="cURL"
   values={[
@@ -99,7 +98,7 @@ exit()
 
 ### Request
 
-Given below is an example of the request along with optional query parameters. For a complete list of query parameters and their description, see the [table](#query-parameters) below.
+Given below is an example of the request along with optional query parameters. For a complete list of query parameters and their description, see the [Query Parameters](#query-parameters) table below.
 
 ```java
 GET https://api.symbl.ai/v1/conversations
@@ -117,8 +116,8 @@ Following are the optional query parameters that you can pass in this API:
 
 | Parameter | Data Type | Description | Required | Default Value | 
 |--------|--------|---------------|-----|---|
-`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.<br/>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.<br/>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`.|

docs/conversation-api/api-reference/analytics.md

@@ -34,16 +34,13 @@ For each conversation it returns:
 4. <strong>Pace</strong> - Words per minute spoken in the conversation.
 5. <strong>Overlap</strong> - 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`
 
 <Tabs
   defaultValue="cURL"

docs/conversation-api/api-reference/comprehensive-action-items.md

@@ -22,6 +22,9 @@ For any queries or feedback, please contact us at [email protected].
 
 This API returns all the action items that are enriched with corresponding contexts.
 
+### 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
 
@@ -30,10 +33,6 @@ This API returns all the action items that are enriched with corresponding conte
 
 ### 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).
-:::
-
 
 <Tabs
   defaultValue="cURL"

docs/conversation-api/api-reference/conversation.md

@@ -13,19 +13,16 @@ This API returns the conversation meta-data like meeting name, member name and e
 
 It returns data for a specific conversation (using `conversationId`). If you wish to get all the conversations, see [GET All Conversations](/docs/conversation-api/all-conversations) page. 
 
+### 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
 
 `GET 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).
-:::
-
-
 <Tabs
   defaultValue="cURL"
   values={[

docs/conversation-api/api-reference/delete.md

@@ -14,18 +14,16 @@ This API permanently deletes conversation and all related entities such as messa
 NOTE: Once delete operation is successful, all information associated with the Conversation ID is permanently lost and cannot be recovered later.
 :::
 
+### 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
 
 `DELETE 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).
-:::
-
-
 <Tabs
   defaultValue="cURL"
   values={[

docs/conversation-api/api-reference/entities.md

@@ -23,17 +23,16 @@ In order to detect entities in conversation we have introduced new parameter for
 
 For the [Async Audio File](/docs/async-api/overview/audio/post-audio) and the [Async Video File](/docs/async-api/overview/video/post-video) endpoints, `detectEntities` is a query parameter, e.g. `https://api.symbl.ai/v1/process/audio?detectEntities=true`. For the other APIs it's passed in the JSON Request Body.
 
+### 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
 
 `GET https://api.symbl.ai/v1/conversations/{conversationId}/entities`
 
 ### 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).
-:::
-
 <Tabs
   defaultValue="cURL"
   values={[

docs/conversation-api/api-reference/follow-ups.md

@@ -16,17 +16,16 @@ This is a category of [Action Items](/docs/conversation-api/action-items) with a
 a task like sending an email or making a phone call or booking an appointment
 or setting up a meeting.
 
+### 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
 
 `GET https://api.symbl.ai/v1/conversations/{conversationId}/follow-ups`
 
 ### 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).
-:::
-
 <Tabs
   defaultValue="cURL"
   values={[

docs/conversation-api/api-reference/insights.md

@@ -12,6 +12,10 @@ import TabItem from '@theme/TabItem';
 
 Returns all the insights in a conversation including Topics, Questions and Action Items
 
+### 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
 
 `GET https://api.symbl.ai/v1/conversations/{conversationId}/insights`
@@ -30,10 +34,6 @@ Field  | Description
 
 ### 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).
-:::
-
 <Tabs
   defaultValue="cURL"
   values={[

docs/conversation-api/api-reference/members.md

@@ -16,16 +16,16 @@ For more details on identifying members by [Speaker Events or Active Talker even
 
 For more details on identifying members by [independent audio stream integration using Websocket.](/docs/streamingapi/overview/configuration)
 
+### 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
 
 `GET https://api.symbl.ai/v1/conversations/{conversationId}/members`
 
 ### 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).
-:::
-
 <Tabs
   defaultValue="cURL"
   values={[

docs/conversation-api/api-reference/messages.md

@@ -10,26 +10,23 @@ import TabItem from '@theme/TabItem';
 
 ---
 
-The Messages API returns a list of all the messages in a conversation. You can use this for getting **Speech to Text** data (also known as transcription) for video conference, meeting or a telephone call.
+The Messages API returns a list of all the messages in a conversation. You can use this for getting **Speech to Text** data (also known as transcription) for video conference, meeting or a telephone call. Here, the message refers to a continuous sentence by a speaker.
 
-Here, the message refers to a continuous sentence by a speaker.
+:::info Sentiment Analysis in messages <font color="orange"> BETA</font>
 
-#### Sentiment Analysis in messages <font color="orange"> BETA</font>
+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
 
 `GET https://api.symbl.ai/v1/conversations/{conversationId}/messages`
 
 ### 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).
-:::
-
 <Tabs
   defaultValue="cURL"
   values={[
@@ -143,7 +140,7 @@ Parameter | Required | Value |Description |
              "phrases": [
                 {
                     "type": "action_phrase",
-                    "text": "$69.99 per month",
+                    "text": "submit the documents",
                 }
              ],
              "sentiment": {
@@ -300,5 +297,5 @@ Field  | Description
 ```duration``` |  Returned as a float value measuring in seconds, upto 2 decimal points. It indicates for how long the sentence or word was spoken. It is returned at the sentence level as well as the word level.<br/> `duration= endTime (of current sentence/ word) - startTime (of current sentence/ word)`.<br/> This variable is currently in <font color="orange"> Labs</font>.
 ```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. <br/> 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 <font color="orange"> Labs</font>. |
-```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). |
+```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). |

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).
-:::
-
-
 <Tabs
   defaultValue="cURL"
   values={[

docs/conversation-api/api-reference/questions.md

@@ -12,16 +12,16 @@ import TabItem from '@theme/TabItem';
 
 This API help you find explicit question or request for information that comes up during the conversation, whether answered or not, is recognized as a question.
 
+### 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}/questions`
 
 ### 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).
-:::
-
 <Tabs
   defaultValue="cURL"
   values={[