Method: projects.locations.apps.generateOnboardingSuggestions

Genera sugerencias de integración personalizadas para el estado cero de Arc: clasifica al usuario que realiza la solicitud (nuevo, explorando o recurrente) a partir de su historial de sesiones de asistente en la app y devuelve chips de sugerencias (reanudar una sesión, continuar el trabajo o comenzar algo nuevo) para renderizar antes de que se envíe cualquier mensaje.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
name

string

Obligatorio. La app cuyo estado cero se está renderizando. Formato: projects/{project}/locations/{location}/apps/{app}

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "maxSuggestions": integer
}
Campos
maxSuggestions

integer

Es opcional. Es la cantidad máxima de sugerencias que se devolverán. El valor predeterminado es 4 cuando no se establece.

Cuerpo de la respuesta

Mensaje de respuesta para SessionService.GenerateOnboardingSuggestions.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON
{
  "userProfile": enum (GenerateOnboardingSuggestionsResponse.UserProfile),
  "suggestions": [
    {
      object (AssistantSuggestion)
    }
  ],
  "contextToken": string
}
Campos
userProfile

enum (GenerateOnboardingSuggestionsResponse.UserProfile)

Es la clasificación del historial del usuario que realiza la solicitud.

suggestions[]

object (AssistantSuggestion)

Sugerencias personalizadas, clasificadas primero por relevancia.

contextToken

string

Es el token opaco que captura la instantánea de incorporación que se usó para generar estas sugerencias. Los clientes lo repiten en el primer StreamChatAiAssistantRequest para que el servidor pueda reutilizar la instantánea.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.assistantSessions.list

Para obtener más información, consulta la documentación de IAM.

GenerateOnboardingSuggestionsResponse.UserProfile

Clasificación del historial del usuario que realiza la solicitud con el asistente en esta app.

Enums
USER_PROFILE_UNSPECIFIED Perfil sin especificar.
NEW No hay sesiones de asistente que contengan mensajes.
EXPLORING Una o dos sesiones de asistente que contienen mensajes.
RETURNING Más de dos sesiones de asistente que contienen mensajes.

AssistantSuggestion

Un solo chip de sugerencias de incorporación personalizado para el estado cero de Arc.

Representación 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.
}
Campos
suggestionId

string

Es el identificador estable de esta sugerencia, que los clientes devuelven en el registro de interacciones.

label

string

Es la etiqueta del chip que se muestra al usuario (60 caracteres como máximo).

rationale

string

Explicación breve opcional de por qué se muestra esta sugerencia (cuadro de información o ventana emergente de justificación).

icon

enum (AssistantSuggestion.Icon)

Es la sugerencia de ícono para el chip.

source

enum (AssistantSuggestion.Source)

Cómo se generó esta sugerencia

candidateType

string

Es el tipo de candidato de la tabla de reglas en minúsculas con guiones medios (p.ej., "resume-pending-review") para las métricas.

Qué sucede cuando se activa el chip La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
seedPrompt

string

Completa previamente el compositor con este texto; el usuario lo revisa y lo envía.

loadSession

object (AssistantSuggestion.LoadSession)

Abre una sesión existente de Gemini.

sendMessage

string

Completa previamente el compositor con este texto y envíalo de inmediato. Solo se usa para chips de respuesta rápida dentro de una conversación de incorporación activa.

Fin de los campos mutuamente excluyentes.

AssistantSuggestion.LoadSession

Son los parámetros para la acción loadSession.

Representación JSON
{
  "assistantSessionId": string
}
Campos
assistantSessionId

string

Es el identificador de la sesión del asistente que se abrirá (el segmento final del nombre del recurso AssistantSession).

AssistantSuggestion.Icon

Es la sugerencia de ícono para el chip.

Enums
ICON_UNSPECIFIED Ícono sin especificar.
RESUME Reanudar una sesión anterior
BUILD Crea algo nuevo.
EVALUATE Sugerencia relacionada con la evaluación.
DEPLOY Sugerencia relacionada con la Deployment.
EXPLORE Sugerencia de exploración o descubrimiento.
FIX Corregir un error o un estado de falla

AssistantSuggestion.Source

Cómo se generó esta sugerencia

Enums
SOURCE_UNSPECIFIED Origen sin especificar.
RULE Candidato de tabla de reglas determinista con fraseo de plantilla.
LLM_RANKED Candidato de la tabla de reglas reclasificado y reformulado por el paso de reformulación del LLM.