A grande maioria dos modelos na categoria Mensagens do Usuário se baseia no componente Resposta Comum, que permite usar propriedades e metadados do componente para criar uma interface de usuário especializada que pode incluir texto, botões de ação, imagens e cartões.

Em muitos casos, como os modelos na subcategoria Exibir Mensagens Multimídia, as principais diferenças estão na propriedade Metadados do componente Resposta Comum.

Em outros casos, como na subcategoria Exibir Tabelas e Formulários, o modelo consiste em um componente Resposta Comum precedido por um componente Definir Variável.

Na subcategoria Recursos Específicos do Canal, há exemplos de uso de extensões disponíveis para canais do Slack e do Microsoft Teams.

O componente Feedback do Usuário permite coletar dados de feedback para Insights apresentando aos usuários uma escala de classificação depois que eles concluírem um fluxo transacional. Os usuários não podem alterar sua classificação porque o componente Feedback do Usuário não permite entrada fora da ordem. Se você estiver usando o SDK 21.10 ou posterior, esse componente gerará um sistema de classificação por estrelas horizontal.

Embora seja possível alterar o comportamento desse componente usando as propriedades do componente, você pode alterar sua aparência ao usar o SDK (versão 21.10 ou posterior). Por exemplo, você pode substituir os ícones de estrela padrão usados para os botões de feedback por outro ícone.

Esse componente pode retornar as seguintes ações:

Você pode usar as seguintes variáveis do sistema para a saída de mensagens pelos estados de transição:

• system.userFeedbackRating - Retorna a classificação do usuário.
• system.userFeedbackText - Quando enableTextFeedback é definido como true, sua habilidade pode solicitar feedback quando as classificações ficam abaixo do valor threshold. system.userFeedbackText retorna a entrada do usuário (${system.userFeedbackText.value}).

O texto de exibição padrão do componente é armazenado em entradas de pacote de recursos. Essas entradas do bundle têm texto padrão, mas você pode personalizá-las. Veja a seguir as entradas deste componente:

Copia valores de uma variável para outra.

As definições dessas propriedades não precisam espelhar umas às outras. Embora você possa definir variáveis de destino e de origem como listas de variáveis, também pode definir a variável de origem com uma única variável e o destino como lista. Se você definir uma variável de destino adicional, ela herdará o valor da variável do valor de origem subsequente especificado.

Esse componente redefine os valores das variáveis especificadas como nulos.

O componente Definir Variável define o valor de uma variável predefinida.

O componente Detectar Idioma usa o serviço de tradução para detectar o idioma do usuário na entrada do usuário.

Esse componente define uma variável chamada profile.languageTag com a string de configuração regional. Você pode definir variáveis com o idioma atual quando usa essa variável em uma expressão de valor (${profile.languageTag}).

Este componente envia o texto especificado para o serviço de tradução da habilidade e, em seguida, armazena a tradução em inglês. Ele utiliza a habilidade que está sendo configurada com um serviço de tradução, que reconhece o idioma da entrada do usuário e o traduz em inglês. Este componente não funciona com habilidades que usam o modo de idioma Suportado Nativamente.

Use esse componente quando precisar processar o texto de entrada bruto antes de traduzi-lo. Por exemplo, talvez você queira remover alguns dados pessoais da entrada do usuário antes de enviá-la ao serviço de tradução.

Como esse componente utiliza o serviço de tradução, que já detecta o idioma do usuário, ele não precisa seguir estados que detectem ou definam o idioma.

O componente Converter saída permite traduzir texto especificado para o idioma do usuário. O componente assume o valor definido para a propriedade Expressão. Ele usa o serviço de tradução da habilidade para traduzir o texto no idioma detectado pelo componente Detectar Idioma ou pela variável profile.locale e o armazena na variável especificada pela propriedade Variável.

Este componente não funciona com habilidades que usam o modo de idioma Suportado Nativamente.

O componente Entidade de Correspondência chama o Mecanismo de Intenção para extrair informações de entidade do texto mantido pela propriedade Variável de Origem. Se houver uma correspondência para o tipo de entidade variável, a variável especificada pela propriedade Variável será definida com esse valor de entidade.

Esse componente também tem duas transições predefinidas: match e nomatch.

Use esse componente para obter o código de autorização para serviços protegidos pelo fluxo de concessão do código de autorização, como LinkedIn, Twitter, Google ou Microsoft. Os componentes personalizados da habilidade podem trocar o código de autorização por um token de acesso, que depois eles usam para chamar o serviço final.

O componente primeiro direciona o usuário para a página de log-in do provedor de identidades. Após um log-in bem-sucedido, o componente retorna o código de autorização em uma variável, que você usa para transmitir o código de autorização ao componente personalizado. A API do componente personalizado deve trocar o código de autorização, o ID do cliente e o segredo do cliente por um token de acesso do usuário OAuth.

Para cada estado que exija autorização antes de ser chamado, defina sua definição Exige Autorização como True. Consulte Autorização do Usuário para obter as etapas para configurar isso.

${(system.message.channelConversation.channelType=='twilio')?then('false','true')}

Esse componente pode retornar as seguintes ações:

O texto de exibição padrão do componente é armazenado em entradas de pacote de recursos. Essas entradas do bundle têm texto padrão, mas você pode personalizá-las. Veja a seguir as entradas deste componente:

Consulte Modificar uma Entrada de Pacote de Recursos para obter as etapas para alterar a mensagem padrão de uma entrada de pacote de recursos.

Quando o mecanismo de caixa de diálogo encontra esse componente, o bot de habilidades solicita ao usuário com dois links — Log-in e Cancelar.

Descrição da ilustração fb-oauth.png

Há várias formas de fazer a transição desse componente:

• O usuário clica no botão Cancelar e o componente muda para o estado denominado pela ação fail.

• O usuário não clica em qualquer botão, mas digita texto. O componente muda para o estado nomeado pela ação textReceived.

• O usuário clica no link de log-in e o canal renderiza a página de log-in do provedor de identidades ou sua caixa de diálogo de autenticação como webview, conforme mostrado no exemplo a seguir. Após a autorização bem-sucedida, o componente muda para o estado nomeado pela ação pass (ou para o próximo estado se não houver uma ação pass), que normalmente chamaria um componente personalizado que troca o código de autorização por um token de acesso.

Descrição da ilustração webview-login.png

Se a janela de teste não renderizar a webview, recorte e cole o texto do link no browser.

Use esse componente para obter um token de acesso do usuário OAuth2 (tipo de concessão Código de Autorização) para recursos protegidos pelo OCI IAM, Oracle Access Manager (OAM), plataforma de identidade da Microsoft ou autorização do Google OAuth 2.0. Esse componente conclui todas as etapas do fluxo de 3 fases do OAuth2 e retorna o token de acesso do OAuth2.

Para cada estado que exija autorização antes de ser chamado, defina sua definição Exige Autorização como True. Consulte Autorização do Usuário para obter as etapas para configurar isso.

Se você precisar obter um token de acesso do tipo de concessão Credenciais do Cliente para acessar recursos do cliente, consulte OAuth 2.0 Client.

Para poder usar esse componente em uma habilidade, execute as seguintes tarefas:

1. Caso ele ainda não esteja registrado, registre o cliente no provedor de identidades, conforme descrito em Registro do Provedor de Identidades.
2. Adicione um serviço de autenticação para o provedor de identidades, conforme descrito em Serviços de Autenticação.

Alguns provedores de identidade emitem tokens de atualização. Quando você usa esse componente, o Digital Assistant armazena o token de atualização durante o período de retenção especificado para o serviço de autenticação. O backend do Digital Assistant pode usar o token de atualização, se disponível, para obter um novo token de acesso sem que o usuário tenha de acessar novamente.

${(system.message.channelConversation.channelType=='twilio')?then('false','true')}

Esse componente pode retornar as seguintes ações:

O texto de exibição padrão do componente é armazenado em entradas de pacote de recursos. Essas entradas do bundle têm texto padrão, mas você pode personalizá-las. Veja a seguir as entradas deste componente:

Consulte Modificar uma Entrada de Pacote de Recursos para obter as etapas para alterar a mensagem padrão de uma entrada de pacote de recursos.

Quando o mecanismo de caixa de diálogo encontra o componente, o bot de habilidades solicita ao usuário dois links: Obter um Token de Acesso e Cancelar (você pode usar linkLabel e cancelLabel para alterar o texto do link).

Se o usuário clicar no link para obter um token de acesso, ele exibirá a página de log-in do provedor de identidades ou a caixa de diálogo de autenticação, conforme especificado pelo serviço de autenticação. Após o log-in bem-sucedido, ele obtém o token de acesso, define os valores das variáveis identificadas por accessTokenVariableName e authenticatedUserVariableName e, em seguida, vai para o estado denominado pela ação pass (ou para o próximo estado, se não houver uma ação pass). Se o usuário cancelar, a ação de postback será definida como fail. Se o usuário digitar texto, ele retornará a ação textReceived.

Como mencionado anteriormente, você pode definir requiresAuthorization para um estado para garantir que o usuário esteja autorizado antes de chamar o componente do estado. Se o usuário ainda não tiver autorizado, a caixa de diálogo chamará o evento Autorizar Usuário.

Use esse componente para obter um token de acesso do OAuth2 do tipo de concessão Credenciais do Cliente. Ou seja, você o utiliza para obter um token de acesso com base nas credenciais do cliente, e não no nome do usuário e na senha. Você pode usar esse componente para obter um token que permita o acesso aos recursos do cliente protegidos pelo Oracle Identity Cloud Service ou Oracle Access Manager (OAM).

Se você precisar acessar recursos em nome de um usuário, consulte OAuth 2.0 Account Link e OAuth Account Link.

Para poder usar esse componente em uma habilidade, execute as seguintes tarefas:

1. Caso ele ainda não esteja registrado, registre o cliente no provedor de identidades, conforme descrito em Registro do Provedor de Identidades.
2. Adicione um serviço de autenticação de credenciais do cliente para o provedor de identidades, conforme descrito em Serviços de Autenticação.

Esse componente não tem qualquer ação. Para tratar os problemas do sistema que possam ocorrer, adicione uma próxima transição que vá para um estado que possa tratar esses erros.

Use esse componente para revogar todos os tokens de atualização e de acesso do usuário conectado do provedor de identidades que o serviço de autenticação representa. Ele também remove os tokens de atualização do banco de dados. Para usar esse componente, informe o URL do token de atualização de revogação do provedor de identidades na IU do Serviço de Autenticação.

A habilidade deve incluir um estado que use o componente OAuth 2.0 Account Link para o mesmo serviço de autenticação e deve ser chamada antes do estado que usa esse componente.

Este componente pode retornar a seguinte ação:

Use esse componente para alternar estados com base em um valor de variável.

Este componente determina um caminho de execução resolvendo uma variável ou expressão e, em seguida, acionando uma ação de transição correspondente mapeada para um estado no fluxo.

Defina e mapeie as ações de transição na guia Transições do inspetor de propriedades.

Com esse componente, você chama um fluxo filho do fluxo atual, opcionalmente transmitindo parâmetros de entrada. Quando o fluxo filho é concluído, ele retorna uma ação e parâmetros de saída opcionais para seu fluxo pai.

As ações de transição que podem ser definidas dependem das ações definidas no componente Fluxo Final do fluxo filho.

Com esse componente, você chama o fluxo de uma habilidade diferente, opcionalmente informando parâmetros de entrada. Quando o fluxo chamado é concluído, ele retorna uma ação e parâmetros de saída opcionais para o fluxo de chamada.

Antes de usar esse componente, deve haver um fluxo público disponível na habilidade que você está chamando. Consulte Chamar Outra Habilidade de um Fluxo.

ParamName: ParamValue

Este componente é usado para finalizar explicitamente um fluxo.

Quando esse estado é atingido, todas as variáveis do fluxo são limpas e o controle é retornado ao fluxo pai (ou, se não houver um fluxo pai, o Fluxo Principal).

Você não precisará de um estado de Fluxo Final para um fluxo se não precisar retornar parâmetros ou ações do fluxo para um fluxo pai ou para o Fluxo Principal.

Este modelo consiste nos componentes Iniciação do Agente e Conversa do Agente. Você usa esses componentes juntos para transferir a conversa de uma habilidade para um agente do Oracle B2C Service.

• O componente Iniciação do Agente inicia o handshake com o canal de integração do agente especificado pela propriedade Canal de Integração do Agente do componente.
• O componente Conversa do Agente gerencia o intercâmbio entre a habilidade e o agente ativo.

Esse modelo destina-se às conversas originadas na habilidade. Não use este modelo para conversas originadas no chat do Oracle B2C Service, conforme descrito em O Digital Assistant as Agent Framework em Ação.

Use o componente de transferência do Agente nos assistentes digitais DA-as-agent para transferir a conversa de volta para o serviço de chat. A conversa será roteada para um agente ao vivo de acordo com as regras de chat configuradas no serviço de chat.

Esse componente se destina a conversas originadas em um chat de serviço, conforme descrito em O Digital Assistant as Agent Framework em Ação. Para conversas originadas na habilidade, use o modelo de Comunicação do Agente.

Você pode usar o componente Condição de Transferência do Agente nos assistentes digitais DA-as-agent para determinar se os agentes estão disponíveis e, em caso afirmativo, o tempo de espera esperado.

Você usa as propriedades do componente para especificar as condições de transferência e retorna uma ação que indica se as condições foram atendidas. Além disso, ele define os valores da variável de mapa nomeada.

Esta é a estrutura do valor da Variável de Status de Disponibilidade do Agente e as informações armazenadas nela:

queueId (integer, optional): The engagement queue ID,
expectedTotalWaitSeconds (integer, optional): Expected wait time in the queue in seconds
        ( -1 if there's inadequate information, zero or greater otherwise ).,
expectedWaitSeconds (integer, optional): The number representing the "ss" segment of the expected wait time of format mm:ss 
        ( -1 if there's inadequate information, zero or greater otherwise ).,
expectedWaitMinutes (integer, optional): The number representing the "mm" segment of the expected wait time of format mm:ss 
        ( -1 if there's inadequate information, zero or greater otherwise ).,
availableAgentSessions (integer, optional): Total number of sessions available across all agents.,
totalAvailableAgents (integer, optional): Total number of agents whose status is available.,
totalUnavailableAgents (integer, optional): Total number of agents whose status is unavailable.,
totalAgentsRequestingNewEngagement (integer, optional): Total number of agents who are available and have capacity.
outsideOperatingHours (boolean, optional): True if outside operating hours. False if inside operating hours.,
engagementsInQueue (integer, optional): The number of engagements currently in the queue.
sessionId (string, optional): The session ID.,
clientId (integer, optional): The client ID.

This might take {minutes, plural,
     =-1 {}
     =0 {}
     =1 {1 minute and }
     other {# minutes and }
}{seconds, plural,
     =-1 {a while}
     =0 {{minutes, plural,
          =0 {a short wait time}
          other {0 seconds}
        }}
     =1 {1 second}
     other {# seconds}
} to connect. Are you willing to wait?

Use esse componente para enviar uma solicitação HTTP a um ponto final REST que você configurou nas definições de Serviços de API.

Estas são as propriedades do componente:

O componente retorna estas ações:

Para saber mais, consulte Acessar Backends Usando o Componente de Serviço REST.

Use este componente para pesquisar o Oracle B2C Service Knowledge Foundation ou o Oracle Fusion Service Knowledge Management para obter informações sobre um determinado termo de pesquisa e exibir os resultados.

Para o Oracle B2C Service, os resultados da pesquisa dependem se as respostas são públicas e quais são as definições de nível de acesso, produto ou categoria.

Observe que você deve criar um serviço de pesquisa de conhecimento para poder usar este componente. Consulte Adicionar um Serviço de Pesquisa de Conhecimento.

Estas são as propriedades do componente da Pesquisa de Conhecimento:

Use o modelo de Criação de Incidente para criar um relatório de incidentes em um local de atendimento ao cliente. Observe que você deve criar uma integração de atendimento ao cliente na página Definições > Serviços Adicionais > Integração de Atendimento ao Cliente para poder usar esse componente em sua instância.

Use esse componente para acessar uma entrevista do Oracle Intelligent Advisor de uma habilidade.

Crie uma integração de serviço do Intelligent Advisor para poder usar esse componente. Consulte Adicionar um Serviço do Intelligent Advisor. Além disso, a entrevista deve ter sido implantada no Intelligent Advisor Hub e ativada no canal de serviço de chat. A entrevista deve ser para usuários anônimos. Não é possível acessar entrevistas para usuários do portal ou usuários do agente.

Você pode usar as propriedades do componente para especificar as seguintes definições de entrevista:

• Se os títulos e a explicação serão exibidos
• Os labels dos botões sim, não e incerto
• As strings que o usuário digita para redefinir, retornar à pergunta anterior (desfazer) e sair da entrevista
• O texto a ser exibido no final da entrevista
• Como formar as frases da pergunta sobre se a explicação deve ser exibida
• A string que o usuário digita para indicar a conclusão do upload dos arquivos
• Os valores de atributo e os parâmetros de conector a serem transmitidos à entrevista
• A localidade do projeto a ser usada

O componente Webview abre um webview na sua habilidade ou para habilidades que são executadas em um canal Web, em uma guia do browser.

Você usa esse componente para enviar uma notificação a um usuário quando ocorreu um evento baseado em Nuvem de um tipo registrado no Oracle Digital Assistant. Consulte Eventos Externos para obter informações sobre como registrar tipos de evento e configurar um assistente digital para consumir o evento.

Use esse componente para publicar externamente um evento baseado em Nuvem de um tipo que foi registrado no Oracle Digital Assistant. Consulte Eventos Externos para obter informações sobre o registro de tipos de evento e a configuração de um assistente digital para publicar e consumir eventos.

Veja um exemplo de payload que pode ser usado como o valor da propriedade Dados:

{
    "size": "Large",
    "type": "Veggie"
}

        "system.postbackActions": {
          "small": {
            "postback": {
              "variables": {
                "size": "Small"
              },
              "system.botId": "44F2405C-F317-4A3F-8250-617F54F01EA6",
              "action": "Small",
              "system.state": "size"

Nesse ponto, o sistema compara a propriedade system.state no payload da ação de postback de entrada com o estado atual. Quando os dois não correspondem, a habilidade executa uma transição que pode, dependendo de como você configura seu fluxo de caixas de diálogo, respeitar a solicitação do usuário ou negá-la.

Você pode alterar o comportamento padrão do tratamento de mensagens fora da ordem mapeando o evento de transição do sistema Mensagem Fora da Ordem para um componente Chamar Fluxo que chama um fluxo fornecido para tratar mensagens fora da ordem.