Retrieve documents analysis

GET

/document/processed.{content_type}

This method retrieves analysis results for processed documents from Semantria. FAILED documents will have FAILED status in response. Semantria responds with limited amount of results per API call. If configuration ID provided, Semantria responds with the document, which were queued using the same configuration ID, in opposite Primary.

Request

Path Params

Query Params

Responses

🟢200Client request accepted and queued. Server responds with processed documents.

application/json

Body

🟢202Client request accepted, no processed documents found on the server.

🟠401Authentication failed.

🟠402Unauthorized. Limit of system calls is reached or subscription is expired.

🔴500Server side issue. Server may respond with the details in response body.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.semantria.com//document/processed.'

Response Example

200 - Example 1

{
    "auto_categories": [
        {
            "categories": [
                {
                    "strength_score": 0,
                    "title": "string",
                    "type": "string"
                }
            ],
            "sentiment_polarity": "negative",
            "sentiment_score": 0,
            "strength_score": 0,
            "title": "string",
            "type": "string"
        }
    ],
    "config_id": "string",
    "details": [
        {
            "is_imperative": true,
            "is_polar": true,
            "words": [
                {
                    "is_negated": true,
                    "sentiment_score": 0,
                    "stemmed": "string",
                    "tag": "string",
                    "title": "string",
                    "type": "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"
        }
    ],
    "id": "string",
    "intentions": [
        {
            "evidence_phrase": "string",
            "type": "string",
            "what": "string",
            "who": "string"
        }
    ],
    "job_id": "string",
    "language": "string",
    "language_score": 0,
    "model_sentiment": {
        "mixed_score": 0,
        "model_name": "string",
        "negative_score": 0,
        "neutral_score": 0,
        "positive_score": 0,
        "sentiment_polarity": "negative"
    },
    "opinions": [
        {
            "quotation": "string",
            "sentiment_polarity": "negative",
            "sentiment_score": 0,
            "speaker": 0,
            "topic": "string",
            "type": "named"
        }
    ],
    "phrases": [
        {
            "intensifying_phrase": "string",
            "is_intensified": true,
            "is_negated": true,
            "negating_phrase": "string",
            "sentiment_polarity": "negative",
            "sentiment_score": 0,
            "title": "string",
            "type": "string"
        }
    ],
    "relations": [
        {
            "confidence_score": 0,
            "entities": [
                {
                    "entity_type": "string",
                    "title": "string"
                }
            ],
            "extra": "string",
            "relation_type": "string",
            "type": "named"
        }
    ],
    "sentiment_polarity": "negative",
    "sentiment_score": 0,
    "source_text": "string",
    "status": "queued",
    "summary": "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"
        }
    ]
}

Modified at 2022-09-10 18:38:13

Queue batch of documents for analysis

Cancel document analysis