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

Risorsa: Assistente

Risorsa Assistente Discovery Engine.

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "generationConfig": {
    object (GenerationConfig)
  },
  "googleSearchGroundingEnabled": boolean,
  "webGroundingType": enum (WebGroundingType),
  "defaultWebGroundingToggleOff": boolean,
  "mapsGroundingType": enum (MapsGroundingType),
  "defaultMapsGroundingToggleOff": 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,
  "createTime": string,
  "updateTime": string,
  "knowledgeCatalogEnabled": boolean
}
Campi
name

string

Immutabile. Nome risorsa dell'assistente. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Deve essere una stringa con codifica UTF-8 con un limite di lunghezza di 1024 caratteri.
displayName

string

Obbligatorio. Il nome visualizzato dell'assistente.

Deve essere una stringa con codifica UTF-8 con un limite di lunghezza di 128 caratteri.
description

string

Facoltativo. Descrizione per ulteriori informazioni. Previsto per essere mostrato nell'interfaccia utente di configurazione, non agli utenti dell'assistente.
generationConfig

object (GenerationConfig)

Facoltativo. Configurazione per la generazione della risposta dell'assistente.
googleSearchGroundingEnabled
(deprecated)

boolean

Facoltativo. Deprecato: utilizza webGroundingType.
webGroundingType

enum (WebGroundingType)

Facoltativo. Il tipo di grounding web da utilizzare.
defaultWebGroundingToggleOff

boolean

Facoltativo. Questo campo controlla l'attivazione/disattivazione predefinita della base web per gli utenti finali se webGroundingType è impostato su WEB_GROUNDING_TYPE_GOOGLE_SEARCH o WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. Per impostazione predefinita, questo campo è impostato su false. Se webGroundingType è WEB_GROUNDING_TYPE_GOOGLE_SEARCH o WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, l'utente finale avrà l'ancoraggio web attivato per impostazione predefinita nella UI. Se il valore è true, il pulsante di attivazione/disattivazione della base verrà disattivato per impostazione predefinita nell'UI. Gli utenti finali possono comunque attivare il grounding web nell'interfaccia utente se è abilitato.
mapsGroundingType

enum (MapsGroundingType)

Facoltativo. Il tipo di grounding di Google Maps da utilizzare.
defaultMapsGroundingToggleOff

boolean

Facoltativo. Questo campo controlla il pulsante di attivazione/disattivazione predefinito della base delle mappe per gli utenti finali se mapsGroundingType è impostato su MAPS_GROUNDING_TYPE_GOOGLE_MAPS. Per impostazione predefinita, questo campo è impostato su false. Se mapsGroundingType è MAPS_GROUNDING_TYPE_GOOGLE_MAPS, l'ancoraggio delle mappe sarà attivato per impostazione predefinita nell'interfaccia utente per gli utenti finali. Se è true, il pulsante di attivazione/disattivazione della messa a terra sarà impostato sulla posizione OFF nell'interfaccia utente. Se è abilitata, gli utenti finali possono comunque attivare la base delle mappe nell'interfaccia utente.
vertexAiAgentConfigs[]
(deprecated)

object (VertexAiAgentConfig)

Facoltativo. Ritirato: verrà sostituito dagli agenti Dialogflow in AgentService. Elenco degli agenti Vertex AI raggiungibili tramite l'assistente.
enabledActions
(deprecated)

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

Facoltativo. Deprecato: verrà sostituito da enabledTools. Le azioni attivate su questo assistente. Le chiavi sono il nome del connettore, ad esempio "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector. I valori sono costituiti dalle azioni abilitate dall'amministratore nei confronti dell'istanza del connettore. L'amministratore può attivare in modo selettivo più azioni su una qualsiasi delle istanze del connettore create nel progetto. Ad esempio {"jira1ConnectorName": [(actionId1, "createTicket"), (actionId2, "transferTicket")], "gmail1ConnectorName": [(actionId3, "sendEmail"),..] }
enabledTools

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

Facoltativo. Nota: non ancora implementata. Utilizza invece enabledActions. Gli strumenti attivati su questo assistente. Le chiavi sono il nome del connettore, ad esempio "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector". I valori sono costituiti da strumenti abilitati dall'amministratore per l'istanza del connettore. L'amministratore può attivare selettivamente più strumenti in una qualsiasi delle istanze del connettore create nel progetto. Ad esempio {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
customerPolicy

object (CustomerPolicy)

Facoltativo. Norme per i clienti per l'assistente.
vertexAiSearchToolConfig

object (VertexAiSearchToolConfig)

Facoltativo. Opzioni di configurazione per lo strumento Vertex AI Search.
styleAndFormattingInstructions
(deprecated)

string

Facoltativo. Deprecato: utilizza invece additionalSystemInstruction. Snippet di istruzioni di sistema comuni per impostare lo stile, il tono e la formattazione della conversazione. Aggiunto a tutti i prompt LLM tramite il segnaposto [STYLE_AND_FORMATTING_INSTRUCTIONS].
agentConfigs[]
(deprecated)

object (AgentConfig)

Facoltativo. Deprecato: utilizza invece AgentService. Elenco degli agenti raggiungibili tramite l'assistente.
enableEndUserAgentCreation

boolean

Facoltativo. Indica se gli utenti finali sono autorizzati a creare agenti in Agentspace.
disableLocationContext

boolean

Facoltativo. Indica se disattivare il contesto della posizione dell'utente. Per impostazione predefinita, il contesto della posizione dell'utente è abilitato.
createTime

string (Timestamp format)

Solo output. Rappresenta l'ora in cui è stato creato questo assistente.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo output. Rappresenta l'ora dell'ultimo aggiornamento dell'assistente.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
knowledgeCatalogEnabled

boolean

Facoltativo. Indica se Knowledge Catalog è abilitato per questo assistente specifico. Se abilitata, questa funzionalità utilizza i dati dell'organizzazione per fornire un contesto di scoperta. Se non specificato, il valore predefinito è true.

GenerationConfig

Configurazione per la generazione della risposta dell'assistente.

Rappresentazione JSON 
{
  "defaultModelId": string,
  "allowedModelIds": [
    string
  ],
  "systemInstruction": {
    object (SystemInstruction)
  },
  "defaultLanguage": string
}
Campi
defaultModelId

string

Facoltativo. Il modello predefinito da utilizzare per l'assistente.
allowedModelIds[]

string

Facoltativo. L'elenco dei modelli che possono essere utilizzati per l'assistente.
systemInstruction

object (SystemInstruction)

Istruzione di sistema, nota anche come preambolo del prompt per le chiamate LLM. Vedi anche https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions
defaultLanguage

string

La lingua predefinita da utilizzare per la generazione della risposta dell'assistente. Utilizza un codice lingua ISO 639-1 come en. Se non specificata, la lingua verrà rilevata automaticamente.

SystemInstruction

Istruzione di sistema, nota anche come preambolo del prompt per le chiamate LLM.

Rappresentazione JSON 
{
  "additionalSystemInstruction": string
}
Campi
additionalSystemInstruction

string

Facoltativo. Istruzione di sistema aggiuntiva che verrà aggiunta all'istruzione di sistema predefinita.

WebGroundingType

Il tipo di grounding web da utilizzare.

Enum
WEB_GROUNDING_TYPE_UNSPECIFIED Impostazione predefinita non specificata. Equivale a disattivato.
WEB_GROUNDING_TYPE_DISABLED Il grounding web è disattivato.

MapsGroundingType

Il tipo di grounding di Google Maps da utilizzare.

Enum
MAPS_GROUNDING_TYPE_UNSPECIFIED Impostazione predefinita non specificata. Equivale a disattivato.
MAPS_GROUNDING_TYPE_DISABLED La base di Maps è disattivata.
MAPS_GROUNDING_TYPE_GOOGLE_MAPS Il grounding con Google Maps è attivato.

VertexAiAgentConfig

Deprecato: utilizza gli agenti Dialogflow in AgentService. Rappresenta un agente Vertex AI esterno raggiungibile tramite l'assistente.

Rappresentazione JSON 
{
  "displayName": string,
  "name": string,
  "toolDescription": string
}
Campi
displayName

string

Obbligatorio. Nome visualizzato dell'agente Vertex AI utilizzato come riferimento nell'assistente.
name

string

Obbligatorio. Nome della risorsa dell'agente Vertex AI. Formato: projects/{project}/locations/{location}/agents/{agent}
toolDescription

string

Obbligatorio. La descrizione dello strumento dell'agente Vertex AI. Questa descrizione verrà utilizzata dal modello LLM per decidere se l'agente si attiene alla domanda dell'utente e se la domanda deve essere instradata all'agente.

ActionList

Deprecato: verrà sostituito da ToolList. Le azioni abilitate su un connettore

Rappresentazione JSON 
{
  "actionInfo": [
    {
      object (ActionInfo)
    }
  ]
}
Campi
actionInfo[]

object (ActionInfo)

L'elenco delle azioni con le informazioni corrispondenti.

ActionInfo

Deprecato: verrà sostituito da ToolInfo. Informazioni per identificare un'azione.

Rappresentazione JSON 
{
  "actionName": string,
  "actionDisplayName": string
}
Campi
actionName

string

Il nome dell'azione come definito da DataConnectorService.QueryAvailableActions.
actionDisplayName

string

Il nome visualizzato dell'azione.

ToolList

Gli strumenti abilitati su un connettore

Rappresentazione JSON 
{
  "toolInfo": [
    {
      object (ToolInfo)
    }
  ]
}
Campi
toolInfo[]

object (ToolInfo)

L'elenco degli strumenti con le informazioni corrispondenti.

ToolInfo

Informazioni per identificare uno strumento.

Rappresentazione JSON 
{
  "toolName": string,
  "toolDisplayName": string
}
Campi
toolName

string

Il nome dello strumento definito da DataConnectorService.QueryAvailableActions. Nota: utilizza action nelle API DataConnectorService, ma sono uguali a tool qui.
toolDisplayName

string

Il nome visualizzato dello strumento.

CustomerPolicy

Norme definite dal cliente per l'assistente.

Rappresentazione JSON 
{
  "bannedPhrases": [
    {
      object (BannedPhrase)
    }
  ],
  "modelArmorConfig": {
    object (ModelArmorConfig)
  },
  "dataProtectionPolicy": {
    object (DataProtectionPolicy)
  }
}
Campi
bannedPhrases[]

object (BannedPhrase)

Facoltativo. Elenco di frasi vietate.
modelArmorConfig

object (ModelArmorConfig)

Facoltativo. Configurazione di Model Armor da utilizzare per la sanitizzazione dei prompt degli utenti e delle risposte dell'assistente.
dataProtectionPolicy

object (DataProtectionPolicy)

(Facoltativo) Policy di protezione dei dati da utilizzare per la sanificazione dei caricamenti di file.

BannedPhrase

Definizione di una frase vietata definita dal cliente. Una frase vietata non può essere visualizzata nella query dell'utente o nella risposta del LLM, altrimenti la risposta verrà rifiutata.

Rappresentazione JSON 
{
  "phrase": string,
  "matchType": enum (BannedPhraseMatchType),
  "ignoreDiacritics": boolean
}
Campi
phrase

string

Obbligatorio. I contenuti della stringa non elaborata da vietare.
matchType

enum (BannedPhraseMatchType)

Facoltativo. Tipo di corrispondenza per la frase vietata.
ignoreDiacritics

boolean

Facoltativo. Se è true, i segni diacritici (ad es. accenti, umlauti) vengono ignorati durante la corrispondenza delle frasi vietate. Ad esempio, "cafe" corrisponderà a "café".

BannedPhraseMatchType

Il metodo di corrispondenza per la frase vietata.

Enum
BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED Il valore predefinito è SIMPLE_STRING_MATCH.
SIMPLE_STRING_MATCH La frase vietata corrisponde se viene trovata in qualsiasi punto del testo come sottostringa esatta.
WORD_BOUNDARY_STRING_MATCH La corrispondenza con la frase vietata si verifica solo se il pattern trovato nel testo è delimitato da separatori di parole. La frase stessa può comunque contenere delimitatori di parole.

ModelArmorConfig

Configurazione dei modelli Model Armor con definizione personalizzata da utilizzare per la sanificazione dei prompt dell'utente e delle risposte dell'assistente.

Rappresentazione JSON 
{
  "userPromptTemplate": string,
  "responseTemplate": string,
  "failureMode": enum (FailureMode)
}
Campi
userPromptTemplate

string

Facoltativo. Il nome risorsa del template Model Armor per la sanificazione dei prompt dell'utente. Formato: projects/{project}/locations/{location}/templates/{templateId}

Se non specificato, non verrà applicata alcuna sanificazione al prompt dell'utente.
responseTemplate

string

Facoltativo. Il nome risorsa del template Model Armor per la sanificazione delle risposte dell'assistente. Formato: projects/{project}/locations/{location}/templates/{templateId}

Se non specificato, alla risposta dell'assistente non verrà applicata alcuna sanificazione.
failureMode

enum (FailureMode)

Facoltativo. Definisce la modalità di errore per la sanificazione di Model Armor.

FailureMode

Determina il comportamento quando Model Armor non riesce a elaborare una richiesta.

Enum
FAILURE_MODE_UNSPECIFIED Modalità di errore non specificata, il comportamento predefinito è FAIL_CLOSED.
FAIL_OPEN In caso di errore di elaborazione di Model Armor, la richiesta può procedere senza modifiche.
FAIL_CLOSED In caso di errore di elaborazione di Model Armor, la richiesta viene rifiutata.

VertexAiSearchToolConfig

Opzioni di configurazione per lo strumento Vertex AI Search che l'assistente può utilizzare durante l'elaborazione delle query.

Rappresentazione JSON 
{
  "llmSystemInstructions": string
}
Campi
llmSystemInstructions
(deprecated)

string

Deprecato: ti invitiamo a non utilizzare questo campo. Istruzioni di sistema per rispondere in base ai risultati di ricerca di Vertex AI Search. Tieni presente che la risposta prodotta dallo strumento di ricerca potrebbe differire dalla risposta finale dell'assistente.

In generale, le istruzioni di sistema sono un insieme di istruzioni in linguaggio naturale che il modello elabora prima di elaborare i prompt. Indicano al modello come deve comportarsi e rispondere ai prompt. Consulta la pagina https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions

Esempio: "Utilizza solo le informazioni delle fonti per rispondere. Inoltre, assicurati di formattare correttamente la risposta con Markdown."

Se non specificato, verrà utilizzato il valore predefinito interno.

AgentConfig

Deprecato: utilizza invece AgentService. Opzioni di configurazione per gli agenti che l'assistente può chiamare durante l'elaborazione delle query.

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "vertexAiSdkAgentConnectionInfo": {
    object (VertexAiSdkAgentConnectionInfo)
  },
  "httpAgentConnectionInfo": {
    object (HttpAgentConnectionInfo)
  }
  // End of mutually exclusive fields.
}
Campi
id

string

Obbligatorio. Un ID univoco e leggibile per l'agente. Deve corrispondere alla seguente espressione regolare: [a-z][a-zA-Z0-9_-]*.
displayName

string

Obbligatorio. Il nome visualizzato dell'agente utilizzato come riferimento nell'assistente.
toolDescription

string

Obbligatorio. La descrizione dello strumento dell'agente. Questa descrizione verrà utilizzata dal modello LLM per decidere se l'agente si attiene alla domanda dell'utente e se la domanda deve essere instradata all'agente.
icon

object (Image)

Obbligatorio. L'icona che rappresenta l'agente nell'interfaccia utente.
authorizations[]

string

Facoltativo. Nomi delle risorse delle autorizzazioni richieste. Se l'utente non è autorizzato, il servizio restituirà una serie di URI di autorizzazione che l'utente deve aprire in un browser e autorizzare. Una volta concesse tutte le autorizzazioni, l'utente può riprovare la query e le autorizzazioni verranno inoltrate all'agente.

Formato: projects/{project}/locations/{location}/authorizations/{authorization}
La configurazione della connessione dell'agente. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
vertexAiSdkAgentConnectionInfo

object (VertexAiSdkAgentConnectionInfo)

Obbligatorio. Informazioni sulla connessione per un agente dell'SDK Vertex AI
httpAgentConnectionInfo

object (HttpAgentConnectionInfo)

Obbligatorio. Informazioni sulla connessione per un agente HTTP.
Fine dei campi che si escludono a vicenda.

VertexAiSdkAgentConnectionInfo

Informazioni di connessione per un agente SDK Vertex AI. Al momento sono supportati solo gli agenti esposti tramite motori di ragionamento.

Rappresentazione JSON 
{
  "reasoningEngine": string
}
Campi
reasoningEngine

string

Il nome della risorsa del motore di ragionamento che espone l'agente. Formato: projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}

HttpAgentConnectionInfo

Un agente raggiungibile dall'assistente tramite HTTP.

Rappresentazione JSON 
{
  "httpUri": string
}
Campi
httpUri

string

Obbligatorio. L'indirizzo HTTP dell'agente, ad es. "https://example.com/agent1".

Immagine

Rappresenta un'immagine.

Rappresentazione JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "uri": string,
  "content": string
  // End of mutually exclusive fields.
}
Campi
Può essere un URI o i contenuti codificati come stringa Base64. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
uri

string

Obbligatorio. URI immagine.
content

string

Obbligatorio. Contenuti del file immagine con codifica base64.
Fine dei campi che si escludono a vicenda.

Metodi

assist

 Aiuta l'utente con una query.

create

 Crea un Assistant.

createCachedContent

 Crea una memorizzazione nella cache del contesto esplicita (Vertex CachedContent); il relativo name viene passato come cachedContent nelle successive richieste GenerateContent.

delete

 Elimina un Assistant.

deleteCachedContent

 Elimina una memorizzazione nella cache del contesto creata da CreateCachedContent (libera spazio di archiviazione prima del TTL).

generateContent

 Genera contenuti da un modello per conto di un client Gemini Enterprise proprietario (unario).

get

 Riceve un Assistant.

list

 Elenca tutti i Assistant in un Engine.

patch

 Aggiorna un Assistant

predict

 Fornisce una previsione unaria da un modello per conto di un client Gemini Enterprise proprietario.

streamAssist

 Aiuta l'utente con una query in modalità di streaming.

streamGenerateContent

 Variante di GenerateContent per lo streaming lato server.

streamRawPredict

 Streaming lato server della previsione non elaborata, per i modelli che utilizzano un protocollo di richiesta/risposta non elaborato anziché la forma generateContent.