NAV Navbar
shell python

Introduction

Welcome to the VeriUs API Documentation! You can use our API to access VeriUs API endpoints, which brings the power of NLP to your applications.

We have language bindings in Shell, Python and more on the way! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Before you can use our API, you need to register an account. Please go head and create an account if you haven't already.

Upon creating an account, an API key will be automatically generated for you.

Installation

$ pip install veriusapigateway

      

You can use pip to install package.

Authentication

To authorize, use this code:

from veriusapigateway import VeriUsAPIGateway

VeriUsAPI = VeriUsAPIGateway('$APIKEY')
# With shell, you can just pass the correct header with each request
$ curl -H "apikey: $APIKEY"

Make sure to replace $APIKEY with your API key.

VeriUs uses API keys to allow access to the API.

We expect for the API key to be included in all API requests to the server in a header that looks like the following:

apikey: $APIKEY

API Endpoints

Text Similarity

HTTP Request

POST https://api.verius.ai/text-similarity

Query Parameters

Parameter Required Description
text1 true First text to get similarity
text2 true Second text to get similarity
text1 = """Artificial intelligence (AI), the ability of a digital computer or
computer-controlled robot to perform tasks commonly associated with intelligent beings."""
text2 = """AI (artificial intelligence) is the simulation of human intelligence
processes by machines, especially computer systems."""
VeriUsAPI.text_similarity(text1, text2)
$ curl -X POST -H "Content-Type: application/json"
  -H "apikey: $APIKEY"
  -d '{"text1": "Artificial intelligence (AI), the ability
  of a digital computer or computer-controlled robot to perform
  tasks commonly associated with intelligent beings.",
  "text2": "AI (artificial intelligence) is the simulation of human
  intelligence processes by machines, especially computer systems."}'
  https://api.verius.ai/text-similarity

The above command returns JSON structured like this:

{"result": 0.4136701519960154}

Language Detection

HTTP Request

POST https://api.verius.ai/language-detection

Query Parameters

Parameter Required Description
text true Text for identifying the language
text = """Yapay zeka (AI), bir dijital bilgisayarın veya bilgisayar kontrollü
robotun, akıllı varlıklar ile yaygın olarak ilişkili görevleri gerçekleştirme
kabiliyetidir."""
VeriUsAPI.language(text)
$ curl -X POST -H "Content-Type: application/json"
  -H "apikey: $APIKEY"
  -d '{"text": "Yapay zeka (AI), bir dijital bilgisayarın
  veya bilgisayar kontrollü robotun, akıllı varlıklar ile
  yaygın olarak ilişkili görevleri gerçekleştirme kabiliyetidir."}'
  https://api.verius.ai/language-detection

The above command returns JSON structured like this:

{"result": "tr"}

Abusive Content Detection

HTTP Request

POST https://api.verius.ai/abusive-content-detection

Query Parameters

Parameter Required Description
text true Text for identifying whether the text is abusive or not
text = """Yapay zeka (AI), bir dijital bilgisayarın veya bilgisayar kontrollü
robotun, akıllı varlıklar ile yaygın olarak ilişkili görevleri
 gerçekleştirme kabiliyetidir."""
VeriUsAPI.abusive(text)
$ curl -X POST -H "Content-Type: application/json"
  -H "apikey: $APIKEY"
  -d '{"text": "Yapay zeka (AI), bir dijital bilgisayarın
  veya bilgisayar kontrollü robotun, akıllı varlıklar ile
  yaygın olarak ilişkili görevleri gerçekleştirme kabiliyetidir."}'
  https://api.verius.ai/abusive-content-detection

The above command returns JSON structured like this:

{"confidency": 0.9427243215855821, "result": "Non-abusive"}

Text Summarization

HTTP Request

POST https://api.verius.ai/text-summarizer

Query Parameters

Parameter Required Description
text true Input for summary
text = """Bir kedi varmış, çok yalnızmış.  Çünkü kedi, annesini ve babasını
kaybetmiş.Her gün yollarda gezermiş aç aç. Çöplükte yaşarmış. Bir gün bir evin
yanından geçerken bir çocuğa rastlamış. Çocuk kediyi 2-3 dakika sevdikten sonra
onu evine götürmüş, kedi ise hiç bir şey dememiş çünkü kedi hiç  Olamaz çünkü
onun bir ailesi var demiş. Ancak çocuk ısrar etmiş ve babasını ikna etmiş.
Çocuk da mutluymuş kedi  de. Kediyi beslemeye başlamışlar. 1 sene geçtikten
sonra kedinin annesi ve babası ortaya çıkmış. Yavrularını bulmak için
çabalamışlar ve sonunda bulmuşlar. Kedi ilk önce gitmek istememiş fakat annesi
babası olduğunu anlayınca hemen onların yanına gitmiş. Çocuk ağlamaya başlamış.
-Anladım baba, mutlu mutlu yaşasınlar, demiş. Kedi ve ailesi yola çıkmışlar,
iyi bir hayata yeniden başlamışlar."""
VeriUsAPI.summary(text)
$ curl -X POST -H "Content-Type: application/json"
  -H "apikey: $APIKEY"
  -d '{"text": "Bir kedi varmış, çok yalnızmış.  Çünkü kedi, annesini
  ve babasını kaybetmiş.Her gün yollarda gezermiş aç aç. Çöplükte yaşarmış.
  Bir gün bir evin yanından geçerken bir çocuğa rastlamış. Çocuk kediyi 2-3
  dakika sevdikten sonra onu evine götürmüş, kedi ise hiç bir şey dememiş
  çünkü kedi hiç  Olamaz çünkü onun bir ailesi var demiş. Ancak çocuk ısrar
  etmiş ve babasını ikna etmiş. Çocuk da mutluymuş kedi  de. Kediyi beslemeye
  başlamışlar. 1 sene geçtikten sonra kedinin annesi ve babası ortaya çıkmış.
  Yavrularını bulmak için çabalamışlar ve sonunda bulmuşlar. Kedi ilk önce
  gitmek istememiş fakat annesi babası olduğunu anlayınca hemen onların yanına
  gitmiş. Çocuk ağlamaya başlamış.-Anladım baba, mutlu mutlu yaşasınlar, demiş.
  Kedi ve ailesi yola çıkmışlar, iyi bir hayata yeniden başlamışlar."}'
  https://api.verius.ai/text-summarizer

The above command returns JSON structured like this:

{"result": "Çocuk kediyi 2-3 dakika sevdikten sonra onu evine götürmüş, kedi ise
   hiç bir şey dememiş çünkü kedi hiç  Olamaz çünkü onun bir ailesi var demiş.
   Çocuk da mutluymuş kedi  de."}

Keyword Extraction

HTTP Request

POST https://api.verius.ai/keyword-extractor

Query Parameters

Parameter Required Description
text true Text to get keywords from
text = """Carl Sagan, Dünya dışında akıllı hayatın araştırılmasından yanaydı.
Bilim dünyasını, Dünya dışı akıllı yaşam formlarından gelen sinyalleri dinlemek
için büyük radyo-teleskopları kullanmaya sevk etmiştir. Diğer gezegenlere
sondalar gönderilmesi gerektiğini savunmuştur. Carl Sagan, 12 yıl boyunca
Icarus dergisinin editörlüğünü yapmıştır. Planetary Society nin
kurucularındandır. Carl Sagan, SETI Enstitüsü nün yönetim kurulunun
bir üyesiydi."""
VeriUsAPI.keywords(text)
$ curl -X POST -H "Content-Type: application/json"
  -H "apikey: $APIKEY"
  -d '{"text": "Carl Sagan, Dünya dışında akıllı hayatın araştırılmasından
  yanaydı. Bilim dünyasını, Dünya dışı akıllı yaşam formlarından gelen
  sinyalleri dinlemek için büyük radyo-teleskopları kullanmaya sevk etmiştir.
  Diğer gezegenlere sondalar gönderilmesi gerektiğini savunmuştur. Carl Sagan,
  12 yıl boyunca Icarus dergisinin editörlüğünü yapmıştır. Planetary Society nin
  kurucularındandır. Carl Sagan, SETI Enstitüsü nün
  yönetim kurulunun bir üyesiydi."}'
  https://api.verius.ai/keyword-extractor

The above command returns JSON structured like this:

{"result": "Carl Sagan Akıllı"}

Entity Extraction

HTTP Request

POST https://api.verius.ai/entity-extraction

Query Parameters

Parameter Required Description
text true Text for extracting entities.
text = "Merhaba ben Ahmet, nasılsınız?"
VeriUsAPI.named_entitites(text)
$ curl -X POST -H "Content-Type: application/json"
  -H "apikey: $APIKEY"
  -d '{"text": "Merhaba ben Ahmet, nasılsınız?"}'
  https://api.verius.ai/entity-extraction

The above command returns JSON structured like this:

{"word_list": ["Merhaba", "ben", "Ahmet", ",", "nasılsınız", "?"],
  "prediction_list": ["O", "O", "B-PERSON", "O", "O", "O"]}

Distorted Language Detection

HTTP Request

POST https://api.verius.ai/distorted-language-detection

Query Parameters

Parameter Required Description
text true Input text
text = """Gelecek hafta için bir toplantı assign edip brainstorming yapalım
ve bir an önce bu konuda aksiyon alalım çünkü deadline yaklaşıyor."""
VeriUsAPI.distorted(text)
$ curl -X POST -H "Content-Type: application/json"
  -H "apikey: $APIKEY"
  -d '{"text": "Gelecek hafta için bir toplantı assign edip brainstorming
  yapalım ve bir an önce bu konuda aksiyon alalım çünkü deadline yaklaşıyor."}'
  https://api.verius.ai/distorted-language-detection

The above command returns JSON structured like this:

{"result": 0.9992382579798134}

Intent Detection

HTTP Request

POST https://api.verius.ai/intent-detection

Query Parameters

Parameter Required Description
text true Text to identify the intent
text = "Merhaba banka hesabı açmak istiyorum yardımcı olabilir misiniz?"
VeriUsAPI.intent(text)
$ curl -X POST -H "Content-Type: application/json"
  -H "apikey: $APIKEY"
  -d '{"text": "Merhaba banka hesabı açmak istiyorum yardımcı olabilir misiniz?"}'
  https://api.verius.ai/intent-detection

The above command returns JSON structured like this:

{"result": "QUERY"}

Normalization

HTTP Request

POST https://api.verius.ai/normalization

Query Parameters

Parameter Required Description
text true Text for normalizing
text = """@dida bi yere gitcem büttttttüüüünnnnn insanlar hür, haysiyet
ve haklari bakimindan e$it doğarlaaaar."""
VeriUsAPI.normal(text)
$ curl -X POST -H "Content-Type: application/json"
  -H "apikey: $APIKEY"
  -d '{"text": "@dida bi yere gitcem büttttttüüüünnnnn insanlar hür, haysiyet
  ve haklari bakimindan e$it doğarlaaaar."}'
  https://api.verius.ai/normalization

The above command returns JSON structured like this:

{"result": "@mansiyon[@dida] bir yere gideceğim bütün insanlar hür ,
  haysiyet ve haklar bakımından eşit doğarlar ."}

Deasciifier

HTTP Request

POST https://api.verius.ai/deasciifier

Query Parameters

Parameter Required Description
text true Text to deasciify
text = """Dun yolda bir kedi gordum, cok sevımlıydı. Hemen alıp cantama
koydum ve eve getırdım."""
VeriUsAPI.deasciified(text)
$ curl -X POST -H "Content-Type: application/json"
  -H "apikey: $APIKEY"
  -d '{"text": "Dun yolda bir kedi gordum, cok sevımlıydı. Hemen alıp cantama
  koydum ve eve getırdım."}'
  https://api.verius.ai/deasciifier

The above command returns JSON structured like this:

{"result": "Dün yolda bir kedi gördüm, çok sevimliydi.
  Hemen alıp çantama koydum ve eve getirdim."}

Morphological Analysis

HTTP Request

POST https://api.verius.ai/morphology

Query Parameters

Parameter Required Description
text true Text to analyze morphologically
text = "Bütün insanlar hür , haysiyet ve haklar bakımından eşit doğarlar ."
VeriUsAPI.morphology(text)
$ curl -X POST -H "Content-Type: application/json"
  -H "apikey: $APIKEY"
  -d '{"text": "Bütün insanlar hür , haysiyet ve haklar bakımından
  eşit doğarlar ."}'
  https://api.verius.ai/morphology

The above command returns JSON structured like this:

{"result": "[[bütün:Adj] bütün:Adj, [insan:Noun] insan:Noun+lar:A3pl,
  [hür:Adj] hür:Adj, [,:Punc] ,:Punc, [haysiyet:Noun] haysiyet:Noun+A3sg,
  [ve:Conj] ve:Conj, [hak:Noun] hak:Noun+lar:A3pl, [bakım:Noun]
  bakım:Noun+A3sg+ı:P3sg+ndan:Abl, [eşit:Adj] eşit:Adj, [doğmak:Verb]
  doğ:Verb+ar:Aor+lar:A3pl, [.:Punc] .:Punc]"}

Sexual Content Detection

HTTP Request

POST https://api.verius.ai/sexual-content-detection

Query Parameters

Parameter Required Description
text true Text to identify whether it contains sexual meaning or not
text = "Senden her yerin gözükecek şekilde fotoğraf istiyorum."
VeriUsAPI.sexual(text)
$ curl -X POST -H "Content-Type: application/json"
  -H "apikey: $APIKEY"
  -d '{"text": "Senden her yerin gözükecek şekilde fotoğraf istiyorum."}'
  https://api.verius.ai/sexual-content-detection

The above command returns JSON structured like this:

{"confidency": 0.9279416838064626, "result": "SEXUAL"}

Gibberish Detection

HTTP Request

POST https://api.verius.ai/gibberish-detection

Query Parameters

Parameter Required Description
text true Text to identify whether it is meaningful
text = "RÖHAEHÖHEY. Gülmeyi unuttuk be Hüseyin."
VeriUsAPI.gibberish(text)
$ curl -X POST -H "Content-Type: application/json"
  -H "apikey: $APIKEY"
  -d '{"text": "RÖHAEHÖHEY. Gülmeyi unuttuk be Hüseyin."}'
  https://api.verius.ai/gibberish-detection

The above command returns JSON structured like this:

{"result": "GIBBERISH"}

Sentence Tokenizer

HTTP Request

POST https://api.verius.ai/sentence-tokenizer

Query Parameters

Parameter Required Description
text true Text for splitting into tokens
text = "Geçen gün o geldi ama neden geldi hala belli değil."
VeriUsAPI.sentence_tokens(text)
$ curl -X POST -H "Content-Type: application/json"
  -H "apikey: $APIKEY"
  -d '{"text": "Geçen gün o geldi ama neden geldi hala belli değil."}'
  https://api.verius.ai/sentence-tokenizer

The above command returns JSON structured like this:

{"result": ["Geçen gün o geldi", "ama neden geldi", "hala belli değil ."]}

Sentiment Classification

HTTP Request

POST https://api.verius.ai/sentiment-analysis

Query Parameters

Parameter Required Description
text true Text for identifying the sentiment
text = "Bu ürünü hiç beğenmedim, iade etmek istiyorum."
VeriUsAPI.sentiment(text)
$ curl -X POST -H "Content-Type: application/json"
  -H "apikey: $APIKEY"
  -d '{"text": "Bu ürünü hiç beğenmedim, iade etmek istiyorum."}'
  https://api.verius.ai/sentiment-analysis

The above command returns JSON structured like this:

{"result": "Negative"}

Turkish Stemmer

HTTP Request

POST https://api.verius.ai/stemmer

Query Parameters

Parameter Required Description
text true Text to get roots of words.
text = "Büyük haberlerle geldim sana."
VeriUsAPI.stem(text)
$ curl -X POST -H "Content-Type: application/json"
  -H "apikey: $APIKEY"
  -d '{"text": "Büyük haberlerle geldim sana."}'
  https://api.verius.ai/stemmer

The above command returns JSON structured like this:

{"result": "Büyük haber gel sen ."}

Topic Detection for Electronics Retail

HTTP Request

POST https://api.verius.ai/topic-detection/elektronik

Query Parameters

Parameter Required Description
text true Text for extraction topics.
text = "güven veren güler yüzlü eleman enes için teşekkür ederim"
VeriUsAPI.topics_electronics(text)
$ curl -X POST -H "Content-Type: application/json"
  -H "apikey: $APIKEY"
  -d '{"text": "güven veren güler yüzlü eleman enes için teşekkür ederim"}'
  https://api.verius.ai/topic-detection/elektronik

The above command returns JSON structured like this:

{"result": ["personel", "teşekkür"]}

Topic Detection for Clothing Retail

HTTP Request

POST https://api.verius.ai/topic-detection/giyim

Query Parameters

Parameter Required Description
text true Text for extraction topics.
text = "pantolon aldım 200 lira para verdim. İndirim yok mu hiç?"
VeriUsAPI.topics_clothing(text)
$ curl -X POST -H "Content-Type: application/json"
  -H "apikey: $APIKEY"
  -d '{"text": "pantolon aldım 200 lira para verdim. İndirim yok mu hiç?"}'
  https://api.verius.ai/topic-detection/giyim

The above command returns JSON structured like this:

{"result": ["ürün", "fiyat_kampanya"]}

Topic Detection for Hospital Reviews

HTTP Request

POST https://api.verius.ai/topic-detection/hastane

Query Parameters

Parameter Required Description
text true Text for extraction topics.
text = "Doktor beyden çok memnun kaldım. Teşekkürler."
VeriUsAPI.topics_hospital(text)
$ curl -X POST -H "Content-Type: application/json"
  -H "apikey: $APIKEY"
  -d '{"text": "Doktor beyden çok memnun kaldım. Teşekkürler."}'
  https://api.verius.ai/topic-detection/hastane

The above command returns JSON structured like this:

{"result": ["hekimlik_hizmeti", "teşekkür"]}

Topic Detection for Food Retail

HTTP Request

POST https://api.verius.ai/topic-detection/market

Query Parameters

Parameter Required Description
text true Text for extraction topics.
text = "market içinde mevcut kötü bir koku var; balık, et ve peynir reyonundan geliyor."
VeriUsAPI.topics_market(text)
$ curl -X POST -H "Content-Type: application/json"
  -H "apikey: $APIKEY"
  -d '{"text": "market içinde mevcut kötü bir koku var;
   balık, et ve peynir reyonundan geliyor."}'
  https://api.verius.ai/topic-detection/market

The above command returns JSON structured like this:

{"result": ["ortam", "ürün"]}

Taxonomy

HTTP Request

POST https://api.verius.ai/taxonomy_web

Query Parameters

Parameter Required Description
text true Text to get tags.
text = """VeriUs teknoloji servis olarak yapay zeka (AIaaS) ürünleri geliştiren
çeşitli yapay zeka, makine öğrenmesi, metin madenciliği, doğal dil isleme ve
sosyal ağ analizi servisleri ve danışmanlığı sağlayan bir yapay zeka servis
sağlayıcıdır. Ekibimiz oldukça donanımlı Yapay Zeka araştırmacıları, makine
öğrenmesi yazılım mühendisleri ve veri bilimcilerden oluşmaktadır. Şirketin
kurucusunun 15+ yıl akademik ve uygulamalı makine öğrenmesi ve metin
madenciliği tecrübesi bulunmaktadır. Bir üniversite spin-off şirketi olarak
VeriUs bu akademik araştırma tecrübesi ve üniversite araştırma grupları ve
laboratuvarındaki birikmiş olan bilgiyle desteklenmektedir. İsmimiz VeriUs
Türkçe Veri ve Us yani zeka kelimelerinin birleşiminden oluşmaktadır.
İsmimiz odak noktamızı vurgulamaktadır; veri analizi ve yapay zeka."""
VeriUsAPI.taxonomy(text)
$ curl -X POST -H "Content-Type: application/json"
  -H "apikey: $APIKEY"
  -d '{"text": "VeriUs teknoloji servis olarak yapay zeka (AIaaS) ürünleri
  geliştiren çeşitli yapay zeka, makine öğrenmesi, metin madenciliği, doğal dil isleme ve
  sosyal ağ analizi servisleri ve danışmanlığı sağlayan bir yapay zeka servis
  sağlayıcıdır. Ekibimiz oldukça donanımlı Yapay Zeka araştırmacıları, makine
  öğrenmesi yazılım mühendisleri ve veri bilimcilerden oluşmaktadır. Şirketin
  kurucusunun 15+ yıl akademik ve uygulamalı makine öğrenmesi ve metin
  madenciliği tecrübesi bulunmaktadır. Bir üniversite spin-off şirketi olarak
  VeriUs bu akademik araştırma tecrübesi ve üniversite araştırma grupları ve
  laboratuvarındaki birikmiş olan bilgiyle desteklenmektedir. İsmimiz VeriUs
  Türkçe Veri ve Us yani zeka kelimelerinin birleşiminden oluşmaktadır.
  İsmimiz odak noktamızı vurgulamaktadır; veri analizi ve yapay zeka."}'
  https://api.verius.ai/taxonomy_web

The above command returns JSON structured like this:

{"result": "Bilgisayar"}

Errors

Error Code Meaning
400 Bad Request -- Your request is incalid. You probably didn't send any request body.
401 Unauthorized -- Your API key is wrong.
403 Forbidden -- You can not access to this service.
404 Not Found -- This endpoint does not exist. You might have entered it wrong.
405 Method Not Allowed -- We only accept POST method. You probably tried to send a GET request.
418 I'm a teapot.
429 Too Many Requests -- You've reached your hit limit.
500 Internal Server Error -- We had a problem with our server. Try again later.