MCP Tools Reference: ces.googleapis.com

Strumento: create_toolset

Crea un nuovo set di strumenti nell'app specificata.

Il seguente esempio mostra come utilizzare curl per richiamare lo strumento MCP create_toolset.

Curl Request
                  
curl --location 'https://ces.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "create_toolset",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'
                

Schema di input

Messaggio di richiesta per AgentService.CreateToolset.

CreateToolsetRequest

Rappresentazione JSON
{
  "parent": string,
  "toolsetId": string,
  "toolset": {
    object (Toolset)
  }
}
Campi
parent

string

Obbligatorio. Il nome della risorsa dell'app in cui creare un insieme di strumenti.

toolsetId

string

Facoltativo. L'ID da utilizzare per il toolset, che diventerà il componente finale del nome della risorsa del toolset. Se non viene fornito, verrà assegnato automaticamente un ID univoco per il toolset.

toolset

object (Toolset)

Obbligatorio. Il set di strumenti per creare.

Toolset

Rappresentazione JSON
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "executionType": enum (ExecutionType),
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },

  // Union field toolset_type can be only one of the following:
  "mcpToolset": {
    object (McpToolset)
  },
  "openApiToolset": {
    object (OpenApiToolset)
  },
  "connectorToolset": {
    object (ConnectorToolset)
  }
  // End of list of possible types for union field toolset_type.
}
Campi
name

string

Identificatore. L'identificatore univoco del set di strumenti. Formato: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}

displayName

string

Facoltativo. Il nome visualizzato del toolset. Deve essere univoco all'interno della stessa app.

description

string

Facoltativo. La descrizione del set di strumenti.

createTime

string (Timestamp format)

Solo output. Timestamp di creazione del toolset.

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. Timestamp dell'ultimo aggiornamento del toolset.

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".

etag

string

ETag utilizzato per garantire che l'oggetto non sia stato modificato durante un'operazione di lettura, modifica e scrittura. Se l'etag è vuoto, l'aggiornamento sovrascriverà eventuali modifiche simultanee.

executionType

enum (ExecutionType)

Facoltativo. Il tipo di esecuzione degli strumenti nel toolset.

toolFakeConfig

object (ToolFakeConfig)

Facoltativo. Configurazione del comportamento degli strumenti in modalità simulata.

Campo unione toolset_type. Il tipo di toolset. toolset_type può essere solo uno dei seguenti tipi:
mcpToolset

object (McpToolset)

Facoltativo. Un insieme di strumenti che contiene un elenco di strumenti offerti dal server MCP.

openApiToolset

object (OpenApiToolset)

Facoltativo. Un insieme di strumenti che contiene un elenco di strumenti definiti da uno schema OpenAPI.

connectorToolset

object (ConnectorToolset)

Facoltativo. Un insieme di strumenti che genera strumenti da una connessione Integration Connectors.

McpToolset

Rappresentazione JSON
{
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "toolOverrides": [
    {
      object (McpToolOverride)
    }
  ]
}
Campi
serverAddress

string

Obbligatorio. L'indirizzo del server MCP, ad esempio "https://example.com/mcp/". Se il server è creato con l'SDK MCP, l'URL deve avere il suffisso "/mcp/". Sono supportati solo i server basati sul trasporto HTTP in streaming. Per ulteriori dettagli, consulta la pagina https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.

apiAuthentication

object (ApiAuthentication)

Facoltativo. Informazioni di autenticazione necessarie per accedere agli strumenti ed eseguire uno strumento sul server MCP. Per l'autenticazione con token di autenticazione, il token si applica solo all'esecuzione dello strumento, non agli strumenti di gestione delle schede. Ciò richiede che gli strumenti possano essere elencati senza autenticazione.

serviceDirectoryConfig

object (ServiceDirectoryConfig)

Facoltativo. Configurazione di Service Directory per VPC-SC, utilizzata per risolvere i nomi dei servizi all'interno di un perimetro.

tlsConfig

object (TlsConfig)

Facoltativo. La configurazione TLS. Include i certificati del server personalizzati che il client deve considerare attendibili.

customHeaders

map (key: string, value: string)

Facoltativo. Le intestazioni personalizzate da inviare nella richiesta al server MCP. I valori devono essere nel formato $context.variables.<name_of_variable> e possono essere impostati nelle variabili di sessione. Per maggiori dettagli, visita la pagina https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

toolOverrides[]

object (McpToolOverride)

Facoltativo. Override per singoli strumenti all'interno di questo insieme di strumenti. In questo modo, puoi ignorare dettagli specifici come descrizioni, nomi o bloccare gli stati degli strumenti in modo che non siano completamente dinamici.

ApiAuthentication

Rappresentazione JSON
{

  // Union field auth_config can be only one of the following:
  "apiKeyConfig": {
    object (ApiKeyConfig)
  },
  "oauthConfig": {
    object (OAuthConfig)
  },
  "serviceAgentIdTokenAuthConfig": {
    object (ServiceAgentIdTokenAuthConfig)
  },
  "serviceAccountAuthConfig": {
    object (ServiceAccountAuthConfig)
  },
  "bearerTokenConfig": {
    object (BearerTokenConfig)
  }
  // End of list of possible types for union field auth_config.
}
Campi
Campo unione auth_config. La configurazione di autenticazione. auth_config può essere solo uno dei seguenti tipi:
apiKeyConfig

object (ApiKeyConfig)

Facoltativo. Configurazione per l'autenticazione della chiave API.

oauthConfig

object (OAuthConfig)

Facoltativo. Configurazione per OAuth.

serviceAgentIdTokenAuthConfig

object (ServiceAgentIdTokenAuthConfig)

Facoltativo. Configurazione per l'autenticazione con token ID generato dall'agente di servizio CES.

serviceAccountAuthConfig

object (ServiceAccountAuthConfig)

Facoltativo. Configurazione per l'autenticazione del account di servizio.

bearerTokenConfig

object (BearerTokenConfig)

Facoltativo. Configurazione per l'autenticazione con token di connessione.

ApiKeyConfig

Rappresentazione JSON
{
  "keyName": string,
  "apiKeySecretVersion": string,
  "requestLocation": enum (RequestLocation)
}
Campi
keyName

string

Obbligatorio. Il nome del parametro o dell'intestazione della chiave API. Ad esempio, Se la richiesta API è "https://example.com/act?X-Api-Key=", "X-Api-Key" sarà il nome del parametro.

apiKeySecretVersion

string

Obbligatorio. Il nome della risorsa della versione del secret di Secret Manager che archivia la chiave API. Formato: projects/{project}/secrets/{secret}/versions/{version}

Nota: devi concedere il ruolo roles/secretmanager.secretAccessor al service agent CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

requestLocation

enum (RequestLocation)

Obbligatorio. Posizione della chiave nella richiesta.

OAuthConfig

Rappresentazione JSON
{
  "oauthGrantType": enum (OauthGrantType),
  "clientId": string,
  "clientSecretVersion": string,
  "tokenEndpoint": string,
  "scopes": [
    string
  ]
}
Campi
oauthGrantType

enum (OauthGrantType)

Obbligatorio. Tipi di autorizzazione con OAuth.

clientId

string

Obbligatorio. L'ID client del provider OAuth.

clientSecretVersion

string

Obbligatorio. Il nome della risorsa della versione del secret di Secret Manager che archivia il client secret. Formato: projects/{project}/secrets/{secret}/versions/{version}

Nota: devi concedere il ruolo roles/secretmanager.secretAccessor al service agent CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

tokenEndpoint

string

Obbligatorio. L'endpoint del token nel provider OAuth da scambiare con un token di accesso.

scopes[]

string

Facoltativo. Gli ambiti OAuth da concedere.

ServiceAccountAuthConfig

Rappresentazione JSON
{
  "serviceAccount": string,
  "scopes": [
    string
  ]
}
Campi
serviceAccount

string

Obbligatorio. L'indirizzo email del account di servizio utilizzato per l'autenticazione. CES utilizza questo account di servizio per scambiare un token di accesso, che viene poi inviato nell'intestazione Authorization della richiesta.

All'account di servizio deve essere concesso il ruolo roles/iam.serviceAccountTokenCreator all'agente di servizio CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

scopes[]

string

Facoltativo. Gli ambiti OAuth da concedere. Se non specificato, viene utilizzato l'ambito predefinito https://www.googleapis.com/auth/cloud-platform.

BearerTokenConfig

Rappresentazione JSON
{
  "token": string
}
Campi
token

string

Obbligatorio. Il token di connessione. Deve essere nel formato $context.variables.<name_of_variable>.

ServiceDirectoryConfig

Rappresentazione JSON
{
  "service": string
}
Campi
service

string

Obbligatorio. Il nome del servizio Service Directory. Formato: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. La posizione della directory dei servizi deve corrispondere a quella dell'app.

TlsConfig

Rappresentazione JSON
{
  "caCerts": [
    {
      object (CaCert)
    }
  ]
}
Campi
caCerts[]

object (CaCert)

Obbligatorio. Specifica un elenco di certificati CA personalizzati consentiti per la verifica HTTPS.

CaCert

Rappresentazione JSON
{
  "displayName": string,
  "cert": string
}
Campi
displayName

string

Obbligatorio. Il nome dei certificati CA personalizzati consentiti. Può essere utilizzato per distinguere i certificati CA personalizzati.

cert

string (bytes format)

Obbligatorio. I certificati CA personalizzati consentiti (in formato DER) per la verifica HTTPS. Esegue l'override dell'archivio di attendibilità SSL predefinito. Se questo campo è vuoto o non specificato, CES utilizzerà l'archivio di attendibilità predefinito di Google per verificare i certificati. Nota: assicurati che i certificati del server HTTPS siano firmati con "subject alt name". Ad esempio, un certificato può essere autofirmato utilizzando il seguente comando:

   openssl x509 -req -days 200 -in example.com.csr \
     -signkey example.com.key \
     -out example.com.crt \
     -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

Una stringa con codifica in base64.

CustomHeadersEntry

Rappresentazione JSON
{
  "key": string,
  "value": string
}
Campi
key

string

value

string

McpToolOverride

Rappresentazione JSON
{
  "tool": string,
  "nameOverride": string,
  "descriptionOverride": string,
  "snapshot": {
    object (McpToolDefinition)
  }
}
Campi
tool

string

Obbligatorio. Il nome originale dello strumento così come viene emesso dal server MCP.

nameOverride

string

Facoltativo. Se presente, questo strumento utilizza questo nome nell'agente al posto del nome originale. Viene utilizzato principalmente come alias se il server MCP offre strumenti con nomi poco chiari.

descriptionOverride

string

Facoltativo. Se presente, questo strumento utilizza questa descrizione anziché quella originale del server.

snapshot

object (McpToolDefinition)

Solo output. Se presente, questo strumento è "Bloccato" e utilizza i valori dello snapshot come fallback se il server non è temporaneamente disponibile o se non è presente alcuna sostituzione.

McpToolDefinition

Rappresentazione JSON
{
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  }
}
Campi
description

string

Solo output. La descrizione dello strumento MCP. Questa impostazione può essere sostituita da description_override in McpToolOverride.

inputSchema

object (Schema)

Solo output. Lo schema degli argomenti di input dello strumento MCP.

outputSchema

object (Schema)

Solo output. Lo schema degli argomenti di output dello strumento MCP.

Schema

Rappresentazione JSON
{
  "type": enum (Type),
  "properties": {
    string: {
      object (Schema)
    },
    ...
  },
  "required": [
    string
  ],
  "description": string,
  "items": {
    object (Schema)
  },
  "nullable": boolean,
  "uniqueItems": boolean,
  "prefixItems": [
    {
      object (Schema)
    }
  ],
  "additionalProperties": {
    object (Schema)
  },
  "anyOf": [
    {
      object (Schema)
    }
  ],
  "enum": [
    string
  ],
  "default": value,
  "ref": string,
  "defs": {
    string: {
      object (Schema)
    },
    ...
  },
  "title": string,
  "minItems": string,
  "maxItems": string,

  // Union field _minimum can be only one of the following:
  "minimum": number
  // End of list of possible types for union field _minimum.

  // Union field _maximum can be only one of the following:
  "maximum": number
  // End of list of possible types for union field _maximum.
}
Campi
type

enum (Type)

Obbligatorio. Il tipo di dati.

properties

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

Facoltativo. Proprietà di Type.OBJECT.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

required[]

string

Facoltativo. Proprietà obbligatorie di Type.OBJECT.

description

string

Facoltativo. La descrizione dei dati.

items

object (Schema)

Facoltativo. Schema degli elementi di Type.ARRAY.

nullable

boolean

Facoltativo. Indica se il valore può essere null.

uniqueItems

boolean

Facoltativo. Indica che gli elementi dell'array devono essere univoci. Si applica solo a TYPE.ARRAY.

prefixItems[]

object (Schema)

Facoltativo. Schemi degli elementi iniziali di Type.ARRAY.

additionalProperties

object (Schema)

Facoltativo. Può essere un valore booleano o un oggetto, controlla la presenza di proprietà aggiuntive.

anyOf[]

object (Schema)

Facoltativo. Il valore deve essere convalidato in base a uno o più sottoschema nell'elenco.

enum[]

string

Facoltativo. Valori possibili dell'elemento di tipo primitivo con formato enum. Esempi: 1. Possiamo definire la direzione come : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. Possiamo definire il numero di appartamento come : {type:INTEGER, format:enum, enum:["101", "201", "301"]}

default

value (Value format)

Facoltativo. Valore predefinito dei dati.

ref

string

Facoltativo. Consente riferimenti indiretti tra i nodi dello schema. Il valore deve essere un riferimento valido a un elemento secondario della radice defs.

Ad esempio, lo schema seguente definisce un riferimento a un nodo dello schema denominato "Pet":

type: object
properties:
  pet:
    ref: #/defs/Pet
defs:
  Pet:
    type: object
    properties:
      name:
        type: string

Il valore della proprietà "pet" è un riferimento al nodo dello schema denominato "Pet". Per maggiori dettagli, visita la pagina https://json-schema.org/understanding-json-schema/structuring.

defs

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

Facoltativo. Una mappa delle definizioni da utilizzare per ref. Consentito solo nella radice dello schema.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

title

string

Facoltativo. Il titolo dello schema.

minItems

string (int64 format)

Facoltativo. Numero minimo di elementi per Type.ARRAY.

maxItems

string (int64 format)

Facoltativo. Numero massimo di elementi per Type.ARRAY.

Campo unione _minimum.

_minimum può essere solo uno dei seguenti tipi:

minimum

number

Facoltativo. Valore minimo per Type.INTEGER e Type.NUMBER.

Campo unione _maximum.

_maximum può essere solo uno dei seguenti tipi:

maximum

number

Facoltativo. Valore massimo per Type.INTEGER e Type.NUMBER.

PropertiesEntry

Rappresentazione JSON
{
  "key": string,
  "value": {
    object (Schema)
  }
}
Campi
key

string

value

object (Schema)

Valore

Rappresentazione JSON
{

  // Union field kind can be only one of the following:
  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
  // End of list of possible types for union field kind.
}
Campi
Campo unione kind. Il tipo di valore. kind può essere solo uno dei seguenti tipi:
nullValue

null

Rappresenta un null JSON.

numberValue

number

Rappresenta un numero JSON. Non deve essere NaN, Infinity o -Infinity, in quanto non sono supportati in JSON. Inoltre, non può rappresentare valori Int64 di grandi dimensioni, poiché il formato JSON in genere non li supporta nel suo tipo di numero.

stringValue

string

Rappresenta una stringa JSON.

boolValue

boolean

Rappresenta un valore booleano JSON (valore letterale true o false in JSON).

structValue

object (Struct format)

Rappresenta un oggetto JSON.

listValue

array (ListValue format)

Rappresenta un array JSON.

Struct

Rappresentazione JSON
{
  "fields": {
    string: value,
    ...
  }
}
Campi
fields

map (key: string, value: value (Value format))

Mappa non ordinata di valori con tipo dinamico.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

Rappresentazione JSON
{
  "key": string,
  "value": value
}
Campi
key

string

value

value (Value format)

ListValue

Rappresentazione JSON
{
  "values": [
    value
  ]
}
Campi
values[]

value (Value format)

Campo ripetuto di valori con tipo dinamico.

DefsEntry

Rappresentazione JSON
{
  "key": string,
  "value": {
    object (Schema)
  }
}
Campi
key

string

value

object (Schema)

OpenApiToolset

Rappresentazione JSON
{
  "openApiSchema": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
Campi
openApiSchema

string

Obbligatorio. Lo schema OpenAPI del set di strumenti.

apiAuthentication

object (ApiAuthentication)

Facoltativo. Informazioni di autenticazione richieste dall'API.

tlsConfig

object (TlsConfig)

Facoltativo. La configurazione TLS. Include i certificati del server personalizzati

serviceDirectoryConfig

object (ServiceDirectoryConfig)

Facoltativo. Configurazione di Service Directory.

ignoreUnknownFields

boolean

Facoltativo. Se il valore è true, l'agente ignorerà i campi sconosciuti nella risposta API per tutte le operazioni definite nello schema OpenAPI.

url

string

Facoltativo. L'URL del server dello schema Open API. Questo campo viene impostato solo nei toolset nelle dipendenze dell'ambiente durante il processo di esportazione se lo schema contiene un URL del server. Durante il processo di importazione, se questo URL è presente nelle dipendenze dell'ambiente e lo schema contiene il segnaposto $env_var, quest'ultimo verrà sostituito nello schema.

ConnectorToolset

Rappresentazione JSON
{
  "connection": string,
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "connectorActions": [
    {
      object (Action)
    }
  ]
}
Campi
connection

string

Obbligatorio. Il nome completo della risorsa della connessione Integration Connectors a cui viene fatto riferimento. Formato: projects/{project}/locations/{location}/connections/{connection}

authConfig

object (EndUserAuthConfig)

Facoltativo. Configura la gestione dell'autenticazione in Integration Connectors. Per impostazione predefinita, un'autenticazione amministratore viene trasmessa nelle richieste dell'API Integration Connectors. Puoi ignorarla con una configurazione di autenticazione dell'utente finale diversa. Nota: per specificare una configurazione EUC qui, l'override dell'autenticazione deve essere abilitato per la connessione. In caso contrario, la creazione del Toolset non riuscirà. Consulta: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override

connectorActions[]

object (Action)

Obbligatorio. L'elenco delle azioni/operazioni di entità del connettore per cui generare strumenti.

EndUserAuthConfig

Rappresentazione JSON
{

  // Union field auth_config can be only one of the following:
  "oauth2AuthCodeConfig": {
    object (Oauth2AuthCodeConfig)
  },
  "oauth2JwtBearerConfig": {
    object (Oauth2JwtBearerConfig)
  }
  // End of list of possible types for union field auth_config.
}
Campi
Campo unione auth_config. La configurazione di autenticazione. auth_config può essere solo uno dei seguenti tipi:
oauth2AuthCodeConfig

object (Oauth2AuthCodeConfig)

Autenticazione del codice di autorizzazione OAuth 2.0.

oauth2JwtBearerConfig

object (Oauth2JwtBearerConfig)

Autenticazione della concessione di autorizzazione OAuth 2.0 del profilo JWT.

Oauth2AuthCodeConfig

Rappresentazione JSON
{
  "oauthToken": string
}
Campi
oauthToken

string

Obbligatorio. Nome del parametro token OAuth da trasferire. Deve essere nel formato $context.variables.<name_of_variable>.

Oauth2JwtBearerConfig

Rappresentazione JSON
{
  "issuer": string,
  "subject": string,
  "clientKey": string
}
Campi
issuer

string

Obbligatorio. Nome del parametro dell'emittente da trasferire. Deve essere nel formato $context.variables.<name_of_variable>.

subject

string

Obbligatorio. Nome del parametro oggetto da trasferire. Deve essere nel formato $context.variables.<name_of_variable>.

clientKey

string

Obbligatorio. Nome del parametro client da trasferire. Deve essere nel formato $context.variables.<name_of_variable>.

Azione

Rappresentazione JSON
{
  "inputFields": [
    string
  ],
  "outputFields": [
    string
  ],

  // Union field action_spec can be only one of the following:
  "connectionActionId": string,
  "entityOperation": {
    object (EntityOperation)
  }
  // End of list of possible types for union field action_spec.
}
Campi
inputFields[]

string

Facoltativo. Campi dell'entità da utilizzare come input per l'operazione. Se non vengono specificati campi, verranno utilizzati tutti i campi dell'entità.

outputFields[]

string

Facoltativo. Campi dell'entità da restituire dall'operazione. Se non vengono specificati campi, vengono restituiti tutti i campi dell'entità.

Campo unione action_spec. Specifica di un'azione da configurare per l'utilizzo dello strumento. action_spec può essere solo uno dei seguenti tipi:
connectionActionId

string

ID di un'azione di connessione da utilizzare per lo strumento.

entityOperation

object (EntityOperation)

Configurazione dell'operazione dell'entità da utilizzare per lo strumento.

EntityOperation

Rappresentazione JSON
{
  "entityId": string,
  "operation": enum (OperationType)
}
Campi
entityId

string

Obbligatorio. ID dell'entità.

operation

enum (OperationType)

Obbligatorio. Operazione da eseguire sull'entità.

Timestamp

Rappresentazione JSON
{
  "seconds": string,
  "nanos": integer
}
Campi
seconds

string (int64 format)

Rappresenta i secondi del tempo UTC a partire dall'epoca Unix 1970-01-01T00:00:00Z. Deve essere compreso tra -62135596800 e 253402300799 inclusi (corrispondenti a 0001-01-01T00:00:00Z e 9999-12-31T23:59:59Z).

nanos

integer

Frazioni di secondo non negative con risoluzione in nanosecondi. Questo campo è la porzione di nanosecondi della durata, non un'alternativa ai secondi. I valori negativi dei secondi con frazioni devono comunque avere valori di nanosecondi non negativi che vengono conteggiati in avanti nel tempo. Deve essere compreso tra 0 e 999.999.999 inclusi.

ToolFakeConfig

Rappresentazione JSON
{
  "enableFakeMode": boolean,

  // Union field tool_response can be only one of the following:
  "codeBlock": {
    object (CodeBlock)
  }
  // End of list of possible types for union field tool_response.
}
Campi
enableFakeMode

boolean

Facoltativo. Indica se lo strumento utilizza la modalità Falso.

Campo unione tool_response. La risposta è statica o fornita da una funzione Python. tool_response può essere solo uno dei seguenti tipi:
codeBlock

object (CodeBlock)

Facoltativo. Blocco di codice che verrà eseguito al posto di una chiamata allo strumento reale.

CodeBlock

Rappresentazione JSON
{
  "pythonCode": string
}
Campi
pythonCode

string

Obbligatorio. Codice Python che verrà richiamato in modalità di simulazione dello strumento. Firma della funzione Python prevista: per intercettare tutte le chiamate di strumenti: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: per intercettare una chiamata di strumento specifica: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: se la funzione restituisce None, verrà richiamato lo strumento reale.

RequestLocation

La posizione della chiave API nella richiesta.

Enum
REQUEST_LOCATION_UNSPECIFIED Non specificato. Questo valore non deve essere utilizzato.
HEADER Rappresenta la chiave nell'intestazione HTTP.
QUERY_STRING Rappresenta la chiave nella stringa di query.

OauthGrantType

Tipi di autorizzazione con OAuth. È supportata solo la concessione delle credenziali client.

Enum
OAUTH_GRANT_TYPE_UNSPECIFIED Non specificato. Il valore predefinito è CLIENT_CREDENTIAL.
CLIENT_CREDENTIAL Rappresenta il flusso delle credenziali client.

Tipo

Tipi di dati OpenAPI.

Enum
TYPE_UNSPECIFIED Tipo non specificato.
STRING Tipo di stringa.
INTEGER Tipo intero.
NUMBER Tipo di numero.
BOOLEAN Tipo booleano.
OBJECT Tipo di oggetto.
ARRAY Tipo di array.

NullValue

Rappresenta un null JSON.

NullValue è un sentinel che utilizza un'enumerazione con un solo valore per rappresentare il valore nullo per l'unione di tipi Value.

Un campo di tipo NullValue con un valore diverso da 0 è considerato non valido. La maggior parte dei serializzatori ProtoJSON emetterà un valore con null_value impostato come null JSON indipendentemente dal valore intero, quindi eseguirà l'andata e il ritorno a un valore 0.

Enum
NULL_VALUE Valore nullo.

OperationType

L'operazione da eseguire sull'entità.

Enum
OPERATION_TYPE_UNSPECIFIED Tipo di operazione non specificato. Non valido, la creazione/l'aggiornamento di ConnectorTool non riuscirà.
LIST Elenco operazioni.
GET Recupera operazione.
CREATE Crea operazione.
UPDATE Operazione di aggiornamento.
DELETE Operazione di eliminazione.

ExecutionType

Il tipo di esecuzione dello strumento o del set di strumenti.

Enum
EXECUTION_TYPE_UNSPECIFIED Il tipo di esecuzione non è specificato. Se non specificato, il valore predefinito è SYNCHRONOUS.
SYNCHRONOUS Lo strumento viene eseguito in modo sincrono. La sessione viene bloccata finché lo strumento non viene restituito.
ASYNCHRONOUS Lo strumento viene eseguito in modo asincrono. La sessione continuerà durante l'esecuzione dello strumento.

Schema di output

Un insieme di strumenti rappresenta un gruppo di strumenti gestiti dinamicamente che possono essere utilizzati dall'agente.

Toolset

Rappresentazione JSON
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "executionType": enum (ExecutionType),
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },

  // Union field toolset_type can be only one of the following:
  "mcpToolset": {
    object (McpToolset)
  },
  "openApiToolset": {
    object (OpenApiToolset)
  },
  "connectorToolset": {
    object (ConnectorToolset)
  }
  // End of list of possible types for union field toolset_type.
}
Campi
name

string

Identificatore. L'identificatore univoco del set di strumenti. Formato: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}

displayName

string

Facoltativo. Il nome visualizzato del toolset. Deve essere univoco all'interno della stessa app.

description

string

Facoltativo. La descrizione del set di strumenti.

createTime

string (Timestamp format)

Solo output. Timestamp di creazione del toolset.

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. Timestamp dell'ultimo aggiornamento del toolset.

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".

etag

string

ETag utilizzato per garantire che l'oggetto non sia stato modificato durante un'operazione di lettura, modifica e scrittura. Se l'etag è vuoto, l'aggiornamento sovrascriverà eventuali modifiche simultanee.

executionType

enum (ExecutionType)

Facoltativo. Il tipo di esecuzione degli strumenti nel toolset.

toolFakeConfig

object (ToolFakeConfig)

Facoltativo. Configurazione del comportamento degli strumenti in modalità simulata.

Campo unione toolset_type. Il tipo di toolset. toolset_type può essere solo uno dei seguenti tipi:
mcpToolset

object (McpToolset)

Facoltativo. Un insieme di strumenti che contiene un elenco di strumenti offerti dal server MCP.

openApiToolset

object (OpenApiToolset)

Facoltativo. Un insieme di strumenti che contiene un elenco di strumenti definiti da uno schema OpenAPI.

connectorToolset

object (ConnectorToolset)

Facoltativo. Un insieme di strumenti che genera strumenti da una connessione Integration Connectors.

McpToolset

Rappresentazione JSON
{
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "toolOverrides": [
    {
      object (McpToolOverride)
    }
  ]
}
Campi
serverAddress

string

Obbligatorio. L'indirizzo del server MCP, ad esempio "https://example.com/mcp/". Se il server è creato con l'SDK MCP, l'URL deve avere il suffisso "/mcp/". Sono supportati solo i server basati sul trasporto HTTP in streaming. Per ulteriori dettagli, consulta la pagina https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.

apiAuthentication

object (ApiAuthentication)

Facoltativo. Informazioni di autenticazione necessarie per accedere agli strumenti ed eseguire uno strumento sul server MCP. Per l'autenticazione con token di autenticazione, il token si applica solo all'esecuzione dello strumento, non agli strumenti di gestione delle schede. Ciò richiede che gli strumenti possano essere elencati senza autenticazione.

serviceDirectoryConfig

object (ServiceDirectoryConfig)

Facoltativo. Configurazione di Service Directory per VPC-SC, utilizzata per risolvere i nomi dei servizi all'interno di un perimetro.

tlsConfig

object (TlsConfig)

Facoltativo. La configurazione TLS. Include i certificati del server personalizzati che il client deve considerare attendibili.

customHeaders

map (key: string, value: string)

Facoltativo. Le intestazioni personalizzate da inviare nella richiesta al server MCP. I valori devono essere nel formato $context.variables.<name_of_variable> e possono essere impostati nelle variabili di sessione. Per maggiori dettagli, visita la pagina https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

toolOverrides[]

object (McpToolOverride)

Facoltativo. Override per singoli strumenti all'interno di questo insieme di strumenti. In questo modo, puoi ignorare dettagli specifici come descrizioni, nomi o bloccare gli stati degli strumenti in modo che non siano completamente dinamici.

ApiAuthentication

Rappresentazione JSON
{

  // Union field auth_config can be only one of the following:
  "apiKeyConfig": {
    object (ApiKeyConfig)
  },
  "oauthConfig": {
    object (OAuthConfig)
  },
  "serviceAgentIdTokenAuthConfig": {
    object (ServiceAgentIdTokenAuthConfig)
  },
  "serviceAccountAuthConfig": {
    object (ServiceAccountAuthConfig)
  },
  "bearerTokenConfig": {
    object (BearerTokenConfig)
  }
  // End of list of possible types for union field auth_config.
}
Campi
Campo unione auth_config. La configurazione di autenticazione. auth_config può essere solo uno dei seguenti tipi:
apiKeyConfig

object (ApiKeyConfig)

Facoltativo. Configurazione per l'autenticazione della chiave API.

oauthConfig

object (OAuthConfig)

Facoltativo. Configurazione per OAuth.

serviceAgentIdTokenAuthConfig

object (ServiceAgentIdTokenAuthConfig)

Facoltativo. Configurazione per l'autenticazione con token ID generato dall'agente di servizio CES.

serviceAccountAuthConfig

object (ServiceAccountAuthConfig)

Facoltativo. Configurazione per l'autenticazione del account di servizio.

bearerTokenConfig

object (BearerTokenConfig)

Facoltativo. Configurazione per l'autenticazione con token di connessione.

ApiKeyConfig

Rappresentazione JSON
{
  "keyName": string,
  "apiKeySecretVersion": string,
  "requestLocation": enum (RequestLocation)
}
Campi
keyName

string

Obbligatorio. Il nome del parametro o dell'intestazione della chiave API. Ad esempio, Se la richiesta API è "https://example.com/act?X-Api-Key=", "X-Api-Key" sarà il nome del parametro.

apiKeySecretVersion

string

Obbligatorio. Il nome della risorsa della versione del secret di Secret Manager che archivia la chiave API. Formato: projects/{project}/secrets/{secret}/versions/{version}

Nota: devi concedere il ruolo roles/secretmanager.secretAccessor al service agent CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

requestLocation

enum (RequestLocation)

Obbligatorio. Posizione della chiave nella richiesta.

OAuthConfig

Rappresentazione JSON
{
  "oauthGrantType": enum (OauthGrantType),
  "clientId": string,
  "clientSecretVersion": string,
  "tokenEndpoint": string,
  "scopes": [
    string
  ]
}
Campi
oauthGrantType

enum (OauthGrantType)

Obbligatorio. Tipi di autorizzazione con OAuth.

clientId

string

Obbligatorio. L'ID client del provider OAuth.

clientSecretVersion

string

Obbligatorio. Il nome della risorsa della versione del secret di Secret Manager che archivia il client secret. Formato: projects/{project}/secrets/{secret}/versions/{version}

Nota: devi concedere il ruolo roles/secretmanager.secretAccessor al service agent CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

tokenEndpoint

string

Obbligatorio. L'endpoint del token nel provider OAuth da scambiare con un token di accesso.

scopes[]

string

Facoltativo. Gli ambiti OAuth da concedere.

ServiceAccountAuthConfig

Rappresentazione JSON
{
  "serviceAccount": string,
  "scopes": [
    string
  ]
}
Campi
serviceAccount

string

Obbligatorio. L'indirizzo email del account di servizio utilizzato per l'autenticazione. CES utilizza questo account di servizio per scambiare un token di accesso, che viene poi inviato nell'intestazione Authorization della richiesta.

All'account di servizio deve essere concesso il ruolo roles/iam.serviceAccountTokenCreator all'agente di servizio CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

scopes[]

string

Facoltativo. Gli ambiti OAuth da concedere. Se non specificato, viene utilizzato l'ambito predefinito https://www.googleapis.com/auth/cloud-platform.

BearerTokenConfig

Rappresentazione JSON
{
  "token": string
}
Campi
token

string

Obbligatorio. Il token di connessione. Deve essere nel formato $context.variables.<name_of_variable>.

ServiceDirectoryConfig

Rappresentazione JSON
{
  "service": string
}
Campi
service

string

Obbligatorio. Il nome del servizio Service Directory. Formato: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. La posizione della directory dei servizi deve corrispondere a quella dell'app.

TlsConfig

Rappresentazione JSON
{
  "caCerts": [
    {
      object (CaCert)
    }
  ]
}
Campi
caCerts[]

object (CaCert)

Obbligatorio. Specifica un elenco di certificati CA personalizzati consentiti per la verifica HTTPS.

CaCert

Rappresentazione JSON
{
  "displayName": string,
  "cert": string
}
Campi
displayName

string

Obbligatorio. Il nome dei certificati CA personalizzati consentiti. Può essere utilizzato per distinguere i certificati CA personalizzati.

cert

string (bytes format)

Obbligatorio. I certificati CA personalizzati consentiti (in formato DER) per la verifica HTTPS. Esegue l'override dell'archivio di attendibilità SSL predefinito. Se questo campo è vuoto o non specificato, CES utilizzerà l'archivio di attendibilità predefinito di Google per verificare i certificati. Nota: assicurati che i certificati del server HTTPS siano firmati con "subject alt name". Ad esempio, un certificato può essere autofirmato utilizzando il seguente comando:

   openssl x509 -req -days 200 -in example.com.csr \
     -signkey example.com.key \
     -out example.com.crt \
     -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

Una stringa con codifica in base64.

CustomHeadersEntry

Rappresentazione JSON
{
  "key": string,
  "value": string
}
Campi
key

string

value

string

McpToolOverride

Rappresentazione JSON
{
  "tool": string,
  "nameOverride": string,
  "descriptionOverride": string,
  "snapshot": {
    object (McpToolDefinition)
  }
}
Campi
tool

string

Obbligatorio. Il nome originale dello strumento così come viene emesso dal server MCP.

nameOverride

string

Facoltativo. Se presente, questo strumento utilizza questo nome nell'agente al posto del nome originale. Viene utilizzato principalmente come alias se il server MCP offre strumenti con nomi poco chiari.

descriptionOverride

string

Facoltativo. Se presente, questo strumento utilizza questa descrizione anziché quella originale del server.

snapshot

object (McpToolDefinition)

Solo output. Se presente, questo strumento è "Bloccato" e utilizza i valori dello snapshot come fallback se il server non è temporaneamente disponibile o se non è presente alcuna sostituzione.

McpToolDefinition

Rappresentazione JSON
{
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  }
}
Campi
description

string

Solo output. La descrizione dello strumento MCP. Questa impostazione può essere sostituita da description_override in McpToolOverride.

inputSchema

object (Schema)

Solo output. Lo schema degli argomenti di input dello strumento MCP.

outputSchema

object (Schema)

Solo output. Lo schema degli argomenti di output dello strumento MCP.

Schema

Rappresentazione JSON
{
  "type": enum (Type),
  "properties": {
    string: {
      object (Schema)
    },
    ...
  },
  "required": [
    string
  ],
  "description": string,
  "items": {
    object (Schema)
  },
  "nullable": boolean,
  "uniqueItems": boolean,
  "prefixItems": [
    {
      object (Schema)
    }
  ],
  "additionalProperties": {
    object (Schema)
  },
  "anyOf": [
    {
      object (Schema)
    }
  ],
  "enum": [
    string
  ],
  "default": value,
  "ref": string,
  "defs": {
    string: {
      object (Schema)
    },
    ...
  },
  "title": string,
  "minItems": string,
  "maxItems": string,

  // Union field _minimum can be only one of the following:
  "minimum": number
  // End of list of possible types for union field _minimum.

  // Union field _maximum can be only one of the following:
  "maximum": number
  // End of list of possible types for union field _maximum.
}
Campi
type

enum (Type)

Obbligatorio. Il tipo di dati.

properties

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

Facoltativo. Proprietà di Type.OBJECT.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

required[]

string

Facoltativo. Proprietà obbligatorie di Type.OBJECT.

description

string

Facoltativo. La descrizione dei dati.

items

object (Schema)

Facoltativo. Schema degli elementi di Type.ARRAY.

nullable

boolean

Facoltativo. Indica se il valore può essere null.

uniqueItems

boolean

Facoltativo. Indica che gli elementi dell'array devono essere univoci. Si applica solo a TYPE.ARRAY.

prefixItems[]

object (Schema)

Facoltativo. Schemi degli elementi iniziali di Type.ARRAY.

additionalProperties

object (Schema)

Facoltativo. Può essere un valore booleano o un oggetto, controlla la presenza di proprietà aggiuntive.

anyOf[]

object (Schema)

Facoltativo. Il valore deve essere convalidato in base a uno o più sottoschema nell'elenco.

enum[]

string

Facoltativo. Valori possibili dell'elemento di tipo primitivo con formato enum. Esempi: 1. Possiamo definire la direzione come : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. Possiamo definire il numero di appartamento come : {type:INTEGER, format:enum, enum:["101", "201", "301"]}

default

value (Value format)

Facoltativo. Valore predefinito dei dati.

ref

string

Facoltativo. Consente riferimenti indiretti tra i nodi dello schema. Il valore deve essere un riferimento valido a un elemento secondario della radice defs.

Ad esempio, lo schema seguente definisce un riferimento a un nodo dello schema denominato "Pet":

type: object
properties:
  pet:
    ref: #/defs/Pet
defs:
  Pet:
    type: object
    properties:
      name:
        type: string

Il valore della proprietà "pet" è un riferimento al nodo dello schema denominato "Pet". Per maggiori dettagli, visita la pagina https://json-schema.org/understanding-json-schema/structuring.

defs

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

Facoltativo. Una mappa delle definizioni da utilizzare per ref. Consentito solo nella radice dello schema.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

title

string

Facoltativo. Il titolo dello schema.

minItems

string (int64 format)

Facoltativo. Numero minimo di elementi per Type.ARRAY.

maxItems

string (int64 format)

Facoltativo. Numero massimo di elementi per Type.ARRAY.

Campo unione _minimum.

_minimum può essere solo uno dei seguenti tipi:

minimum

number

Facoltativo. Valore minimo per Type.INTEGER e Type.NUMBER.

Campo unione _maximum.

_maximum può essere solo uno dei seguenti tipi:

maximum

number

Facoltativo. Valore massimo per Type.INTEGER e Type.NUMBER.

PropertiesEntry

Rappresentazione JSON
{
  "key": string,
  "value": {
    object (Schema)
  }
}
Campi
key

string

value

object (Schema)

Valore

Rappresentazione JSON
{

  // Union field kind can be only one of the following:
  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
  // End of list of possible types for union field kind.
}
Campi
Campo unione kind. Il tipo di valore. kind può essere solo uno dei seguenti tipi:
nullValue

null

Rappresenta un null JSON.

numberValue

number

Rappresenta un numero JSON. Non deve essere NaN, Infinity o -Infinity, in quanto non sono supportati in JSON. Inoltre, non può rappresentare valori Int64 di grandi dimensioni, poiché il formato JSON in genere non li supporta nel suo tipo di numero.

stringValue

string

Rappresenta una stringa JSON.

boolValue

boolean

Rappresenta un valore booleano JSON (valore letterale true o false in JSON).

structValue

object (Struct format)

Rappresenta un oggetto JSON.

listValue

array (ListValue format)

Rappresenta un array JSON.

Struct

Rappresentazione JSON
{
  "fields": {
    string: value,
    ...
  }
}
Campi
fields

map (key: string, value: value (Value format))

Mappa non ordinata di valori con tipo dinamico.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

Rappresentazione JSON
{
  "key": string,
  "value": value
}
Campi
key

string

value

value (Value format)

ListValue

Rappresentazione JSON
{
  "values": [
    value
  ]
}
Campi
values[]

value (Value format)

Campo ripetuto di valori con tipo dinamico.

DefsEntry

Rappresentazione JSON
{
  "key": string,
  "value": {
    object (Schema)
  }
}
Campi
key

string

value

object (Schema)

OpenApiToolset

Rappresentazione JSON
{
  "openApiSchema": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
Campi
openApiSchema

string

Obbligatorio. Lo schema OpenAPI del set di strumenti.

apiAuthentication

object (ApiAuthentication)

Facoltativo. Informazioni di autenticazione richieste dall'API.

tlsConfig

object (TlsConfig)

Facoltativo. La configurazione TLS. Include i certificati del server personalizzati

serviceDirectoryConfig

object (ServiceDirectoryConfig)

Facoltativo. Configurazione di Service Directory.

ignoreUnknownFields

boolean

Facoltativo. Se il valore è true, l'agente ignorerà i campi sconosciuti nella risposta API per tutte le operazioni definite nello schema OpenAPI.

url

string

Facoltativo. L'URL del server dello schema Open API. Questo campo viene impostato solo nei toolset nelle dipendenze dell'ambiente durante il processo di esportazione se lo schema contiene un URL del server. Durante il processo di importazione, se questo URL è presente nelle dipendenze dell'ambiente e lo schema contiene il segnaposto $env_var, quest'ultimo verrà sostituito nello schema.

ConnectorToolset

Rappresentazione JSON
{
  "connection": string,
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "connectorActions": [
    {
      object (Action)
    }
  ]
}
Campi
connection

string

Obbligatorio. Il nome completo della risorsa della connessione Integration Connectors a cui viene fatto riferimento. Formato: projects/{project}/locations/{location}/connections/{connection}

authConfig

object (EndUserAuthConfig)

Facoltativo. Configura la gestione dell'autenticazione in Integration Connectors. Per impostazione predefinita, un'autenticazione amministratore viene trasmessa nelle richieste dell'API Integration Connectors. Puoi ignorarla con una configurazione di autenticazione dell'utente finale diversa. Nota: per specificare una configurazione EUC qui, l'override dell'autenticazione deve essere abilitato per la connessione. In caso contrario, la creazione del Toolset non riuscirà. Consulta: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override

connectorActions[]

object (Action)

Obbligatorio. L'elenco delle azioni/operazioni di entità del connettore per cui generare strumenti.

EndUserAuthConfig

Rappresentazione JSON
{

  // Union field auth_config can be only one of the following:
  "oauth2AuthCodeConfig": {
    object (Oauth2AuthCodeConfig)
  },
  "oauth2JwtBearerConfig": {
    object (Oauth2JwtBearerConfig)
  }
  // End of list of possible types for union field auth_config.
}
Campi
Campo unione auth_config. La configurazione di autenticazione. auth_config può essere solo uno dei seguenti tipi:
oauth2AuthCodeConfig

object (Oauth2AuthCodeConfig)

Autenticazione del codice di autorizzazione OAuth 2.0.

oauth2JwtBearerConfig

object (Oauth2JwtBearerConfig)

Autenticazione della concessione di autorizzazione OAuth 2.0 del profilo JWT.

Oauth2AuthCodeConfig

Rappresentazione JSON
{
  "oauthToken": string
}
Campi
oauthToken

string

Obbligatorio. Nome del parametro token OAuth da trasferire. Deve essere nel formato $context.variables.<name_of_variable>.

Oauth2JwtBearerConfig

Rappresentazione JSON
{
  "issuer": string,
  "subject": string,
  "clientKey": string
}
Campi
issuer

string

Obbligatorio. Nome del parametro dell'emittente da trasferire. Deve essere nel formato $context.variables.<name_of_variable>.

subject

string

Obbligatorio. Nome del parametro oggetto da trasferire. Deve essere nel formato $context.variables.<name_of_variable>.

clientKey

string

Obbligatorio. Nome del parametro client da trasferire. Deve essere nel formato $context.variables.<name_of_variable>.

Azione

Rappresentazione JSON
{
  "inputFields": [
    string
  ],
  "outputFields": [
    string
  ],

  // Union field action_spec can be only one of the following:
  "connectionActionId": string,
  "entityOperation": {
    object (EntityOperation)
  }
  // End of list of possible types for union field action_spec.
}
Campi
inputFields[]

string

Facoltativo. Campi dell'entità da utilizzare come input per l'operazione. Se non vengono specificati campi, verranno utilizzati tutti i campi dell'entità.

outputFields[]

string

Facoltativo. Campi dell'entità da restituire dall'operazione. Se non vengono specificati campi, vengono restituiti tutti i campi dell'entità.

Campo unione action_spec. Specifica di un'azione da configurare per l'utilizzo dello strumento. action_spec può essere solo uno dei seguenti tipi:
connectionActionId

string

ID di un'azione di connessione da utilizzare per lo strumento.

entityOperation

object (EntityOperation)

Configurazione dell'operazione dell'entità da utilizzare per lo strumento.

EntityOperation

Rappresentazione JSON
{
  "entityId": string,
  "operation": enum (OperationType)
}
Campi
entityId

string

Obbligatorio. ID dell'entità.

operation

enum (OperationType)

Obbligatorio. Operazione da eseguire sull'entità.

Timestamp

Rappresentazione JSON
{
  "seconds": string,
  "nanos": integer
}
Campi
seconds

string (int64 format)

Rappresenta i secondi del tempo UTC a partire dall'epoca Unix 1970-01-01T00:00:00Z. Deve essere compreso tra -62135596800 e 253402300799 inclusi (corrispondenti a 0001-01-01T00:00:00Z e 9999-12-31T23:59:59Z).

nanos

integer

Frazioni di secondo non negative con risoluzione in nanosecondi. Questo campo è la porzione di nanosecondi della durata, non un'alternativa ai secondi. I valori negativi dei secondi con frazioni devono comunque avere valori di nanosecondi non negativi che vengono conteggiati in avanti nel tempo. Deve essere compreso tra 0 e 999.999.999 inclusi.

ToolFakeConfig

Rappresentazione JSON
{
  "enableFakeMode": boolean,

  // Union field tool_response can be only one of the following:
  "codeBlock": {
    object (CodeBlock)
  }
  // End of list of possible types for union field tool_response.
}
Campi
enableFakeMode

boolean

Facoltativo. Indica se lo strumento utilizza la modalità Falso.

Campo unione tool_response. La risposta è statica o fornita da una funzione Python. tool_response può essere solo uno dei seguenti tipi:
codeBlock

object (CodeBlock)

Facoltativo. Blocco di codice che verrà eseguito al posto di una chiamata allo strumento reale.

CodeBlock

Rappresentazione JSON
{
  "pythonCode": string
}
Campi
pythonCode

string

Obbligatorio. Codice Python che verrà richiamato in modalità di simulazione dello strumento. Firma della funzione Python prevista: per intercettare tutte le chiamate di strumenti: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: per intercettare una chiamata di strumento specifica: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: se la funzione restituisce None, verrà richiamato lo strumento reale.

RequestLocation

La posizione della chiave API nella richiesta.

Enum
REQUEST_LOCATION_UNSPECIFIED Non specificato. Questo valore non deve essere utilizzato.
HEADER Rappresenta la chiave nell'intestazione HTTP.
QUERY_STRING Rappresenta la chiave nella stringa di query.

OauthGrantType

Tipi di autorizzazione con OAuth. È supportata solo la concessione delle credenziali client.

Enum
OAUTH_GRANT_TYPE_UNSPECIFIED Non specificato. Il valore predefinito è CLIENT_CREDENTIAL.
CLIENT_CREDENTIAL Rappresenta il flusso delle credenziali client.

Tipo

Tipi di dati OpenAPI.

Enum
TYPE_UNSPECIFIED Tipo non specificato.
STRING Tipo di stringa.
INTEGER Tipo intero.
NUMBER Tipo di numero.
BOOLEAN Tipo booleano.
OBJECT Tipo di oggetto.
ARRAY Tipo di array.

NullValue

Rappresenta un null JSON.

NullValue è un sentinel che utilizza un'enumerazione con un solo valore per rappresentare il valore nullo per l'unione di tipi Value.

Un campo di tipo NullValue con un valore diverso da 0 è considerato non valido. La maggior parte dei serializzatori ProtoJSON emetterà un valore con null_value impostato come null JSON indipendentemente dal valore intero, quindi eseguirà l'andata e il ritorno a un valore 0.

Enum
NULL_VALUE Valore nullo.

OperationType

L'operazione da eseguire sull'entità.

Enum
OPERATION_TYPE_UNSPECIFIED Tipo di operazione non specificato. Non valido, la creazione/l'aggiornamento di ConnectorTool non riuscirà.
LIST Elenco operazioni.
GET Recupera operazione.
CREATE Crea operazione.
UPDATE Operazione di aggiornamento.
DELETE Operazione di eliminazione.

ExecutionType

Il tipo di esecuzione dello strumento o del set di strumenti.

Enum
EXECUTION_TYPE_UNSPECIFIED Il tipo di esecuzione non è specificato. Se non specificato, il valore predefinito è SYNCHRONOUS.
SYNCHRONOUS Lo strumento viene eseguito in modo sincrono. La sessione viene bloccata finché lo strumento non viene restituito.
ASYNCHRONOUS Lo strumento viene eseguito in modo asincrono. La sessione continuerà durante l'esecuzione dello strumento.

Annotazioni dello strumento

Suggerimento distruttivo: ✅ | Suggerimento idempotente: ❌ | Suggerimento di sola lettura: ❌ | Suggerimento di mondo aperto: ❌