Queue collection for analysis

POST

/collection.{content_type}

This method queues collection of documents onto the server for analysis. Queued collection of documents analyzes in common context as entire thing. If unique configuration ID provided, Semantria uses settings of that configuration during analysis, in opposite the primary configuration uses. Collection IDs are unique in scope of configuration. If the same ID appears twice, Semantria overrides existing collection with the new Data

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.semantria.com//collection.' \
--header 'Content-Type: application/json' \
--data-raw 'null'

Response Example

200 - Example 1

{
    "documents": [
        "string"
    ],
    "id": "string",
    "job_id": "string",
    "tag": "string"
}

Request

Path Params

content_type

string

required

Query Params

config_id

string

optional

Identifier of configuration used for analysis.

Body Params application/json

No schema defined

Examples

Responses

🟢200Client request accepted and queued. Server responds with the sentiment-bearing phrases list.

application/json

Body

documents

array[string]

required

List of documents text that need to be analyzed by the service

string

required

Up to 32 symbols unique identifier of document assigned and tracked by client

job_id

string

required

Specific marker of incoming job that can be used then for collections retrieving

tag

string

required

Any text of up to 50 characters used like marker

🟢202Client request accepted and queued for processing.

🟠401Authentication failed.

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

🟠406Documents limit per collection is achieved.

🟠413Characters limit for single document exceeded.

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

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

Updates user categories

Retrieve collections analysis