Usando o APIMart no AnythingLLM

Documentation Index

Fetch the complete documentation index at: https://docs.apimart.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

Pré-requisitos

1. AnythingLLM instalado
   Baixe e instale o AnythingLLM no site oficial ou visite o GitHub
2. Chave de API do APIMart obtida
   Acesse o Console do APIMart para obter sua chave de API (começa com sk-)

​

Etapa 1: Iniciar o AnythingLLM e acessar as configurações

​

1.1 Iniciar o aplicativo

1. Inicie o aplicativo desktop AnythingLLM ou acesse a versão web
2. Uma tela de boas-vindas aparecerá na primeira inicialização
3. Clique no botão Open settings no canto inferior esquerdo

​

1.2 Navegar até a configuração do LLM

1. Encontre LLM Preference no menu à esquerda
2. Clique para entrar na página de configuração do LLM

​

Etapa 2: Configurar a API do APIMart

​

2.1 Selecionar o provedor LLM

1. Encontre o menu suspenso LLM Provider
2. Selecione Generic OpenAI

​

2.2 Configurar as informações da API

​

2.3 Ajustar parâmetros do modelo (opcional)

​

2.4 Salvar a configuração

1. Clique no botão Save na parte inferior da página
2. O sistema testará automaticamente a conexão
3. Uma mensagem de sucesso aparecerá se a configuração estiver correta

​

Etapa 3: Configurar o modelo de Embedding (opcional)

​

3.1 Navegar até as configurações de Embedding

1. Encontre Embedding Preference no menu à esquerda
2. Clique para entrar na página de configuração do modelo de embedding

​

3.2 Configurar o modelo de Embedding

​

Etapa 4: Criar área de trabalho e fazer upload de documentos

​

4.1 Criar área de trabalho

1. Volte para a interface principal
2. Clique em + New Workspace
3. Digite o nome da área de trabalho (por exemplo, “Assistente de documentação técnica”, “Base de conhecimento de atendimento ao cliente”)
4. Clique em Criar

​

4.2 Fazer upload de documentos

• 📄 Documentos de texto - .txt, .md, .pdf, .docx
• 💻 Arquivos de código - .py, .js, .java, .cpp, etc.
• 🌐 Páginas web - Via raspagem de URL
• 📊 Arquivos de dados - .csv, .json, .xml

1. Na página da área de trabalho, clique em Upload Documents
2. Selecione arquivos ou arraste e solte arquivos na área de upload
3. Aguarde o processamento dos documentos
4. Os documentos serão automaticamente vetorizados

​

4.3 Gerenciar documentos

1. Visualize todos os documentos carregados
2. Exclua documentos desnecessários
3. Visualize detalhes da divisão de documentos
4. Edite metadados de documentos

​

Etapa 5: Iniciar conversas

​

5.1 Conversas básicas

1. Na área de trabalho, encontre a caixa de entrada de conversação
2. Digite sua pergunta ou requisição
3. A IA gerará respostas com base nos seus documentos carregados e nos modelos do APIMart

​

5.2 Usando recursos da base de conhecimento

1. Analisar sua pergunta
2. Recuperar conteúdo relevante dos documentos carregados
3. Gerar respostas precisas combinando o conteúdo recuperado e o modelo de IA

​

5.3 Alternar entre áreas de trabalho

1. Clique no nome da área de trabalho no canto superior esquerdo
2. Selecione outras áreas de trabalho ou crie novas
3. Cada área de trabalho tem documentos e histórico de conversas independentes

​

Recursos avançados

​

1. Modo Agente

• 🔍 Pesquise na web - Obtenha informações em tempo real
• 🧮 Realize cálculos - Lide com matemática e análise de dados
• 📊 Gere gráficos - Visualize dados
• 🔗 Chame APIs - Interaja com serviços externos

1. Encontre Agent Configuration nas configurações da área de trabalho
2. Selecione ferramentas e recursos para ativar
3. Salve a configuração

​

2. Gerenciamento do histórico de conversas

• Exportar conversas - Exporte conversas como texto ou JSON
• Pesquisar histórico - Encontre rapidamente conversas históricas
• Excluir registros - Limpe históricos de conversas desnecessários

​

3. Prompts de sistema personalizados

1. Encontre System Prompt
2. Personalize o papel e o comportamento da IA
3. Exemplo:

You are a professional technical support engineer, skilled at answering technical questions about products.
When answering, please:
1. Maintain professionalism and courtesy
2. Provide detailed step-by-step instructions
3. If uncertain, recommend contacting technical support

​

4. Gerenciamento multiusuário (apenas implantação com Docker)

• Crie várias contas de usuário
• Defina diferentes níveis de permissão
• Gerencie permissões de acesso à área de trabalho

​

5. Acesso à API

• Acesso programático às áreas de trabalho
• Upload e gerenciamento de documentos
• Envio de requisições de conversa
• Integração em seus aplicativos

​

FAQ

​

Q1: Não consigo me conectar ao serviço APIMart?

1. Verifique a Base URL:
   • Certifique-se de que seja https://api.apimart.ai/v1 (inclui /v1)
   • Não adicione caminhos extras ou omita /v1
2. Verifique a API Key:
   • Confirme que a API Key começa com sk-
   • Verifique se a chave é válida no Console do APIMart
3. Verifique a conexão de rede:
   • Certifique-se de que pode acessar https://api.apimart.ai
   • Verifique as configurações de firewall ou proxy

​

Q2: Os documentos não estão sendo recuperados corretamente após o upload?

1. Verifique a configuração do modelo de Embedding:
   • Confirme que o modelo de embedding está configurado corretamente
   • Teste a conexão do modelo de embedding
2. Reprocesse os documentos:
   • Exclua e refaça o upload dos documentos
   • Verifique se o formato do documento é suportado
3. Ajuste os parâmetros de recuperação:
   • Ajuste o limite de similaridade nas configurações da área de trabalho
   • Aumente o número de pedaços de documentos retornados

​

Q3: Resposta lenta da conversa?

1. Mude para modelos mais rápidos:
   • Use gpt-4o-mini em vez de gpt-4o
   • Use gemini-2.0-flash-exp para resposta mais rápida
2. Otimize a quantidade de documentos:
   • Reduza o número de documentos na área de trabalho
   • Remova arquivos grandes desnecessários
3. Ajuste o Max Tokens:
   • Reduza o comprimento máximo de saída
   • Use prompts mais concisos

​

Q4: Como visualizar o uso e os custos da API?

• 📊 Estatísticas de chamadas de API
• 💰 Detalhes de custos
• 📈 Gráficos de tendência de uso
• 🔍 Logs detalhados de requisições

​

Q5: Quais opções de implantação o AnythingLLM suporta?

• 🖥️ Aplicativo desktop - Windows, macOS, Linux
• 🐳 Docker - Implantação auto-hospedada
• ☁️ Versão na nuvem - AnythingLLM Cloud (em breve)

​

Exemplos de casos de uso

​

1. Base de conhecimento corporativa

• Modelo: gpt-4o-mini (custo-benefício)
• Documentos: Documentos internos da empresa, manuais, FAQs
• Função: Consulta rápida de informações para funcionários

• Integração de novos funcionários
• Consulta rápida de políticas da empresa
• Recuperação de documentação técnica

​

2. Assistente de documentação técnica

• Modelo: claude-sonnet-4-5-20250929 (excelente para código)
• Documentos: Docs de API, especificações técnicas, base de código
• Função: Auxiliar desenvolvedores a encontrar informações técnicas

• Consultas de documentação de uso de API
• Recuperação de exemplos de código
• Respostas a perguntas técnicas

​

3. Base de conhecimento de atendimento ao cliente

• Modelo: gpt-4o (conversa de alta qualidade)
• Documentos: Manuais de produtos, FAQs, soluções
• Função: Resposta rápida a perguntas de clientes

• Resposta automática a FAQs
• Orientação de uso de produtos
• Sugestões de solução de problemas

​

4. Assistente de pesquisa e aprendizado

• Modelo: gpt-5 (compreensão poderosa)
• Documentos: Artigos de pesquisa, livros didáticos, anotações
• Função: Auxiliar no aprendizado e pesquisa

• Resumo e análise de artigos
• Explicação de pontos de conhecimento
• Planejamento de caminhos de aprendizagem

​

Recursos

• 📚 Base de conhecimento privada - Construa uma base de conhecimento privada e segura localmente
• 🔒 Privacidade dos dados - Todos os dados armazenados localmente, protegendo a privacidade
• 🤖 Suporte a múltiplos modelos - Alterne flexivelmente entre diferentes modelos de IA
• 📄 Suporte a vários formatos - Suporte para vários formatos de documentos
• 🎯 Recuperação precisa - Recuperação inteligente de documentos baseada em vetores
• 💬 Conversa contextual - Mantenha o contexto em conversas longas
• 🔧 Altamente personalizável - Prompts, parâmetros personalizados, etc.
• 🌐 Multiplataforma - Suporte para Windows, macOS, Linux

​

Segurança e privacidade de dados

​

Armazenamento local de dados

• 📁 Sistema de arquivos local - Documentos armazenados localmente
• 🗄️ Banco de dados vetorial local - Índices vetoriais armazenados localmente
• 💾 Histórico de conversas - Registros de conversas armazenados localmente

​

Segurança das chamadas de API

• 🔐 Transmissão criptografada - Todas as chamadas de API usam criptografia HTTPS
• 🔑 Proteção de chaves - API Key armazenada com segurança
• 🚫 Sem retenção de dados - O APIMart não armazena o conteúdo das suas conversas

​

Melhores práticas

​

1. Gerenciamento de documentos

• Atualizações regulares - Mantenha o conteúdo dos documentos atualizado
• Organização estruturada - Use uma estrutura de pastas clara
• Convenções de nomenclatura - Use nomes de arquivos significativos
• Excluir obsoletos - Limpe regularmente documentos desatualizados

​

2. Otimização de prompts

You are an assistant

You are a professional technical support assistant specializing in helping users resolve product-related technical issues.

When answering, please follow these principles:
1. Answer based on provided documentation; if information isn't available, clearly state so
2. Provide detailed step-by-step instructions with examples when necessary
3. Use clear, understandable language
4. For complex issues, recommend contacting the technical support team

​

3. Otimização de desempenho

• Controle o tamanho dos documentos - Evite carregar arquivos individuais excessivamente grandes
• Divisão razoável - Use as configurações padrão de divisão de documentos
• Escolha o modelo apropriado - Selecione o modelo com base na complexidade da tarefa
• Monitore o uso - Verifique regularmente o uso da API

​

4. Planejamento da área de trabalho

• Divida por projeto - Crie áreas de trabalho independentes para diferentes projetos
• Gerenciamento de permissões - Defina as permissões da área de trabalho adequadamente (versão Docker)
• Backup de dados - Faça backup regularmente de áreas de trabalho importantes

​

Suporte e ajuda

• 📚 Documentação do APIMart
• 📚 Documentação oficial do AnythingLLM
• 📚 AnythingLLM no GitHub
• 💬 Comunidade do Discord
• 🐦 Twitter @APIMart_
• 📧 Suporte técnico: zhihong@apimart.ai