Extractive Summary

This API will summarize your conversation using the salient information present in the conversation.

Overview
Extractive summarization aims at identifying the salient information that is then extracted and grouped together to form a concise summary.
Source: Google
Input Type Supported: Audio, Text
Model Dependency: Speech to Text, Speaker Separation
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
extractive_summary.enable
required
boolean
Extractive summary will be computed when extractive_summary.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
                     },
                     "extractive_summary":{
                          "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.extractive_summary
optional
boolean
Returns extractive summary 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 "exxtractive summary" Job is in "Queued" state and "Completed" state. 
QUEUED STATE
COMPLETED STATE
QUEUED STATE
{
    "status":{
        "extractive_summary":"Queued",
    }
    "data":{
        "extractive_summary":{}
    }
}
COMPLETED STATE
{
    "status":{
        "extractive_summary":"Completed"
    }
    "data":{
        "extractive_summary":{
            "chunks":[
                ...
                {
                  "start_time" : "174100.0"
			            "end_time" : "175100.0",
			            "sentence" : "How do I access the Documentation ?",
			            "confidence" : "0.33"
			          },
                {
                  "start_time" : "174100.0"
			            "end_time" : "175100.0",
			            "sentence": "Make the requested changes on the website by Friday",
			            "confidence" :"0.95"
			          },
			          ...
            ]
        
        }
    }
}
Response Object Fields
Fields
Description
start_time
Starting time of the chunk in milliseconds.
end_time
Ending time of the chunk in milliseconds.
sentence
Summarized sentence extracted from Marsview STT with Chunk timestamps of the original sentence.

Conversation API (Bundle) - Previous

Topics

Next - Conversation API (Bundle)

Abstractive Summary

Last updated 3 months ago

Fields	Description
`start_time`	Starting time of the chunk in milliseconds.
`end_time`	Ending time of the chunk in milliseconds.
`sentence`	Summarized sentence extracted from Marsview STT with Chunk timestamps of the original sentence.

Extractive Summary

Overview

postCompute Metadata

Example API Call

Request

Response

postRequest Metadata

Response Object Fields

post
Compute Metadata

post
Request Metadata