REST Resource: projects.locations.collections.engines.assistants.cannedQueries

Resource: CannedQuery

Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.

JSON representation 
{
  "name": string,
  "displayName": string,
  "defaultTexts": {
    object (CannedQueryTexts)
  },
  "localizedTexts": {
    string: {
      object (CannedQueryTexts)
    },
    ...
  },
  "requiredCapabilities": [
    {
      object (AssistantCapability)
    }
  ],
  "enabled": boolean,
  "googleDefined": boolean
}
Fields
name

string

Immutable. Resource name of the canned query. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{cannedQuery}

It must be a UTF-8 encoded string with a length limit of 1024 characters.
displayName

string

The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.
defaultTexts

object (CannedQueryTexts)

Required. The default (non-localized) values for the text attributes.
localizedTexts

map (key: string, value: object (CannedQueryTexts))

Optional. The translations of the text attributes. The keys should be BCP-47 language codes.
requiredCapabilities[]

object (AssistantCapability)

Optional. The capabilities the Assistant needs to have to use this canned query.
enabled

boolean

Whether this canned query is enabled.
googleDefined

boolean

Output only. Whether this is a Google-defined, read-only canned query.

CannedQueryTexts

The text pieces for the canned query, which can be localized.

JSON representation 
{
  "title": string,
  "prefix": string,
  "suggestedPrompts": [
    {
      object (SuggestedPrompt)
    }
  ]
}
Fields
title

string

Required. The title that is for the end user.
prefix

string

Optional. The prefix that suggestedPrompts should start with.
suggestedPrompts[]

object (SuggestedPrompt)

Required. The prompts the canned query will offer to the user.

SuggestedPrompt

A suggested prompt for the canned query.

JSON representation 
{
  "promptText": string
}
Fields
promptText

string

Required. The text of the suggested prompt.

AssistantCapability

Capability of an assistant needed to use this canned query.

JSON representation 
{

  // Union field capability can be only one of the following:
  "actionName": string
  // End of list of possible types for union field capability.
}
Fields
Union field capability. Capability of an assistant, either an action or a tool. capability can be only one of the following:
actionName

string

The name of the action that the Assistant needs to have set up to use this canned query.

Methods

create

 Creates a CannedQuery.

delete

 Deletes a CannedQuery.

get

 Gets a CannedQuery.

list

 Lists all CannedQuerys under an Assistant.

listActiveCannedQueryUserViews

 Lists the CannedQueryUserViews for all active CannedQuerys.

patch

 Updates a CannedQuery.