Integrações de Script

Você pode criar suas próprias ações de script em Bot Builder. Isso permite personalizar como o bot responde nas conversas. As ações de script são ações personalizadas de bot que você pode usar em diálogosClosed Histórias, regras e fluxos no Bot Builder. para definir as respostas do bot durante as conversas.

As ações de script são criadas em integrações de script em Bot Builder. As integrações de script oferecem suporte a JavaScript. Cada integração de script pode ter mais que uma ação. Quando uma ação é habilitada, ela fica disponível no menu de ações do bot quando você adiciona uma resposta do bot a uma storyClosed Usado para treinar um bot para o tratamento de interações com base na intenção e no contexto., regraClosed Usadas para definir uma resposta de bot a mensagens que não mudam com o contexto. ou fallbackClosed Uma alternativa em texto simples enviada quando o destino não oferece suporte a mídia avançada..

A lista a seguir fornece exemplos de algumas maneiras de se usar as ações de script:

  • Crie código para projetar uma ação de bot que atenda às exigências específicas da sua organização.
  • Denomine a sua própria API externa como uma ação de script.
  • Adicione Scripts às competências de bot e publique-as na Skill Store.

Bot Builder scripts são executados no servidor, portanto há algumas limitações a serem consideradas ao criar seus scripts.

Editor de scripts

Uma integração de script pode ter mais de uma ação. Cada ação tem o seu próprio script. Você pode acessar o editor de script nas propriedades de cada ação.

No editor, você pode Enter o código à esquerda e, em seguida, clique no triângulo de execução Uma seta triangular apontando para a direita. para visualizar os resultados no painel Console.

Use AI to Create or Edit a script

O conteúdo desta seção é destinado a um produto ou recurso que está em um programa de pré-visualização pública. Se você não faz parte da pré-visualização e gostaria de obter mais informações, contate seu representante de conta.

Use a Script editorguia para exibir o Agente Copilot, onde você pode interagir usando linguagem natural para criar, entender e modificar scripts de forma mais eficiente. Com o Agente Copilot no Script editor, você pode:

  • Gere novos scripts usando prompts de linguagem natural.

  • Edite scripts existentes solicitando ao Agente Copilot que adicione validações, condições ou lógica.

  • Compare sugestões de código, visualize comparações lado a lado do seu código original e do código gerado pelo Agent Copilot.

  • Aceitar ou Rejeitar as sugestões de Copilot com um único clique.

  • Quando o Agent Copilot gera scripts que fazem referência a novas variáveis (slots), estes são criados automaticamente e refletidos na seção Slots.

  • Prompts com várias interações, em que você pode fazer perguntas de acompanhamento ou refinar seu prompt para melhorar o script de forma iterativa.

  • Recolher o painel do Copilot Agente para uma visualização de edição mais limpa.

Um desenvolvedor de bot está criando um script para validar a entrada de um usuário para um número de conta. Em vez de escrever manualmente a lógica de validação, o desenvolvedor usa o Agent Copilot no Script editor.

O desenvolvedor digita um Prompt: “Você pode adicionar validação para verificar se o número de conta tem 10 dígitos?”

Agente Copilot gera um script com a lógica de validação apropriada.

O desenvolvedor revisa as alterações sugeridas, compara-as com o código original e clica em Aceitar para aplicar a atualização.

O agente Copilot também detecta que um novo slot accountNumber é referenciado e o adiciona automaticamente à seção Slots.

O desenvolvedor continua refinando o script ao fazer perguntas de acompanhamento como:

"Adicionar uma mensagem de erro se a entrada for inválida."

Script Variáveis

Você pode criar variáveis para usar em scripts Bot Builder. As Variáveis podem armazenar um valor para ser usado em outro local do script. Elas só podem ser usadas na integração de script em que você as cria, mas você pode usá-las em qualquer um dos scripts dessa integração.

Não é possível alterar os valores de variáveis no script. Elas só podem ser modificadas na página de integração do script ou quando uma ação que faz referência à variável é usada em uma resposta de bot em uma storyClosed Usado para treinar um bot para o tratamento de interações com base na intenção e no contexto., regraClosed Usadas para definir uma resposta de bot a mensagens que não mudam com o contexto. ou fallbackClosed Uma alternativa em texto simples enviada quando o destino não oferece suporte a mídia avançada..

Para usar uma variável em uma ação:

  • É necessário que o script da ação faça referência à variável.
  • Ele deve ser editável nessa ação, caso você quiser alterar o valor.

Os scripts do Bot Builder são compatíveis com quatro tipos de variáveis:

  • Texto: As variáveis de texto contêm valores de string simples. Uma variável de texto editável torna-se um campo na IU da ação de script, onde é possível digitar texto no campo para atribuir um valor à variável.
  • Number: As variáveis do tipo número contêm valores numéricos. Uma variável numérica editável torna-se um campo na IU da ação de script, onde é possível digitar um número no campo para atribuir um valor à variável.
  • Selecionar: Use variáveis de seleção quando desejar definir múltiplos valores possíveis para a variável. Uma variável selecionada se torna uma lista suspensa na IU da ação de script. As opções da lista suspensa são definidas no campo Valores, na definição da variável da guia Scripts.
  • Secreto: Use variáveis secretas para armazenar dados privados, como tokens ou credenciais de API. Depois que tiver digitado o valor, o Bot Builder irá mascarar todos os caracteres, exceto os cinco primeiros, com asteriscos ( * ). O valor é somente leitura e não pode ser substituído ou alterado pelo script ou por meio da ação de script. Se precisar alterá-lo, você deve atualizar o valor na página variável no script. variáveis SECRETAS não podem ser tornadas editáveis.

Você pode definir um valor padrão para variáveis de texto, número e seleção. Quando a variável é editável, o valor padrão pode ser substituído ao selecionar ou inserir um valor diferente quando você adiciona a ação a uma resposta de bot. Quando a variável não é editável, mas é referenciada em um script de uma ação, o valor padrão é usado, caso ele exista. Caso nenhum padrão tenha sido designado, a variável não terá valor no script.

As variáveis que você cria são adicionadas ao objeto Variables object na integração script.

Objetos e funções padrão

Além das funcionalidades JavaScript padrão, o Bot Builder possui a seguinte estrutura específica para bot:

  • O objeto Bot fornece uma maneira alternativa de criar como seu bot responde nas conversas.
  • O objeto Store permite manter as informações de contexto para uma execução de script.
  • O objeto Variáveis contém todas as variáveis que você adiciona à integração do script.
  • A função fetch é uma implementação do JavaScript fetch padrão.
  • O console permite a depuração.

Como os scripts do Bot Builder operam no servidor, há algumas limitações a serem consideradas ao criar seus scripts.

Objeto Bot

O objeto Bot contém métodos que acionam ações de script. Ao escrever um script, o editor da Web solicita todos os métodos disponíveis, incluindo seus argumentos e tipos. Os métodos a seguir estão disponíveis ao usar o objeto Bot:

Muitos métodos no objeto Bot podem ser opcionalmente personalizados com um parâmetro options. Options pode ser fallbackText (fallback) ou typing (smart typing). Os valores possíveis para typing são 1, 2 ou 3.

Options = {
	"fallbackText": "this is the fallback text",
	"typing": 2,
}

sendMessage

Insira uma mensagem de texto simples para o bot enviar. Utilize o formato .sendMessage(text: string, options: Options): void. O options parâmetro não é obrigatório.

Bot.sendMessage('This is message written by bot')

sendAdaptiveCard

Insira a carga útil para o Adaptive Card que quer enviar. Utilize o formato .sendAdaptiveCard(adaptiveCard: AdaptiveCardPayload, options: Options): void. O options parâmetro não é necessário.

Você pode encontrar a carga útil para o seu cartão adaptável no criador de Adaptive Card. Em Bot Builder, vá para Preferências > Adaptive Cards e, em seguida, copie o conteúdo do painel Card Payload editor. Você pode saber mais sobre como trabalhar comAdaptive Cards em Bot Builder.

Bot.sendAdaptiveCard(<Valid_Adaptive Card_JSON_Payload>)

sendButtons

Configure e envie até três botões. Todas as configurações dos botões podem ser organizadas definindo atributos. Use o exemplo abaixo para comparar as configurações do botão na caixa de diálogo com os atributos do script. Utilize o formato .sendButtons(text: string, buttons: ButtonPayload[], options: Options): void. O options parâmetro não é obrigatório.

Bot.sendButtons('This is message written by bot', [
{
	title: 'Button 1',
	intent: {
		name: 'mood'
	}
}
])

Você também pode acionar entityValue, texto ou url por meio do seu script.

A combinação desses atributos pode resultar em um erro ou comportamento inesperado.

// triggers intent
{
	title: 'Title',
	intent: 'mood'
}

// triggers intent with entity value
{
	title: 'Title',
	intent: {
		name: 'mood',
		entity: 'myEntity',
		value: 'entity value'
	}
}

// url
{
	title: 'Title',
	url: 'https://www.nice.com'
}

// text
{
	title: 'Title',
	text: 'This is a text'
}

sendQuickReplies

Configure e envie até três respostas rápidas. Todas as configurações de resposta rápida podem ser organizadas definindo atributos. As opções de respostas rápidas são iguais às opções de botões. Utilize o formato .sendQuickReplies(text: string, quickReplies: QuickReplyPayload[], options: Options): void. O options parâmetro não é obrigatório.

Bot.sendQuickReplies('This is message written by bot', [
{
	title: 'Quick reply 1',
	intent: {
		name: 'mood'
	}
}
])

Você também pode acionar o valor de value da entidade, text ou url por meio do seu script.

A combinação desses atributos pode resultar em erro ou comportamento inesperado.

// triggers intent
{
	title: 'Title',
	intent: 'mood'
}

// triggers intent with entity value
{
	title: 'Title',
	intent: {
		name: 'mood',
		entity: 'myEntity',
		value: 'entity value'
	}
}

// url
{
	title: 'Title',
	url: 'https://www.nice.com'
}

// text
{
	title: 'Title',
	text: 'This is a text'
}

sendCards

Configure e envie até 10 cards. Utilize o formato .sendCards(cards: CardPayload[], options: Options): void. O options parâmetro não é obrigatório.

Bot.sendCards([{
	title: 'Card title',
	description: 'Card description',
	image: 'https://picsum.photos/200/300',
	mimetype: 'image/jpeg',
	button: {
		title: 'Button title',
		url: 'https://www.nice.com/'
	}
}])

sendMultimedia

A multimídia não é validada por Bot Builder, mas pode ser validada em outras integrações. O conteúdo no url deve estar disponível durante todo o tempo em que o script for usado. Também deve ser publicamente acessível, pois será baixado repetidamente quando o script for executado. As restrições de tipo e tamanho de mídia são as mesmas de quando você usa uma ação de bot multimídia. Utilize o formato .sendMultimedia(url: string, mimetype: string, options: Options): void. O options parâmetro não é obrigatório.

Bot.sendMultimedia('https://picsum.photos/200/300', 'image/jpeg')

sendRichLink

Configure e envie um link avançado. Utilize o formato .sendRichLink(richlink: RichLinkPayload): void.

Bot.sendRichLink({
	title: 'Title',
	url: 'https://www.nice.com',
	image: 'https://picsum.photos/200/300',
	mimetype: 'image/jpeg'
})

sendListPicker

Configure e envie até 12 opções do seletor de lista. Todas as opções do seletor de lista podem ser organizadas pela configuração de atributos. As opções do seletor de lista são as mesmas opções dos botões. Utilize o formato .sendListPicker(message: string, description: string, actions: ListPickerPayload[], options: Options): void. O options parâmetro não é obrigatório.

Bot.sendListPicker('Message', 'Description', [{
	title: 'Title',
	description: 'Description',
	image: {
		url: 'https://picsum.photos/200/300',
		mimetype: 'image/jpeg'
	}
	intent: {
		name: 'mood'
	}
}])

handover

Configure para onde o handoverClosed A transferência de um contato de um agente virtual para um agente ao vivo. vai usando um queueId. Isso pode permanecer null, para usar o redirecionamento automático, ou pode ser o ID de uma fila existente. Utilize o formato .handover(queueId: string, note: stringId): void. O parâmetro note é opcional, mas queueId é obrigatório.

Para localizar um queueId:

  1. Em NiCE CXone, clique no seletor de aplicativos Icon of three-by-three grid of white squares on a blue background e selecioneACD.

  2. Vá para Digital Experience (DX) > Routing Filas.

  3. Localize a fila DE espera para a qual você precisa do id e clique em Editar.

  4. Na página de edição da fila DE espera, veja a URL em seu navegador. O número após /edit/ é o queueId. Deve ter a aparência de cinco conjuntos de números e letras separados por hifens. Por exemplo, 67bf5865-4556-40db-ba44-6c0cc3f88ffa.

Bot.handover(null)
// or
Bot.handover('queueId')

addTags

Configure quais tags devem ser aplicadas. Quaisquer tags usadas no script já devem existir no Bot Builder. Se uma tag for chamada no script, mas não existir, a ação será ignorada. Utilize o formato .addTags(tags: string[]): void.

Bot.addTags(['Tag 1', 'Tag 2'])

waitForResponse

Em alguns casos, é necessário esperar por uma resposta do cliente e continuar com a execução do seu script. Como a comunicação com o cliente é assíncrona, a espera pela resposta também é assíncrona. O Bot.waitForResponse método usa um parâmetro: o nome da função que será executada após o recebimento de uma resposta. Utilize o formato .waitForResponse(functionName: string): void.

Esta função tem um comportamento adiado. Isso significa que o resultado não é efetivado imediatamente quando executado. Em vez disso, a execução de script atual deve terminar primeiro. Se você deseja que o script termine com uma função de comportamento adiada, é necessário parar explicitamente a execução do script usando uma instrução return ou condições.

function main() {
	console.log('Testing wait for response')
	Bot.waitForResponse('response') //The script continues to run and the next line executes while listening for a customer response
	console.log('This is still going to be executed')
}

function response() {
	console.log('Customer responded', Bot.slots['last customer message'].value)
}

fillSlot

Configure qual slotClosed Entidade extraída da mensagem do contato e salva para uso nas respostas do bot. Semelhante a uma variável. deve ser aplicado. Quaisquer slots usados no script já devem existir em Bot Builder. Se um slot for chamado no script, mas não existir, a ação será ignorada.

Se quiser apenas armazenar o valor para a execução do script, use uma variável de local ou use o objeto Store. Utilize o formato .fillSlot(name: string, value: any[]): void.

Para acessar o valor real do slot, você deve acessar o atributo .value.

function main() {
	Bot.fillSlot('slotName', 'slotValue');
	console.log(Bot.slots.slotName.value);
}

slots

Na notação de ponto, o editor pode solicitar slotsClosed Entidade extraída da mensagem do contato e salva para uso nas respostas do bot. Semelhante a uma variável. disponíveis, mas isso só é aplicável quando os nomes dos slots não contêm espaços ou caracteres especiais. Nos casos em que os nomes de slot incluem espaços ou caracteres especiais, a notação de colchetes deve ser usada em vez disso.

console.log(Bot.slots)

// example
let contactId = Bot.slots['contact.id'].value
let lastCustomerMessage = Bot.slots['last customer message'].value

sendAsCustomer

Essa função permite adicionar o que o contatoClosed A pessoa que interage com um agente, Rvi ou bot em seu contact center. pode dizer nas suas históriasClosed Usado para treinar um bot para o tratamento de interações com base na intenção e no contexto. e regrasClosed Usadas para definir uma resposta de bot a mensagens que não mudam com o contexto.. Utilize o formato .sendAsCustomer(text: string): void.

Esta função tem um comportamento adiado. Isso significa que o resultado não é efetivado imediatamente quando executado. Em vez disso, a execução de script atual deve terminar primeiro. Se você deseja que o script termine com uma função de comportamento adiada, é necessário parar explicitamente a execução do script usando uma instrução return ou condições.

Bot.sendAsCustomer('Hello bot')

Objeto Store

Store é um objeto criado para armazenar dados durante a execução do script. Comparado a uma variável de local, tem a vantagem de poder ser usado em múltiplas funções .waitForResponse.

Set, get

Store.set(name: string, value: any[]): void

Store.get(name: string): any[]

function main() {
	Store.set('token', 'my-secret-token')
	Bot.waitForResponse('response')
}

async function response() {
	console.log(Store.get('token')) // my-secret-token is logged
}

Objeto variáveis

O objeto Variables contém as variáveis que você cria na integração de script. Cada variável é uma propriedade de Variables. Cada variável contém um conjunto de subpropriedades que contêm informações sobre ela.O exemplo a seguir mostra uma variável selecionada, denominada colorChoice:

"colorChoice": {
  "defaultValue": "red",
  "options": [
	"red",
	"green",
	"blue"
	],
  "type": "select",
  "value": "red",
  "name": "colorChoice"
}		

No exemplo, a lista de valores atribuídos à variável está contida na propriedade options.

Inicialmente, as propriedades defaultValue e value contêm o mesmo valor. Se você não especificar um valor padrão para uma variável select, o padrão será null. Os valores de Variável não podem ser alterados no script, mas podem ser tornados editáveis e, então, alterados quando a ação é usada em uma história ou regra.

Consulte Variáveis em um script

Consulte um valor de variável usando notação de ponto: Variables.varName.value

Consulte a lista de opções em uma variável select: Variables.varName.options

Visualizar Variáveis existentes em uma Integração de script

Você pode ver uma lista das variáveis existentes e suas propriedades no script adicionando a seguinte linha ao seu código e, em seguida, executando o script. A lista será exibida no console. O código é: console.log(Variables). Da mesma forma, você pode visualizar o conteúdo de uma única variável adicionando console.log(Variables.varName.value) ou console.log(Variables.varName.options) ao seu script.

fetch funções

fetch(url: string, ?options), sempre que possível, as opções são:

  • method - 'GET', 'POST', 'PUT', 'DELETE'
  • Cabeçalhos
  • form_params
  • json
  • Corpo

Use fetch para se comunicar com APIs. Elas podem ser qualquer uma das APIs do NiCE CXone ou sua própria.

const URL = 'https://nice.com'

async function main() {
	// 1. using async/await
	try {
		const response1 = await fetch(URL, { 'method': 'GET' })

		console.log(
			'response 1',
			response1.ok,
			response1.status,
			response1.statusText,
			response1.url,
			response1.headers
		)
		console.log('response 1', await response1.text())
	} catch (exception) {
		console.log('Error occured', exception)
	}

	// 2. using Promises
	fetch(URL, { 'method': 'GET' })
		.then(response => {
			console.log(
				'response 2',
				response.ok,
				response.status,
				response.statusText,
				response.url,
				response.headers
			)
	
			return response.text()
		})
		.then(response => {
			console.log('response 2', response)
		})
		.catch(exception => {
			console.log('Error occured', exception)
		})
	
	// 3. using fetchSync
	try {
		const response3 = fetchSync(URL, { 'method': 'GET' })
		console.log('response 3', response3)
	} catch (exception) {
		console.log('Error occured', exception)
	}
}

fetchSync

A função fetch é uma implementação padrão de fetch JavaScript, que retorna Promise e também implementa funções .json() ou .text() na resposta.

Há também uma variante síncrona fetchSync, que retorna a resposta diretamente, e não Promise. Se você quiser permanecer coerente com o mundo assíncrono do JavaScript, utilize uma função fetch padrão.

console Função

console é usado para testar seu script. Você pode registrar quaisquer dados. O resultado do log também é armazenado no histórico da conversa, mas não é enviado ao contatoClosed A pessoa que interage com um agente, Rvi ou bot em seu contact center..

log

Utilize o formato console.log(…output: any[]): void.

console.log('my log', 123, {pi: 3.14})

warn

Utilize o formato console.warn(…output: any[]): void.

console.warn('my warn', 123, {pi: 3.14})

info

Utilize o formato console.info(…output: any[]): void.

console.info('my info output', 123, {pi: 3.14})

debug

Utilize o formato console.debug(…output: any[]): void.

console.debug('my debug output', 123, {pi: 3.14})

error

Utilize o formato console.error(…output: any[]): void.

console.error('my error output', 123, {pi: 3.14})

Tratamento de erro

onError

É possível resolver erros de exceções inesperadas definindo a função onError.

let onError = (e) => console.log('my handler', e.message)
		
function main() {
	Bot.nonExistentMethod()
}

Funções de hash

Você pode usar a biblioteca CryptoJS em seus scripts no Bot Builder. Por exemplo:

const cryptojs = require('crypto-js');x
var hash = CryptoJS.SHA256("TOKEN");

Você pode saber mais sobre como trabalhar com essa biblioteca no site da documentação do CryptoJS An icon of a square with an arrow  pointing from the center out to the upper right corner..