Discovery Engine API (discoveryengine:v1alpha)

Additions

Methods


• ▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.get

  HTTP Method : GET

  Scopes :

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

  Path : v1alpha/{+name}

  Description : Gets a CannedQuery.

  Parameter Order : name

  Parameters :

  name

  Required : Yes

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/cannedQueries/[^/]+$

  Description : Required. Resource name of CannedQuery. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}`

  Location : path

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/cannedQueries/{cannedQueriesId}

• ▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.delete

  Description : Deletes a CannedQuery.

  Parameters :

  name

  Required : Yes

  Description : Required. Resource name of CannedQuery. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` If the caller does not have permission to delete the canned query, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the canned query to delete does not exist, a `NOT_FOUND` error is returned.

  Location : path

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/cannedQueries/[^/]+$

  HTTP Method : DELETE

  Scopes :

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

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/cannedQueries/{cannedQueriesId}

  Path : v1alpha/{+name}

  Parameter Order : name

• ▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.patch

  HTTP Method : PATCH

  Description : Updates a CannedQuery.

  Path : v1alpha/{+name}

  Scopes :

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

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/cannedQueries/{cannedQueriesId}

  Parameter Order : name

  Parameters :

  name

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/cannedQueries/[^/]+$

  Description : Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.

  Required : Yes

  Type : string

  Location : path

  updateMask

  Description : The list of fields to update.

  Format : google-fieldmask

  Type : string

  Location : query

• ▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.create

  Parameters :

  parent

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$

  Location : path

  Required : Yes

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

  Type : string

  cannedQueryId

  Type : string

  Location : query

  Description : 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](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.

  Description : Creates a CannedQuery.

  Parameter Order : parent

  Path : v1alpha/{+parent}/cannedQueries

  Scopes :

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

  HTTP Method : POST

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/cannedQueries

• ▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.list

  Path : v1alpha/{+parent}/cannedQueries

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/cannedQueries

  Scopes :

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

  Parameter Order : parent

  HTTP Method : GET

  Description : Lists all CannedQuerys under an Assistant.

  Parameters :

  parent

  Location : path

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$

  Required : Yes

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

  filter

  Description : Optional. The filter expression. Supported fields: * `enabled` * `google_defined` Examples: * `enabled=true` * `google_defined=true` * `enabled=true AND google_defined=true`

  Type : string

  Location : query

  pageToken

  Location : query

  Type : string

  Description : A page token received from a previous CannedQueryService.ListCannedQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CannedQueryService.ListCannedQueries must match the call that provided the page token.

  pageSize

  Location : query

  Format : int32

  Description : Maximum number of canned queries to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.

  Type : integer