Pular para o conteúdo principal
O SDK do EKB (Software Development Kit) fornece uma biblioteca completa em TypeScript/JavaScript para integrar os poderosos recursos do EKB aos seus aplicativos. Construa interfaces de chat, gerencie dados estruturados, habilite conversas por voz e aproveite agentes de IA programaticamente. Este artigo fornecerá uma visão geral do SDK do EKB com exemplos de uso e práticas recomendadas.

O que é o SDK do EKB?

O SDK do EKB é uma biblioteca TypeScript que fornece acesso programático aos recursos principais do EKB:
  • ChatSDK: Construa interfaces de IA conversacional com gerenciamento de chat, tratamento de mensagens e respostas por streaming.
  • SmartTablesSDK: Gerencie tabelas de dados estruturados com consultas avançadas, filtragem e processamento de dados por IA.
  • VoiceSDK: Habilite conversas por voz com integração automática de chat e hooks do React.

Instalação

Ou com yarn:

Início Rápido

Configuração Básica

Autenticação

O SDK suporta dois métodos de autenticação:

1. Autenticação por Chave de API (Recomendado para Lado do Servidor)

Use chaves de API para comunicação entre servidores e integrações externas:
Obtendo Chaves de API:
  1. Navegue até Minha Conta > Chaves de API no seu painel do EKB
  2. Crie um novo par de chaves de API
  3. Copie a Chave de API e o Secret da API
  4. Armazene-as de forma segura (use variáveis de ambiente, nunca faça commit para controle de versão)

2. Autenticação por Token de Acesso (Para Aplicativos Web)

Use tokens de acesso para aplicações do lado do cliente com sessões de usuário existentes:

Componentes do SDK

Chat SDK

Construa interfaces de IA conversacional com gerenciamento abrangente de chat. Principais Recursos:
  • Criar, listar e gerenciar chats
  • Enviar mensagens com suporte a streaming
  • Integração com base de conhecimento
  • Upload de arquivos (imagens, documentos)
  • Feedback do usuário (curtir/não curtir)
  • Agentes e modelos personalizados
Saiba Mais: Documentação do Chat SDK

Smart Tables SDK

Gerencie dados estruturados com consultas avançadas e processamento por IA. Principais Recursos:
  • Criar e gerenciar tabelas de dados
  • Filtragem e ordenação avançadas
  • Importação/exportação de dados (CSV, Excel)
  • Cálculo de colunas por IA
  • Visualizações e gerenciamento de colunas personalizadas
  • Paginação e busca
Saiba Mais: Documentação do Smart Tables SDK

Voice SDK

Habilite conversas por voz com integração automática de chat. Principais Recursos:
  • Conversas por voz em tempo real
  • Transcrição automática
  • Hooks do React para fácil integração
  • Visualização de áudio
  • Gerenciamento de sessões
  • Integração com chat
Saiba Mais: Documentação do Voice SDK

Casos de Uso Comuns

1. Chatbot de Suporte ao Cliente

2. Aplicativo de Gerenciamento de Dados

3. Aplicativo com Suporte a Voz

Variáveis de Ambiente

Para aplicações em produção, sempre use variáveis de ambiente:

Tratamento de Erros

Todos os métodos do SDK lançam erros que devem ser capturados e tratados:

Suporte a TypeScript

O SDK é escrito em TypeScript e fornece definições de tipos completas:

Integração com React

O SDK inclui hooks do React para fácil integração:

Práticas Recomendadas

1. Use Variáveis de Ambiente

Nunca codifique chaves de API ou secrets diretamente no código. Sempre use variáveis de ambiente.

2. Trate Erros Adequadamente

Sempre envolva chamadas ao SDK em blocos try-catch e forneça mensagens de erro significativas aos usuários.

3. Reutilize Instâncias do SDK

Crie instâncias do SDK uma vez e reutilize-as, em vez de criar novas instâncias para cada operação.

4. Use Streaming para Melhor Experiência

Para aplicativos de chat, use respostas por streaming para feedback em tempo real:

5. Implemente Paginação

Ao listar chats ou consultar tabelas, sempre implemente paginação:

Obter Ajuda

  • Documentação: Navegue pela documentação detalhada de cada componente do SDK.
  • Suporte: Envie um e-mail para Suporte para assistência técnica.
  • Exemplos: Confira o repositório do SDK para exemplos completos e funcionais.