Method: projects.locations.collections.dataConnector.executeAction

DataConnector을 사용하여 서드 파티 작업을 실행합니다.

HTTP 요청

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/dataConnector}:executeAction

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
name

string

필수 항목입니다. DataConnector 리소스

작업을 실행하는 데 사용되는 데이터 커넥터입니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "actionName": string,
  "args": {
    object
  },
  "languageCode": string,
  "assistAnswerInfo": {
    object (AssistAnswerInfo)
  }
}
필드
actionName

string

필수입니다. 작업의 이름입니다.

예: 'send_email'
args

object (Struct format)

필수 항목입니다. 작업의 이름이 지정된 인수입니다.

예: {"recipient": "tom@...", "subject": ... }

사용자에게 제공되는 경우 이 부분을 수정할 수 있습니다.
languageCode

string

(선택사항) 작업에서 생성된 상태 및 오류 메시지에 사용할 언어입니다.
assistAnswerInfo

object (AssistAnswerInfo)

(선택사항) 지정된 경우 작업 실행 결과가 지정된 지원 답변과 연결됩니다. 이렇게 하면 어시스턴트가 동일한 세션의 후속 답변에서 결과를 고려할 수 있습니다.

참조된 지원 답변 리소스가 있어야 합니다.

응답 본문

DataConnectorService.ExecuteAction 메서드에 대한 응답입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "status": {
    object (Status)
  },
  "textResult": string,
  "result": {
    object
  }
}
필드
status

object (Status)

작업 실행 상태입니다.
textResult

string

성공한 경우 작업 실행의 사람이 읽을 수 있는 결과입니다.
result

object (Struct format)

성공한 경우 작업 실행의 자세한 결과입니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

자세한 내용은 Authentication Overview를 참조하세요.

IAM 권한

name 리소스에 대해서는 다음 IAM 권한이 필요합니다.

  • discoveryengine.dataConnectors.executeAction

자세한 내용은 IAM 문서를 참조하세요.

AssistAnswerInfo

지원 답변에서 작업 호출을 식별하는 메시지입니다.

JSON 표현 
{
  "assistAnswer": string,
  "invocationId": string
}
필드
assistAnswer

string

필수 항목입니다. 지원 답변의 이름입니다.

형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}
invocationId

string

필수 항목입니다. 작업 호출 ID입니다.