com.rabidgremlin.mutters.core.IntentMatcher Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mutters-core Show documentation

A framework for building bots.

There is a newer version: 7.1.0

package com.rabidgremlin.mutters.core;

import java.util.HashMap;
import java.util.Set;

/**
 * This is the interface implemented by any intent matcher. It should take an user's utterance (and a context) and
 * return an intent match.
 * 
 * If no match can be found it should return null.
 * 
 * @author rabidgremlin
 *
 */
public interface IntentMatcher
{
  /**
   * This returns the best intent match for the user's utterance. Can return null to indicate no good match found.
   * 
   * @param utterance The user's utterance.
   * @param context The user's context, helps with extracting data from the user's utterance.
   * @param expectedIntents Set of intent names that we expect to match on. Matcher will only return a match from this
   *          set. Can be null if matcher should match against any intent.
   * @param debugValues Map of debug values. Pass in null if no debug values required.
   * @return The best intent match or null if no good match.
   */
  IntentMatch match(String utterance, Context context, Set expectedIntents, HashMap debugValues);

}