Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DC-294 #361

Merged
merged 4 commits into from
Feb 10, 2022
Merged

DC-294 #361

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
364129d
DC-294
pema-s Feb 3, 2022
59a381b
Updates sample response
pema-s Feb 9, 2022
aa36e73
Adds feedback + minor changes
pema-s Feb 10, 2022
358d8b3
Updates description for variables
pema-s Feb 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 64 additions & 36 deletions docs/conversation-api/api-reference/messages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,31 +10,22 @@ import TabItem from '@theme/TabItem';

---

The Messages API returns a list of all the messages in a conversation. You can use this for providing **Speech to Text data (also known as transcription sometimes)** for video conference, meeting or 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 message refer to a continuous sentence spoken by a speaker.
Here, the message refers to a continuous sentence spoken by a speaker.

### Word-level Confidence Score <font color="orange"> LABS</font>
#### Sentiment Analysis in messages <font color="orange"> BETA</font>

This API provides word-level confidence score that represents the confidence level of individual words within the message or transcript. The confidence score shows the relevancy of the word in the transcript which means higher the word-level confidence score, the more relevant it is to the message.
You can enable sentiment analysis over each message being spoken in the conversation.
pema-s marked this conversation as resolved.
Show resolved Hide resolved

When you pass `verbose=true`, the word-level confidence score is by default returned in the response body.


### Sentiment Analysis in messages <font color="orange"> BETA</font>

Here you can enable sentiment analysis over each message which is being spoken in the conversation.

All you need to do is pass `sentiment=true` as a query parameter. [Read more about it](/docs/concepts/sentiment-analysis).
To do this, pass the query parameter `sentiment=true`. Read more about Sentiment Analysis [here](/docs/concepts/sentiment-analysis).

### 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).
:::
Expand Down Expand Up @@ -146,11 +137,13 @@ Parameter | Required | Value |Description |
},
"startTime": "2020-07-10T11:16:21.024Z",
"endTime": "2020-07-10T11:16:26.724Z",
"timeOffset": 5.9,
"duration": 1,
"conversationId": "6749556955938816",
"phrases": [
{
"type": "action_phrase",
"text": "$69.99 per month"
"text": "$69.99 per month",
}
],
"sentiment": {
Expand All @@ -164,49 +157,69 @@ Parameter | Required | Value |Description |
"word": "Best",
"startTime": "2020-08-18T11:10:14.536Z",
"endTime": "2020-08-18T11:10:15.536Z",
"score": 0.91
"score": 0.91,
"timeOffset": 5.9,
"duration": 0.2

},
{
"word": "package",
"startTime": "2020-08-18T11:10:16.536Z",
"endTime": "2020-08-18T11:10:17.536Z",
"score": 0.80
"score": 0.80,
"timeOffset": 6.1,
"duration": 0.1

},
{
"word": "for",
"startTime": "2020-08-18T11:10:18.536Z",
"endTime": "2020-08-18T11:10:19.536Z",
"score": 0.79
"score": 0.68,
pema-s marked this conversation as resolved.
Show resolved Hide resolved
"timeOffset": 6.2,
"duration": 0.1

},
{
"word": "you",
"startTime": "2020-08-18T11:10:20.536Z",
"endTime": "2020-08-18T11:10:22.536Z",
"score": 0.85
"score": 0.68,
"timeOffset": 6.3,
"duration": 0.3

},
{
"word": "is",
"startTime": "2020-08-18T11:10:22.536Z",
"endTime": "2020-08-18T11:10:25.536Z",
"score": 0.89
"score": 0.68,
"timeOffset": 6.6,
"duration": 0.3
},
{
"word": "$69.99",
"startTime": "2020-08-18T11:10:25.536Z",
"endTime": "2020-08-18T11:10:27.536Z",
"score": 0.86
"score": 0.68,
"timeOffset": 6.67,
"duration": 0.3
},
{
"word": "per",
"startTime": "2020-08-18T11:10:27.536Z",
"endTime": "2020-08-18T11:10:29.536Z",
"score": 0.82
"score": 0.67,
"timeOffset": 6.6,
"duration": 0.4
},
{
"word": "month.",
"startTime": "2020-08-18T11:10:30.536Z",
"endTime": "2020-08-18T11:10:32.536Z",
"score": 0.90
"score": 0.67,
"timeOffset": 6.8,
"duration": 0.5
}]
},
{
Expand All @@ -218,44 +231,57 @@ Parameter | Required | Value |Description |
}
"startTime": "2020-08-18T11:11:14.536Z",
"endTime": "2020-08-18T11:11:18.536Z",
"timeOffset": 15.27,
"duration": 1.23,
"conversationId": "5139780136337408",
"phrases": [],
"sentiment": {
"polarity": {
"score": 0.2
"score": 0.2,
},
"suggested": "neutral"
},
"words": [
{
"word": "Okay,",
"startTime": "2020-08-18T11:11:14.536Z",
"endTime": "2020-08-18T11:11:14.936Z"
"score": 0.91
"endTime": "2020-08-18T11:11:14.936Z",
"score": 0.91,
"timeOffset": 15.25,
"duration": 0.59

},
{
"word": "Where",
"startTime": "2020-08-18T11:11:14.936Z",
"endTime": "2020-08-18T11:11:15.436Z"
"score": 0.91
"endTime": "2020-08-18T11:11:15.436Z",
"score": 0.91,
"timeOffset": 15.25,
"duration": 0.59
},
{
"word": "is",
"startTime": "2020-08-18T11:11:16.236Z",
"endTime": "2020-08-18T11:11:16.536Z"
"score": 0.88
"endTime": "2020-08-18T11:11:16.536Z",
"score": 0.88,
"timeOffset": 15.25,
"duration": 0.58
},
{
"word": "the",
"startTime": "2020-08-18T11:11:16.536Z",
"endTime": "2020-08-18T11:11:16.936Z"
"score": 0.85
"endTime": "2020-08-18T11:11:16.936Z",
"score": 0.85,
"timeOffset": 15.25,
"duration": 0.58
},
{
"word": "file?",
"startTime": "2020-08-18T11:11:16.936Z",
"endTime": "2020-08-18T11:11:17.236Z"
"score": 0.89
"endTime": "2020-08-18T11:11:17.236Z",
"score": 0.89,
"timeOffset": 15.25,
"duration": 0.59
}
]
}
Expand All @@ -270,7 +296,9 @@ Field | Description
```from``` | User object with name and email.
```startTime``` | DateTime value.
```endTime``` | DateTime value.
```conversationId``` | Unique conversation identifier.
```words``` | Words object with properties `word`, `startTime`, `endTime` and `score`. The `score` represents the word level confidence score. The value that is accepted for the data type is float.
```timeOffset``` | Returned as a float value measuring in seconds, up to 2 decimal points. It is returned at the sentence level as well as the word level. At the sentence level, it means the relative timestamp of when the sentence was spoken to when the conversation started (i.e., `startTime`). At the word level, it means the relative timestamp of when the word was spoken to when the conversation started (i.e., `startTime`). This variable is currently in <font color="orange"> Labs</font>.
```duration``` | Returned as a float value measuring in seconds, upto 2 decimal points. It is returned at the sentence level as well as the word level. At the sentence level, it means the relative timestamp of when the sentence was spoken to when the conversation ended (i.e.,`endTime`). At the word level, it means the relative timestamp of when the word was spoken to when the conversation ended (i.e., `endTime`). This variable is currently in <font color="orange"> Labs</font>.
pema-s marked this conversation as resolved.
Show resolved Hide resolved
```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 message or transcript. The confidence 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 in the response body. Note that processed text conversation will not return any confidence score since it is already in the transcript form. The word level confidence score is currently in <font color="orange"> Labs</font>.
pema-s marked this conversation as resolved.
Show resolved Hide resolved
```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).
1 change: 1 addition & 0 deletions docs/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,4 @@ You can create up to 200 Trackers per account.

### Can I view the logs of Streaming API?
Yes, you can view the Streaming API logs via the [Symbl Platform](https://platform.symbl.ai/#/login).