REST Resource: brands.agents.integrations

Resource: Integrasi

Informasi tentang integrasi.

Representasi 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.
}
Kolom
name

string

Hanya output. ID unik integrasi. Hanya baca. Ditentukan oleh platform.
status

enum (IntegrationStatus)

Hanya output. Status integrasi.
Kolom union integration_info. Informasi mendetail tentang integrasi. integration_info hanya ada berupa salah satu diantara berikut:
dialogflowEsIntegration

object (DialogflowEsIntegration)

Informasi tentang project Dialogflow ES terkait. https://cloud.google.com/dialogflow/es/docs
dialogflowCxIntegration

object (DialogflowCxIntegration)

Informasi tentang project Dialogflow CX terkait. https://cloud.google.com/dialogflow/cx/docs/basics

IntegrationStatus

Status integrasi.

Enum
INTEGRATION_STATUS_UNSPECIFIED Status integrasi tidak ditentukan.
ENABLED Aktif
DISABLED Nonaktif.

DialogflowEsIntegration

Informasi tentang agen Business Messages dan pengaitan project Dialogflow ES.

Representasi JSON 
{
  "dialogflowProjectId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  },
  "dialogflowKnowledgeBases": [
    {
      object (DialogflowKnowledgebase)
    }
  ]
}
Kolom
dialogflowProjectId

string

Wajib. Project ID Dialogflow.

Tidak dapat diedit. Untuk mengubah nilai ini, Anda harus menghapus project Dialogflow dari agen ini, lalu membuat integrasi baru.
autoResponseStatus

enum (AutoResponseStatus)

Wajib. Jika ENABLED, Business Messages akan otomatis mengirimkan respons Dialogflow kepada pengguna.
dialogflowServiceAccountEmail

string

Hanya output. Akun layanan yang harus dikonfigurasi dalam project Dialogflow dengan peran "Dialogflow Console Agent Editor" dan "Dialogflow API Client". Hal ini diperlukan untuk memberikan akses ke Dialogflow API.
operationInfo

object (OperationInfo)

Hanya output. Informasi tentang status pengoperasian integrasi Dialogflow.
dialogflowKnowledgeBases[]

object (DialogflowKnowledgebase)

Basis pengetahuan yang terkait dengan project Dialogflow.

Opsional

AutoResponseStatus

Status respons otomatis Dialogflow.

Enum
AUTO_RESPONSE_STATUS_UNSPECIFIED Respons otomatis tidak ditentukan.
ENABLED Respons otomatis diaktifkan.
DISABLED Respons otomatis dinonaktifkan.

OperationInfo

Informasi operasi Dialogflow.

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

string

Hanya output. Nama yang ditetapkan server (ID operasi), yang hanya bersifat unik dalam layanan yang sama yang awalnya menampilkannya.
operationType

enum (OperationType)

Hanya output. Jenis Operasi Dialogflow.
operationState

enum (OperationState)

Hanya output. Status Operasi Dialogflow.
error

object (Status)

Hanya output. Hasil error, jika ada.

OperationType

Jenis operasi Dialogflow.

Enum
OPERATION_TYPE_UNSPECIFIED Jenis tidak ditentukan.
ASSOCIATE_DIALOGFLOW Kaitkan Dialogflow.
DISSOCIATE_DIALOGFLOW Pisahkan Dialogflow.
ADD_DOCUMENT_TO_KNOWLEDGEBASE Tambahkan dokumen ke pusat informasi.
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE Hapus dokumen dari pusat informasi.

OperationState

Status operasi di Dialogflow.

Enum
OPERATION_STATE_UNSPECIFIED Status tidak ditentukan.
PROCESSING Memproses.
COMPLETED Selesai.
FAILED Gagal.

Status

Jenis Status menentukan model error logis yang cocok untuk berbagai lingkungan pemrograman, meliputi REST API dan RPC API. Jenis error ini digunakan oleh gRPC. Setiap pesan Status berisi tiga bagian data: kode error, pesan error, dan detail error.

Anda dapat mencari tahu lebih lanjut tentang model error ini dan cara penanganannya di Panduan Desain API.

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

integer

Kode status, harus berupa nilai enum dari google.rpc.Code.
message

string

Pesan error yang ditampilkan ke developer dan seharusnya dalam bahasa Inggris. Setiap pesan error yang ditampilkan kepada pengguna harus dilokalkan dan dikirim di kolom google.rpc.Status.details, atau dilokalkan oleh klien.
details[]

object

Daftar pesan yang membawa detail error. Ada seperangkat jenis pesan umum untuk digunakan API.

Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.

DialogflowKnowledgebase

Informasi pusat informasi. Pusat informasi dapat memiliki beberapa URL FAQ.

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

string

Hanya output. ID pusat informasi.

ID unik yang ditampilkan oleh layanan Dialogflow setelah pembuatan pusat informasi. Jika ID merek adalah "1234", ID agen adalah "5678", ID integrasinya adalah "9092", dan ID basis pengetahuan adalah "1111", parameter ini akan menghasilkan "brand/1234/agents/5678/integrations/9092/knowledgebases/1111".
displayName

string

Wajib. Nama tampilan pusat informasi.
documents[]

object (DialogflowDocument)

Dokumen pusat informasi.

Opsional
updateTime

string (Timestamp format)

Hanya output. Waktu saat pusat informasi dibuat atau diperbarui.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

DialogflowDocument

Dokumen basis pengetahuan. Dokumen dapat berupa URL situs atau URL ke file CSV. URL harus tersedia untuk publik. File CSV harus berisi satu atau beberapa pasangan pertanyaan/jawaban, dengan satu baris untuk setiap pasangan.

Representasi 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.
}
Kolom
name

string

ID Dokumen yang dibuat sistem.

Jika ID merek adalah "1234", ID agennya adalah "5678", ID integrasinya adalah "9092", ID basis pengetahuannya adalah "1111", dan ID dokumennya adalah "2222", parameter ini akan menghasilkan "brand/1234/agents/5678/integrations/9092/knowledgebases/1111/documents/222".
displayName

string

Wajib. Nama tampilan dokumen FAQ.
updateTime

string (Timestamp format)

Hanya output. Waktu dokumen dibuat/diperbarui.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
operationInfo

object (OperationInfo)

Hanya output. Informasi Operasi hanya diisi saat dokumen ditambahkan ke pusat informasi yang ada.
Kolom union content. Konten dokumen. content hanya ada berupa salah satu diantara berikut:
faqUrl

string

URL dokumen FAQ.
rawContent

string (bytes format)

Konten mentah dokumen.

String berenkode base64.

DialogflowCxIntegration

Informasi tentang agen Business Messages dan pengaitan project Dialogflow CX.

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

string

Wajib. Project ID Dialogflow.

Tidak dapat diedit. Untuk mengubah nilai ini, Anda harus menghapus project Dialogflow dari agen ini, lalu membuat integrasi baru.
dialogflowAgentId

string

Wajib. ID Agen Dialogflow.
autoResponseStatus

enum (AutoResponseStatus)

Wajib. Jika ENABLED, Business Messages akan otomatis mengirimkan respons Dialogflow kepada pengguna.
dialogflowServiceAccountEmail

string

Hanya output. Akun layanan yang harus dikonfigurasi dalam project Dialogflow dengan peran "Dialogflow Console Agent Editor" dan "Dialogflow API Client". Hal ini diperlukan untuk memberikan akses ke Dialogflow API.
operationInfo

object (OperationInfo)

Hanya output. Informasi tentang status pengoperasian integrasi Dialogflow.

Metode

create

 Buat integrasi.

delete

 Menghapus integrasi.

get

 Dapatkan integrasi.

list

 Mencantumkan integrasi.

patch

 Memperbarui integrasi.