@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Tisane API Documentation
@base https://api.tisane.ai
@auth ApiKey Ocp-Apim-Subscription-Key in header
@endpoints 8
@toc parse(1), languages(1), helper(1), compare(1), similarity(1), detectLanguage(1), transform(1), lm(1)

@group parse
@endpoint POST /parse
@desc The method analyzes the input, returning high-level and low-level metadata (abusive & problematic fragments, sentiment snippets, entities, topics, phrase structure, parts of speech, etc
@returns(200) {text: str, entities_summary: [map]}

@endgroup

@group languages
@endpoint GET /languages
@desc Obtain a list of the languages supported by the service

@endgroup

@group helper
@endpoint POST /helper/extract_text
@desc A service method to remove JavaScript, CSS tags, JSON, and other markup, returning pure decoded text

@endgroup

@group compare
@endpoint POST /compare/entities
@desc Compares two compound named entities and outputs the differences found
@returns(200) {result: str, differences: [str]}

@endgroup

@group similarity
@endpoint POST /similarity
@desc Calculate semantic similarity between two text fragments, in the same language or in two different languages

@endgroup

@group detectLanguage
@endpoint POST /detectLanguage
@desc Detects the languages used in the specified text fragment
@returns(200) {languages: [map]}

@endgroup

@group transform
@endpoint POST /transform
@desc The method translates the input

@endgroup

@group lm
@endpoint GET /lm/inflections
@desc List inflected forms
@optional {language: str # (Required) The language code, lexeme: str # (Required) The lexeme to inspect, family: str # (Required) The family to inspect}

@endgroup

@end