ai.tock.nlp.core

Interface NlpCore

public NlpCore

The main entry point for NLP.

Method Summary

Modifier and Type	Method and Description
java.util.List<ai.tock.nlp.core.EntityRecognition>	evaluateEntities(CallContext context, java.lang.String text, java.util.List<ai.tock.nlp.core.EntityRecognition> entities) Evaluate entity values.
java.util.Set<java.lang.String>	getBuiltInEntityTypes() Returns all built-in entities.
boolean	healthcheck() Check engines availability.
ValueDescriptor	mergeValues(CallContext context, Entity entity, java.util.List<ai.tock.nlp.core.merge.ValueDescriptor> values) Merge two or more values for the given class Entity.
ParsingResult	parse(CallContext context, java.lang.String text, IntentSelector intentSelector) Parse text with NLP engine.
boolean	supportValuesMerge(EntityType entityType) Does the given class EntityType supports values merge?
java.util.Set<ai.tock.nlp.core.NlpEngineType>	supportedNlpEngineTypes() Supported nlp engines.

Method Detail

getBuiltInEntityTypes

@NotNull
java.util.Set<java.lang.String> getBuiltInEntityTypes()

Returns all built-in entities.

Returns:

the built-in entity types (namespace:name)

parse

@NotNull
ParsingResult parse(@NotNull
                             CallContext context,
                             @NotNull
                             java.lang.String text,
                             @NotNull
                             IntentSelector intentSelector)

Parse text with NLP engine.

supportedNlpEngineTypes

@NotNull
java.util.Set<ai.tock.nlp.core.NlpEngineType> supportedNlpEngineTypes()

Supported nlp engines.

evaluateEntities

@NotNull
java.util.List<ai.tock.nlp.core.EntityRecognition> evaluateEntities(@NotNull
                                                                             CallContext context,
                                                                             @NotNull
                                                                             java.lang.String text,
                                                                             @NotNull
                                                                             java.util.List<ai.tock.nlp.core.EntityRecognition> entities)

Evaluate entity values.

Parameters:

context - the call context

text - the query

entities - the not yet evaluated identified entities

Returns:

the evaluated entities

supportValuesMerge

boolean supportValuesMerge(@NotNull
                           EntityType entityType)

Does the given class EntityType supports values merge?

See Also:

class EntityType

mergeValues

@Nullable
ValueDescriptor mergeValues(@NotNull
                                      CallContext context,
                                      @NotNull
                                      Entity entity,
                                      @NotNull
                                      java.util.List<ai.tock.nlp.core.merge.ValueDescriptor> values)

Merge two or more values for the given class Entity.

See Also:

class Entity

healthcheck

boolean healthcheck()

Check engines availability.