Method: projects.locations.apps.generateOnboardingSuggestions

Genera suggerimenti di onboarding personalizzati per lo stato zero di Arc: classifica l'utente richiedente (nuovo/esploratore/di ritorno) in base alla cronologia delle sessioni dell'assistente nell'app e restituisce chip di suggerimento (riprendi una sessione, continua il lavoro o inizia qualcosa di nuovo) da visualizzare prima dell'invio di un messaggio.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di percorso

Parametri
name

string

Obbligatorio. L'app di cui viene eseguito il rendering dello stato vuoto. Formato: projects/{project}/locations/{location}/apps/{app}

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "maxSuggestions": integer
}
Campi
maxSuggestions

integer

Facoltativo. Il numero massimo di suggerimenti da restituire. Se non viene impostato, il valore predefinito è 4.

Corpo della risposta

Messaggio di risposta per SessionService.GenerateOnboardingSuggestions.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

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

enum (GenerateOnboardingSuggestionsResponse.UserProfile)

Classificazione della cronologia dell'utente che ha inviato la richiesta.
suggestions[]

object (AssistantSuggestion)

Suggerimenti personalizzati, classificati in base alla pertinenza.
contextToken

string

Token opaco che acquisisce lo snapshot di onboarding utilizzato per generare questi suggerimenti. I client lo ripetono nel primo StreamChatAiAssistantRequest in modo che il server possa riutilizzare lo snapshot.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • ces.assistantSessions.list

Per saperne di più, consulta la documentazione di IAM.

GenerateOnboardingSuggestionsResponse.UserProfile

Classificazione della cronologia dell'utente richiedente con l'assistente in questa app.

Enum
USER_PROFILE_UNSPECIFIED Profilo non specificato.
NEW Nessuna sessione dell'assistente contenente messaggi.
EXPLORING Una o due sessioni dell'assistente contenenti messaggi.
RETURNING Più di due sessioni dell'assistente contenenti messaggi.

AssistantSuggestion

Un singolo chip di suggerimento di onboarding personalizzato per lo stato zero di Arc.

Rappresentazione 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.
}
Campi
suggestionId

string

Identificatore stabile per questo suggerimento, utilizzato dai client nel logging delle interazioni.
label

string

Etichetta del chip mostrata all'utente (massimo 60 caratteri).
rationale

string

Breve spiegazione facoltativa del motivo per cui viene mostrato questo suggerimento (tooltip/popover di motivazione).
icon

enum (AssistantSuggestion.Icon)

Suggerimento per l'icona del chip.
source

enum (AssistantSuggestion.Source)

Come è stato generato questo suggerimento.
candidateType

string

Tipo di candidato della tabella delle regole in kebab-case (ad es. "resume-pending-review"), per le metriche.
Cosa comporta l'attivazione del chip. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
seedPrompt

string

Precompila il compositore con questo testo; l'utente lo esamina e lo invia.
loadSession

object (AssistantSuggestion.LoadSession)

Apri una sessione dell'assistente esistente.
sendMessage

string

Precompila il compositore con questo testo e invia immediatamente. Utilizzato solo per i chip di risposta rapida all'interno di una conversazione di onboarding attiva.
Fine dei campi che si escludono a vicenda.

AssistantSuggestion.LoadSession

Parametri per l'azione loadSession.

Rappresentazione JSON 
{
  "assistantSessionId": string
}
Campi
assistantSessionId

string

Identificatore della sessione dell'assistente da aprire (il segmento finale del nome della risorsa AssistantSession).

AssistantSuggestion.Icon

Suggerimento per l'icona del chip.

Enum
ICON_UNSPECIFIED Icona Non specificato.
RESUME Riprendere una sessione precedente.
BUILD Crea qualcosa di nuovo.
EVALUATE Suggerimento relativo alla valutazione.
DEPLOY Suggerimento relativo al deployment.
EXPLORE Suggerimento di esplorazione/scoperta.
FIX Correggi un errore o uno stato di errore.

AssistantSuggestion.Source

Come è stato generato questo suggerimento.

Enum
SOURCE_UNSPECIFIED Origine non specificata.
RULE Candidato di tabella delle regole deterministico con frasi del modello.
LLM_RANKED Candidato della tabella delle regole riordinato e formulato dal passaggio di formulazione dell'LLM.