Google Search Appliance Protocol Reference - Manual (Page 100)

Google Search Appliance: Search Protocol Reference Query Suggestion Service /suggest Protocol 100
Request:
/suggest?q=<query>&max=<num>&site=<collection>&client=<frontend>&format=rich
Response (wrapped for readability):
{
"query": "<query>",
"results": [
{ "name": "<term 1>", "type": "suggest"},
{ "name": "<term 2>", "type": "suggest"},
{ "name": "<term 3>", "type": "uar", "content": "Title of UAR",
"moreDetailsUrl": "URL of UAR"}
...,
]
}
Clients can distinguish between suggest and user-added results by looking at the type. The type can be
suggest or uar (user-added result) to identify the type of suggestion.
The style value is reserved and not used in version 6.2. For suggest entries, a term must be present.
For user-added results entries, moreDetailsUrl must be present.
If no result occurs, the rich format provides the following response:
{ "query": <query>, "results": [] }
q The partial query string that a user enters in the search box.
The minimum size is one character. If set to 0, that is, if the
search box is empty, then the suggest client side JavaScript
doesn’t send a request to query suggestion. Even if an
administrator implements a custom interface, sending an
empty token returns an empty set as the result. The
maximum size of the token parameter is not defined. None
site Collection name. default_collection
Parameter Description Default Value