Pular para o conteúdo principal
SDK JavaScript aberto

Crie um chatbot personalizado com nosso SDK JavaScript

Use @openstaticfish/chattybox para controlar a interface enquanto o ChattyBox gere a recuperação de conteúdo, as citações de fontes, as conversas e o dimensionamento. A chave de API segura para uso no navegador identifica o seu projeto e pode ser restringida a origens aprovadas.

Recolhe conteúdo de páginas de documentação publicadasRespostas com citações de fontesCrie uma interface personalizada com o SDKNão é necessário migrar a documentaçãoNão é necessário cartão de créditoO seu conteúdo continua a ser seu
Pergunte ao ChattyBox
Por onde devo começar se precisar de uma resposta fiável deste site?
Comece por adicionar o URL público do seu site ao ChattyBox. Este recupera conteúdo indexado para orientar as respostas e pode apresentar ligações às páginas de origem para os visitantes consultarem. Teste as respostas e as respostas alternativas antes do lançamento.
iFontes3^
SDK JavaScript guia
chattybox.ai
Análises
chattybox.ai
Início
chattybox.ai

Conversa ilustrativa — não é um chat em direto.

Disponibilizado pelo ChattyBox

Lance um chatbot com citações de fontes sem reconstruir a infraestrutura do seu site

O ChattyBox recolhe o conteúdo do seu site, documentação, centro de ajuda, CMS ou base de conhecimento existentes. O conteúdo recuperado pode orientar as respostas do chatbot; verifique a precisão das respostas e das citações.

Instale um pacote ESM tipado do npm com Bun ou o seu gestor de pacotes preferido.
Crie sua própria renderização de mensagem, estado de conversa, citações e design de interação.
Use a mesma infraestrutura de recuperação gerenciada e resposta baseada na origem que o widget hospedado.
Chaves públicas de navegador funcionam entre origens por padrão; restrições de origem exata são proteção adicional opcional, não autenticação.
Etapa do fluxo de trabalho

Crie um projeto ChattyBox, indexe seu conteúdo e teste perguntas representativas.

Etapa do fluxo de trabalho

Crie uma chave API pública do widget; opcionalmente, restrinja-a às origens da sua aplicação.

Etapa do fluxo de trabalho

Instale @openstaticfish/chattybox e inicialize o cliente com a URL da API do painel.

Etapa do fluxo de trabalho

Renderize respostas e URLs de origem citados na interface que seu produto precisa.

Lançamento em três etapas

Ligue o seu site público ou a sua documentação, teste respostas com citações e depois crie a sua interface com o SDK.

Comece a construir com o SDK
Infraestrutura de chat headless

Domine a experiência do produto, não o pipeline de recuperação

O SDK é o caminho recomendado para integrações lideradas por desenvolvedores que precisam de UI personalizada, estado de aplicativo ou fluxos de trabalho específicos de produto.

Caminho de decisão

Use estes pontos de verificação para decidir se o ChattyBox deve funcionar ao lado da sua plataforma de documentação, substituir um assistente separado ou permanecer isolado para testes.

01

API de cliente tipada

Use um cliente focado e compatível com TypeScript para mensagens, conversas de acompanhamento, configuração de widgets e rótulos localizados.

02

Citações de fontes

Receba URLs de origem com cada resposta fundamentada e decida exatamente como elas aparecem em sua interface.

03

Continuidade da conversa

Reutilize o mesmo conversationId nas perguntas de seguimento para incluir até 12 mensagens recentes guardadas como contexto do modelo, cada uma limitada a 2.000 caracteres. É contexto limitado, não a transcrição completa; mantenha os IDs separados entre visitantes sem relação.

04

Limites transparentes

A sua aplicação é responsável pela apresentação e pelo desenho da interação; o ChattyBox gere o rastreio, a recuperação de conteúdo, a geração e o dimensionamento.

Caminho de instalação

Instale o SDK do chatbot JavaScript

O pacote funciona em aplicações atuais de navegador e Node.js que disponibilizem fetch. Use o URL exato da API do widget e a chave pública para navegador apresentados no separador de incorporação do projeto.

  1. 1Instale @openstaticfish/chattybox do npm.
  2. 2Inicialize um cliente Chattybox com sua chave de API pública e URL da API do widget.
  3. 3Envie uma mensagem e renderize a resposta retornada, o ID da conversa e os URLs de origem.
Comece a construir com o SDK
chat.ts
ts
import { Chattybox } from '@openstaticfish/chattybox';

// Replace these placeholders with the public key and widget API URL from Embed.
const chattybox = new Chattybox({
  apiKey: 'YOUR_PUBLIC_WIDGET_KEY',
  baseUrl: 'YOUR_WIDGET_API_URL',
});

const answer = await chattybox.sendMessage({
  message: 'How do I get started?',
});

console.log(answer.message, answer.sources);
Perguntas frequentes

Perguntas comuns

1

O que é um SDK JavaScript headless para chatbots?

É uma biblioteca cliente que fornece transporte de chat e dados de resposta sem prescrever a interface. Seu aplicativo renderiza mensagens, fontes, estados de carregamento e controles.

2

O SDK JavaScript do ChattyBox é público no npm?

Sim. Instale @openstaticfish/chattybox do npm e use a API pública documentada na página de referência do SDK.

3

O SDK inclui recuperação e citações de fontes?

O SDK chama a infraestrutura gerenciada do ChattyBox, que recupera o conteúdo indexado e retorna a mensagem gerada com URLs de origem citados.

4

Devo usar o SDK ou widget.js?

Use o SDK quando a sua equipa for responsável por uma interface ou fluxo de trabalho personalizado. Use widget.js quando quiser que o ChattyBox mantenha uma interface de chat pronta a usar, sem necessidade de compilação.

Comece gratuitamente

Não é necessário cartão de crédito

Crie um chatbot gratuitamente

Plano Free. Sem cartão.