Method: projects.locations.apps.generateOnboardingSuggestions

Arc のゼロ状態に対してパーソナライズされたオンボーディングの候補を生成します。アプリ内のアシスタント セッション履歴からリクエスト元のユーザーを分類(新規 / 探索中 / 再訪)し、メッセージが送信される前にレンダリングする候補ワード(セッションの再開、作業の続行、新しいタスクの開始)を返します。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。ゼロ状態がレンダリングされているアプリ。形式: 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 メッセージを含む 1 つまたは 2 つのアシスタント セッション。
RETURNING メッセージを含むアシスタント セッションが 3 つ以上ある。

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」)のルールテーブル候補タイプ。

チップを有効にするとどうなるか。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
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 のフレーズ化ステップで再ランク付けされ、フレーズ化されたルールテーブル候補。