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.
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.
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.
Crie um projeto ChattyBox, indexe seu conteúdo e teste perguntas representativas.
Crie uma chave API pública do widget; opcionalmente, restrinja-a às origens da sua aplicação.
Instale @openstaticfish/chattybox e inicialize o cliente com a URL da API do painel.
Renderize respostas e URLs de origem citados na interface que seu produto precisa.
Lançamento em três etapas
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.
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.
Use um cliente focado e compatível com TypeScript para mensagens, conversas de acompanhamento, configuração de widgets e rótulos localizados.
Receba URLs de origem com cada resposta fundamentada e decida exatamente como elas aparecem em sua interface.
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.
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.
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.
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);É 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.
Sim. Instale @openstaticfish/chattybox do npm e use a API pública documentada na página de referência do SDK.
O SDK chama a infraestrutura gerenciada do ChattyBox, que recupera o conteúdo indexado e retorna a mensagem gerada com URLs de origem citados.
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.
Não é necessário cartão de crédito
Plano Free. Sem cartão.