Tisane

Tisane API Documentation

Tisane is a natural language processing library, providing: * standard NLP functionality * special functions for detection of problematic or abusive content *…

AI & machine learning#openapi#text

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Tisane is a natural language processing library, providing:

  • standard NLP functionality
  • special functions for detection of problematic or abusive content
  • low-level NLP like morphological analysis and tokenization of no-space languages (Chinese, Japanese, Thai)

Tisane has monolithic architecture. All the functions are exposed using the same language models and the same analysis process invoked using the POST /parse method. Other methods in the API are either wrappers based on the process, helper methods, or allow inspection of the language models.

The current section of the documentation describes the two structures used in the parsing & transformation methods.

Getting Started

This guide describes how to setup your Tisane account. The steps you need to complete are as follows:

  • Step 1 – Create an Account
  • Step 2 – Save Your API Key
  • Step 3 – Integrate the API

Step 1 – Create an Account

Navigate to Sign up to Tisane API. The free Community Plan allows up to 50,000 requests but comes with a limitation of 10 requests per minute.

Step 2 - Save Your API Key

You will need the API key to make requests. Open your Developer Profile to find your API keys.

Step 3 - Integrate with the API

In summary, the POST /parse method has 3 attributes: content, language, and settings. All 3 attributes are mandatory.

For example:
{"language": "en", "content": "hello", "settings": {}}

Read on for more info on the response and the settings specs. The method doc pages contain snippets of code for your favorite languages and platforms.

Response Reference

The response of the POST /parse method contains several sections displayed or hidden according to the settings provided.

The common attributes are:

  • text (string) - the original input
  • reduced_output (boolean) - if the input is too big, and verbose information like the lexical chunk was requested, the verbose information will not be generated, and this flag will be set to true and returned as part of the response
  • sentiment (floating-point number) - a number in range -1 to 1 indicating the document-level sentiment. Only shown when document_sentiment setting is set to true.
  • signal2noise (floating-point number) - a signal to noise ranking of the text, in relation to the array of concepts specified in the relevant setting. Only shown when the relevant setting exists.

Abusive or Problematic Content

The abuse section is an array of detected instances of content that may violate some terms of use. NOTE: the terms of use in online communities may vary, and so it is up to the administrators to determine whether the content is indeed abusive. For instance, it makes no sense to restrict sexual advances in a dating community, or censor profanities when it's accepted in the bulk of the community.

The section exists if instances of abuse are detected and the abuse setting is either omitted or set to true.

Every instance contains the following attributes:

  • offset (unsigned integer) - zero-based offset where the instance starts
  • length (unsigned integer) - length of the content
  • sentence_index (unsigned integer) - zero-based index of the sentence containing the instance
  • text (string) - fragment of text containing the instance (only included if the snippets setting is set to true)
  • tags (array of strings) - when exists, provides additional detail about the abuse. For instance, if the fragment is classified as an attempt to sell hard drugs, one of the tags will be hard_drug.
  • type (string) - the type of the abuse
  • severity (string) - how severe the abuse is. The levels of severity are low, medium, high, and extreme
  • explanation (string) - when available, provides rationale for the annotation; set the explain setting to true to enable.

The currently supported types are:

  • personal_attack - an insult / attack on the addressee, e.g. an instance of cyberbullying. Please note that an attack on a post or a point, or just negative sentiment is not the same as an insult. The line may be blurred at times. See our Knowledge Base for more information.
  • bigotry - hate speech aimed at one of the protected classes. The hate speech detected is not just racial slurs, but, generally, hostile statements aimed at the group as a whole
  • profanity - profane language, regardless of the intent
  • sexual_advances - welcome or unwelcome attempts to gain some sort of sexual favor or gratification
  • criminal_activity - attempts…

Endpoints 6

Language Model Direct Access

  • GETList hypernyms/hypernyms?family={family_id}&maxLevel={max_number_of_levels}Lists all hypernyms related to a family. A hypernym is a parent concent. E.g. "vehicle" is a hypernym of "truck".
  • GETList hyponyms/hyponyms?family={family_id}&maxLevel={max_number_of_levels}Lists all hyponyms related to a family. A hyponym is a child concent. E.g. "truck" is a hypernym of "vehicle".
  • GETList inflected forms/inflections?language={language_code}&lexeme={lexeme_id}&family={family_id}List inflected forms
  • GETGet family details/lm/family?id={family_id}Fetches and outputs metadata for a family from the Tisane language models.
  • GETList word senses/senses?language={language_code}&word={word}Fetches and outputs all senses related to a word.
  • GETList feature values/values?language={language_code}&type={Grammar/Style/Semantics}&description={feature_list_name}Lists feature values for a particular category of features. This allows obtaining all the values such as entity types, subtypes, abuse types and tags, and…

API details

Base URL
https://api.tisane.ai
Authentication
None declared in the description
Operations
6 operations on 6 pathsGET 6
Main resources
Language Model Direct Access 6
Response formats
application/json text/plain
Description format
OpenAPI 3.0.3, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Tisane API Documentation in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Tisane API Documentation collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “List hypernyms” (GET /hypernyms?family={family_id}&maxLevel={max_number_of_levels}), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Tisane API Documentation?

Tisane is a natural language processing library, providing: * standard NLP functionality * special functions for detection of problematic or abusive content *… It is listed under AI & machine learning and has 6 endpoints.

Who publishes the Tisane API Documentation?

It is listed from Tisane's public API description (an OpenAPI document), not published by Tisane on Swastik Codes. Anyone who controls tisane.ai can claim the profile by adding a DNS TXT record.

What is the base URL of the Tisane API Documentation?

Requests go to https://api.tisane.ai. Endpoint paths are added to this base URL.

How do I authenticate with the Tisane API Documentation?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Tisane API Documentation have?

6 operations on 6 paths (6 GET). The largest groups are Language Model Direct Access.

Is forking the Tisane API Documentation free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.