Topik ini menjelaskan cara mendapatkan satu atau beberapa dokumen dalam koleksi berdasarkan ID dokumen atau daftar ID menggunakan SDK untuk Python.
Jika ID yang ditentukan tidak ada, keluaran yang sesuai akan kosong.
Prasyarat
Kluster telah dibuat. Untuk informasi lebih lanjut, lihat Buat sebuah kluster.
Kunci API telah diperoleh. Untuk informasi lebih lanjut, lihat Kelola Kunci API.
SDK versi terbaru telah diinstal. Untuk informasi lebih lanjut, lihat Instal DashVector SDK.
Definisi API
collection.fetch(
ids: Union[str, List[str]],
partition: Optional[str] = None,
async_req: bool = False
) -> DashVectorResponseContoh
Ganti YOUR_API_KEY dengan kunci API Anda dan YOUR_CLUSTER_ENDPOINT dengan titik akhir kluster Anda dalam kode contoh agar kode dapat berjalan dengan benar.
Buat koleksi bernama
quickstartterlebih dahulu. Untuk informasi lebih lanjut, lihat bagian "Contoh" dari topik Buat sebuah koleksi. Sisipkan beberapa dokumen terlebih dahulu. Untuk informasi lebih lanjut, lihat Sisipkan dokumen.
import dashvector
client = dashvector.Client(
api_key='YOUR_API_KEY',
endpoint='YOUR_CLUSTER_ENDPOINT'
)
collection = client.get(name='quickstart')
doc_id = '1'
docs = collection.fetch(doc_id)
# Periksa apakah metode fetch berhasil dipanggil.
if docs:
print('fetch sukses')
# Periksa apakah ID dokumen yang ingin diperoleh ada. Jika tidak, keluaran yang sesuai akan kosong.
if doc_id in docs:
doc = docs[doc_id]
print(doc.id)
print(doc.vector)
print(doc.fields)
# Lintasi semua dokumen dan kembalikan hasilnya.
for id in docs:
print(docs[id])
# Dapatkan beberapa dokumen sekaligus.
docs = collection.fetch(['1','2']) Parameter permintaan
Parameter | Tipe | Nilai default | Deskripsi |
ids | Union[Union[str, int], List[Union[str, int]]] | - | Kunci utama atau daftar kunci utama. |
partition | Optional[str] | None | Opsional. Nama partisi. |
async_req | bool | False | Opsional. Menentukan apakah akan mengaktifkan mode asinkron. |
Parameter respons
Sebuah objek DashVectorResponse dikembalikan, yang berisi hasil operasi seperti yang dijelaskan dalam tabel berikut.
Parameter | Tipe | Deskripsi | Contoh |
code | int | Kode status yang dikembalikan. Untuk informasi lebih lanjut, lihat Kode status. | 0 |
message | str | Pesan yang dikembalikan. | sukses |
request_id | str | ID unik dari permintaan. | 19215409-ea66-4db9-8764-26ce2eb5bb99 |
output | Dict[str, Doc] | Kamus dengan kunci diatur ke kunci utama dan nilai diatur ke objek Doc. |