io.cortical.services

Interface Expressions

public interface Expressions

The Expression Retina's API.

Method Summary

Methods

Modifier and Type	Method and Description
List<Context>	getContexts(Boolean includeFingerprint, Double sparsity, Model model) Calculate contexts of the result of an expression.
List<Context>	getContexts(Boolean includeFingerprint, Double sparsity, String jsonModel) Calculate a contexts of the result of an expression.
List<Context>	getContexts(Boolean includeFingerprint, Model model) Calculate contexts of the result of an expression.
List<Context>	getContexts(Boolean includeFingerprint, String jsonModel) Calculate a contexts of the result of an expression.
List<Context>	getContexts(Double sparsity, Model model) Calculate contexts of the result of an expression.
List<Context>	getContexts(Double sparsity, String jsonModel) Calculate a contexts of the result of an expression.
List<Context>	getContexts(Model model) Calculate contexts of the result of an expression.
List<Context>	getContexts(Pagination pagination, Boolean includeFingerprint, Double sparsity, Model model) Calculate contexts of the result of an expression.
List<Context>	getContexts(Pagination pagination, Boolean includeFingerprint, Double sparsity, String jsonModel) Calculate a contexts of the result of an expression.
List<Context>	getContexts(String jsonModel) Calculate contexts of the result of an expression.
List<List<Context>>	getContextsBulk(Boolean includeFingerprint, Double sparsity, Model... models) Calculate contexts for each item in the model's array.
List<List<Context>>	getContextsBulk(Boolean includeFingerprint, Double sparsity, String jsonModel) Calculate contexts for each items in the model's array.
List<List<Context>>	getContextsBulk(Boolean includeFingerprint, Model... models) Calculate contexts for each item in the model's array.
List<List<Context>>	getContextsBulk(Boolean includeFingerprint, String jsonModel) Calculate contexts for each items in the model's array.
List<List<Context>>	getContextsBulk(Double sparsity, Model... models) Calculate contexts for each item in the model's array.
List<List<Context>>	getContextsBulk(Double sparsity, String jsonModel) Calculate contexts for each items in the model's array.
List<List<Context>>	getContextsBulk(Model... models) Calculate contexts for each item in the model's array.
List<List<Context>>	getContextsBulk(Pagination pagination, Boolean includeFingerprint, Double sparsity, Model... models) Calculate contexts for each models.
List<List<Context>>	getContextsBulk(Pagination pagination, Boolean includeFingerprint, Double sparsity, String jsonModel) Calculate contexts for each model.
List<List<Context>>	getContextsBulk(String jsonModel) Calculate contexts for each items in the model's array.
List<Term>	getSimilarTerms(Integer contextId, Model model) Get similar terms for the expression (including all parts of speech).
List<Term>	getSimilarTerms(Integer contextId, PosType posType, Boolean includeFingerprint, Double sparsity, Model model) Get similar terms for the expression.
List<Term>	getSimilarTerms(Integer contextId, PosType posType, Boolean includeFingerprint, Double sparsity, String jsonModel) Gets similar terms for the expression.
List<Term>	getSimilarTerms(Integer contextId, PosType posType, Boolean includeFingerprint, Model model) Get similar terms for the expression.
List<Term>	getSimilarTerms(Integer contextId, PosType posType, Boolean includeFingerprint, String jsonModel) Gets similar terms for the expression.
List<Term>	getSimilarTerms(Integer contextId, PosType posType, Double sparsity, Model model) Get similar terms for the expression.
List<Term>	getSimilarTerms(Integer contextId, PosType posType, Double sparsity, String jsonModel) Gets similar terms for the expression.
List<Term>	getSimilarTerms(Integer contextId, PosType posType, Model model) Get similar terms for the expression.
List<Term>	getSimilarTerms(Integer contextId, PosType posType, Pagination pagination, Boolean includeFingerprint, Double sparsity, Model model) Get similar terms for the expression.
List<Term>	getSimilarTerms(Integer contextId, PosType posType, Pagination pagination, Boolean includeFingerprint, Double sparsity, String jsonModel) Gets similar terms for the expression.
List<Term>	getSimilarTerms(Integer contextId, PosType posType, String jsonModel) Gets similar terms for the expression.
List<Term>	getSimilarTerms(Integer contextId, String jsonModel) Get similar terms for the expression (including all parts of speech).
List<Term>	getSimilarTerms(Model model) Get similar terms for the expression (including all parts of speech and contexts).
List<Term>	getSimilarTerms(PosType posType, Model model) Get similar terms for the expression (including all contexts).
List<Term>	getSimilarTerms(PosType posType, String jsonModel) Get similar terms for the expression (including all contexts).
List<Term>	getSimilarTerms(String jsonModel) Get similar terms for the expression (including all parts of speech and contexts).
List<List<Term>>	getSimilarTermsBulk(Integer contextId, Model... models) Retrieve similar terms (all parts of speech) for each item in the model's array.
List<List<Term>>	getSimilarTermsBulk(Integer contextId, PosType posType, Boolean includeFingerprint, Double sparsity, Model... models) Retrieve similar terms for the each item in the model's array.
List<List<Term>>	getSimilarTermsBulk(Integer contextId, PosType posType, Boolean includeFingerprint, Double sparsity, String jsonModel) Retrieve similar terms for the each item in the model's array.
List<List<Term>>	getSimilarTermsBulk(Integer contextId, PosType posType, Boolean includeFingerprint, Model... models) Retrieve similar terms for each item in the model's array.
List<List<Term>>	getSimilarTermsBulk(Integer contextId, PosType posType, Boolean includeFingerprint, String jsonModel) Retrieve similar terms for the each item in the model's array.
List<List<Term>>	getSimilarTermsBulk(Integer contextId, PosType posType, Double sparsity, Model... models) Retrieve similar terms for each item in the model's array.
List<List<Term>>	getSimilarTermsBulk(Integer contextId, PosType posType, Double sparsity, String jsonModel) Retrieve similar terms for the each item in the model's array.
List<List<Term>>	getSimilarTermsBulk(Integer contextId, PosType posType, Model... models) Retrieve similar terms for each item in the model's array.
List<List<Term>>	getSimilarTermsBulk(Integer contextId, PosType posType, Pagination pagination, Boolean includeFingerprint, Double sparsity, Model... models) Retrieve similar terms for each item in the model's array.
List<List<Term>>	getSimilarTermsBulk(Integer contextId, PosType posType, Pagination pagination, Boolean includeFingerprint, Double sparsity, String jsonModel) Retrieve similar terms for the each item in the model's array.
List<List<Term>>	getSimilarTermsBulk(Integer contextId, PosType posType, String jsonModel) Retrieve similar terms for the each item in the model's array.
List<List<Term>>	getSimilarTermsBulk(Integer contextId, String jsonModel) Retrieve similar terms for each item in the models array for all parts of speech.
List<List<Term>>	getSimilarTermsBulk(Model... models) Retrieve similar terms for each item in the models array for all parts of speech and all contexts.
List<List<Term>>	getSimilarTermsBulk(PosType posType, Model... models) Retrieve similar terms for each item in the model's array including all contexts.
List<List<Term>>	getSimilarTermsBulk(PosType posType, String jsonModel) Retrieve similar terms for each item in the model's array for all contexts.
List<List<Term>>	getSimilarTermsBulk(String jsonModel) Retrieve similar terms for each item in the model's array for all parts of speech and all contexts.
Fingerprint	resolve(Double sparsity, Model model) Resolves an expression.
Fingerprint	resolve(Double sparsity, String jsonModel) Resolves an expression.
Fingerprint	resolve(Model model) Resolves an expression.
Fingerprint	resolve(String jsonModel) Resolves an expression.
List<Fingerprint>	resolveBulk(Double sparsity, Model... models) Resolves a bulk expression call.
List<Fingerprint>	resolveBulk(Double sparsity, String jsonModel) Resolves a bulk expression.
List<Fingerprint>	resolveBulk(Model... models) Resolves a bulk expression.
List<Fingerprint>	resolveBulk(String jsonModel) Resolves a bulk expression.

Method Detail

getSimilarTermsBulk

List<List<Term>> getSimilarTermsBulk(Integer contextId,
                                   PosType posType,
                                   Pagination pagination,
                                   Boolean includeFingerprint,
                                   Double sparsity,
                                   Model... models)
                                     throws com.fasterxml.jackson.core.JsonProcessingException,
                                            ApiException

Retrieve similar terms for each item in the model's array.

Parameters:

contextId - : the id of the relevant context (or null if all contexts are to be used).

posType - : a part of speech type.

pagination - : a response's items pagination mechanism configuration.

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

sparsity - : a value used for re-sparsifying the evaluated expression.

models - : model(s) for which a list of terms is generated. (for each model a list of Term is generated.)

Returns:

a List containing a List of terms generated for each item in the models.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTermsBulk

List<List<Term>> getSimilarTermsBulk(Integer contextId,
                                   PosType posType,
                                   Boolean includeFingerprint,
                                   Double sparsity,
                                   Model... models)
                                     throws com.fasterxml.jackson.core.JsonProcessingException,
                                            ApiException

Retrieve similar terms for the each item in the model's array.
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:

contextId - : the id of the relevant context (or null if all contexts are to be used).

posType - : a part of speech type.

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

sparsity - : a value used for re-sparsifying the evaluated expression.

models - : model(s) for which a list of terms is generated. (for each model a list of Term is generated.)

Returns:

a List containing a List of terms generated for each item in the models.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTermsBulk

List<List<Term>> getSimilarTermsBulk(Integer contextId,
                                   PosType posType,
                                   Double sparsity,
                                   Model... models)
                                     throws com.fasterxml.jackson.core.JsonProcessingException,
                                            ApiException

Retrieve similar terms for each item in the model's array.
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

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT

Parameters:

contextId - : the id of the relevant context.

posType - : a part of speech type.

sparsity - : a value used for re-sparsifying the evaluated expression.

models - : model(s) for which a list of terms is generated. (for each model a list of Term is generated.)

Returns:

a List containing a List of terms generated for each item in the models.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTermsBulk

List<List<Term>> getSimilarTermsBulk(Integer contextId,
                                   PosType posType,
                                   Boolean includeFingerprint,
                                   Model... models)
                                     throws com.fasterxml.jackson.core.JsonProcessingException,
                                            ApiException

Retrieve similar terms for each item in the model's array.
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 default sparsity is DefaultValues.DEF_VALUE_SPARSITY.

Parameters:

contextId - : the id of the relevant context.

posType - : a part of speech type.

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

models - : model(s) for which a list of terms is generated. (for each model a list of Term is generated.)

Returns:

a List containing a List of terms generated for each item in the models.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTermsBulk

List<List<Term>> getSimilarTermsBulk(Integer contextId,
                                   PosType posType,
                                   Model... models)
                                     throws com.fasterxml.jackson.core.JsonProcessingException,
                                            ApiException

Retrieve similar terms for each item in the model's array.
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 default sparsity is DefaultValues.DEF_VALUE_SPARSITY.
Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT

Parameters:

contextId - : the id of the relevant context.

posType - : a part of speech type.

models - : model(s) for which a list of terms is generated. (for each model a list of Term is generated.)

Returns:

a List containing a List of terms generated for each item in the models.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTermsBulk

List<List<Term>> getSimilarTermsBulk(PosType posType,
                                   Model... models)
                                     throws com.fasterxml.jackson.core.JsonProcessingException,
                                            ApiException

Retrieve similar terms for each item in the model's array including all contexts.
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 default sparsity is DefaultValues.DEF_VALUE_SPARSITY.
Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT

Parameters:

posType - : a part of speech type.

models - : model(s) for which a list of terms is generated. (for each model a list of Term is generated.)

Returns:

a List containing a List of terms generated for each item in the models.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTermsBulk

List<List<Term>> getSimilarTermsBulk(Integer contextId,
                                   Model... models)
                                     throws com.fasterxml.jackson.core.JsonProcessingException,
                                            ApiException

Retrieve similar terms (all parts of speech) for each item in the model's array.
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 default sparsity is DefaultValues.DEF_VALUE_SPARSITY.
Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT

Parameters:

contextId - : the id of the relevant context.

models - : model(s) for which a list of terms is generated. (for each model a list of Term is generated.)

Returns:

a List containing a List of terms generated for each item in the models.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTermsBulk

List<List<Term>> getSimilarTermsBulk(Model... models)
                                     throws com.fasterxml.jackson.core.JsonProcessingException,
                                            ApiException

Retrieve similar terms for each item in the models array for all parts of speech and all contexts.
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 default sparsity is DefaultValues.DEF_VALUE_SPARSITY.
Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT

Parameters:

models - : model(s) for which a list of terms is generated. (for each model a list of Term is generated.)

Returns:

a List containing a List of terms generated for each item in the models.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTermsBulk

List<List<Term>> getSimilarTermsBulk(PosType posType,
                                   String jsonModel)
                                     throws com.fasterxml.jackson.core.JsonProcessingException,
                                            ApiException

Retrieve similar terms for each item in the model's array for all contexts.
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 default sparsity is DefaultValues.DEF_VALUE_SPARSITY.
Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT

Parameters:

posType - : a part of speech type.

jsonModel - : model(s) for which a list of terms is generated in the json representation. (for each model a list of Term is generated.)

Returns:

a List containing a List of terms generated for each item in the models.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTermsBulk

List<List<Term>> getSimilarTermsBulk(Integer contextId,
                                   String jsonModel)
                                     throws com.fasterxml.jackson.core.JsonProcessingException,
                                            ApiException

Retrieve similar terms for each item in the models array for all parts of speech.
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 default sparsity is DefaultValues.DEF_VALUE_SPARSITY.
Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT

Parameters:

contextId - : the id of the relevant context.

jsonModel - : model(s) for which a list of terms is generated in the json representation. (for each model a list of Term is generated.)

Returns:

a List containing a List of terms generated for each item in the models.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTermsBulk

List<List<Term>> getSimilarTermsBulk(String jsonModel)
                                     throws com.fasterxml.jackson.core.JsonProcessingException,
                                            ApiException

Retrieve similar terms for each item in the model's array for all parts of speech and all contexts.
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 default sparsity is DefaultValues.DEF_VALUE_SPARSITY.
Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT

Parameters:

jsonModel - : model(s) for which a list of terms is generated in the json representation. (for each model a list of Term is generated.)

Returns:

a List containing a List of terms generated for each item in the models.

Throws:

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

ApiException - : if there are server or connection issues.

resolveBulk

List<Fingerprint> resolveBulk(Double sparsity,
                            Model... models)
                              throws com.fasterxml.jackson.core.JsonProcessingException,
                                     ApiException

Resolves a bulk expression call.

Parameters:

models - : model(s) for which the list of fingerprints is generated.

sparsity - : a value used for re-sparsifying the evaluated expression.

Returns:

a list of fingerprints generated for each of the input model(s).

Throws:

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

ApiException - : if there are server or connection issues.

resolveBulk

List<Fingerprint> resolveBulk(Model... models)
                              throws com.fasterxml.jackson.core.JsonProcessingException,
                                     ApiException

Resolves a bulk expression.
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY.

Parameters:

models - : a model(s) for which the list of fingerprints is generated.

Returns:

a list of fingerprints generated for each of the input model(s).

Throws:

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

ApiException - : if there are server or connection issues.

getContextsBulk

List<List<Context>> getContextsBulk(Pagination pagination,
                                  Boolean includeFingerprint,
                                  Double sparsity,
                                  Model... models)
                                    throws com.fasterxml.jackson.core.JsonProcessingException,
                                           ApiException

Calculate contexts for each models.
Returns a list of Context for each of the input expressions in the bulk expression call. The returned Response object will contain a list of lists of Contexts.

Parameters:

pagination - : the response's items pagination mechanism configuration.

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

sparsity - : a value used for re-sparsifying the evaluated expression.

models - : model(s) for which a list of contexts is generated. (for each model a list of Context is generated.)

Returns:

a list of contexts' lists generated from the input model(s).

Throws:

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

ApiException - : if there are server or connection issues.

getContextsBulk

List<List<Context>> getContextsBulk(Boolean includeFingerprint,
                                  Double sparsity,
                                  Model... models)
                                    throws com.fasterxml.jackson.core.JsonProcessingException,
                                           ApiException

Calculate contexts for each item in the model's array.
The default pagination configuration is:

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

Parameters:

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

sparsity - : a value used for re-sparsifying the evaluated expression.

models - : model(s) for which a list of contexts is generated. (for each model a list of Context is generated.)

Returns:

a list of contexts' lists generated from passed model(s).

Throws:

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

ApiException - : if there are server or connection issues.

getContextsBulk

List<List<Context>> getContextsBulk(Double sparsity,
                                  Model... models)
                                    throws com.fasterxml.jackson.core.JsonProcessingException,
                                           ApiException

Calculate contexts for each item in the model's array.
The default pagination configuration is:

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

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT

Parameters:

sparsity - : a value used for re-sparsifying the evaluated expression.

models - : model(s) for which a list of contexts is generated. (for each model a list of Context is generated.)

Returns:

a list of contexts' lists generated from passed model(s).

Throws:

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

ApiException - : if there are server or connection issues.

getContextsBulk

List<List<Context>> getContextsBulk(Boolean includeFingerprint,
                                  Model... models)
                                    throws com.fasterxml.jackson.core.JsonProcessingException,
                                           ApiException

Calculate contexts for each item in the model's array.
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY.
The default pagination configuration is:

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

Parameters:

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

models - : model(s) for which a list of contexts is generated. (for each model a list of Context is generated.)

Returns:

a list of contexts' lists generated from passed model(s).

Throws:

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

ApiException - : if there are server or connection issues.

getContextsBulk

List<List<Context>> getContextsBulk(Model... models)
                                    throws com.fasterxml.jackson.core.JsonProcessingException,
                                           ApiException

Calculate contexts for each item in the model's array.
Returns a list of Context for each one of the input expressions in the bulk, so the returned Response object will contain a list of lists of Contexts.
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY.
The default pagination configuration is:

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

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT

Parameters:

models - : the model(s) for which a list of contexts is generated. (for each model a list of Context is generated.)

Returns:

a list of contexts' lists generated from passed model(s).

Throws:

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

ApiException - : if there are server or connection issues.

resolve

Fingerprint resolve(Double sparsity,
                  Model model)
                    throws com.fasterxml.jackson.core.JsonProcessingException,
                           ApiException

Resolves an expression.

Parameters:

sparsity - : a value used for re-sparsifying the evaluated expression.

model - : a model for which a fingerprint is generated.

Returns:

a fingerprint for the input model.

Throws:

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

ApiException - : if there are server or connection issues.

resolve

Fingerprint resolve(Model model)
                    throws com.fasterxml.jackson.core.JsonProcessingException,
                           ApiException

Resolves an expression.
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY.

Parameters:

model - : a model for which a fingerprint is generated.

Returns:

a fingerprint for the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getContexts

List<Context> getContexts(Pagination pagination,
                        Boolean includeFingerprint,
                        Double sparsity,
                        Model model)
                          throws com.fasterxml.jackson.core.JsonProcessingException,
                                 ApiException

Calculate contexts of the result of an expression.

Parameters:

pagination - : the response item's pagination mechanism configuration.

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

sparsity - : a value used for re-sparsifying the evaluated expression.

model - : a model for which a list of contexts is generated.

Returns:

a list of contexts generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getContexts

List<Context> getContexts(Boolean includeFingerprint,
                        Double sparsity,
                        Model model)
                          throws com.fasterxml.jackson.core.JsonProcessingException,
                                 ApiException

Calculate contexts of the result of an expression.
The default pagination configuration is:

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

Parameters:

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

sparsity - : a value used for re-sparsifying the evaluated expression.

model - : a model for which a list of contexts is generated.

Returns:

a list of contexts generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getContexts

List<Context> getContexts(Double sparsity,
                        Model model)
                          throws com.fasterxml.jackson.core.JsonProcessingException,
                                 ApiException

Calculate contexts of the result of an expression.
The default pagination configuration is:

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

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT

Parameters:

sparsity - : a value used for re-sparsifying the evaluated expression.

model - : a model for which a list of contexts is generated.

Returns:

a list of contexts generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getContexts

List<Context> getContexts(Boolean includeFingerprint,
                        Model model)
                          throws com.fasterxml.jackson.core.JsonProcessingException,
                                 ApiException

Calculate contexts of the result of an expression.
The default pagination configuration is:

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

The default sparsity is DefaultValues.DEF_VALUE_SPARSITY

Parameters:

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

model - : a model for which a list of contexts is generated.

Returns:

a list of contexts generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getContexts

List<Context> getContexts(Model model)
                          throws com.fasterxml.jackson.core.JsonProcessingException,
                                 ApiException

Calculate contexts of the result of an expression.
The default pagination configuration is:

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

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY

Parameters:

sparsity - : a value used for re-sparsifying the evaluated expression.

model - : a model for which a list of contexts is generated.

Returns:

a list of contexts generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTerms

List<Term> getSimilarTerms(Integer contextId,
                         PosType posType,
                         Pagination pagination,
                         Boolean includeFingerprint,
                         Double sparsity,
                         Model model)
                           throws com.fasterxml.jackson.core.JsonProcessingException,
                                  ApiException

Get similar terms for the expression.

Parameters:

contextId - : the id of the relevant context.

posType - : a part of speech type.

pagination - : a response's items pagination mechanism configuration.

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

sparsity - : a value used for re-sparsifying the evaluated expression.

model - : a model for which a list of terms is generated.

Returns:

a list of similar terms generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTerms

List<Term> getSimilarTerms(Integer contextId,
                         PosType posType,
                         Boolean includeFingerprint,
                         Double sparsity,
                         Model model)
                           throws com.fasterxml.jackson.core.JsonProcessingException,
                                  ApiException

Get similar terms for the expression.
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:

contextId - : the id of the relevant context.

posType - : a part of speech type.

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

sparsity - : a value used for re-sparsifying the evaluated expression.

model - : a model for which a list of terms is generated.

Returns:

a list of similar terms generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTerms

List<Term> getSimilarTerms(Integer contextId,
                         PosType posType,
                         Double sparsity,
                         Model model)
                           throws com.fasterxml.jackson.core.JsonProcessingException,
                                  ApiException

Get similar terms for the expression.
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

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT

Parameters:

contextId - : the id of the relevant context.

posType - : a part of speech type.

sparsity - : a value used for re-sparsifying the evaluated expression.

model - : a model for which a list of terms is generated.

Returns:

a list of similar terms generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTerms

List<Term> getSimilarTerms(Integer contextId,
                         PosType posType,
                         Boolean includeFingerprint,
                         Model model)
                           throws com.fasterxml.jackson.core.JsonProcessingException,
                                  ApiException

Get similar terms for the expression.
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 default sparsity is DefaultValues.DEF_VALUE_SPARSITY

Parameters:

contextId - : the id of the relevant context.

posType - : a part of speech type.

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

model - : a model for which a list of terms is generated.

Returns:

a list of similar terms generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTerms

List<Term> getSimilarTerms(Integer contextId,
                         PosType posType,
                         Model model)
                           throws com.fasterxml.jackson.core.JsonProcessingException,
                                  ApiException

Get similar terms for the expression.
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

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY

Parameters:

contextId - : the id of the relevant context.

posType - : a part of speech type.

model - : a model for which a list of terms is generated.

Returns:

a list of similar terms generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTerms

List<Term> getSimilarTerms(PosType posType,
                         Model model)
                           throws com.fasterxml.jackson.core.JsonProcessingException,
                                  ApiException

Get similar terms for the expression (including all contexts).
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

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY

Parameters:

posType - : a part of speech type.

model - : a model for which a list of terms is generated.

Returns:

a list of similar terms generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTerms

List<Term> getSimilarTerms(Integer contextId,
                         Model model)
                           throws com.fasterxml.jackson.core.JsonProcessingException,
                                  ApiException

Get similar terms for the expression (including all parts of speech).
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

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY

Parameters:

contextId - : the id of the relevant context.

model - : a model for which a list of terms is generated.

Returns:

a list of similar terms generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTerms

List<Term> getSimilarTerms(Model model)
                           throws com.fasterxml.jackson.core.JsonProcessingException,
                                  ApiException

Get similar terms for the expression (including all parts of speech and contexts).
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

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY

Parameters:

model - : a model for which a list of terms is generated.

Returns:

a list of similar terms generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTerms

List<Term> getSimilarTerms(PosType posType,
                         String jsonModel)
                           throws com.fasterxml.jackson.core.JsonProcessingException,
                                  ApiException

Get similar terms for the expression (including all contexts).
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

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY

Parameters:

posType - : a part of speech type.

jsonModel - : a model for which a list of terms is generated in the json representation.

Returns:

a list of similar terms generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTerms

List<Term> getSimilarTerms(Integer contextId,
                         String jsonModel)
                           throws com.fasterxml.jackson.core.JsonProcessingException,
                                  ApiException

Get similar terms for the expression (including all parts of speech).
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

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY

Parameters:

contextId - : a context id

jsonModel - : a model for which a list of terms is generated.

Returns:

a list of similar terms generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTerms

List<Term> getSimilarTerms(String jsonModel)
                           throws com.fasterxml.jackson.core.JsonProcessingException,
                                  ApiException

Get similar terms for the expression (including all parts of speech and contexts).
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

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY

Parameters:

jsonModel - : a model for which a list of terms is generated.

Returns:

a list of similar terms generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTermsBulk

List<List<Term>> getSimilarTermsBulk(Integer contextId,
                                   PosType posType,
                                   Pagination pagination,
                                   Boolean includeFingerprint,
                                   Double sparsity,
                                   String jsonModel)
                                     throws com.fasterxml.jackson.core.JsonProcessingException,
                                            ApiException

Retrieve similar terms for the each item in the model's array.

Parameters:

contextId - : a context id

posType - : a part of speech type.

pagination - : a response's items pagination mechanism configuration.

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

sparsity - : a value used for re-sparsifying the evaluated expression.

jsonModel - : json model for which a list of terms is generated. (for each model a list of Term is generated.)

Returns:

A list containing a list of terms generated for each item in the models.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTermsBulk

List<List<Term>> getSimilarTermsBulk(Integer contextId,
                                   PosType posType,
                                   Boolean includeFingerprint,
                                   Double sparsity,
                                   String jsonModel)
                                     throws com.fasterxml.jackson.core.JsonProcessingException,
                                            ApiException

Retrieve similar terms for the each item in the model's array.
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:

contextId - : a context id

posType - : a part of speech type.

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

sparsity - : a value used for re-sparsifying the evaluated expression.

jsonModel - : model(s) for which a list of terms is generated. (for each model a list of Term is generated.)

Returns:

A list containing a list of terms generated for each item in the models.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTermsBulk

List<List<Term>> getSimilarTermsBulk(Integer contextId,
                                   PosType posType,
                                   Double sparsity,
                                   String jsonModel)
                                     throws com.fasterxml.jackson.core.JsonProcessingException,
                                            ApiException

Retrieve similar terms for the each item in the model's array.
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

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT

Parameters:

contextId - : a context id

posType - : a part of speech type.

sparsity - : a value used for re-sparsifying the evaluated expression.

jsonModel - : json model(s) for which a list of terms is generated. (for each model a list of Term is generated.)

Returns:

A list containing a list of terms generated for each item in the models.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTermsBulk

List<List<Term>> getSimilarTermsBulk(Integer contextId,
                                   PosType posType,
                                   Boolean includeFingerprint,
                                   String jsonModel)
                                     throws com.fasterxml.jackson.core.JsonProcessingException,
                                            ApiException

Retrieve similar terms for the each item in the model's array.
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 default sparsity is DefaultValues.DEF_VALUE_SPARSITY.

Parameters:

contextId - : a context id

posType - : a part of speech type.

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

jsonModel - : a json model(s) for which a list of terms is generated. (for each model a list of Term is generated.)

Returns:

A list containing a list of terms generated for each item in the models.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTermsBulk

List<List<Term>> getSimilarTermsBulk(Integer contextId,
                                   PosType posType,
                                   String jsonModel)
                                     throws com.fasterxml.jackson.core.JsonProcessingException,
                                            ApiException

Retrieve similar terms for the each item in the model's array.
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

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY.

Parameters:

contextId - : a context id

posType - : a part of speech type.

jsonModel - : json model(s) for which a list of terms is generated. (for each model a list of Term is generated.)

Returns:

A list containing a list of terms generated for each item in the models.

Throws:

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

ApiException - : if there are server or connection issues.

resolveBulk

List<Fingerprint> resolveBulk(Double sparsity,
                            String jsonModel)
                              throws com.fasterxml.jackson.core.JsonProcessingException,
                                     ApiException

Resolves a bulk expression.

Parameters:

jsonModel - : json model(s) for which the list of fingerprints is generated.

sparsity - : the value used for re-sparsifying the evaluated expression.

Returns:

a list of fingerprints generated for the input model(s).

Throws:

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

ApiException - : if there are server or connection issues.

resolveBulk

List<Fingerprint> resolveBulk(String jsonModel)
                              throws com.fasterxml.jackson.core.JsonProcessingException,
                                     ApiException

Resolves a bulk expression.
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY.

Parameters:

jsonModel - : json model(s) for which the list of fingerprints is generated.

Returns:

a list of fingerprints generated for the input model(s).

Throws:

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

ApiException - : if there are server or connection issues.

getContextsBulk

List<List<Context>> getContextsBulk(Pagination pagination,
                                  Boolean includeFingerprint,
                                  Double sparsity,
                                  String jsonModel)
                                    throws com.fasterxml.jackson.core.JsonProcessingException,
                                           ApiException

Calculate contexts for each model.
Returns a list of Context for each one of the input expressions in the bulk, so the returned Response object will contain a list of lists of Contexts.

Parameters:

pagination - : a response's items pagination mechanism configuration.

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

sparsity - : a value used for re-sparsifying the evaluated expression.

jsonModel - : json model(s) for which a list of contexts is generated. (for each model a list of Context is generated.)

Returns:

a list of contexts lists generated from the input model(s).

Throws:

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

ApiException - : if there are server or connection issues.

getContextsBulk

List<List<Context>> getContextsBulk(Boolean includeFingerprint,
                                  Double sparsity,
                                  String jsonModel)
                                    throws com.fasterxml.jackson.core.JsonProcessingException,
                                           ApiException

Calculate contexts for each items in the model's array.
The default pagination configuration is:

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

Parameters:

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

sparsity - : a value used for re-sparsifying the evaluated expression.

jsonModel - : json model(s) for which a list of contexts is generated. (for each model a list of Context is generated.)

Returns:

a list of contexts lists generated from the input model(s).

Throws:

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

ApiException - : if there are server or connection issues.

getContextsBulk

List<List<Context>> getContextsBulk(Double sparsity,
                                  String jsonModel)
                                    throws com.fasterxml.jackson.core.JsonProcessingException,
                                           ApiException

Calculate contexts for each items in the model's array.
The default pagination configuration is:

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

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT

Parameters:

sparsity - : a value used for re-sparsifying the evaluated expression.

jsonModel - : json model(s) for which a list of contexts is generated. (for each model a list of Context is generated.)

Returns:

a list of contexts lists generated from passed model(s).

Throws:

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

ApiException - : if there are server or connection issues.

getContextsBulk

List<List<Context>> getContextsBulk(Boolean includeFingerprint,
                                  String jsonModel)
                                    throws com.fasterxml.jackson.core.JsonProcessingException,
                                           ApiException

Calculate contexts for each items in the model's array.
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY
The default pagination configuration is:

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

Parameters:

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

jsonModel - : json model(s) for which a list of contexts is generated. (for each model a list of Context is generated.)

Returns:

a list of contexts lists generated from passed model(s).

Throws:

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

ApiException - : if there are server or connection issues.

getContextsBulk

List<List<Context>> getContextsBulk(String jsonModel)
                                    throws com.fasterxml.jackson.core.JsonProcessingException,
                                           ApiException

Calculate contexts for each items in the model's array.
Returns a list of Context for each one of the input expressions in the bulk. The returned Response object will contain a list of lists of Contexts.
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY
The default pagination configuration is:

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

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT

Parameters:

jsonModel - : json model(s) for which a list of contexts is generated. (for each model a list of Context is generated.)

Returns:

a list of contexts lists generated from passed model(s).

Throws:

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

ApiException - : if there are server or connection issues.

resolve

Fingerprint resolve(Double sparsity,
                  String jsonModel)
                    throws com.fasterxml.jackson.core.JsonProcessingException,
                           ApiException

Resolves an expression.

Parameters:

sparsity - : a value used for re-sparsifying the evaluated expression.

jsonModel - : json model for which a fingerprint is generated.

Returns:

a fingerprint for the input model.

Throws:

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

ApiException - : if there are server or connection issues.

resolve

Fingerprint resolve(String jsonModel)
                    throws com.fasterxml.jackson.core.JsonProcessingException,
                           ApiException

Resolves an expression.
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY.

Parameters:

jsonModel - : json model for which a fingerprint is generated.

Returns:

a fingerprint for the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getContexts

List<Context> getContexts(Pagination pagination,
                        Boolean includeFingerprint,
                        Double sparsity,
                        String jsonModel)
                          throws com.fasterxml.jackson.core.JsonProcessingException,
                                 ApiException

Calculate a contexts of the result of an expression.

Parameters:

pagination - : a response's items pagination mechanism configuration.

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

sparsity - : a value used for re-sparsifying the evaluated expression.

jsonModel - : json model for which a list of contexts is generated.

Returns:

a list of contexts generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getContexts

List<Context> getContexts(Boolean includeFingerprint,
                        Double sparsity,
                        String jsonModel)
                          throws com.fasterxml.jackson.core.JsonProcessingException,
                                 ApiException

Calculate a contexts of the result of an expression.
The default pagination configuration is:

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

Parameters:

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

sparsity - : a value used for re-sparsifying the evaluated expression.

jsonModel - : json model for which a list of contexts is generated.

Returns:

a list of contexts generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getContexts

List<Context> getContexts(Double sparsity,
                        String jsonModel)
                          throws com.fasterxml.jackson.core.JsonProcessingException,
                                 ApiException

Calculate a contexts of the result of an expression.
The default pagination configuration is:

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

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT

Parameters:

sparsity - : a value used for re-sparsifying the evaluated expression.

jsonModel - : a json model for which a list of contexts is generated.

Returns:

a list of contexts generated from passed model.

Throws:

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

ApiException - : if there are server or connection issues.

getContexts

List<Context> getContexts(Boolean includeFingerprint,
                        String jsonModel)
                          throws com.fasterxml.jackson.core.JsonProcessingException,
                                 ApiException

Calculate a contexts of the result of an expression.
The default pagination configuration is:

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

The default sparsity is DefaultValues.DEF_VALUE_SPARSITY

Parameters:

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

jsonModel - : json model for which a list of contexts is generated.

Returns:

a list of contexts generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getContexts

List<Context> getContexts(String jsonModel)
                          throws com.fasterxml.jackson.core.JsonProcessingException,
                                 ApiException

Calculate contexts of the result of an expression.
The default pagination configuration is:

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

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY

Parameters:

sparsity - : a value used for re-sparsifying the evaluated expression.

jsonModel - : json model for which a list of contexts is generated.

Returns:

a list of contexts generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTerms

List<Term> getSimilarTerms(Integer contextId,
                         PosType posType,
                         Pagination pagination,
                         Boolean includeFingerprint,
                         Double sparsity,
                         String jsonModel)
                           throws com.fasterxml.jackson.core.JsonProcessingException,
                                  ApiException

Gets similar terms for the expression.

Parameters:

contextId - : a context id

posType - : a part of speech type

pagination - : a response's items pagination mechanism configuration.

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

sparsity - : a value used for re-sparsifying the evaluated expression.

jsonModel - : json model for which a list of terms is generated.

Returns:

a list of similar terms generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTerms

List<Term> getSimilarTerms(Integer contextId,
                         PosType posType,
                         Boolean includeFingerprint,
                         Double sparsity,
                         String jsonModel)
                           throws com.fasterxml.jackson.core.JsonProcessingException,
                                  ApiException

Gets similar terms for the expression.
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:

contextId - : a context id

posType - : a part of speech type

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

sparsity - : a value used for re-sparsifying the evaluated expression.

jsonModel - : json model for which a list of terms is generated.

Returns:

a list of similar terms generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTerms

List<Term> getSimilarTerms(Integer contextId,
                         PosType posType,
                         Double sparsity,
                         String jsonModel)
                           throws com.fasterxml.jackson.core.JsonProcessingException,
                                  ApiException

Gets similar terms for the expression.
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

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT

Parameters:

contextId - : a context id

posType - : a part of speech type

sparsity - : a value used for re-sparsifying the evaluated expression.

jsonModel - : json model for which a list of terms is generated.

Returns:

a list of similar terms generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTerms

List<Term> getSimilarTerms(Integer contextId,
                         PosType posType,
                         Boolean includeFingerprint,
                         String jsonModel)
                           throws com.fasterxml.jackson.core.JsonProcessingException,
                                  ApiException

Gets similar terms for the expression.
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 default sparsity is DefaultValues.DEF_VALUE_SPARSITY

Parameters:

contextId - : a context id

posType - : a part of speech type

includeFingerprint - : true if a fingerprint field should be provided for each of the response items.

jsonModel - : json model for which a list of terms is generated.

Returns:

a list of similar terms generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.

getSimilarTerms

List<Term> getSimilarTerms(Integer contextId,
                         PosType posType,
                         String jsonModel)
                           throws com.fasterxml.jackson.core.JsonProcessingException,
                                  ApiException

Gets similar terms for the expression.
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

Whether to include a fingerprint in the response is defined by DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT
The default sparsity is DefaultValues.DEF_VALUE_SPARSITY

Parameters:

contextId - : a context id

posType - : a part of speech type

jsonModel - : json model for which a list of terms is generated.

Returns:

a list of similar terms generated from the input model.

Throws:

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

ApiException - : if there are server or connection issues.