Assistente de escrita com IA de código aberto e fácil de usar

Introdução geral

O AI Writing Assistant é um assistente de escrita de IA de código aberto baseado no Next.js, hospedado no GitHub, projetado para ajudar escritores, criadores de conteúdo e profissionais de redação a melhorar a eficiência e a qualidade de sua escrita por meio da tecnologia de inteligência artificial. A ferramenta permite que os usuários organizem os requisitos de redação por meio de um editor de estilo de prompt detalhado e enviem instruções a vários modelos de linguagem grande (LLMs) para gerar conteúdo. Ela é compatível com as principais interfaces de API, como OpenAI, Claude e Grok, e oferece opções de configuração flexíveis e uma interface fácil de usar. Seja na criação de artigos, no ajuste do tom ou na exportação de arquivos Markdown, esse projeto oferece aos usuários um suporte eficiente à escrita e é um excelente exemplo de como a tecnologia e a criatividade podem trabalhar juntas.

Lista de funções

• Personalização do estilo da palavra CueSuporte à edição multidimensional de linguagem, estrutura, emoção, etc., para gerar um texto que atenda às necessidades do usuário.
• Suporte a vários modelosCompatível com OpenAI, Claude, Gemini e outras APIs do LLM para atender às necessidades de diferentes cenários.
• Configuração flexível da APIConfigure facilmente chaves de API e pontos de extremidade com um painel dobrável.
• Edição de conteúdo em tempo realTexto gerado: O texto gerado pode ser modificado diretamente no editor incorporado.
• Exportação MarkdownExportação de conteúdo com um clique para o formato Markdown para facilitar o salvamento e o compartilhamento.
• Exibição de informações de depuraçãoForneça registros detalhados de resposta da API para solução de problemas.
• Mudança de temaSuporte aos modos escuro e claro para se adaptar às preferências do usuário.
• Suporte ao agenteFuncionalidade de proxy integrada para atender ao acesso à rede ou às limitações de CORS.

Usando a Ajuda

O AI Writing Assistant é uma ferramenta de código aberto que exige que os usuários obtenham o código via GitHub e o executem localmente. Abaixo está um guia detalhado de instalação e uso para ajudar os usuários a começar rapidamente.

Processo de instalação

Para usar essa ferramenta, você precisará de alguma base técnica, incluindo um ambiente Node.js e operações Git. Aqui estão as etapas:

1. Preparação do ambiente
   • Certifique-se de que seu computador tenha o Node.js 16.20.0 ou posterior instalado (download:https://nodejs.org/).
   • Instale a ferramenta Git (endereço de download:https://git-scm.com/) para clonagem de código.
2. Obter o código do projeto
   • Abra seu navegador e acesse https://github.com/GeekyWizKid/writing-helper.
   • Clique no botão verde "Code" (Código) para copiar o endereço do repositório:https://github.com/GeekyWizKid/writing-helper.git.
   • Abra um terminal e digite o seguinte comando para clonar o projeto:

     git clone https://github.com/GeekyWizKid/writing-helper.git
     

   • Vá para o catálogo de projetos:

     cd writing-helper
     

3. Instalação de dependências
   • Execute o seguinte comando no terminal para instalar as dependências necessárias para o projeto:

     npm install
     

   • Aguarde alguns minutos até que todas as dependências sejam instaladas.
4. Iniciando o servidor de desenvolvimento
   • Digite o seguinte comando para iniciar o projeto:

     npm run dev
     

   • Após uma inicialização bem-sucedida, abra seu navegador e acesse http://localhost:3000Você pode ver a interface da ferramenta.
5. resolução de falhas
   • Se a inicialização falhar, verifique se a versão do Node.js está correta ou consulte a mensagem de erro do terminal.
   • Visite a página "Problemas" do GitHub para pesquisar problemas semelhantes ou enviar um novo problema para obter ajuda.

Funções principais

Após a instalação, os usuários podem usar as seguintes funções por meio da interface do navegador:

Configurações da API

• Abra o painel de configuraçõesClique no botão "API Settings" (Configurações da API), à esquerda, para expandir o painel de configuração.
• Selecione o modeloSelecione uma API compatível (por exemplo, OpenAI, Claude, Grok, etc.) no menu suspenso.
• Digite a chaveDigite sua chave de API (obtida na plataforma apropriada, por exemplo, o site da OpenAI) no campo correspondente.
• Pontos de extremidade personalizadosSe estiver usando um proxy ou modelo local, você poderá inserir um endereço personalizado em "API Base URL".
• Salvar configuraçãoClique em "Save" (Salvar) ou vá diretamente para a próxima etapa e a configuração entrará em vigor automaticamente.

Configuração de conteúdo e personalização de estilo

• Definição do temaPreencha a caixa de entrada "Article Topic" com o objetivo da criação, por exemplo, "Scientific Press Release".
• Adicionar palavras-chaveDigite palavras relevantes no campo "Keywords" (Palavras-chave), como "Artificial Intelligence, Technology Trends" (Inteligência artificial, tendências tecnológicas), separadas por vírgulas.
• Contagem de palavras-alvoDigite o número desejado de palavras, por exemplo, 500.
• Editor de estilo::
  1. Clique no botão "Style Editor" para inserir as configurações detalhadas.
  2. estiloDescrição geral: Digite uma descrição geral, por exemplo, "conciso e claro".
  3. idiomaEscolha de tipos de frases (predominância de frases curtas) ou retórica (por exemplo, metáforas).
  4. estruturaTamanho dos parágrafos: defina o tamanho dos parágrafos (de 3 a 5 frases por parágrafo) e as transições (transição natural).
  5. mover-se (emocionalmente)Ajuste o tom (por exemplo, otimismo positivo).
  6. Salve e retorne à tela principal.

Gerar e editar conteúdo

• Gerar conteúdoClique no botão "Generate Content" (Gerar conteúdo), aguarde alguns segundos e o editor correto mostrará o resultado.
• Modificação em tempo realAjuste o texto diretamente no editor, por exemplo, removendo frases redundantes ou adicionando detalhes.
• Exportação de arquivosClique no botão "Export as Markdown", escolha o caminho para salvar e o arquivo será salvo como .md Download do formato.

Depuração e otimização

• Ver registroSe a geração falhar, clique em "Debug Info" para exibir os detalhes da resposta da API e verificar se há problemas de chave ou de rede.
• Uso de proxiesSe você encontrar um erro CORS, marque "Use proxy server" (Usar servidor proxy) nas configurações da API para resolver o problema por meio do proxy integrado.

Funções em destaque

• Comutação de vários modelos::
  Os usuários podem alternar os modelos a qualquer momento, por exemplo, do OpenAI GPT-4 para o Grok, para comparar o efeito de geração de diferentes modelos. Etapas: insira as configurações da API, selecione o novo modelo, insira a chave correspondente, salve e gere novamente.
• Personalização detalhada de estilos::
  O editor de estilo é o destaque central. Por exemplo, a perspectiva narrativa é definida como "primeira pessoa", o tom emocional como "humorístico e leve" e o ritmo como "frases curtas e rápidas", e o conteúdo gerado seguirá rigorosamente esses requisitos.
• Teste de API do Grok::
  Se estiver usando Grok Modelos, acessíveis http://localhost:3000/grok teste o status da conexão e visualize os registros de resposta detalhados.

Recomendações de uso

• uso inicialRecomendamos que você experimente primeiro o modelo GPT-3.5-Turbo da OpenAI, que é fácil de configurar e tem boa capacidade de resposta.
• Salvar a chavePara evitar entradas duplicadas, recomenda-se que a chave de API seja registrada em um local seguro.
• Envolvimento da comunidadeSe a funcionalidade não estiver perfeita, você poderá contribuir com código ou sugestões enviando uma solicitação pull no GitHub.

Com essas etapas, os usuários podem aproveitar ao máximo os recursos avançados do AI Writing Assistant, seja para gerar rascunhos rapidamente ou personalizar profundamente o conteúdo, o que pode melhorar significativamente a eficiência da escrita.