Suggest API

Vision General

La API de Suggest es una API para gestionar las palabras de sugerencia utilizadas por la funcionalidad de sugerencias de Fess. Permite obtener informacion estadistica sobre el numero de palabras de sugerencia y eliminar palabras de sugerencia.

Las palabras de sugerencia incluyen las generadas a partir de documentos rastreados (derivadas de documentos) y las generadas a partir de las consultas de busqueda de los usuarios (derivadas de consultas de busqueda). Esta API permite eliminarlas por tipo o eliminarlas todas a la vez.

Autenticacion

El acceso a esta API requiere autenticacion mediante un token de acceso. Especifique el token de acceso en la cabecera de la solicitud.

Authorization: Bearer <token de acceso>

El token de acceso debe tener el permiso de Admin API (por defecto Radmin-api). Para obtener informacion sobre como obtener un token de acceso y los detalles de los permisos, consulte Vision General de Admin API.

URL Base

/api/admin/suggest

Lista de Endpoints

Metodo Ruta Descripcion
GET / Obtener informacion estadistica de palabras de sugerencia
DELETE /all Eliminar todas las palabras de sugerencia
DELETE /document Eliminar palabras de sugerencia derivadas de documentos
DELETE /query Eliminar palabras de sugerencia derivadas de consultas de busqueda

Obtener Informacion Estadistica de Palabras de Sugerencia

Obtiene informacion estadistica sobre el numero de palabras de sugerencia.

Solicitud

GET /api/admin/suggest

Respuesta

{
  "response": {
    "version": "15.7.0",
    "status": 0,
    "setting": {
      "totalWordsNum": 1500,
      "documentWordsNum": 1200,
      "queryWordsNum": 450
    }
  }
}

Campos de Respuesta

Campo Descripcion
setting.totalWordsNum Numero total de palabras de sugerencia (numero de palabras de sugerencia registradas en el indice de sugerencias)
setting.documentWordsNum Numero de palabras de sugerencia derivadas de documentos (numero de palabras de sugerencia con frecuencia de documento igual o superior a 1)
setting.queryWordsNum Numero de palabras de sugerencia derivadas de consultas de busqueda (numero de palabras de sugerencia con frecuencia de consulta igual o superior a 1)

Nota

documentWordsNum y queryWordsNum no son excluyentes entre si. Si una palabra de sugerencia tiene origen tanto en documentos como en consultas de busqueda, se incluye en el recuento de ambos. Por este motivo, la suma de documentWordsNum y queryWordsNum puede no coincidir con totalWordsNum.

Eliminar Todas las Palabras de Sugerencia

Elimina todas las palabras de sugerencia. Se eliminan todas las palabras de sugerencia del indice de sugerencias, independientemente de si son derivadas de documentos o de consultas de busqueda.

Solicitud

DELETE /api/admin/suggest/all

Respuesta

{
  "response": {
    "version": "15.7.0",
    "status": 0
  }
}

Eliminar Palabras de Sugerencia Derivadas de Documentos

Elimina las palabras de sugerencia generadas a partir de documentos (palabras de sugerencia derivadas de documentos).

Solicitud

DELETE /api/admin/suggest/document

Respuesta

{
  "response": {
    "version": "15.7.0",
    "status": 0
  }
}

Eliminar Palabras de Sugerencia Derivadas de Consultas de Busqueda

Elimina las palabras de sugerencia generadas a partir de consultas de busqueda (palabras de sugerencia derivadas de consultas de busqueda).

Solicitud

DELETE /api/admin/suggest/query

Respuesta

{
  "response": {
    "version": "15.7.0",
    "status": 0
  }
}

Respuesta de Error

Si el proceso de eliminacion falla, se devuelve el estado HTTP 400 y el campo status del cuerpo de la respuesta se establece en 1 (BAD_REQUEST), con el campo message conteniendo el mensaje de error.

{
  "response": {
    "version": "15.7.0",
    "status": 1,
    "message": "Failed to delete a document."
  }
}

Si el token de acceso no se especifica, no es valido o los permisos son insuficientes, el campo status del cuerpo de la respuesta se establece en 3 (UNAUTHORIZED). Para consultar la lista de valores de status y codigos de estado HTTP, consulte Vision General de Admin API.

Ejemplos de Uso

Obtener Informacion Estadistica

curl -X GET "http://localhost:8080/api/admin/suggest" \
     -H "Authorization: Bearer YOUR_TOKEN"

Eliminar Todas las Palabras de Sugerencia

curl -X DELETE "http://localhost:8080/api/admin/suggest/all" \
     -H "Authorization: Bearer YOUR_TOKEN"

Eliminar Palabras de Sugerencia Derivadas de Documentos

curl -X DELETE "http://localhost:8080/api/admin/suggest/document" \
     -H "Authorization: Bearer YOUR_TOKEN"

Eliminar Palabras de Sugerencia Derivadas de Consultas de Busqueda

curl -X DELETE "http://localhost:8080/api/admin/suggest/query" \
     -H "Authorization: Bearer YOUR_TOKEN"

Informacion de Referencia