REST Resource: brands.agents.integrations

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 (IntegrationStatus),

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

string

Chỉ có đầu ra. Giá trị nhận dạng duy nhất của liên kết tích hợp. Chỉ đọc. Do nền tảng xác định.
status

enum (IntegrationStatus)

Chỉ có đầu ra. Trạng thái tích hợp.
Trường 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:
dialogflowEsIntegration

object (DialogflowEsIntegration)

Thông tin về một dự án Dialogflow ES được liên kết. https://cloud.google.com/dialogflow/es/docs
dialogflowCxIntegration

object (DialogflowCxIntegration)

Thông tin về một dự án Dialogflow CX được liên kết. https://cloud.google.com/dialogflow/cx/docs/basics
agentWebhookIntegration

object (AgentWebhookIntegration)

Thông tin về webhook cho nhân viên hỗ trợ. Nếu bạn thiết lập một webhook ở cấp nhân viên hỗ trợ, webhook này sẽ ghi đè webhook ở cấp đối tác.

IntegrationStatus

Trạng thái tích hợp.

Enum
INTEGRATION_STATUS_UNSPECIFIED Chưa chỉ định trạng thái tích hợp.
ENABLED Đã bật.
DISABLED Đang tắt.

DialogflowEsIntegration

Thông tin về một nhân viên hỗ trợ Business Messages và mối liên kết với dự án Dialogflow ES.

Biểu diễn dưới dạng JSON 
{
  "dialogflowProjectId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  },
  "dialogflowKnowledgeBases": [
    {
      object (DialogflowKnowledgebase)
    }
  ]
}
Trường
dialogflowProjectId

string

Bắt buộc. Mã dự án Dialogflow.

Không chỉnh sửa được. Để 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 yêu cầu tích hợp mới.
autoResponseStatus

enum (AutoResponseStatus)

Bắt buộc. Nếu ENABLED, Business Messages sẽ tự động gửi phản hồi Dialogflow cho người dùng.
dialogflowServiceAccountEmail

string

Chỉ có đầu ra. Tài khoản dịch vụ phải được định cấu hình trong dự án Dialogflow với các vai trò "Trình chỉnh sửa tác nhân bảng điều khiển hộp thoại" và "Ứng dụng API Dialogflow". Đây là yêu cầu bắt buộc để cấp quyền truy cập vào API Dialogflow.
operationInfo

object (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[]

object (DialogflowKnowledgebase)

Cơ sở kiến thức liên quan đến dự án Dialogflow.

Không bắt buộc

AutoResponseStatus

Trạng thái trả lời tự động của Dialogflow.

Enum
AUTO_RESPONSE_STATUS_UNSPECIFIED Chưa chỉ định thư trả lời tự động.
ENABLED Tính năng tự động trả lời đang 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 (OperationType),
  "operationState": enum (OperationState),
  "error": {
    object (Status)
  }
}
Trường
operationName

string

Chỉ có đầu ra. Tên do máy chủ chỉ định (mã hoạt động), là tên duy nhất trong cùng một dịch vụ ban đầu trả về mã đó.
operationType

enum (OperationType)

Chỉ có đầu ra. Loại hoạt động của Dialogflow.
operationState

enum (OperationState)

Chỉ có đầu ra. Trạng thái hoạt động của Dialogflow.
error

object (Status)

Chỉ có đầu ra. Kết quả lỗi, nếu có.

OperationType

Các 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 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

Trạng thái hoạt động trong Dialogflow.

Enum
OPERATION_STATE_UNSPECIFIED Trạng thái chưa 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. 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à chi tiết lỗi.

Bạn có thể tìm hiểu thêm về mô hình lỗi này và cách xử lý lỗi 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

integer

Mã trạng thái phải là một giá trị enum của google.rpc.Code.
message

string

Một 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 phải được bản địa hoá và gửi trong trường google.rpc.Status.details hoặc được ứng dụng bản địa hoá.
details[]

object

Danh sách các thông báo cho biết thông tin chi tiết về lỗi. Có một nhóm các loại thông báo phổ biến để API sử dụng.

Đối tượng chứa các trường thuộc kiểu tuỳ ý. Trường "@type" bổ sung chứa URI xác định loại. Ví dụ: { "id": 1234, "@type": "types.example.com/standard/id" }.

DialogflowKnowledgebase

Thông tin cơ sở kiến thức. 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 (DialogflowDocument)
    }
  ],
  "updateTime": string
}
Trường
name

string

Chỉ có đầu ra. Mã cơ sở kiến thức.

Mã 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 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" và mã nhận dạng cơ sở kiến thức là "1111", thì tham số này sẽ được phân giải thành "brands/1234/agents/5678/integrations/9092/Xem cơ sở/1111".
displayName

string

Bắt buộc. Tên hiển thị của cơ sở kiến thức.
documents[]

object (DialogflowDocument)

Tài liệu cơ sở kiến thức.

Không bắt buộc
updateTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian tạo hoặc cập nhật cơ sở kiến thức.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".

DialogflowDocument

Tài liệu cơ sở kiến thức. Tài liệu có thể là URL của trang web hoặc URL dẫn đến tệp CSV. Các URL phải ở trạng thái 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 (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.
}
Trường
name

string

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", mã nhận dạng cơ sở kiến thức là "1111" và mã nhận dạng tài liệu là "2222", thì tham số này sẽ được phân giải thành "brands/1234/agents/5678/integrations/9092/Xem cơ sở/1111/documents/222".
displayName

string

Bắt buộc. Tên hiển thị của tài liệu Câu hỏi thường gặp.
updateTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian tạo/cập nhật tài liệu.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
operationInfo

object (OperationInfo)

Chỉ có đầu ra. Thông tin hoạt động chỉ được điền khi tài liệu được thêm vào cơ sở kiến thức hiện có.
Trường hợp content. Nội dung của tài liệu. content chỉ có thể là một trong những trạng thái sau:
faqUrl

string

URL của một tài liệu Câu hỏi thường gặp.
rawContent

string (bytes format)

Nội dung thô của tài liệu.

Một chuỗi được mã hoá base64.

DialogflowCxIntegration

Thông tin về một nhân viên hỗ trợ Business Messages và mối liên kết với dự án Dialogflow CX.

Biểu diễn dưới dạng JSON 
{
  "dialogflowProjectId": string,
  "dialogflowAgentId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  }
}
Trường
dialogflowProjectId

string

Bắt buộc. Mã dự án Dialogflow.

Không chỉnh sửa được. Để 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 yêu cầu tích hợp mới.
dialogflowAgentId

string

Bắt buộc. Mã nhân viên hỗ trợ Dialogflow.
autoResponseStatus

enum (AutoResponseStatus)

Bắt buộc. Nếu ENABLED, Business Messages sẽ tự động gửi phản hồi Dialogflow cho người dùng.
dialogflowServiceAccountEmail

string

Chỉ có đầu ra. Tài khoản dịch vụ phải được định cấu hình trong dự án Dialogflow với các vai trò "Trình chỉnh sửa tác nhân bảng điều khiển hộp thoại" và "Ứng dụng API Dialogflow". Đây là yêu cầu bắt buộc để cấp quyền truy cập vào API Dialogflow.
operationInfo

object (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.

AgentWebhookIntegration

Thông tin về webhook dành cho nhân viên hỗ trợ Business Messages.

Biểu diễn dưới dạng JSON 
{
  "webhookUri": string,
  "verificationToken": string
}
Trường
webhookUri

string

Bắt buộc. URL webhook nơi tin nhắn được gửi đến.
verificationToken

string

Chỉ nhập. Mã xác minh.

Phương thức

create

 Tạo liên kết tích hợp.

delete

 Xoá chế độ tích hợp.

get

 Nhận liên kết tích hợp.

list

 Liệt kê các liên kết tích hợp.

patch

 Cập nhật một chế độ tích hợp.