Kueri istilah - Tablestore SDK untuk Python - Tablestore

Gunakan Tablestore SDK untuk Python untuk mencocokkan nilai bidang atau token yang persis sama dengan salah satu nilai kueri yang ditentukan.

Prasyarat

Instal Tablestore SDK untuk Python dan inisialisasi klien.

Deskripsi

Kueri istilah mencocokkan beberapa nilai dalam suatu bidang. Suatu baris cocok jika salah satu nilai kueri merupakan kecocokan eksak. Untuk bidang non-teks seperti Keyword dan Long, nilai bidang harus persis sama dengan salah satu nilai kueri. Ini mirip dengan kondisi SQL IN. Untuk bidang Text, suatu baris cocok jika salah satu token persis sama dengan salah satu nilai kueri. Nilai kueri tidak ditokenisasi. Tokenisasi dapat berbeda tergantung pada konfigurasi alat analisis, pembaruan algoritma, dan bahasa. Jangan gunakan kueri istilah untuk mencocokkan string lengkap dalam bidang Text. Saat memanggil metode search, atur jenis kueri menjadi TermsQuery. Untuk informasi mengenai jenis bidang, lihat Jenis string.

TermsQuery(field_name, column_values, weight=None)

Contoh berikut mengkueri baris di mana bidang category persis sama dengan books atau games, serta mengembalikan hingga 10 baris dan jumlah total baris yang cocok.

query = TermsQuery("category", ["books", "games"])
search_query = SearchQuery(
    query,
    limit=10,
    get_total_count=True,
)
response = client.search(
    "example_table",
    "example_index",
    search_query,
    ColumnsToGet(return_type=ColumnReturnType.ALL),
)
print(response.total_count)
for row in response.rows:
    print(row)

Parameter

Permintaan pencarian

Metode search mencakup parameter berikut.

Nama	Jenis	Deskripsi
table_name (wajib)	`str`	Nama tabel data.
index_name (wajib)	`str`	Nama indeks pencarian.
search_query (wajib)	`SearchQuery`	Kondisi kueri dan konfigurasi kueri umum.
columns_to_get (opsional)	`ColumnsToGet`	Konfigurasi kolom yang dikembalikan. Jika parameter ini tidak ditentukan, hanya kolom kunci primer yang dikembalikan.
routing_keys (opsional)	`list`	Daftar nilai kunci primer untuk bidang routing kustom. Anda tidak perlu menentukan parameter ini jika routing kustom tidak dikonfigurasi.
timeout_s (opsional)	`int`	Timeout permintaan dalam detik. Jika parameter ini tidak ditentukan, timeout tingkat client akan digunakan.

Konfigurasi kueri

search_query bertipe SearchQuery dan mencakup parameter berikut.

Nama	Jenis	Deskripsi
query (wajib)	`Query`	Kondisi kueri. Atur parameter ini ke `TermsQuery`.
sort (opsional)	`Sort`	Urutan pengurutan hasil kueri. Untuk informasi selengkapnya, lihat Mengurutkan dan membagi halaman hasil.
get_total_count (opsional)	`bool`	Menentukan apakah jumlah total baris yang cocok dikembalikan. Nilai default: `False`. Mengatur parameter ini ke `True` meningkatkan beban kueri.
next_token (opsional)	`bytes`	Token paginasi. Atur parameter ini ke `next_token` dari respons sebelumnya untuk mengambil halaman berikutnya. Untuk informasi selengkapnya, lihat Mengurutkan dan membagi halaman hasil.
offset (opsional)	`int`	Offset tempat kueri saat ini dimulai. Gunakan parameter ini untuk paginasi dangkal.
limit (opsional)	`int`	Jumlah maksimum baris yang dikembalikan. Jika parameter ini diatur ke `0`, tidak ada data baris yang dikembalikan.
aggs (opsional)	`list[Agg]`	Konfigurasi agregasi. Untuk informasi selengkapnya, lihat Agregasi.
group_bys (opsional)	`list[BaseGroupBy]`	Konfigurasi pengelompokan. Untuk informasi selengkapnya, lihat Agregasi.
collapse_field (opsional)	`Collapse`	Konfigurasi pelipatan hasil, yang menghapus hasil duplikat berdasarkan bidang tertentu. Untuk informasi selengkapnya, lihat Melipat hasil kueri.
highlight (opsional)	`Highlight`	Konfigurasi ringkasan dan penyorotan untuk bidang `Text`. Untuk informasi selengkapnya, lihat Ringkasan dan penyorotan.

Kondisi kueri

search_query.query bertipe TermsQuery dan mencakup parameter berikut.

Nama	Jenis	Deskripsi
field_name (wajib)	`str`	Nama bidang terindeks yang akan dikueri.
column_values (wajib)	`list`	Daftar nilai kueri. Anda dapat menentukan hingga 1.024 nilai. Suatu baris cocok jika salah satu nilai kueri merupakan kecocokan eksak. Untuk bidang `Text`, setiap nilai digunakan sebagai token lengkap dan tidak ditokenisasi.
weight (opsional)	`float`	Bobot relevansi kondisi kueri. Nilainya harus berupa bilangan titik mengambang positif. Nilai yang lebih besar memberikan kontribusi lebih besar terhadap skor relevansi BM25. Parameter ini tidak memengaruhi kecocokan atau jumlah baris yang dikembalikan. Parameter ini hanya memengaruhi urutan ketika hasil diurutkan berdasarkan skor relevansi. Nilai default: `1.0`.

Kolom yang dikembalikan

columns_to_get bertipe ColumnsToGet dan mencakup parameter berikut.

Nama	Jenis	Deskripsi
column_names (opsional)	`list[str]`	Nama kolom atribut yang dikembalikan. Tentukan parameter ini hanya ketika `return_type` bernilai `SPECIFIED`.
return_type (opsional)	`ColumnReturnType`	Mode kolom yang dikembalikan. `NONE` (default) hanya mengembalikan kolom kunci primer; `SPECIFIED` mengembalikan kolom atribut dalam `column_names`; `ALL` mengembalikan semua kolom atribut dari tabel; dan `ALL_FROM_INDEX` mengembalikan semua kolom atribut terindeks.

Respons

Metode search mengembalikan SearchResponse. Tabel berikut menjelaskan bidang intinya.

Bidang	Jenis	Deskripsi
rows	`list[Row]`	Baris yang dikembalikan oleh kueri saat ini. Jumlah baris tidak melebihi `limit`.
next_token	`bytes`	Token untuk halaman berikutnya. Jika bidang ini tidak kosong, berikan ke permintaan berikutnya untuk melanjutkan pembacaan.
total_count	`int`	Jumlah baris yang cocok. Nilainya bergantung pada konfigurasi `get_total_count`.
is_all_succeed	`bool`	Menunjukkan apakah semua partisi indeks telah dikueri. Jika nilainya `False`, hasil parsial dikembalikan dan `total_count` mungkin kurang dari jumlah aktual baris yang cocok.
agg_results	`list[AggResult]`	Hasil agregasi. Bidang ini kosong jika `aggs` tidak dikonfigurasi.
group_by_results	`list[GroupByResult]`	Hasil pengelompokan. Bidang ini kosong jika `group_bys` tidak dikonfigurasi.
search_hits	`list[SearchHit]`	Hit pencarian, termasuk informasi tambahan seperti skor relevansi, sorotan, dan baris anak yang cocok.

Respons kompatibel Tupel

Mulai Tablestore SDK untuk Python versi 5.2.0, API pencarian mengembalikan objek respons, bukan tupel. Versi 5.1.0 dan sebelumnya mengembalikan tupel secara langsung. Pada versi 5.2.1 dan seterusnya, Anda dapat memanggil SearchResponse.v1_response() untuk mendapatkan tupel yang kompatibel dengan versi sebelumnya. Untuk kode baru, akses atribut SearchResponse secara langsung guna menghindari kesalahan unpacking jika bidang respons diperluas.

(
    rows,
    next_token,
    total_count,
    is_all_succeed,
    agg_results,
    group_by_results,
    search_hits,
) = response.v1_response()