Method: projects.locations.apps.runAssistant

지정된 어시스턴트 세션의 어시스턴트 에이전트를 실행합니다.

HTTP 요청

POST https://ces.googleapis.com/v1beta/{app=projects/*/locations/*/apps/*}:runAssistant

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

경로 매개변수

매개변수
app

string

필수 항목입니다. 어시스턴트를 실행할 앱입니다. 형식: projects/{project}/locations/{location}/apps/{app}

요청 본문

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

JSON 표현 
{
  "assistantSession": string,
  "message": {
    object (AssistantMessage)
  },
  "interactionType": enum (RunAssistantRequest.InteractionType)
}
필드
assistantSession

string

필수 항목입니다. 어시스턴트를 실행하는 데 사용할 어시스턴트 세션입니다. 형식: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}
message

object (AssistantMessage)

필수 항목입니다. 어시스턴트 에이전트에 보낼 메시지입니다.
interactionType

enum (RunAssistantRequest.InteractionType)

선택사항입니다. 어시스턴트 메시지의 다양한 상호작용 유형입니다.

응답 본문

AssistantService.RunAssistant의 응답 메시지입니다.

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

JSON 표현 
{
  "output": {
    object (AssistantOutput)
  },
  "state": enum (AssistantSessionState)
}
필드
output

object (AssistantOutput)

필수 항목입니다. 어시스턴트 에이전트의 출력입니다.
state

enum (AssistantSessionState)

출력 전용입니다. 어시스턴트 세션의 상태입니다.

승인 범위

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

자세한 내용은 Authentication Overview에서 확인하세요.

IAM 권한

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

  • ces.apps.update

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

RunAssistantRequest.InteractionType

어시스턴트에 전송된 메시지의 상호작용 유형입니다.

열거형
INTERACTION_TYPE_UNSPECIFIED 기본값입니다. 유형이 지정되지 않은 경우 이 값이 사용됩니다.
NEW_MESSAGE 메시지는 사용자 입력입니다. 사용자 입력은 청크 목록에 제공됩니다.
POLL 이 메시지는 어시스턴트 세션의 상태를 폴링하기 위한 것입니다.
DISMISS 검토 대기 중인 어시스턴트 세션을 닫는 메시지입니다. 이렇게 하면 어시스턴트 세션의 상태가 유휴 상태로 변경됩니다.

AssistantOutput

어시스턴트 에이전트의 출력입니다.

JSON 표현 
{
  "message": {
    object (AssistantMessage)
  },
  "userResponseSuggestions": {
    object (UserResponseSuggestions)
  }
}
필드
message

object (AssistantMessage)

필수 항목입니다. 어시스턴트 에이전트의 대답입니다.
userResponseSuggestions

object (UserResponseSuggestions)

출력 전용입니다. 어시스턴트 에이전트의 추천 사용자 응답입니다.