API de RelatedQuery

Vision General

La API de RelatedQuery es para gestionar consultas relacionadas de Fess. Puede sugerir palabras clave de busqueda relacionadas para consultas de busqueda especificas.

URL Base

/api/admin/relatedquery

Lista de Endpoints

Metodo Ruta Descripcion
GET/PUT /settings Obtener lista de consultas relacionadas
GET /setting/{id} Obtener consulta relacionada
POST /setting Crear consulta relacionada
PUT /setting Actualizar consulta relacionada
DELETE /setting/{id} Eliminar consulta relacionada

Obtener Lista de Consultas Relacionadas

Solicitud

GET /api/admin/relatedquery/settings
PUT /api/admin/relatedquery/settings

Parametros

Parametro Tipo Requerido Descripcion
size Integer No Numero de elementos por pagina (predeterminado: 20)
page Integer No Numero de pagina (comienza en 0)

Respuesta

{
  "response": {
    "status": 0,
    "settings": [
      {
        "id": "query_id_1",
        "term": "fess",
        "queries": ["fess tutorial", "fess installation", "fess configuration"]
      }
    ],
    "total": 5
  }
}

Obtener Consulta Relacionada

Solicitud

GET /api/admin/relatedquery/setting/{id}

Respuesta

{
  "response": {
    "status": 0,
    "setting": {
      "id": "query_id_1",
      "term": "fess",
      "queries": ["fess tutorial", "fess installation", "fess configuration"],
      "virtualHost": ""
    }
  }
}

Crear Consulta Relacionada

Solicitud

POST /api/admin/relatedquery/setting
Content-Type: application/json

Cuerpo de la Solicitud

{
  "term": "search",
  "queries": ["search tutorial", "search syntax", "advanced search"],
  "virtualHost": ""
}

Descripcion de Campos

Campo Requerido Descripcion
term Si Palabra clave de busqueda
queries Si Array de consultas relacionadas
virtualHost No Host virtual

Respuesta

{
  "response": {
    "status": 0,
    "id": "new_query_id",
    "created": true
  }
}

Actualizar Consulta Relacionada

Solicitud

PUT /api/admin/relatedquery/setting
Content-Type: application/json

Cuerpo de la Solicitud

{
  "id": "existing_query_id",
  "term": "search",
  "queries": ["search tutorial", "search syntax", "advanced search", "search tips"],
  "virtualHost": "",
  "versionNo": 1
}

Respuesta

{
  "response": {
    "status": 0,
    "id": "existing_query_id",
    "created": false
  }
}

Eliminar Consulta Relacionada

Solicitud

DELETE /api/admin/relatedquery/setting/{id}

Respuesta

{
  "response": {
    "status": 0,
    "id": "deleted_query_id",
    "created": false
  }
}

Ejemplos de Uso

Consultas Relacionadas con Productos

curl -X POST "http://localhost:8080/api/admin/relatedquery/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "term": "product",
       "queries": ["product features", "product pricing", "product comparison", "product reviews"]
     }'

Consultas Relacionadas con Ayuda

curl -X POST "http://localhost:8080/api/admin/relatedquery/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "term": "help",
       "queries": ["help center", "help documentation", "help contact support"]
     }'

Informacion de Referencia