ai.tock.nlp.api.client

Interface NlpClient

All Known Implementing Classes:

TockNlpClient

public NlpClient

Wraps calls to the NLP stack. class TockNlpClient is the provided implementation.

See Also:

class TockNlpClient

Constructor Detail

NlpClient

public NlpClient()

Method Detail

parse

@Nullable
NlpResult parse(@NotNull
                          NlpQuery query)

Analyses a sentence and returns the result.

evaluateEntities

@Nullable
EntityEvaluationResult evaluateEntities(@NotNull
                                                  EntityEvaluationQuery query)

Evaluates entities.

mergeValues

@Nullable
ValuesMergeResult mergeValues(@NotNull
                                        ValuesMergeQuery query)

Merges values and returns the result if found.

markAsUnknown

void markAsUnknown(@NotNull
                   MarkAsUnknownQuery query)

Informs the nlp model that a sentence has not been understood.

getIntentsByNamespaceAndName

@Nullable
java.util.List<ai.tock.nlp.api.client.model.dump.IntentDefinition> getIntentsByNamespaceAndName(@NotNull
                                                                                                          java.lang.String namespace,
                                                                                                          @NotNull
                                                                                                          java.lang.String name)

Returns the list of intents of a model.

Returns:

List of IntentDefinition

getApplicationByNamespaceAndName

@Nullable
ApplicationDefinition getApplicationByNamespaceAndName(@NotNull
                                                                 java.lang.String namespace,
                                                                 @NotNull
                                                                 java.lang.String name)

Returns an application for the specified namespace and name.

Returns:

the application if any

createApplication

@Nullable
ApplicationDefinition createApplication(@NotNull
                                                  java.lang.String namespace,
                                                  @NotNull
                                                  java.lang.String name,
                                                  @NotNull
                                                  java.util.Locale locale)

Creates an application if it does not exists.

Returns:

the new application, null if it already exists.

importNlpDump

boolean importNlpDump(@NotNull
                      java.io.InputStream stream)

Imports a NLP dump (configuration and sentences of the NLP model).

Returns:

true if NLP model is modified, false either

importNlpPlainDump

boolean importNlpPlainDump(@NotNull
                           ApplicationDump dump)

Imports a NLP dump (configuration and sentences of the NLP model).

Parameters:

dump - the dump to import

Returns:

true if NLP model is modified, false either

importNlpSentencesDump

boolean importNlpSentencesDump(@NotNull
                               java.io.InputStream stream)

Imports a NLP sentences dump (only validated sentences) - format is simpler than class ApplicationDump.

Returns:

true if NLP model is modified, false either

See Also:

class ApplicationDump

importNlpPlainSentencesDump

boolean importNlpPlainSentencesDump(@NotNull
                                    SentencesDump dump)

Imports a NLP sentences dump (only validated sentences) - format is simpler than class ApplicationDump.

Parameters:

dump - the dump to import

Returns:

true if NLP model is modified, false either

See Also:

class ApplicationDump

healthcheck

boolean healthcheck()

Checks the server is up.