Buat skrip pengurutan menggunakan antarmuka baris perintah - OpenSearch

SortScript adalah alat CLI berbasis Python untuk mengelola skrip pengurutan di OpenSearch. Gunakan alat ini untuk membuat, mengunggah, mengompilasi, menerbitkan, dan menghapus skrip pengurutan berbasis Cava yang mengontrol cara hasil pencarian diurutkan.

Catatan

Berikan nama skrip pengurutan yang berbeda dari ekspresi yang dibuat di Konsol OpenSearch. Keduanya dapat dirujuk dalam kueri berdasarkan nama, sehingga penggunaan nama yang berbeda mencegah kebingungan.

Prasyarat

Sebelum memulai, pastikan Anda telah memiliki:

Python versi lebih baru dari 2.7
SortScript CLI — unduh alat tersebut
ID AccessKey dan Rahasia AccessKey yang telah dikonfigurasi di tools_conf.py

Siklus hidup skrip pengurutan

Skrip pengurutan melewati tahapan-tahapan berikut:

Tahap	Deskripsi	Dapat diulang sebelum publish?
Create	Mendaftarkan nama skrip yang terkait dengan versi aplikasi	Tidak
Upload code	Mengunggah file sumber `.cava`	Ya
Compile	Memverifikasi sintaks	Ya
Publish	Mempromosikan ke produksi; mengunci skrip	Tidak
Delete	Menghapus skrip yang tidak lagi diperlukan	Tidak
View	Memeriksa status atau kode kapan saja	Tidak Berlaku

Penting

Setelah dipublikasikan, skrip akan terkunci. Anda tidak dapat mengunggah kode baru atau mengompilasi ulang. Satu-satunya operasi yang tersedia adalah penghapusan.

Kelola skrip pengurutan

Semua perintah menggunakan parameter umum berikut:

Parameter	Deskripsi	Contoh
`--appName`	Nama aplikasi	`script_test`
`--appVersionId`	ID versi aplikasi	`12345678`
`--scriptName`	Nama skrip pengurutan	`script1`
`--scriptFileName`	Nama file sumber Cava dalam skrip	`BasicSimilarityScorer.cava`
`--localFile`	Path lokal ke file yang diunggah	`./BasicSimilarityScorer.cava`

Buat skrip pengurutan

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

Unggah kode skrip

Unggah setiap file sumber Cava satu per satu. Untuk sintaks Cava, lihat panduan 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

Anda dapat mengunggah ulang file sebanyak yang diperlukan sebelum menerbitkan skrip.

Kompilasi skrip pengurutan

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

Jika terdapat error sintaks, perbaiki lalu kompilasi ulang. Anda dapat mengompilasi berulang kali sebelum menerbitkan.

Terbitkan skrip pengurutan

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

Penting

Penerbitan mengunci skrip. Anda tidak dapat mengunggah kode baru atau mengompilasi ulang setelah titik ini.

Lihat skrip pengurutan

Untuk melihat skrip pengurutan tertentu:

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

Untuk menampilkan semua skrip pengurutan dalam versi aplikasi:

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

Lihat detail file kode

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

Hapus file kode

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

Hapus skrip pengurutan

Peringatan

Sebelum menghapus skrip pengurutan, pastikan skrip tersebut tidak dirujuk dalam kueri aktif apa pun. Menghapus skrip yang sedang digunakan menyebabkan kueri tersebut mengembalikan error.

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

Gunakan skrip pengurutan dalam kueri

Untuk menerapkan skrip pengurutan pada hasil pencarian:

Pastikan skrip pengurutan telah dipublikasikan.
Dalam kueri, atur second_rank_name ke nama skrip pengurutan.
Atur second_rank_type ke cava_script.

Contoh parameter kueri:

Parameter	Nilai	Deskripsi
`second_rank_name`	`script1`	Nama skrip pengurutan yang telah dipublikasikan
`second_rank_type`	`cava_script`	Menentukan bahwa sumber pengurutan berasal dari skrip Cava

Catatan

Jika skrip pengurutan yang ditentukan dalam second_rank_name tidak ada, kueri tetap mengembalikan hasil namun juga mengembalikan error.