REST Resource: projects.locations.apps.deployments

Ressource: Bereitstellung

Eine Bereitstellung ist eine unveränderliche, abfragbare Version der App. Sie wird verwendet, um eine App-Version mit einem bestimmten Channel-Profil bereitzustellen.

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 (Deployment.Modality),
  "agentRegistryDeployment": {
    object (AgentRegistryDeployment)
  }
}
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 in der Bereitstellung verwendete Channel-Profil.
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, mit dem sichergestellt wird, dass sich das Objekt während eines Read-Modify-Write-Vorgangs nicht geändert hat. Wenn das ETag leer ist, werden durch das Update alle gleichzeitigen Änderungen ü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. Beim Konfigurieren eines Instagram-Kanalprofils sind flüchtige Instagram-Anmeldedaten erforderlich.
modelSettings

object (ModelSettings)

Optional. Modelleinstellungen für die Bereitstellung. Überschreibt die auf App-/Agent-Ebene konfigurierten Modelleinstellungen. 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 (Deployment.Modality)

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

object (AgentRegistryDeployment)

Optional. Konfiguration für die Bereitstellung dieser Bereitstellung in Agent Registry. Falls vorhanden, wird diese Bereitstellung in Agent Registry veröffentlicht.

ExperimentConfig

Test für die Bereitstellung

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

object (ExperimentConfig.VersionRelease)

Optional. Version für den Test.

ExperimentConfig.VersionRelease

Version für den Test.

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

enum (ExperimentConfig.State)

Optional. Status der Version.
trafficAllocations[]

object (ExperimentConfig.VersionRelease.TrafficAllocation)

Optional. Traffic-Zuweisungen für das Release der Version.

ExperimentConfig.State

Status des Tests.

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

ExperimentConfig.VersionRelease.TrafficAllocation

Traffic-Zuordnung für die Versionsveröffentlichung.

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

string

Optional. ID der Traffic-Zuordnung. String im freien Format mit bis zu 128 Zeichen.
trafficPercentage

integer

Optional. Prozentsatz des Traffics für die 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

Temporäre Meta-Anmeldedaten für die native WhatsApp-Integration.

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 6‑stellige 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 Geschäfts-Konto-ID, die für die Telefonnummer verwendet werden soll.
wabaId

string

Erforderlich. Die WhatsApp Business-Konto-ID.
conversationProfileId

string

Optional. Die Konversationsprofil-ID, die für die Bereitstellung verwendet werden soll.

InstagramCredentials

Sitzungsspezifische Meta-Anmeldedaten für die native Instagram-Integration.

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

string

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

string

Optional. Die Konversationsprofil-ID, die für die Bereitstellung verwendet werden soll.

Deployment.Modality

Die Modalität der Bereitstellung.

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

AgentRegistryDeployment

Konfiguration und Status für die Bereitstellung der Agent Registry.

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

string

Optional. Nur Ausgabe. Der Ressourcenname des bereitgestellten Agent Registry-Dienstes. Format: projects/{project}/locations/{location}/services/{service}

Methoden

create

 Erstellt ein neues Deployment in der angegebenen App.

delete

 Löscht das angegebene Deployment.

get

 Ruft die Details der angegebenen Bereitstellung ab.

getExtendedAgentCard

 Ruft die erweiterte Agentenkarte für den authentifizierten Agenten ab.

list

 Listet Bereitstellungen in der angegebenen App auf.

patch

 Aktualisiert die angegebene Bereitstellung.