Method: instances.translateUdmQuery

Full name: projects.locations.instances.translateUdmQuery

Translate natural language to a UDM Search query.

HTTP request

POST https://chronicle.googleapis.com/v1alpha/{instance}:translateUdmQuery

Path parameters

Parameters
instance

string

Required. The Chronicle instance associated with the request. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "text": string
}
Fields
text

string

Required. Natural language text to be translated to a UDM Search query.

Response body

Response message for TranslateUDMQuery.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "query": string,
  "time_range": {
    object (Interval)
  },
  "message": string
}
Fields
query

string

Translated UDM Search query (if successful).
time_range

object (Interval)

Optional. Translated timerange (if the user specified a time range).
message

string

Optional. Message to be shown to the user, e.g. if the translation was unsuccessful or if confidence is low.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the instance resource:

  • chronicle.ais.translateYlRule

For more information, see the IAM documentation.