Semantria
  1. ProcessingCollections
Semantria
  • Blacklist
    • Remove items from blacklist
      DELETE
    • Retrieve blacklisted items
      GET
    • Add items to blacklist
      POST
    • Update items in blacklist
      PUT
  • Categories
    • Remove user categories
      DELETE
    • Retrieve user categories
      GET
    • Add user categories
      POST
    • Updates user categories
      PUT
  • ProcessingCollections
    • Queue collection for analysis
      POST
    • Retrieve collections analysis
      GET
    • Cancel collection analysis
      DELETE
    • Retrieve collection analysis or its status in queue
      GET
  • Configuration
    • Remove user configurations
      DELETE
    • Retrieve user configurations
      GET
    • Create user configurations
      POST
    • Update user configurations
      PUT
  • ProcessingDocuments
    • Queue document for analysis
      POST
    • Queue batch of documents for analysis
      POST
    • Retrieve documents analysis
      GET
    • Cancel document analysis
      DELETE
    • Retrieve document analysis or its status in queue
      GET
  • Entities
    • Remove user entities
      DELETE
    • Retrieve user entities
      GET
    • Add user entities
      POST
    • Update user entities
      PUT
  • Features
    • Retrieve supported features
  • Phrases
    • Remove sentiment-bearing phrases
    • Retrieve sentiment-bearing phrases
    • Add sentiment-bearing phrases
    • Updates sentiment-bearing phrases
  • Queries
    • Remove queries
    • Retrieve queries
    • Add or update queries
    • Update queries
  • Statistics
    • Retrieve usage statistics
  • Status
    • Retrieve API status
  • Subscription
    • Retrieve subscription details
  • Taxonomy
    • Remove taxonomy nodes
    • Retrieve taxonomy
    • Add taxonomy nodes
    • Update taxonomy nodes
  1. ProcessingCollections

Retrieve collection analysis or its status in queue

GET
/collection/{collection_id}.{content_type}
This method retrieves analysis results for documents collection by its unique ID or the collection’s status in queue if it did not analyzed yet. Semantria guarantees delivering of all collections back to the client even if they FAILED on Semantria side due to some reason.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.semantria.com//collection/.'
Response Response Example
200 - Example 1
{
    "config_id": "string",
    "entities": [
        {
            "count": 0,
            "entity_type": "string",
            "label": "string",
            "mentions": [
                {
                    "is_negated": true,
                    "label": "string",
                    "locations": [
                        {
                            "index": 0,
                            "length": 0,
                            "offset": 0
                        }
                    ],
                    "negating_phrase": "string"
                }
            ],
            "negative_count": 0,
            "neutral_count": 0,
            "positive_count": 0,
            "title": "string",
            "type": "named"
        }
    ],
    "facets": [
        {
            "attributes": [
                {
                    "count": 0,
                    "label": "string",
                    "mentions": [
                        {
                            "is_negated": true,
                            "label": "string",
                            "locations": [
                                {
                                    "index": 0,
                                    "length": 0,
                                    "offset": 0
                                }
                            ],
                            "negating_phrase": "string"
                        }
                    ]
                }
            ],
            "count": 0,
            "label": "string",
            "mentions": [
                {
                    "is_negated": true,
                    "label": "string",
                    "locations": [
                        {
                            "index": 0,
                            "length": 0,
                            "offset": 0
                        }
                    ],
                    "negating_phrase": "string"
                }
            ],
            "negative_count": 0,
            "neutral_count": 0,
            "positive_count": 0
        }
    ],
    "id": "string",
    "job_id": "string",
    "status": "queued",
    "tag": "string",
    "taxonomy": [
        {
            "hitcount": 0,
            "id": "string",
            "sentiment_polarity": "negative",
            "sentiment_score": 0,
            "title": "string",
            "type": "concept"
        }
    ],
    "themes": [
        {
            "mentions": [
                {
                    "is_negated": true,
                    "label": "string",
                    "locations": [
                        {
                            "index": 0,
                            "length": 0,
                            "offset": 0
                        }
                    ],
                    "negating_phrase": "string"
                }
            ],
            "normalized": "string",
            "phrases_count": 0,
            "sentiment_polarity": "negative",
            "sentiment_score": 0,
            "stemmed": "string",
            "themes_count": 0,
            "title": "string"
        }
    ],
    "topics": [
        {
            "hitcount": 0,
            "id": "string",
            "sentiment_polarity": "negative",
            "sentiment_score": 0,
            "title": "string",
            "type": "concept"
        }
    ]
}

Request

Path Params
collection_id
string 
required
Collection ID
content_type
string 
required
Query Params
config_id
string 
optional
Identifier of configuration used for analysis.

Responses

🟢200Client request accepted. Server responds with processed document or its status.
application/json
Body
config_id
string 
required
Unique configuration identifier. Usually 36 alphanumeric characters
entities
array[object (Entity) {9}] 
required
Returns the named entities and user defined entities from the text
count
integer 
required
The count of occurrences of the entity across the documents
>= 0
entity_type
string 
required
Type of the entity (Company, Person, Place, Product, etc.)
label
string 
required
Descriptive label for the entity, if applicable
mentions
array[object (Mention) {4}] 
required
Returns the genuine forms of entity mentioned across the documents
negative_count
integer 
required
The count of negative occurrences of the entity across the documents
>= 0
neutral_count
integer 
required
The count of neutral occurrences of the entity across the documents
>= 0
positive_count
integer 
required
The count of positive occurrences of the entity across the documents
>= 0
title
string 
required
Normalized form of the entity. It is the normalized entity title
type
enum<string> 
required
Type of the entity; can be either “named” or “user” (reserved for future usage)
Allowed values:
nameduser
facets
array[object (Facet) {7}] 
required
Returns the facets extracted across all documents in the collection
attributes
array[object (Attribute) {3}] 
required
Returns the attributes associated with this facet
count
integer 
required
The count of occurrences of the facet in the text
>= 0
label
string 
required
The text of the facet
mentions
array[object (Mention) {4}] 
required
Returns genuine forms of facet mentioned across the documents
negative_count
integer 
required
The count of negative occurrences of the facet across the documents
>= 0
neutral_count
integer 
required
The count of neutral occurrences of the facet across the documents
>= 0
positive_count
integer 
required
The count of positive occurrences of the facet across the documents
>= 0
id
string 
required
Unique collection identifier. Can be up to 36 alphanumeric characters
job_id
string 
required
Specific marker of a job collection belongs to, can be used for collections ordering on client side.
status
enum<string> 
required
Status of the collection
Allowed values:
queuedprocessedfailed
tag
string 
required
Any text of up to 50 characters used like marker
taxonomy
array[object (Topic) {6}] 
required
Returns the taxonomy determined for the text
hitcount
integer 
required
The number of documents within the collection that match the topic
>= 0
id
string 
required
Unique topic identifier
sentiment_polarity
enum<string> 
required
Verbal representation of sentiment score. Can be "negative", "positive" or "neutral"
Allowed values:
negativepositiveneutral
sentiment_score
number <double>
required
The sentiment score for documents content associated with the topic
title
string 
required
The topic title, which is its label in the text
type
enum<string> 
required
Type of the topic; can be either "concept" or "query"
Allowed values:
conceptquery
themes
array[object (Theme) {8}] 
required
Returns themes across the documents
mentions
array[object (Mention) {4}] 
required
Returns the concept and query defined topics determined for the text
normalized
string 
required
The normalized form of the theme
phrases_count
integer 
required
Count of sentiment-bearing phrases was used in calculating theme's sentiment
>= 0
sentiment_polarity
enum<string> 
required
Verbal representation of sentiment score. Can be "negative", "positive" or "neutral"
Allowed values:
negativepositiveneutral
sentiment_score
number <double>
required
Sentiment score for theme’s sentences across the documents
stemmed
string 
required
The stemmed form of the theme
themes_count
integer 
required
Count of themes across the documents that got rolled into this one
>= 0
title
string 
required
The text of the theme across the documents
topics
array[object (Topic) {6}] 
required
Returns the concept and query defined topics determined for the text
hitcount
integer 
required
The number of documents within the collection that match the topic
>= 0
id
string 
required
Unique topic identifier
sentiment_polarity
enum<string> 
required
Verbal representation of sentiment score. Can be "negative", "positive" or "neutral"
Allowed values:
negativepositiveneutral
sentiment_score
number <double>
required
The sentiment score for documents content associated with the topic
title
string 
required
The topic title, which is its label in the text
type
enum<string> 
required
Type of the topic; can be either "concept" or "query"
Allowed values:
conceptquery
🟠401Authentication failed.
🟠402Unauthorized. Limit of system calls is reached or subscription is expired.
🟠404No collections with provided ID found on server.
🔴500Server side issue. Server may respond with the details in response body.
Modified at 2022-09-10 18:38:13
Previous
Cancel collection analysis
Next
Remove user configurations
Built with