La cláusula config permite especificar configuraciones como la posición del primer documento por devolver, la cantidad de documentos por devolver, el formato de datos de los resultados y el número de documentos que se ordenarán mediante una expresión de ordenamiento fino.
Descripción de la sintaxis
|
Parámetro |
Tipo |
Obligatorio |
Valor válido |
Valor predeterminado |
Descripción |
|
start |
int |
No |
[0, 5000] |
0 |
Número ordinal del primer documento que se devolverá en los resultados de búsqueda. |
|
hit |
int |
No |
[0, 500] |
10 |
Cantidad máxima de documentos que se pueden devolver. |
|
format |
string |
No |
json |
Formato de datos de los resultados devueltos. Los formatos JSON y fullJSON son compatibles. En comparación con el formato JSON, fullJSON admite campos adicionales, como variableValue y sortExprValues. |
|
|
rerank_size |
int |
No |
[0, 2000] |
200 |
Cantidad de documentos que se ordenarán mediante una expresión de ordenamiento fino basada en una columna. |
|
total_rank_size |
int |
No |
- |
- |
Cantidad de documentos que se ordenarán mediante una expresión de ordenamiento preliminar. |
|
total_rerank_size |
int |
No |
[0,10000] |
- |
Cantidad de documentos que se ordenarán mediante una expresión de ordenamiento fino. |
|
default_operator |
string |
No |
'AND' u 'OR' |
AND |
Operador de consulta predeterminado para esta consulta. Nota: Este parámetro solo es compatible con instancias exclusivas. |
Notas de uso
La cláusula config es opcional.
Separe los pares clave-valor de los parámetros con comas (,).
Separe la clave y el valor de cada parámetro con dos puntos (:).
Asegúrese de que la suma de los valores de los parámetros start y hit no exceda 5,000. De lo contrario, se producirá un error y no se devolverán resultados. Si necesita obtener más de 5,000 entradas de datos en varias páginas, realice una búsqueda de desplazamiento para exportar los documentos a la vez e implementar la paginación. Para obtener más información, consulte Scroll searches.
El parámetro default_operator solo es compatible con instancias exclusivas.
El parámetro total_rank_size se especifica en diferentes formatos según el SDK de OpenSearch para cada lenguaje. En el SDK de OpenSearch para Java, especifique este parámetro con el siguiente formato:
config.addToCustomConfig("total_rank_size:200000");. En el SDK de OpenSearch para PHP, especifique este parámetro con el siguiente formato:$params->setCustomConfig('total_rank_size', 200000);.-
Consulte los detalles de ordenamiento de los documentos al agregar un parámetro a su código.
Método: Agregue el parámetro format:fulljson a una cláusula config.
En los resultados devueltos, el parámetro sortExprValues indica la información de ordenamiento de un documento.
-
"sortExprValues": [ "10000.0340123586" ]El valor del parámetro sortExprValues es una matriz que corresponde al valor del campo de ordenamiento en una cláusula de ordenamiento. Ejemplo:
sort=-price;-RANKEn este caso, el valor del parámetro sortExprValues tiene el formato [precio, puntuación del documento].
Si no configura una cláusula de ordenamiento, el valor del parámetro sortExprValues será la puntuación del documento de forma predeterminada.
Ejemplos
-
Configure la paginación. En este ejemplo, se devuelven 20 documentos por página.
# The config clause for the first page. config=start:0, hit:20, format:json # The config clause for the second page. config=start:20, hit:20, format:json -
Establezca en 1000 la cantidad de documentos que se ordenarán mediante una expresión de ordenamiento fino.
config=start:0, hit:20, rerank_size:1000 -
Establezca en 100 la cantidad máxima de documentos por recuperar.
config=start:0, hit:20, total_rank_size:100