Action Items

This API returns a list of all the action items generated from the conversation

Overview

Action Item API detects an event, task, activity, or action that needs to take place in the future (after the conversation). These Action items can be of high priority with a definite assignee and due date or of lower priority with a non-definite due date.

All action items are generated with action phrases, assignees, and due dates to make the output immediately consumable by your CRM or project management tools

Input Type Supported: Audio, Video

Model Dependency: Speech to Text, Speaker Separation, Speech Type

post
Compute Metadata

https://api.marsview.ai/v1/conversation/compute
This method is used to upload an audio or video file on which metadata has to be computed. Settings object can be used to enable/disable metadata from different models. Check the overview section for getting a list of models that are available
Request
Response
Request
Headers
appSecret
required
string
<sample-app-secret>
appId
required
string
<sample-app-Id>
Content-Type
optional
string
application/json
Body Parameters
speech_type.enable
required
boolean
Speech_type will be computed when speech_type.enable key is set to true under the settings object
Response
200: OK
A Transaction ID is returned in the JSON body once the processing job is launched successfully. This Transaction ID can be used to check the status of the job or fetch the results of the job once the metadata is computed
{
"status":true,
"transaction_id":32dcef1a-5724-4df8-a4a5-fb43c047716b,
"message": " Compute job for file-id: 32dcef1a-5724-4df8-a4a5-fb43c047716b launched successfully"
}
400: Bad Request
This usually happens when the settings for computing the metadata are not configured correctly. Check the request object and also the dependencies required to compute certain metadata objects. ( For Example: Speech to Text has to be enabled for Action Items to be enabled)
{
"status":false,
"error":{
"code":"MCST07",
"message":"DependencyError: emotion_analysis depends on speech_to_text"
}
}

Example API Call

Request

CURL
CURL
curl --request POST 'https://api.marsview.ai/v1/conversation/compute' \
--header 'appSecret: 32dcef1a-5724-4df8-a4a5-fb43c047716b' \
--header 'appId: 1ZrKT0tTv7rVWX-qNAKLc' \
--header 'Content-Type: application/json' \
--data-raw '{
"settings":{
"speech_to_text":{
"enable":true,
"pii_detection":false,
"custom_vocabulary":["Marsview" , "Pikachu"]
},
"speaker_separation":{
"enable":true,
"num_speakers":4
},
"speech_type_analysis":{
"enable":true
},
"action_items":{
"enable":true
}
}
}'

Response

Given below is a sample response JSON when the Status code is 200.

{
"status":true,
"transaction_id":32dcef1a-5724-4df8-a4a5-fb43c047716b,
"message": " Compute job for file-id: 32dcef1a-5724-4df8-a4a5-fb43c047716b launched successfully"
}

post
Request Metadata

https://api.marsview.ai/v1/conversation/fetch
This method is used to fetch specific Metadata for a particular file_id. It can also be used for long polling to track the progress of compute under the status object.
Request
Response
Request
Headers
Content-Type
optional
string
application/json
appId
optional
string
<sample-app-id>
appSecret
optional
string
<sample-app-secret>
Body Parameters
fileID
optional
string
fileId of the audio/video file
data.action_items
optional
boolean
Returns tone data for file_id once computed
Response
200: OK
The output consists of two objects. The data object returns the requested metadata if it is computed. The status object shows the current state of the requested metadata. Status for each metadata field can take values "Queued"/"Processing"/"Completed". Shown below is a case where "sentiment analysis" Job is in "Queued" state and "Completed" state.
QUEUED STATE
COMPLETED STATE
QUEUED STATE
{
"status":{
"action_items":"Queued",
}
"data":{
"action_items":{}
}
}
COMPLETED STATE
{
"status":{
"action_items":"Completed"
}
"data":{
"action_items":{
"chunks":[
...
{
"start_time" : "174100.0"
"end_time" : "175100.0",
"sentence" : "Doe, Send the Shipment by next Monday",
"deadline": "4/1/2021",
"assigned_by" : "speaker: 1",
"assigned_to" : "Doe",
"confidence" : "0.73"
},
{
"start_time" : "174100.0"
"end_time" : "175100.0",
"sentence": "Make the requested changes on the website by Friday",
"deadline": "1/1/21"
"confidence" :"0.95"
},
...
]
}
}
}

Response Object Fields

Fields

Description

sentence

The transcribed sentence from Marsview STT which is an action item

deadline

Deadline for the action item.

assigned_by

The Speaker who has spoken the sentence

assigned_to

Extracted Speaker info/ Person name from the sentence

priority

Importance of the Sentence

‚Äč