ai.tock.nlp.api.client.model

Class NlpResult

ai.tock.nlp.api.client.model.NlpResult

public class NlpResult

The result of the class NlpQuery.

See Also:

class NlpQuery

Constructor Detail

NlpResult

public NlpResult(@NotNull
                 java.lang.String intent,
                 @NotNull
                 java.lang.String intentNamespace,
                 @NotNull
                 java.util.Locale language,
                 @NotNull
                 java.util.List<ai.tock.nlp.api.client.model.NlpEntityValue> entities,
                 @NotNull
                 java.util.List<ai.tock.nlp.api.client.model.NlpEntityValue> notRetainedEntities,
                 double intentProbability,
                 double entitiesProbability,
                 @NotNull
                 java.lang.String retainedQuery,
                 @NotNull
                 java.util.Map<java.lang.String,java.lang.Double> otherIntentsProbabilities,
                 @Nullable
                 java.lang.String staticResponse)

The result of the class NlpQuery.

Parameters:

intent - The intent selected.

intentNamespace - the namespace of the selected intent.

language - The language selected.

entities - The selected entities.

notRetainedEntities - The entities found but not retained.

intentProbability - The intent evaluated probability.

entitiesProbability - The average entity evaluation probability.

retainedQuery - The analysed query.

otherIntentsProbabilities - Other intents with significant probabilities.

staticResponse - The static text response possibly returned for the class NlpQuery

See Also:

class NlpQuery

Method Detail

firstValue

@Nullable
public NlpEntityValue firstValue(@NotNull
                                           java.lang.String role)

entityTextContent

@NotNull
public java.lang.String entityTextContent(@NotNull
                                                   NlpEntityValue value)

hasIntent

public boolean hasIntent(@NotNull
                         java.lang.String intent,
                         double minProbability)

getIntent

@NotNull
public java.lang.String getIntent()

The intent selected.

getIntentNamespace

@NotNull
public java.lang.String getIntentNamespace()

the namespace of the selected intent.

getLanguage

@NotNull
public java.util.Locale getLanguage()

The language selected.

getEntities

@NotNull
public java.util.List<ai.tock.nlp.api.client.model.NlpEntityValue> getEntities()

The selected entities.

getNotRetainedEntities

@NotNull
public java.util.List<ai.tock.nlp.api.client.model.NlpEntityValue> getNotRetainedEntities()

The entities found but not retained.

getIntentProbability

public double getIntentProbability()

The intent evaluated probability.

getEntitiesProbability

public double getEntitiesProbability()

The average entity evaluation probability.

getRetainedQuery

@NotNull
public java.lang.String getRetainedQuery()

The analysed query.

getOtherIntentsProbabilities

@NotNull
public java.util.Map<java.lang.String,java.lang.Double> getOtherIntentsProbabilities()

Other intents with significant probabilities.

getStaticResponse

@Nullable
public java.lang.String getStaticResponse()

The static text response possibly returned for the

class NlpQuery

See Also:

class NlpQuery

component1

@NotNull
public java.lang.String component1()

The intent selected.

component2

@NotNull
public java.lang.String component2()

the namespace of the selected intent.

component3

@NotNull
public java.util.Locale component3()

The language selected.

component4

@NotNull
public java.util.List<ai.tock.nlp.api.client.model.NlpEntityValue> component4()

The selected entities.

component5

@NotNull
public java.util.List<ai.tock.nlp.api.client.model.NlpEntityValue> component5()

The entities found but not retained.

component6

public double component6()

The intent evaluated probability.

component7

public double component7()

The average entity evaluation probability.

component8

@NotNull
public java.lang.String component8()

The analysed query.

component9

@NotNull
public java.util.Map<java.lang.String,java.lang.Double> component9()

Other intents with significant probabilities.

component10

@Nullable
public java.lang.String component10()

The static text response possibly returned for the

class NlpQuery

See Also:

class NlpQuery

copy

@NotNull
public NlpResult copy(@NotNull
                               java.lang.String intent,
                               @NotNull
                               java.lang.String intentNamespace,
                               @NotNull
                               java.util.Locale language,
                               @NotNull
                               java.util.List<ai.tock.nlp.api.client.model.NlpEntityValue> entities,
                               @NotNull
                               java.util.List<ai.tock.nlp.api.client.model.NlpEntityValue> notRetainedEntities,
                               double intentProbability,
                               double entitiesProbability,
                               @NotNull
                               java.lang.String retainedQuery,
                               @NotNull
                               java.util.Map<java.lang.String,java.lang.Double> otherIntentsProbabilities,
                               @Nullable
                               java.lang.String staticResponse)

The result of the class NlpQuery.

See Also:

class NlpQuery

toString

@NotNull
public java.lang.String toString()

The result of the class NlpQuery.

See Also:

class NlpQuery

hashCode

public int hashCode()

The result of the class NlpQuery.

See Also:

class NlpQuery

equals

public boolean equals(@Nullable
                      java.lang.Object p)

The result of the class NlpQuery.

See Also:

class NlpQuery