Method: projects.locations.collections.engines.assistants.cannedQueries.create

Creates a CannedQuery.

HTTP request

POST https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/engines/*/assistants/*}/cannedQueries

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource name. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Query parameters

Parameters
cannedQueryId

string

Required. The ID to use for the canned query, which will become the final component of the canned query's resource name.

This field must conform to RFC-1034 with a length limit of 63 characters.

Request body

The request body contains an instance of CannedQuery.

Response body

If successful, the response body contains a newly created instance of CannedQuery.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.