com.avaya.collaboration.call.speech.search.sample

Class SampleUnifiedSpeechCall

java.lang.Object

com.avaya.collaboration.call.CallListenerAbstract

com.avaya.collaboration.call.speech.search.sample.SampleUnifiedSpeechCall

All Implemented Interfaces:

CallListener

public class SampleUnifiedSpeechCall
extends CallListenerAbstract

Sample Code: Start a Speech Search on a call

The code below illustrates how to intercept a call and start a speech search. First, to be able to intercept a call, you must implement a class that is annotated with TheCallListener and either implement CallListener or extend CallListenerAbstract. This class is a "listener" that allows you to intercept a call.

Next, you must implement a "speech search listener" class that implements SpeechSearchListener. This class allows you to be notified when important events related to a speech search have occurred. Specifically, if a match occurs for a speech search, then the method matchFound will be called with the match details. If an error occurred starting a speech search then startSearchFailed will be called, otherwise if the search is terminated for any reason then terminated method will be called.

In the callIntercepted method shown below the following occurs:

• A search query is created
• The search query is added to the search options with the language details of the the search
• Speech search is started on the call (both parties) and a speech search listener is provided that provides callback.

The search query used in the sample is an example of a insurance sales call. The call is searched for the presence of three concepts:

1. Opening
2. Selling
3. Closing

In turn, the opening concept contains two sub concepts (greeting, introduction). The SpeechSearchListener will report matches for phrases and as they are matched the concepts.

Also in this example when a call is answered, a Text to Speech (TTS) message is played to the calling party to inform them that the call is being monitored for speech search. We implement a "media listener" and use it to listen for the play completed event. Our media listener then starts the Automatic Speech Recognition (ASR). We implement a "voicexml dialog listener" and use it to listen for the event when a menu selection is recognized.

 @TheCallListener
 public class SampleUnifiedSpeechCall extends CallListenerAbstract
 {
    private final Logger logger = Logger.getLogger(SampleUnifiedSpeechCall.class);

    protected class MySpeechSearchListener implements SpeechSearchListener
    {

         @Override
         public void matchFound(UUID searchId, Call call, List searchMatches)
         {
             for (SpeechSearchMatch match : searchMatches)
             {
                 logger.info("A match has been found for " + match.getName() + " at " + match.getStartTime() +
                         " seconds");
             }
         }

         @Override
         public void startSearchFailed(UUID searchId, Exception execption)
         {
             logger.info("The search failed due to errors[" + execption.getMessage()
                     + "]");
         }

         @Override
         public void terminated(UUID searchId, String reason)
         {
             logger.info("The search was terminated due to " + reason);
         }
     }

    protected class MyMediaListener extends MediaListenerAbstract implements VoiceXMLDialogListener
    {
        private final Participant participant;

        public MyMediaListener(final Participant participant)
        {
            this.participant = participant;
        }

        @Override
        public void playCompleted(final UUID requestId, final PlayOperationCause cause)
        {
            logger.info("playCompleted: We completed playing Text-to-speech. "
                    + "Next, send a VoiceXML dialog request for speech recognition.");

            VoiceXMLDialogItem dialogItem = null;
            try
            {
                dialogItem = SpeechFactory.createVoiceXMLDialogItem()
                        .setVoiceXMLScript(new URI("http: *www.mycompany.com/menu.vxml"));
            }
            catch (final URISyntaxException e)
            {
                logger.info("playCompleted: An error occured. Please check that your VoiceXML URL is valid.");
            }
            final UUID asrRequestId = SpeechFactory.createSpeechService()
                    .startVoiceXMLDialog(participant, dialogItem, this);
            logger.info("playCompleted: Search a voice recognition dialog with UUID " + asrRequestId);
        }

        @Override
        public void dialogEvent(final UUID requestId, final Map names,
                final VoiceXMLDialogCause dialogEvent)
        {
            logger.info("dialogEvent: We completed VoiceXML speech recognition.");
        }
    }

    @Override
    public void callIntercepted(final Call call)
    {
        final SearchQuery searchQuery = createSearchQuery();
        final SearchOptions options = SpeechFactory.createSearchOptions()
                .setLanguage("en_US").setSearchQuery(searchQuery);

        final UUID searchID = SpeechFactory.createSpeechService().startSearch(call,
                options, new MySpeechSearchListener());
        logger.info("callIntercepted: Search started with UUID " + searchID.toString());
    }

    @Override
    public void callAnswered(final Call call)
    {
        final Participant participant = call.getCallingParty();

        final MediaService mediaService = MediaFactory.createMediaService();
        PlayItem playItem = null;
        try
        {
            playItem = MediaFactory.createPlayItem()
                    .setSource("Your call is currently being monitored");
        }
        catch (final URISyntaxException e)
        {
            logger.info("callAnswered: An error occured. Please check that text to speech message is valid.");
        }
        final UUID ttsRequestId = mediaService.play(participant, playItem,
                 new MyMediaListener(participant));
        logger.info("callAnswered: Started a play request for a text to speech  with UUID " + ttsRequestId);
    }

     public SearchQuery createSearchQuery()
     {
         Concept greeting = SpeechFactory.createConcept()
                 .setName("Greeting")
                 .setOperator(SpeechFactory.createAnyOperator())
                 .setThreshold(45.0f)
                 .addPhrase("Good Morning", 45.0f)
                 .addPhrase("Hello", 45.0f);

         Concept introduction = SpeechFactory.createConcept()
                 .setName("Introduction of Agent and Department")
                 .setOperator(SpeechFactory.createAnyOperator())
                 .setThreshold(45.0f)
                 .addPhrase("Welcome to", 45.0f)
                 .addPhrase("My name is", 45.0f);

         Concept opening = SpeechFactory.createConcept()
                 .setName("Opening")
                 .setOperator(SpeechFactory.createAllOperator())
                 .setThreshold(45.0f)
                 .setSubConcepts(greeting, introduction);

         Concept selling = SpeechFactory.createConcept()
                 .setName("Selling")
                 .setOperator(SpeechFactory.createAllOperator())
                 .setThreshold(45.0f)
                 .addPhrase("Would you like to buy", 45.0f)
                 .addPhrase("Could I offer you", 45.0f);

         Concept closing = SpeechFactory.createConcept()
                 .setName("Closing")
                 .setOperator(SpeechFactory.createAllOperator())
                 .setThreshold(45.0f)
                 .addPhrase("Thank you for calling", 45.0f)
                 .addPhrase("We appreciate your call", 45.0f);

         return SpeechFactory.createSearchQuery()
                 .setLangauge("en_US")
                 .setConcepts(opening, selling, closing);

     }
 }

Constructor Summary

Constructors

Constructor and Description
SampleUnifiedSpeechCall()

Method Summary

Methods

Modifier and Type	Method and Description
void	callAnswered(Call call) When a call is answered, play a Text to Speech prompt to the calling party to inform them the call is being monitored for speech search.
void	callIntercepted(Call call) Intercept a call and start a speech search.
SearchQuery	createSearchQuery() Create a Search Query based on a insurance sales call.

Methods inherited from class com.avaya.collaboration.call.CallListenerAbstract

addParticipantFailed, callAlerting, callOriginated, callTerminated, mediaDetected, participantDropped

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SampleUnifiedSpeechCall

public SampleUnifiedSpeechCall()

Method Detail

callIntercepted

public void callIntercepted(Call call)

Intercept a call and start a speech search.

Parameters:

call - the intercepted call

callAnswered

public void callAnswered(Call call)

When a call is answered, play a Text to Speech prompt to the calling party to inform them the call is being monitored for speech search. - We use our Media Listener to listen for the when the text to speech play is completed. - Our Media Listener then starts the Automatic Speech Recognition.

Specified by:

callAnswered in interface CallListener

Overrides:

callAnswered in class CallListenerAbstract

Parameters:

call - instance of the call

createSearchQuery

public SearchQuery createSearchQuery()

Create a Search Query based on a insurance sales call.

Returns:

search query.