Method: projects.locations.apps.generateOnboardingSuggestions

Gera sugestões de integração personalizadas para o estado zero do Arc: classifica o usuário que faz a solicitação (novo / explorando / retornando) com base no histórico de sessões do assistente no app e retorna chips de sugestão de resposta (retomar uma sessão, continuar o trabalho ou começar algo novo) para renderizar antes que qualquer mensagem seja enviada.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O app cujo estado zero está sendo renderizado. Formato: projects/{project}/locations/{location}/apps/{app}

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "maxSuggestions": integer
}
Campos
maxSuggestions

integer

Opcional. Número máximo de sugestões a serem retornadas. O padrão é 4 quando não definido.

Corpo da resposta

Mensagem de resposta para SessionService.GenerateOnboardingSuggestions.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "userProfile": enum (GenerateOnboardingSuggestionsResponse.UserProfile),
  "suggestions": [
    {
      object (AssistantSuggestion)
    }
  ],
  "contextToken": string
}
Campos
userProfile

enum (GenerateOnboardingSuggestionsResponse.UserProfile)

Classificação do histórico do usuário solicitante.

suggestions[]

object (AssistantSuggestion)

Sugestões personalizadas, classificadas por relevância.

contextToken

string

Token opaco que captura o snapshot de integração usado para gerar essas sugestões. Os clientes o repetem no primeiro StreamChatAiAssistantRequest para que o servidor possa reutilizar o snapshot.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.assistantSessions.list

Para mais informações, consulte a documentação do IAM.

GenerateOnboardingSuggestionsResponse.UserProfile

Classificação do histórico do usuário que fez a solicitação com o assistente neste app.

Tipos enumerados
USER_PROFILE_UNSPECIFIED Perfil não especificado.
NEW Não há sessões do assistente com mensagens.
EXPLORING Uma ou duas sessões do assistente com mensagens.
RETURNING Mais de duas sessões do assistente com mensagens.

AssistantSuggestion

Um único chip de sugestão de resposta de integração personalizado para o estado zero do Arc.

Representação 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

Identificador estável para essa sugestão, que é enviado e recebido pelos clientes no registro de interações.

label

string

Rótulo do ícone mostrado ao usuário (no máximo 60 caracteres).

rationale

string

Explicação curta opcional de por que essa sugestão é mostrada (dica / pop-over de justificativa).

icon

enum (AssistantSuggestion.Icon)

Dica de ícone para o ícone.

source

enum (AssistantSuggestion.Source)

Como essa sugestão foi gerada.

candidateType

string

Tipo de candidato da tabela de regras em kebab-case (por exemplo, "resume-pending-review"), para métricas.

O que acontece ao ativar o chip. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
seedPrompt

string

Preencha o editor com este texto. O usuário revisa e envia.

loadSession

object (AssistantSuggestion.LoadSession)

Abra uma sessão do assistente.

sendMessage

string

Preencha o editor com este texto e envie imediatamente. Usado apenas para chips de resposta rápida em uma conversa de integração ativa.

Fim dos campos mutuamente exclusivos.

AssistantSuggestion.LoadSession

Parâmetros para a ação loadSession.

Representação JSON
{
  "assistantSessionId": string
}
Campos
assistantSessionId

string

Identificador da sessão do assistente a ser aberta (o segmento final do nome do recurso AssistantSession).

AssistantSuggestion.Icon

Dica de ícone para o ícone.

Tipos enumerados
ICON_UNSPECIFIED Ícone não especificado.
RESUME Retomar uma sessão anterior.
BUILD Crie algo novo.
EVALUATE Sugestão relacionada à avaliação.
DEPLOY Sugestão relacionada à implantação.
EXPLORE Sugestão de exploração / descoberta.
FIX Corrigir um erro ou estado de falha.

AssistantSuggestion.Source

Como essa sugestão foi gerada.

Tipos enumerados
SOURCE_UNSPECIFIED Origem não especificada.
RULE Candidato determinista de tabela de regras com frase de modelo.
LLM_RANKED Candidato da tabela de regras reclassificado e formulado pela etapa de formulação do LLM.