diff --git a/docs/async-api/overview/audio/post-audio-url.md b/docs/async-api/overview/audio/post-audio-url.md index b67f8a34..f189e38f 100644 --- a/docs/async-api/overview/audio/post-audio-url.md +++ b/docs/async-api/overview/audio/post-audio-url.md @@ -302,7 +302,7 @@ Parameters | Required | Type | Description ---------- | ------- | ------- | ------- ```url``` | Mandatory | String | A valid url string. The URL must be a publicly accessible url. ```customVocabulary``` | Optional | String[] | Contains a list of words and phrases that provide hints to the speech recognition task. -```confidenceThreshold``` | Optional | Double | Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range <=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`. +```confidenceThreshold``` | Optional | Double | Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range >=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`. ```detectPhrases```| Optional | Boolean | It shows Actionable Phrases in each sentence of conversation. These sentences can be found using the Conversation's Messages API. It's a boolean value where the default value is `false`. ```name``` | Optional | String | Your meeting name. Default name set to `conversationId`. ```webhookUrl``` | Optional | String | Webhook URL on which job updates to be sent. This should be after the API call is made. For Webhook payload, refer to the [Using Webhook](#using-webhook) section below. diff --git a/docs/async-api/overview/audio/post-audio.md b/docs/async-api/overview/audio/post-audio.md index 2689dbbf..85f43718 100644 --- a/docs/async-api/overview/audio/post-audio.md +++ b/docs/async-api/overview/audio/post-audio.md @@ -211,7 +211,7 @@ Parameters | Required | Type | Description ```name``` | Optional | String | Your meeting name. Default name set to `conversationId`. ```webhookUrl``` | Optional | String | Webhook URL on which job updates to be sent. This should be after the API call is made. For Webhook payload, refer to the [Using Webhook](#using-webhook) section below. ```customVocabulary``` | Optional | String[] | Contains a list of words and phrases that provide hints to the speech recognition task. -```confidenceThreshold``` | Optional | Double | Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range <=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`. +```confidenceThreshold``` | Optional | Double | Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range >=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`. ```entities``` | Optional | Object[] | Input custom entities which can be detected in your conversation using [Entities API](/docs/conversation-api/entities). See sample request under [Custom Entity](#custom-entity) section. ```detectEntities``` | Optional | Boolean | Default value is `false`. If not set the [Entities API](/docs/conversation-api/entities) will not return any entities from the conversation. ```detectPhrases```| Optional | Boolean | Accepted values are `true` & `false`. It shows Actionable Phrases in each sentence of conversation. These sentences can be found in the Conversation's Messages API. diff --git a/docs/async-api/overview/audio/put-audio-url.md b/docs/async-api/overview/audio/put-audio-url.md index b5c1a07a..c3b88f22 100644 --- a/docs/async-api/overview/audio/put-audio-url.md +++ b/docs/async-api/overview/audio/put-audio-url.md @@ -14,8 +14,7 @@ It can be useful in any use case where you have access to multiple recorded audi :::important -If there are multiple requests are submitted for the same Conversation ID, all the requests will be processed synchronously -in order to maintain the order of the requests for the conversation. +If multiple requests are submitted for the same Conversation ID, all the requests are processed synchronously in order to maintain the order of the requests for the conversation. ::: ### Authentication @@ -316,7 +315,7 @@ Parameters | Required | Type | Description ---------- | ------- | ------- | ----- ```url``` | Mandatory | String | A valid url string. The URL must be a publicly accessible url. ```customVocabulary``` | Optional | String[] | Contains a list of words and phrases that provide hints to the speech recognition task. -```confidenceThreshold``` | Optional | Double | Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range <=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`. +```confidenceThreshold``` | Optional | Double | Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range >=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`. ```detectPhrases```| Optional | Boolean | It shows Actionable Phrases in each sentence of conversation. These sentences can be found using the Conversation's Messages API. It's a boolean value where the default value is `false`. ```name``` | Optional | String | Your meeting name. Default name set to `conversationId`. ```webhookUrl``` | Optional | String | Webhook URL on which job updates to be sent. This should be post making the API call. For Webhook payload, refer to the [Using Webhook](#using-webhook) section below. diff --git a/docs/async-api/overview/audio/put-audio.md b/docs/async-api/overview/audio/put-audio.md index cdd8e4e7..b99dbdb7 100644 --- a/docs/async-api/overview/audio/put-audio.md +++ b/docs/async-api/overview/audio/put-audio.md @@ -215,7 +215,7 @@ Parameters | Required | Type | Description ```name``` | Optional | String | Your meeting name. Default name set to `conversationId`. ```webhookUrl``` | Optional | String | Webhook url on which job updates to be sent. This should be post making the API call. For Webhook payload, refer to the [Using Webhook](#using-webhook) section below. ```customVocabulary``` | Optional | String[] | Contains a list of words and phrases that provide hints to the speech recognition task. -```confidenceThreshold``` | Optional | Double | Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range <=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`. +```confidenceThreshold``` | Optional | Double | Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range >=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`. ```detectPhrases```| Optional | Boolean | Accepted values are `true` & `false`. It shows Actionable Phrases in each sentence of conversation. These sentences can be found in the Conversation's Messages API. ```entities``` | Optional | Object[] | Input custom entities which can be detected in your conversation using [Entities API](/docs/conversation-api/entities). See sample request under [Custom Entity](#custom-entity) section below. ```detectEntities``` | Optional | Boolean | Default value is `false`. If not set the [Entities API](/docs/conversation-api/entities) will not return any entities from the conversation. diff --git a/docs/async-api/overview/text/post-text.md b/docs/async-api/overview/text/post-text.md index ede13464..e64403ab 100644 --- a/docs/async-api/overview/text/post-text.md +++ b/docs/async-api/overview/text/post-text.md @@ -299,7 +299,7 @@ Field | Required | Type | Description ---------- | ------- | ------- | ------- | ```name``` | Optional | String | Your meeting name. Default name set to `conversationId`. ```detectPhrases```| Optional | Boolean | It shows Actionable Phrases in each sentence of conversation. These sentences can be found using the Conversation's Messages API. Default value is `false`. -```confidenceThreshold``` | Optional | Double | Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range <=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`. +```confidenceThreshold``` | Optional | Double | Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range >=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`. ```entities``` | Optional | List | Input custom entities which can be detected in conversation using [Entities API](/docs/conversation-api/entities). ```detectEntities``` | Optional | Boolean | Default value is `false`. If not set the [Entities API](/docs/conversation-api/entities) will not return any entities from the conversation. ```messages``` | Mandatory | list | Input Messages to look for insights. [See the messages section below for more details.](#messages) diff --git a/docs/async-api/overview/text/put-text.md b/docs/async-api/overview/text/put-text.md index 2b89ee60..b4bf467a 100644 --- a/docs/async-api/overview/text/put-text.md +++ b/docs/async-api/overview/text/put-text.md @@ -13,7 +13,7 @@ The PUT Async Text API allows you to process any text payload to append the tran It can be useful in cases where you have new information like chats, emails or messages which keep generating for single entity. Using this API, you can add all the new entity data to the existing Conversation ID (`conversationId`). :::info -If there are multiple requests are submitted for the same Conversation ID, all the requests will be processed synchronously in order to maintain the order of the requests for the conversation. +If multiple requests are submitted for the same Conversation ID, all the requests are processed synchronously in order to maintain the order of the requests for the conversation. ::: ### Authentication @@ -218,7 +218,7 @@ payload = { "confidenceThreshold": 0.6, # - "detectPhrases": true, # + "detectPhrases": "true", # "messages": [ { "payload": { @@ -269,7 +269,7 @@ responses = { 500: 'Something went wrong! Please contact support@symbl.ai' } -response = requests.request("PUT", url, headers=headers, data=json.dumps(payload), params=json.dumps(params))) +response = requests.request("PUT", url, headers=headers, data=json.dumps(payload)) if response.status_code == 201: # Successful API execution @@ -336,7 +336,7 @@ Field | Required | Type | Description ---------- | ------- | ------- | ------- | ```name``` | Optional | String | Your meeting name. Default name set to `conversationId`. ```messages``` | Mandatory | List | Input Messages to look for insights. [See the messages section below for more details.](#messages) -```confidenceThreshold``` | Optional | Double | Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range <=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`. +```confidenceThreshold``` | Optional | Double | Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range >=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`. ```detectPhrases```| Optional | Boolean | It shows Actionable Phrases in each sentence of a conversation. These sentences can be found using the Conversation's Messages API. The default value is `false`. ```entities``` | Optional | List | Input custom entities which can be detected in your conversation using [Entities API](/docs/conversation-api/entities). ```detectEntities``` | Optional | Boolean | Default value is `false`. If not set the [Entities API](/docs/conversation-api/entities) will not return any entities from the conversation. @@ -483,4 +483,4 @@ Here, the value of `X` can be found in [FAQ](/docs/faq). :::caution You must wait for the job to complete processing before you proceed with getting the Conversation Intelligence. If you immediately make a GET request to Conversation API, it is possible that you'll receive incomplete insights. Therefore, ensure that you wait for the job to complete. -::: \ No newline at end of file +::: diff --git a/docs/async-api/overview/video/post-video-url.md b/docs/async-api/overview/video/post-video-url.md index f78a981c..bf4eda6e 100644 --- a/docs/async-api/overview/video/post-video-url.md +++ b/docs/async-api/overview/video/post-video-url.md @@ -277,7 +277,7 @@ Field | Required | Type | Description ----- | ------- | -------- | ------- | ```url``` | Mandatory | String | A valid URL string. The URL must be a publicly accessible URL. ```customVocabulary``` | Optional | String[] | Contains a list of words and phrases that provide hints to the speech recognition task. -```confidenceThreshold``` | Optional | Double | Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range <=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`. +```confidenceThreshold``` | Optional | Double | Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range >=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`. ```detectPhrases```| Optional | Boolean | It shows [Actionable Phrases](/docs/concepts/action-items) in each sentence of conversation. These sentences can be found using the [Conversation's Messages API](/docs/conversation-api/messages). Accepts `true` or `false`. ```name``` | Optional | String | Your meeting name. Default name set to `conversationId`. ```webhookUrl``` | Optional | String | Webhook URL on which job updates to be sent. This should be after the API call is made. For Webhook payload, refer to the [Using Webhook](#using-webhook) section below. diff --git a/docs/async-api/overview/video/post-video.md b/docs/async-api/overview/video/post-video.md index 1e16a531..e65d9c8c 100644 --- a/docs/async-api/overview/video/post-video.md +++ b/docs/async-api/overview/video/post-video.md @@ -188,7 +188,7 @@ Parameter | Required | Type | Description ```name``` | Optional | String | Your meeting name. Default name set to `conversationId`. ```webhookUrl``` | Optional | String | Webhook URL on which job updates to be sent. This should be post API. For Webhook payload, refer to the [Using Webhook](#using-webhook) section below. ```customVocabulary``` | Optional | String[] | Contains a list of words and phrases that provide hints to the speech recognition task. -```confidenceThreshold``` | Optional | Double | Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range <=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`. +```confidenceThreshold``` | Optional | Double | Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range >=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`. ```detectPhrases```| Optional | Boolean | Accepted values are `true` & `false`. It shows [Actionable Phrases](/docs/conversation-api/action-items) in each sentence of conversation. These sentences can be found in the [Conversation's Messages API](/docs/conversation-api/messages). ```entities``` | Optional | Object[] | Input custom entities which can be detected in your conversation using [Entities API](/docs/conversation-api/entities). Sample request for Custom Entity is given in the [Custom Entity](#custom-entity) section below. ```detectEntities``` | Optional | Boolean | Default value is `false`. If not set the [Entities API](/docs/conversation-api/entities) will not return any entities from the conversation. diff --git a/docs/async-api/overview/video/put-video-url.md b/docs/async-api/overview/video/put-video-url.md index eafd3c4a..28ac10bc 100644 --- a/docs/async-api/overview/video/put-video-url.md +++ b/docs/async-api/overview/video/put-video-url.md @@ -18,8 +18,7 @@ This API supports only mp4 file formats video. If you have any other type ::: :::note -If there are multiple requests are submitted for the same Conversation ID all the requests will be processed synchronously -in order to maintain the order of the requests for the conversation. +If multiple requests are submitted for the same Conversation ID, all the requests are processed synchronously in order to maintain the order of the requests for the conversation. ::: ### Authentication @@ -297,7 +296,7 @@ Field | Required | Type | Description ----- | ------- | -------- | ------- | ```url``` | Mandatory | String | A valid URL string. The URL must be a publicly accessible URL. ```customVocabulary``` | Optional | String[] | Contains a list of words and phrases that provide hints to the speech recognition task. -```confidenceThreshold``` | Optional | Double | Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range <=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`. +```confidenceThreshold``` | Optional | Double | Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range >=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`. ```detectPhrases```| Optional | Boolean | It shows [Actionable Phrases](/docs/concepts/action-items) in each sentence of conversation. These sentences can be found using the [Conversation's Messages API](/docs/conversation-api/messages). Accepts `true` or `false`. ```name``` | Optional | String | Your meeting name. Default name set to `conversationId`. ```webhookUrl``` | Optional | String | Webhook URL on which job updates to be sent. This should be after the API call is made. For Webhook payload, refer to the [Using Webhook](#using-webhook) section below. diff --git a/docs/async-api/overview/video/put-video.md b/docs/async-api/overview/video/put-video.md index ff219728..efbc219b 100644 --- a/docs/async-api/overview/video/put-video.md +++ b/docs/async-api/overview/video/put-video.md @@ -18,8 +18,7 @@ This API supports only mp4 file formats video. If you have any other type ::: :::note -If there are multiple requests are submitted for the same Conversation ID, all the requests will be processed synchronously -in order to maintain the order of the requests for the conversation. +If multiple requests are submitted for the same Conversation ID, all the requests are processed synchronously in order to maintain the order of the requests for the conversation. ::: ### Authentication @@ -204,7 +203,7 @@ Parameter | Required | Type | Description ```name``` | Optional | String | Your meeting name. Default name set to `conversationId`. ```webhookUrl``` | Optional | String | Webhook URL on which job updates to be sent. This should be after the API call is made. For Webhook payload, refer to the [Using Webhook](#using-webhook) section below. ```customVocabulary``` | Optional | String[] | Contains a list of words and phrases that provide hints to the speech recognition task. -```confidenceThreshold``` | Optional | Double | Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range <=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`. +```confidenceThreshold``` | Optional | Double | Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range >=0.5 to <=1.0 (i.e., greater than or equal to `0.5` and less than or equal to `1.0`.). The default value is `0.5`. ```detectPhrases```| Optional | Boolean | Accepted values are `true` & `false`. It shows [Actionable Phrases](/docs/conversation-api/action-items) in each sentence of conversation. These sentences can be found in the [Conversation's Messages API](/docs/conversation-api/messages). ```entities``` | Optional | Object[] | Input custom entities which can be detected in your conversation using [Entities API](/docs/conversation-api/entities). Sample request for Custom Entity is given in the [Custom Entity](#custom-entity) section below. ```detectEntities``` | Optional | Boolean | Default value is `false`. If not set the [Entities API](/docs/conversation-api/entities) will not return any entities from the conversation. diff --git a/docs/async-api/tutorials/get-speaker-separation-audio-video.md b/docs/async-api/tutorials/get-speaker-separation-audio-video.md index f3854bee..103d76df 100644 --- a/docs/async-api/tutorials/get-speaker-separation-audio-video.md +++ b/docs/async-api/tutorials/get-speaker-separation-audio-video.md @@ -12,7 +12,7 @@ import TabItem from '@theme/TabItem'; -[Symbl's Async API](/docs/async-api/introduction) allows you to process stored recordings of audio or video from files or URLs or even textual content from a conversation. In this guide, we will walk you through how to implement [Speaker Separation](/docs/async-api/reference/reference/#speaker-separation) with audio or video files. Speaker Separation, in short, is the ability to detect and separate unique speakers in a single stream of audio & video without the need for separate speaker events. +[Symbl's Async API](/docs/async-api/introduction) allows you to process stored recordings of audio or video from files or URLs or even textual content from a conversation. In this guide, we will walk you through how to implement [Speaker Separation](/docs/async-api/overview/speaker-separation/) with audio or video files. Speaker Separation, in short, is the ability to detect and separate unique speakers in a single stream of audio & video without the need for separate speaker events. :::info Speaker Diarization Language Support diff --git a/docs/faq.md b/docs/faq.md index 96c1f3af..1f303281 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -25,6 +25,8 @@ We store transcripts, insights, and metadata of the conversation, which is persi For trial, [Streaming API](/docs/streamingapi/introduction) has a limit of 2 concurrent connections, and [Async APIs](/docs/async-api/overview/introduction) has a limit of 2 concurrent jobs. After you upgrade your account, it has a limit of 50 concurrent connections for Streaming API and 50 concurrent jobs for Async API. If you are looking to scale, and need more concurrent jobs than this limit, please contact us at support@symbl.ai. +### What happens when multiple requests are sent for the same Conversation ID? +If multiple requests are submitted for the same Conversation ID, all the requests are processed synchronously in order to maintain the order of the requests for the conversation. ### What is the maximum length of meeting duration the [Async API](/docs/async-api/overview/introduction) supports? diff --git a/docs/integrations/agora-sdk-plugin.md b/docs/integrations/agora-sdk-plugin.md index 3ffb5732..23c9f4cf 100644 --- a/docs/integrations/agora-sdk-plugin.md +++ b/docs/integrations/agora-sdk-plugin.md @@ -191,7 +191,7 @@ The following table lists the parameters and their descriptions used in the samp | `symbl_token_api` | The URL for secure token generation. | `symbl_meeting_encoding` | The audio encoding in which the audio will be sent over the WebSocket connection. | `symbl_meeting_sampleRateHertz` | The rate of the incoming audio stream. -| `symbl_confidence_threshold` | The minimum confidence score that you can set for an API to consider it as valid insight. The minimum confidence score should be in the range <=0.5 to <=1.0 (greater than or equal to 0.5 and less than or equal to 1.0.). Default value is 0.5. +| `symbl_confidence_threshold` | The minimum confidence score that you can set for an API to consider it as valid insight. The minimum confidence score should be in the range >=0.5 to <=1 (greater than or equal to 0.5 and less than or equal to 1.0.). Default value is 0.5. You would have to call the method above during the initialization of the Agora Engine in your application. diff --git a/docs/streamingapi/reference/reference.md b/docs/streamingapi/reference/reference.md index eb53506b..22d333c8 100644 --- a/docs/streamingapi/reference/reference.md +++ b/docs/streamingapi/reference/reference.md @@ -61,7 +61,7 @@ Field | Required | Supported Value | Description Field | Required | Supported value | Default Value | Description ---------- | ------- | ------- | ------- | ------- | -```confidenceThreshold``` | false | <=0.5 to <=1.0 | 0.5 | Minimum confidence score that you can set for an API to consider it as valid insight. The minimum confidence score should be in the range <=0.5 to <=1.0 (greater than or equal to `0.5` and less than or equal to `1.0`.). Default value is `0.5`. +```confidenceThreshold``` | false | <=0.5 to <=1.0 | 0.5 | Minimum confidence score that you can set for an API to consider it as valid insight. The minimum confidence score should be in the range >=0.5 to <=1 (greater than or equal to `0.5` and less than or equal to `1.0`.). Default value is `0.5`. ```speechRecognition``` | false | | | See Speech Recognition section [below](#speech-recognition). ```meetingTitle``` | false | | | The name of the meeting. diff --git a/docs/subscribe-api.md b/docs/subscribe-api.md index 75a06511..3bf4c1bf 100644 --- a/docs/subscribe-api.md +++ b/docs/subscribe-api.md @@ -23,7 +23,7 @@ While users connected on websocket are charged per user, the listen-only partici This can be turned on or off for a conversation, on demand. :::info -The Subscribe APIs does not have a limit to the number of participants that can join. You can seamlessly add up to 10,000 participants. +The Subscribe API allows you to add up to 10,000 participants per call. ::: ### API Endpoint