MCP Tools Reference: ces.googleapis.com

Tool: list_deployments

Listet Bereitstellungen in der angegebenen App auf.

Im folgenden Beispiel wird gezeigt, wie Sie mit curl das MCP-Tool list_deployments aufrufen.

Curl-Anfrage
                  
curl --location 'https://ces.[REGION].rep.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
}'
                

Eingabeschema

Anfragenachricht für AgentService.ListDeployments.

ListDeploymentsRequest

JSON-Darstellung
{
  "parent": string,
  "pageSize": integer,
  "pageToken": string,
  "orderBy": string
}
Felder
parent

string

Erforderlich. Die übergeordnete App. Format: projects/{project}/locations/{location}/apps/{app}

pageSize

integer

Optional. Die maximale Anzahl der Bereitstellungen, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 50 Bereitstellungen zurückgegeben. Der Höchstwert liegt bei 1.000. Alle Werte darüber werden implizit in 1.000 umgewandelt.

pageToken

string

Optional. Ein Seitentoken, das von einem vorherigen ListDeployments-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für ListDeployments bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

orderBy

string

Optional. Feld, nach dem sortiert werden soll. Nur „name“ und „create_time“ werden unterstützt. Weitere Informationen finden Sie unter https://google.aip.dev/132#ordering.

Ausgabeschema

Antwortnachricht für AgentService.ListDeployments.

ListDeploymentsResponse

JSON-Darstellung
{
  "deployments": [
    {
      object (Deployment)
    }
  ],
  "nextPageToken": string
}
Felder
deployments[]

object (Deployment)

Die Liste der Bereitstellungen.

nextPageToken

string

Ein Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

Bereitstellung

JSON-Darstellung
{
  "name": string,
  "displayName": string,
  "appVersion": string,
  "channelProfile": {
    object (ChannelProfile)
  },
  "createTime": string,
  "updateTime": string,
  "etag": string
}
Felder
name

string

ID. Der Ressourcenname der Bereitstellung. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

displayName

string

Erforderlich. Der Anzeigename der Bereitstellung.

appVersion

string

Optional. Der Ressourcenname der bereitzustellenden App-Version. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version} Verwenden Sie projects/{project}/locations/{location}/apps/{app}/versions/-, um die App-Version im Entwurf zu verwenden.

channelProfile

object (ChannelProfile)

Erforderlich. Das im Einsatz verwendete Kanalprofil.

createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung dieser Bereitstellung.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

updateTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der letzten Aktualisierung dieser Bereitstellung.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

etag

string

Nur Ausgabe. Etag, das verwendet wird, um sicherzustellen, dass sich das Objekt während eines Read-Modify-Write-Vorgangs nicht geändert hat. Wenn das ETag leer ist, werden alle gleichzeitigen Änderungen durch das Update überschrieben.

ChannelProfile

JSON-Darstellung
{
  "profileId": string,
  "channelType": enum (ChannelType),
  "personaProperty": {
    object (PersonaProperty)
  },
  "disableDtmf": boolean,
  "disableBargeInControl": boolean,
  "webWidgetConfig": {
    object (WebWidgetConfig)
  },
  "noiseSuppressionLevel": string
}
Felder
profileId

string

Optional. Die eindeutige ID des Channelprofils.

channelType

enum (ChannelType)

Optional. Der Typ des Channelprofils.

personaProperty

object (PersonaProperty)

Optional. Die Persona-Eigenschaft des Kanalprofils.

disableDtmf

boolean

Optional. Gibt an, ob DTMF (Dual-Tone-Multifrequenz) deaktiviert werden soll.

disableBargeInControl

boolean

Optional. Gibt an, ob die Funktion zum Unterbrechen von Nutzeranfragen in der Unterhaltung deaktiviert werden soll. – true: Nutzerunterbrechungen sind deaktiviert, während der Agent spricht. – false: Der Agent behält die automatische Kontrolle darüber, wann der Nutzer unterbrechen kann.

webWidgetConfig

object (WebWidgetConfig)

Optional. Die Konfiguration für das Web-Widget.

noiseSuppressionLevel

string

Optional. Der Grad der Geräuschunterdrückung des Kanalprofils. Verfügbare Werte sind „low“, „moderate“, „high“ und „very_high“.

PersonaProperty

JSON-Darstellung
{
  "persona": enum (Persona)
}
Felder
persona

enum (Persona)

Optional. Die Persona des Kanals.

WebWidgetConfig

JSON-Darstellung
{
  "modality": enum (Modality),
  "theme": enum (Theme),
  "webWidgetTitle": string,
  "securitySettings": {
    object (SecuritySettings)
  }
}
Felder
modality

enum (Modality)

Optional. Die Modalität des Web-Widgets.

theme

enum (Theme)

Optional. Das Design des Web-Widgets.

webWidgetTitle

string

Optional. Der Titel des Web-Widgets.

securitySettings

object (SecuritySettings)

Optional. Die Sicherheitseinstellungen des Web-Widgets.

SecuritySettings

JSON-Darstellung
{
  "enablePublicAccess": boolean,
  "enableOriginCheck": boolean,
  "allowedOrigins": [
    string
  ],
  "enableRecaptcha": boolean
}
Felder
enablePublicAccess

boolean

Optional. Gibt an, ob der öffentliche Zugriff auf das Web-Widget aktiviert ist. Wenn true, ist das Web-Widget öffentlich zugänglich. Wenn false, muss das Web-Widget in Ihr eigenes Authentifizierungs- und Autorisierungssystem integriert werden, um gültige Anmeldedaten für den Zugriff auf den CES-Agent zurückzugeben.

enableOriginCheck

boolean

Optional. Gibt an, ob die Ursprungsprüfung für das Web-Widget aktiviert ist. Wenn true, prüft das Web-Widget den Ursprung der Website, auf der das Web-Widget geladen wird. Das Laden ist nur für denselben Ursprung oder einen der zulässigen Ursprünge zulässig.

allowedOrigins[]

string

Optional. Die Ursprünge, die das Web-Widget hosten dürfen. Ein Ursprung wird durch RFC 6454 definiert. Wenn leer, sind alle Ursprünge zulässig. Es sind maximal 100 Ursprünge zulässig. Beispiel: „https://beispiel.de“

enableRecaptcha

boolean

Optional. Gibt an, ob die reCAPTCHA-Überprüfung für das Web-Widget aktiviert ist.

Zeitstempel

JSON-Darstellung
{
  "seconds": string,
  "nanos": integer
}
Felder
seconds

string (int64 format)

Stellt Sekunden der UTC-Zeit seit Unix-Epoche 1970-01-01T00:00:00Z dar. Muss einschließlich zwischen -62135596800 und 253402300799 liegen (entspricht 0001-01-01T00:00:00Z bis 9999-12-31T23:59:59Z).

nanos

integer

Nicht negative Sekundenbruchteile Nanosekunden-Auflösung. Dieses Feld enthält den Nanosekundenanteil der Dauer und ist keine Alternative zu Sekunden. Negative Sekundenwerte mit Bruchteilen müssen weiterhin nicht negative Nano-Werte haben, die zeitlich vorwärts gezählt werden. Muss zwischen 0 und 999.999.999 liegen.

Tool-Annotationen

Destruktiver Hinweis: ❌ | Idempotenter Hinweis: ✅ | Nur-Lese-Hinweis: ✅ | Open-World-Hinweis: ❌