Method: projects.locations.apps.generateOnboardingSuggestions

Generiert personalisierte Onboarding-Vorschläge für den Arc-Nullzustand: Klassifiziert den anfragenden Nutzer (neu / erkundend / wiederkehrend) anhand seines Assistant-Sitzungsverlaufs in der App und gibt Vorschlags-Chips (Sitzung fortsetzen, Arbeit fortsetzen oder etwas Neues beginnen) zurück, die gerendert werden, bevor eine Nachricht gesendet wird.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Die App, deren Startzustand gerendert wird. Format: projects/{project}/locations/{location}/apps/{app}

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "maxSuggestions": integer
}
Felder
maxSuggestions

integer

Optional. Maximale Anzahl der zurückzugebenden Vorschläge. Wenn kein Wert festgelegt ist, wird der Standardwert 4 verwendet.

Antworttext

Antwortnachricht für SessionService.GenerateOnboardingSuggestions.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung
{
  "userProfile": enum (GenerateOnboardingSuggestionsResponse.UserProfile),
  "suggestions": [
    {
      object (AssistantSuggestion)
    }
  ],
  "contextToken": string
}
Felder
userProfile

enum (GenerateOnboardingSuggestionsResponse.UserProfile)

Klassifizierung des Verlaufs des anfragenden Nutzers.

suggestions[]

object (AssistantSuggestion)

Personalisierte Vorschläge, sortiert nach Relevanz.

contextToken

string

Undurchsichtiges Token, das den Onboarding-Snapshot erfasst, der zum Generieren dieser Vorschläge verwendet wurde. Clients geben ihn beim ersten StreamChatAiAssistantRequest zurück, damit der Server den Snapshot wiederverwenden kann.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource name:

  • ces.assistantSessions.list

Weitere Informationen finden Sie in der IAM-Dokumentation.

GenerateOnboardingSuggestionsResponse.UserProfile

Klassifizierung des Verlaufs des anfragenden Nutzers mit dem Assistenten in dieser App.

Enums
USER_PROFILE_UNSPECIFIED Nicht angegebenes Profil.
NEW Keine Assistant-Sitzungen mit Nachrichten.
EXPLORING Eine oder zwei Assistant-Sitzungen mit Nachrichten.
RETURNING Mehr als zwei Assistant-Sitzungen mit Nachrichten.

AssistantSuggestion

Ein einzelner personalisierter Vorschlags-Chip für das Onboarding im Nullzustand von Arc.

JSON-Darstellung
{
  "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.
}
Felder
suggestionId

string

Stabile Kennung für diesen Vorschlag, die von Clients im Interaktions-Logging zurückgegeben wird.

label

string

Chip-Label, das dem Nutzer angezeigt wird (maximal 60 Zeichen).

rationale

string

Optionale kurze Erklärung, warum dieser Vorschlag angezeigt wird (Kurzinfo / Pop-over mit Begründung).

icon

enum (AssistantSuggestion.Icon)

Symbolhinweis für den Chip.

source

enum (AssistantSuggestion.Source)

So wurde dieser Vorschlag generiert.

candidateType

string

Kandidatentyp der Regeltabelle in Kebab-Case-Schreibweise (z.B. „resume-pending-review“) für Messwerte.

Was die Aktivierung des Chips bewirkt. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
seedPrompt

string

Der Composer wird mit diesem Text vorausgefüllt. Der Nutzer überprüft und sendet ihn.

loadSession

object (AssistantSuggestion.LoadSession)

Öffnen Sie eine vorhandene Assistant-Sitzung.

sendMessage

string

Füllt den Composer mit diesem Text vor und sendet ihn sofort. Wird nur für Kurzantwort-Chips in einer aktiven Onboarding-Unterhaltung verwendet.

Ende der sich gegenseitig ausschließenden Felder.

AssistantSuggestion.LoadSession

Parameter für die Aktion „loadSession“.

JSON-Darstellung
{
  "assistantSessionId": string
}
Felder
assistantSessionId

string

ID der zu öffnenden Assistentensitzung (das letzte Segment des Ressourcennamens der AssistantSession).

AssistantSuggestion.Icon

Symbolhinweis für den Chip.

Enums
ICON_UNSPECIFIED Symbol „Nicht angegeben“
RESUME Eine vorherige Sitzung fortsetzen.
BUILD Etwas Neues entwickeln.
EVALUATE Bewertungsbezogener Vorschlag.
DEPLOY Bereitstellungsbezogener Vorschlag.
EXPLORE Vorschlag für Erkundung/Entdeckung.
FIX Fehler oder fehlerhaften Status beheben.

AssistantSuggestion.Source

So wurde dieser Vorschlag generiert.

Enums
SOURCE_UNSPECIFIED Nicht angegebene Quelle.
RULE Deterministischer Kandidat für eine Regeltabelle mit Vorlagenformulierung.
LLM_RANKED Der Kandidat für die Regeltabelle wird im Schritt „LLM-Formulierung“ neu sortiert und formuliert.