Guía de la API de Fess

Introducción

Introducción

• Público objetivo
• Antes de comenzar
• Requisitos previos para el uso de la API
• Acceso en línea
• Contacto para soporte técnico
• Referencia a sitios web de terceros relacionados
• Cómo enviar comentarios y sugerencias

Inicio rápido de la API

• Comience la API en 5 minutos
• Uso con Postman
• Ejemplos de código por lenguaje de programación
• Tabla de compatibilidad de versiones de la API
• Solución de problemas
• Próximos pasos

Especificaciones comunes

Descripción general de la API

• API proporcionadas por Fess
• URL base
• Sobre de respuesta
• Respuesta de error
• Autenticación y sesión
• Formatos de streaming
• Tipos de API

API de búsqueda

API de búsqueda

• Búsqueda de documentos
• Obtención de todos los documentos (búsqueda por scroll - NDJSON)

API de etiquetas

• Obtención de etiquetas
• Ejemplos de uso
• Respuesta de error

API de palabras populares

• Obtención de lista de palabras populares
• Ejemplos de uso
• Respuesta de error

API de sugerencias

• Obtención de lista de palabras sugeridas
• Ejemplos de uso
• Respuesta de error

API de consultas relacionadas y contenido relacionado

• Obtención de consultas relacionadas
• Obtención de contenido relacionado

Health API

• Obtención del estado
• Ejemplos de uso
• Respuesta y respuesta de error

Autenticación e interfaz de usuario

API de autenticación y sesión

• Descripción general
• Información de usuario común (UserPayload)
• Obtención del estado de autenticación
• Inicio de sesión
• Cierre de sesión
• Cambio de contraseña

API de configuración de interfaz de usuario

• Descripción general
• Obtención de la configuración de interfaz de usuario

API de funciones de usuario

API de favoritos

• Obtención de lista de documentos favoritos
• Obtención del estado de favorito
• Registro de favorito

API de registro de clics

• Registro de un clic

API de caché

• Obtención de documento en caché

API de chat con IA

Chat API

• Descripción general
• Requisitos previos
• Autenticación y CSRF
• Límite de velocidad
• POST /chat
• POST /chat/stream
• DELETE /chat/sessions/{session_id}
• Seguridad
• Información de referencia

API de administración

Referencia de Admin API

• Vision General de Admin API
• API de WebConfig
• API de FileConfig
• API de DataConfig
• API de Documents
• API de CrawlingInfo
• API de FailureUrl
• API de Backup
• API de Scheduler
• API de JobLog
• API de User
• API de Role
• API de Group
• API de AccessToken
• API de LabelType
• API de KeyMatch
• API de BoostDoc
• API de ElevateWord
• API de BadWord
• API de RelatedContent
• API de RelatedQuery
• API de Suggest
• API de General
• API de SystemInfo
• API de Stats
• API de Log
• API de Storage
• API de Plugin
• API de Dict
• API de SearchLog