@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Text Analytics Client
@version v2.1-preview
@auth ApiKey Ocp-Apim-Subscription-Key in header
@endpoints 4
@toc keyPhrases(1), languages(1), sentiment(1), entities(1)

@group keyPhrases
@endpoint POST /keyPhrases
@desc The API returns a list of strings denoting the key talking points in the input text.
@required {input: map # Collection of documents to analyze. Documents can now contain a language field to indicate the text language}
@returns(200) A successful response results in 0 or more key phrases identified in each valid document

@endgroup

@group languages
@endpoint POST /languages
@desc The API returns the detected language and a numeric score between 0 and 1.
@required {input: map # Collection of documents to analyze.}
@returns(200) A successful call results in the detected language with the highest probability for each valid document

@endgroup

@group sentiment
@endpoint POST /sentiment
@desc The API returns a numeric score between 0 and 1.
@required {input: map # Collection of documents to analyze.}
@returns(200) A successful call results in each valid document getting a sentiment score between 0 and 1

@endgroup

@group entities
@endpoint POST /entities
@desc The API returns a list of recognized entities in a given document.
@required {input: map # Collection of documents to analyze.}
@returns(200) A successful call results in a list of recognized entities returned for each valid document

@endgroup

@end