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 |
Erforderlich. Der Name der Bereitstellung. Format: |
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 ( |
| Felder | |
|---|---|
name |
ID. Der Ressourcenname der Bereitstellung. Format: |
displayName |
Erforderlich. Der Anzeigename der Bereitstellung. |
appVersion |
Optional. Der Ressourcenname der bereitzustellenden App-Version. Format: |
channelProfile |
Erforderlich. Das im Einsatz verwendete Kanalprofil. |
createTime |
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: |
updateTime |
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: |
etag |
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 |
Optional. Testkonfiguration für die Bereitstellung. |
whatsappCredentials |
Optional. Nur Eingabe. Beim Konfigurieren eines WhatsApp-Channelprofils sind temporäre WhatsApp-Anmeldedaten erforderlich. |
instagramCredentials |
Optional. Nur Eingabe. Bei der Konfiguration eines Instagram-Kanalprofils sind temporäre Instagram-Anmeldedaten erforderlich. |
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 |
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 ( |
| Felder | |
|---|---|
profileId |
Optional. Die eindeutige ID des Channelprofils. |
channelType |
Optional. Der Typ des Channel-Profils. |
personaProperty |
Optional. Die Persona-Eigenschaft des Kanalprofils. |
webWidgetConfig |
Optional. Die Konfiguration für das Web-Widget. |
whatsappConfig |
Optional. Konfiguration für WhatsApp-Bereitstellungen. |
instagramConfig |
Optional. Konfiguration für Instagram-Bereitstellungen. |
Union-Feld Für |
|
disableDtmf |
Optional. Gibt an, ob DTMF (Dual-Tone-Multifrequenz) deaktiviert werden soll. |
Union-Feld Für |
|
disableBargeInControl |
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 Für |
|
noiseSuppressionLevel |
Optional. Der Grad der Geräuschunterdrückung des Kanalprofils. Verfügbare Werte sind „low“, „moderate“, „high“ und „very_high“. |
PersonaProperty
| JSON-Darstellung |
|---|
{
"persona": enum ( |
| Felder | |
|---|---|
persona |
Optional. Die Persona des Kanals. |
WebWidgetConfig
| JSON-Darstellung |
|---|
{ "modality": enum ( |
| Felder | |
|---|---|
modality |
Optional. Die Modalität des Web-Widgets. |
theme |
Optional. Das Design des Web-Widgets. |
webWidgetTitle |
Optional. Der Titel des Web-Widgets. |
securitySettings |
Optional. Die Sicherheitseinstellungen des Web-Widgets. |
SecuritySettings
| JSON-Darstellung |
|---|
{ "enablePublicAccess": boolean, "enableOriginCheck": boolean, "allowedOrigins": [ string ], "enableRecaptcha": boolean } |
| Felder | |
|---|---|
enablePublicAccess |
Optional. Gibt an, ob der öffentliche Zugriff auf das Web-Widget aktiviert ist. Wenn |
enableOriginCheck |
Optional. Gibt an, ob die Ursprungsprüfung für das Web-Widget aktiviert ist. Wenn |
allowedOrigins[] |
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 |
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 |
Erforderlich. Die WhatsApp Business-Konto-ID. |
phoneNumberId |
Erforderlich. Die Meta-Telefonnummer-ID. |
phoneNumber |
Optional. Die Telefonnummer im E.164-Format. |
displayName |
Nur Ausgabe. Der abgerufene Name der Meta-Unternehmensseite. |
thumbnailUrl |
Nur Ausgabe. Die abgerufene Miniaturansicht-URL des Meta-Unternehmensprofils. |
description |
Nur Ausgabe. Die Beschreibung der Meta-Unternehmensseite oder des Meta-Profils. |
InstagramConfig
| JSON-Darstellung |
|---|
{ "instagramAccountId": string, "displayName": string, "thumbnailUrl": string, "description": string } |
| Felder | |
|---|---|
instagramAccountId |
Erforderlich. Die Instagram-Konto-ID. |
displayName |
Nur Ausgabe. Der abgerufene Name der Meta-Unternehmensseite. |
thumbnailUrl |
Nur Ausgabe. Die abgerufene Miniaturansicht-URL des Meta-Unternehmensprofils. |
description |
Nur Ausgabe. Die Beschreibung der Meta-Unternehmensseite oder des Meta-Profils. |
Zeitstempel
| JSON-Darstellung |
|---|
{ "seconds": string, "nanos": integer } |
| Felder | |
|---|---|
seconds |
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 |
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 ( |
| Felder | |
|---|---|
versionRelease |
Optional. Version für den Test. |
VersionRelease
| JSON-Darstellung |
|---|
{ "state": enum ( |
| Felder | |
|---|---|
state |
Optional. Status der Versionsveröffentlichung. |
trafficAllocations[] |
Optional. Traffic-Zuweisungen für die Versionsveröffentlichung. |
TrafficAllocation
| JSON-Darstellung |
|---|
{ "id": string, "trafficPercentage": integer, "appVersion": string } |
| Felder | |
|---|---|
id |
Optional. Die ID der Traffic-Zuordnung. Freiformatierter String mit bis zu 128 Zeichen. |
trafficPercentage |
Optional. Traffic-Prozentsatz der Traffic-Zuordnung. muss zwischen 0 und 100 liegen. |
appVersion |
Optional. App-Version der Traffic-Zuordnung. Format: |
WhatsAppCredentials
| JSON-Darstellung |
|---|
{ "authCode": string, "pin": string, "phoneNumber": string, "businessAccountId": string, "wabaId": string, "conversationProfileId": string } |
| Felder | |
|---|---|
authCode |
Erforderlich. Der Meta-Autorisierungscode, der vom eingebetteten Registrierungsvorgang bereitgestellt wird. |
pin |
Erforderlich. Die sechsstellige PIN, die vom Nutzer für die Bestätigung in zwei Schritten erstellt wurde. |
phoneNumber |
Erforderlich. Die Telefonnummer, mit der Sie sich bei WhatsApp registrieren. |
businessAccountId |
Erforderlich. Die ID des Geschäftskontos, die für die Telefonnummer verwendet werden soll. |
wabaId |
Erforderlich. Die WhatsApp Business-Konto-ID. |
conversationProfileId |
Optional. Die ID des Unterhaltungsprofils, das für die Bereitstellung verwendet werden soll. |
InstagramCredentials
| JSON-Darstellung |
|---|
{ "authCode": string, "conversationProfileId": string } |
| Felder | |
|---|---|
authCode |
Erforderlich. Der Meta-Autorisierungscode, der vom eingebetteten Registrierungsvorgang bereitgestellt wird. |
conversationProfileId |
Optional. Die ID des Unterhaltungsprofils, das für die Bereitstellung verwendet werden soll. |
ModelSettings
| JSON-Darstellung |
|---|
{ "model": string, // Union field |
| Felder | |
|---|---|
model |
Optional. Das LLM-Modell, das der Agent verwenden soll. Wenn nicht festgelegt, übernimmt der Agent das Modell vom übergeordneten Agent. |
Union-Feld Für |
|
temperature |
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: ❌