Usando o APIMart no Dify

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. Conta no Dify registrada Visite o site oficial do Dify para registrar uma conta, escolha a versão na nuvem ou auto-hospedada
2. Chave de API do APIMart obtida Acesse o Console do APIMart para obter sua chave de API (começa com sk-)

​

Etapa 1: Fazer login no Dify e acessar as configurações

​

1.1 Acessar a plataforma Dify

• Versão na nuvem: Visite https://cloud.dify.ai e faça login
• Versão auto-hospedada: Visite o endereço da sua implantação do Dify

​

1.2 Navegar até as configurações de modelos

1. Clique no ícone de avatar no canto superior direito
2. Selecione Settings
3. Escolha Model Provider no menu à esquerda

​

Etapa 2: Adicionar o provedor de modelos APIMart

​

2.1 Selecionar o método de configuração

​

Método 1: Usar a API personalizada da OpenAI (Recomendado)

1. Encontre o provedor OpenAI na página Model Provider
2. Clique no botão Configure ou Settings
3. Na página de configuração:
   • API Key: Insira sua chave de API do APIMart (sk-xxxxxxxxxxxx)
   • API Base URL ou Base URL: Insira https://api.apimart.ai/v1
4. Clique em Save

5. Após a configuração, retorne à página do provedor OpenAI e visualize a Model List
6. Na lista de modelos, encontre os modelos que você precisa (por exemplo, gpt-4o, gpt-4o-mini, chatgpt-4o-latest, etc.)
7. Clique no interruptor no lado direito do modelo para ativá-lo (azul indica ativado)

​

Método 2: Adicionar provedor de modelo personalizado

1. Role para baixo até a seção Custom Model
2. Clique no botão + Add Model

​

2.2 Configurar o provedor APIMart

​

2.3 Adicionar mais modelos (opcional)

1. Na seção de modelos personalizados, clique novamente no botão + Add Model
2. Preencha as informações de configuração para outro modelo
3. Clique em Salvar

​

Série GPT-4/5

​

Série Claude

​

Série Gemini

​

Etapa 3: Usar os modelos do APIMart em aplicações

​

3.1 Criar nova aplicação

1. Volte para a página inicial do Dify
2. Clique no botão Create App
3. Selecione o tipo de aplicação:
   • Chatbot - Aplicação de conversação
   • Text Generator - Aplicação de geração de texto
   • Agent - Agente inteligente
   • Workflow - Aplicação de fluxo de trabalho complexo

​

3.2 Selecionar modelo APIMart

1. Encontre a área Model Settings
2. Clique no menu suspenso Select Model
3. Selecione o provedor APIMart
4. Escolha seu modelo configurado (por exemplo, gpt-4o)

​

3.3 Configurar parâmetros do modelo

​

Etapa 4: Construir e testar a aplicação

​

4.1 Adicionar prompts

1. Escreva prompts na área System Prompt
2. Use variáveis para tornar seu app dinâmico:
   • {{variable_name}} - Variável de entrada do usuário
   • {{context}} - Contexto da base de conhecimento

You are a professional customer service assistant, skilled at answering product questions.

Product Information: {{product_info}}

Please provide accurate and friendly answers based on user questions. If unsure, honestly inform the user.

User Question: {{user_question}}

​

4.2 Adicionar base de conhecimento (opcional)

1. Clique em Knowledge Base no menu à esquerda
2. Crie uma nova base de conhecimento e faça upload de documentos
3. Vincule a base de conhecimento na página de orquestração da aplicação
4. Configure os parâmetros de recuperação

​

4.3 Testar a aplicação

1. Digite perguntas de teste no painel Preview à direita
2. Revise a eficácia da resposta da IA
3. Ajuste prompts e parâmetros conforme necessário
4. Repita o teste até ficar satisfeito

​

4.4 Publicar a aplicação

1. Clique no botão Publish no canto superior direito
2. Selecione o método de publicação:
   • API Call - Integração via API
   • Embed in Website - Gerar código de incorporação
   • Public Link - Gerar link de compartilhamento

​

Etapa 5: Monitorar e otimizar

​

5.1 Visualizar logs da aplicação

1. Clique na aba Logs
2. Visualize todos os registros de conversa
3. Analise as perguntas dos usuários e as respostas da IA
4. Descubra oportunidades de melhoria

​

5.2 Monitorar o uso da API

• 📊 Estatísticas de chamadas de API - Total de chamadas, taxa de sucesso
• 💰 Detalhes de custos - Custos diários/mensais
• 📈 Tendências de uso - Tendências de mudança de uso
• 🔍 Logs de requisições - Registros detalhados de requisições

​

5.3 Otimizar o desempenho da aplicação

1. Ajustar a seleção de modelos
   • Use gpt-4o-mini para tarefas simples para reduzir custos
   • Use gpt-4o ou claude-sonnet-4-5 para tarefas complexas para melhorar a qualidade
2. Otimizar prompts
   • Torne os prompts mais claros e específicos
   • Adicione exemplos para melhorar a eficácia
   • Use cadeia de pensamento para melhor raciocínio
3. Configurar caching
   • Ative o cache para perguntas similares
   • Reduza os custos de chamadas de API

​

Recursos avançados

​

Usando orquestração de fluxo de trabalho

1. Branches condicionais - Execute lógica diferente com base nas condições
2. Colaboração multimodelo - Combine vantagens de vários modelos
3. Chamadas a ferramentas externas - Chame APIs, bancos de dados e outros recursos externos
4. Passagem de variáveis - Passe dados entre diferentes nós

​

Configurando capacidades de Agente

1. Chamada de ferramentas - Deixe a IA chamar ferramentas externas
2. Gerenciamento de memória - Mantenha memória de conversa de longo prazo
3. Tomada de decisão autônoma - A IA planeja autonomamente os passos de execução

​

Aplicações multimodais

1. Compreensão de imagens - Use gpt-4o ou claude-3 para processar imagens
2. Geração de imagens - Integre a API de geração de imagens do APIMart
3. Processamento de voz - Integre serviços TTS e STT

​

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 o servidor pode acessar https://api.apimart.ai
   • Versões auto-hospedadas precisam garantir a conectividade de rede do servidor

​

Q2: A resposta do modelo está lenta?

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 o comprimento do prompt:
   • Reduza contexto desnecessário
   • Simplifique as descrições dos prompts
3. Ajuste a recuperação da base de conhecimento:
   • Reduza o número de documentos recuperados
   • Aumente o limite de similaridade

​

Q3: Chamadas de API falham ou retornam erros?

​

Q4: Como reduzir os custos de uso da API?

1. Seleção de modelos:
   • Use gpt-4o-mini para tarefas simples (custo é apenas 1/10 do gpt-4o)
   • Considere modelos mais econômicos para tarefas em lote
2. Ative caching:
   • Retorne resultados em cache para as mesmas perguntas
   • Configure a correspondência de similaridade no Dify
3. Otimize o comprimento da saída:
   • Defina um Max Tokens razoável
   • Evite gerar respostas excessivamente longas
4. Use saída em streaming:
   • Melhore a experiência do usuário sem aumentar os custos

​

Q5: Como lidar com dados sensíveis?

1. Use variáveis de ambiente:
   • Não codifique chaves de API no código
   • Use o recurso de variáveis de ambiente do Dify
2. Configure controle de acesso:
   • Defina permissões de acesso à aplicação
   • Ative autenticação para chamadas de API
3. Logs de auditoria:
   • Verifique regularmente os logs da aplicação
   • Monitore padrões de acesso anormais

​

Melhores práticas

​

1. Engenharia de prompts

# Role Definition
You are a professional [role description]

# Task Objective
You need to help users [task description]

# Output Requirements
- Requirement 1
- Requirement 2
- Requirement 3

# Input Information
{{user_input}}

​

2. Gerenciamento da base de conhecimento

• Estratégia de divisão: Defina um tamanho razoável de pedaço de documento (recomendado 500-1000 caracteres)
• Marcação de metadados: Adicione metadados aos documentos para facilitar a recuperação
• Atualizações regulares: Mantenha o conteúdo da base de conhecimento atualizado

​

3. Tratamento de erros

• Mensagens amigáveis: Forneça mensagens de erro claras aos usuários
• Estratégia de fallback: Mude para um modelo de backup quando o principal falhar
• Mecanismo de retentativa: Retentativa automática para erros temporários

​

4. Monitoramento de desempenho

• Defina alertas: Alerte para saldo baixo, altas taxas de erro
• Análise regular: Analise os dados de uso semanal/mensalmente
• Otimização contínua: Ajuste a configuração com base nos dados

​

Exemplos de casos de uso

​

1. Atendimento ao cliente inteligente

• Modelo: gpt-4o-mini (custo-benefício)
• Base de conhecimento: Documentos de produto, FAQ
• Recursos: Respostas automáticas a perguntas comuns, escala problemas complexos para humanos

​

2. Assistente de criação de conteúdo

• Modelo: gpt-4o ou claude-sonnet-4-5 (alta qualidade)
• Recursos: Geração de artigos, reescrita, polimento
• Parâmetros: Temperature=0.8 (aumentar criatividade)

​

3. Assistente de código

• Modelo: claude-sonnet-4-5 (excelente para código)
• Recursos: Geração, explicação, depuração de código
• Base de conhecimento: Documentação do projeto, documentação da API

​

4. Assistente de análise de dados

• Modelo: gpt-4o (forte capacidade de raciocínio)
• Ferramentas: Execução de código Python, visualização de dados
• Recursos: Análise de dados, geração de relatórios

​

Recursos

• 🤖 Construir aplicações de IA rapidamente - Crie aplicações de IA poderosas sem codificação
• 📚 Aprimoramento com base de conhecimento - A tecnologia RAG permite que a IA responda com base em seus dados
• 🔧 Fluxos de trabalho flexíveis - Orquestre visualmente lógica de IA complexa
• 🎯 Gerenciamento preciso de prompts - Controle de versão e teste A/B
• 📊 Monitoramento e análise completos - Entenda o uso e desempenho do app
• 🔌 Múltiplos métodos de integração - API, incorporado, WebApp e mais
• 👥 Colaboração em equipe - Suporte ao desenvolvimento colaborativo multiusuário
• 🌐 Suporte multimodelo - Alterne flexivelmente entre diferentes modelos de IA

​

Suporte e ajuda

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