Pular para o conteúdo principal
SDK do chatbot Next.js

Adicione um chatbot de IA personalizado ao Plataforma Next.js

Use @openstaticfish/chattybox dentro de um limite de cliente focado enquanto o restante do seu aplicativo App Router permanece renderizado pelo servidor. ChattyBox lida com recuperação, citações, conversas e dimensionamento.

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^
Integração com Next.js 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.

Mantenha a interface de chat interativa em um pequeno limite de cliente com `use client`.
Exponha apenas uma chave de widget pública com restrição de origem por meio de variáveis ​​NEXT_PUBLIC.
Renderize as respostas citadas com seu sistema de design Next.js e shell de aplicativo existentes.
Mantenha o rastreamento, a recuperação, o armazenamento de vetores, a geração de respostas e o escalonamento gerenciados pelo ChattyBox.
Etapa do fluxo de trabalho

Instale @openstaticfish/chattybox no aplicativo Next.js.

Etapa do fluxo de trabalho

Adicione a chave pública da API do widget e o URL da API como variáveis de ambiente NEXT_PUBLIC.

Etapa do fluxo de trabalho

Crie um componente cliente para estado de chat e interação do navegador.

Etapa do fluxo de trabalho

Importe esse componente cliente de uma página ou layout de componente de servidor.

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.

Crie um chatbot Next.js
Integração com o App Router

Adicione interatividade sem abrir mão da renderização do servidor

Mantenha o SDK na borda do cliente onde ocorre a interação por chat e preserve os componentes do servidor para o restante do aplicativo.

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

Limite de cliente pequeno

Marque apenas o módulo de chat interativo com `use client`, em vez de transferir uma página ou layout inteiro para o navegador.

02

Clareza da chave pública

Use uma chave de projeto segura para navegador com origens permitidas; nunca exponha credenciais de gerenciamento por meio de variáveis ​​NEXT_PUBLIC.

03

IU de produto personalizada

Renderize mensagens e citações em sua própria navegação, área de conta, shell de documentos ou fluxo de trabalho de suporte.

04

Nenhum serviço RAG personalizado

Evite adicionar handlers de rota apenas para fazer proxy de uma API gerida acessível pelo navegador, a menos que o seu produto tenha um requisito concreto do lado do servidor.

Caminho de instalação

Crie um cliente de bate-papo Next.js App Router

O SDK usa fetch e credenciais do projeto visíveis no navegador, por isso inicialize-o num módulo cliente. Mantenha segredos e APIs de gestão fora das variáveis NEXT_PUBLIC.

  1. 1Instale o pacote npm e configure uma chave pública restrita à origem.
  2. 2Crie um componente com `use client` que controle o estado das mensagens e da conversa.
  3. 3Renderize o componente da página renderizada pelo servidor sem converter toda a rota em um componente cliente.
Crie um chatbot Next.js
app/components/chat.tsx
tsx
'use client';

import { useState, type FormEvent } from 'react';
import { Chattybox, ChattyboxError, type ChatResponse } from '@openstaticfish/chattybox';

const chattybox = new Chattybox({
  apiKey: process.env.NEXT_PUBLIC_CHATTYBOX_API_KEY!,
  baseUrl: process.env.NEXT_PUBLIC_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>
  );
}

// Import and render <Chat /> from your page or layout. This shows the latest answer, not a saved transcript.
// No automatic retries: see the SDK retry-safety guide before adding retries.
Perguntas frequentes

Perguntas comuns

1

O ChattyBox SDK funciona com o Next.js App Router?

Sim. Use-o em um componente cliente para estado de bate-papo interativo e renderize esse componente a partir de uma página ou layout do App Router.

2

Preciso de um manipulador de rota Next.js para ChattyBox?

Não para a integração normal do navegador. As chaves públicas do widget são projetadas para uso do cliente e podem ser restritas a origens aprovadas.

3

As chaves NEXT_PUBLIC do ChattyBox são secretas?

A chave pública do widget identifica um projeto, mas não é uma credencial de gerenciamento. Restrinja-o às suas origens de produção e visualização e nunca exponha segredos administrativos.

4

Posso usar o widget ChattyBox hospedado com Next.js?

Sim. O guia de instalação do widget alojado mostra como usar next/script se preferir uma interface mantida a uma interface personalizada com o SDK.

Comece gratuitamente

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

Crie um chatbot gratuitamente

Plano Free. Sem cartão.