
public final class NlpResult

The result of the NlpQuery.

Field Summary

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

Constructor Summary

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

Method Summary

Modifier and Type	Method	Description
`final NlpEntityValue`	`firstValue(String role)`
`final String`	`entityTextContent(NlpEntityValue value)`
`final Boolean`	`hasIntent(String intent, Double minProbability)`
`final String`	`component1()`
`final String`	`component2()`
`final Locale`	`component3()`
`final List<NlpEntityValue>`	`component4()`
`final List<NlpEntityValue>`	`component5()`
`final Double`	`component6()`
`final Double`	`component7()`
`final String`	`component8()`
`final Map<String, Double>`	`component9()`
`final String`	`component10()`
`final NlpResult`	`copy(String intent, String intentNamespace, Locale language, List<NlpEntityValue> entities, List<NlpEntityValue> notRetainedEntities, Double intentProbability, Double entitiesProbability, String retainedQuery, Map<String, Double> otherIntentsProbabilities, String staticResponse)`
`final String`	`getIntent()`	The intent selected.
`final String`	`getIntentNamespace()`	the namespace of the selected intent.
`final Locale`	`getLanguage()`	The language selected.
`final List<NlpEntityValue>`	`getEntities()`	The selected entities.
`final List<NlpEntityValue>`	`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.
`final String`	`getStaticResponse()`	The static text response possibly returned for the NlpQuery

Methods inherited from class ai.tock.nlp.api.client.model.NlpResult
equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NlpResult

NlpResult(String intent, String intentNamespace, Locale language, List<NlpEntityValue> entities, List<NlpEntityValue> notRetainedEntities, Double intentProbability, Double entitiesProbability, String retainedQuery, Map<String, Double> otherIntentsProbabilities, String staticResponse)

Method Detail

firstValue

 final NlpEntityValue firstValue(String role)

entityTextContent

 final String entityTextContent(NlpEntityValue value)

hasIntent

 final Boolean hasIntent(String intent, Double minProbability)

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

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

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

component4

 final List<NlpEntityValue> component4()

component5

 final List<NlpEntityValue> component5()

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

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

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

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

component10
```
 final String component10()
```

copy

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

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<NlpEntityValue> getEntities()

The selected entities.

getNotRetainedEntities
```
 final List<NlpEntityValue> 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.

getStaticResponse
```
 final String getStaticResponse()
```
The static text response possibly returned for the NlpQuery

Class NlpResult

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ai.tock.nlp.api.client.model.NlpResult

Methods inherited from class java.lang.Object

Constructor Detail

NlpResult

Method Detail

firstValue

entityTextContent

hasIntent

component1

component2

component3

component4

component5

component6

component7

component8

component9

component10

copy

getIntent

getIntentNamespace

getLanguage

getEntities

getNotRetainedEntities

getIntentProbability

getEntitiesProbability

getRetainedQuery

getOtherIntentsProbabilities

getStaticResponse