Text
Text Insight
You need to call this API to find the insights from your text note.
Please check an example find the return response and an object.
Response
{
"status": "success",
"data": {
"count": {
"wordCount": 0,
"characterCount": 0,
"characterCountWithoutSpace": 0
},
"insight": {
"intents": {
"needs": [
{
"id": 32,
"text": "Sentence 1"
}
],
"wants": [
{
"id": 50,
"text": "Sentence 1"
}
]
},
"state": "processed",
"updatedAt": "2021-04-13T00:30:26.720Z",
"arts": [
{
"isDeleted": false,
"instances": [
{
"endChar": 512,
"startChar": 489
}
],
"isCustom": false,
"name": "xxxxx",
"id": 0
},
{
"isDeleted": false,
"instances": [
{
"endChar": 1397,
"startChar": 1386
}
],
"isCustom": false,
"name": "xxxxxxx",
"id": 1
}
],
"brands": [
{
"isDeleted": false,
"instances": [
{
"endChar": 202,
"startChar": 198
},
{
"endChar": 356,
"startChar": 352
}
],
"isCustom": false,
"name": "xxxxx",
"id": 0
},
{
"isDeleted": false,
"instances": [
{
"endChar": 333,
"startChar": 310
}
],
"isCustom": false,
"name": "xxxxx",
"id": 1
},
{
"isDeleted": false,
"instances": [
{
"endChar": 721,
"startChar": 713
},
{
"endChar": 3009,
"startChar": 3001
},
{
"endChar": 6074,
"startChar": 6066
},
{
"endChar": 6391,
"startChar": 6383
},
{
"endChar": 6615,
"startChar": 6607
},
{
"endChar": 6854,
"startChar": 6846
},
{
"endChar": 6914,
"startChar": 6906
}
],
"isCustom": false,
"name": "xxxxx",
"id": 2
}
],
"cardinals": [
{
"isDeleted": false,
"instances": [
{
"endChar": 1797,
"startChar": 1794
},
{
"endChar": 1850,
"startChar": 1847
}
],
"isCustom": false,
"name": "xxxxx",
"id": 0
},
{
"isDeleted": false,
"instances": [
{
"endChar": 3028,
"startChar": 3022
}
],
"isCustom": false,
"name": "xxxxx",
"id": 1
}
],
"dates": [
{
"isDeleted": false,
"instances": [
{
"endChar": 755,
"startChar": 739
}
],
"isCustom": false,
"name": "xxxxx",
"id": 0
}
],
"events": [
{
"isDeleted": false,
"instances": [
{
"endChar": 755,
"startChar": 739
}
],
"isCustom": false,
"name": "xxxxx",
"id": 0
}
],
"facs": [
{
"isDeleted": false,
"instances": [
{
"endChar": 755,
"startChar": 739
}
],
"isCustom": false,
"name": "xxxxx",
"id": 0
}
],
"geopolitical": [
{
"isDeleted": false,
"instances": [
{
"endChar": 172,
"startChar": 163
}
],
"isCustom": false,
"name": "xxxxx",
"id": 0
}
],
"keywords": [
{
"isDeleted": false,
"instances": [
{
"endChar": 172,
"startChar": 163
}
],
"isCustom": false,
"name": "xxxxx",
"id": 0
}
],
"languages": [
{
"isDeleted": false,
"instances": [
{
"endChar": 172,
"startChar": 163
}
],
"isCustom": false,
"name": "xxxxx",
"id": 0
}
],
"laws": [
{
"isDeleted": false,
"instances": [
{
"endChar": 172,
"startChar": 163
}
],
"isCustom": false,
"name": "xxxxx",
"id": 0
}
],
"locations": [
{
"isDeleted": false,
"instances": [
{
"endChar": 172,
"startChar": 163
}
],
"isCustom": false,
"name": "xxxxx",
"id": 0
}
],
"money": [
{
"isDeleted": false,
"instances": [
{
"endChar": 172,
"startChar": 163
}
],
"isCustom": false,
"name": "xxxxx",
"id": 0
}
],
"nationalities": [
{
"isDeleted": false,
"instances": [
{
"endChar": 1284,
"startChar": 1275
}
],
"isCustom": false,
"name": "Republish",
"id": 0
}
],
"ordinals": [
{
"isDeleted": false,
"instances": [
{
"endChar": 2812,
"startChar": 2807
},
{
"endChar": 2851,
"startChar": 2846
}
],
"isCustom": false,
"name": "xxxxx",
"id": 0
}
],
"people": [
{
"isDeleted": false,
"instances": [
{
"endChar": 196,
"startChar": 188
},
{
"endChar": 350,
"startChar": 342
}
],
"isCustom": false,
"name": "xxxxx",
"id": 0
}
],
"percentages": [
{
"isDeleted": false,
"instances": [
{
"endChar": 196,
"startChar": 188
},
{
"endChar": 350,
"startChar": 342
}
],
"isCustom": false,
"name": "xxxxx",
"id": 0
}
],
"products": [
{
"isDeleted": false,
"instances": [
{
"endChar": 4930,
"startChar": 4926
}
],
"isCustom": false,
"name": "xxxxx",
"id": 0
}
],
"quantities": [
{
"isDeleted": false,
"instances": [
{
"endChar": 4930,
"startChar": 4926
}
],
"isCustom": false,
"name": "xxxxx",
"id": 0
}
],
"times": [
{
"isDeleted": false,
"instances": [
{
"endChar": 4930,
"startChar": 4926
}
],
"isCustom": false,
"name": "xxxxx",
"id": 0
}
],
"topics": []
},
"description": "xxxxx",
"tags": [
"tag1",
"tag2"
],
"text": "<strong class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>Hello, This is sample text</b>",
"rawText": "Hello, This is sample text",
"state": "processed",
"assignTo": "",
"remark": "",
"sentiment": [
{
"document": {
"Negative": 0.00000,
"Neutral": 0.00000,
"Positive": 0.00000
},
"sentences": [
{
"id": 1,
"instances": [],
"score": {
"compound": 0,
"neg": 0,
"neu": 1,
"pos": 0
},
"text": "Sentence 1"
},
{
"id": 2,
"instances": [],
"score": {
"compound": 0,
"neg": 0,
"neu": 1,
"pos": 0
},
"text": "Sentence 2"
},
{
"id": 3,
"instances": [],
"score": {
"compound": 0.7269,
"neg": 0.037,
"neu": 0.809,
"pos": 0.154
},
"text": "Sentence 3"
}
]
}
],
"createdAt": "2021-04-13T00:30:26.721Z",
"originalCreatedAt": "2021-04-13T00:30:26.721Z",
"name": "xxxxx"
}
}
get/text/insight/{mediaId}
Request
- Base URL: https://api.speakai.co/v1
- URL: https://api.speakai.co/v1/text/insight/{mediaId}
- Auth: API key in header x-speakai-key and API key in header x-access-token
Path parameters
mediaIdstring required
Response
OK
Changes
No recorded changes to this operation across all 2 revisions of this API.