Overview

NLU / NLP Methods

These are the methods that actually perform analysis and transformation of input text.


Analyze text

POST
https://api.tisane.ai
/parse

The method analyzes the input and detects problematic content, sentiment snippets, entities, topics, phrase structure, parts of speech, stopwords, and more.

Analyze text › Headers

Ocp-Apim-Subscription-Key
​string · required

Your Tisane API key. Visible on the Profile page after sign-in.

Analyze text › Request Body

language
​string · required
content
​string · required
settings
​object

Analyze text › Responses

Successful response

text
​string · required

Input text.

language
​string

Language code, when the language identification is used.

​Memory

The state after the analysis. Can be used to set the state of the future analyses. (Set state to true to show.)

​array
​object[]
​object[]
​object[]
​object[]

List available languages

GET
https://api.tisane.ai
/languages

Retrieve a list of supported languages.

The response includes the following attributes:

  • id - Language ID.
  • name - Native name.
  • englishName - English name.
  • nativeEncoding - Encoding of the language.
  • preferredFont - Recommended font for display.
  • latin - Whether the language uses Latin script.
  • rightToLeft - Whether the language uses right-to-left script (e.g., Arabic, Hebrew, Persian).

List available languages › Headers

Ocp-Apim-Subscription-Key
​string · required

Your Tisane API key. Visible on the Profile page after sign-in.

List available languages › Responses

Successful response

​object[]
isoCode
​string
name
​string
englishName
​string
nativeEncoding
​string
fontFace
​string
latin
​boolean
rightToLeft
​boolean

Text clean-up

POST
https://api.tisane.ai
/helper/extract_text

A service method to remove JavaScript, CSS tags, JSON, and other markup, returning pure decoded text. The request body includes the markup content from which text will be extracted.

Note: This method does not process binary content.

Text clean-up › Headers

Ocp-Apim-Subscription-Key
​string · required

Your Tisane API key. Visible on the Profile page after sign-in.

Text clean-up › Request Body

string

Text clean-up › Responses

Successful response

string

Named entity comparison

POST
https://api.tisane.ai
/compare/entities

Compares two compound named entities and identifies differences. The request body should include:

  • language1 (string) - IETF tag for the first entity's language.
  • entity1 (string) - The first entity.
  • language2 (string) - IETF tag for the second entity's language.
  • entity2 (string) - The second entity.
  • type (string) - The entity type (currently only person is supported).

More information: Named Entities in the Tisane API Response Guide The response contains:

  • result (string) - Comparison result:

    • no_single_entity - One or both entities are invalid.
    • same - Entities are identical (name order might differ).
    • different - Entities differ, with details in differences.
  • differences (array of strings) - Lists detected differences:

    • given_name
    • surname
    • title (e.g., Mr., Mrs.)
    • social_role (e.g., academic degrees)
    • suffix
    • variation (e.g., spelling or style differences)

Named entity comparison › Headers

Ocp-Apim-Subscription-Key
​string · required

Your Tisane API key. Visible on the Profile page after sign-in.

Named entity comparison › Request Body

Named entity comparison › Responses

Successful response


Semantic similarity

POST
https://api.tisane.ai
/similarity

Calculate the semantic similarity between two text fragments, either in the same language or in different languages.

The request body should contain:

  • content1 (string) - The first text fragment.
  • language1 (string) - The IETF language code for content1.
  • content2 (string) - The second text fragment to compare.
  • language2 (string) - The IETF language code for content2.
  • settings (object) - Additional settings as per specifications. More information: Tisane API Configuration And Customization Guide.

The response is a number between 0 and 1, representing the similarity of the submitted text fragments.

Semantic similarity › Headers

Ocp-Apim-Subscription-Key
​string · required

Your Tisane API key. Visible on the Profile page after sign-in.

Semantic similarity › Request Body

Semantic similarity › Responses

Successful response

number

Detect language

POST
https://api.tisane.ai
/detectLanguage

Detects the languages used in the provided text fragment and returns the breakdown by offsets.

The request body should include:

  • content (string) - the text fragment to analyze.
  • languages (string, optional) - a vertical bar-delimited list of language codes to use as cues.
  • delimiter (string, optional) - a regular expression for segmenting the fragment; by default, the fragment is not segmented. The response is a JSON structure containing languages, which provides a breakdown of language codes.

Detect language › Headers

Ocp-Apim-Subscription-Key
​string · required

Your Tisane API key. Visible on the Profile page after sign-in.

Detect language › Request Body

content
​string

The text fragment to analyze.

languages
​string

A vertical bar-delimited list of language codes to use as cues.

delimiter
​string

A regular expression for segmenting the fragment; by default, the fragment is not segmented

Detect language › Responses

Successful response


Translate text

POST
https://api.tisane.ai
/transform

This method translates the input text. The request body should include the following elements:

  • from (string) - A standard IETF tag for the source language. Use * or a vertical bar-delimited set of language codes to invoke autodetect.
  • to (string) - A standard IETF tag for the target language. If the source and target languages are the same, paraphrasing will be applied.
  • content (string) - The text content to translate.
  • settings (object) - Additional translation settings.

More information: Tisane API Configuration And Customization Guide

The response is the transformed text.

Translate text › Headers

Ocp-Apim-Subscription-Key
​string · required

Your Tisane API key. Visible on the Profile page after sign-in.

Translate text › Request Body

from
​string
to
​string
content
​string
​object

Translate text › Responses

Successful translation response

string