Zasób: Integration
Informacje o integracji.
Zapis JSON |
---|
{ "name": string, "status": enum ( |
Pola | |
---|---|
name |
Tylko dane wyjściowe. Unikalny identyfikator integracji. Tylko do odczytu. Zdefiniowane przez platformę. |
status |
Tylko dane wyjściowe. Stan integracji. |
Pole sumy integration_info . Szczegółowe informacje dotyczące integracji. integration_info może być tylko jedną z tych wartości: |
|
dialogflowEsIntegration |
Informacje o powiązanym projekcie Dialogflow ES. https://cloud.google.com/dialogflow/es/docs |
dialogflowCxIntegration |
Informacje o powiązanym projekcie Dialogflow CX. https://cloud.google.com/dialogflow/cx/docs/basics |
agentWebhookIntegration |
Informacje o webhooku agenta. Jeśli webhook jest skonfigurowany na poziomie agenta, zastąpi on webhook na poziomie partnera. |
IntegrationStatus
Stany integracji.
Wartości w polu enum | |
---|---|
INTEGRATION_STATUS_UNSPECIFIED |
Stan integracji jest nieokreślony. |
ENABLED |
Włączono. |
DISABLED |
Wyłączono. |
DialogflowEsIntegration
Informacje o agencie Business Messages i powiązaniu projektu Dialogflow ES.
Zapis JSON |
---|
{ "dialogflowProjectId": string, "autoResponseStatus": enum ( |
Pola | |
---|---|
dialogflowProjectId |
To pole jest wymagane. Identyfikator projektu Dialogflow. Nie można jej edytować. Aby zmienić tę wartość, musisz usunąć projekt Dialogflow z tego agenta, a następnie utworzyć nową integrację. |
autoResponseStatus |
To pole jest wymagane. Jeśli |
dialogflowServiceAccountEmail |
Tylko dane wyjściowe. Konto usługi, które należy skonfigurować w projekcie Dialogflow przy użyciu ról „edytujący agenty konsoli Dialogflow” i „klient interfejsu Dialogflow API”. Jest to wymagane do zapewnienia dostępu do interfejsu Dialogflow API. |
operationInfo |
Tylko dane wyjściowe. Informacje o stanie działania integracji Dialogflow. |
dialogflowKnowledgeBases[] |
Bazy wiedzy powiązane z projektem Dialogflow. Opcjonalnie |
AutoResponseStatus
Stan automatycznej odpowiedzi Dialogflow.
Wartości w polu enum | |
---|---|
AUTO_RESPONSE_STATUS_UNSPECIFIED |
Automatyczna odpowiedź nie jest określona. |
ENABLED |
Automatyczna odpowiedź jest włączona. |
DISABLED |
Automatyczna odpowiedź jest wyłączona. |
OperationInfo
informacje o operacji Dialogflow;
Zapis JSON |
---|
{ "operationName": string, "operationType": enum ( |
Pola | |
---|---|
operationName |
Tylko dane wyjściowe. Nazwa przypisana przez serwer (identyfikator operacji), która jest unikalna tylko w tej samej usłudze, która została zwrócona. |
operationType |
Tylko dane wyjściowe. Typ operacji Dialogflow. |
operationState |
Tylko dane wyjściowe. Stan operacji Dialogflow. |
error |
Tylko dane wyjściowe. Wynik błędu (jeśli wystąpił). |
OperationType
Typy operacji Dialogflow.
Wartości w polu enum | |
---|---|
OPERATION_TYPE_UNSPECIFIED |
Nieokreślony typ. |
ASSOCIATE_DIALOGFLOW |
Powiąż Dialogflow. |
DISSOCIATE_DIALOGFLOW |
Usuwanie powiązań z Dialogflow. |
ADD_DOCUMENT_TO_KNOWLEDGEBASE |
Dodaj dokument do bazy wiedzy. |
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE |
Usunięcie dokumentu z bazy wiedzy. |
OperationState
Stany operacji w Dialogflow.
Wartości w polu enum | |
---|---|
OPERATION_STATE_UNSPECIFIED |
Nieokreślony stan. |
PROCESSING |
Przetwarzam. |
COMPLETED |
Zakończono. |
FAILED |
Niepowodzenie. |
Stan
Typ Status
definiuje model logiczny błędów, który jest odpowiedni do różnych środowisk programowania, w tym interfejsów API REST i RPC. Jest używany przez gRPC. Każdy komunikat Status
zawiera 3 rodzaje danych: kod błędu, komunikat o błędzie i szczegóły błędu.
Więcej informacji o tym modelu błędu i o tym, jak z nim korzystać, znajdziesz w przewodniku po projektowaniu interfejsów API.
Zapis JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Pola | |
---|---|
code |
Kod stanu, który powinien być wartością wyliczeniową |
message |
Komunikat o błędzie widoczny dla deweloperów w języku angielskim. Każdy komunikat o błędzie widoczny dla użytkownika powinien być zlokalizowany i wysyłany w polu |
details[] |
Lista komunikatów ze szczegółami błędu. Istnieje wspólny zestaw typów wiadomości używanych przez interfejsy API. Obiekt zawierający pola dowolnego typu. Dodatkowe pole |
DialogflowKnowledgebase
Informacje w bazie wiedzy. Baza wiedzy może mieć wiele adresów URL z najczęstszymi pytaniami.
Zapis JSON |
---|
{
"name": string,
"displayName": string,
"documents": [
{
object ( |
Pola | |
---|---|
name |
Tylko dane wyjściowe. Identyfikator bazy wiedzy. Unikalny identyfikator zwrócony przez usługę Dialogflow po utworzeniu bazy wiedzy. Jeśli identyfikator marki to „1234”, identyfikator agenta to „5678”, identyfikator integracji to „9092”, a identyfikator bazy wiedzy to „1111”, parametr przyjmuje wartość „brands/1234/agents/5678/integrations/9092/knowledgebases/1111”. |
displayName |
To pole jest wymagane. Wyświetlana nazwa bazy wiedzy. |
documents[] |
Dokumenty bazy wiedzy. Opcjonalnie |
updateTime |
Tylko dane wyjściowe. Czas utworzenia lub zaktualizowania bazy wiedzy. Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: |
DialogflowDocument
Dokument bazy wiedzy. Dokumentem może być adres URL witryny lub plik CSV. Adresy URL muszą być dostępne publicznie. Pliki CSV muszą zawierać co najmniej jedną parę pytań/odpowiedzi, po jednym wierszu na każdą parę.
Zapis JSON |
---|
{ "name": string, "displayName": string, "updateTime": string, "operationInfo": { object ( |
Pola | |
---|---|
name |
Wygenerowany przez system identyfikator dokumentu. Jeśli identyfikator marki to „1234”, identyfikator agenta to „5678”, identyfikator integracji to „9092”, identyfikator bazy wiedzy to „1111”, a identyfikator dokumentu to „2222”, parametr ten ma postać „brands/1234/agents/5678/integrations/9092/knowledgebase/2”. |
displayName |
To pole jest wymagane. Wyświetlana nazwa dokumentu z najczęstszymi pytaniami. |
updateTime |
Tylko dane wyjściowe. Godzina utworzenia/aktualizacji dokumentu. Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: |
operationInfo |
Tylko dane wyjściowe. Informacje o operacji są wypełniane tylko wtedy, gdy dokument zostanie dodany do istniejącej bazy wiedzy. |
Pole sumy content . Treść dokumentu. content może być tylko jedną z tych wartości: |
|
faqUrl |
Adres URL dokumentu z najczęstszymi pytaniami. |
rawContent |
Sama treść dokumentu. Ciąg zakodowany w standardzie base64. |
DialogflowCxIntegration
Informacje o agencie Business Messages i powiązaniu projektu Dialogflow CX.
Zapis JSON |
---|
{ "dialogflowProjectId": string, "dialogflowAgentId": string, "autoResponseStatus": enum ( |
Pola | |
---|---|
dialogflowProjectId |
To pole jest wymagane. Identyfikator projektu Dialogflow. Nie można jej edytować. Aby zmienić tę wartość, musisz usunąć projekt Dialogflow z tego agenta, a następnie utworzyć nową integrację. |
dialogflowAgentId |
To pole jest wymagane. Identyfikator agenta Dialogflow. |
autoResponseStatus |
To pole jest wymagane. Jeśli |
dialogflowServiceAccountEmail |
Tylko dane wyjściowe. Konto usługi, które należy skonfigurować w projekcie Dialogflow przy użyciu ról „edytujący agenty konsoli Dialogflow” i „klient interfejsu Dialogflow API”. Jest to wymagane do zapewnienia dostępu do interfejsu Dialogflow API. |
operationInfo |
Tylko dane wyjściowe. Informacje o stanie działania integracji Dialogflow. |
AgentWebhookIntegration
Informacje o webhooku agenta Business Messages.
Zapis JSON |
---|
{ "webhookUri": string, "verificationToken": string } |
Pola | |
---|---|
webhookUri |
To pole jest wymagane. Adres URL webhooka, na który są dostarczane wiadomości. |
verificationToken |
Tylko wejście. Token weryfikacyjny. |
Metody |
|
---|---|
|
Utwórz integrację. |
|
Usuń integrację. |
|
Pobierz integrację. |
|
Wyświetl listę integracji. |
|
Zaktualizuj integrację. |