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

Ressource: Assistant

Discovery Engine Assistant-Ressource

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "description": string,
  "generationConfig": {
    object (GenerationConfig)
  },
  "googleSearchGroundingEnabled": boolean,
  "webGroundingType": enum (WebGroundingType),
  "enabledActions": {
    string: {
      object (ActionList)
    },
    ...
  },
  "enabledTools": {
    string: {
      object (ToolList)
    },
    ...
  },
  "customerPolicy": {
    object (CustomerPolicy)
  }
}
Felder
name

string

Nicht veränderbar. Ressourcenname des Assistenten. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

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

string

Erforderlich. Der Anzeigename des Assistenten.

Es muss ein UTF-8-codierter String mit einer Längenbegrenzung von 128 Zeichen sein.
description

string

Optional. Beschreibung für weitere Informationen. Sollte in der Konfigurations-UI angezeigt werden, nicht den Nutzern des Assistenten.
generationConfig

object (GenerationConfig)

Optional. Konfiguration für die Generierung der Assistentenantwort.
googleSearchGroundingEnabled
(deprecated)

boolean

Optional. Verworfen. Verwenden Sie stattdessen webGroundingType.
webGroundingType

enum (WebGroundingType)

Optional. Der Typ der zu verwendenden Web-Fundierung.
enabledActions
(deprecated)

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

Optional. Verworfen: Wird stattdessen durch enabledTools ersetzt. Die aktivierten Aktionen für diesen Assistenten. Die Schlüssel sind Connectornamen, z. B. „projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector“. Die Werte bestehen aus vom Administrator aktivierten Aktionen für die Connector-Instanz. Administratoren können mehrere Aktionen für jede der Connector-Instanzen, die sie im Projekt erstellt haben, selektiv aktivieren. Beispiel: {"jira1ConnectorName": [(actionId1, "createTicket"), (actionId2, "transferTicket")], "gmail1ConnectorName": [(actionId3, "sendEmail"),..] }
enabledTools

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

Optional. Hinweis: Noch nicht implementiert. Verwenden Sie stattdessen enabledActions. Die aktivierten Tools für diesen Assistenten. Die Schlüssel sind Connectornamen, z. B. „projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector“. Die Werte bestehen aus vom Administrator aktivierten Tools für die Connector-Instanz. Administratoren können mehrere Tools für jede der Connector-Instanzen, die sie im Projekt erstellt haben, selektiv aktivieren. Beispiel: {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
customerPolicy

object (CustomerPolicy)

Optional. Kundenrichtlinie für den Assistenten.

GenerationConfig

Konfiguration für die Generierung der Assistentenantwort.

JSON-Darstellung 
{
  "defaultModelId": string,
  "allowedModelIds": [
    string
  ],
  "systemInstruction": {
    object (SystemInstruction)
  },
  "defaultLanguage": string
}
Felder
defaultModelId

string

Optional. Das Standardmodell, das für den Assistenten verwendet werden soll.
allowedModelIds[]

string

Optional. Die Liste der Modelle, die für den Assistenten verwendet werden dürfen.
systemInstruction

object (SystemInstruction)

Systemanweisung, auch als Prompt-Präambel für LLM-Aufrufe bezeichnet. Weitere Informationen unter https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions
defaultLanguage

string

Die Standardsprache, die für die Generierung der Assistentenantwort verwendet werden soll. Verwenden Sie einen ISO 639-1-Sprachcode wie en. Falls nicht angegeben, wird die Sprache automatisch erkannt.

SystemInstruction

Systemanweisung, auch als Prompt-Präambel für LLM-Aufrufe bezeichnet.

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

string

Optional. Zusätzliche Systemanweisung, die der Standard-Systemanweisung hinzugefügt wird.

WebGroundingType

Der Typ der zu verwendenden Web-Fundierung.

Enums
WEB_GROUNDING_TYPE_UNSPECIFIED Nicht spezifizierte Standardeinstellung. Dies entspricht „Deaktiviert“.
WEB_GROUNDING_TYPE_DISABLED Die Web-Fundierung ist deaktiviert.

ActionList

Verworfen: Wird stattdessen durch ToolList ersetzt. Die aktivierten Aktionen für einen Connector.

JSON-Darstellung 
{
  "actionInfo": [
    {
      object (ActionInfo)
    }
  ]
}
Felder
actionInfo[]

object (ActionInfo)

Die Liste der Aktionen mit den entsprechenden Aktionsinformationen

ActionInfo

Verworfen: Wird stattdessen durch ToolInfo ersetzt. Informationen zur Identifizierung einer Aktion.

JSON-Darstellung 
{
  "actionName": string,
  "actionDisplayName": string
}
Felder
actionName

string

Der Name der Aktion, wie er von DataConnectorService.QueryAvailableActions definiert wird
actionDisplayName

string

Der Anzeigename der Aktion

ToolList

Die aktivierten Tools für einen Connector

JSON-Darstellung 
{
  "toolInfo": [
    {
      object (ToolInfo)
    }
  ]
}
Felder
toolInfo[]

object (ToolInfo)

Die Liste der Tools mit den entsprechenden Tool-Informationen

ToolInfo

Informationen zur Identifizierung eines Tools

JSON-Darstellung 
{
  "toolName": string,
  "toolDisplayName": string
}
Felder
toolName

string

Der Name des Tools, wie er von DataConnectorService.QueryAvailableActions definiert wird Hinweis: In den DataConnectorService-APIs wird action verwendet, aber die Werte sind dieselben wie für tool.
toolDisplayName

string

Der Anzeigename des Tools

CustomerPolicy

Benutzerdefinierte Richtlinie für den Assistenten

JSON-Darstellung 
{
  "bannedPhrases": [
    {
      object (BannedPhrase)
    }
  ],
  "modelArmorConfig": {
    object (ModelArmorConfig)
  }
}
Felder
bannedPhrases[]

object (BannedPhrase)

Optional. Liste verbotener Ausdrücke.
modelArmorConfig

object (ModelArmorConfig)

Optional. Konfiguration „Model Armor“, die zum Bereinigen von Nutzer-Prompts und Assistentenantworten verwendet werden soll.

BannedPhrase

Definition eines benutzerdefinierten verbotenen Ausdrucks. Ein verbotener Ausdruck darf nicht in der Nutzerabfrage oder LLM-Antwort enthalten sein, da die Antwort sonst abgelehnt wird.

JSON-Darstellung 
{
  "phrase": string,
  "matchType": enum (BannedPhraseMatchType),
  "ignoreDiacritics": boolean
}
Felder
phrase

string

Erforderlich. Der zu sperrende Rohstring-Inhalt.
matchType

enum (BannedPhraseMatchType)

Optional. Keyword-Option für den verbotenen Ausdruck.
ignoreDiacritics

boolean

Optional. Wenn der Wert „true“ ist, werden diakritische Zeichen (z. B. Akzente, Umlaute) beim Abgleich mit verbotenen Ausdrücken ignoriert. So wird z. B. „Cafe“ genau wie „Café“ behandelt.

BannedPhraseMatchType

Die Abgleichsmethode für den verbotenen Ausdruck

Enums
BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED Die Standardeinstellung ist SIMPLE_STRING_MATCH.
SIMPLE_STRING_MATCH Der verbotene Ausdruck wird als Übereinstimmung erkannt, wenn er als exakter Teilstring an einer beliebigen Stelle im Text vorkommt.
WORD_BOUNDARY_STRING_MATCH Ein verbotener Ausdruck wird nur dann erkannt, wenn das im Text gefundene Muster von Worttrennzeichen umgeben ist. Der Ausdruck selbst kann trotzdem Worttrennzeichen enthalten.

ModelArmorConfig

Konfiguration für benutzerdefinierte Model Armor-Vorlagen, die zum Bereinigen von Nutzer-Prompts und Assistentenantworten verwendet werden.

JSON-Darstellung 
{
  "userPromptTemplate": string,
  "responseTemplate": string,
  "failureMode": enum (FailureMode)
}
Felder
userPromptTemplate

string

Optional. Der Ressourcenname der Model Armor-Vorlage zum Bereinigen von Nutzer-Prompts. Format: projects/{project}/locations/{location}/templates/{templateId}

Wenn nicht angegeben, wird der Nutzer-Prompt nicht bereinigt.
responseTemplate

string

Optional. Der Ressourcenname der Model Armor-Vorlage zum Bereinigen von Assistentenantworten. Format: projects/{project}/locations/{location}/templates/{templateId}

Wenn nicht angegeben, wird die Antwort des Assistenten nicht bereinigt.
failureMode

enum (FailureMode)

Optional. Definiert den Fehlermodus für die Bereinigung von Model Armor.

FailureMode

Bestimmt das Verhalten, wenn Model Armor eine Abfrage nicht verarbeiten kann.

Enums
FAILURE_MODE_UNSPECIFIED Nicht angegebener Fehlermodus; Standardverhalten ist FAIL_CLOSED.
FAIL_OPEN Bei einem Fehler während der Model Armor-Verarbeitung darf die Abfrage ohne Änderungen fortgesetzt werden.
FAIL_CLOSED Bei einem Fehler während der Model Armor-Verarbeitung wird die Abfrage abgelehnt.

Methoden

assist

 Unterstützt den Nutzer bei einer Abfrage.

create

 Erstellt einen Assistant.

delete

 Löscht einen Assistant.

get

 Ruft einen Assistant ab.

list

 Listet alle Assistants unter einer Engine auf.

patch

 Aktualisiert einen Assistant.

streamAssist

 Unterstützt den Nutzer bei einer Abfrage durch Streaming.