Ressource: Integration
Informationen zur Integration.
JSON-Darstellung |
---|
{ "name": string, "status": enum ( |
Felder | |
---|---|
name |
Nur Ausgabe Die eindeutige Kennung der Integration. Schreibgeschützt. Von der Plattform definiert. |
status |
Nur Ausgabe Integrationsstatus. |
Union-Feld integration_info . Detaillierte Informationen für die Integration. Für integration_info ist nur einer der folgenden Werte zulässig: |
|
dialogflowEsIntegration |
Informationen zu einem verknüpften Dialogflow ES-Projekt. https://cloud.google.com/dialogflow/es/docs |
dialogflowCxIntegration |
Informationen zu einem verknüpften Dialogflow CX-Projekt. https://cloud.google.com/dialogflow/cx/docs/basics |
IntegrationStatus
Integrationsstatus.
Enums | |
---|---|
INTEGRATION_STATUS_UNSPECIFIED |
Integrationsstatus ist nicht angegeben. |
ENABLED |
Aktiviert. |
DISABLED |
Deaktiviert. |
DialogflowEsIntegration
Informationen zu einem Business Messages-Agent und einer Dialogflow ES-Projektverknüpfung.
JSON-Darstellung |
---|
{ "dialogflowProjectId": string, "autoResponseStatus": enum ( |
Felder | |
---|---|
dialogflowProjectId |
Erforderlich. Dialogflow-Projekt-ID Kann nicht bearbeitet werden. Wenn Sie diesen Wert ändern möchten, müssen Sie das Dialogflow-Projekt aus diesem Agent löschen und dann eine neue Integration erstellen. |
autoResponseStatus |
Erforderlich. Wenn |
dialogflowServiceAccountEmail |
Nur Ausgabe Das Dienstkonto, das im Dialogflow-Projekt mit den Rollen „Agent-Bearbeiter“ in der Dialogflow-Konsole und „Dialogflow API-Client“ konfiguriert werden muss. Dies ist erforderlich, um Zugriff auf die Dialogflow API zu gewähren. |
operationInfo |
Nur Ausgabe Informationen zum Betriebsstatus der Dialogflow-Integration. |
dialogflowKnowledgeBases[] |
Mit dem Dialogflow-Projekt verknüpfte Wissensdatenbanken. Optional |
AutoResponseStatus
Status der automatischen Antwort von Dialogflow.
Enums | |
---|---|
AUTO_RESPONSE_STATUS_UNSPECIFIED |
Automatische Antwort ist nicht angegeben. |
ENABLED |
Automatische Antworten sind aktiviert. |
DISABLED |
Automatische Antworten sind deaktiviert. |
OperationInfo
Die Dialogflow-Vorgangsinformationen.
JSON-Darstellung |
---|
{ "operationName": string, "operationType": enum ( |
Felder | |
---|---|
operationName |
Nur Ausgabe Der vom Server zugewiesene Name (Vorgangs-ID), der nur innerhalb des Dienstes eindeutig ist, der ihn ursprünglich zurückgibt. |
operationType |
Nur Ausgabe Dialogflow-Vorgangstyp. |
operationState |
Nur Ausgabe Dialogflow-Vorgangsstatus. |
error |
Nur Ausgabe Fehlerergebnis, falls vorhanden. |
OperationType
Dialogflow-Vorgangstypen.
Enums | |
---|---|
OPERATION_TYPE_UNSPECIFIED |
Nicht definierter Typ. |
ASSOCIATE_DIALOGFLOW |
Dialogflow verknüpfen. |
DISSOCIATE_DIALOGFLOW |
Dialogflow trennen. |
ADD_DOCUMENT_TO_KNOWLEDGEBASE |
Dokument zur Wissensdatenbank hinzufügen. |
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE |
Dokument aus Wissensdatenbank löschen. |
OperationState
Vorgangsstatus in Dialogflow
Enums | |
---|---|
OPERATION_STATE_UNSPECIFIED |
Nicht angegebener Zustand. |
PROCESSING |
Wird verarbeitet. |
COMPLETED |
Abgeschlossen. |
FAILED |
Fehlgeschlagen. |
Status
Mit dem Typ Status
wird ein logisches Fehlermodell definiert, das für verschiedene Programmierumgebungen wie REST APIs und RPC APIs geeignet ist. Dieses Modell wird von gRPC verwendet. Jede Status
-Meldung enthält die folgenden drei Datenelemente: Fehlercode, Fehlermeldung und Fehlerdetails.
Weitere Informationen zu diesem Fehlermodell und zur Arbeit damit finden Sie in der API-Designanleitung.
JSON-Darstellung |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Felder | |
---|---|
code |
Der Statuscode, der idealerweise ein ENUM-Wert von |
message |
Eine an Entwickler gerichtete Fehlermeldung, die englischsprachig sein sollte. Jede Fehlermeldung an den Nutzer sollte lokalisiert und im Feld |
details[] |
Eine Auflistung aller Meldungen, die die Fehlerdetails enthalten. Es gibt einen gemeinsamen Satz von Nachrichtentypen, die APIs verwenden können. Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld |
DialogflowKnowledgebase
Informationen aus der Wissensdatenbank. Eine Wissensdatenbank kann mehrere FAQ-URLs haben.
JSON-Darstellung |
---|
{
"name": string,
"displayName": string,
"documents": [
{
object ( |
Felder | |
---|---|
name |
Nur Ausgabe Wissensdatenbank-ID Eindeutige Kennung, die vom Dialogflow-Dienst nach dem Erstellen einer Wissensdatenbank zurückgegeben wird. Wenn die Marken-ID „1234“, die Agent-ID „5678“, die Integrations-ID „9092“ und die ID der Wissensdatenbank „1111“ ist, wird dieser Parameter in „brands/1234/agents/5678/integrations/9092/knowledgebases/1111“ aufgelöst. |
displayName |
Erforderlich. Anzeigename der Wissensdatenbank. |
documents[] |
Wissensdatenbank-Dokumente Optional |
updateTime |
Nur Ausgabe Zeitpunkt, zu dem die Wissensdatenbank erstellt oder aktualisiert wurde. Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: |
DialogflowDocument
Ein Wissensdatenbankdokument. Ein Dokument kann entweder eine Website-URL oder eine URL zu einer CSV-Datei sein. URLs müssen öffentlich verfügbar sein. CSV-Dateien müssen ein oder mehrere Frage-/Antwort-Paare mit einer Zeile pro Paar enthalten.
JSON-Darstellung |
---|
{ "name": string, "displayName": string, "updateTime": string, "operationInfo": { object ( |
Felder | |
---|---|
name |
Vom System generierte Dokument-ID. Wenn die Marken-ID „1234“, die Agent-ID „5678“, die Integrations-ID „9092“, die ID der Wissensdatenbank „1111“ und die Dokument-ID „2222“ ist, wird dieser Parameter in „brands/1234/agents/5678/integrations/9092/knowledgebases/1111/“ aufgelöst. |
displayName |
Erforderlich. Anzeigename eines FAQ-Dokuments. |
updateTime |
Nur Ausgabe Zeitpunkt, zu dem das Dokument erstellt/aktualisiert wurde. Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: |
operationInfo |
Nur Ausgabe Vorgangsinformationen werden nur eingefügt, wenn ein Dokument einer vorhandenen Wissensdatenbank hinzugefügt wird. |
Union-Feld content . Inhalt des Dokuments. Für content ist nur einer der folgenden Werte zulässig: |
|
faqUrl |
URL eines FAQ-Dokuments. |
rawContent |
Der Rohinhalt des Dokuments. Ein base64-codierter String. |
DialogflowCxIntegration
Informationen zu einem Business Messages-Agent und einer Dialogflow CX-Projektverknüpfung.
JSON-Darstellung |
---|
{ "dialogflowProjectId": string, "dialogflowAgentId": string, "autoResponseStatus": enum ( |
Felder | |
---|---|
dialogflowProjectId |
Erforderlich. Dialogflow-Projekt-ID Kann nicht bearbeitet werden. Wenn Sie diesen Wert ändern möchten, müssen Sie das Dialogflow-Projekt aus diesem Agent löschen und dann eine neue Integration erstellen. |
dialogflowAgentId |
Erforderlich. Die Dialogflow-Agent-ID. |
autoResponseStatus |
Erforderlich. Wenn |
dialogflowServiceAccountEmail |
Nur Ausgabe Das Dienstkonto, das im Dialogflow-Projekt mit den Rollen „Agent-Bearbeiter“ in der Dialogflow-Konsole und „Dialogflow API-Client“ konfiguriert werden muss. Dies ist erforderlich, um Zugriff auf die Dialogflow API zu gewähren. |
operationInfo |
Nur Ausgabe Informationen zum Betriebsstatus der Dialogflow-Integration. |
Methoden |
|
---|---|
|
Erstellen Sie eine Integration. |
|
Integration löschen. |
|
Binden Sie eine Integration ein. |
|
Listen Sie Integrationen auf. |
|
Integration aktualisieren |