From fb0e9e49e799d08b69d79792e034b82e1d0719c3 Mon Sep 17 00:00:00 2001 From: Mukulika Date: Wed, 16 Mar 2022 18:55:09 +0530 Subject: [PATCH 1/2] DC-225 Further explanation for the and parameters --- .../api-reference/comprehensive-action-items.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/conversation-api/api-reference/comprehensive-action-items.md b/docs/conversation-api/api-reference/comprehensive-action-items.md index 08120999..0e5f4d45 100644 --- a/docs/conversation-api/api-reference/comprehensive-action-items.md +++ b/docs/conversation-api/api-reference/comprehensive-action-items.md @@ -153,9 +153,9 @@ Field | Description ```id``` | Unique identifier of the comprehensive action item. ```text``` | Text of the comprehensive action item. ```type``` | Response type. Default is `action_item`. -```score``` | Confidence score of the detected action item. Value from 0 - 1. +```score``` | Confidence score of the detected action item. Value from 0 - 1. The score shows the relevancy of the action item in the transcript. Higher the confidence score, the more relevant it is. ```messageRefs.id``` | Unique identifiers of the corresponding messages from where the action item was derived. You may get multiple message IDs here as Symbl identifies all the relevant messages in the conversation and generates the required action item accordingly. ```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. Explains the tone of the message. 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 to whom the action item is assigned. From 4e180036fe9ffa088b645641164f5211a8fbec06 Mon Sep 17 00:00:00 2001 From: Mukulika <60316606+Mukulikaa@users.noreply.github.com> Date: Tue, 22 Mar 2022 11:26:22 +0530 Subject: [PATCH 2/2] Improved wording --- .../api-reference/comprehensive-action-items.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conversation-api/api-reference/comprehensive-action-items.md b/docs/conversation-api/api-reference/comprehensive-action-items.md index 0e5f4d45..ab60e219 100644 --- a/docs/conversation-api/api-reference/comprehensive-action-items.md +++ b/docs/conversation-api/api-reference/comprehensive-action-items.md @@ -156,6 +156,6 @@ Field | Description ```score``` | Confidence score of the detected action item. Value from 0 - 1. The score shows the relevancy of the action item in the transcript. Higher the confidence score, the more relevant it is. ```messageRefs.id``` | Unique identifiers of the corresponding messages from where the action item was derived. You may get multiple message IDs here as Symbl identifies all the relevant messages in the conversation and generates the required action item accordingly. ```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. Explains the tone of the message. For e.g, ‘I will complete this task today’ is a definitive sentence. +```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 to whom the action item is assigned.