Tài nguyên: Tích hợp
Thông tin về việc tích hợp.
Biểu diễn dưới dạng JSON |
---|
{ "name": string, "status": enum ( |
Trường | |
---|---|
name |
Chỉ có đầu ra. Giá trị nhận dạng duy nhất của chế độ tích hợp. Chỉ có thể đọc. Do nền tảng xác định. |
status |
Chỉ có đầu ra. Trạng thái tích hợp. |
Trường kết hợp integration_info . Thông tin chi tiết về việc tích hợp. integration_info chỉ có thể là một trong những trạng thái sau đây: |
|
dialogflowEsIntegration |
Thông tin về một dự án Dialogflow ES được liên kết. https://cloud.google.com/dialogflow/es/docs |
dialogflowCxIntegration |
Thông tin về một dự án Dialogflow CX được liên kết. https://cloud.google.com/dialogflow/cx/docs/basics |
IntegrationStatus
Các trạng thái tích hợp.
Enum | |
---|---|
INTEGRATION_STATUS_UNSPECIFIED |
Bạn chưa chỉ định trạng thái tích hợp. |
ENABLED |
Đã bật. |
DISABLED |
Đang tắt. |
DialogflowEsIntegration
Thông tin về nhân viên hỗ trợ Business Messages và dự án Dialogflow ES.
Biểu diễn dưới dạng JSON |
---|
{ "dialogflowProjectId": string, "autoResponseStatus": enum ( |
Trường | |
---|---|
dialogflowProjectId |
Bắt buộc. Mã dự án Dialogflow. Không thể chỉnh sửa. Để thay đổi giá trị này, bạn phải xoá dự án Dialogflow khỏi nhân viên hỗ trợ này, sau đó tạo một mục tích hợp mới. |
autoResponseStatus |
Bắt buộc. Nếu giá trị trả về là |
dialogflowServiceAccountEmail |
Chỉ có đầu ra. Bạn phải định cấu hình tài khoản dịch vụ trong dự án Dialogflow bằng "Dialogflow Console Agent Editor" và "Dialogflow API Client" vai trò. Bạn cần làm việc này để cấp quyền truy cập vào API Dialogflow. |
operationInfo |
Chỉ có đầu ra. Thông tin về trạng thái hoạt động của công cụ tích hợp Dialogflow. |
dialogflowKnowledgeBases[] |
Cơ sở kiến thức liên quan đến dự án Dialogflow. Không bắt buộc |
AutoResponseStatus
Trạng thái phản hồi tự động của Dialogflow.
Enum | |
---|---|
AUTO_RESPONSE_STATUS_UNSPECIFIED |
Chưa chỉ định chế độ tự động trả lời. |
ENABLED |
Tính năng tự động trả lời được bật. |
DISABLED |
Tính năng tự động trả lời đã bị tắt. |
OperationInfo
Thông tin về hoạt động của Dialogflow.
Biểu diễn dưới dạng JSON |
---|
{ "operationName": string, "operationType": enum ( |
Trường | |
---|---|
operationName |
Chỉ có đầu ra. Tên do máy chủ chỉ định (mã hoạt động). Tên này chỉ là duy nhất trong cùng một dịch vụ trả về giá trị ban đầu. |
operationType |
Chỉ có đầu ra. Loại hoạt động của Dialogflow. |
operationState |
Chỉ có đầu ra. Trạng thái hoạt động của Dialogflow. |
error |
Chỉ có đầu ra. Kết quả lỗi, nếu có. |
OperationType
Loại thao tác Dialogflow.
Enum | |
---|---|
OPERATION_TYPE_UNSPECIFIED |
Loại không xác định. |
ASSOCIATE_DIALOGFLOW |
Liên kết Dialogflow. |
DISSOCIATE_DIALOGFLOW |
Huỷ liên kết Dialogflow. |
ADD_DOCUMENT_TO_KNOWLEDGEBASE |
Thêm tài liệu vào cơ sở kiến thức. |
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE |
Xoá tài liệu khỏi cơ sở kiến thức. |
OperationState
Các trạng thái của hoạt động trong Dialogflow.
Enum | |
---|---|
OPERATION_STATE_UNSPECIFIED |
Trạng thái không xác định. |
PROCESSING |
Đang xử lý. |
COMPLETED |
Đã hoàn tất. |
FAILED |
Không thành công. |
Trạng thái
Loại Status
xác định mô hình lỗi logic phù hợp với nhiều môi trường lập trình, bao gồm cả API REST và API RPC. Hàm này được gRPC sử dụng. Mỗi thông báo Status
chứa 3 phần dữ liệu: mã lỗi, thông báo lỗi và thông tin chi tiết về lỗi.
Bạn có thể tìm hiểu thêm về mô hình lỗi này cũng như cách xử lý trong Hướng dẫn thiết kế API.
Biểu diễn dưới dạng JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Trường | |
---|---|
code |
Mã trạng thái, phải là một giá trị enum của |
message |
Thông báo lỗi dành cho nhà phát triển, phải bằng tiếng Anh. Mọi thông báo lỗi dành cho người dùng đều phải được bản địa hoá và gửi trong trường |
details[] |
Danh sách các thông báo chứa thông tin chi tiết về lỗi. Có một nhóm loại thông báo phổ biến để API sử dụng. Một đối tượng có chứa các trường thuộc loại tuỳ ý. Trường bổ sung |
DialogflowKnowledgebase
Thông tin về cơ sở kiến thức. Một cơ sở kiến thức có thể có nhiều URL câu hỏi thường gặp.
Biểu diễn dưới dạng JSON |
---|
{
"name": string,
"displayName": string,
"documents": [
{
object ( |
Trường | |
---|---|
name |
Chỉ có đầu ra. Mã cơ sở kiến thức. Giá trị nhận dạng duy nhất do dịch vụ Dialogflow trả về sau khi tạo cơ sở kiến thức. Nếu giá trị nhận dạng thương hiệu là "1234", giá trị nhận dạng tác nhân là "5678", giá trị nhận dạng tích hợp là "9092" và giá trị nhận dạng cơ sở kiến thức là "1111", tham số này được phân giải thành "brands/1234/agents/5678/integrations/9092/understandbases/1111". |
displayName |
Bắt buộc. Tên hiển thị của cơ sở kiến thức. |
documents[] |
Tài liệu cơ sở kiến thức. Không bắt buộc |
updateTime |
Chỉ có đầu ra. Thời gian mà cơ sở kiến thức được tạo hoặc cập nhật. Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: |
DialogflowDocument
Tài liệu cơ sở kiến thức. Một tài liệu có thể là URL của trang web hoặc URL dẫn đến tệp CSV. URL phải được cung cấp công khai. Tệp CSV phải chứa một hoặc nhiều cặp câu hỏi/câu trả lời, với một hàng cho mỗi cặp.
Biểu diễn dưới dạng JSON |
---|
{ "name": string, "displayName": string, "updateTime": string, "operationInfo": { object ( |
Trường | |
---|---|
name |
Mã tài liệu do hệ thống tạo. Nếu mã nhận dạng thương hiệu là "1234", mã nhận dạng tác nhân là "5678", mã nhận dạng tích hợp là "9092", giá trị nhận dạng cơ sở kiến thức là "1111" và mã nhận dạng tài liệu là "2222", tham số này chuyển thành "brands/1234/agents/5678/integrations/9092/understands/1111/documents/222". |
displayName |
Bắt buộc. Tên hiển thị của tài liệu Câu hỏi thường gặp. |
updateTime |
Chỉ có đầu ra. Thời gian tạo/cập nhật tài liệu. Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: |
operationInfo |
Chỉ có đầu ra. Thông tin vận hành chỉ được điền sẵn khi một tài liệu được thêm vào cơ sở kiến thức hiện có. |
Trường kết hợp content . Nội dung của giấy tờ. content chỉ có thể là một trong những trạng thái sau đây: |
|
faqUrl |
URL của tài liệu Câu hỏi thường gặp. |
rawContent |
Nội dung thô của tài liệu. Chuỗi được mã hoá base64. |
DialogflowCxIntegration
Thông tin về nhân viên hỗ trợ Business Messages và dự án Dialogflow CX.
Biểu diễn dưới dạng JSON |
---|
{ "dialogflowProjectId": string, "dialogflowAgentId": string, "autoResponseStatus": enum ( |
Trường | |
---|---|
dialogflowProjectId |
Bắt buộc. Mã dự án Dialogflow. Không thể chỉnh sửa. Để thay đổi giá trị này, bạn phải xoá dự án Dialogflow khỏi nhân viên hỗ trợ này, sau đó tạo một mục tích hợp mới. |
dialogflowAgentId |
Bắt buộc. Mã nhân viên hỗ trợ Dialogflow. |
autoResponseStatus |
Bắt buộc. Nếu giá trị trả về là |
dialogflowServiceAccountEmail |
Chỉ có đầu ra. Bạn phải định cấu hình tài khoản dịch vụ trong dự án Dialogflow bằng "Dialogflow Console Agent Editor" và "Dialogflow API Client" vai trò. Bạn cần làm việc này để cấp quyền truy cập vào API Dialogflow. |
operationInfo |
Chỉ có đầu ra. Thông tin về trạng thái hoạt động của công cụ tích hợp Dialogflow. |
Phương thức |
|
---|---|
|
Tạo một liên kết tích hợp. |
|
Xoá chế độ tích hợp. |
|
Tích hợp. |
|
Liệt kê các mục tích hợp. |
|
Cập nhật một chế độ tích hợp. |