@datafire/semantria

Client library for Semantria

Installation and Usage

npm install --save @datafire/semantria

let semantria = require('@datafire/semantria').create();

.then(data => {
  console.log(data);
});

Description

Semantria applies Text and Sentiment Analysis to tweets, facebook posts, surveys, reviews or enterprise content.

Actions

deleteBlacklistItems

This method removes certain blacklisted items by their values on Semantria side.

semantria.deleteBlacklistItems({
  "Blacklisted item IDs": [],
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration blacklist items linked to.
- Blacklisted item IDs required array
  - items string
- content_type required string

Output

Output schema unknown

getBlacklist

This method retrieves all backlisted items available on Semantria side.

semantria.getBlacklist({
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration blacklist linked to.
- content_type required string

Output

output array
- items BlacklistItem_ResponseVersion

addBlacklist

This method adds new unique items to the backlist on Semantria side.

semantria.addBlacklist({
  "Blacklisted items": null,
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration blacklist linked to.
- Blacklisted items required Request%20class
- content_type required string

Output

output array
- items BlacklistItem_ResponseVersion

updateBlacklist

This method updates existing items by unique IDs in the backlist on Semantria side.

semantria.updateBlacklist({
  "Blacklisted items": null,
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration blacklist linked to.
- Blacklisted items required Request%20class
- content_type required string

Output

output array
- items BlacklistItem_ResponseVersion

deleteCategories

This method removes certain user categories by their IDs on Semantria side.

semantria.deleteCategories({
  "Category IDs": [],
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration user categories linked to.
- Category IDs required array
  - items string
- content_type required string

Output

Output schema unknown

getCategories

This method retrieves list of user categories available on Semantria side.

semantria.getCategories({
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration user categories linked to.
- content_type required string

Output

output array
- items Category_ResponseVersion

addCategories

This method adds user categories on Semantria side.

semantria.addCategories({
  "Categories": null,
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration user categories linked to.
- Categories required Request%20class
- content_type required string

Output

output array
- items Category_ResponseVersion

updateCategories

This method updates user categories by unique IDs on Semantria side.

semantria.updateCategories({
  "Categories": null,
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration user categories linked to.
- Categories required Request%20class
- content_type required string

Output

output array
- items Category_ResponseVersion

queueCollection

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

semantria.queueCollection({
  "Collection": null,
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration used for analysis.
- Collection required Request%20class
- content_type required string

Output

output Collection

retrieveProcessedCollections

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

semantria.retrieveProcessedCollections({
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration used for analysis.
- content_type required string

Output

output CollectionAnalyticData

cancelCollection

This method cancels collection analysis by unique ID on Semantria side if it is waiting for analysis in queue.

semantria.cancelCollection({
  "collection_id": "",
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration used for analysis.
- collection_id required string: Collection ID
- content_type required string

Output

Output schema unknown

receiveCollectionAnalyticData

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.

semantria.receiveCollectionAnalyticData({
  "collection_id": "",
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration used for analysis.
- collection_id required string: Collection ID
- content_type required string

Output

output CollectionAnalyticData

deleteConfigurations

This method removes certain configuration by unique ID on Semantria side.

semantria.deleteConfigurations({
  "Configuration IDs": [],
  "content_type": ""
}, context)

Input

input object
- Configuration IDs required array
  - items string
- content_type required string

Output

Output schema unknown

getConfigurations

This method retrieves all user configurations available on Semantria side.

semantria.getConfigurations({
  "content_type": ""
}, context)

Input

input object
- content_type required string

Output

output array
- items Configuration_ResponseVersion

addConfigurations

This method creates configurations on Semantria side.

semantria.addConfigurations({
  "Configurations": null,
  "content_type": ""
}, context)

Input

input object
- Configurations required Request%20class
- content_type required string

Output

output array
- items Configuration_ResponseVersion

updateConfigurations

This method updates specific configurations by unique IDs on Semantria side.

semantria.updateConfigurations({
  "Configurations": null,
  "content_type": ""
}, context)

Input

input object
- Configurations required Request%20class
- content_type required string

Output

output array
- items Configuration_ResponseVersion

queueDocument

This method queues document onto the server for analysis. Queued document analyzes individually and will have its own set of results. If unique configuration ID provided, Semantria uses settings of that configuration during analysis, in opposite the primary configuration uses. Document IDs are unique in scope of configuration. If the same ID appears twice, Semantria overrides existing document with the new Data.

semantria.queueDocument({
  "Document": null,
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration used for analysis.
- Document required Request%20class
- content_type required string

Output

output Document

queueBatchOfDocuments

This method queues batch of documents for analysis. The rules are the same as for single document mode but here the documents ordered into the batch.

semantria.queueBatchOfDocuments({
  "Batch of Documents": null,
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration used for analysis.
- Batch of Documents required Request%20class
- content_type required string

Output

output Document

retrieveProcessedDocuments

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.

semantria.retrieveProcessedDocuments({
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration used for analysis.
- content_type required string

Output

output DocumentAnalyticData

cancelDocument

This method cancels document analysis by unique ID on Semantria side if it is waiting for analysis in queue.

semantria.cancelDocument({
  "document_id": "",
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration used for analysis.
- document_id required string: Document ID
- content_type required string

Output

Output schema unknown

receiveDocumentAnalyticData

This method retrieves analysis results for the single document by its unique ID or the document’s status in queue if it did not analyzed yet. Semantria guarantees delivering of all documents back to the client even if they FAILED on Semantria side due to some reason.

semantria.receiveDocumentAnalyticData({
  "document_id": "",
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration used for analysis.
- document_id required string: Document ID
- content_type required string

Output

output DocumentAnalyticData

deleteEntities

This method removes certain user entities by their names on Semantria side.

semantria.deleteEntities({
  "content_type": ""
}, context)

Input

input object
- content_type required string

Output

Output schema unknown

getEntities

This method retrieves list of user entities available on Semantria side.

semantria.getEntities({
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration user entities linked to.
- content_type required string

Output

output array
- items Entity_ResponseVersion

addEntities

This method adds user entities on Semantria side.

semantria.addEntities({
  "User entities": null,
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration user entities linked to.
- User entities required Request%20class
- content_type required string

Output

output array
- items Entity_ResponseVersion

updateEntities

This method updates user entities by unique IDs on Semantria side.

semantria.updateEntities({
  "User entities": null,
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration user entities linked to.
- User entities required Request%20class
- content_type required string

Output

output array
- items Entity_ResponseVersion

getFeatures

This method returns list of supported features per languages supported by Semantria API. Let the users know about API capabilities.

semantria.getFeatures({
  "content_type": ""
}, context)

Input

input object
- language string: Filter features by specified language
- content_type required string

Output

output array
- items Feature

deletePhrases

This method removes certain sentiment-bearing phrases by their names on Semantria side.

semantria.deletePhrases({
  "Sentiment phrase IDs": [],
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration phrases linked to.
- Sentiment phrase IDs required array
  - items string
- content_type required string

Output

Output schema unknown

getPhrases

This method retrieves list of sentiment-bearing phrases available on Semantria side.

semantria.getPhrases({
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration phrases linked to.
- content_type required string

Output

output array
- items Phrase_ResponseVersion

addPhrases

This method adds sentiment-bearing phrases on Semantria side.

semantria.addPhrases({
  "Sentiment phrases": null,
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration phrases linked to.
- Sentiment phrases required Request%20class
- content_type required string

Output

output array
- items Phrase_ResponseVersion

updatePhrases

This method updates sentiment-bearing phrases by unique IDs on Semantria side.

semantria.updatePhrases({
  "Sentiment phrases": null,
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration phrases linked to.
- Sentiment phrases required Request%20class
- content_type required string

Output

output array
- items Phrase_ResponseVersion

deleteQueries

This method removes certain queries by their IDs on Semantria side.

semantria.deleteQueries({
  "Query IDs": [],
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration queries linked to.
- Query IDs required array
  - items string
- content_type required string

Output

Output schema unknown

getQueries

This method retrieves list of queries available on Semantria side.

semantria.getQueries({
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration queries linked to.
- content_type required string

Output

output array
- items Query_ResponseVersion

addQueries

This method adds queries on Semantria side.

semantria.addQueries({
  "Queries": null,
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration queries linked to.
- Queries required Request%20class
- content_type required string

Output

output array
- items Query_ResponseVersion

updateQueries

This method updates queries by unique IDs on Semantria side.

semantria.updateQueries({
  "Queries": null,
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration queries linked to.
- Queries required Request%20class
- content_type required string

Output

output array
- items Query_ResponseVersion

getStatistic

This method retrieves overall and per configuration usage statistics for specific timeframe. Statistics ordered per available configurations. Available interval values are current hour, day, week, month and year.

semantria.getStatistic({
  "content_type": ""
}, context)

Input

input object
- config_id string: Configuration identifier for usage statistics retrieving.
- interval string: Hour, Day, Week, Month, Year values are supported.
- content_type required string

Output

output Statistic

getStatus

This method retrieves API status information such as the app version, current API version, supported languages and encodings, the overall service status, etc.

semantria.getStatus({
  "content_type": ""
}, context)

Input

input object
- content_type required string

Output

output Status

getSubscription

This method retrieves user's subscription details that consist of the list of allowed features, configured limits and options on Semantria side.

semantria.getSubscription({
  "content_type": ""
}, context)

Input

input object
- content_type required string

Output

output Subscription

deleteTaxonomy

This method removes certain taxonomy nodes by their IDs on Semantria side.

semantria.deleteTaxonomy({
  "Taxonomy node IDs": [],
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration queries linked to.
- Taxonomy node IDs required array
  - items string
- content_type required string

Output

Output schema unknown

getTaxonomy

This method retrieves list of taxonomy available on Semantria side.

semantria.getTaxonomy({
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration taxonomy linked to.
- content_type required string

Output

output array
- items TaxonomyNode_ResponseVersion

addTaxonomy

This method adds taxonomy nodes on Semantria side.

semantria.addTaxonomy({
  "Taxonomy": null,
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration queries linked to.
- Taxonomy required Request%20class
- content_type required string

Output

output array
- items TaxonomyNode_ResponseVersion

updateTaxonomy

This method updates taxonomy nodes on Semantria side.

semantria.updateTaxonomy({
  "Taxonomy": null,
  "content_type": ""
}, context)

Input

input object
- config_id string: Identifier of configuration queries linked to.
- Taxonomy required Request%20class
- content_type required string

Output

output array
- items TaxonomyNode_ResponseVersion

Definitions

Attribute

Attribute object
- count required integer: The count of occurrences of the attribute across the documents
- label required string: The text of the attribute
- mentions required array: Returns genuine forms of attribute mentioned across the documents
  - items Mention

AutoCategory

AutoCategory object
- categories required array: List of sub-categories of the current category if applicable
  - items SubCategory
- sentiment_polarity required string (values: negative, positive, neutral): Verbal representation of sentiment score. Can be "negative", "positive" or "neutral"
- sentiment_score required number: The sentiment score associated with this category
- strength_score required number: Strength of the category matches with the document content
- title required string: The category title, which is its label in the text
- type required string: Type of category; can be either "node" (root level) or "leaf" (nested) value

BlacklistItem_InsertVersion

BlacklistItem_InsertVersion object
- name required string: Blacklist item name

BlacklistItem_ResponseVersion

BlacklistItem_ResponseVersion object
- id required string: Unique blacklist item identifier
- modified required string: The timestamp of the latest update of the record. Creation date of update didn't occur
- name required string: Blacklist item name

BlacklistItem_UpdateVersion

BlacklistItem_UpdateVersion object
- id required string: Unique blacklist item identifier
- name required string: Blacklist item name

Category_InsertVersion

Category_InsertVersion object
- name required string: Category name
- samples required array: Category samples
  - items string
- weight required number: Category weight

Category_ResponseVersion

Category_ResponseVersion object
- id required string: Unique category identifier
- modified required string: The timestamp of the latest update of the record. Creation date of update didn't occur
- name required string: Category name
- samples required array: Category samples
  - items string
- weight required number: Category weight

Category_UpdateVersion

Category_UpdateVersion object
- id required string: Unique category identifier
- name required string: Category name
- samples required array: Category samples
  - items string
- weight required number: Category weight

Collection

Collection object
- documents required array: List of documents text that need to be analyzed by the service
  - items string
- id required string: Up to 32 symbols unique identifier of document assigned and tracked by client
- job_id required string: Specific marker of incoming job that can be used then for collections retrieving
- tag required string: Any text of up to 50 characters used like marker

CollectionAnalyticData

CollectionAnalyticData object
- config_id required string: Unique configuration identifier. Usually 36 alphanumeric characters
- entities required array: Returns the named entities and user defined entities from the text
  - items Entity
- facets required array: Returns the facets extracted across all documents in the collection
  - items Facet
- id required string: Unique collection identifier. Can be up to 36 alphanumeric characters
- job_id required string: Specific marker of a job collection belongs to, can be used for collections ordering on client side.
- status required string (values: queued, processed, failed): Status of the collection
- tag required string: Any text of up to 50 characters used like marker
- taxonomy required array: Returns the taxonomy determined for the text
  - items Topic
- themes required array: Returns themes across the documents
  - items Theme
- topics required array: Returns the concept and query defined topics determined for the text
  - items Topic

ConfigurationCollectionSection

ConfigurationCollectionSection object
- attribute_mentions_limit required integer: Limits the number of mentions of attribute responded from the server. Default: 0
- concept_topics_limit required integer: Limits the number of concept topics responded from the service. Default: 5
- facet_atts_limit required integer: Limits the number of facets which will be responded from the server. Default: 5
- facet_mentions_limit required integer: Limits the number of mentions of facet responded from the server. Default: 0
- facets_limit required integer: Limits the number of facets which will be responded from the server. Default: 15
- named_entities_limit required integer: Limits the number of named entities responded from the service. Default: 5
- named_mentions_limit required integer: Limits the number of mentions of theme responded from the server. Default: 0
- query_topics_limit required integer: Limits the number of query topics responded from the service. Default: 5
- theme_mentions_limit required integer: Limits the number of entity mentions responded from the server. Default: 0
- themes_limit required integer: Limits the number of themes responded from the service. Default: 5
- user_entities_limit required integer: Limits the number of user entities the service responds. Default: 15
- user_mentions_limit required integer: Limits the number of user entity mentions the service responds. Default: 0

ConfigurationDocumentSection

ConfigurationDocumentSection object
- auto_categories_limit required integer: Limits the number of auto categories the service responds. Default: 5
- concept_topics_limit required integer: Limits the number of concept topics the service responds. Default: 5
- detect_language required boolean: Switches on language detection feature. Default: true
- entity_themes_limit required integer: Limits the number of entity themes the service responds. Default: 0
- intentions required boolean: Switches on intentions detection feature. Default: false
- model_sentiment required boolean: Switches on/off model-based sentiment feature. Default: false
- named_entities_limit required integer: Limits the number of named entities the service responds. Default: 5
- named_mentions_limit required integer: Limits the number of named entity related mentions. Default: 0
- named_opinions_limit required integer: Limits the number of named entity opinions the service responds. Default: 0
- named_relations_limit required integer: Limits the number of named entity relations the service responds. Default: 0
- phrases_limit required integer: Limits the number of responded sentiment-bearing phrases for document. Default: 0
- pos_types required string (values: All, Noun, Verb, Adjective, Determiner, Misc, Twitter, Chinese): Defines parts-of-speech which will be responded by the server
- possible_phrases_limit required integer: Limits the number of responded possible phrases which may affect on sentiment score extraction. Default: 0
- query_topics_limit required integer: Limits the number of query topics the service responds. Default: 5
- summary_limit required integer: Limits the number of sentences for the document summary feature. Default: 3
- theme_mentions_limit required integer: Limits the number of document and entity related theme mentions. Default: 0
- themes_limit required integer: Limits the number of document themes the service responds. Default: 0
- user_entities_limit required integer: Limits the number of user entities the service responds. Default: 5
- user_mentions_limit required integer: Limits the number of user entity related mentions. Default: 0
- user_opinions_limit required integer: Limits the number of concept topics the service responds. Default: 0
- user_relations_limit required integer: Limits the number of user entity relations the service responds. Default: 0

Configuration_InsertVersion

Configuration_InsertVersion object
- auto_response required boolean: Defines whether or not the service should respond with processed results automatically. Default: false
- callback required string: Defines a callback URL for automatic data responding
- categories_threshold required number: Defines low threshold for strength score of user categories to be reported in the output. Default: 0.45
- chars_threshold required integer: Defines the threshold for alphanumeric characters in the text in percent. Default: 80
- collection required ConfigurationCollectionSection
- document required ConfigurationDocumentSection
- entities_threshold required integer: Defines low threshold for evidence score of named and user entities to be reported in the output.
- is_primary required boolean: Identifies whether the current configuration is primary or not. Default: false
- language required string: Defines target language that will be used for task processing. Default: English
- name required string: Configuration name
- one_sentence required boolean: Leads the service to consider the entire document as single sentence. Default: false
- process_html required boolean: Leads the service to clean HTML tags before processing. Default: false

Configuration_ResponseVersion

Configuration_ResponseVersion object
- auto_response required boolean: Defines whether or not the service should respond with processed results automatically. Default: false
- callback required string: Defines a callback URL for automatic data responding
- categories_threshold required number: Defines low threshold for strength score of user categories to be reported in the output. Default: 0.45
- chars_threshold required integer: Defines the threshold for alphanumeric characters in the text in percent. Default: 80
- collection required ConfigurationCollectionSection
- config_id required string: Unique configuration identifier
- document required ConfigurationDocumentSection
- entities_threshold required integer: Defines low threshold for evidence score of named and user entities to be reported in the output. Default: 55
- from_template_config_id required string: Unique identifier of configuration (template) the current configuration has been clonned from
- is_primary required boolean: Identifies whether the current configuration is primary or not. Default: false
- language required string: Defines target language that will be used for task processing. Default: English
- modified required string: The timestamp of the latest update of the record. Creation date of update didn't occur
- name required string: Configuration name
- one_sentence required boolean: Leads the service to consider the entire document as single sentence. Default: false
- process_html required boolean: Leads the service to clean HTML tags before processing. Default: false
- version required string: Version of the vertical pack, for versioning purposes

Configuration_UpdateVersion

Configuration_UpdateVersion object
- auto_response required boolean: Defines whether or not the service should respond with processed results automatically. Default: false
- callback required string: Defines a callback URL for automatic data responding
- categories_threshold required number: Defines low threshold for strength score of user categories to be reported in the output. Default: 0.45
- chars_threshold required integer: Defines the threshold for alphanumeric characters in the text in percent. Default: 80
- collection required ConfigurationCollectionSection
- config_id required string: Unique configuration identifier
- document required ConfigurationDocumentSection
- entities_threshold required integer: Defines low threshold for evidence score of named and user entities to be reported in the output. Default: 55
- is_primary required boolean: Identifies whether the current configuration is primary or not. Default: false
- language required string: Defines target language that will be used for task processing. Default: English
- name required string: Configuration name
- one_sentence required boolean: Leads the service to consider the entire document as single sentence. Default: false
- process_html required boolean: Leads the service to clean HTML tags before processing. Default: false

Details

Details object
- is_imperative required boolean: Represents whether sentence (group of words) is imperative or not
- is_polar required boolean: Represents whether or not sentence content contains sentiment polarity
- words required array: Returns list of words grouped by the parent sentence
  - items Word

Document

Document object
- id required string: Up to 32 symbols unique identifier of document assigned and tracked by client.
- job_id required string: Specific marker of incoming job that can be used then for documents retrieving
- tag required string: Any text of up to 50 characters used like marker.
- text required string: Document text that needs to be analyzed by the service.

DocumentAnalyticData

DocumentAnalyticData object
- auto_categories required array: Auto-generated categories applicable for the document
  - items AutoCategory
- config_id required string: Unique configuration identifier. Usually 36 alphanumeric characters
- details required array: Returns sentences from the original document with POS tags within
  - items Details
- entities required array: Returns the named entities and user defined entities from the text
  - items Entity
- id required string: Unique document identifier. Can be up to 36 alphanumeric characters
- intentions required array: Returns intentions list detected by the engine
  - items Intention
- job_id required string: Specific marker of a job document belongs to, can be used for documents ordering on client side
- language required string: Determined language of source text
- language_score required number: The percentage score of the best match of language among detected languages
- model_sentiment required ModelSentiment
- opinions required array: Returns the list of opinions extracted from the source text
  - items Opinion
- phrases required array: Returns sentiment-bearing phrases of the document
  - items Phrase
- relations required array: Returns relations which represent a connection between one or more Entity objects
  - items Relation
- sentiment_polarity required string (values: negative, positive, neutral): Verbal representation of sentiment score. Can be "negative", "positive" or "neutral"
- sentiment_score required number: A sentiment analysis of the document text
- source_text required string: Original source text passed by client for this document
- status required string (values: queued, processed, failed): Status of the document
- summary required string: A summary of the document text
- taxonomy required array: Returns the taxonomy determined for the text
  - items Topic
- themes required array: Returns themes of the document
  - items Theme
- topics required array: Returns the concept and query defined topics determined for the text
  - items Topic

Entity

Entity object
- count required integer: The count of occurrences of the entity across the documents
- entity_type required string: Type of the entity (Company, Person, Place, Product, etc.)
- label required string: Descriptive label for the entity, if applicable
- mentions required array: Returns the genuine forms of entity mentioned across the documents
  - items Mention
- negative_count required integer: The count of negative occurrences of the entity across the documents
- neutral_count required integer: The count of neutral occurrences of the entity across the documents
- positive_count required integer: The count of positive occurrences of the entity across the documents
- title required string: Normalized form of the entity. It is the normalized entity title
- type required string (values: named, user): Type of the entity; can be either “named” or “user” (reserved for future usage)

Entity_InsertVersion

Entity_InsertVersion object
- label required string: Descriptive label for the entity, e.g. Wikipedia URL
- name required string: Entity name
- normalized required string: Normalized form of the entity. Will replace entity name in the output
- type required string: Type of the entity (Company, Person, any custom type)

Entity_ResponseVersion

Entity_ResponseVersion object
- id required string: Unique user entity identifier
- label required string: Descriptive label for the entity, e.g. Wikipedia URL
- modified required string: The timestamp of the latest update of the record. Creation date of update didn't occur
- name required string: Entity name
- normalized required string: Normalized form of the entity. Will replace entity name in the output
- type required string: Type of the entity (Company, Person, any custom type)

Entity_UpdateVersion

Entity_UpdateVersion object
- id required string: Unique user entity identifier
- label required string: Descriptive label for the entity, e.g. Wikipedia URL
- name required string: Entity name
- normalized required string: Normalized form of the entity. Will replace entity name in the output
- type required string: Type of the entity (Company, Person, any custom type)

Facet object
- attributes required array: Returns the attributes associated with this facet
  - items Attribute
- count required integer: The count of occurrences of the facet in the text
- label required string: The text of the facet
- mentions required array: Returns genuine forms of facet mentioned across the documents
  - items Mention
- negative_count required integer: The count of negative occurrences of the facet across the documents
- neutral_count required integer: The count of neutral occurrences of the facet across the documents
- positive_count required integer: The count of positive occurrences of the facet across the documents

Feature

Feature object
- detailed_mode required FeatureDetailedModeSection
- discovery_mode required FeatureDiscoveryModeSection
- html_processing required boolean: Represents whether HTML processing supported for certain language or not
- id required string: Unique language identifier
- language required string: Represents language following options relevant to
- one_sentence_mode required boolean: Considers entire text as one sentence and uses optimized chunker for short content like tweets.
- settings required FeatureSettingsSection
- templates required FeatureTemplateSection

FeatureDetailedModeSection

FeatureDetailedModeSection object
- auto_categories required boolean: Represents whether auto-categories of entities supported for certain language or not
- entity_mentions required boolean: Represents whether mentions of entities supported for certain language or not
- entity_opinions required boolean: Represents whether opinions of entities supported for certain language or not
- entity_relations required boolean: Represents whether relations of entities supported for certain language or not
- entity_themes required boolean: Represents whether themes of entities supported for certain language or not
- intentions required boolean: Represents whether intentions detection supported for certain language or not
- language_detection required boolean: Represents whether language detection feature supported or not
- model_sentiment required boolean: Represents whether model-based sentiment supported for certain language or not
- named_entities required boolean: Represents whether named entities extraction supported for certain language or not
- pos_tagging required boolean: Represents whether POS tagging supported for certain language or not
- queries required boolean: Represents whether queries of entities supported for certain language or not
- sentiment required boolean: Represents whether sentiment detection supported for certain language or not
- sentiment_phrases required boolean: Represents whether sentiment phrases detection supported for certain language or not
- summarization required boolean: Represents whether summarization supported for certain language or not
- taxonomy required boolean: Represents whether taxonomy feature supported for certain language or not
- theme_mentions required boolean: Represents whether mentions of themes supported for certain language or not
- themes required boolean: Represents whether themes extraction supported for certain language or not
- user_categories required boolean: Represents whether user categories of entities supported for certain language or not
- user_entities required boolean: Represents whether user entities extraction supported for certain language or not

FeatureDiscoveryModeSection

FeatureDiscoveryModeSection object
- entity_mentions required boolean: Represents whether mentions of entities supported for certain language or not
- facet_attributes required boolean: Represents whether attributes of facets supported for certain language or not
- facet_mentioins required boolean: Represents whether mentions of facets supported for certain language or not
- facets required boolean: Represents whether facets detection supported for certain language or not
- named_entities required boolean: Represents whether named entities extraction supported for certain language or not
- queries required boolean: Represents whether queries extraction supported for certain language or not
- taxonomy required boolean: Represents whether taxonomy feature supported for certain language or not
- theme_mentions required boolean: Represents whether mentions of themes supported for certain language or not
- themes required boolean: Represents whether themes extraction supported for certain language or not
- user_categories required boolean: Represents whether user categories extraction supported for certain language or not
- user_entities required boolean: Represents whether user entities extraction supported for certain language or not

FeatureSettingsSection

FeatureSettingsSection object
- blacklist required boolean: Represents whether blacklist feature supported for certain language or not
- queries required boolean: Represents whether queries definition supported for certain language or not
- sentiment_phrases required boolean: Represents whether sentiment-bearing phrases adjustmment supported for certain language or not
- taxonomy required boolean: Represents whether taxonomy feature supported for certain language or not
- user_categories required boolean: Represents whether user categories definition supported for certain language or not
- user_entities required boolean: Represents whether user entities definition supported for certain language or not

FeatureTemplateSection

FeatureTemplateSection object
- config_id required string: Unique identifier of configuration associated with the vertical pack. Required for cloning
- description required string: Verbal description of template features, belonging to domain area, etc.
- id required string: Unique document identifier. Can be up to 36 alphanumeric characters
- is_free required boolean: Shows whether Vertical pack is free or requires subscription
- language required string: The language supported by the vertical pack
- name required string: Name of the vertical pack
- type required string (values: language-default, vertical-pack): The type of the vertical pack, can be either "vertical-pack" or "language-default"
- version required string: Version of the vertical pack, for versioning purposes.

Intention

Intention object
- evidence_phrase required string: The phrase which expressed the intention
- type required string: The classification of the intention detected (buy, quit, etc.)
- what required string: The object of the intention (if detected)
- who required string: The author of the intention (if detected)

JSON

Location

Location object
- index required integer: Document index within collection where the mention appeared
- length required integer: The length of the mention in bytes
- offset required integer: The amount of bytes offset in the original text before the start of the mention

Mention

Mention object
- is_negated required boolean: Indicates whether or not the mention has been negated
- label required string: The text of the attribute mention
- locations required array: List of coordinates of the mentions found within the collection
  - items Location
- negating_phrase required string: If the mention has been negated, this gives the negating phrase

ModelSentiment

ModelSentiment object
- mixed_score required number: Mixed sentiment score associated with the document
- model_name required string: Name of the sentiment model used for scoring
- negative_score required number: Negative (probable negative score) sentiment score associated with the document
- neutral_score required number: Neutral (probable neutral score) sentiment score associated with the document
- positive_score required number: Positive (probable positive score) sentiment score associated with the document
- sentiment_polarity required string (values: negative, positive, neutral): Verbal representation of sentiment score that matches the best on the document. Can be "negative", "positive" or "neutral"

Opinion

Opinion object
- quotation required string: The text of the expressed opinion
- sentiment_polarity required string (values: negative, positive, neutral): Verbal representation of sentiment score. Can be "negative", "positive" or "neutral"
- sentiment_score required number: The sentiment score associated with the opinion
- speaker required number: An entity title identifying the author of the opinion
- topic required string: An entity title identifying the subject of the opinion, if applicable
- type required string (values: named, user): Type of opinion according to extracted entity

Phrase

Phrase object
- intensifying_phrase required string: If the phrase has been intensified, this gives the intensifying phrase
- is_intensified required boolean: Specifies whether the phrase has been intensified or not
- is_negated required boolean: Specifies whether the phrase has been negated or not
- negating_phrase required string: If the phrase has been negated, this gives the negating phrase
- sentiment_polarity required string (values: negative, positive, neutral): Verbal representation of sentiment score. Can be "negative", "positive" or "neutral"
- sentiment_score required number: The sentiment score associated with this phrase
- title required string: The text of the sentiment-bearing phrase
- type required string: Type of phrase; can be either "possible" or "detected" value

Phrase_InsertVersion

Phrase_InsertVersion object
- name required string: Sentiment-bearing phrase name
- weight required number: Sentiment-bearing phrase weight

Phrase_ResponseVersion

Phrase_ResponseVersion object
- id required string: Unique sentiment-bearing phrase identifier
- modified required string: The timestamp of the latest update of the record. Creation date of update didn't occur
- name required string: Sentiment-bearing phrase name
- weight required number: Sentiment-bearing phrase weight

Phrase_UpdateVersion

Phrase_UpdateVersion object
- id required string: Unique sentiment-bearing phrase identifier
- name required string: Sentiment-bearing phrase name
- weight required number: Sentiment-bearing phrase weight

Query_InsertVersion

Query_InsertVersion object
- name required string: Query name
- query required string: Boolean query used for content categorization

Query_ResponseVersion

Query_ResponseVersion object
- id required string: Unique query identifier
- modified required string: The timestamp of the latest update of the record. Creation date of update didn't occur
- name required string: Query name
- query required string: Boolean query used for content categorization

Query_UpdateVersion

Query_UpdateVersion object
- id required string: Unique query identifier
- name required string: Query name
- query required string: Boolean query used for content categorization

Relation

Relation object
- confidence_score required number: A measure of confidence in the relationship extraction
- entities required array: Returns entities which presents parent relationship
  - items RelationEntity
- extra required string: Extra information that has been extracted about the relationship
- relation_type required string: A label describing the nature of the relationship
- type required string (values: named, user): Type of relation according to extracted entities

RelationEntity

RelationEntity object
- entity_type required string: Type of the entity (Company, Person, Place, Product, etc.)
- title required string: Normalized entity title based on existing entity normalization rules

Request class

Request_class

Statistic

Statistic object
- calls_data required integer: Total number of data API calls made. These affect you API balance
- calls_polling required integer: Total number of polling API calls made. These do not affect API balance
- calls_settings required integer: Total number of settings API calls made. These do not affect API balance
- colls_documents required integer: Total number of documents that have been queued into collections
- colls_failed required integer: Total number of collections that have failed to be processed
- colls_processed required integer: Total numbers of collections that have been successfully processed
- colls_responded required integer: Total number of successfully processed collections that have been returned
- configurations required array: Includes statistics per specific configuration
  - items StatisticConfiguration
- docs_failed required integer: Total number of documents that have failed to be processed
- docs_processed required integer: Total number of documents that have been successfully processed
- docs_responded required integer: Total number of successfully processed documents that have been returned
- latest_used_app required string: The latest application that used the API on this account
- name required string: Semantria subscriber name. Usually email
- overall_batches required integer: Total number of queued batches of texts processed
- overall_calls required integer: Total number of API calls made
- overall_docs required integer: Total number of documents that have been queued
- overall_exceeded required integer: Total number of documents that have exceeded the favorable (suggested) limit
- overall_texts required integer: Total number of texts processed
- overcall_colls required integer: Total numbers of collections that have been queued
- status required string: Semantria subscriber status. Can be active, expired, disabled, etc
- used_apps required string: A list of all the applications that have used the API on this account

StatisticConfiguration

StatisticConfiguration object
- calls_data required integer: Total number of data API calls made. These affect you API balance
- calls_polling required integer: Total number of polling API calls made. These do not affect API balance
- calls_settings required integer: Total number of settings API calls made. These do not affect API balance
- colls_failed required integer: Total number of collections that have failed to be processed
- colls_processed required integer: Total numbers of collections that have been successfully processed
- colls_responded required integer: Total number of successfully processed collections that have been returned
- config_id required string: Unique identifier of configuration
- docs_failed required integer: Total number of documents that have failed to be processed
- docs_processed required integer: Total number of documents that have been successfully processed
- docs_responded required integer: Total number of successfully processed documents that have been returned
- latest_used_app required string: The latest application that used the API on this account
- name required string: The name of configuration
- overall_batches required integer: Total number of queued batches of texts processed
- overall_calls required integer: Total number of API calls made
- overall_docs required integer: Total number of documents that have been queued
- overall_exceeded required integer: Total number of documents that have exceeded the favorable (suggested) limit
- overall_texts required integer: Total number of texts processed
- overcall_colls required integer: Total numbers of collections that have been queued
- used_apps required string: A list of all the applications that have used the API on this account

Status

Status object
- api_version required string: Represents current version of the exposed API
- service_status required string (values: available, pending, sold): Represents the availability of the service
- service_version required string: Represents current version of the Semantria service
- supported_compression required string: Exposes supported compression algorithms. Currently only gzip and deflate are supported
- supported_encoding required string: Exposes supported content encoding. Currently only UTF-8 is supported
- supported_languages required array: Exposes list of supported languages
  - items string

SubCategory

SubCategory object
- strength_score required number: Strength of the category matches with the document content
- title required string: The category title, which is its label in the text
- type required string: Type of category; can be either "node" (root level) or "leaf" (nested) value

Subscription

Subscription object
- basic_settings required SubscriptionBasicSection
- billing_settings required SubscriptionBillingSection
- feature_settings required SubscriptionFeatureSection
- name required string: Semantria subscriber name. Usually email
- status required string: Semantria subscriber status. Can be active, expired, disabled, etc

SubscriptionBasicSection

SubscriptionBasicSection object
- auto_response_limit required integer: Represents the maximum size of outgoing batch for auto-response feature
- batch_limit required integer: Represents the maximum size of the incoming batch in documents
- blacklist_limit required integer: Represents the maximum number of allowed blacklist items
- callback_batch_limit required integer: Represents the maximum size of outgoing batch for callback data retrieving mode
- categories_limit required integer: Represents the maximum number of allowed categories
- category_samples_limit required integer: Represents the maximum number of allowed category samples
- characters_limit required integer: Represents the maximum length of the document allowed for processing
- collection_limit required integer: Represents the maximum size of collection in documents
- configurations_limit required integer: Represents the maximum number of allowed configurations
- entities_limit required integer: Represents the maximum number of allowed entities
- output_data_limit required integer: Represent the maximum number allowed as output limit of configuration
- processed_batch_limit required integer: Represents the maximum size of outgoing batch for pulling data retrieving mode
- queries_limit required integer: Represents the maximum number of allowed queries
- return_source_text required boolean: Indicates whether responding of source text along with the analysis data is allowed or not
- sentiment_limit required integer: Represents the maximum number of allowed sentiment-bearing phrases

SubscriptionBillingSection

SubscriptionBillingSection object
- app_seats_allocated required integer: Number of allocated application cells permitted to work with the API
- app_seats_permitted required integer: Number of permitted application to work with the same API account
- data_calls_balance required integer: Represents actual value of remained data API calls
- data_calls_limit required integer: Represents the limit of data API calls per "data_calls_limit_interval" value
- data_calls_limit_interval required integer: Represents an interval for the "data_calls_limit" value of current subscription
- docs_balance required integer: Current transaction balance. Applicable for pay-as-you-go subscriptions only
- docs_limit required integer: Represents the transactions limit per "docs_limit_interval" value
- docs_limit_interval required integer: Represents the timeframe for the "docs_limit" value of current subscription
- docs_suggested required integer: Represents the amount of favorable documents suggested for throughput subscriptions
- docs_suggested_interval required integer: Represents the timeframe for the “docs_suggested” value of the current subscription
- expiration_date required string: Expiration date of current subscription. Defined as a Unix time stamp
- limit_type required string: Subscription type can have either pay-as-you-go or throughput value
- polling_calls_balance required integer: Represents actual value of remained polling API calls
- polling_calls_limit required integer: Represents the limit of polling API calls per "polling_calls_limit_interval" value
- polling_calls_limit_interval required integer: Represents an interval for the "polling_calls_limit" value of current subscription
- priority required string: Processing priority of current subscriber. Can have low, normal or high value
- settings_calls_balance required integer: Represents actual value of remained settings API calls
- settings_calls_limit required integer: Represents the limit of settings API calls per "settings_calls_limit_interval" value
- settings_calls_limit_interval required integer: Represents an interval for the "settings_calls_limit" value of current subscription

SubscriptionFeatureSection

SubscriptionFeatureSection object
- collection required SubscriptionFeatureSectionCollection
- document required SubscriptionFeatureSectionDocument
- html_processing required boolean: Identifies whether HTML processing feature is supported or not
- supported_languages required string: Lists all languages which are allowed for current subscription
- templates required SubscriptionFeatureSectionTemplate

SubscriptionFeatureSectionCollection

SubscriptionFeatureSectionCollection object
- concept_topics required boolean: Indicates whether concept topics are allowed or not
- facets required boolean: Indicates whether facets extraction feature is allowed or not
- mentions required boolean: Indicates whether mentions are allowed for facets and attributes or not
- named_entities required boolean: Indicates whether named entities feature is allowed or not
- query_topics required boolean: Indicates whether query defined topics are allowed or not
- themes required boolean: Indicates whether themes extraction feature is allowed or not
- user_entities required boolean: Indicates whether user entities feature is allowed or not

SubscriptionFeatureSectionDocument

SubscriptionFeatureSectionDocument object
- auto_categories required boolean: Indicates whether auto categories feature is allowed or not
- concept_topics required boolean: Indicates whether concept topics are allowed or not
- entity_themes required boolean: Indicates whether entity themes feature is allowed or not
- intentions required boolean: Indicates whether intentions feature is allowed or not.
- language_detection required boolean: Indicates whether language detection feature is allowed or not
- mentions required boolean: Indicates whether mentions for entities and themes are allowed or not
- model_sentiment required boolean: Indicates whether model-based sentiment feature is allowed or not
- named_entities required boolean: Indicates whether named entities feature is allowed or not
- named_relations required boolean: Indicates whether relations for named entities are allowed or not
- opinions required boolean: Indicates whether opinions feature is allowed or not
- phrases_detection required boolean: Indicates whether possible phrases detection feature is allowed or not
- pos_tagging required boolean: Indicates whether part of speech tagging feature is allowed or not
- query_topics required boolean: Indicates whether query defined topics are allowed or not
- sentiment_phrases required boolean: Indicates whether sentiment-bearing phrases output is allowed or not
- summary required boolean: Indicates whether summarization feature is allowed or not
- themes required boolean: Indicates whether document themes feature is allowed or not
- user_entities required boolean: Indicates whether user entities feature is allowed or not
- user_relations required boolean: Indicates whether relations for user entities are allowed or not

SubscriptionFeatureSectionTemplate

SubscriptionFeatureSectionTemplate object
- config_id required string: Unique identifier of configuration associated with the vertical pack. Required for cloning
- description required string: Verbal description of template features, belonging to domain area, etc.
- id required string: Unique document identifier. Can be up to 36 alphanumeric characters
- is_free required boolean: Shows whether Vertical pack is free or requires subscription
- language required string: The language supported by the vertical pack
- name required string: Name of the vertical pack
- type required string (values: language-default, vertical-pack): The type of the vertical pack, can be either "vertical-pack" or "language-default"
- version required string: Version of the vertical

@datafire/semantria

Integration registry for DataFire

by DataFire

@datafire/semantria

Installation and Usage

Description

Actions

deleteBlacklistItems

Input

Output

getBlacklist

Input

Output

addBlacklist

Input

Output

updateBlacklist

Input

Output

deleteCategories

Input

Output

getCategories

Input

Output

addCategories

Input

Output

updateCategories

Input

Output

queueCollection

Input

Output

retrieveProcessedCollections

Input

Output

cancelCollection

Input

Output

receiveCollectionAnalyticData

Input

Output

deleteConfigurations

Input

Output

getConfigurations

Input

Output

addConfigurations

Input

Output

updateConfigurations

Input

Output

queueDocument

Input

Output

queueBatchOfDocuments

Input

Output

retrieveProcessedDocuments

Input

Output

cancelDocument

Input

Output

receiveDocumentAnalyticData

Input

Output

deleteEntities

Input

Output

getEntities

Input

Output

addEntities

Input

Output

updateEntities