
public final class ParseResult

A NLP parse result.

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`intent`
`private final String`	`intentNamespace`
`private final Locale`	`language`
`private final List<ParsedEntityValue>`	`entities`
`private final List<ParsedEntityValue>`	`notRetainedEntities`
`private final Double`	`intentProbability`
`private final Double`	`entitiesProbability`
`private final String`	`retainedQuery`
`private final Map<String, Double>`	`otherIntentsProbabilities`

Constructor Summary

Constructors
Constructor	Description
`ParseResult(String intent, String intentNamespace, Locale language, List<ParsedEntityValue> entities, List<ParsedEntityValue> notRetainedEntities, Double intentProbability, Double entitiesProbability, String retainedQuery, Map<String, Double> otherIntentsProbabilities)`

Method Summary

Modifier and Type	Method	Description
`final ParsedEntityValue`	`firstValue(String role)`	Returns the first value for the specified entity role.
`final ParseResult`	`obfuscate(List<IntRange> obfuscatedRanges)`	Obfuscates the result.
`final String`	`component1()`
`final String`	`component2()`
`final Locale`	`component3()`
`final List<ParsedEntityValue>`	`component4()`
`final List<ParsedEntityValue>`	`component5()`
`final Double`	`component6()`
`final Double`	`component7()`
`final String`	`component8()`
`final Map<String, Double>`	`component9()`
`final ParseResult`	`copy(String intent, String intentNamespace, Locale language, List<ParsedEntityValue> entities, List<ParsedEntityValue> notRetainedEntities, Double intentProbability, Double entitiesProbability, String retainedQuery, Map<String, Double> otherIntentsProbabilities)`
`final String`	`getIntent()`	The intent selected.
`final String`	`getIntentNamespace()`	The namespace of the selected intent.
`final Locale`	`getLanguage()`	The language selected.
`final List<ParsedEntityValue>`	`getEntities()`	The selected entities.
`final List<ParsedEntityValue>`	`getNotRetainedEntities()`	The entities found but not retained.
`final Double`	`getIntentProbability()`	The intent evaluated probability.
`final Double`	`getEntitiesProbability()`	The average entity evaluation probability.
`final String`	`getRetainedQuery()`	The analysed query.
`final Map<String, Double>`	`getOtherIntentsProbabilities()`	Other intents with significant probabilities.

Methods inherited from class ai.tock.nlp.front.shared.parser.ParseResult
equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParseResult

ParseResult(String intent, String intentNamespace, Locale language, List<ParsedEntityValue> entities, List<ParsedEntityValue> notRetainedEntities, Double intentProbability, Double entitiesProbability, String retainedQuery, Map<String, Double> otherIntentsProbabilities)

Method Detail

firstValue
```
 final ParsedEntityValue firstValue(String role)
```
Returns the first value for the specified entity role.

obfuscate

 final ParseResult obfuscate(List<IntRange> obfuscatedRanges)

Obfuscates the result.

component1
```
 final String component1()
```

component2
```
 final String component2()
```

component3
```
 final Locale component3()
```

component4

 final List<ParsedEntityValue> component4()

component5

 final List<ParsedEntityValue> component5()

component6
```
 final Double component6()
```

component7
```
 final Double component7()
```

component8
```
 final String component8()
```

component9
```
 final Map<String, Double> component9()
```

copy

 final ParseResult copy(String intent, String intentNamespace, Locale language, List<ParsedEntityValue> entities, List<ParsedEntityValue> notRetainedEntities, Double intentProbability, Double entitiesProbability, String retainedQuery, Map<String, Double> otherIntentsProbabilities)

getIntent
```
 final String getIntent()
```
The intent selected.

getIntentNamespace
```
 final String getIntentNamespace()
```
The namespace of the selected intent.

getLanguage
```
 final Locale getLanguage()
```
The language selected.

getEntities

 final List<ParsedEntityValue> getEntities()

The selected entities.

getNotRetainedEntities

 final List<ParsedEntityValue> getNotRetainedEntities()

The entities found but not retained.

getIntentProbability
```
 final Double getIntentProbability()
```
The intent evaluated probability.

getEntitiesProbability
```
 final Double getEntitiesProbability()
```
The average entity evaluation probability.

getRetainedQuery
```
 final String getRetainedQuery()
```
The analysed query.

getOtherIntentsProbabilities
```
 final Map<String, Double> getOtherIntentsProbabilities()
```
Other intents with significant probabilities.

Class ParseResult

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ai.tock.nlp.front.shared.parser.ParseResult

Methods inherited from class java.lang.Object

Constructor Detail

ParseResult

Method Detail

firstValue

obfuscate

component1

component2

component3

component4

component5

component6

component7

component8

component9

copy

getIntent

getIntentNamespace

getLanguage

getEntities

getNotRetainedEntities

getIntentProbability

getEntitiesProbability

getRetainedQuery

getOtherIntentsProbabilities