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),
  "defaultWebGroundingToggleOff": boolean,
  "vertexAiAgentConfigs": [
    {
      object (VertexAiAgentConfig)
    }
  ],
  "enabledActions": {
    string: {
      object (ActionList)
    },
    ...
  },
  "enabledTools": {
    string: {
      object (ToolList)
    },
    ...
  },
  "customerPolicy": {
    object (CustomerPolicy)
  },
  "vertexAiSearchToolConfig": {
    object (VertexAiSearchToolConfig)
  },
  "styleAndFormattingInstructions": string,
  "agentConfigs": [
    {
      object (AgentConfig)
    }
  ],
  "enableEndUserAgentCreation": boolean,
  "disableLocationContext": boolean
}
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.
defaultWebGroundingToggleOff

boolean

Optional. Mit diesem Feld wird die standardmäßige Umschaltfläche für die Web-Grundlage für Endnutzer gesteuert, wenn webGroundingType auf WEB_GROUNDING_TYPE_GOOGLE_SEARCH oder WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH festgelegt ist. Standardmäßig ist dieses Feld auf „false“ gesetzt. Wenn webGroundingType WEB_GROUNDING_TYPE_GOOGLE_SEARCH oder WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH ist, ist die Web-Fundierung für Endnutzer standardmäßig auf der Benutzeroberfläche aktiviert. Wenn der Wert „true“ festgelegt ist, wird die Ein-/Aus-Schaltfläche für die Fundierung standardmäßig in der Benutzeroberfläche deaktiviert. Endnutzer können die Web-Fundierung weiterhin in der Benutzeroberfläche aktivieren, wenn sie aktiviert ist.
vertexAiAgentConfigs[]
(deprecated)

object (VertexAiAgentConfig)

Optional. Verworfen: Wird durch Dialogflow-Agents in AgentService ersetzt. Liste der Vertex AI Agents, die über den Assistenten erreicht werden können.
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.
vertexAiSearchToolConfig

object (VertexAiSearchToolConfig)

Optional. Konfigurationsoptionen für das Vertex AI Search-Tool.
styleAndFormattingInstructions
(deprecated)

string

Optional. Verworfen. Verwenden Sie stattdessen [addtional_system_instructions][GenerationConfig.SystemInstruction.additional_system_instructions]. Häufig verwendeter Systemanweisungs-Snippet zum Festlegen von Konversationsstil, Ton und Formatierung. Wird allen LLM-Prompts über den Platzhalter [STYLE_AND_FORMATTING_INSTRUCTIONS] hinzugefügt.
agentConfigs[]

object (AgentConfig)

Optional. Liste der Agents, die über den Assistenten erreicht werden können.
enableEndUserAgentCreation

boolean

Optional. Gibt an, ob Endnutzer Agents im Agentspace erstellen dürfen.
disableLocationContext

boolean

Optional. Gibt an, ob der Kontext des Nutzerstandorts deaktiviert werden soll. Der Kontext des Nutzerstandorts ist standardmäßig aktiviert.

GenerationConfig

Konfiguration für die Generierung der Assistentenantwort.

JSON-Darstellung 
{
  "systemInstruction": {
    object (SystemInstruction)
  },
  "defaultLanguage": string
}
Felder
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.

VertexAiAgentConfig

Verworfen: Nutzen Sie stattdessen Dialogflow-Agents in AgentService. Stellt einen externen Vertex AI-Agent dar, der über den Assistenten erreicht werden kann.

JSON-Darstellung 
{
  "displayName": string,
  "name": string,
  "toolDescription": string
}
Felder
displayName

string

Erforderlich. Anzeigename des Vertex AI-Agents, der als Referenz im Assistenten verwendet wird.
name

string

Erforderlich. Ressourcenname des Vertex AI-Agents. Format: projects/{project}/locations/{location}/agents/{agent}
toolDescription

string

Erforderlich. Die Tool-Beschreibung des Vertex AI-Agents. Anhand dieser Beschreibung entscheidet das LLM, ob der Agent für die Frage des Nutzers relevant ist und an den Agent weitergeleitet werden soll.

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.

VertexAiSearchToolConfig

Konfigurationsoptionen für das Vertex AI Search-Tool, das der Assistent bei der Verarbeitung von Abfragen verwenden kann.

JSON-Darstellung 
{
  "llmSystemInstructions": string
}
Felder
llmSystemInstructions
(deprecated)

string

Verworfen. Bitte verwenden Sie dieses Feld nicht. Systemanweisungen für die Beantwortung auf Grundlage der Suchergebnisse von Vertex AI Search. Die vom Suchtool generierte Antwort kann sich von der endgültigen Antwort des Assistenten unterscheiden.

Im Allgemeinen sind Systemanweisungen eine Reihe von Anweisungen in natürlicher Sprache, die vom Modell verarbeitet werden, bevor es Prompts verarbeitet. Sie geben dem Modell vor, wie es sich verhalten und auf Prompts reagieren soll. Weitere Informationen finden Sie unter https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions.

Beispiel: „Verwende zur Beantwortung der Frage nur Informationen aus den Quellen. Formatiere die Antwort außerdem mit Markdown.“

Wenn nicht angegeben, wird der interne Standardwert verwendet.

AgentConfig

Konfigurationsoptionen für die Agents, die der Assistent bei der Verarbeitung von Abfragen aufrufen darf.

JSON-Darstellung 
{
  "id": string,
  "displayName": string,
  "toolDescription": string,
  "icon": {
    object (Image)
  },
  "authorizations": [
    string
  ],

  // Union field connection_info can be only one of the following:
  "vertexAiSdkAgentConnectionInfo": {
    object (VertexAiSdkAgentConnectionInfo)
  },
  "httpAgentConnectionInfo": {
    object (HttpAgentConnectionInfo)
  }
  // End of list of possible types for union field connection_info.
}
Felder
id

string

Erforderlich. Eine eindeutige, menschenlesbare ID für den Agent. Muss diesem regulären Ausdruck entsprechen: [a-z][a-zA-Z0-9_-]*.
displayName

string

Erforderlich. Anzeigename des Vertex AI-Agents, der als Referenz im Assistenten verwendet wird.
toolDescription

string

Erforderlich. Die Tool-Beschreibung des Agents. Anhand dieser Beschreibung entscheidet das LLM, ob der Agent für die Frage des Nutzers relevant ist und an den Agent weitergeleitet werden soll.
icon

object (Image)

Erforderlich. Das Symbol, das den Agent in der Benutzeroberfläche darstellt.
authorizations[]

string

Optional. Ressourcennamen der erforderlichen Autorisierungen. Wenn der Nutzer nicht autorisiert ist, gibt der Dienst einige Autorisierungs-URIs zurück, die der Nutzer in einem Browser öffnen und autorisieren muss. Sobald alle Autorisierungen erteilt wurden, kann der Nutzer die Abfrage noch einmal versuchen. Die Autorisierungen werden dann an den Agent weitergeleitet.

Format: projects/{project}/locations/{location}/authorizations/{authorization}
Union-Feld connection_info. Die Verbindungskonfiguration des Agents. Für connection_info ist nur einer der folgenden Werte zulässig:
vertexAiSdkAgentConnectionInfo

object (VertexAiSdkAgentConnectionInfo)

Erforderlich. Verbindungsinformationen für einen Vertex AI SDK-Agent.
httpAgentConnectionInfo

object (HttpAgentConnectionInfo)

Erforderlich. Verbindungsinformationen für einen HTTP-Agent.

VertexAiSdkAgentConnectionInfo

Verbindungsinformationen für einen Vertex AI SDK-Agent. Derzeit werden nur Agents unterstützt, die über Problemlösungs-Engines bereitgestellt werden.

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

string

Der Ressourcenname der Problemlösungs-Engine, die den Agent bereitstellt. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}

HttpAgentConnectionInfo

Ein Agent, der über HTTP vom Assistenten erreichbar ist.

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

string

Erforderlich. Die HTTP-Adresse des Agents, z. B. „https://beispiel.de/agent1“.

Bild

Stellt ein Bild dar.

JSON-Darstellung 
{

  // Union field storage_method can be only one of the following:
  "uri": string,
  "content": string
  // End of list of possible types for union field storage_method.
}
Felder
Union-Feld storage_method. Kann entweder ein URI oder der als Base64-String codierte Inhalt sein. Für storage_method ist nur einer der folgenden Werte zulässig:
uri

string

Erforderlich. Bild-URI.
content

string

Erforderlich. Base64-codierter Inhalt der Bilddatei.

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.

listAvailableAgentViews

 Listet die Daten für die Anzeige der Agents unter einem Assistant auf, die für den Aufrufer verfügbar sind.

patch

 Aktualisiert einen Assistant.

streamAssist

 Unterstützt den Nutzer bei einer Abfrage durch Streaming.