Create a sorting script using the command line interface - OpenSearch

SortScript es una herramienta de CLI basada en Python para la gestión de scripts de ordenamiento en OpenSearch. Úsela para crear, cargar, compilar, publicar y eliminar scripts de ordenamiento basados en Cava que controlan cómo se ordenan los resultados de búsqueda.

Nota

Asigne a los scripts de ordenamiento nombres distintos de los de las expresiones creadas en la consola de OpenSearch. Ambos pueden referenciarse por nombre en las consultas, por lo que los nombres diferentes evitan confusiones.

Requisitos previos

Antes de empezar, asegúrese de contar con:

Python posterior a la versión 2.7
CLI de SortScript — download the tool
Sus AccessKey ID y AccessKey secret configurados en tools_conf.py

Ciclo de vida de los scripts de ordenamiento

Un script de ordenamiento pasa por las etapas que se indican a continuación:

Etapa	Descripción	¿Repetible antes de publicar?
Cree	Registre un nombre de script vinculado a una versión de la aplicación	No
Cargue el código	Cargue archivos fuente `.cava`	Sí
Compile	Compruebe la sintaxis	Sí
Publique	Promueva a producción; el script se bloquea	No
Elimine	Elimine un script que ya no sea necesario	No
Consulte	Consulte el estado o el código en cualquier momento	No aplicable

Importante

Después de publicarlo, el script queda bloqueado. No podrá cargar código nuevo ni recompilarlo. La eliminación es la única operación disponible.

Gestione los scripts de ordenamiento

Todos los comandos usan los parámetros comunes que se indican a continuación:

Parámetro	Descripción	Ejemplo
`--appName`	Nombre de la aplicación	`script_test`
`--appVersionId`	ID de la versión de la aplicación	`12345678`
`--scriptName`	Nombre del script de ordenamiento	`script1`
`--scriptFileName`	Nombre de un archivo fuente de Cava dentro del script	`BasicSimilarityScorer.cava`
`--localFile`	Ruta local del archivo que se carga	`./BasicSimilarityScorer.cava`

Cree un script de ordenamiento

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

Cargue el código del script

Cargue cada archivo fuente de Cava de forma individual. Para la sintaxis de Cava, consulte la guía de 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

Antes de publicar el script, vuelva a cargar los archivos tantas veces como sea necesario.

Compile el script de ordenamiento

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

Si se devuelven errores de sintaxis, corríjalos y vuelva a compilar. Compile tantas veces como sea necesario antes de publicar.

Publique el script de ordenamiento

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

Importante

La publicación bloquea el script. Ya no podrá cargar código nuevo ni recompilarlo.

Consulte los scripts de ordenamiento

Consulte un script de ordenamiento específico:

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

Enumere todos los scripts de ordenamiento en una versión de la aplicación:

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

Consulte los detalles de los archivos de código

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

Elimine los archivos de código

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

Elimine el script de ordenamiento

Aviso

Antes de eliminar un script de ordenamiento, asegúrese de que no se haga referencia a él en ninguna consulta activa. Si elimina un script que está en uso, esas consultas devolverán errores.

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

Use un script de ordenamiento en una consulta

Para aplicar un script de ordenamiento a los resultados de búsqueda:

Confirme que el script de ordenamiento está publicado.
En la consulta, establezca second_rank_name en el nombre del script de ordenamiento.
Establezca second_rank_type en cava_script.

Parámetros de ejemplo para la consulta:

Parámetro	Valor	Descripción
`second_rank_name`	`script1`	Nombre del script de ordenamiento publicado
`second_rank_type`	`cava_script`	Especifica que el origen del ordenamiento es un script de Cava

Nota

Si el script de ordenamiento especificado en second_rank_name no existe, la consulta devuelve resultados, pero también devuelve un error.