Google Search Appliance Protocol Reference - Manual (Page 98)

Google Search Appliance: Search Protocol Reference Query Suggestion Service /suggest Protocol 98
Response:
[ "", "", ..., "" ]
Or, if no result:
[]
OpenSearch Format
The os format uses the OpenSearch protocol.
Request:
/suggest?q=&max=&site=&client=&
format=os
Parameter Description Default Value
callback Provides a JSONP compatible response from suggest. If you
set callback=test, it will return:
/* GSA Suggest Service JSONP Response. */
test();
The prefix /* GSA Suggest Service JSONP Response. */ is
hard-coded in the response to safeguard against cross-site
scripting attacks on the JSONP callback name. You must
remove the prefix before the response can be parsed by
JavaScript.
client Front end name. default_frontend
format The output format in which the client wants the results. os
max The maximum number of results that the suggest server
should return. The minimum is 0, which indicates that the
server should return an empty set, however this result
would not be meaningful.
The maximum is not defined. If this parameter is not set,
then the default value is 10 possible matches. If fewer
suggestions are configured, then they are returned.
10 (matches)
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