Topik ini menjelaskan cara membuat koleksi menggunakan SDK untuk Python.
Prasyarat
Kluster telah dibuat. Untuk informasi lebih lanjut, lihat Buat 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
Client.create(
name: str,
dimension: int,
dtype: Union[Type[int], Type[float]] = float,
fields_schema: Optional[Dict[str, Union[Type[str], Type[int], Type[float], Type[bool], Type[long]]]] = None,
metric: str = 'cosine',
timeout: Optional[int] = None
) -> DashVectorResponseContoh
Anda perlu mengganti 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.
import dashvector
client = dashvector.Client(
api_key='YOUR_API_KEY',
endpoint='YOUR_CLUSTER_ENDPOINT'
)
# Buat sebuah koleksi dan atur namanya menjadi quickstart, jumlah dimensi vektor menjadi 4,
# tipe data vektor ke nilai default yaitu float,
# dan metrik jarak menjadi dotproduct.
# Pra-definisikan nama, berat, usia, dan bidang id, serta atur tipe datanya masing-masing ke str, float, int, dan dashvector.long.
# Atur timeout ke -1 untuk mengaktifkan mode asinkron untuk metode create.
ret = client.create(
name='quickstart',
dimension=4,
metric='dotproduct',
dtype=float,
# Untuk mempertahankan kejelasan semantik dari anotasi tipe,
# DashVector mendefinisikan tipe Long melalui modul typing,
# yang menyediakan dukungan anotasi tipe untuk skenario di mana bilangan bulat besar perlu dianotasikan secara eksplisit
fields_schema={'name': str, 'weight': float, 'age': int, 'id': dashvector.long},
timeout=-1
)
# Periksa apakah koleksi berhasil dibuat.
if ret:
print('pembuatan koleksi berhasil!')
# Anda juga dapat menggunakan kode berikut untuk memeriksa apakah koleksi berhasil dibuat.
# from dashvector import DashVectorCode
# if ret.code == DashVectorCode.Success:
# print('pembuatan koleksi berhasil!')Parameter permintaan
Parameter | Tipe | Nilai default | Deskripsi |
name | str | - | Nama koleksi yang akan dibuat. |
dimension | int | - | Jumlah dimensi vektor. |
dtype | Union[Type[int], Type[float]] | float | Opsional. Tipe data vektor. |
fields_schema
| Optional[Dict[str,Union[Type[str], Type[int], Type[float], Type[bool], Type[long]]]] | None | Opsional. Bidang yang telah ditentukan sebelumnya. |
metric | str | cosine | Opsional. Metrik jarak. Nilai valid: Jika nilainya adalah |
timeout | Optional[int] | None |
|
Untuk informasi lebih lanjut tentang keuntungan pra-pendefinisian bidang selama pembuatan koleksi, lihat Tanpa Skema.
Parameter respons
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 |