Method: projects.locations.apps.generateOnboardingSuggestions

Arc 제로 상태에 대한 맞춤 온보딩 추천을 생성합니다. 앱의 어시스턴트 세션 기록에서 요청하는 사용자(신규/탐색/재방문)를 분류하고 메시지가 전송되기 전에 렌더링할 추천 쿼리 칩(세션 재개, 작업 계속, 새로운 작업 시작)을 반환합니다.

HTTP 요청

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

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

경로 매개변수

매개변수
name

string

필수 항목입니다. 0 상태가 렌더링되는 앱입니다. 형식: projects/{project}/locations/{location}/apps/{app}

요청 본문

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

JSON 표현
{
  "maxSuggestions": integer
}
필드
maxSuggestions

integer

선택사항입니다. 반환할 최대 추천 수입니다. 설정하지 않으면 기본값은 4입니다.

응답 본문

SessionService.GenerateOnboardingSuggestions의 응답 메시지입니다.

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

JSON 표현
{
  "userProfile": enum (GenerateOnboardingSuggestionsResponse.UserProfile),
  "suggestions": [
    {
      object (AssistantSuggestion)
    }
  ],
  "contextToken": string
}
필드
userProfile

enum (GenerateOnboardingSuggestionsResponse.UserProfile)

요청하는 사용자의 기록 분류입니다.

suggestions[]

object (AssistantSuggestion)

관련성이 가장 높은 순으로 정렬된 맞춤 추천입니다.

contextToken

string

이러한 추천을 생성하는 데 사용된 온보딩 스냅샷을 캡처하는 불투명 토큰입니다. 클라이언트는 첫 번째 StreamChatAiAssistantRequest에서 이를 에코하므로 서버가 스냅샷을 재사용할 수 있습니다.

승인 범위

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

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

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

IAM 권한

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

  • ces.assistantSessions.list

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

GenerateOnboardingSuggestionsResponse.UserProfile

이 앱에서 어시스턴트를 사용한 요청 사용자의 기록 분류입니다.

열거형
USER_PROFILE_UNSPECIFIED 지정되지 않은 프로필입니다.
NEW 메시지가 포함된 어시스턴트 세션이 없습니다.
EXPLORING 메시지가 포함된 하나 또는 두 개의 어시스턴트 세션입니다.
RETURNING 메시지가 포함된 어시스턴트 세션이 2개 이상입니다.

AssistantSuggestion

Arc의 제로 스테이트를 위한 단일 맞춤 온보딩 추천 칩입니다.

JSON 표현
{
  "suggestionId": string,
  "label": string,
  "rationale": string,
  "icon": enum (AssistantSuggestion.Icon),
  "source": enum (AssistantSuggestion.Source),
  "candidateType": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "seedPrompt": string,
  "loadSession": {
    object (AssistantSuggestion.LoadSession)
  },
  "sendMessage": string
  // End of mutually exclusive fields.
}
필드
suggestionId

string

상호작용 로깅에서 클라이언트가 왕복하는 이 추천의 안정적인 식별자입니다.

label

string

사용자에게 표시되는 칩 라벨입니다(최대 60자(영문 기준)).

rationale

string

이 추천이 표시되는 이유에 대한 간단한 설명(선택사항, 도움말/근거 팝오버)

icon

enum (AssistantSuggestion.Icon)

칩의 아이콘 힌트입니다.

source

enum (AssistantSuggestion.Source)

이 추천이 생성된 방식입니다.

candidateType

string

측정항목의 케밥 케이스로 된 규칙 테이블 후보 유형입니다(예: 'resume-pending-review').

칩을 활성화하면 어떻게 되나요? 다음은 상호 배타적인 필드 목록입니다. 응답에서 최대 하나의 필드가 설정됩니다.
seedPrompt

string

이 텍스트로 작성 도구를 미리 채웁니다. 사용자가 검토하고 전송합니다.

loadSession

object (AssistantSuggestion.LoadSession)

기존 어시스턴트 세션을 엽니다.

sendMessage

string

이 텍스트로 작성기를 미리 채우고 즉시 제출합니다. 활성 온보딩 대화 내의 빠른 답장 칩에만 사용됩니다.

상호 배타적 필드의 끝입니다.

AssistantSuggestion.LoadSession

loadSession 작업의 매개변수입니다.

JSON 표현
{
  "assistantSessionId": string
}
필드
assistantSessionId

string

열려는 어시스턴트 세션의 식별자입니다(AssistantSession 리소스 이름의 마지막 세그먼트).

AssistantSuggestion.Icon

칩의 아이콘 힌트입니다.

열거형
ICON_UNSPECIFIED 지정되지 않은 아이콘입니다.
RESUME 이전 세션을 재개합니다.
BUILD 새로운 것을 만드세요.
EVALUATE 평가 관련 제안입니다.
DEPLOY 배포 관련 추천입니다.
EXPLORE 탐색/발견 추천
FIX 오류 또는 실패 상태를 수정합니다.

AssistantSuggestion.Source

이 추천이 생성된 방식입니다.

열거형
SOURCE_UNSPECIFIED 지정되지 않은 소스입니다.
RULE 템플릿 문구가 있는 결정론적 규칙 테이블 후보입니다.
LLM_RANKED LLM 문구 단계에서 순위가 재정렬되고 문구가 지정된 규칙 테이블 후보입니다.