แหล่งข้อมูล: การผสานรวม
ข้อมูลเกี่ยวกับการผสานรวม
การแสดง JSON |
---|
{ "name": string, "status": enum ( |
ช่อง | |
---|---|
name |
เอาต์พุตเท่านั้น ตัวระบุที่ไม่ซ้ำกันของการผสานรวม อ่านอย่างเดียว กำหนดโดยแพลตฟอร์ม |
status |
เอาต์พุตเท่านั้น สถานะการผสานรวม |
ฟิลด์การรวม integration_info ข้อมูลโดยละเอียดสำหรับการผสานรวม integration_info ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
dialogflowEsIntegration |
ข้อมูลเกี่ยวกับโปรเจ็กต์ Dialogflow ES ที่เกี่ยวข้อง https://cloud.google.com/dialogflow/es/docs |
dialogflowCxIntegration |
ข้อมูลเกี่ยวกับโปรเจ็กต์ Dialogflow CX ที่เกี่ยวข้อง https://cloud.google.com/dialogflow/cx/docs/basics |
IntegrationStatus
สถานะการผสานรวม
Enum | |
---|---|
INTEGRATION_STATUS_UNSPECIFIED |
ไม่ได้ระบุสถานะการผสานรวม |
ENABLED |
เปิดใช้แล้ว |
DISABLED |
ปิดใช้อยู่ |
DialogflowEsIntegration
ข้อมูลเกี่ยวกับตัวแทน Business Messages และการเชื่อมโยงโปรเจ็กต์ Dialogflow ES
การแสดง JSON |
---|
{ "dialogflowProjectId": string, "autoResponseStatus": enum ( |
ช่อง | |
---|---|
dialogflowProjectId |
ต้องระบุ รหัสโปรเจ็กต์ Dialogflow แก้ไขไม่ได้ หากต้องการเปลี่ยนค่านี้ คุณต้องลบโปรเจ็กต์ Dialogflow จาก Agent นี้ จากนั้นจึงสร้างการผสานรวมใหม่ |
autoResponseStatus |
ต้องระบุ หากเป็น |
dialogflowServiceAccountEmail |
เอาต์พุตเท่านั้น บัญชีบริการที่ต้องกำหนดค่าในโปรเจ็กต์ Dialogflow โดยมีบทบาท "ผู้แก้ไข Agent ของ Dialogflow Console" และ "ไคลเอ็นต์ Dialogflow API" ขั้นตอนนี้จำเป็นสำหรับการให้สิทธิ์เข้าถึง Dialogflow API |
operationInfo |
เอาต์พุตเท่านั้น ข้อมูลเกี่ยวกับสถานะการทำงานของการผสานรวม Dialogflow |
dialogflowKnowledgeBases[] |
ฐานความรู้ที่เกี่ยวข้องกับโครงการ Dialogflow ไม่บังคับ |
AutoResponseStatus
สถานะการตอบกลับอัตโนมัติของ Dialogflow
Enum | |
---|---|
AUTO_RESPONSE_STATUS_UNSPECIFIED |
ไม่ได้ระบุการตอบกลับอัตโนมัติ |
ENABLED |
เปิดใช้การตอบกลับอัตโนมัติแล้ว |
DISABLED |
การตอบกลับอัตโนมัติถูกปิดใช้งาน |
OperationInfo
ข้อมูลการดำเนินการ Dialogflow
การแสดง JSON |
---|
{ "operationName": string, "operationType": enum ( |
ช่อง | |
---|---|
operationName |
เอาต์พุตเท่านั้น ชื่อที่เซิร์ฟเวอร์กำหนด (รหัสการดำเนินการ) ซึ่งจะไม่ซ้ำกันภายในบริการเดียวกันที่ส่งชื่อกลับมาในตอนแรก |
operationType |
เอาต์พุตเท่านั้น ประเภทการดำเนินการ Dialogflow |
operationState |
เอาต์พุตเท่านั้น สถานะการดำเนินการ Dialogflow |
error |
เอาต์พุตเท่านั้น ผลลัพธ์ที่ผิดพลาด (หากมี) |
OperationType
ประเภทการดำเนินการ Dialogflow
Enum | |
---|---|
OPERATION_TYPE_UNSPECIFIED |
ไม่ระบุประเภท |
ASSOCIATE_DIALOGFLOW |
เชื่อมโยง Dialogflow |
DISSOCIATE_DIALOGFLOW |
ยกเลิกการเชื่อมโยง Dialogflow |
ADD_DOCUMENT_TO_KNOWLEDGEBASE |
เพิ่มเอกสารไปยังฐานความรู้ |
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE |
ลบเอกสารออกจากฐานความรู้ |
OperationState
สถานะการดำเนินการใน Dialogflow
Enum | |
---|---|
OPERATION_STATE_UNSPECIFIED |
สถานะที่ไม่ได้ระบุ |
PROCESSING |
กำลังประมวลผล |
COMPLETED |
เสร็จสมบูรณ์ |
FAILED |
ไม่สำเร็จ |
สถานะ
ประเภท Status
กำหนดโมเดลข้อผิดพลาดเชิงตรรกะที่เหมาะสำหรับสภาพแวดล้อมการเขียนโปรแกรมที่แตกต่างกัน ซึ่งรวมถึง REST API และ RPC API ใช้โดย gRPC ข้อความ Status
แต่ละข้อความจะมีข้อมูล 3 อย่าง ได้แก่ รหัสข้อผิดพลาด ข้อความแสดงข้อผิดพลาด และรายละเอียดข้อผิดพลาด
ดูข้อมูลเพิ่มเติมเกี่ยวกับรูปแบบข้อผิดพลาดนี้และวิธีทำงานกับรูปแบบดังกล่าวได้ในคู่มือการออกแบบ API
การแสดง JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
ช่อง | |
---|---|
code |
รหัสสถานะ ซึ่งควรเป็นค่า enum ของ |
message |
ข้อความแสดงข้อผิดพลาดที่ส่งถึงนักพัฒนาซอฟต์แวร์ ซึ่งควรเป็นภาษาอังกฤษ ข้อความแสดงข้อผิดพลาดที่แสดงต่อผู้ใช้ควรแปลและส่งในช่อง |
details[] |
รายการข้อความที่มีรายละเอียดข้อผิดพลาด มีชุดประเภทข้อความที่ใช้กันโดยทั่วไปสำหรับ API ออบเจ็กต์ที่มีช่องประเภทที่กำหนดเอง ช่องเพิ่มเติม |
DialogflowKnowledgebase
ข้อมูลฐานความรู้ ฐานความรู้หนึ่งสามารถมี URL คำถามที่พบบ่อยได้หลายรายการ
การแสดง JSON |
---|
{
"name": string,
"displayName": string,
"documents": [
{
object ( |
ช่อง | |
---|---|
name |
เอาต์พุตเท่านั้น รหัสฐานความรู้ ตัวระบุที่ไม่ซ้ำกันที่บริการ Dialogflow แสดงผลหลังจากสร้างฐานความรู้ หากตัวระบุแบรนด์คือ "1234" ตัวระบุตัวแทนคือ "5678" ตัวระบุการผสานรวมจะเป็น "9092" และตัวระบุฐานความรู้คือ "1111" พารามิเตอร์นี้จะเปลี่ยนเป็น "brands/1234/agents/5678/integrations/9092/knowledgebases/1111" |
displayName |
ต้องระบุ ชื่อที่แสดงของฐานความรู้ |
documents[] |
เอกสารฐานความรู้ ไม่บังคับ |
updateTime |
เอาต์พุตเท่านั้น เวลาที่สร้างหรืออัปเดตฐานความรู้ การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: |
DialogflowDocument
เอกสารฐานความรู้ เอกสารอาจเป็น URL ของเว็บไซต์หรือ URL ไปยังไฟล์ CSV ก็ได้ URL ต้องพร้อมใช้งานแบบสาธารณะ ไฟล์ CSV ต้องมีคู่คำถาม/คำตอบอย่างน้อย 1 คู่ โดยแต่ละคู่มี 1 แถว
การแสดง JSON |
---|
{ "name": string, "displayName": string, "updateTime": string, "operationInfo": { object ( |
ช่อง | |
---|---|
name |
รหัสเอกสารที่ระบบสร้าง หากตัวระบุแบรนด์คือ "1234" ตัวระบุ Agent คือ "5678" ตัวระบุการผสานรวมคือ "9092" ตัวระบุฐานความรู้คือ "1111" และตัวระบุเอกสารคือ "2222" พารามิเตอร์นี้จะแก้ไขเป็น "brands/1234/agents/5678/integrations/9092/knowledge2bases/1111/knowledge2bases/1111" |
displayName |
ต้องระบุ ชื่อที่แสดงของเอกสารคำถามที่พบบ่อย |
updateTime |
เอาต์พุตเท่านั้น เวลาที่สร้าง/อัปเดตเอกสาร การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: |
operationInfo |
เอาต์พุตเท่านั้น ระบบจะป้อนข้อมูลการดำเนินการก็ต่อเมื่อเพิ่มเอกสารในฐานความรู้ที่มีอยู่เท่านั้น |
ฟิลด์การรวม content เนื้อหาของเอกสาร content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
faqUrl |
URL ของเอกสารคำถามที่พบบ่อย |
rawContent |
เนื้อหาดิบของเอกสาร สตริงที่เข้ารหัสแบบ Base64 |
DialogflowCxIntegration
ข้อมูลเกี่ยวกับตัวแทน Business Messages และการเชื่อมโยงโปรเจ็กต์ Dialogflow CX
การแสดง JSON |
---|
{ "dialogflowProjectId": string, "dialogflowAgentId": string, "autoResponseStatus": enum ( |
ช่อง | |
---|---|
dialogflowProjectId |
ต้องระบุ รหัสโปรเจ็กต์ Dialogflow แก้ไขไม่ได้ หากต้องการเปลี่ยนค่านี้ คุณต้องลบโปรเจ็กต์ Dialogflow จาก Agent นี้ จากนั้นจึงสร้างการผสานรวมใหม่ |
dialogflowAgentId |
ต้องระบุ รหัสตัวแทน Dialogflow |
autoResponseStatus |
ต้องระบุ หากเป็น |
dialogflowServiceAccountEmail |
เอาต์พุตเท่านั้น บัญชีบริการที่ต้องกำหนดค่าในโปรเจ็กต์ Dialogflow โดยมีบทบาท "ผู้แก้ไข Agent ของ Dialogflow Console" และ "ไคลเอ็นต์ Dialogflow API" ขั้นตอนนี้จำเป็นสำหรับการให้สิทธิ์เข้าถึง Dialogflow API |
operationInfo |
เอาต์พุตเท่านั้น ข้อมูลเกี่ยวกับสถานะการทำงานของการผสานรวม Dialogflow |
วิธีการ |
|
---|---|
|
สร้างการผสานรวม |
|
ลบการผสานรวม |
|
รับการผสานรวม |
|
แสดงรายการการผสานรวม |
|
อัปเดตการผสานรวม |