Para hospedar o pacote de componentes personalizados do Oracle Digital Assistant como um serviço de componente incorporado, primeiro você deve compactar os componentes personalizados em um arquivo TGZ. Em seguida, quando você criar o serviço de componente incorporado, faça upload desse arquivo.

Esse arquivo TGZ, que você compacta usando bots-node-sdk pack, deve conter os ativos e a estrutura descritos em Implementar Componentes Personalizados. Ele também deve conter todos os módulos de nó dos quais ele depende (o bots-node-sdk pack faz isso para você).

Para preparar um pacote para upload no serviço de contêiner incorporado:

1. Certifique-se de ter a versão mais recente das ferramentas de linha de comandos do Bots Node.js.

   O contêiner incorporado requer que o arquivo TGZ inclua todas as dependencies. As versões anteriores não incluíam dependencies no arquivo. Agora, o comando que você usará para criar o arquivo TGZ garante que o seu arquivo package.json contenha um nó bundledDependencies que lista todos os módulos dependentes que precisam ser incluídos no arquivo TGZ.

2. No diretório que contém o arquivo main.js, execute o comando a seguir para todos os módulos dos quais seu pacote depende. Não é necessário fazer isso para devDependencies, como o Bots Node SDK.

   Esse comando adiciona o módulo à pasta node_modules e o adiciona como dependência em package.json.

   npm install <module>

   Se seu package.json já nomear todas as dependências, você poderá executar npm install.

3. Certifique-se de que a pasta de nível superior contém um arquivo .npmignore com uma entrada *.tgz. Por exemplo :

   *.tgz
   spec
   service-*

   Caso contrário, ao compactar os arquivos em um arquivo TGZ, você incluirá o arquivo TGZ que já existe na pasta de nível superior e seu arquivo TGZ dobrará de tamanho. Depois de compactar os arquivos algumas vezes, o arquivo TGZ ficará muito grande para ser submetido a upload para o contêiner.

4. Execute este comando:

   bots-node-sdk pack

   Este comando valida o pacote de componentes, atualiza-o para incluir devDependencies se necessário e, em seguida, cria um arquivo TGZ, do qual você fará upload quando criar um serviço de componente incorporado na guia Componentes da habilidade. Observe que os arquivos listados como dependencies são incluídos como bundledDependencies, com exceção do Bots Node SDK e do Express, que são devDependencies.

Seu pacote deve ser compatível com o Nó 14.17.0.

Para obter mais informações sobre o comando pack, consulte https://github.com/oracle/bots-node-sdk/blob/master/bin/CLI.md.

Depois de compactar um pacote de componentes personalizados em um arquivo TGZ, você pode submetê-lo a upload para criar um serviço de componente incorporado na guia Componentes da habilidade.

Para saber como criar o arquivo TGZ, consulte Preparar o Pacote para um Serviço de Contêiner Incorporado.

Para criar o serviço de componente incorporado:

1. Na habilidade, clique em Componentes .

2. Clique em .

3. Selecione Contêiner Incorporado.

4. Clique em Fazer Upload de um arquivo de pacote de componentes e aponte para o arquivo TGZ para upload ou arraste o arquivo para a caixa Arquivo de Pacote.

5. (Opcional) Se você quiser enviar instruções context.logger() de componente personalizado para o log do serviço, alterne Ativar Registro em Log do Componente para Ativado. Essa alternância só está disponível em instâncias do Oracle Digital Assistant provisionadas no Oracle Cloud Infrastructure (às vezes chamadas de infraestrutura de nuvem Geração 2).

   Você pode ver o log na guia Componentes clicando em Diagnóstico > Exibir Logs.

   Observação
   
   A habilidade mantém uma entrada de log por dois dias. Quando você exclui um serviço de componente personalizado incorporado, as entradas de log da habilidade desse serviço são excluídas.

6. Clique em Criar.

   O Digital Assistant faz upload do arquivo TGZ e cria o serviço de componente incorporado. Durante o upload, o Digital Assistant verifica se o pacote é válido e pode rejeitar o pacote pelos motivos descritos posteriormente nesta seção.

   Após o upload do arquivo TGZ, o serviço de componente personalizado é construído e seus componentes são implantados. Se a página Componentes exibir uma mensagem de espera de implantação depois que você fizer upload do arquivo TGZ, isso significará que o serviço foi criado, mas ainda não está disponível. Quando o serviço se tornar disponível, os metadados de implantação serão exibidos no lugar da mensagem sobre a espera da implantação.

7. Certifique-se de que a opção Serviço Ativado esteja ativado.

Durante o upload, o o Digital Assistant pode rejeitar o pacote. Aqui estão os motivos para a rejeição e maneiras de resolver os problemas.

• JavaScript contém erros de sintaxe: Se o JavaScript de um componente tiver erros de sintaxe, esse componente não será adicionado ao contêiner, o que resultará nesta mensagem de erro:

  Error Message: failed to start service built: Invalid component
        path:

  Exiba os arquivos de componente em um editor que detecte erros de sintaxe. Além disso, tente hospedar o pacote em um servidor local que envia mensagens de erro para um log de console.

  Outro motivo para esta mensagem pode ser que o pacote não contém todas as dependências do módulo do nó. Consulte o próximo item desta lista.

• Módulos de nó ausentes: Se o pacote não contiver todas as dependências do módulo de nó, você receberá a mesma mensagem de erro acima:

  Error Message: failed to start service built: Invalid component
        path:

  Para saber como incluir dependências do módulo de nó, consulte Preparar o Pacote para um Serviço de Contêiner Incorporado.

• O nome do componente é muito longo: Se o nome de um componente tiver mais de 100 caracteres, começar com System., ou contiver caracteres que não sejam alfanuméricos e sublinhados, a criação do serviço falhará.

  Altere o nome no JavaScript do componente, compacte o componente novamente e repita o upload.

• Limite de serviço do componente excedido: Se sua instância já tiver o número máximo de serviços de componente personalizado incorporado, a criação do serviço falhará. Peça ao administrador de serviço o limite embedded-custom-component-service-count conforme descrito em Exibir Limites de Serviço na Console de Infraestrutura.

  Se você precisar aumentar o limite, poderá solicitar um aumento. Consulte Solicitando um Aumento do Limite de Serviço.

• O arquivo TGZ é muito grande: Isso geralmente acontece quando o arquivo .npmignore não contém uma entrada *.tgz e, portanto, toda vez que você compacta os arquivos, uma cópia aninhada do arquivo TGZ existente é adicionada.

  Quando a pasta de nível superior contém um arquivo .npmignore com *.tgz, a versão anterior do arquivo TGZ não é incluída quando você atualiza o pacote.

Se você enviar instruções context.logger() do componente personalizado para o log do serviço, alterne Ativar Registro em Log do Componente para Ativado. Essa alternância só está disponível em instâncias do Oracle Digital Assistant provisionadas no Oracle Cloud Infrastructure (às vezes chamadas de infraestrutura de nuvem Geração 2).

Quando a opção Ativar Registro em Log do Componente estiver ativada, você poderá clicar no botão Diagnóstico do serviço para acessar os logs de exibição e os relatórios de falhas para diagnosticar o problema.

• Selecione Exibir Logs para exibir as mensagens que o componente personalizado envia para context.logger(). Esse recurso só está disponível em instâncias do Oracle Digital Assistant provisionadas no Oracle Cloud Infrastructure (às vezes chamadas de infraestrutura de nuvem Geração 2). A chave Ativar Registro em Log do Componente deve estar Ativada para que o log contenha essas mensagens.
• Selecione Exibir Relatório de Falhas para exibir detalhes sobre o que pode ter feito o contêiner falhar.

Depois de criar o serviço, você pode chamar os componentes personalizados do seu fluxo de caixas de diálogo conforme descrito em Componentes Personalizados.