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

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`. }

{
  "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 riêng biệt của hoạt động 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 nhóm `integration_info`. Thông tin chi tiết về hoạt động 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 một nhân viên hỗ trợ. Nếu bạn định cấu hình một webhook ở cấp nhân viên hỗ trợ, thì webhook đó sẽ ghi đè webhook ở cấp đối tác.

IntegrationStatus

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

Enum
`INTEGRATION_STATUS_UNSPECIFIED`	Trạng thái tích hợp không xác định.
`ENABLED`	Đã bật.
`DISABLED`	Đang tắt.

DialogflowEsIntegration

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

Biểu diễn dưới dạng JSON

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

{
  "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 mối tích hợp mới.
`autoResponseStatus`	`enum (AutoResponseStatus)` Bắt buộc. Nếu `ENABLED`, Business Messages sẽ tự động gửi các câu trả lời của 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 vai trò "Dialogflow Console Agent Editor" và "Dialogflow API Client". Bạn phải làm việc này để 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 được liên kết với 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`	Không xác định phản hồ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 đang tắt.

OperationInfo

Thông tin về thao tác 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ã thao tác), chỉ mang tính duy nhất trong cùng một dịch vụ ban đầu trả về tên đó.
`operationType`	`enum (OperationType)` Chỉ có đầu ra. Loại thao tác 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`	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

Trạng thái của thao tác 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ột mô hình lỗi logic phù hợp với nhiều môi trường lập trình, trong đó có API REST và API RPC. gRPC sử dụng loại này. 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 cụ thể về 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ý mô hình này 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

Trường
`code`	`integer` Mã trạng thái, phải là giá trị enum của `google.rpc.Code`.
`message`	`string` 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 mà người dùng thấy đều phải được bản địa hoá và gửi trong trường `google.rpc.Status.details` hoặc được ứng dụng khách bản địa hoá.
`details[]`	`object` Danh sách các thông báo chứa thông tin cụ thể về lỗi. Có một nhóm gồm nhiều loại thông báo chung để API sử dụng. Một đối tượng chứa các trường thuộc một loại tuỳ ý. Một trường bổ sung `"@type"` chứa một URI xác định loại. Ví dụ: `{ "id": 1234, "@type": "types.example.com/standard/id" }`.

code

integer

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

message

string

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 mà người dùng thấy đều phải được bản địa hoá và gửi trong trường google.rpc.Status.details hoặc được ứng dụng khách bản địa hoá.

details[]

object

Danh sách các thông báo chứa thông tin cụ thể về lỗi. Có một nhóm gồm nhiều loại thông báo chung để API sử dụng.

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

DialogflowKnowledgebase

Thông tin trong cơ sở kiến thức. Một cơ sở kiến thức có thể có nhiều URL cho 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. Giá trị nhận dạng riêng biệt do dịch vụ Dialogflow trả về sau khi tạo một 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", thì tham số này sẽ phân giải thành "brands/1234/agents/5678/integrations/9092/knowledgebases/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 trong 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. Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` hoặc `"2014-10-02T15:01:23+05:30"`.

DialogflowDocument

Một tài liệu trong cơ sở kiến thức. Tài liệu có thể là URL của trang web hoặc URL của tệp CSV. Các 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ỗi cặp nằm trên một hàng.

Biểu diễn dưới dạng JSON

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`. }

{
  "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ã nhận dạng tài liệu do hệ thống tạo. 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", giá trị nhận dạng cơ sở kiến thức là "1111" và giá trị nhận dạng tài liệu là "2222", thì tham số này sẽ phân giải thành "brands/1234/agents/5678/integrations/9092/knowledgebases/1111/documents/2222".
`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. Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` hoặc `"2014-10-02T15:01:23+05:30"`.
`operationInfo`	`object (OperationInfo)` Chỉ có đầu ra. Thông tin về thao tác 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 nhóm `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ối liên kết giữa nhân viên hỗ trợ Business Messages và dự án Dialogflow CX.

Biểu diễn dưới dạng JSON

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

{
  "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 mối tích hợp mới.
`dialogflowAgentId`	`string` Bắt buộc. Mã nhân viên hỗ trợ dự án Dialogflow.
`autoResponseStatus`	`enum (AutoResponseStatus)` Bắt buộc. Nếu `ENABLED`, Business Messages sẽ tự động gửi các câu trả lời của 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 vai trò "Dialogflow Console Agent Editor" và "Dialogflow API Client". Bạn phải làm việc này để 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 cho nhân viên hỗ trợ Business Messages.

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

Trường

Trường
`webhookUri`	`string` Bắt buộc. URL webhook nơi các thông báo được gửi đến.
`verificationToken`	`string` Chỉ có đầu vào. Mã xác minh.

webhookUri

string

Bắt buộc. URL webhook nơi các thông báo được gửi đến.

verificationToken

string

Chỉ có đầu vào. Mã xác minh.

Phương thức
`create`	Tạo một mối liên kết tích hợp.
`delete`	Xoá một chế độ tích hợp.
`get`	Nhận một chế độ tích hợp.
`list`	Liệt kê các chế độ tích hợp.
`patch`	Cập nhật một mối tích hợp.

REST Resource: brands.agents.integrations

Tài nguyên: Tích hợp

IntegrationStatus

DialogflowEsIntegration

AutoResponseStatus

OperationInfo

OperationType

OperationState

Trạng thái

DialogflowKnowledgebase

DialogflowDocument

DialogflowCxIntegration

AgentWebhookIntegration

Phương thức

`create`

`delete`

`get`

`list`

`patch`

REST Resource: brands.agents.integrations Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.

Tài nguyên: Tích hợp

IntegrationStatus

DialogflowEsIntegration

AutoResponseStatus

OperationInfo

OperationType

OperationState

Trạng thái

DialogflowKnowledgebase

DialogflowDocument

DialogflowCxIntegration

AgentWebhookIntegration

Phương thức

create

delete

get

list

patch

REST Resource: brands.agents.integrations

`create`

`delete`

`get`

`list`

`patch`