ai.tock.nlp.api.client

Class TockNlpClient

ai.tock.nlp.api.client.TockNlpClient

All Implemented Interfaces:

NlpClient

public class TockNlpClient
implements NlpClient

Wraps calls to the NLP stack.

Field Detail

Companion

public static ai.tock.nlp.api.client.TockNlpClient.Companion Companion

Constructor Detail

TockNlpClient

public TockNlpClient(@NotNull
                     java.lang.String baseUrl)

Wraps calls to the NLP stack.

TockNlpClient

public TockNlpClient()

Wraps calls to the NLP stack.

Method Detail

parse

@Nullable
public NlpResult parse(@NotNull
                                 NlpQuery query)

Analyses a sentence and returns the result.

evaluateEntities

@Nullable
public EntityEvaluationResult evaluateEntities(@NotNull
                                                         EntityEvaluationQuery query)

Evaluates entities.

mergeValues

@Nullable
public ValuesMergeResult mergeValues(@NotNull
                                               ValuesMergeQuery query)

Merges values and returns the result if found.

markAsUnknown

public void markAsUnknown(@NotNull
                          MarkAsUnknownQuery query)

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

createApplication

@Nullable
public 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.

getIntentsByNamespaceAndName

@Nullable
public 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
public 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

importNlpDump

public 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

public 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

public 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

public 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

public boolean healthcheck()

Checks the server is up.