Create a sorting script using the command line interface - OpenSearch

SortScript est un outil CLI basé sur Python permettant de gérer les scripts de tri dans OpenSearch. Utilisez-le pour créer, télécharger, compiler, publier et supprimer des scripts de tri basés sur Cava qui contrôlent le classement des résultats de recherche.

Remarque

Attribuez aux scripts de tri des noms différents de ceux des expressions créées dans la console OpenSearch. Les deux pouvant être référencés par leur nom dans les requêtes, l'utilisation de noms distincts permet d'éviter toute confusion.

Prérequis

Avant de commencer, assurez-vous de disposer des éléments suivants :

Une version de Python supérieure à 2,7
L'outil CLI SortScript — téléchargez l'outil
Votre AccessKey ID et votre AccessKey secret configurés dans tools_conf.py

Cycle de vie d'un script de tri

Un script de tri passe par les étapes suivantes :

Étape	Description	Répétable avant publication ?
Create	Enregistrer un nom de script associé à une version d'application	Non
Upload code	Télécharger les fichiers source `.cava`	Oui
Compile	Vérifier la syntaxe	Oui
Publish	Promouvoir en production ; verrouille le script	Non
Delete	Supprimer un script qui n'est plus nécessaire	Non
View	Inspecter l'état ou le code à tout moment	N/A

Important

Après la publication, le script est verrouillé. Vous ne pouvez ni télécharger de nouveau code ni le recompiler. La suppression est la seule opération disponible.

Gérer les scripts de tri

Toutes les commandes utilisent les paramètres communs suivants :

Paramètre	Description	Exemple
`--appName`	Nom de l'application	`script_test`
`--appVersionId`	ID de version de l'application	`12345678`
`--scriptName`	Nom du script de tri	`script1`
`--scriptFileName`	Nom d'un fichier source Cava au sein du script	`BasicSimilarityScorer.cava`
`--localFile`	Chemin local vers le fichier à télécharger	`./BasicSimilarityScorer.cava`

Créer un script de tri

python ./sortscript create --appName script_test --appVersionId 12345678 --scriptName script1

Télécharger le code du script

Téléchargez chaque fichier source Cava individuellement. Pour la syntaxe Cava, consultez le guide Cava.

python ./sortscript updatecontent --appName script_test --appVersionId 12345678 --scriptName script1 --scriptFileName BasicSimilarityScorer.cava --localFile ./BasicSimilarityScorer.cava
python ./sortscript updatecontent --appName script_test --appVersionId 12345678 --scriptName script1 --scriptFileName IntelligenceAlgorithmScorer.cava --localFile ./IntelligenceAlgorithmScorer.cava

Vous pouvez retélécharger les fichiers autant de fois que nécessaire avant de publier le script.

Compiler le script de tri

python ./sortscript compile --appName script_test --appVersionId 12345678 --scriptName script1

Si des erreurs de syntaxe sont renvoyées, corrigez-les et recompilez. Vous pouvez compiler plusieurs fois avant la publication.

Publier le script de tri

python ./sortscript release --appName script_test --appVersionId 12345678 --scriptName script1

Important

La publication verrouille le script. Vous ne pouvez ni télécharger de nouveau code ni recompiler après cette étape.

Consulter les scripts de tri

Pour afficher un script de tri spécifique :

python ./sortscript list --appName script_test --appVersionId 12345678 --scriptName script1

Pour répertorier tous les scripts de tri d'une version d'application :

python ./sortscript list --appName script_test --appVersionId 12345678

Afficher les détails des fichiers de code

python ./sortscript getcontent --appName script_test --appVersionId 12345678 --scriptName script1 --scriptFileName BasicSimilarityScorer.cava
python ./sortscript getcontent --appName script_test --appVersionId 12345678 --scriptName script1 --scriptFileName IntelligenceAlgorithmScorer.cava

Supprimer des fichiers de code

python ./sortscript deleteScriptFile --appName script_test --appVersionId 12345678 --scriptName script1 --scriptFileName BasicSimilarityScorer.cava
python ./sortscript deleteScriptFile --appName script_test --appVersionId 12345678 --scriptName script1 --scriptFileName IntelligenceAlgorithmScorer.cava

Supprimer le script de tri

Avertissement

Avant de supprimer un script de tri, assurez-vous qu'il n'est référencé dans aucune requête active. La suppression d'un script en cours d'utilisation entraîne des erreurs lors de l'exécution de ces requêtes.

python ./sortscript delete --appName script_test --appVersionId 12345678 --scriptName script1

Utiliser un script de tri dans une requête

Pour appliquer un script de tri aux résultats de recherche :

Confirmez que le script de tri est publié.
Dans la requête, définissez second_rank_name sur le nom du script de tri.
Définissez second_rank_type sur cava_script.

Exemple de paramètres de requête :

Paramètre	Valeur	Description
`second_rank_name`	`script1`	Nom du script de tri publié
`second_rank_type`	`cava_script`	Indique que la source de classement est un script Cava

Remarque

Si le script de tri spécifié dans second_rank_name n'existe pas, la requête renvoie toujours des résultats, mais retourne également une erreur.