tablestore-agent-cli memungkinkan Anda mengelola memory store, menulis memori, mengambil memori jangka panjang, melakukan kueri memori jangka pendek, mengaudit permintaan, dan mengakses dashboard. CLI ini cocok untuk debugging lokal, operasi dan pemeliharaan, serta skrip otomatisasi.
Instalasi
Instal CLI secara global dengan npm. Diperlukan Node.js versi 18 atau yang lebih baru.
npm install -g @tablestore/tablestore-agent-cli
tablestore-agent-cli versionKonfigurasi
Sebelum menggunakan CLI untuk pertama kali, Anda harus mengonfigurasi kredensial akses, instans Tablestore, dan nilai default untuk layanan memori. CLI menyimpan pengaturan ini ke file konfigurasi lokal. Variabel lingkungan memiliki prioritas lebih tinggi daripada file konfigurasi.
Konfigurasi kredensial akses
tablestore-agent-cli configure set access_key_id '...'
tablestore-agent-cli configure set access_key_secret '...'
tablestore-agent-cli configure set region 'cn-beijing'Konfigurasi instans Tablestore
tablestore-agent-cli configure set ots_endpoint 'https://<instance>.cn-beijing.ots.aliyuncs.com'
tablestore-agent-cli configure set ots_instance_name '<instance-name>'Jika Anda tidak mengonfigurasi ots_endpoint dan ots_instance_name, CLI akan secara otomatis membuat dan menggunakan kembali instans Tablestore terkelola saat Anda menjalankan perintah doctor atau melakukan operasi apa pun.
Konfigurasi nilai default layanan memori
tablestore-agent-cli configure set memory_store_name 'agent_memory'
tablestore-agent-cli configure set memory_app_id 'app-001'
tablestore-agent-cli configure set memory_tenant_id 'tenant-001'
tablestore-agent-cli configure set memory_agent_id 'agent-001'
tablestore-agent-cli configure set memory_run_id 'run-001'Setelah mengonfigurasi nilai default ini, Anda dapat menghilangkan parameter yang sesuai dalam perintah berikutnya.
File konfigurasi dan variabel lingkungan
File konfigurasi berada di lokasi berikut:
~/.config/tablestore-agent-cli/config.tomlVariabel lingkungan memiliki prioritas lebih tinggi daripada file konfigurasi. Tabel berikut menunjukkan pemetaan antara keduanya.
Variabel lingkungan | Parameter |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Diagnostik
Jalankan perintah doctor memory untuk memeriksa kredensial akses, konfigurasi instans Tablestore, dan konektivitas ke layanan memori. Jika ada pemeriksaan yang gagal, perintah tersebut akan mengembalikan kode keluar non-nol.
tablestore-agent-cli doctor memoryMengelola penyimpanan memori
Memory store adalah unit penyimpanan untuk memori jangka panjang dan jangka pendek. Setiap memory store dipetakan ke satu set tabel data dan indeks dalam instans Tablestore.
Buat memory store
tablestore-agent-cli memory create --store agent_memory --description "Agent long-term memory store"Setelah membuat memory store, layanan akan menginisialisasi indeks sekundernya secara asinkron. Anda harus menunggu sekitar 1 menit hingga indeks siap sebelum dapat menulis data dan melakukan pencarian.
Daftar penyimpanan memori
tablestore-agent-cli memory list
tablestore-agent-cli memory ls --limit 50 --next-token <token>ls adalah alias untuk list. Perintah ini mengembalikan satu halaman hasil. Untuk mengambil halaman berikutnya, gunakan nextToken dari respons.
Lihat memory store
tablestore-agent-cli memory describe --store agent_memory
tablestore-agent-cli memory show --store agent_memoryshow adalah alias untuk describe.
Memperbarui penyimpanan memori
tablestore-agent-cli memory update --store agent_memory --description "New description"Hapus memory store
tablestore-agent-cli memory delete --store agent_memory
tablestore-agent-cli memory rm --store agent_memory -yrm adalah alias untuk delete. Di lingkungan TTY, CLI akan meminta konfirmasi sebelum penghapusan. Gunakan flag -y untuk melewati konfirmasi.
Menulis memori
Untuk menulis memori, Anda harus menentukan cakupan lengkap, yang mencakup app-id, tenant-id, agent-id, dan run-id. Karakter wildcard * tidak diperbolehkan dalam cakupan untuk perintah tulis.
Tambahkan memori berdasarkan teks
Gunakan flag --text untuk meneruskan teks yang telah diproses secara langsung:
tablestore-agent-cli memory add \
--store agent_memory \
--app-id app-001 \
--tenant-id user-001 \
--agent-id assistant \
--run-id session-001 \
--text "The user likes to drink coffee."Penulisan sinkron
Secara default, operasi tulis berjalan dalam mode asinkron, artinya server mengekstraksi memori dari teks di latar belakang. Gunakan flag --sync agar memori segera tersedia untuk pengambilan.
tablestore-agent-cli memory add \
--store agent_memory \
--app-id app-001 \
--tenant-id user-001 \
--agent-id assistant \
--run-id session-001 \
--text "The user prefers a concise response style." \
--syncTambahkan memori berdasarkan file pesan
Gunakan flag --messages-file untuk meneruskan daftar pesan percakapan. Konten file harus berupa array JSON.
tablestore-agent-cli memory add \
--store agent_memory \
--app-id app-001 \
--tenant-id user-001 \
--agent-id assistant \
--run-id session-001 \
--messages-file ./messages.jsonLampirkan metadata
Gunakan flag --metadata untuk meneruskan string JSON dan melampirkan bidang kustom:
tablestore-agent-cli memory add \
--store agent_memory \
--app-id app-001 \
--text "The user likes Sichuan food." \
--metadata '{"source":"chat","topic":"preference"}'Cari memori jangka panjang
Gunakan perintah memory search untuk melakukan pencarian semantik. Dalam cakupan, parameter tenant-id, agent-id, dan run-id mendukung karakter wildcard * untuk menggabungkan hasil dari berbagai cakupan.
tablestore-agent-cli memory search \
--store agent_memory \
--app-id app-001 \
--tenant-id user-001 \
--agent-id '*' \
--run-id '*' \
--query "What food does the user like?" \
--top-k 5Nilai default untuk --top-k adalah 10, dan nilainya harus berada dalam rentang 1 hingga 50.
Untuk menonaktifkan rerank:
tablestore-agent-cli memory search \
--store agent_memory \
--app-id app-001 \
--tenant-id user-001 \
--query "User preferences" \
--disable-rerankRerank diaktifkan secara default. Gunakan flag --disable-rerank untuk menonaktifkannya. Saat rerank dinonaktifkan, hasil diurutkan hanya berdasarkan jarak vektor.
Untuk memfilter berdasarkan kecocokan metadata eksak:
tablestore-agent-cli memory search \
--store agent_memory \
--app-id app-001 \
--tenant-id user-001 \
--query "User preferences" \
--metadata '{"source":"chat"}'Setiap elemen dalam daftar results pada respons berisi unit (unit memori) yang cocok dan score-nya. Bidang dalam objek unit menggunakan snake_case. Untuk informasi selengkapnya, lihat Referensi API.
Mengelola memori jangka panjang
Anda dapat melakukan kueri, memperbarui, dan menghapus satu unit memori jangka panjang. memory-id dikembalikan oleh respons perintah memory add atau perintah list-units. Untuk mengambil, memperbarui, atau menghapus satu unit memori, Anda harus memberikan Scope lengkap yang konsisten dengan yang digunakan saat operasi tulis. Artinya keempat segmen (app-id, tenant-id, agent-id, dan run-id) harus ditentukan, dan karakter wildcard * tidak diperbolehkan.
Daftar unit memori
tablestore-agent-cli memory list-units --store agent_memory --app-id app-001
tablestore-agent-cli memory ls-units --store agent_memory --app-id app-001 --limit 20 --next-token <token>ls-units adalah alias untuk list-units.
Ambil memori tunggal
tablestore-agent-cli memory get \
--store agent_memory \
--memory-id mem-001 \
--app-id app-001 \
--tenant-id user-001 \
--agent-id assistant \
--run-id session-001cat adalah alias untuk get.
Perbarui memori tunggal
tablestore-agent-cli memory update-unit \
--store agent_memory \
--memory-id mem-001 \
--app-id app-001 \
--tenant-id user-001 \
--agent-id assistant \
--run-id session-001 \
--text "The user prefers coffee and concise answers."Hapus memori tunggal
tablestore-agent-cli memory delete-unit \
--store agent_memory \
--memory-id mem-001 \
--app-id app-001 \
--tenant-id user-001 \
--agent-id assistant \
--run-id session-001rm-unit adalah alias untuk delete-unit.
Kueri memori jangka pendek dan log audit
Kueri memori jangka pendek
tablestore-agent-cli memory msg-list \
--store agent_memory \
--app-id app-001 \
--tenant-id user-001 \
--agent-id assistant \
--run-id session-001Untuk melakukan kueri memori jangka pendek, Anda harus menentukan cakupan empat bagian lengkap, termasuk app-id, tenant-id, agent-id, dan run-id. Karakter wildcard * tidak diperbolehkan. ls-msgs adalah alias untuk msg-list.
Kueri log audit permintaan
Gunakan flag --operation untuk memfilter catatan audit permintaan berdasarkan jenis operasi. Dalam cakupan, parameter tenant-id, agent-id, dan run-id mendukung karakter wildcard *.
tablestore-agent-cli memory req-list \
--store agent_memory \
--app-id app-001 \
--tenant-id '*' \
--agent-id '*' \
--run-id '*' \
--operation AddMemoriesls-reqs adalah alias untuk req-list.
Output yang ramah skrip
Saat memanggil CLI dari skrip atau agen, gunakan flag -q (atau --quiet) untuk hanya mengeluarkan bidang data dari respons, yang menyederhanakan pemrosesan pipeline.
tablestore-agent-cli -q memory search \
--store agent_memory \
--app-id app-001 \
--tenant-id user-001 \
--query "What drinks does the user like?"Dashboard
CLI menyertakan dashboard web bawaan untuk manajemen visual dan debugging.
tablestore-agent-cli dashboard start
tablestore-agent-cli dashboard start -p 9999
tablestore-agent-cli dashboard start --host 0.0.0.0Secara default, dashboard mendengarkan pada 127.0.0.1:3000. Buka alamat ini di browser Anda untuk mengaksesnya. Gunakan flag -p untuk menentukan port kustom. Gunakan --host 0.0.0.0 untuk mengizinkan akses dari mesin lain.