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 메시지에는 오류 코드, 오류 메시지, 오류 세부정보라는 3가지 데이터가 포함됩니다.

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

기술 자료 정보입니다. 기술 자료에는 여러 FAQ URL이 있을 수 있습니다.

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 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.

DialogflowDocument

기술 자료 문서입니다. 문서는 웹사이트 URL 또는 CSV 파일의 URL일 수 있습니다. URL은 공개적으로 사용할 수 있어야 합니다. 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/90911/12bases2/integrations/9091/12bases2'로 확인됩니다.
displayName

string

필수 항목입니다. FAQ 문서의 표시 이름입니다.
updateTime

string (Timestamp format)

출력 전용. 문서가 생성/업데이트된 시간입니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.
operationInfo

object (OperationInfo)

출력 전용. 작업 정보는 문서가 기존 기술 자료에 추가될 때만 채워집니다.
통합 필드 content. 문서의 콘텐츠입니다. content은 다음 중 하나여야 합니다.
faqUrl

string

FAQ 문서의 URL입니다.
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

 통합을 업데이트합니다.