com.avaya.collaboration.call.speech.search

Interface SearchOptions

public interface SearchOptions

Options for Speech Search including the search queries, and language details.

The search queries included in the search options must match the language of search options otherwise an InvalidSearchQueryException is thrown.

Since:

3.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_LANGUAGE The default language.

Method Summary

Methods

Modifier and Type	Method and Description
String	getLanguage() The language used in the speech search.
MatchReportingStrategy	getMatchReportingStrategy() The match reporting strategy which can be either a summary or detailed.
Collection	getSearchQueries() The collection of search queries used in the speech search.
SearchOptions	setLanguage(String language) Set the language used for the speech search.
SearchOptions	setMatchReportingStrategy(MatchReportingStrategy strategy) Sets the match reporting strategy that tunes the reporting of the matches found during a speech search.
SearchOptions	setSearchQuery(SearchQuery[] queries) Set the search queries used for the speech search.

Field Detail

DEFAULT_LANGUAGE

static final String DEFAULT_LANGUAGE

The default language.

See Also:

Constant Field Values

Method Detail

getLanguage

String getLanguage()

The language used in the speech search.

Returns:

the language.

setLanguage

SearchOptions setLanguage(String language)

Set the language used for the speech search.

Well-formed language values have the form comprising of a ISO 639 alpha-2 or alpha-3 language code and the possibility of a ISO 3166 alpha-2 country code.

The following are all examples of well-formed language codes:

• "en" (English)
• "de" (German)
• "en_US" (US English)
• "de_AT" (Austrian German)

If no ISO 639 language code is specified the default ("en_US") is assumed.

The IANA Language Subtag Registry maintains an active directory of valid language and country codes.

Parameters:

language - the ISO 639 language code (and optional ISO 3166 country code) used for the speech search

Returns:

the search options.

See Also:

IANA Language Subtag Registry

getSearchQueries

Collection getSearchQueries()

The collection of search queries used in the speech search.

Returns:

collection of queries.

setSearchQuery

SearchOptions setSearchQuery(SearchQuery[] queries)
                             throws InvalidSearchQueryException

Set the search queries used for the speech search.

Parameters:

queries - the search queries used for the search.

Returns:

the search options

Throws:

InvalidSearchQueryException

getMatchReportingStrategy

MatchReportingStrategy getMatchReportingStrategy()

The match reporting strategy which can be either a summary or detailed.

Returns:

the match reporting strategy

setMatchReportingStrategy

SearchOptions setMatchReportingStrategy(MatchReportingStrategy strategy)

Sets the match reporting strategy that tunes the reporting of the matches found during a speech search. If no match reporting strategy is provided, ALL is assumed.