Tous les produits
Search

Ce produit

    OpenSearch:config clause

    Centre de documentation

    OpenSearch:config clause

    Dernière mise à jour :Aug 22, 2026

    La clause config gère la pagination, le format de réponse et l'étendue du classement des résultats de recherche.

    Paramètres

    Paramètre Type Obligatoire Valeur valide Par défaut Description
    start INT Non [0, 5000] 0 Décalage du premier document à renvoyer.
    hit INT Non [0, 500] 10 Nombre maximal de documents par ensemble de résultats.
    format STRING Non JSON, fullJSON JSON Format de réponse. Le format fullJSON inclut deux champs supplémentaires : variableValue et sortExprValues.
    rerank_size INT Non [0, 2000] 200 Nombre de documents transmis à l'expression de tri fin.
    total_rank_size INT Non — — Nombre de documents transmis à l'expression de tri grossier.
    default_operator STRING Non AND, OR AND Opérateur de requête par défaut. Pris en charge uniquement pour les instances dédiées.

    Notes d'utilisation

    1. La clause config est facultative.

    2. Séparez les paires clé-valeur par des virgules (,) et chaque clé de sa valeur par un deux-points (:).

    3. La somme des paramètres start et hit ne doit pas dépasser 5 000. Toute requête dépassant cette limite renvoie une erreur sans résultat. Cette restriction s'explique par le fait que la récupération de fenêtres de résultats profondes exige le chargement en mémoire de tous les documents précédents, ce qui accroît considérablement l'utilisation des ressources. Pour paginer au-delà de 5 000 documents, utilisez plutôt une recherche par défilement.

    4. Le paramètre default_operator est pris en charge uniquement pour les instances dédiées.

    5. La syntaxe du paramètre total_rank_size varie selon le SDK utilisé :

      • SDK Java : config.addToCustomConfig("total_rank_size:200000");

      • SDK PHP : $params->setCustomConfig('total_rank_size', 200000);

    6. Pour inclure les détails du tri dans la réponse, ajoutez format:fulljson à la clause config. Le champ sortExprValues de la réponse contient un tableau des valeurs des champs de tri correspondant à la clause de tri. Par exemple, avec sort=-price;-RANK, sortExprValues renvoie [price, Document score]. En l'absence de clause de tri configurée, sortExprValues renvoie par défaut le score du document.

    Format de réponse : JSON vs fullJSON

    Champ JSON fullJSON
    Champs de résultat standard Oui Oui
    variableValue — Oui
    sortExprValues — Oui

    Utilisez le format fullJSON pour inspecter les scores de tri par document ou les valeurs d'expression de variable, notamment lors du débogage du comportement de classement.

    Exemples

    Paginer les résultats — 20 documents par page

    # Page 1
config=start:0, hit:20, format:xml

# Page 2
config=start:20, hit:20, format:xml
    Le document source utilise format:xml dans cet exemple de pagination. Toutefois, le tableau des paramètres ne répertorie que JSON et fullJSON comme valeurs de format prises en charge. Cette incohérence figure dans la source originale et a été signalée à l'équipe produit pour examen.

    Définir le pool de candidats pour le tri fin à 1 000 documents

    config=start:0, hit:20, rerank_size:1000

    Limiter le tri grossier à 100 documents

    config=start:0, hit:20, total_rank_size:100

    Étapes suivantes