REST Resource: brands.agents.integrations

资源：集成

集成相关信息。

JSON 表示法 
{
  "name": string,
  "status": enum (IntegrationStatus),

  // Union field integration_info can be only one of the following:
  "dialogflowEsIntegration": {
    object (DialogflowEsIntegration)
  },
  "dialogflowCxIntegration": {
    object (DialogflowCxIntegration)
  }
  // End of list of possible types for union field integration_info.
}
字段
name

string

仅限输出。集成的唯一标识符。只读。由平台定义。
status

enum (IntegrationStatus)

仅限输出。集成状态。
联合字段 integration_info。集成的详细信息。integration_info 只能是下列其中一项：
dialogflowEsIntegration

object (DialogflowEsIntegration)

关联的 Dialogflow ES 项目的相关信息。https://cloud.google.com/dialogflow/es/docs
dialogflowCxIntegration

object (DialogflowCxIntegration)

关联的 Dialogflow CX 项目的相关信息。https://cloud.google.com/dialogflow/cx/docs/basics

IntegrationStatus

集成状态。

枚举
INTEGRATION_STATUS_UNSPECIFIED 未指定集成状态。
ENABLED 已启用。
DISABLED 已停用。

DialogflowEsIntegration

Business Messages 代理和 Dialogflow ES 项目关联的相关信息。

JSON 表示法 
{
  "dialogflowProjectId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  },
  "dialogflowKnowledgeBases": [
    {
      object (DialogflowKnowledgebase)
    }
  ]
}
字段
dialogflowProjectId

string

必需。Dialogflow 项目 ID。

不可修改。如需更改此值，您必须从此代理中删除 Dialogflow 项目，然后创建新的集成。
autoResponseStatus

enum (AutoResponseStatus)

必需。如果为 ENABLED，Business Messages 会自动将 Dialogflow 回复发送给用户。
dialogflowServiceAccountEmail

string

仅限输出。必须使用“Dialogflow 控制台代理编辑器”在 Dialogflow 项目中配置的服务账号和“Dialogflow API 客户端”角色。要提供对 Dialogflow API 的访问权限，必须执行此操作。
operationInfo

object (OperationInfo)

仅限输出。有关 Dialogflow 集成运行状态的信息。
dialogflowKnowledgeBases[]

object (DialogflowKnowledgebase)

与 Dialogflow 项目关联的知识库。

可选

AutoResponseStatus

Dialogflow 自动响应状态。

枚举
AUTO_RESPONSE_STATUS_UNSPECIFIED 未指定自动回复。
ENABLED 已启用自动回复。
DISABLED 自动回复已停用。

OperationInfo

Dialogflow 操作信息。

JSON 表示法 
{
  "operationName": string,
  "operationType": enum (OperationType),
  "operationState": enum (OperationState),
  "error": {
    object (Status)
  }
}
字段
operationName

string

仅限输出。服务器分配的名称（操作 ID），该名称仅在最初返回它的那项服务中是唯一的。
operationType

enum (OperationType)

仅限输出。Dialogflow 操作类型。
operationState

enum (OperationState)

仅限输出。Dialogflow 操作状态。
error

object (Status)

仅限输出。错误结果（如果有）。

OperationType

Dialogflow 操作类型。

枚举
OPERATION_TYPE_UNSPECIFIED 未指定类型。
ASSOCIATE_DIALOGFLOW 关联 Dialogflow。
DISSOCIATE_DIALOGFLOW 取消关联 Dialogflow。
ADD_DOCUMENT_TO_KNOWLEDGEBASE 将文档添加到知识库。
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE 从知识库中删除文档。

OperationState

Dialogflow 中的操作状态。

枚举
OPERATION_STATE_UNSPECIFIED 未指定状态。
PROCESSING 正在处理。
COMPLETED 已完成。
FAILED 失败。

状态

Status 类型定义了适用于不同编程环境（包括 REST API 和 RPC API）的逻辑错误模型。此类型供 gRPC 使用。每条 Status 消息包含三部分数据：错误代码、错误消息和错误详细信息。

如需详细了解该错误模型及其使用方法，请参阅 API 设计指南。

JSON 表示法 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
字段
code

integer

状态代码，应为 google.rpc.Code 的枚举值。
message

string

面向开发者的错误消息（应采用英语）。任何向用户显示的错误消息都应进行本地化并通过 google.rpc.Status.details 字段发送，或者由客户端进行本地化。
details[]

object

包含错误详细信息的消息列表。有一组通用的消息类型可供 API 使用。

可以包含任意类型字段的对象。附加字段 "@type" 包含用于标示相应类型的 URI。示例：{ "id": 1234, "@type": "types.example.com/standard/id" }。

DialogflowKnowledgebase

知识库信息。一个知识库可以有多个常见问题解答网址。

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "documents": [
    {
      object (DialogflowDocument)
    }
  ],
  "updateTime": string
}
字段
name

string

仅限输出。知识库 ID。

创建知识库后 Dialogflow 服务返回的唯一标识符。如果品牌标识符为“1234”，代理标识符为“5678”，集成标识符为“9092”，知识库标识符为“1111”，则此参数将解析为“brands/1234/agents/5678/integrations/9092/knowledgebases/1111”。
displayName

string

必需。知识库显示名称。
documents[]

object (DialogflowDocument)

知识库文档。

可选
updateTime

string (Timestamp format)

仅限输出。创建或更新知识库的时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

DialogflowDocument

知识库文档。文档可以是网站网址，也可以是 CSV 文件的网址。网址必须可公开访问。CSV 文件必须包含一个或多个问题/答案对，每行对应一行。

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

系统生成的文档 ID。

如果品牌标识符为“1234”，代理标识符为“5678”，集成标识符为“9092”，知识库标识符为“1111”，文档标识符为“2222”，则此参数将解析为“brands/1234/agents/5678/integrations/documents1documents2”
displayName

string

必需。常见问题解答文档的显示名称。
updateTime

string (Timestamp format)

仅限输出。创建/更新文档的时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
operationInfo

object (OperationInfo)

仅限输出。仅当文档添加到现有知识库时，系统才会填充操作信息。
联合字段 content。文档的内容。content 只能是下列其中一项：
faqUrl

string

常见问题解答文档的网址。
rawContent

string (bytes format)

文档的原始内容。

使用 base64 编码的字符串。

DialogflowCxIntegration

Business Messages 代理和 Dialogflow CX 项目关联的相关信息。

JSON 表示法 
{
  "dialogflowProjectId": string,
  "dialogflowAgentId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  }
}
字段
dialogflowProjectId

string

必需。Dialogflow 项目 ID。

不可修改。如需更改此值，您必须从此代理中删除 Dialogflow 项目，然后创建新的集成。
dialogflowAgentId

string

必需。Dialogflow 代理 ID。
autoResponseStatus

enum (AutoResponseStatus)

必需。如果为 ENABLED，Business Messages 会自动将 Dialogflow 回复发送给用户。
dialogflowServiceAccountEmail

string

仅限输出。必须使用“Dialogflow 控制台代理编辑器”在 Dialogflow 项目中配置的服务账号和“Dialogflow API 客户端”角色。要提供对 Dialogflow API 的访问权限，必须执行此操作。
operationInfo

object (OperationInfo)

仅限输出。有关 Dialogflow 集成运行状态的信息。

方法

create

 创建集成。

delete

 删除集成。

get

 获取集成。

list

 列出集成。

patch

 更新集成。