Propriedade do componente
Componha mensagens, cartões de citação, prompts, estados vazios e controles a partir de seus próprios componentes React.
Conecte componentes React ao ChattyBox com @openstaticfish/chattybox. Sua equipe controla renderização e estado, enquanto a infraestrutura gerenciada cuida de respostas baseadas em fontes, citações e agrupamento de conversas.
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 o JavaScript SDK em seu aplicativo React.
Crie um cliente Chattybox fora do caminho de renderização do componente.
Envie mensagens de um manipulador de eventos e atualize o estado da UI com a resposta.
Renderize links de origem e lide com falhas estruturadas do ChattyboxError.
Lançamento em três etapas
Use os padrões de estado, acessibilidade, estilo e sistema de design que seu aplicativo já segue, em vez de se adaptar a um shell de widget fixo.
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.
Componha mensagens, cartões de citação, prompts, estados vazios e controles a partir de seus próprios componentes React.
Use o estado local ou a camada de estado existente enquanto mantém as conversas isoladas entre os visitantes.
Controle o foco, as regiões ativas, o comportamento do teclado e os anúncios de erros em seu aplicativo.
Mantenha a integração no navegador simples enquanto o ChattyBox trata da indexação e recuperação de conteúdo e das respostas com citações.
Crie o cliente uma vez, chame-o de um manipulador de eventos e mantenha cada ID de conversa do visitante no estado do componente ou do aplicativo.
import { useState, type FormEvent } from 'react';
import { Chattybox, ChattyboxError, type ChatResponse } from '@openstaticfish/chattybox';
// Vite browser example. Other frameworks use different public environment APIs.
const chattybox = new Chattybox({
apiKey: import.meta.env.VITE_CHATTYBOX_API_KEY,
baseUrl: import.meta.env.VITE_CHATTYBOX_API_URL,
});
export function Chat() {
const [question, setQuestion] = useState('');
const [answer, setAnswer] = useState<ChatResponse | null>(null);
const [pending, setPending] = useState(false);
const [error, setError] = useState('');
async function ask(event: FormEvent<HTMLFormElement>) {
event.preventDefault();
const message = question.trim();
if (pending || !message || message.length > 2000) return;
setPending(true);
setError('');
try {
const result = await chattybox.sendMessage({
message,
// Same ID includes up to 12 recent saved messages, not the full transcript.
conversationId: answer?.conversationId,
});
// The backend may return a provider failure in an otherwise successful response.
if ('providerError' in result && typeof result.providerError === 'string' && result.providerError) {
setError('Chat could not be completed.');
return;
}
setAnswer(result);
setQuestion('');
} catch (failure) {
setError(failure instanceof ChattyboxError
? failure.status + ': ' + failure.message
: 'Chat could not be completed.');
} finally {
setPending(false);
}
}
const sources = answer?.sources.filter((source) => {
try { return ['https:', 'http:'].includes(new URL(source).protocol); }
catch { return false; }
}) ?? [];
return (
<section aria-label="Chat">
<form onSubmit={ask}>
<label>Question
<input value={question} maxLength={2000} disabled={pending}
onChange={(event) => setQuestion(event.target.value)} />
</label>
<button type="submit" disabled={pending || !question.trim()}>
{pending ? 'Sending...' : 'Send'}
</button>
</form>
{error && <p role="alert">{error}</p>}
<div aria-live="polite" aria-busy={pending}>
<p style={{ whiteSpace: 'pre-wrap' }}>{answer?.message}</p>
{sources.length > 0 && <ul aria-label="Sources">
{sources.map((source, index) => <li key={index}>
<a href={source} target="_blank" rel="noopener noreferrer">{source}</a>
</li>)}
</ul>}
</div>
</section>
);
}
// Render <Chat /> in your app. This shows the latest answer, not a saved transcript.
// No automatic retries: see the SDK retry-safety guide before adding retries.Sim. O JavaScript SDK retorna mensagens, IDs de conversa e URLs de origem para que seu aplicativo React possa renderizar uma interface totalmente personalizada.
Não são exportados componentes nem hooks React. Use os métodos headless com seus componentes ou chame mountWidget() em um layout persistente do navegador para carregar o widget flutuante mantido.
Crie-o fora do caminho de renderização do componente ou em um provedor de aplicativo estável, em vez de construir um novo cliente para cada renderização.
Sim. Use o guia de instalação do widget hospedado quando desejar uma interface mantida em vez da renderização React personalizada.
Não é necessário cartão de crédito
Plano Free. Sem cartão.