Semantria
  1. Configuration
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. Configuration

Retrieve user configurations

GET
/configurations.{content_type}
This method retrieves all user configurations available on Semantria side.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.semantria.com//configurations.'
Response Response Example
200 - Example 1
[
    {
        "auto_response": true,
        "callback": "string",
        "categories_threshold": 0,
        "chars_threshold": 0,
        "collection": {
            "attribute_mentions_limit": 0,
            "concept_topics_limit": 0,
            "facet_atts_limit": 0,
            "facet_mentions_limit": 0,
            "facets_limit": 0,
            "named_entities_limit": 0,
            "named_mentions_limit": 0,
            "query_topics_limit": 0,
            "theme_mentions_limit": 0,
            "themes_limit": 0,
            "user_entities_limit": 0,
            "user_mentions_limit": 0
        },
        "config_id": "string",
        "document": {
            "auto_categories_limit": 0,
            "concept_topics_limit": 0,
            "detect_language": true,
            "entity_themes_limit": 0,
            "intentions": true,
            "model_sentiment": true,
            "named_entities_limit": 0,
            "named_mentions_limit": 0,
            "named_opinions_limit": 0,
            "named_relations_limit": 0,
            "phrases_limit": 0,
            "pos_types": "All",
            "possible_phrases_limit": 0,
            "query_topics_limit": 0,
            "summary_limit": 0,
            "theme_mentions_limit": 0,
            "themes_limit": 0,
            "user_entities_limit": 0,
            "user_mentions_limit": 0,
            "user_opinions_limit": 0,
            "user_relations_limit": 0
        },
        "entities_threshold": 0,
        "from_template_config_id": "string",
        "is_primary": true,
        "language": "string",
        "modified": "string",
        "name": "string",
        "one_sentence": true,
        "process_html": true,
        "version": "string"
    }
]

Request

Path Params
content_type
string 
required

Responses

🟢200Client request accepted. Server responds with status object.
application/json
Body
array of:
auto_response
boolean 
required
Defines whether or not the service should respond with processed results automatically. Default: false
callback
string 
required
Defines a callback URL for automatic data responding
categories_threshold
number <double>
required
Defines low threshold for strength score of user categories to be reported in the output. Default: 0.45
chars_threshold
integer 
required
Defines the threshold for alphanumeric characters in the text in percent. Default: 80
>= 0<= 100
collection
object (ConfigurationCollectionSection) 
required
attribute_mentions_limit
integer 
required
Limits the number of mentions of attribute responded from the server. Default: 0
>= 0<= 20
concept_topics_limit
integer 
required
Limits the number of concept topics responded from the service. Default: 5
>= 0<= 20
facet_atts_limit
integer 
required
Limits the number of facets which will be responded from the server. Default: 5
>= 0<= 20
facet_mentions_limit
integer 
required
Limits the number of mentions of facet responded from the server. Default: 0
>= 0<= 20
facets_limit
integer 
required
Limits the number of facets which will be responded from the server. Default: 15
>= 0<= 20
named_entities_limit
integer 
required
Limits the number of named entities responded from the service. Default: 5
>= 0<= 20
named_mentions_limit
integer 
required
Limits the number of mentions of theme responded from the server. Default: 0
>= 0<= 20
query_topics_limit
integer 
required
Limits the number of query topics responded from the service. Default: 5
>= 0<= 20
theme_mentions_limit
integer 
required
Limits the number of entity mentions responded from the server. Default: 0
>= 0<= 20
themes_limit
integer 
required
Limits the number of themes responded from the service. Default: 5
>= 0<= 20
user_entities_limit
integer 
required
Limits the number of user entities the service responds. Default: 15
>= 0<= 20
user_mentions_limit
integer 
required
Limits the number of user entity mentions the service responds. Default: 0
>= 0<= 20
config_id
string 
required
Unique configuration identifier
document
object (ConfigurationDocumentSection) 
required
auto_categories_limit
integer 
required
Limits the number of auto categories the service responds. Default: 5
>= 0<= 20
concept_topics_limit
integer 
required
Limits the number of concept topics the service responds. Default: 5
>= 0<= 20
detect_language
boolean 
required
Switches on language detection feature. Default: true
entity_themes_limit
integer 
required
Limits the number of entity themes the service responds. Default: 0
>= 0<= 20
intentions
boolean 
required
Switches on intentions detection feature. Default: false
model_sentiment
boolean 
required
Switches on/off model-based sentiment feature. Default: false
named_entities_limit
integer 
required
Limits the number of named entities the service responds. Default: 5
>= 0<= 20
named_mentions_limit
integer 
required
Limits the number of named entity related mentions. Default: 0
>= 0<= 20
named_opinions_limit
integer 
required
Limits the number of named entity opinions the service responds. Default: 0
>= 0<= 20
named_relations_limit
integer 
required
Limits the number of named entity relations the service responds. Default: 0
>= 0<= 20
phrases_limit
integer 
required
Limits the number of responded sentiment-bearing phrases for document. Default: 0
>= 0<= 20
pos_types
enum<string> 
required
Defines parts-of-speech which will be responded by the server
Allowed values:
AllNounVerbAdjectiveDeterminerMiscTwitterChinese
possible_phrases_limit
integer 
required
Limits the number of responded possible phrases which may affect on sentiment score extraction. Default: 0
>= 0<= 20
query_topics_limit
integer 
required
Limits the number of query topics the service responds. Default: 5
>= 0<= 20
summary_limit
integer 
required
Limits the number of sentences for the document summary feature. Default: 3
>= 0<= 20
theme_mentions_limit
integer 
required
Limits the number of document and entity related theme mentions. Default: 0
>= 0<= 20
themes_limit
integer 
required
Limits the number of document themes the service responds. Default: 0
>= 0<= 20
user_entities_limit
integer 
required
Limits the number of user entities the service responds. Default: 5
>= 0<= 20
user_mentions_limit
integer 
required
Limits the number of user entity related mentions. Default: 0
>= 0<= 20
user_opinions_limit
integer 
required
Limits the number of concept topics the service responds. Default: 0
>= 0<= 20
user_relations_limit
integer 
required
Limits the number of user entity relations the service responds. Default: 0
>= 0<= 20
entities_threshold
integer 
required
Defines low threshold for evidence score of named and user entities to be reported in the output. Default: 55
from_template_config_id
string 
required
Unique identifier of configuration (template) the current configuration has been clonned from
is_primary
boolean 
required
Identifies whether the current configuration is primary or not. Default: false
language
string 
required
Defines target language that will be used for task processing. Default: English
modified
string 
required
The timestamp of the latest update of the record. Creation date of update didn't occur
name
string 
required
Configuration name
one_sentence
boolean 
required
Leads the service to consider the entire document as single sentence. Default: false
process_html
boolean 
required
Leads the service to clean HTML tags before processing. Default: false
version
string 
required
Version of the vertical pack, for versioning purposes
🟠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.
Modified at 2022-09-10 18:38:13
Previous
Remove user configurations
Next
Create user configurations
Built with