io.cortical.services

Interface Texts

public interface Texts

The Retina's Texts API.

Method Summary

Methods

Modifier and Type	Method and Description
List<Fingerprint>	getFingerprintBulk(Double sparsity, Text... texts) Retrieve a list of fingerprints obtained from input texts (one fingerprint per text).
List<Fingerprint>	getFingerprints(String text) Retrieve fingerprints for the input text (text is split and for each item a fingerprint is generated).
List<String>	getKeywords(String text) Retrieve a list of keywords from the input text.
List<Text>	getSlices(String text) Slice the text.
List<Text>	getSlices(String text, Boolean includeFingerprint) Slice the text.
List<Text>	getSlices(String text, Pagination pagination, Boolean includeFingerprint) Slice the text.
List<String>	getTokens(String text, PosTag[] posTags) Retrieve a list of lists of tokens for the input model: a list of sentences containing lists of tokens.
Retina	identifyRetinaByText(String text) Identifies the language of the text and returns (if possible) a relevant Retina object.

Method Detail

getKeywords

List<String> getKeywords(String text)
                         throws ApiException

Retrieve a list of keywords from the input text.

Parameters:

model - : the input model.

Returns:

an array of keywords

Throws:

ApiException - : if there are some server or connection issues.

getFingerprints

List<Fingerprint> getFingerprints(String text)
                                  throws ApiException

Retrieve fingerprints for the input text (text is split and for each item a fingerprint is generated).

Parameters:

model - : model for which a fingerprint is generated.

Returns:

fingerprints generated for the input model.

Throws:

ApiException - : if there are server or connection issues.

getFingerprintBulk

List<Fingerprint> getFingerprintBulk(Double sparsity,
                                   Text... texts)
                                     throws com.fasterxml.jackson.core.JsonProcessingException,
                                            ApiException

Retrieve a list of fingerprints obtained from input texts (one fingerprint per text).

Parameters:

texts - : input texts.

sparsity - : the value used for re-sparsifying the expression. Not used here!

Returns:

a list of fingerprints generated using the input model.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if it is impossible to generate the request using the input model.

ApiException - : if there are server or connection issues.

getSlices

List<Text> getSlices(String text,
                   Pagination pagination,
                   Boolean includeFingerprint)
                     throws ApiException

Slice the text.

Parameters:

text - : a text to slice.

pagination - : a pagination configuration.

includeFingerprint - : true if a fingerprint should be provided with the response items.

Returns:

list of slices in the Text representation.

Throws:

ApiException - : if there are server or connection issues.

getSlices

List<Text> getSlices(String text,
                   Boolean includeFingerprint)
                     throws ApiException

Slice the text.
The default pagination configuration is:

• Start from: DefaultValues.DEF_VALUE_START_INDEX
• Max count of items in a result: DefaultValues.DEF_VALUE_MAX_ITEMS_COUNT

Parameters:

text - : a text to slice.

includeFingerprint - : true if a fingerprint should be provided with the response items.

Returns:

list of slices in the Text representation.

Throws:

ApiException - : if there are server or connection issues.

getSlices

List<Text> getSlices(String text)
                     throws ApiException

Slice the text.
The default pagination configuration is:

• Start from: DefaultValues.DEF_VALUE_START_INDEX
• Max count of items in a result: DefaultValues.DEF_VALUE_MAX_ITEMS_COUNT

The ability of a response items to have/provide fingerprint is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT

Parameters:

text - : a text to slice.

Returns:

list of slices in the Text representation.

Throws:

ApiException - : if there are server or connection issues.

getTokens

List<String> getTokens(String text,
                     PosTag[] posTags)
                       throws ApiException

Retrieve a list of lists of tokens for the input model: a list of sentences containing lists of tokens.

Parameters:

text - : input text.

posTags - : array of pos tags used in the token generation.

Returns:

: a list of tokens.

Throws:

ApiException - : if there are server or connection issues.

identifyRetinaByText

Retina identifyRetinaByText(String text)
                            throws ApiException

Identifies the language of the text and returns (if possible) a relevant Retina object.

Parameters:

text - the input text

Returns:

a Retina object.

Throws:

ApiException - : if there are server or connection issues.