Semantic API v1.4

Description

An API to use Neticle Technologies' semantic and text analysis functions in a standard way.

Version History

Version	Release Date	Released by	Description
v1.0	2015.06.21.	Peter Szekeres	Initial internal version
v1.1	2016.07.29.	Zoltan Csikos	input_text can be sent via POST
v1.2	2016.08.15.	Zoltan Csikos	Enabled sending multiple synonyms at the same time for the same text
v1.3	2016.09.15.	Zoltan Csikos	synonyms array can be sent via POST
v1.4	2017.05.15.	Zoltan Csikos	Structure of response JSON has been changed under „total_synonym_hit_numbers”

Changelog

Compared to v1.3:

Structure of response JSON has been changed.

Compared to v1.2:

API accepts url encoded synonyms via a POST request (synonyms must be url encoded if sent via POST)

Compared to v1.2:

API accepts url encoded synonyms via a POST request (synonyms must be url encoded if sent via POST)

Compared to v1.1:

Ability to send multiple synonyms for the analyzed text
Result comes back from the API as an array of result objects.

Compared to v1.0:

API accepts url encoded input_text via a POST request (input_text must be url encoded if sent via POST)

Text Analysis

Description

Doing automated semantic analysis on input text.

Entity oriented sentiment analysis: in a text only the phrases, entities and labels related to the set target entity are analyzed. The target is set by it's synonyms, spelling and mispellings.

Document level sentiment analysis: in a text every phrases, entities and labels are analyzed. In this case no synonyms are given as input parameter.

Attribute recognition: service and product attributes (for example: screen, bandwidth, etc.) are recognized.

Topic recognition: key topics (for example: 3G, mobile payment, etc.) are recognized.

Location recognition: related locations (for example: Hungary, Pécs, etc.) are recognized.

Brand recognition: related brands (for example: Audi, Mercedes, etc.) are recognized.

Emotion recognition: related emotions (for example: joy, etc.) are recognized.

Person recognition: related persons (for example: Bill Gates, etc.) are recognized.

Organization recognition: related organizations (for example: UNICEF, etc.) are recognized.

Event recognition: related events (for example: festivals, conferences, etc.) are recognized.

Business topic recognition: related business topics (for example: revenue, IPO, etc.) are recognized.

Legal topic recognition: related legal topics (for example: lawsuit, legislation, etc.) are recognized.

Medical topic recognition: related mediacal topics (for example: receipt, sympton, etc.) are recognized.

HR topic recognition: related HR topics (for example: job, salary, etc.) are recognized.

Base URL

https://semanticapi.neticle.hu/1.4/text_analysis

Parameters

http argument	parameter description
lang	the language of the 'input text'. Possible values: bg - Bulgarian de - German en - English hu - Hungarian (required parameter)
token	ID of the caller, for example: demokey2 (required parameter)
input_text	Raw input text or HTML formatted text to analyze. Must be url encoded if sent via POST. (required parameter)
synonyms	array of array of synonyms. Must be url encoded if sent via POST. Synonyms are case-sensitive spellings, mispellings, synonyms of the target entity of the sentiment analysis. For example to analyze Audi brand the following synonyms should be set: audi, Audi, AUDI If synonyms are set, then only the phrases and labels related to the target represented by synonyms will be recognized (aka. entity oriented sentiment analysis): These cars are cool, but I don't like* that Audi.* If no synonyms are set, then the full text will be analyzed (aka. document level sentiment analysis). This version should be use only in special cases, because often gives bad results for precise analysis: These cars are cool, but I don't like* that Audi.* example value: - general analysis: skip synonyms altogether from the URL or use: [[]] - analyzing the input_text with one set of synonyms: [["audi", "Audi", "AUDI"]] (same as [„audi”, „Audi”, „AUDI”] in v1.1) - AND logical operator can be set with ; mark: [["Apple;smartphone"]] - phrases can be set with „…”: [["Paramount Channel"]] - sending multiple sets of synonyms: [["audi", "Audi", "AUDI"],["mercedes", "Mercedes", "MERCEDES"]] - general analysis and analysis based on two sets of synonyms: [[],["audi", "Audi", "AUDI"],["mercedes", "Mercedes", "MERCEDES"]] (optional parameter)
neticle_profile	String parameter to set Neticle profile name for specialised lexicons. (This will be used by Neticle system only.) (optional parameter)
stem	whether to include the stemmed format of the original 'input text' within the API response. Possible values: 1 - enabled 0 - disabled (default) (optional parameter)
lang_check	whether to check that the original 'input text' is aligned with the lang parameter. Possible values: 1 - enabled 0 - disabled (default) (optional parameter)
format	desired API output format Possible values: json (default) (optional parameter)
call_id	a special id to help to track calls for different topics Possible values: any string shorter than 255 characters (optional parameter)
replace_accent	whether to remove letter accents from the input text or not Possible values: 1 - enabled 0 - disabled (default) (optional parameter)

Sample call

https://testsapi.neticle.hu/1.4/text_analysis?lang=hu&replace_accent=0&token=websitedemo01&stem=0&format=json&synonyms=[[],[%22aut%C3%B3%22%2C%22Aut%C3%B3%22]]&input_text=Sziasztok%2C+Kiss+B%C3%A9la+vagyok%2C+%C3%A9s+szeretek+Audi+aut%C3%B3t+vezetni+Budapesten%2C+mert+gyorsabb+mint+a+t%C3%B6megk%C3%B6zleked%C3%A9s.+Ez%C3%A9rt+az+aut%C3%B3+egy+nagyon+hasznos+dolog+az+%C3%A9letemben.+Gyakran+m%C3%A9g+a+gyerekek%C3%A9rt+is+rossz+kocsival+megyek+iskol%C3%A1ba.+Sajnos+azonban+nincsenek+gyerekeim%2C+de+a+kocsim+ett%C5%91l+m%C3%A9g+baromi+gyors.+Az+egyed%C3%BCli+negat%C3%ADvum+az+aut%C3%B3k+tekintet%C3%A9ben%2C+hogy+el%C3%A9gg%C3%A9+b%C3%BCd%C3%B6sek.+Kiv%C3%A9ve+a+Mercedes+aut%C3%B3it%2C+mert+azok+illatosabbak%2C+mint+a+friss+tavaszi+szell%C5%91.+R%C3%A1ad%C3%A1sul+eg%C3%A9szs%C3%A9gtelen+besz%C3%ADvni+a+kocsikb%C3%B3l+sz%C3%A9pen+kiszabadul%C3%B3+f%C3%BCst%C3%B6t.+Mindazon%C3%A1ltal+szem%C3%A9ly+szerint+im%C3%A1dok+aut%C3%B3t+vezetni.

Sample response

{
  "input_length": 563,
  "results": [
    {
      "input_length": 563,
      "recognized_negative_phrases": [
        {
          "related_pos_phrases": [],
          "phrase": "is rossz",
          "mention_number": 1,
          "related_entities": [
            {
              "entity_name": "iskola",
              "entity_type": "topic",
              "related_mention_number": 1
            }
          ],
          "mentions": [
            " Gyakran még a gyerekekért is rossz kocsival megyek iskolába"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [],
          "phrase": "Sajnos",
          "mention_number": 1,
          "related_entities": [],
          "mentions": [
            " Sajnos azonban nincsenek gyerekeim"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [],
          "phrase": "Az egyedüli negatívum",
          "mention_number": 1,
          "related_entities": [
            {
              "entity_name": "tekintet",
              "entity_type": "attribute",
              "related_mention_number": 1
            }
          ],
          "mentions": [
            " Az egyedüli negatívum az autók tekintetében"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [],
          "phrase": "eléggé büdösek",
          "mention_number": 1,
          "related_entities": [],
          "mentions": [
            " hogy eléggé büdösek"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [],
          "phrase": "egészségtelen",
          "mention_number": 1,
          "related_entities": [
            {
              "entity_name": "egészség",
              "entity_type": "topic",
              "related_mention_number": 1
            }
          ],
          "mentions": [
            " Ráadásul egészségtelen beszívni a kocsikból szépen kiszabaduló füstöt"
          ],
          "related_neg_phrases": []
        }
      ],
      "keyword_stats": {
        "total_keyword_hit_number": 0,
        "total_synonym_hit_numbers": []
      },
      "processing_time_in_ms": 341,
      "recognized_synonyms": [],
      "recognized_positive_phrases": [
        {
          "related_pos_phrases": [],
          "phrase": "szeretek",
          "mention_number": 1,
          "related_entities": [
            {
              "entity_name": "Audi",
              "entity_type": "brand",
              "related_mention_number": 1
            },
            {
              "entity_name": "Budapest",
              "entity_type": "location",
              "related_mention_number": 1
            }
          ],
          "mentions": [
            " és szeretek Audi autót vezetni Budapesten"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [],
          "phrase": "gyorsabb",
          "mention_number": 1,
          "related_entities": [
            {
              "entity_name": "sebesség",
              "entity_type": "attribute",
              "related_mention_number": 1
            }
          ],
          "mentions": [
            " mert gyorsabb mint a tömegközlekedés"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [],
          "phrase": "egy nagyon hasznos",
          "mention_number": 1,
          "related_entities": [
            {
              "entity_name": "hasznosság",
              "entity_type": "attribute",
              "related_mention_number": 1
            }
          ],
          "mentions": [
            " Ezért az autó egy nagyon hasznos dolog az életemben"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [],
          "phrase": "még baromi gyors",
          "mention_number": 1,
          "related_entities": [
            {
              "entity_name": "sebesség",
              "entity_type": "attribute",
              "related_mention_number": 1
            }
          ],
          "mentions": [
            " de a kocsim ettől még baromi gyors"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [],
          "phrase": "azok illatosabbak",
          "mention_number": 1,
          "related_entities": [
            {
              "entity_name": "illat",
              "entity_type": "attribute",
              "related_mention_number": 1
            }
          ],
          "mentions": [
            " mert azok illatosabbak"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [],
          "phrase": "imádok",
          "mention_number": 1,
          "related_entities": [
            {
              "entity_name": "élvezet",
              "entity_type": "emotion",
              "related_mention_number": 1
            }
          ],
          "mentions": [
            " Mindazonáltal személy szerint imádok autót vezetni"
          ],
          "related_neg_phrases": []
        }
      ],
      "html_formatted_text": "<span class=\"contain_keyword\">Sziasztok</span>, <span class=\"contain_keyword\">Kiss Béla vagyok</span>, <span class=\"contain_keyword\">és <span class=\"phrase_pos_lvl2 polarity_item\" title=\"2\">szeretek</span> Audi autót vezetni Budapesten</span>, <span class=\"contain_keyword\">mert <span class=\"phrase_pos_lvl2 polarity_item\" title=\"2\">gyorsabb</span> mint a tömegközlekedés</span>. <span class=\"contain_keyword\">Ezért az autó <span class=\"phrase_pos_lvl3 polarity_item\" title=\"3\">egy nagyon hasznos</span> dolog az életemben</span>. <span class=\"contain_keyword\">Gyakran még a gyerekekért <span class=\"phrase_neg_lvl2 polarity_item\" title=\"-2 \">is rossz</span> kocsival megyek iskolába</span>. <span class=\"contain_keyword\"><span class=\"phrase_neg_lvl1 polarity_item\" title=\"-1\">Sajnos</span> azonban nincsenek gyerekeim</span>, <span class=\"contain_keyword\">de a kocsim ettől <span class=\"phrase_pos_lvl3 polarity_item\" title=\"4.5\">még baromi gyors</span></span>. <span class=\"contain_keyword\"><span class=\"phrase_neg_lvl3 polarity_item\" title=\"-3\">Az egyedüli negatívum</span> az autók tekintetében</span>, <span class=\"contain_keyword\">hogy <span class=\"phrase_neg_lvl1 polarity_item\" title=\"-1\">eléggé büdösek</span></span>. <span class=\"contain_keyword\">Kivéve a Mercedes autóit</span>, <span class=\"contain_keyword\">mert <span class=\"phrase_pos_lvl2 polarity_item\" title=\"2\">azok illatosabbak</span></span>, <span class=\"contain_keyword\">mint a friss tavaszi szellő</span>. <span class=\"contain_keyword\">Ráadásul <span class=\"phrase_neg_lvl2 polarity_item\" title=\"-2 \">egészségtelen</span> beszívni a kocsikból szépen kiszabaduló füstöt</span>. <span class=\"contain_keyword\">Mindazonáltal személy szerint <span class=\"phrase_pos_lvl2 polarity_item\" title=\"2\">imádok</span> autót vezetni</span>.",
      "opinion_index": 6.5,
      "call_id": "",
      "entities": [
        {
          "related_pos_phrases": [],
          "entity_name": "Béla",
          "entity_opinion_index": 0,
          "mention_number": 1,
          "related_entities": [],
          "entity_type": "person",
          "mentions": [
            " Kiss Béla vagyok"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [
            {
              "phrase": "szeretek",
              "related_mention_number": 1
            }
          ],
          "entity_name": "Audi",
          "entity_opinion_index": 2,
          "mention_number": 1,
          "related_entities": [
            {
              "entity_name": "Budapest",
              "entity_type": "location",
              "related_mention_number": 1
            }
          ],
          "entity_type": "brand",
          "mentions": [
            " és szeretek Audi autót vezetni Budapesten"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [
            {
              "phrase": "szeretek",
              "related_mention_number": 1
            }
          ],
          "entity_name": "Budapest",
          "entity_opinion_index": 2,
          "mention_number": 1,
          "related_entities": [
            {
              "entity_name": "Audi",
              "entity_type": "brand",
              "related_mention_number": 1
            }
          ],
          "entity_type": "location",
          "mentions": [
            " és szeretek Audi autót vezetni Budapesten"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [
            {
              "phrase": "gyorsabb",
              "related_mention_number": 1
            }
          ],
          "entity_name": "sebesség",
          "entity_opinion_index": 6.5,
          "mention_number": 2,
          "related_entities": [],
          "entity_type": "attribute",
          "mentions": [
            " mert gyorsabb mint a tömegközlekedés"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [
            {
              "phrase": "egy nagyon hasznos",
              "related_mention_number": 1
            }
          ],
          "entity_name": "hasznosság",
          "entity_opinion_index": 3,
          "mention_number": 1,
          "related_entities": [],
          "entity_type": "attribute",
          "mentions": [
            " Ezért az autó egy nagyon hasznos dolog az életemben"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [],
          "entity_name": "iskola",
          "entity_opinion_index": -2,
          "mention_number": 1,
          "related_entities": [],
          "entity_type": "topic",
          "mentions": [
            " Gyakran még a gyerekekért is rossz kocsival megyek iskolába"
          ],
          "related_neg_phrases": [
            {
              "phrase": "is rossz",
              "related_mention_number": 1
            }
          ]
        },
        {
          "related_pos_phrases": [],
          "entity_name": "tekintet",
          "entity_opinion_index": -3,
          "mention_number": 1,
          "related_entities": [],
          "entity_type": "attribute",
          "mentions": [
            " Az egyedüli negatívum az autók tekintetében"
          ],
          "related_neg_phrases": [
            {
              "phrase": "Az egyedüli negatívum",
              "related_mention_number": 1
            }
          ]
        },
        {
          "related_pos_phrases": [],
          "entity_name": "Mercedes",
          "entity_opinion_index": 0,
          "mention_number": 1,
          "related_entities": [],
          "entity_type": "brand",
          "mentions": [
            " Kivéve a Mercedes autóit"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [
            {
              "phrase": "azok illatosabbak",
              "related_mention_number": 1
            }
          ],
          "entity_name": "illat",
          "entity_opinion_index": 2,
          "mention_number": 1,
          "related_entities": [],
          "entity_type": "attribute",
          "mentions": [
            " mert azok illatosabbak"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [],
          "entity_name": "egészség",
          "entity_opinion_index": -2,
          "mention_number": 1,
          "related_entities": [],
          "entity_type": "topic",
          "mentions": [
            " Ráadásul egészségtelen beszívni a kocsikból szépen kiszabaduló füstöt"
          ],
          "related_neg_phrases": [
            {
              "phrase": "egészségtelen",
              "related_mention_number": 1
            }
          ]
        },
        {
          "related_pos_phrases": [
            {
              "phrase": "imádok",
              "related_mention_number": 1
            }
          ],
          "entity_name": "élvezet",
          "entity_opinion_index": 2,
          "mention_number": 1,
          "related_entities": [],
          "entity_type": "emotion",
          "mentions": [
            " Mindazonáltal személy szerint imádok autót vezetni"
          ],
          "related_neg_phrases": []
        }
      ]
    },
    {
      "input_length": 563,
      "recognized_negative_phrases": [
        {
          "related_pos_phrases": [],
          "phrase": "Az egyedüli negatívum",
          "mention_number": 1,
          "related_entities": [
            {
              "entity_name": "tekintet",
              "entity_type": "attribute",
              "related_mention_number": 1
            }
          ],
          "mentions": [
            " Az egyedüli negatívum az autók tekintetében"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [],
          "phrase": "eléggé büdösek",
          "mention_number": 1,
          "related_entities": [],
          "mentions": [
            " hogy eléggé büdösek"
          ],
          "related_neg_phrases": []
        }
      ],
      "keyword_stats": {
        "total_keyword_hit_number": 1,
        "total_synonym_hit_numbers": [
          {
            "synonym_hit_number": 1,
            "synonym_hit": "autó"
          }
        ]
      },
      "processing_time_in_ms": 332,
      "recognized_synonyms": [
        "autó"
      ],
      "recognized_positive_phrases": [
        {
          "related_pos_phrases": [],
          "phrase": "szeretek",
          "mention_number": 1,
          "related_entities": [
            {
              "entity_name": "Audi",
              "entity_type": "brand",
              "related_mention_number": 1
            },
            {
              "entity_name": "Budapest",
              "entity_type": "location",
              "related_mention_number": 1
            }
          ],
          "mentions": [
            " és szeretek Audi autót vezetni Budapesten"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [],
          "phrase": "gyorsabb",
          "mention_number": 1,
          "related_entities": [
            {
              "entity_name": "sebesség",
              "entity_type": "attribute",
              "related_mention_number": 1
            }
          ],
          "mentions": [
            " mert gyorsabb mint a tömegközlekedés"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [],
          "phrase": "egy nagyon hasznos",
          "mention_number": 1,
          "related_entities": [
            {
              "entity_name": "hasznosság",
              "entity_type": "attribute",
              "related_mention_number": 1
            }
          ],
          "mentions": [
            " Ezért az autó egy nagyon hasznos dolog az életemben"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [],
          "phrase": "azok illatosabbak",
          "mention_number": 1,
          "related_entities": [
            {
              "entity_name": "illat",
              "entity_type": "attribute",
              "related_mention_number": 1
            }
          ],
          "mentions": [
            " mert azok illatosabbak"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [],
          "phrase": "imádok",
          "mention_number": 1,
          "related_entities": [
            {
              "entity_name": "élvezet",
              "entity_type": "emotion",
              "related_mention_number": 1
            }
          ],
          "mentions": [
            " Mindazonáltal személy szerint imádok autót vezetni"
          ],
          "related_neg_phrases": []
        }
      ],
      "html_formatted_text": "Sziasztok, Kiss Béla vagyok, <span class=\"contain_keyword\">és <span class=\"phrase_pos_lvl2 polarity_item\" title=\"2\">szeretek</span> Audi <span class=\"synonym\">autó</span>t vezetni Budapesten</span>, <span class=\"contain_keyword\">mert <span class=\"phrase_pos_lvl2 polarity_item\" title=\"2\">gyorsabb</span> mint a tömegközlekedés</span>. <span class=\"contain_keyword\">Ezért az <span class=\"synonym\">autó</span> <span class=\"phrase_pos_lvl3 polarity_item\" title=\"3\">egy nagyon hasznos</span> dolog az életemben</span>. Gyakran még a gyerekekért is rossz kocsival megyek iskolába. Sajnos azonban nincsenek gyerekeim, de a kocsim ettől még baromi gyors. <span class=\"contain_keyword\"><span class=\"phrase_neg_lvl3 polarity_item\" title=\"-3\">Az egyedüli negatívum</span> az <span class=\"synonym\">autó</span>k tekintetében</span>, <span class=\"contain_keyword\">hogy <span class=\"phrase_neg_lvl1 polarity_item\" title=\"-1\">eléggé büdösek</span></span>. <span class=\"contain_keyword\">Kivéve a Mercedes <span class=\"synonym\">autó</span>it</span>, <span class=\"contain_keyword\">mert <span class=\"phrase_pos_lvl2 polarity_item\" title=\"2\">azok illatosabbak</span></span>, <span class=\"contain_keyword\">mint a friss tavaszi szellő</span>. Ráadásul egészségtelen beszívni a kocsikból szépen kiszabaduló füstöt. <span class=\"contain_keyword\">Mindazonáltal személy szerint <span class=\"phrase_pos_lvl2 polarity_item\" title=\"2\">imádok</span> <span class=\"synonym\">autó</span>t vezetni</span>.",
      "opinion_index": 7,
      "call_id": "",
      "entities": [
        {
          "related_pos_phrases": [
            {
              "phrase": "szeretek",
              "related_mention_number": 1
            }
          ],
          "entity_name": "Audi",
          "entity_opinion_index": 2,
          "mention_number": 1,
          "related_entities": [
            {
              "entity_name": "Budapest",
              "entity_type": "location",
              "related_mention_number": 1
            }
          ],
          "entity_type": "brand",
          "mentions": [
            " és szeretek Audi autót vezetni Budapesten"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [
            {
              "phrase": "szeretek",
              "related_mention_number": 1
            }
          ],
          "entity_name": "Budapest",
          "entity_opinion_index": 2,
          "mention_number": 1,
          "related_entities": [
            {
              "entity_name": "Audi",
              "entity_type": "brand",
              "related_mention_number": 1
            }
          ],
          "entity_type": "location",
          "mentions": [
            " és szeretek Audi autót vezetni Budapesten"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [
            {
              "phrase": "gyorsabb",
              "related_mention_number": 1
            }
          ],
          "entity_name": "sebesség",
          "entity_opinion_index": 2,
          "mention_number": 1,
          "related_entities": [],
          "entity_type": "attribute",
          "mentions": [
            " mert gyorsabb mint a tömegközlekedés"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [
            {
              "phrase": "egy nagyon hasznos",
              "related_mention_number": 1
            }
          ],
          "entity_name": "hasznosság",
          "entity_opinion_index": 3,
          "mention_number": 1,
          "related_entities": [],
          "entity_type": "attribute",
          "mentions": [
            " Ezért az autó egy nagyon hasznos dolog az életemben"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [],
          "entity_name": "tekintet",
          "entity_opinion_index": -3,
          "mention_number": 1,
          "related_entities": [],
          "entity_type": "attribute",
          "mentions": [
            " Az egyedüli negatívum az autók tekintetében"
          ],
          "related_neg_phrases": [
            {
              "phrase": "Az egyedüli negatívum",
              "related_mention_number": 1
            }
          ]
        },
        {
          "related_pos_phrases": [],
          "entity_name": "Mercedes",
          "entity_opinion_index": 0,
          "mention_number": 1,
          "related_entities": [],
          "entity_type": "brand",
          "mentions": [
            " Kivéve a Mercedes autóit"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [
            {
              "phrase": "azok illatosabbak",
              "related_mention_number": 1
            }
          ],
          "entity_name": "illat",
          "entity_opinion_index": 2,
          "mention_number": 1,
          "related_entities": [],
          "entity_type": "attribute",
          "mentions": [
            " mert azok illatosabbak"
          ],
          "related_neg_phrases": []
        },
        {
          "related_pos_phrases": [
            {
              "phrase": "imádok",
              "related_mention_number": 1
            }
          ],
          "entity_name": "élvezet",
          "entity_opinion_index": 2,
          "mention_number": 1,
          "related_entities": [],
          "entity_type": "emotion",
          "mentions": [
            " Mindazonáltal személy szerint imádok autót vezetni"
          ],
          "related_neg_phrases": []
        }
      ]
    }
  ],
  "total_processing_time_in_ms": 676
}

Response explanation

Element	Description
entities	Recognized labels and entities (topics, attributes, brands, locations, etc. (If synonyms are set as parameters, only the labels, entities and phrases related to the target synonyms are recognized. If no synonyms set then every label, entity and phrase is recognized in the text.)
entity_name	The name of the entity.
entity_opinion_index	The quantified opinion related to the entity.
entity_type	The type of the entity: topic, event, person, brand, attribute, location, etc.
html_formatted_text	The HTML and CSS formatted text. If a sentence part contains a synonym it is surrounded by contain_keyword class span tag. Recognized phrases are surrounded by polarity_item class span tags. Recognized synonyms are surrounded by synonym class span tags.
keyword_stats	Number of keyword and synonym mentions.
mention_number	Number of separate entity mentions.
mentions	Relevant sentences of entity mentions.
opinion_index	A score that represents how positive or negative is the text. 0 means neutral opinion, while negative value means negative opinion and positive value means positive opinion.
phrase	The phrase recognized.
processing_time_in_ms	The time needed to process the request.
recognized_negative_phrases	Negative phrases recognized in the text. (If synonyms are set, only the negative phrases related to the synonyms are recognized. If no synonyms set then every negative phrase is recognized in the text.)
recognized_positive_phrases	Positive phrases recognized in the text. (If synonyms are set, only the positive phrases related to the synonyms are recognized. If no synonyms set then every positive phrase is recognized in the text.)
related_neg_phrases	Negative phrases related to the entity.
related_mention_number	The number of how many times mentioned together with the entity in the same sentence.
related_pos_phrases	Positive phrases related to the entity.
recognized_synonyms	Synonyms recognized in the text.
total_keyword_hit_number	Number of the target entity was mentioned in the input texts. Every synonym hit is counted. If no synonym is set the result is 0.
total_synonym_hit_numbers	Number of synonym mentions by each synonym.
call_id	A special id to help to track calls for different topics

Error codes

Error code	Error message
0	IP address is blacklisted
1	No lang parameter set
2	Incorrect lang value
3	No token parameter set
4	Incorrect token value
5	Incorrect input_text value
6	Incorrect synonyms value
7	Incorrect stem value
8	Incorrect lang_check value
9	Incorrect format value
10	Incorrect replace_accent value
unknown	Unknown exception

Gender By Name

Description

It predicts the gender based on a name String value.

Possible values:
-1 : female
1 : male
0 : unknown

Base URL

https://semanticapi.neticle.hu/1.1/get_gender_from_name

Parameters

http argument	parameter description
lang	the language of the 'input text'. Possible values: bg - Bulgarian de - German en - English hu - Hungarian (required parameter)
token	ID of the caller, for example: demokey2 (required parameter)
name	name to analyze (required parameter)
format	desired API output format Possible values: json (default) (optional parameter)

Sample call

https://semanticapi.neticle.hu/1.0/get_gender_from_name?lang=hu&token=demokey2&name=Lajos&format=json

Sample response

{
    "user_key": "demokey2",
    "processing_time_in_ms": 400,
    "gender": 0
}

Error codes

Error code	Error message
1	No lang parameter set
2	Incorrect lang value
3	No token parameter set
4	Incorrect token value
5	No name parameter set
6	No format parameter set
7	Incorrect format value
unknown	Unknown exception

Language Check

Description

It checks the language of the input text.

Possible values:
true
false

Base URL

https://semanticapi.neticle.hu/1.1/lang_check

Parameters

http argument	parameter description
lang	the language of the 'input text' to check. Possible values: bg - Bulgarian de - German en - English hu - Hungarian (required parameter)
token	ID of the caller, for example: demokey2 (required parameter)
input_text	text to analyze (required parameter)
format	desired API output format Possible values: json (default) (optional parameter)

Sample call

https://semanticapi.neticle.hu/1.1/lang_check?lang=hu&token=demokey2&input_text=Lajos egy új autót vett&format=json

Sample response

{
    "user_key": "demokey2",
    "processing_time_in_ms": 400,
    "lang": "hu",
    "lang_check": true
}

Error codes

Error code	Error message
1	No lang parameter set
2	Incorrect lang value
3	No token parameter set
4	Incorrect token value
5	No name parameter set
6	No format parameter set
7	Incorrect format value
unknown	Unknown exception

Get Language

Description

It returns the language code of the input text.

Possible values:
bg
de
en
ge
hu
pl
ro
ru
unknown

Base URL

https://semanticapi.neticle.hu/1.4/get_lang

Parameters

http argument	parameter description
token	ID of the caller, for example: demokey2 (required parameter)
input_text	text to analyze (required parameter)
format	desired API output format Possible values: json (default) (optional parameter)

Sample call

https://semanticapi.neticle.hu/1.4/get_lang?token=demokey2&input_text=Lajos egy új autót vett&format=json

Sample response

{
    "errorMessage":"",
    "result":true,
    "recognizedLanguage":"hu",
    "errorCode":0,
    "call_id":"",
    "responseTime":8
}

Error codes

Error code	Error message
0	No error
3	No token parameter set
4	Incorrect token value
5	No input_text parameter set
6	No format parameter set
7	Incorrect format value
unknown	Unknown exception

Get Similarity

Description

It returns the similarity percentage of the input text.

Possible values:
0..100

Base URL

https://semanticapi.neticle.hu/1.4/get_similarity

Parameters

http argument	parameter description
token	ID of the caller, for example: demokey2 (required parameter)
input_text1	text to compare (required parameter)
input_text2	text to compare (required parameter)
format	desired API output format Possible values: json (default) (optional parameter)

Sample call

https://semanticapi.neticle.hu/1.4/get_similarity?input_text1=sok az autó&input_text2=sok volt autóval&token=demokey2&format=json

Sample response

{
    "call_id": "demo_call_id1",
    "processing_time_in_ms": 400,
    "similarity_score": "80"
}

Error codes

Error code	Error message
3	No token parameter set
4	Incorrect token value
5	No input_text1 parameter set
6	No format parameter set
7	Incorrect format value
14	No input_text2 parameter set
unknown	Unknown exception

Neticle Wiki

Felhasználói eszközök

Eszközök a webhelyen

Tartalomjegyzék

Semantic API v1.4

Description

Version History

Changelog

Text Analysis

Description

Base URL

Parameters

Sample call

Sample response

Response explanation

Error codes

Gender By Name

Description

Base URL

Parameters

Sample call

Sample response

Error codes

Language Check

Description

Base URL

Parameters

Sample call

Sample response

Error codes

Get Language

Description

Base URL

Parameters

Sample call

Sample response

Error codes

Get Similarity

Description

Base URL

Parameters

Sample call

Sample response

Error codes

Eszközök az oldalon