Expand Terms

Returns a list of matching possible terms for a wildcard, stem, or fuzzy expansion.

The Expand Terms API returns a list of terms that match a term that you provide, according to a specified expansion.

Quick Start

The Expand Terms API has two required parameters, text and expansion. You set the text parameter to the term that you want to expand, and expansion to the method you want to use to expand the term.

For example:

/1/api/[async|sync]/expandterms/v1?text=probabilit*&expansion=wild

Note: You can use the file, reference and url parameters to submit input as a file, Haven OnDemand object store reference, or URL. However, in all cases, the API accepts only a single term.

There are three different expansions available:

Fuzzy. Return a list of words with a similar spelling to the word you provide. For example, if you provide the term fassion, it might return the terms fashion and fission.

The API expands the term by comparing it to unstemmed terms in a common English reference source. It finds the terms in this source that are similar to the original term (according to an internally-configured tolerance level).

You can use this to find corrections for a misspelled term.

Stem. Returns a list of terms that have the same stem as the word you provide.

Stems are the common roots for similar words, such as plurals and verb forms. For example, the terms helpful, helping, and helps all stem to help. The API stems the term that you provide, and compares it to unstemmed terms in a common English reference source. It finds the terms in this source that have the same stem as the original term.

You can use this expansion to find more information about what a particular keyword query might return.

Wild. Returns a list of the terms that match a wildcard term that you provide. For example, if you provide the term f*ion, it might return the terms function, faction, fashion, fission, and fusion.

You can use a question mark (?) to represent a single unknown character, and an asterisk (*) to represent any number of unknown characters (including zero).

The API expands the term by comparing it to terms in a common English reference source. It finds the terms that match the wildcard pattern.

You can use this expansion to find more information about what a wildcard query might match.

By default the results are listed in their stemmed form (the word root). You can optionally set the stemming parameter to false to return the full unstemmed results.

The max_terms parameter allows you to choose the maximum number of terms to return. You can use the sort parameter to return the results in alphabetical order, or in order of the number of documents the expansion occurs in.

Haven OnDemand uses cookies to enhance and improve the experience it provides. By continuing to use this site or pressing Continue,
we will assume that you accept receiving all cookies. If you would like to change which cookies are set, you can change your settings.