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

Ressource: CannedQuery

Ressource für Standardabfrage von Assistant. Sie stellt eine Abkürzung für den Start einer vordefinierten Unterhaltung dar.

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "defaultTexts": {
    object (CannedQueryTexts)
  },
  "localizedTexts": {
    string: {
      object (CannedQueryTexts)
    },
    ...
  },
  "activationBehavior": enum (ActivationBehavior),
  "requiredCapabilities": [
    {
      object (AssistantCapability)
    }
  ],
  "icon": string,
  "enabled": boolean,
  "googleDefined": boolean
}
Felder
name

string

Nicht veränderbar. Ressourcenname der Standardabfrage. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{cannedQuery}

Es muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein.
displayName

string

Der Anzeigename der Standardabfrage. Es muss ein UTF-8-codierter String mit einer Längenbeschränkung von 128 Zeichen sein.
defaultTexts

object (CannedQueryTexts)

Erforderlich. Die Standardwerte (nicht lokalisiert) für die Textattribute
localizedTexts

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

Optional. Die Übersetzungen der Textattribute. Die Schlüssel sollten BCP-47-Sprachcodes sein.
activationBehavior
(deprecated)

enum (ActivationBehavior)

Das Verhalten, wenn diese Standardabfrage aktiviert wird. Verworfen
requiredCapabilities[]

object (AssistantCapability)

Optional. Die Funktionen, die der Assistent benötigt, um diese Standardanfrage zu verwenden
icon

string

Der Name des Symbols aus der Google-Symbolbibliothek für die Standardabfrage
enabled

boolean

Gibt an, ob diese Standardabfrage aktiviert ist
googleDefined

boolean

Nur Ausgabe. Gibt an, ob es sich um eine von Google definierte, schreibgeschützte Standardabfrage handelt

CannedQueryTexts

Die Textteile für die Standardabfrage, die lokalisiert werden können

JSON-Darstellung 
{
  "title": string,
  "prefix": string,
  "description": string,
  "suggestedPrompts": [
    {
      object (SuggestedPrompt)
    }
  ],

  // Union field start_message can be only one of the following:
  "suggestedUserQuery": string,
  "assistantMessage": string,
  "userQuery": string
  // End of list of possible types for union field start_message.
}
Felder
title

string

Erforderlich. Der Titel für den Endnutzer
prefix

string

Optional. Das Präfix, mit dem suggestedPrompts beginnen soll
description
(deprecated)

string

Erforderlich. Die Beschreibung für den Endnutzer. Verworfen
suggestedPrompts[]

object (SuggestedPrompt)

Erforderlich. Die Aufforderungen, die dem Nutzer in der Standardabfrage angezeigt werden
Union-Feld start_message. Die Nachricht, die für den Beginn der Unterhaltung verwendet wird. Verworfen. Verwenden Sie stattdessen „suggested_prompts“. Für start_message ist nur einer der folgenden Werte zulässig:
suggestedUserQuery
(deprecated)

string

Verworfen. Verwenden Sie stattdessen userQuery. Der vorgefertigte Text für den vorgeschlagenen ersten Zug des Nutzers (z. B. „Generiere ein Katzenbild“)
assistantMessage
(deprecated)

string

Der vordefinierte Text für die erste Äußerung des Assistenten. Dies wird dem Nutzer angezeigt und er wird wahrscheinlich um eine Eingabe gebeten, z. B. „Welche Art von Inhalten möchten Sie erstellen (z. B. E-Mail, Artikel, Präsentation)?“. Verworfen
userQuery
(deprecated)

string

Der vorgefertigte Text für die erste Äußerung des Nutzers. Verworfen. Verwenden Sie stattdessen suggestedPrompts.

SuggestedPrompt

Ein vorgeschlagener Prompt für die Standardabfrage

JSON-Darstellung 
{
  "promptText": string
}
Felder
promptText

string

Erforderlich. Der Text des vorgeschlagenen Prompts

ActivationBehavior

Das Verhalten, wenn diese Standardabfrage aktiviert wird. Verworfen

Enums
ACTIVATION_BEHAVIOR_UNSPECIFIED Standardwert, sollte nicht verwendet werden. Standardwert ist NEW_SESSION.
NEW_SESSION Wenn Sie diese Standardanfrage verwenden, wird eine neue Assistentensitzung gestartet.
NEW_RESEARCH_ASSISTANT_SESSION Wenn Sie diese Standardabfrage verwenden, wird eine neue Recherche-Assistentensitzung gestartet.

AssistantCapability

Funktion eines Assistenten, die für die Verwendung dieser Standardanfrage erforderlich ist

JSON-Darstellung 
{

  // Union field capability can be only one of the following:
  "actionName": string
  // End of list of possible types for union field capability.
}
Felder
Union-Feld capability. Funktion eines Assistenten, entweder eine Aktion oder ein Tool. Für capability ist nur einer der folgenden Werte zulässig:
actionName

string

Der Name der Aktion, die der Assistant eingerichtet haben muss, um diese Standardanfrage zu verwenden

Methoden

create

 Erstellt eine CannedQuery

delete

 Löscht eine CannedQuery

get

 Erstellt eine CannedQuery

list

 Listet alle CannedQuerys unter einem Assistant auf

listActiveCannedQueryUserViews

 Listet die CannedQueryUserViews für alle aktiven CannedQuerys auf

patch

 Aktualisiert eine CannedQuery