Accessing the Search API

By default, when you install a Exalead CloudView product, the commands are available at http://<HOSTNAME>:<BASEPORT+10>.

For example, a search command called search-api is installed, and is available at http://<HOSTNAME>:<BASEPORT+10>/search-api.

The main types of Search API commands are:

• Search: performs searches on the Exalead CloudView index

• Query expansion: provides query expansion on queries

• Spell check: runs spell checking requests on queries

• Suggest: provides the suggest service on queries

• Dictionary: retrieves term, ngrams, phonetized forms, query approximation & regexp frequencies on a dictionary

• Document fetch: retrieves documents from the connectors

• Preview: retrieves rich HTML preview of the documents

• Thumbnail: retrieves image thumbnails of the documents

• Security: authenticates users and get tokens against security sources

The commands are available at: http://<SEARCH_API_HOST>:<SEARCH_API_PORT>/<COMMAND_PATH>

Command	<COMMAND_PATH>	Java client class	.NET client class
Search	/search-api/search	SearchClient	SearchClient
Query expansion	/expansion It supports all Search Command parameters.	n/a	n/a
Spell check	/spellcheck	SpellCheckClient	n/a
Suggest	/suggest/service/SUGGEST_NAME or /suggest/dispatcher/DISPATCHER_NAME	SuggestClient	Suggester*
Dictionary	/dictionary	DictionaryClient	n/a
Document fetch	/fetch	FetchClient	Fetcher*
Preview	/preview	FetchClient	Fetcher*
Thumbnail	/thumbnail	FetchClient	Fetcher*
Security	/security/SOURCE_NAME	SecurityClient	AuthenticationClient*
Search introspection	/introspection/PARAMETER It supports all Search Command parameters.	n/a	n/a

For a complete list of command parameters, see Appendix - Search API Parameters in the Exalead CloudView Configuration Guide.