REST Resource: brands.agents.integrations

Zasób: Integration

Informacje o integracji.

Zapis JSON 
{
  "name": string,
  "status": enum (IntegrationStatus),

  // Union field integration_info can be only one of the following:
  "dialogflowEsIntegration": {
    object (DialogflowEsIntegration)
  },
  "dialogflowCxIntegration": {
    object (DialogflowCxIntegration)
  }
  // End of list of possible types for union field integration_info.
}
Pola
name

string

Tylko dane wyjściowe. Unikalny identyfikator integracji. Tylko do odczytu. Zdefiniowane przez platformę.
status

enum (IntegrationStatus)

Tylko dane wyjściowe. Stan integracji.
Pole sumy integration_info. Szczegółowe informacje dotyczące integracji. integration_info może mieć tylko jedną z tych wartości:
dialogflowEsIntegration

object (DialogflowEsIntegration)

Informacje o powiązanym projekcie Dialogflow ES. https://cloud.google.com/dialogflow/es/docs
dialogflowCxIntegration

object (DialogflowCxIntegration)

Informacje o powiązanym projekcie Dialogflow CX. https://cloud.google.com/dialogflow/cx/docs/basics

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 (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  },
  "dialogflowKnowledgeBases": [
    {
      object (DialogflowKnowledgebase)
    }
  ]
}
Pola
dialogflowProjectId

string

To pole jest wymagane. Identyfikator projektu Dialogflow.

Nie można go edytować. Aby zmienić tę wartość, musisz usunąć projekt Dialogflow z tego agenta, a następnie utworzyć nową integrację.
autoResponseStatus

enum (AutoResponseStatus)

To pole jest wymagane. Jeśli ma wartość ENABLED, Business Messages automatycznie wysyła użytkownikom odpowiedzi Dialogflow.
dialogflowServiceAccountEmail

string

Tylko dane wyjściowe. Konto usługi, które należy skonfigurować w projekcie Dialogflow z użyciem ról „Edytujący agenty konsoli Dialogflow” i „Klient interfejsu Dialogflow API”. Jest to wymagane do zapewnienia dostępu do interfejsu Dialogflow API.
operationInfo

object (OperationInfo)

Tylko dane wyjściowe. Informacje o stanie działania integracji Dialogflow.
dialogflowKnowledgeBases[]

object (DialogflowKnowledgebase)

Bazy wiedzy powiązane z projektem Dialogflow.

Opcjonalnie

AutoResponseStatus

Stan automatycznej odpowiedzi Dialogflow.

Wartości w polu enum
AUTO_RESPONSE_STATUS_UNSPECIFIED Automatyczna odpowiedź jest nieokreślona.
ENABLED Automatyczna odpowiedź jest włączona.
DISABLED Automatyczna odpowiedź jest wyłączona.

OperationInfo

Informacje o operacji Dialogflow.

Zapis JSON 
{
  "operationName": string,
  "operationType": enum (OperationType),
  "operationState": enum (OperationState),
  "error": {
    object (Status)
  }
}
Pola
operationName

string

Tylko dane wyjściowe. Nazwa przypisana przez serwer (identyfikator operacji), która jest niepowtarzalna w tej samej usłudze, która została pierwotnie zwrócona.
operationType

enum (OperationType)

Tylko dane wyjściowe. Typ operacji Dialogflow.
operationState

enum (OperationState)

Tylko dane wyjściowe. Stan operacji Dialogflow.
error

object (Status)

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ązania Dialogflow.
ADD_DOCUMENT_TO_KNOWLEDGEBASE Dodaj dokument do bazy wiedzy.
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE Usuń dokument 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 błędu logicznego, który jest odpowiedni dla różnych środowisk programowania, w tym interfejsów API REST i interfejsów API 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 dokumencie API Design Guide (w języku angielskim).

Zapis JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Pola
code

integer

Kod stanu, który powinien być wartością wyliczeniową google.rpc.Code.
message

string

Komunikat o błędzie widoczny dla dewelopera w języku angielskim. Każdy komunikat o błędzie widoczny dla użytkownika powinien być zlokalizowany i wysyłany w polu google.rpc.Status.details lub zlokalizowany przez klienta.
details[]

object

Lista komunikatów zawierających szczegółowe informacje o błędzie. Istnieje wspólny zestaw typów wiadomości używanych przez interfejsy API.

Obiekt zawierający pola dowolnego typu. Dodatkowe pole "@type" zawiera identyfikator URI identyfikujący typ. Przykład: { "id": 1234, "@type": "types.example.com/standard/id" }.

DialogflowKnowledgebase

Informacje z bazy wiedzy. Baza wiedzy może mieć wiele adresów URL z najczęstszymi pytaniami.

Zapis JSON 
{
  "name": string,
  "displayName": string,
  "documents": [
    {
      object (DialogflowDocument)
    }
  ],
  "updateTime": string
}
Pola
name

string

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 – „1111”, parametr przyjmuje wartość „brands/1234/agents/5678/integrations/9092/knowledgebases/1111”.
displayName

string

To pole jest wymagane. Wyświetlana nazwa bazy wiedzy.
documents[]

object (DialogflowDocument)

Dokumenty bazy wiedzy.

Opcjonalnie
updateTime

string (Timestamp format)

Tylko dane wyjściowe. Czas utworzenia lub zaktualizowania bazy wiedzy.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

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ę pytanie/odpowiedź, po jednym wierszu na każdą parę.

Zapis JSON 
{
  "name": string,
  "displayName": string,
  "updateTime": string,
  "operationInfo": {
    object (OperationInfo)
  },

  // Union field content can be only one of the following:
  "faqUrl": string,
  "rawContent": string
  // End of list of possible types for union field content.
}
Pola
name

string

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 przyjmuje wartość „brands/1234/agents/5678/integrations/9092/knowledgebase/documents/1”.
displayName

string

To pole jest wymagane. Wyświetlana nazwa dokumentu z najczęstszymi pytaniami.
updateTime

string (Timestamp format)

Tylko dane wyjściowe. Godzina utworzenia/aktualizacji dokumentu.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
operationInfo

object (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 mieć tylko jedną z tych wartości:
faqUrl

string

Adres URL dokumentu z najczęstszymi pytaniami.
rawContent

string (bytes format)

Sama zawartość dokumentu.

Ciąg zakodowany w formacie base64.

DialogflowCxIntegration

Informacje o agencie Business Messages i powiązaniu projektu Dialogflow CX.

Zapis JSON 
{
  "dialogflowProjectId": string,
  "dialogflowAgentId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  }
}
Pola
dialogflowProjectId

string

To pole jest wymagane. Identyfikator projektu Dialogflow.

Nie można go edytować. Aby zmienić tę wartość, musisz usunąć projekt Dialogflow z tego agenta, a następnie utworzyć nową integrację.
dialogflowAgentId

string

To pole jest wymagane. Identyfikator agenta Dialogflow.
autoResponseStatus

enum (AutoResponseStatus)

To pole jest wymagane. Jeśli ma wartość ENABLED, Business Messages automatycznie wysyła użytkownikom odpowiedzi Dialogflow.
dialogflowServiceAccountEmail

string

Tylko dane wyjściowe. Konto usługi, które należy skonfigurować w projekcie Dialogflow z użyciem ról „Edytujący agenty konsoli Dialogflow” i „Klient interfejsu Dialogflow API”. Jest to wymagane do zapewnienia dostępu do interfejsu Dialogflow API.
operationInfo

object (OperationInfo)

Tylko dane wyjściowe. Informacje o stanie działania integracji Dialogflow.

Metody

create

 Utwórz integrację.

delete

 Usuń integrację.

get

 Pobierz integrację.

list

 Wyświetl listę integracji.

patch

 Zaktualizuj integrację.