Autocomplete

post/autocomplete

Retrieve query suggestions, operators and documents for the given partially typed query.

SecurityBearerAuth
Request
header Parameters
X-Glean-Auth-Type
string

Auth type being used to access the endpoint (should be non-empty only for global tokens).

X-Scio-Actas
string <email>

Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).

Request Body schema: application/json
required

Autocomplete request

Array of objects (AuthToken)

Auth tokens which may be used for federated results.

datasource
string

Filter to only return results relevant to the given datasource.

datasourcesFilter
Array of strings

Filter results to only those relevant to one or more datasources (e.g. jira, gdrive). Results are unfiltered if missing.

query
string

Partially typed query.

resultSize
integer

Maximum number of results to be returned. If no value is provided, the backend will cap at 200.

resultTypes
Array of strings

Filter to only return results of the given type(s). All types may be returned if omitted.

Items Enum: "ADDITIONAL_DOCUMENT" "APP" "BROWSER_HISTORY" "DATASOURCE" "DOCUMENT" "ENTITY" "GOLINK" "HISTORY" "NEW_CHAT" "OPERATOR" "OPERATOR_VALUE" "QUICKLINK" "SUGGESTION"
object (SessionInfo)
trackingToken
string
Responses
200

OK

Response Schema: application/json
backendTimeMillis
integer <int64>

Time in milliseconds the backend took to respond to the request.

object (ErrorInfo)
experimentIds
Array of integers <int64>

List of experiment ids for the corresponding request.

Array of objects (AutocompleteResultGroup)

Subsections of the results list from which distinct sections should be created.

Array of objects (AutocompleteResult)
object (SessionInfo)
trackingToken
string

An opaque token that represents this particular set of autocomplete results. To be used for /feedback reporting.

400

Invalid request

401

Not Authorized

429

Too Many Requests

Request samples
application/json
{
  • "trackingToken": "trackingToken",
  • "query": "what is a que",
  • "datasource": "GDRIVE",
  • "resultSize": 10
}
Response samples
application/json
{
  • "experimentIds": [
    • 0
    ],
  • "trackingToken": "trackingToken"
}