MCP Tools Reference: ces.googleapis.com

Tool: get_deployment

Ruft Details zur angegebenen Bereitstellung ab.

Das folgende Codebeispiel zeigt, wie Sie mit curl das MCP-Tool get_deployment aufrufen.

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

Eingabeschema

Anfragenachricht für AgentService.GetDeployment.

GetDeploymentRequest

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

string

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

Ausgabeschema

Ein Deployment ist eine unveränderliche, abfragbare Version der App. Es wird verwendet, um eine App-Version mit einem bestimmten Channelprofil bereitzustellen.

Bereitstellung

JSON-Darstellung
{
  "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)
}
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 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.

experimentConfig

object (ExperimentConfig)

Optional. Testkonfiguration für die Bereitstellung.

whatsappCredentials

object (WhatsAppCredentials)

Optional. Nur Eingabe. Beim Konfigurieren eines WhatsApp-Channelprofils sind temporäre WhatsApp-Anmeldedaten erforderlich.

instagramCredentials

object (InstagramCredentials)

Optional. Nur Eingabe. Bei der Konfiguration eines Instagram-Kanalprofils sind temporäre Instagram-Anmeldedaten erforderlich.

modelSettings

object (ModelSettings)

Optional. Modelleinstellungen für die Bereitstellung. Überschreibt die Modelleinstellungen, die auf App-/Agent-Ebene konfiguriert wurden. Hinweis: Das Überschreiben von Modelleinstellungen auf Bereitstellungsebene ist nur über eine Zulassungsliste möglich. Wenden Sie sich an das CXAS-Team, um dieses Feld zu aktivieren.

modality

enum (Modality)

Optional. Die Modalität der Bereitstellung. Hinweis: Das Überschreiben der Modalität auf Bereitstellungsebene ist nur über eine Zulassungsliste möglich. Wenden Sie sich an das CXAS-Team, um dieses Feld zu aktivieren.

ChannelProfile

JSON-Darstellung
{
  "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.
}
Felder
profileId

string

Optional. Die eindeutige ID des Channelprofils.

channelType

enum (ChannelType)

Optional. Der Typ des Channel-Profils.

personaProperty

object (PersonaProperty)

Optional. Die Persona-Eigenschaft des Kanalprofils.

webWidgetConfig

object (WebWidgetConfig)

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

whatsappConfig

object (WhatsAppConfig)

Optional. Konfiguration für WhatsApp-Bereitstellungen.

instagramConfig

object (InstagramConfig)

Optional. Konfiguration für Instagram-Bereitstellungen.

Union-Feld _disable_dtmf.

Für _disable_dtmf ist nur einer der folgenden Werte zulässig:

disableDtmf

boolean

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

Union-Feld _disable_barge_in_control.

Für _disable_barge_in_control ist nur einer der folgenden Werte zulässig:

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.

Union-Feld _noise_suppression_level.

Für _noise_suppression_level ist nur einer der folgenden Werte zulässig:

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 das Feld leer ist, 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.

WhatsAppConfig

JSON-Darstellung
{
  "wabaId": string,
  "phoneNumberId": string,
  "phoneNumber": string,
  "displayName": string,
  "thumbnailUrl": string,
  "description": string
}
Felder
wabaId

string

Erforderlich. Die WhatsApp Business-Konto-ID.

phoneNumberId

string

Erforderlich. Die Meta-Telefonnummer-ID.

phoneNumber

string

Optional. Die Telefonnummer im E.164-Format.

displayName

string

Nur Ausgabe. Der abgerufene Name der Meta-Unternehmensseite.

thumbnailUrl

string

Nur Ausgabe. Die abgerufene Miniaturansicht-URL des Meta-Unternehmensprofils.

description

string

Nur Ausgabe. Die Beschreibung der Meta-Unternehmensseite oder des Meta-Profils.

InstagramConfig

JSON-Darstellung
{
  "instagramAccountId": string,
  "displayName": string,
  "thumbnailUrl": string,
  "description": string
}
Felder
instagramAccountId

string

Erforderlich. Die Instagram-Konto-ID.

displayName

string

Nur Ausgabe. Der abgerufene Name der Meta-Unternehmensseite.

thumbnailUrl

string

Nur Ausgabe. Die abgerufene Miniaturansicht-URL des Meta-Unternehmensprofils.

description

string

Nur Ausgabe. Die Beschreibung der Meta-Unternehmensseite oder des Meta-Profils.

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 (einschließlich).

ExperimentConfig

JSON-Darstellung
{
  "versionRelease": {
    object (VersionRelease)
  }
}
Felder
versionRelease

object (VersionRelease)

Optional. Version für den Test.

VersionRelease

JSON-Darstellung
{
  "state": enum (State),
  "trafficAllocations": [
    {
      object (TrafficAllocation)
    }
  ]
}
Felder
state

enum (State)

Optional. Status der Versionsveröffentlichung.

trafficAllocations[]

object (TrafficAllocation)

Optional. Traffic-Zuweisungen für die Versionsveröffentlichung.

TrafficAllocation

JSON-Darstellung
{
  "id": string,
  "trafficPercentage": integer,
  "appVersion": string
}
Felder
id

string

Optional. Die ID der Traffic-Zuordnung. Freiformatierter String mit bis zu 128 Zeichen.

trafficPercentage

integer

Optional. Traffic-Prozentsatz der Traffic-Zuordnung. muss zwischen 0 und 100 liegen.

appVersion

string

Optional. App-Version der Traffic-Zuordnung. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}

WhatsAppCredentials

JSON-Darstellung
{
  "authCode": string,
  "pin": string,
  "phoneNumber": string,
  "businessAccountId": string,
  "wabaId": string,
  "conversationProfileId": string
}
Felder
authCode

string

Erforderlich. Der Meta-Autorisierungscode, der vom eingebetteten Registrierungsvorgang bereitgestellt wird.

pin

string

Erforderlich. Die sechsstellige PIN, die vom Nutzer für die Bestätigung in zwei Schritten erstellt wurde.

phoneNumber

string

Erforderlich. Die Telefonnummer, mit der Sie sich bei WhatsApp registrieren.

businessAccountId

string

Erforderlich. Die ID des Geschäftskontos, die für die Telefonnummer verwendet werden soll.

wabaId

string

Erforderlich. Die WhatsApp Business-Konto-ID.

conversationProfileId

string

Optional. Die ID des Unterhaltungsprofils, das für die Bereitstellung verwendet werden soll.

InstagramCredentials

JSON-Darstellung
{
  "authCode": string,
  "conversationProfileId": string
}
Felder
authCode

string

Erforderlich. Der Meta-Autorisierungscode, der vom eingebetteten Registrierungsvorgang bereitgestellt wird.

conversationProfileId

string

Optional. Die ID des Unterhaltungsprofils, das für die Bereitstellung verwendet werden soll.

ModelSettings

JSON-Darstellung
{
  "model": string,

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

string

Optional. Das LLM-Modell, das der Agent verwenden soll. Wenn nicht festgelegt, übernimmt der Agent das Modell vom übergeordneten Agent.

Union-Feld _temperature.

Für _temperature ist nur einer der folgenden Werte zulässig:

temperature

number

Optional. Wenn festgelegt, wird diese Temperatur für das LLM-Modell verwendet. Die Temperatur steuert die Zufälligkeit der Antworten des Modells. Niedrigere Temperaturen führen zu vorhersagbareren Antworten. Höhere Temperaturen führen zu kreativeren Antworten.

ChannelType

Der Typ des Channel-Profils.

Enums
UNKNOWN Unbekannter Kanaltyp.
WEB_UI Webbenutzeroberflächen-Channel
API API-Channel.
TWILIO Twilio-Channel.
GOOGLE_TELEPHONY_PLATFORM Google Telephony Platform-Kanal.
CONTACT_CENTER_AS_A_SERVICE Contact Center as a Service (CCaaS)
CONTACT_CENTER_AS_A_SERVICE_CHAT Contact Center as a Service (CCaaS Chat)
FIVE9 Five9-Kanal.
CONTACT_CENTER_INTEGRATION Drittanbieter-Channel für die Contact-Center-Integration.
WHATSAPP WhatsApp-Kanal.
INSTAGRAM Instagram-Kanal

Persona

Die Persona des Kanals.

Enums
UNKNOWN UNKNOWN-Persona.
CONCISE Der Agent hält die Antworten kurz und prägnant.
CHATTY Der KI-Agent liefert zusätzlichen Kontext, Erklärungen und Details.

Modalität

Modalität des Web-Widgets.

Enums
MODALITY_UNSPECIFIED Unbekannte Modalität.
CHAT_AND_VOICE Das Widget unterstützt sowohl Chat- als auch Spracheingabe.
VOICE_ONLY Das Widget unterstützt nur Spracheingabe.
CHAT_ONLY Das Widget unterstützt nur Chateingaben.
CHAT_VOICE_AND_VIDEO Das Widget unterstützt Chat-, Sprach- und Videoeingabe.

Design

Design des Web-Widgets.

Enums
THEME_UNSPECIFIED Unbekanntes Thema.
LIGHT Helles Design
DARK Dunkles Design

Bundesland

Status des Tests.

Enums
STATE_UNSPECIFIED Nicht angegebener Zustand.
PENDING Eingestellt: Dieser Status wird nicht mehr verwendet.
RUNNING Ausführungsstatus. Der Test läuft und ist gültig.
DONE Eingestellt: Dieser Status wird nicht mehr verwendet.
EXPIRED Eingestellt: Dieser Status wird nicht mehr verwendet.

Modalität

Die Modalität der Bereitstellung.

Enums
MODALITY_UNSPECIFIED Unbekannte Modalität.
MODALITY_TEXT Textmodalität.
MODALITY_VOICE Sprachmodalität
MODALITY_VIDEO Videomodalität.

Tool-Annotationen

Tool-Anmerkungen werden an MCP-Clients gesendet, um das grundlegende Risiko eines bestimmten Tools zu beschreiben. Die meisten Clients behandeln diese Hinweise als nicht vertrauenswürdig, sie können aber verwendet werden, um zu entscheiden, wann eine Bestätigungsaufforderung an einen Nutzer gesendet wird.

Zusammen mit dem Titelstring sind die folgenden booleschen Hinweise definiert:

  • readOnlyHint: Wenn „true“, ändert das Tool seine Umgebung nicht. Standardeinstellung: false.
  • destructiveHint: Wenn „true“, kann das Tool destruktive Aktionen ausführen. Wenn „false“, kann das Tool nur additive Aktionen ausführen. Standardeinstellung: true.
  • idempotentHint: Wenn „true“, hat das wiederholte Aufrufen des Tools mit denselben Argumenten keine zusätzlichen Auswirkungen auf die Umgebung. Standardeinstellung: false.
  • openWorldHint: Wenn „true“, kann das Tool mit einer „offenen Welt“ externer Einheiten interagieren. Wenn „false“, kann das Tool nur mit internen Einheiten interagieren. Ein Web-Suchtool wäre beispielsweise frei verfügbar, ein Memory-Tool jedoch nicht.

Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌