API Stability Preview

The queryAssistance() GraphQL query is used to return query assistance for the given search, as well as the assistant version. This is a preview and subject to change.

Syntax

Below is the syntax for the queryAssistance() query field:

graphql
queryAssistance(
      search: string!, remapFields: boolean!
   ): QueryAssistantResult!

The input calls for standard datatypes. For QueryAssistantResult, there is a special datatypes. See the Returned Datatypes section. Here's an example of how this query field might be used:

Show:
graphql
query {
  queryAssistance(search:"127.0.0.1", remapFields: false)
  {version, assistance{__typename} }
}
Example Responses
Show:
json
{
  "data": {
    "queryAssistance": {
      "version": "1.1-0e71eb90c9",
      "assistance": {
        "__typename": "QueryAssistantError"
      }
    }
  }
}

Returned Datatypes

For QueryAssistantResult, there are a couple of parameters and a sub-parameters. Below is a list of the parameters with links to the sub-parameter:

Table: QueryAssistantResult

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Oct 2, 2024
assistanceQueryAssistantAssistanceyes PreviewThe query assistance for the given search. Can be either a successful or an error. See QueryAssistantSuccess and QueryAssistantError.
versionstringyes PreviewThe assistant version.