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
  • Schemas
    • Schemas
      • Attribute
      • AutoCategory
      • BlacklistItem_InsertVersion
      • BlacklistItem_ResponseVersion
      • BlacklistItem_UpdateVersion
      • Category_InsertVersion
      • Category_ResponseVersion
      • Category_UpdateVersion
      • Collection
      • CollectionAnalyticData
      • ConfigurationCollectionSection
      • ConfigurationDocumentSection
      • Configuration_InsertVersion
      • Configuration_ResponseVersion
      • Configuration_UpdateVersion
      • Details
      • Document
      • DocumentAnalyticData
      • Entity
      • Entity_InsertVersion
      • Entity_ResponseVersion
      • Entity_UpdateVersion
      • Facet
      • Feature
      • FeatureDetailedModeSection
      • FeatureDiscoveryModeSection
      • FeatureSettingsSection
      • FeatureTemplateSection
      • Intention
      • JSON
      • Location
      • Mention
      • ModelSentiment
      • Opinion
      • Phrase
      • Phrase_InsertVersion
      • Phrase_ResponseVersion
      • Phrase_UpdateVersion
      • Query_InsertVersion
      • Query_ResponseVersion
      • Query_UpdateVersion
      • Relation
      • RelationEntity
      • Request class
      • Request_class
      • Statistic
      • StatisticConfiguration
      • Status
      • SubCategory
      • Subscription
      • SubscriptionBasicSection
      • SubscriptionBillingSection
      • SubscriptionFeatureSection
      • SubscriptionFeatureSectionCollection
      • SubscriptionFeatureSectionDocument
      • SubscriptionFeatureSectionTemplate
      • TaxonomyNode
      • TaxonomyNode_InsertVersion
      • TaxonomyNode_ResponseVersion
      • TaxonomyNode_UpdateVersion
      • TaxonomyTopic
      • Theme
      • Topic
      • Word
  1. ProcessingCollections

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

Path Params

Query Params

Body Params application/json

Examples

Responses

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

🟢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.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.semantria.com//collection.' \
--header 'Content-Type: application/json' \
--data-raw 'null'
Response Response Example
200 - Example 1
{
    "documents": [
        "string"
    ],
    "id": "string",
    "job_id": "string",
    "tag": "string"
}
Modified at 2022-09-10 18:38:13
Previous
Updates user categories
Next
Retrieve collections analysis
Built with