Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

O sistema contém muitos tipos diferentes de variável que podem ser usados em habilidades para uma mensagem, uma regra, um processamento ou uma integração. Este artigo aborda como e quando essas variáveis podem ser usadas e, sobretudo, o respectivo formatoA plataforma Luma VA fornece diversas variáveis de contexto que podem ser usadas para representação em conversas de habilidade, definições de configuração e em todo o aplicativo Criador de bot.

As variáveis podem ser usadas nos cenários a seguir:

  • Executar serviços web
  • Substituir serviços web em atributosSubstituir serviços web no processamento de habilidades
  • Definir respostas de texto da habilidadeMensagem de informação interna para as respostas do bot ao usuário.

Veja a seguir uma lista dos parâmetros e cenários nos quais elas são usadas.

Tipos de variávelDescriçãoExemplosVariáveis OOTB (Out-of-the-Box - Prontas para Uso)
Atributo globalOs atributos globais armazenam dados extraídos da entrada do usuário, operações de integração de terceiros, respostas e muito mais. Os atributos globais são usados como espaços reservados em modelos de mensagem do usuário, regras, integrações, fluxos de trabalho de ação e muito mais. 

@{global.<attributeIdentifier>}

Por exemplo, @{global.itsm_ticketDescription} é usado para armazenar a descrição do ticket do ITSM, extraído da entrada do usuário.

  • @{global.itsm_instanceId} 
  • @{global.itsm_ticketDescription} 
  • @{global.itsm_ticketType} 
Atributo local
Os atributos locais são usados para armazenar dados temporariamente durante a
vida útil de uma habilidade ou operação. Diferentemente
execução da habilidade. O valor armazenado em uma variável local é retido somente até o item de conversa do prompt. Se usado após o prompt, o valor no atributo local não estará disponível. Ao contrário de um atributo global
, que é válido para toda a sessão do usuário
que pode ser usado em vários eventos e habilidades, um atributo local não está disponível fora da habilidade ou operação
em que foi definida. Os atributos locais são usados como um espaço reservado em modelos de mensagem do usuário e regras no fluxo de trabalho de ação. 
na qual está definido.

@{local.<localAttributeName>} 

Por exemplo, @{local.ticketId} é usado para armazenar a ID do ticket.

@{local.ticketId}
Atributo de usuário personalizadoAtributos de usuário personalizados armazenam Atributos de perfil do usuário definidos por um administrador de sistema. Geralmente, eles armazenam informações, como departamento, local, status VIP e muitas outras que as habilidades podem usar para regras e ramificação. Os atributos de usuário personalizados são usados como espaços reservados em modelos de mensagem do usuário, regras e muitos mais. 

@{user.<userProfileAttributeName>} 

Por exemplo, @{user.firstName} é usado para armazenar o nome do usuário no canal atual.

  • @{user.firstName} 
  • @{user.middleName} 
  • @{user.lastName} 
  • @{user.email} 
  • @{user.userName} 
  • @{user.id} 
  • @{user.phone} 
  • @{user.timezone} 
  • @{user.title} 
  • @{user.contactExternalId}  
  • @{user.roleIds} 
  • @{user.roleNames} 
  • @{user.groupIds} 
  • @{user.groupNames} 
  • @{user.languageLocale} 
  • @{user.languageName} 
  • @{user.languageDisplayName} 
  • @{user.languageCode} 

 

Parâmetros de integração externos: 

  • @{user.location} 
  • @{user.employee id} 
Atributo de canal

Um atributo de canal é usado para

 autenticar o usuário com base no canal

 armazenar os detalhes do canal usado para interagir com o bot

. Ele armazena os detalhes de autenticação do usuário

.

@{channel.<channelAttribute>}  

Por exemplo, @{channel.channelType} é usado para armazenar o tipo de canal atual, por exemplo, o WeChat.

  • @{channel.channelScopeContactId}  
  • @{channel.channelType} 
  • @{channel.channelAuthenticationId} 
  • @{channel.channelAuthenticationStatus} 
  • @{channel.channelAuthenticationMode} 
Atributo de botOs atributos de bot armazenam os atributos específicos do bot atual.

@{bot.<botAttribute>} 

Por exemplo, @{bot.name} é usado para armazenar o nome do bot atual.

  • @{bot.name 
  • @{bot.externalId}  
  • @{bot.symbol} 
  • @{bot.id} 
  • @{bot.languageLocales} 
  • @{bot.languageNames} 
  • @{bot.languageDisplayNames} 
  • @{bot.languageCodes} 
Atributos de configuração da instância do aplicativo conectado Os atributos de configuração da instância do aplicativo conectado armazenam os parâmetros configurados na instância do aplicativo conectado. Eles são utilizados como espaços reservados utilizadospara adicionar valores de parâmetro em modelos de mensagem do usuário, regras, integrações, fluxos de trabalho de ação e assim por diante. 

@{app. <parameterName>}

Por exemplo, @{app.headers.user_auth_token} é usado para armazenar o token de autenticação do usuário durante a integração do serviço web.

  • @{app.apiBaseUrl} 
  • @{app.headers.csm_app_url} 
  • @{app.headers.user_auth_token} 
Solicitação HTTP da operação do aplicativo conectadoEsse atributo contém os valores das solicitações HTTP enviadas para outros sistemas.

@{solicitação. <parametername>} 

Por exemplo, @{request.timeout} é usado para o tempo limite da solicitação em uma chamada de API durante uma conversa do bot.

  • @{request.requestUri} 
  • @{request.method} 
  • @{request.requestUrl} 
  • @{request.headers.<headerName>} 
  • @{request.path.<pathParameterName>} 
  • @{request.query.<queryParameterName>} 
  • @{request.soapBinding} 
  • @{request.soapOperation} 
  • @{request.soapEndPoint} 
  •  @{request.timeout} 
  • @{request.body} 
Resposta HTTP da operação do aplicativo conectadoEsse atributo contém os valores das respostas HTTP recebidas de outros sistemas.@{response. <parametername>} Por exemplo, @{response.statusCode} é usado para exibir o código de status da resposta em uma chamada de API durante uma conversa do bot.
  • @{response.statusCode} 
  • @{response.protocolVersion} 
  • @{response.reasonPhrase} 
  • @{response.statusLine}  
  • @{response.headers.<headerName>} 
    • @{response.body}     
                                                      
ConversaUm atributo de contexto da conversa é usado para armazenar os detalhes do atributo em uso, durante a execução da habilidade. @{conv. <parametername>} Por exemplo,  @{conv. currentAttributeName} armazena o nome do atributo que está sendo usado durante a execução de uma habilidade. 
@{conv.skillName) contém o nome da habilidade que está sendo executada como parte da conversa.
  • @{conv.currentAttributeBlackListedFileFormats}
  • @{conv.currentAttributeDefaultValue}
  • @{conv.currentAttributePattern}
  • @{conv.currentAttributeDataType}
  • @{conv.currentAttributeEnumList}
  • @{conv.currentAttributeIdentifier}
  • @{conv.currentAttributeLength)
  • @{conv.currentAttributeMaximum)
  • @{conv.currentAttributeMaximumFileSize)
  • @{conv.currentAttributeMaximumLength)
  • @{conv.currentAttributeMinimum)
  • @{conv.currentAttributeMinimumLength)
  • @{conv. currentAttributeName)
  • @{conv.currentAttributeValidFileFormats)
  • @{conv.currentAttributeRequired)
  • @{conv.skillName)
DesambiguaçãoEsses atributos contêm detalhes da desambiguação da habilidade resolvida pelo seu bot @{disamb. <attribute>}, por exemplo, nomes de @{disamb.habilidadeé usado para armazenar o nome das habilidades concorrentes que estão no intervalo de proximidade
  • @{disamb.skillConfidenceScores}
  • @{disamb.entidades)
  • @{disamb.skillDescriptions)
  • @{disamb.skillIdentifiers)
  • @{disamb.skillNames)
AcompanhamentoEsses atributos contêm detalhes dos acompanhamentos acionáveis configurados e disparados para seu tenant.

@{followup. <parametername>}, Por exemplo,  @{followup.attemptNumbers} armazena o  número de tentativas configuradas para o acionamento de acompanhamento.

  • @{followup.attemptNumbers}
  • @{followup.configurationConnectionType)
  • @{followup.configurationId)
  • @{followup.configurationName)
  • @{followup.data)
  • @{followup.extractedDataType)
  • @{followup.recordIdentifiers)
FormatoEsses atributos são usados para formatar mensagens de bot exibidas nos canais de bate-papo.

Por exemplo, @{format.lineBreak) representa o caractere de nova linha e é usado para adicionar uma quebra de linha.

  • @{format.beginBold}
  • @{format.beginItalic)
  • @{format.endBold)
  • @{format.endItalic)
  • @{format.lineBreak)
Grupo de retransferênciaO atributo Grupo de retransferência é usado para armazenar os detalhes do grupo de suporte ao qual a solicitação do usuário está atribuída.

@{retransferGroup.newGroupName} representa o nome do grupo de suporte sempre que o usuário solicita conversar com um agente de suporte.

  • @{retransferGroup.newGroupName}
Comando da habilidadeO comando Skill armazena informações sobre as habilidades usadas pelo usuário para sair da conversa com a agente virtual ou o agente de suporte, OU  para transferir a conversa para agentes de suporte.Por exemplo, @{skillcommand.abort} é usado para sair da conversa, é específico do tenant e está definido como //abort por padrão.
  • @{skillcommand.abort}
  • @{skillcommand.agentTransfer}
Agente de suporteOs atributos do agente de suporte são usados para armazenar detalhes relacionados ao agente de suporte conectado ao Console de bate-papo do agente para auxiliar os usuários com a solicitação.@{supportagent. <attribute>} ,Por exemplo, @ {supportagent.firstName} é usado para armazenar o nome do Agente de suporte.
@{supportagent.groupNames} armazena os grupos de suporte dos quais o agente de suporte faz parte.

  • @{supportagent.contactExternalId}
  • @{supportagent.email}
  • @{supportagent.firstName}
  • @{supportagent.groupIds}
  • @{supportagent.groupNames}
  • @{supportagent.id}
  • @{supportagent.languageCode}
  • @{supportagent.languageDisplayName}
  • @{supportagent.languageLocale}
  • @{supportagent.languageName}
  • @{supportagent.lastName}
  • @{supportagent.middleName}
  • @{supportagent.phone}
  • @{supportagent.roleIds}
  • @{supportagent.roleNames}
  • @{supportagent.timezone}
  • @{supportagent.title}
  • @{supportagent.userName}
Bate-papo com agente de suporteO bate-papo do agente de suporte armazena os detalhes da conversa entre o usuário final e o agente de suporte

@{supportagentchat.transcriptJson} armazena a transcrição da conversa entre o usuário final e o agente de suporte no formato JSON

  • @{supportagentchat.transcriptJson}
Grupo de suporteOs atributos do grupo de suporte são usados para armazenar detalhes relacionados ao grupo de suporte selecionado

@{supportgroup. <attribute>}, Por  exemplo @{supportgroup.memberCount) representa o número total de agentes de suporte no grupo de suporte selecionado.

  • @{supportgroup.groupExternalId}
  • @{supportgroup.memberCount}
  • @{supportgroup.name}
  • @{supportgroup.usedFor}
  • @{supportgroup.id}
Comandos do sistemaOs comandos do sistema são usados para disparar uma ação do sistema

@{systemcommand.skip}, O comando Skip é usado para determinar se o usuário final solicitou ignorar o prompt durante a execução da habilidade.

  • @{systemcommand.skip}
TenantOs atributos de tenant são usados para armazenar informações relacionadas ao tenant ao qual o usuário está conectado.@{tenant. <attribute>} ,Por exemplo, @ {tenant.name} é usado para armazenar Nome do tenant
  • @{tenant.externalId}
  • @{tenant.name}
  • @{tenant.symbol}
  • @{tenant.tenantId}


Pesquisas inteligentes

A Luma fornece um recurso de pesquisa inteligente que permite ao administrador do sistema/desenvolvedor acessar rapidamente as variáveis de contexto

Isso ajuda a evitar ter que digitar manualmente, lembrar o formato e consultar a documentação da API. Ele permite que você pesquise diretamente os atributos disponíveis para sua habilidade. Os atributos são agrupados em várias categorias para ajudar a identificar rapidamente o atributo necessário.

Digite @ para invocar o pop-up de pesquisas inteligentes de modo a ver a lista de categorias das variáveis de contexto.   

Os resultados são exibidos em ordem alfabética de A a Z. Você pode pesquisar ou rolar pelo conjunto de resultados e selecionar a variável de contexto necessária. O item selecionado será preenchido no respectivo campo.


Image Added


Info
titleInformações

O recurso Pesquisas inteligentes está disponível em Habilidades do sistema, Conversa trivial, Skill Builder, Integrações, Configurações de bot e Definições do tenant