Referensi: Integrasi
Informasi tentang integrasi.
Representasi JSON |
---|
{ "name": string, "status": enum ( |
Kolom | |
---|---|
name |
Hanya output. ID unik integrasi. Hanya baca. Ditentukan oleh platform. |
status |
Hanya output. Status integrasi. |
Kolom union integration_info . Informasi mendetail tentang integrasi. integration_info hanya ada berupa salah satu diantara berikut: |
|
dialogflowEsIntegration |
Informasi tentang project Dialogflow ES terkait. https://cloud.google.com/dialogflow/es/docs |
dialogflowCxIntegration |
Informasi tentang project Dialogflow CX terkait. https://cloud.google.com/dialogflow/cx/docs/basics |
agentWebhookIntegration |
Informasi tentang webhook untuk agen. Jika webhook dikonfigurasi di tingkat agen, webhook akan menggantikan webhook di tingkat partner. |
IntegrationStatus
Status integrasi.
Enum | |
---|---|
INTEGRATION_STATUS_UNSPECIFIED |
Status integrasi belum ditetapkan. |
ENABLED |
Aktif |
DISABLED |
Nonaktif. |
DialogflowEsIntegration
Informasi tentang agen Business Messages dan pengaitan project Dialogflow ES.
Representasi JSON |
---|
{ "dialogflowProjectId": string, "autoResponseStatus": enum ( |
Kolom | |
---|---|
dialogflowProjectId |
Wajib. Project ID Dialogflow. Tidak dapat diedit. Untuk mengubah nilai ini, Anda harus menghapus project Dialogflow dari agen ini, lalu membuat integrasi baru. |
autoResponseStatus |
Wajib. Jika |
dialogflowServiceAccountEmail |
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 |
Hanya output. Informasi tentang status pengoperasian integrasi Dialogflow. |
dialogflowKnowledgeBases[] |
Basis informasi 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 ( |
Kolom | |
---|---|
operationName |
Hanya output. Nama yang ditetapkan server (ID operasi), yang hanya unik dalam layanan yang sama yang awalnya menampilkannya. |
operationType |
Hanya output. Jenis Operasi Dialogflow. |
operationState |
Hanya output. Status Operasi Dialogflow. |
error |
Hanya output. Hasil error, jika ada. |
OperationType
Jenis operasi Dialogflow.
Enum | |
---|---|
OPERATION_TYPE_UNSPECIFIED |
Jenis tidak ditentukan. |
ASSOCIATE_DIALOGFLOW |
Mengaitkan 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 |
Kode status, harus berupa nilai enum dari |
message |
Pesan error yang ditampilkan ke developer dan seharusnya dalam bahasa Inggris. Setiap pesan error yang ditampilkan kepada pengguna harus dilokalkan dan dikirim di kolom |
details[] |
Daftar pesan yang membawa detail error. Ada seperangkat jenis pesan umum untuk digunakan API. Objek yang berisi kolom tipe arbitrer. Kolom tambahan |
DialogflowKnowledgebase
Informasi pusat informasi. Pusat informasi dapat memiliki beberapa URL FAQ.
Representasi JSON |
---|
{
"name": string,
"displayName": string,
"documents": [
{
object ( |
Kolom | |
---|---|
name |
Hanya output. ID basis pengetahuan. ID unik yang ditampilkan oleh layanan Dialogflow setelah pembuatan pusat informasi. Jika ID brand adalah "1234", ID agen adalah "5678", ID integrasinya adalah "9092", dan ID pusat informasinya adalah "1111", parameter ini akan menghasilkan "brands/1234/agents/5678/integrations/9092/knowledgebases/1111". |
displayName |
Wajib. Nama tampilan basis pengetahuan. |
documents[] |
Dokumen pusat informasi. Opsional |
updateTime |
Hanya output. Waktu saat basis pengetahuan dibuat atau diperbarui. Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: |
DialogflowDocument
Dokumen dasar 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 ( |
Kolom | |
---|---|
name |
ID Dokumen yang dihasilkan sistem. Jika ID brand adalah "1234", ID agennya adalah "5678", ID integrasinya adalah "9092", ID pusat informasinya adalah "1111", dan ID dokumennya adalah "2222", parameter ini akan menghasilkan "brands/1234/agents/5678/integrations/9092/knowledgebases/1111/documents/2222". |
displayName |
Wajib. Nama tampilan dokumen FAQ. |
updateTime |
Hanya output. Waktu saat dokumen dibuat/diperbarui. Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: |
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 |
URL dokumen FAQ. |
rawContent |
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 ( |
Kolom | |
---|---|
dialogflowProjectId |
Wajib. Project ID Dialogflow. Tidak dapat diedit. Untuk mengubah nilai ini, Anda harus menghapus project Dialogflow dari agen ini, lalu membuat integrasi baru. |
dialogflowAgentId |
Wajib. ID Agen Dialogflow. |
autoResponseStatus |
Wajib. Jika |
dialogflowServiceAccountEmail |
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 |
Hanya output. Informasi tentang status pengoperasian integrasi Dialogflow. |
AgentWebhookIntegration
Informasi tentang webhook untuk agen Business Messages.
Representasi JSON |
---|
{ "webhookUri": string, "verificationToken": string } |
Kolom | |
---|---|
webhookUri |
Wajib. URL webhook tempat pesan dikirim. |
verificationToken |
Hanya input. Token verifikasi. |
Metode |
|
---|---|
|
Buat integrasi. |
|
Menghapus integrasi. |
|
Dapatkan integrasi. |
|
Mencantumkan integrasi. |
|
Memperbarui integrasi. |