MCP Tools Reference: ces.googleapis.com

Strumento: list_deployments

Elenca i deployment nell'app specificata.

Il seguente esempio di codice mostra come utilizzare curl per chiamare lo strumento MCP list_deployments.

Richiesta curl 
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": "list_deployments",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Schema di input

Messaggio di richiesta per AgentService.ListDeployments.

ListDeploymentsRequest

Rappresentazione JSON 
{
  "parent": string,
  "pageSize": integer,
  "pageToken": string,
  "orderBy": string
}
Campi
parent

string

Obbligatorio. L'app genitore. Formato: projects/{project}/locations/{location}/apps/{app}
pageSize

integer

Facoltativo. Il numero massimo di deployment da restituire. Il servizio potrebbe restituire un numero inferiore a questo valore. Se non specificato, verranno restituiti al massimo 50 deployment. Il valore massimo è 1000; i valori superiori a 1000 verranno forzati a 1000.
pageToken

string

Facoltativo. Un token di pagina ricevuto da una precedente chiamata ListDeployments. Forniscilo per recuperare la pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti a ListDeployments devono corrispondere alla chiamata che ha fornito il token di pagina.
orderBy

string

Facoltativo. Campo in base al quale ordinare. Sono supportati solo "name" e "create_time". Per maggiori dettagli, visita la pagina https://google.aip.dev/132#ordering.

Schema di output

Messaggio di risposta per AgentService.ListDeployments.

ListDeploymentsResponse

Rappresentazione JSON 
{
  "deployments": [
    {
      object (Deployment)
    }
  ],
  "nextPageToken": string
}
Campi
deployments[]

object (Deployment)

L'elenco dei deployment.
nextPageToken

string

Un token, che può essere inviato come page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

Deployment

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,
  "appVersion": string,
  "channelProfile": {
    object (ChannelProfile)
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "experimentConfig": {
    object (ExperimentConfig)
  },
  "whatsappCredentials": {
    object (WhatsAppCredentials)
  },
  "instagramCredentials": {
    object (InstagramCredentials)
  },
  "modelSettings": {
    object (ModelSettings)
  },
  "modality": enum (Modality)
}
Campi
name

string

Identificatore. Il nome della risorsa del deployment. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
displayName

string

Obbligatorio. Il nome visualizzato del deployment.
appVersion

string

Facoltativo. Il nome risorsa della versione dell'app di cui eseguire il deployment. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version} utilizza projects/{project}/locations/{location}/apps/{app}/versions/- per utilizzare l'app bozza.
channelProfile

object (ChannelProfile)

Obbligatorio. Il profilo del canale utilizzato nel deployment.
createTime

string (Timestamp format)

Solo output. Timestamp di creazione di questo deployment.

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 di questo deployment.

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

Solo output. 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.
experimentConfig

object (ExperimentConfig)

Facoltativo. Configurazione dell'esperimento per il deployment.
whatsappCredentials

object (WhatsAppCredentials)

Facoltativo. Solo input. Credenziali WhatsApp effimere richieste durante la configurazione di un profilo del canale WhatsApp.
instagramCredentials

object (InstagramCredentials)

Facoltativo. Solo input. Le credenziali temporanee di Instagram sono necessarie per configurare un profilo del canale Instagram.
modelSettings

object (ModelSettings)

Facoltativo. Impostazioni del modello per il deployment. Esegue l'override delle impostazioni del modello configurate a livello di app/agente. Nota: l'override delle impostazioni del modello a livello di deployment è controllato da una lista consentita. Contatta il team CXAS per attivare questo campo.
modality

enum (Modality)

Facoltativo. La modalità di deployment. Nota: l'override della modalità a livello di deployment è protetto da una lista consentita. Contatta il team CXAS per attivare questo campo.

ChannelProfile

Rappresentazione JSON 
{
  "profileId": string,
  "channelType": enum (ChannelType),
  "personaProperty": {
    object (PersonaProperty)
  },
  "webWidgetConfig": {
    object (WebWidgetConfig)
  },
  "whatsappConfig": {
    object (WhatsAppConfig)
  },
  "instagramConfig": {
    object (InstagramConfig)
  },

  // Union field _disable_dtmf can be only one of the following:
  "disableDtmf": boolean
  // End of list of possible types for union field _disable_dtmf.

  // Union field _disable_barge_in_control can be only one of the following:
  "disableBargeInControl": boolean
  // End of list of possible types for union field _disable_barge_in_control.

  // Union field _noise_suppression_level can be only one of the following:
  "noiseSuppressionLevel": string
  // End of list of possible types for union field _noise_suppression_level.
}
Campi
profileId

string

Facoltativo. L'identificatore univoco del profilo del canale.
channelType

enum (ChannelType)

Facoltativo. Il tipo di profilo del canale.
personaProperty

object (PersonaProperty)

Facoltativo. La proprietà Persona del profilo del canale.
webWidgetConfig

object (WebWidgetConfig)

Facoltativo. La configurazione del widget web.
whatsappConfig

object (WhatsAppConfig)

Facoltativo. Configurazione specifica per i deployment di WhatsApp.
instagramConfig

object (InstagramConfig)

Facoltativo. Configurazione specifica per i deployment di Instagram.

Campo unione _disable_dtmf.

_disable_dtmf può essere solo uno dei seguenti tipi:
disableDtmf

boolean

Facoltativo. Indica se disattivare il DTMF (multi-frequenza a due toni).

Campo unione _disable_barge_in_control.

_disable_barge_in_control può essere solo uno dei seguenti tipi:
disableBargeInControl

boolean

Facoltativo. Se disattivare il controllo dell'interruzione dell'utente nella conversazione. - true: le interruzioni dell'utente sono disattivate mentre l'agente parla. - false: l'agente mantiene il controllo automatico su quando l'utente può interrompere.

Campo unione _noise_suppression_level.

_noise_suppression_level può essere solo uno dei seguenti tipi:
noiseSuppressionLevel

string

Facoltativo. Il livello di eliminazione del rumore del profilo del canale. I valori disponibili sono "low", "moderate", "high", "very_high".

PersonaProperty

Rappresentazione JSON 
{
  "persona": enum (Persona)
}
Campi
persona

enum (Persona)

Facoltativo. La personalità del canale.

WebWidgetConfig

Rappresentazione JSON 
{
  "modality": enum (Modality),
  "theme": enum (Theme),
  "webWidgetTitle": string,
  "securitySettings": {
    object (SecuritySettings)
  }
}
Campi
modality

enum (Modality)

Facoltativo. La modalità del widget web.
theme

enum (Theme)

Facoltativo. Il tema del widget web.
webWidgetTitle

string

Facoltativo. Il titolo del widget web.
securitySettings

object (SecuritySettings)

Facoltativo. Le impostazioni di sicurezza del widget web.

SecuritySettings

Rappresentazione JSON 
{
  "enablePublicAccess": boolean,
  "enableOriginCheck": boolean,
  "allowedOrigins": [
    string
  ],
  "enableRecaptcha": boolean
}
Campi
enablePublicAccess

boolean

Facoltativo. Indica se l'accesso pubblico al widget web è abilitato. Se true, il widget web sarà accessibile pubblicamente. Se false, il widget web deve essere integrato con il tuo sistema di autenticazione e autorizzazione per restituire credenziali valide per l'accesso all'agente CES.
enableOriginCheck

boolean

Facoltativo. Indica se il controllo dell'origine per il widget web è attivato. Se true, il widget web controllerà l'origine del sito web che lo carica e ne consentirà il caricamento solo nella stessa origine o in una delle origini consentite.
allowedOrigins[]

string

Facoltativo. Le origini autorizzate a ospitare il widget web. Un'origine è definita dalla RFC 6454. Se vuoto, tutte le origini sono consentite. Sono consentite massimo 100 origini. Esempio: "https://example.com"
enableRecaptcha

boolean

Facoltativo. Indica se la verifica reCAPTCHA per il widget web è abilitata.

WhatsAppConfig

Rappresentazione JSON 
{
  "wabaId": string,
  "phoneNumberId": string,
  "phoneNumber": string,
  "displayName": string,
  "thumbnailUrl": string,
  "description": string
}
Campi
wabaId

string

Obbligatorio. L'ID account WhatsApp Business.
phoneNumberId

string

Obbligatorio. L'ID numero di telefono Meta.
phoneNumber

string

Facoltativo. Il numero di telefono in formato E.164.
displayName

string

Solo output. Il nome della pagina aziendale Meta recuperata.
thumbnailUrl

string

Solo output. L'URL della miniatura del profilo dell'attività Meta recuperato.
description

string

Solo output. La descrizione della pagina o del profilo aziendale Meta.

InstagramConfig

Rappresentazione JSON 
{
  "instagramAccountId": string,
  "displayName": string,
  "thumbnailUrl": string,
  "description": string
}
Campi
instagramAccountId

string

Obbligatorio. L'ID account Instagram.
displayName

string

Solo output. Il nome della pagina aziendale Meta recuperata.
thumbnailUrl

string

Solo output. L'URL della miniatura del profilo dell'attività Meta recuperato.
description

string

Solo output. La descrizione della pagina o del profilo aziendale Meta.

Timestamp

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

string (int64 format)

Rappresenta i secondi di tempo UTC trascorsi dall'epoca di 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 parte in 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.

ExperimentConfig

Rappresentazione JSON 
{
  "versionRelease": {
    object (VersionRelease)
  }
}
Campi
versionRelease

object (VersionRelease)

Facoltativo. Versione di rilascio per l'esperimento.

VersionRelease

Rappresentazione JSON 
{
  "state": enum (State),
  "trafficAllocations": [
    {
      object (TrafficAllocation)
    }
  ]
}
Campi
state

enum (State)

Facoltativo. Lo stato del rilascio della versione.
trafficAllocations[]

object (TrafficAllocation)

Facoltativo. Allocazioni del traffico per il rilascio della versione.

TrafficAllocation

Rappresentazione JSON 
{
  "id": string,
  "trafficPercentage": integer,
  "appVersion": string
}
Campi
id

string

Facoltativo. ID dell'assegnazione del traffico. Stringa in formato libero, fino a 128 caratteri.
trafficPercentage

integer

Facoltativo. Percentuale di traffico dell'assegnazione del traffico. Il valore deve essere compreso tra 0 e 100.
appVersion

string

Facoltativo. Versione dell'app dell'assegnazione del traffico. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version}

WhatsAppCredentials

Rappresentazione JSON 
{
  "authCode": string,
  "pin": string,
  "phoneNumber": string,
  "businessAccountId": string,
  "wabaId": string,
  "conversationProfileId": string
}
Campi
authCode

string

Obbligatorio. Il codice di autorizzazione Meta fornito dal flusso di registrazione incorporato.
pin

string

Obbligatorio. Il PIN di 6 cifre creato dall'utente per la verifica in due passaggi.
phoneNumber

string

Obbligatorio. Il numero di telefono con cui registrarsi su WhatsApp.
businessAccountId

string

Obbligatorio. L'ID account aziendale da utilizzare per il numero di telefono.
wabaId

string

Obbligatorio. L'ID account WhatsApp Business.
conversationProfileId

string

Facoltativo. L'ID profilo di conversazione da utilizzare per il deployment.

InstagramCredentials

Rappresentazione JSON 
{
  "authCode": string,
  "conversationProfileId": string
}
Campi
authCode

string

Obbligatorio. Il codice di autorizzazione Meta fornito dal flusso di registrazione incorporato.
conversationProfileId

string

Facoltativo. L'ID profilo di conversazione da utilizzare per il deployment.

ModelSettings

Rappresentazione JSON 
{
  "model": string,

  // Union field _temperature can be only one of the following:
  "temperature": number
  // End of list of possible types for union field _temperature.
}
Campi
model

string

Facoltativo. Il modello LLM che l'agente deve utilizzare. Se non è impostato, l'agente erediterà il modello dall'agente principale.

Campo unione _temperature.

_temperature può essere solo uno dei seguenti tipi:
temperature

number

Facoltativo. Se impostata, questa temperatura verrà utilizzata per il modello LLM. La temperatura controlla la casualità delle risposte del modello. Le temperature più basse producono risposte più prevedibili. Le temperature più alte producono risposte più creative.

ChannelType

Il tipo di profilo del canale.

Enum
UNKNOWN Tipo di canale sconosciuto.
WEB_UI Canale UI web.
API Canale API.
TWILIO Canale Twilio.
GOOGLE_TELEPHONY_PLATFORM Canale della piattaforma di telefonia Google.
CONTACT_CENTER_AS_A_SERVICE Canale Contact Center as a Service (CCaaS).
CONTACT_CENTER_AS_A_SERVICE_CHAT Canale Contact Center as a Service (CCaaS Chat).
FIVE9 Canale Five9.
CONTACT_CENTER_INTEGRATION Canale di integrazione del contact center di terze parti.
WHATSAPP Canale WhatsApp.
INSTAGRAM Canale Instagram.

Utente tipo

La personalità del canale.

Enum
UNKNOWN Utente tipo SCONOSCIUTO.
CONCISE L'agente mantiene le risposte concise e pertinenti
CHATTY L'agente fornisce contesto, spiegazioni e dettagli aggiuntivi

Modalità

Modalità del widget web.

Enum
MODALITY_UNSPECIFIED Modalità sconosciuta.
CHAT_AND_VOICE Il widget supporta sia l'input vocale che quello tramite chat.
VOICE_ONLY Il widget supporta solo l'input vocale.
CHAT_ONLY Il widget supporta solo l'input della chat.
CHAT_VOICE_AND_VIDEO Il widget supporta l'input di chat, voce e video.

Tema

Il tema del widget web.

Enum
THEME_UNSPECIFIED Tema sconosciuto.
LIGHT Tema chiaro.
DARK Tema scuro.

Stato

Stato dell'esperimento.

Enum
STATE_UNSPECIFIED Stato non specificato.
PENDING Deprecato: questo stato non è più utilizzato.
RUNNING Stato di esecuzione. L'esperimento è in corso ed è valido.
DONE Deprecato: questo stato non è più utilizzato.
EXPIRED Deprecato: questo stato non è più utilizzato.

Modalità

La modalità di deployment.

Enum
MODALITY_UNSPECIFIED Modalità sconosciuta.
MODALITY_TEXT Modalità testo.
MODALITY_VOICE Modalità vocale.
MODALITY_VIDEO Modalità video.

Annotazioni dello strumento

Le annotazioni dello strumento vengono inviate ai client MCP per descrivere il rischio di base di un determinato strumento. La maggior parte dei client considera questi suggerimenti non attendibili, ma possono essere utilizzati per decidere quando inviare a un utente una richiesta di conferma.

Oltre alla stringa del titolo, sono definiti i seguenti suggerimenti booleani:

  • readOnlyHint: se è true, lo strumento non modifica il suo ambiente. Valore predefinito: false.
  • destructiveHint: se è true, lo strumento può eseguire azioni distruttive. Se il valore è false, lo strumento può eseguire solo azioni additive. Valore predefinito: true.
  • idempotentHint: se è true, chiamare ripetutamente lo strumento con gli stessi argomenti non avrà alcun effetto aggiuntivo sul suo ambiente. Valore predefinito: false.
  • openWorldHint: se è true, lo strumento può interagire con un "open world" di entità esterne. Se è false, lo strumento può interagire solo con le entità interne. Ad esempio, uno strumento di ricerca web sarebbe open world, mentre uno strumento di memoria no.

Suggerimento distruttivo: ❌ | Suggerimento idempotente: ✅ | Suggerimento di sola lettura: ✅ | Suggerimento open world: ❌