Uso de APIMart en 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.

​

Requisitos previos

1. Tener AnythingLLM instalado
   Descargue e instale AnythingLLM desde el sitio web oficial o visite GitHub
2. Haber obtenido una clave de API de APIMart
   Acceda a la Consola de APIMart para obtener su clave de API (comienza con sk-)

​

Paso 1: Iniciar AnythingLLM y acceder a la configuración

​

1.1 Iniciar la aplicación

1. Inicie la aplicación de escritorio AnythingLLM o acceda a la versión web
2. La pantalla de bienvenida aparecerá en el primer inicio
3. Haga clic en el botón Open settings en la esquina inferior izquierda

​

1.2 Navegar a la configuración del LLM

1. Busque LLM Preference en el menú izquierdo
2. Haga clic para entrar en la página de configuración del LLM

​

Paso 2: Configurar la API de APIMart

​

2.1 Seleccionar el proveedor de LLM

1. Busque el menú desplegable LLM Provider
2. Seleccione Generic OpenAI

​

2.2 Configurar la información de la API

​

2.3 Ajustar parámetros del modelo (opcional)

​

2.4 Guardar la configuración

1. Haga clic en el botón Save en la parte inferior de la página
2. El sistema probará automáticamente la conexión
3. Aparecerá un mensaje de éxito si la configuración es correcta

​

Paso 3: Configurar el modelo de embeddings (opcional)

​

3.1 Navegar a la configuración de embeddings

1. Busque Embedding Preference en el menú izquierdo
2. Haga clic para entrar en la página de configuración del modelo de embeddings

​

3.2 Configurar el modelo de embeddings

​

Paso 4: Crear un espacio de trabajo y cargar documentos

​

4.1 Crear un espacio de trabajo

1. Regrese a la interfaz principal
2. Haga clic en + New Workspace
3. Introduzca el nombre del espacio de trabajo (p. ej., “Asistente de documentación técnica”, “Base de conocimiento de atención al cliente”)
4. Haga clic en Crear

​

4.2 Cargar documentos

• 📄 Documentos de texto - .txt, .md, .pdf, .docx
• 💻 Archivos de código - .py, .js, .java, .cpp, etc.
• 🌐 Páginas web - Mediante scraping de URL
• 📊 Archivos de datos - .csv, .json, .xml

1. En la página del espacio de trabajo, haga clic en Upload Documents
2. Seleccione archivos o arrastre y suelte archivos al área de carga
3. Espere a que se complete el procesamiento del documento
4. Los documentos se vectorizarán automáticamente

​

4.3 Gestionar documentos

1. Vea todos los documentos cargados
2. Elimine los documentos innecesarios
3. Vea los detalles de fragmentación de documentos
4. Edite los metadatos del documento

​

Paso 5: Comenzar las conversaciones

​

5.1 Conversaciones básicas

1. En el espacio de trabajo, busque el cuadro de entrada de conversación
2. Introduzca su pregunta o solicitud
3. La IA generará respuestas basadas en sus documentos cargados y en los modelos de APIMart

​

5.2 Uso de las funciones de base de conocimiento

1. Analiza su pregunta
2. Recupera contenido relevante de los documentos cargados
3. Genera respuestas precisas combinando el contenido recuperado y el modelo de IA

​

5.3 Cambiar de espacio de trabajo

1. Haga clic en el nombre del espacio de trabajo en la esquina superior izquierda
2. Seleccione otros espacios de trabajo o cree uno nuevo
3. Cada espacio de trabajo tiene documentos e historial de conversación independientes

​

Características avanzadas

​

1. Modo Agente

• 🔍 Buscar en la web - Obtener información en tiempo real
• 🧮 Realizar cálculos - Manejar matemáticas y análisis de datos
• 📊 Generar gráficos - Visualizar datos
• 🔗 Llamar APIs - Interactuar con servicios externos

1. Busque Agent Configuration en la configuración del espacio de trabajo
2. Seleccione las herramientas y funciones a habilitar
3. Guarde la configuración

​

2. Gestión del historial de conversaciones

• Exportar conversaciones - Exporte las conversaciones como texto o formato JSON
• Buscar historial - Encuentre rápidamente conversaciones históricas
• Eliminar registros - Limpie el historial de conversaciones innecesario

​

3. Prompts del sistema personalizados

1. Busque System Prompt
2. Personalice el rol y comportamiento de la IA
3. Ejemplo:

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. Gestión multiusuario (solo despliegue con Docker)

• Cree múltiples cuentas de usuario
• Establezca diferentes niveles de permisos
• Gestione los permisos de acceso al espacio de trabajo

​

5. Acceso por API

• Acceso programático al espacio de trabajo
• Cargar y gestionar documentos
• Enviar solicitudes de conversación
• Integrar en sus aplicaciones

​

Preguntas frecuentes

​

Q1: ¿No se puede conectar al servicio de APIMart?

1. Verifique la Base URL:
   • Asegúrese de que sea https://api.apimart.ai/v1 (incluye /v1)
   • No añada rutas adicionales ni omita /v1
2. Verifique la API Key:
   • Confirme que la API Key comience con sk-
   • Compruebe si la clave es válida en la Consola de APIMart
3. Verifique la conexión de red:
   • Asegúrese del acceso a https://api.apimart.ai
   • Compruebe la configuración del firewall o proxy

​

Q2: ¿Los documentos no se recuperan correctamente después de cargarlos?

1. Verifique la configuración del modelo de embeddings:
   • Confirme que el modelo de embeddings esté configurado correctamente
   • Pruebe la conexión del modelo de embeddings
2. Reprocese los documentos:
   • Elimine y vuelva a cargar los documentos
   • Compruebe si el formato del documento es compatible
3. Ajuste los parámetros de recuperación:
   • Ajuste el umbral de similitud en la configuración del espacio de trabajo
   • Aumente el número de fragmentos de documento devueltos

​

Q3: ¿Respuesta de conversación lenta?

1. Cambie a modelos más rápidos:
   • Use gpt-4o-mini en lugar de gpt-4o
   • Use gemini-2.0-flash-exp para una respuesta más rápida
2. Optimice la cantidad de documentos:
   • Reduzca el número de documentos en el espacio de trabajo
   • Elimine archivos grandes innecesarios
3. Ajuste Max Tokens:
   • Reduzca la longitud máxima de la salida
   • Use prompts más concisos

​

Q4: ¿Cómo ver el uso y los costos de la API?

• 📊 Estadísticas de llamadas a la API
• 💰 Detalles de costos
• 📈 Gráficos de tendencias de uso
• 🔍 Registros detallados de solicitudes

​

Q5: ¿Qué opciones de despliegue admite AnythingLLM?

• 🖥️ Aplicación de escritorio - Windows, macOS, Linux
• 🐳 Docker - Despliegue autoalojado
• ☁️ Versión en la nube - AnythingLLM Cloud (próximamente)

​

Ejemplos de casos de uso

​

1. Base de conocimiento empresarial

• Modelo: gpt-4o-mini (económico)
• Documentos: documentos internos de la empresa, manuales, FAQ
• Función: búsqueda rápida de información para empleados

• Incorporación de nuevos empleados
• Búsqueda rápida de políticas de la empresa
• Recuperación de documentación técnica

​

2. Asistente de documentación técnica

• Modelo: claude-sonnet-4-5-20250929 (excelente para código)
• Documentos: documentación de API, especificaciones técnicas, base de código
• Función: ayudar a los desarrolladores a encontrar información técnica

• Consultas de documentación de uso de API
• Recuperación de ejemplos de código
• Respuesta a preguntas técnicas

​

3. Base de conocimiento de atención al cliente

• Modelo: gpt-4o (conversación de alta calidad)
• Documentos: manuales de producto, FAQ, soluciones
• Función: respuesta rápida a preguntas de clientes

• Respuesta automática a FAQ
• Orientación sobre el uso del producto
• Sugerencias de solución de problemas

​

4. Asistente de investigación y aprendizaje

• Modelo: gpt-5 (comprensión potente)
• Documentos: artículos de investigación, libros de texto, notas
• Función: ayudar en el aprendizaje y la investigación

• Resumen y análisis de artículos
• Explicación de puntos de conocimiento
• Planificación de rutas de aprendizaje

​

Características

• 📚 Base de conocimiento privada - Construya una base de conocimiento privada y segura localmente
• 🔒 Privacidad de datos - Todos los datos se almacenan localmente, protegiendo la privacidad
• 🤖 Soporte multimodelo - Cambie de forma flexible entre diferentes modelos de IA
• 📄 Soporte multiformato - Admite varios formatos de documentos
• 🎯 Recuperación precisa - Recuperación inteligente de documentos basada en vectores
• 💬 Conversación contextual - Mantenga el contexto en conversaciones largas
• 🔧 Altamente personalizable - Prompts personalizados, parámetros, etc.
• 🌐 Multiplataforma - Admite Windows, macOS, Linux

​

Seguridad y privacidad de datos

​

Almacenamiento local de datos

• 📁 Sistema de archivos local - Los documentos se almacenan localmente
• 🗄️ Base de datos vectorial local - Los índices vectoriales se almacenan localmente
• 💾 Historial de conversación - Los registros de conversación se almacenan localmente

​

Seguridad de las llamadas a la API

• 🔐 Transmisión cifrada - Todas las llamadas a la API usan cifrado HTTPS
• 🔑 Protección de la clave - La API Key se almacena de forma segura
• 🚫 Sin retención de datos - APIMart no almacena el contenido de sus conversaciones

​

Mejores prácticas

​

1. Gestión de documentos

• Actualizaciones regulares - Mantenga el contenido de los documentos actualizado
• Organización estructurada - Use una estructura clara de carpetas
• Convenciones de nombres - Use nombres de archivo significativos
• Eliminar lo obsoleto - Limpie regularmente los documentos obsoletos

​

2. Optimización 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. Optimización del rendimiento

• Controle el tamaño de los documentos - Evite cargar archivos individuales demasiado grandes
• Fragmentación razonable - Use la configuración predeterminada de fragmentación de documentos
• Elija el modelo adecuado - Seleccione el modelo según la complejidad de la tarea
• Supervise el uso - Verifique regularmente el uso de la API

​

4. Planificación del espacio de trabajo

• Divida por proyecto - Cree espacios de trabajo independientes para diferentes proyectos
• Gestión de permisos - Configure los permisos del espacio de trabajo de forma adecuada (versión Docker)
• Copia de seguridad de datos - Haga copias de seguridad regulares de los espacios de trabajo importantes

​

Soporte y ayuda

• 📚 Documentación de APIMart
• 📚 Documentación oficial de AnythingLLM
• 📚 AnythingLLM GitHub
• 💬 Comunidad de Discord
• 🐦 Twitter @APIMart_
• 📧 Soporte técnico: zhihong@apimart.ai