Comprehensive Action Items (Labs)

Comprehensive Action Items returns all the action items that are enriched with corresponding contexts.

Authentication

Before using this API, you must generate your authentication token (AUTH_TOKEN) as described in Authentication.

To get Comprehensive Action Items, you must first process your conversation using the Async API. After you process the conversation, pass the Conversation ID as a request parameter to the Fetch comprehensive action items request.

Comprehensive Action Items request

GET https://api-labs.symbl.ai/v1/conversations/{conversationId}/comprehensive/action-items

Note that the base URL for all Symbl Labs feature is https://api-labs.symbl.ai

Example Comprehensive Action Items request

curl "https://api-labs.symbl.ai/v1/conversations/$CONVERSATION_ID/comprehensive/action-items" \
    -H "Authorization: Bearer $AUTH_TOKEN"
const request = require('request');
const authToken = AUTH_TOKEN;
const conversationId = CONVERSATION_ID;

request.get({
    url: `https://api-labs.symbl.ai/v1/conversations/${conversationId}/comprehensive/action-items`,
    headers: { 'Authorization': `Bearer ${authToken}` },
    json: true
}, (err, response, body) => {
    console.log(body);
});
import requests

baseUrl = "https://api-labs.symbl.ai/v1/conversations/{conversationId}/comprehensive/action-items"
conversationId = 'your_conversation_id'  # Generated using Submit text end point

url = baseUrl.format(conversationId=conversationId)

# set your access token here. See https://docs.symbl.ai/docs/developer-tools/authentication
access_token = 'your_access_token'

headers = {
    'Authorization': 'Bearer ' + access_token,
    'Content-Type': 'application/json'
}

responses = {
    401: 'Unauthorized. Please generate a new access token.',
    404: 'The conversation and/or it\'s metadata you asked could not be found, please check the input provided',
    500: 'Something went wrong! Please contact [email protected]'
}

response = requests.request("GET", url, headers=headers)

if response.status_code == 200:
    # Successful API execution
    print("actionItems => " + str(response.json()['actionItems']))  # actionsItems object containing actionItem id, text, type, score, messageIds, phrases, definitive, entities, assignee
elif response.status_code in responses.keys():
    print(responses[response.status_code])  # Expected error occurred
else:
    print("Unexpected error occurred. Please contact [email protected]" + ", Debug Message => " + str(response.text))

exit()

Example response

{
    "actionItems": [
        {
            "id": "4875991597973504",
            "text": "Stella and John need to shift their focus more towards dev. John will go ahead and set up a discussion with product.",
            "type": "action_item",
            "score": 0.8735619108573252,
            "messageRefs": [
                {
                  "id": "5943054110294016"
                },
                {
                  "id": "4960777540730880"
                }
            ],
            "entities": [],
            "phrases": [],
            "from": {
                "id": "10aa881e-4c70-4060-8886-66a5e5c9b788",
                "name": "John",
                "userId": "[email protected]"
            },
            "definitive": true,
            "assignee": {
                "id": "10aa881e-4c70-4060-8886-66a5e5c9b788",

                "name": "John",
                "email": "[email protected]"
            }
        }
    ]
}

Response Parameters

FieldDescription
idUnique identifier of the comprehensive action item.
textText of the comprehensive action item.
typeResponse type. Default is action_item.
scoreConfidence score of the detected action item. Value from 0 - 1. The score shows the relevancy of the action item in the transcript. The higher the confidence score, the more relevant it is.
messageRefs.idUnique identifiers of the corresponding messages from where the action item was derived. You may get multiple message IDs as the algorithm identifies all the relevant messages in the conversation and generates the required action items
entitiesList of detected entity objects in the insight with type - entity type and text - corresponding text.
definitiveBoolean 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.
phrasesList of detected phrases with type - phrase type and text - corresponding text. The action_phrase type represents the actionable part of an insight.
assigneeThis field contains the name and email of the person to whom the action item is assigned.

Did this page help you?