Exemplos de guias interativos

Nota: a consola do Vertex AI Agent Builder continua a referir-se aos guias de procedimentos como agentes. Esta opção vai ser atualizada para playbook em breve na consola.

Cada manual deve ter um ou mais exemplos. Estes exemplos são conversas de amostra entre um utilizador final e o manual estratégico, incluindo o diálogo e as ações realizadas pelo agente. Estes são efetivamente exemplos de comandos com poucos exemplos para o MDG.

A consola oferece uma interface para introduzir ações.

Agentes multilingues

Se quiser que o seu agente processe vários idiomas, os exemplos devem usar cada um dos idiomas.

Exemplo de resumo de entrada e resumo de saída

Além dos parâmetros de entrada e saída, os manuais de soluções suportam a receção de um resumo de entrada e a emissão de um resumo de saída para a troca de informações com outros manuais de soluções. Os resumos são úteis para transmitir informações contextuais abstratas entre manuais de soluções, enquanto os parâmetros são mais úteis para transmitir campos estruturados e bem definidos entre manuais de soluções. Os parâmetros são a única forma de trocar dados entre fluxos e manuais de estratégias.

Adicione resumos de entradas relevantes aos exemplos para condicionar o livro de jogadas a ajustar as respetivas ações com base nos resumos de entradas no tempo de execução. Adicione resumos de resultados, incluindo detalhes relevantes e precisos sobre a conversa de exemplo, para mostrar ao manual o que é importante resumir.

Nota: os exemplos do playbook predefinido podem não definir parâmetros de entrada ou um resumo de entrada. O manual de procedimentos predefinido serve como ponto de entrada para as conversas com o utilizador, pelo que não tem forma de receber parâmetros de entrada.

Estado de exemplo

Num determinado momento da conversa, uma estratégia está num dos seguintes estados:

• OK: o guia interativo atingiu com êxito o respetivo objetivo e o controlo vai ser transferido para o guia interativo principal.
• CANCELLED: o utilizador decidiu não avançar com o objetivo atribuído ao manual de estratégias. O controlo é agora transferido para o manual de instruções para pais. Se o manual de procedimentos principal for um fluxo do CX, a intenção da introdução do utilizador é detetada antes da execução do fluxo.
• FAILED: o manual não pode avançar com o objetivo devido a um erro (por exemplo, a ferramenta devolve um erro 500). A sessão termina com o estado de falha. É adicionada uma mensagem EndInteraction à resposta.
• ESCALATED: o guia interativo decidiu que não consegue atingir o objetivo e tem de encaminhar a situação para um humano. A sessão termina com o estado encaminhado. É adicionada uma mensagem EndInteraction à resposta.
• PENDING: A conversa continua no manual de vendas.

O exemplo de nível superior e as respetivas invocações de playbook devem ser indicados com um estado que corresponda ao playbook ao qual fazem referência.

Estratégia de seleção

A definição da estratégia de seleção controla se um exemplo está incluído no comando do livro de jogadas enviado para o MDG. Estão disponíveis as seguintes opções:

• Selecionar dinamicamente: o exemplo é incluído condicionalmente com base na sua relevância para o contexto da conversa atual. O exemplo pode ser omitido se o comando estiver a aproximar-se do limite de tokens.

• Selecionar sempre: o exemplo é sempre incluído, independentemente do contexto da conversa. O exemplo pode ser omitido se o comando estiver a aproximar-se do limite de tokens.

• Nunca selecionar: o exemplo nunca é incluído no comando. O exemplo não tem efeito no desempenho do manual de estratégias. Esta definição é útil para excluir temporariamente um exemplo para testes.

Adicionar ação

Um exemplo fornecido num manual consiste numa série de ações. Estas ações podem variar nas suas combinações, mas representam principalmente a interação entre o utilizador e o manual de estratégias, juntamente com as ações realizadas entre elas para satisfazer a consulta ou os requisitos do utilizador.

Existem duas formas de adicionar ações a um exemplo:

• Para adicionar uma ação manualmente, clique no botão + na parte inferior do painel direito ou no botão Adicionar ação quando passar o ponteiro do rato sobre as ações existentes. Pode usar estas opções quando cria um novo exemplo clicando na opção + Exemplo ou quando edita um exemplo existente.
• Para gerar ações automaticamente com base nas instruções do manual existentes, introduza uma entrada do utilizador no campo Introduzir entrada do utilizador na parte inferior do painel direito. Pode usar esta opção quando criar ou editar um exemplo. Em alternativa, pode usar esta opção quando testar o seu guião de execução em tempo de execução no painel Pré-visualizar guião de execução à direita. Para guardar ações num exemplo do painel Pré-visualizar manual de soluções, clique em Guardar exemplo depois de selecionar a invocação do manual de soluções na lista de invocações à esquerda do painel Pré-visualizar manual de soluções.

Certifique-se de que verifica a correção das ações geradas automaticamente e edite-as, se necessário. Isto é especialmente importante para os manuais com poucos ou nenhum exemplo.

Os seguintes tipos de ações são suportados pelo manual de estratégias:

Resposta do guia interativo

A resposta do manual à consulta do utilizador.

Introdução do utilizador

A consulta do utilizador.

Utilização de ferramentas

Esta é uma invocação de ferramenta para obter informações adicionais necessárias para satisfazer a consulta do utilizador. Esta ação deve especificar os seguintes detalhes:

• Ferramenta: nome da ferramenta que deve ser invocada.

• Ação: nome da operação para a ferramenta OpenAPI que deve ser invocada. Para as ferramentas de armazenamento de dados e a ferramenta de funções, o nome da ação é igual ao nome da ferramenta.

• Entrada da ferramenta: entradas a incluir na chamada da ferramenta. Normalmente, são derivados das interações anteriores da conversa com o utilizador.

  Para as ferramentas de API aberta, o JSON é necessário para os tipos de métodos POST, PUT e PATCH.requestBody

  Exemplo de entrada Ferramenta de API aberta requestBody para a ação createPet:

  {
    "id": 1,
    "name": "Luna"
  }
  

  Para a ferramenta de armazenamento de dados, o exemplo requestBody onde a consulta é obrigatória e outros campos são opcionais.

  {
    "query": "Where is my nearest store?",
    "filter": "country: ANY(\"United States\")",
    "userMetadata": {
      "userCity": "San Francisco",
    },
    "fallback": "We don't have any stores in your area."
  }
  

• Resultado da ferramenta: a resposta da invocação da ferramenta. Esta é uma resposta JSON válida da ferramenta à entrada fornecida. Para as ferramentas de API aberta, também pode ser um erro de string (por exemplo, "404 Não encontrado").

  Exemplo de resultado da ferramenta de API aberta para a ação listPets:

  {
    "pets": [
      {
        "id": 1,
        "name": "Luna"
      },
      {
        "id": 2,
        "name": "Charlie"
      }]
  }
  

  Exemplo de saída da ferramenta Data store:

  {
    "answer": "Here's the address to your nearest store ...",
    "snippets": [
      {
        "title": "San Francisco Downtown",
        "uri": "https://www.example.com/San_Francisco_Downtown",
        "text": "Address for San Francisco Downtown .."
      }
    ]
  }
  

Para garantir que o plano de ação é à prova de falhas, inclua também exemplos de como o plano de ação deve responder quando a invocação da ferramenta falha. A falha de invocação da ferramenta de API aberta pode ser representada como uma string de erro ("404 não encontrado") na saída da ferramenta. Para as ferramentas de armazenamento de dados a entrada fallback pode ser usada para especificar como responder se não existir uma resposta resumida.

Se quiser que a sua ferramenta de armazenamento de dados inclua o URI na resposta do guião, adicione exemplos que contenham o URI com o qual quer que o guião responda. Se este URI for proveniente da ferramenta de armazenamento de dados, a saída da ferramenta de armazenamento de dados deve conter um URI que corresponda ao URI na resposta do manual de soluções. Tenha em atenção que fallback não pode ser usado neste cenário porque desativa a capacidade do manual de instruções do MDG de reformular a resposta da ferramenta de armazenamento de dados para incluir URIs na resposta do manual de instruções.

Os exemplos que contêm ações de utilização de ferramentas podem ser bastante detalhados e contribuir para um aumento do consumo do limite de tokens de entrada. Para garantir uma utilização eficiente dos tokens, certifique-se de que as saídas das ferramentas são concisas e contêm informações relevantes para os objetivos do manual de estratégias. Para as ferramentas de armazenamento de dados, considere remover fragmentos dos exemplos, uma vez que podem contribuir para um elevado consumo de tokens de entrada.

Invocação do guia interativo

Esta ação é usada quando o playbook deve invocar outro playbook de tarefas para satisfazer a consulta do utilizador. Esta ação deve especificar os seguintes detalhes:

• Playbook: nome do guia interativo a ser invocado.
• Resumo da entrada de invocação do Playbook: Um resumo das partes relevantes da conversa anterior útil para o Playbook que está a ser invocado.
• Parâmetros de entrada: Parâmetros de entrada a transmitir ao manual de procedimentos.
• Resumo do resultado da invocação do guia interativo: Um resumo do que o guia interativo deve gerar após a conclusão do respetivo objetivo.
• Parâmetros de saída: Parâmetros de saída gerados pelo guião de planeamento após a conclusão do respetivo objetivo.

Transição do guia interativo

Uma ação de transição do guião de planeamento é uma ação terminal (não deve ser seguida de outras ações) que indica que o guião de planeamento de rotina decidiu sair e fazer a transição para um guião de planeamento de rotina de destino. Tenha em atenção que, uma vez que esta ação indica que o manual de soluções termina, adicione os parâmetros de saída do manual de soluções à saída do manual de soluções do exemplo.

Invocação do fluxo

Esta ação é usada quando o manual de procedimentos da tarefa deve invocar um fluxo. Esta ação deve especificar os seguintes detalhes:

• Fluxo: nome do fluxo a ser invocado.
• Parâmetros de entrada do fluxo: Parâmetros de entrada a transmitir ao fluxo.
• Parâmetros de retorno do fluxo: Parâmetros de saída devolvidos do fluxo.

Transição do fluxo

Uma ação de transição de fluxo é uma ação terminal (não deve ser seguida de outras ações) que indica que o manual de procedimentos de rotina decidiu sair e fazer a transição para um fluxo de destino. Tenha em atenção que, uma vez que esta ação indica que o manual de soluções termina, adicione os parâmetros de saída do manual de soluções à saída do manual de soluções do exemplo.