API de búsqueda
Obtención de resultados de búsqueda
Solicitud
| Método HTTP | GET |
| Endpoint | /api/v1/documents |
Al enviar una solicitud como http://<Server Name>/api/v1/documents?q=término de búsqueda a Fess, puede recibir los resultados de búsqueda de Fess en formato JSON. Para usar la API de búsqueda, debe habilitar la respuesta JSON en Sistema > Configuración general de la consola de administración.
Parámetros de solicitud
Al especificar parámetros de solicitud como http://<Server Name>/api/v1/documents?q=término de búsqueda&num=50&fields.label=fess, puede realizar búsquedas más avanzadas. Los parámetros de solicitud disponibles son los siguientes:
| q | Término de búsqueda. Se pasa con codificación URL. |
| start | Posición inicial del número de resultados. Comienza desde 0. |
| num | Número de resultados a mostrar. El valor predeterminado es 20. Se pueden mostrar hasta 100 resultados. |
| sort | Ordenar. Se utiliza para ordenar los resultados de búsqueda. |
| fields.label | Valor de etiqueta. Se utiliza para especificar una etiqueta. |
| facet.field | Especificación de campo de faceta. (Ejemplo) facet.field=label |
| facet.query | Especificación de consulta de faceta. (Ejemplo) facet.query=timestamp:[now/d-1d TO *] |
| facet.size | Especificación del número máximo de facetas a obtener. Es válido cuando se especifica facet.field. |
| facet.minDocCount | Obtiene facetas con un recuento mayor o igual a este valor. Es válido cuando se especifica facet.field. |
| geo.location.point | Especificación de latitud y longitud. (Ejemplo) geo.location.point=35.0,139.0 |
| geo.location.distance | Especificación de la distancia desde el punto central. (Ejemplo) geo.location.distance=10km |
| lang | Especificación del idioma de búsqueda. (Ejemplo) lang=en |
| preference | Cadena que especifica el shard al realizar la búsqueda. (Ejemplo) preference=abc |
| callback | Nombre del callback cuando se utiliza JSONP. No es necesario especificarlo si no se utiliza JSONP. |
Tabla: Parámetros de solicitud
Respuesta
Se devuelve una respuesta como la siguiente:
(Formato embellecido)
{
"q": "Fess",
"query_id": "bd60f9579a494dfd8c03db7c8aa905b0",
"exec_time": 0.21,
"query_time": 0,
"page_size": 20,
"page_number": 1,
"record_count": 31625,
"page_count": 1,
"highlight_params": "&hq=n2sm&hq=Fess",
"next_page": true,
"prev_page": false,
"start_record_number": 1,
"end_record_number": 20,
"page_numbers": [
"1",
"2",
"3",
"4",
"5"
],
"partial": false,
"search_query": "(Fess OR n2sm)",
"requested_time": 1507822131845,
"related_query": [
"aaa"
],
"related_contents": [],
"data": [
{
"filetype": "html",
"title": "Open Source Enterprise Search Server: Fess — Fess 11.0 documentation",
"content_title": "Open Source Enterprise Search Server: Fess — Fe...",
"digest": "Docs » Open Source Enterprise Search Server: Fess Commercial Support Open Source Enterprise Search Server: Fess What is Fess ? Fess is very powerful and easily deployable Enterprise Search Server. ...",
"host": "fess.codelibs.org",
"last_modified": "2017-10-09T22:28:56.000Z",
"content_length": "29624",
"timestamp": "2017-10-09T22:28:56.000Z",
"url_link": "https://fess.codelibs.org/",
"created": "2017-10-10T15.30:48.609Z",
"site_path": "fess.codelibs.org/",
"doc_id": "e79fbfdfb09d4bffb58ec230c68f6f7e",
"url": "https://fess.codelibs.org/",
"content_description": "Enterprise Search Server: <strong>Fess</strong> Commercial Support Open...Search Server: <strong>Fess</strong> What is <strong>Fess</strong> ? <strong>Fess</strong> is very powerful...You can install and run <strong>Fess</strong> quickly on any platforms...Java runtime environment. <strong>Fess</strong> is provided under Apache...Apache license. Demo <strong>Fess</strong> is OpenSearch-based search",
"site": "fess.codelibs.org/",
"boost": "10.0",
"mimetype": "text/html"
}
]
}
Los elementos son los siguientes:
Búsqueda de todos los documentos
Para buscar todos los documentos objetivo, envíe la siguiente solicitud: http://<Server Name>/api/v1/documents/all?q=término de búsqueda
Para usar esta funcionalidad, debe establecer api.search.scroll en true en fess_config.properties.
Parámetros de solicitud
Los parámetros de solicitud disponibles son los siguientes:
| q | Término de búsqueda. Se pasa con codificación URL. |
| num | Número de resultados a mostrar. El valor predeterminado es 20. Se pueden mostrar hasta 100 resultados. |
| sort | Ordenar. Se utiliza para ordenar los resultados de búsqueda. |
Tabla: Parámetros de solicitud
Respuesta de error
Si la API de búsqueda falla, se devuelve una respuesta de error como la siguiente:
| Código de estado | Descripción |
| 400 Bad Request | Cuando los parámetros de solicitud son incorrectos |
| 500 Internal Server Error | Cuando se produce un error interno del servidor |
Ejemplo de respuesta de error:
{
"message": "Invalid request parameter",
"status": 400
}