Conversation Type

Distinguish between conversation type and capture actionable notes from your input

Overview

Conversation Type model helps you understand the type of conversation at any given time. Every conversation text input will be broadly classified into four categories - Statement, Command, Action Item, or a Question.

Speech Types

Type

Description

Statement

a definite or clear expression of something in chat

Command

an authoritative or peremptory order

Action Item

a chat worded or expressed regarding an event, task, activity, or action that needs to take place

Question

a chat worded or expressed so as to elicit information

Input Type Supported: Text

post
Compute Metadata

https://api.marsview.ai/v1/nlp/conversationType
Request
Response
Request
Headers
appSecret
required
string
<sample-app-secret>
appId
required
string
<sample-app-Id>
Content-Type
optional
string
application/json
Body Parameters
data.text
required
boolean
Raw text on which sentiments have to be computed.
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"
}

Example API Call

Request

CURL
CURL
curl --request POST 'https://api.marsview.ai/v1/nlp/conversationType' \
--header 'appSecret: 32dcef1a-5724-4df8-a4a5-fb43c047716b' \
--header 'appId: 1ZrKT0tTv7rVWX-qNAKLc' \
--header 'Content-Type: application/json' \
--data-raw '{
"data":{
"text":"A watch is a portable timepiece intended to be carried or worn by a person. It is designed to keep a consistent movement despite the motions caused by the person's activities. A wristwatch is designed to be worn around the wrist, attached by a watch strap or other type of bracelet, including metal bands, leather straps or any other kind of bracelet. A pocket watch is designed for a person to carry in a pocket, often attached to a chain. The study of timekeeping is known as horology. Watches progressed in the 17th century from spring-powered clocks, which appeared as early as the 14th century. During most of its history the watch was a mechanical device, driven by clockwork, powered by winding a mainspring, and keeping time with an oscillating balance wheel. These are called mechanical watches.[1][2] In the 1960s the electronic quartz watch was invented, which was powered by a battery and kept time with a vibrating quartz crystal.
By the 1980s the quartz watch had taken over most of the market from the mechanical watch. Historically, this is called the quartz revolution (also known as quartz crisis in Swiss)."
}
}'

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/nlp/conversationType/fetch
This method is used to fetch specific Metadata for a particular transaction_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
transactionId
optional
string
Transaction ID to fetch data from
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 "emotion analysis" Job is in "Queued" state and "Completed" state.
QUEUED STATE
COMPLETED STATE
QUEUED STATE
{
"status":{
"conversation_type_analysis":"Queued",
}
"data":{
"conversation_type_analysis":{}
}
}
COMPLETED STATE
{
"status":{
"conversation_type_analysis":"Completed"
}
"data":{
"conversation_type_analysis":{
"sentences":[
...
{
"start_char" : "1235"
"end_char" : "1347",
"sentence": "A watch is a portable timepiece intended to be carried or worn by a person",
"type":"statement",
"confidence":0.62
},
{
"start_time" : "1349"
"end_time" : "1450",
"sentence":" It is designed to keep a consistent movement despite the motions caused by the person's activities",
"type":"statement",
"confidence":0.20
},
...
]
}
}
}

Response Object Fields

Fields

Description

start_char

Starting character of the sentence in the original text

end_time

Ending character of the sentence in the original text

sentences

List of Conversation Type objects for that particular chunk

sentences.type

Name Tag for the Type of conversation type detected.

sentences.confidence

Confidence of the conversation type (ranges from 0 to 1). Higher the better

sentences.sentence

A sentence extracted from the original text