ai.tock.nlp.front.shared.parser

Class ParseResult

ai.tock.nlp.front.shared.parser.ParseResult

public class ParseResult

A NLP parse result.

Constructor Detail

ParseResult

public ParseResult(@NotNull
                   java.lang.String intent,
                   @NotNull
                   java.lang.String intentNamespace,
                   @NotNull
                   java.util.Locale language,
                   @NotNull
                   java.util.List<ai.tock.nlp.front.shared.parser.ParsedEntityValue> entities,
                   @NotNull
                   java.util.List<ai.tock.nlp.front.shared.parser.ParsedEntityValue> notRetainedEntities,
                   double intentProbability,
                   double entitiesProbability,
                   @NotNull
                   java.lang.String retainedQuery,
                   @NotNull
                   java.util.Map<java.lang.String,java.lang.Double> otherIntentsProbabilities)

A NLP parse result.

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.

Method Detail

firstValue

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

Returns the first value for the specified entity role.

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.front.shared.parser.ParsedEntityValue> getEntities()

The selected entities.

getNotRetainedEntities

@NotNull
public java.util.List<ai.tock.nlp.front.shared.parser.ParsedEntityValue> 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.

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.front.shared.parser.ParsedEntityValue> component4()

The selected entities.

component5

@NotNull
public java.util.List<ai.tock.nlp.front.shared.parser.ParsedEntityValue> 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.

copy

@NotNull
public ParseResult copy(@NotNull
                                 java.lang.String intent,
                                 @NotNull
                                 java.lang.String intentNamespace,
                                 @NotNull
                                 java.util.Locale language,
                                 @NotNull
                                 java.util.List<ai.tock.nlp.front.shared.parser.ParsedEntityValue> entities,
                                 @NotNull
                                 java.util.List<ai.tock.nlp.front.shared.parser.ParsedEntityValue> notRetainedEntities,
                                 double intentProbability,
                                 double entitiesProbability,
                                 @NotNull
                                 java.lang.String retainedQuery,
                                 @NotNull
                                 java.util.Map<java.lang.String,java.lang.Double> otherIntentsProbabilities)

A NLP parse result.

toString

@NotNull
public java.lang.String toString()

hashCode

public int hashCode()

equals

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