Technical reference

Referensi konfigurasi memori

Halaman ini mencantumkan setiap kenop konfigurasi untuk pencarian memori OpenClaw. Untuk ikhtisar konseptual, lihat:

Semua pengaturan pencarian memori berada di bawah agents.defaults.memorySearch dalam openclaw.json, kecuali dinyatakan lain.


Pemilihan provider

Kunci Tipe Default Deskripsi
provider string "openai" ID adaptor embedding seperti bedrock, deepinfra, gemini, github-copilot, local, mistral, ollama, openai, openai-compatible, atau voyage; juga dapat berupa models.providers.<id> yang dikonfigurasi dengan api yang menunjuk ke adaptor embedding memori atau API model kompatibel OpenAI
model string default provider Nama model embedding
fallback string "none" ID adaptor fallback ketika yang utama gagal
enabled boolean true Mengaktifkan atau menonaktifkan pencarian memori

Ketika provider tidak diatur, OpenClaw menggunakan embedding OpenAI. Atur provider secara eksplisit untuk menggunakan Gemini, Voyage, Mistral, DeepInfra, Bedrock, GitHub Copilot, Ollama, model GGUF lokal, atau endpoint /v1/embeddings yang kompatibel dengan OpenAI. Konfigurasi lama yang masih menyatakan provider: "auto" diselesaikan menjadi openai.

Ketika provider tidak ditetapkan, provider: "auto" lama ada, atau provider: "none" sengaja memilih mode hanya FTS, recall memori masih dapat menggunakan peringkat FTS leksikal saat embedding tidak tersedia.

Provider non-lokal eksplisit gagal secara tertutup. Jika Anda mengatur memorySearch.provider ke provider konkret yang didukung jarak jauh seperti OpenAI, Gemini, Voyage, Mistral, Bedrock, GitHub Copilot, DeepInfra, Ollama, LM Studio, atau provider kustom yang kompatibel dengan OpenAI, dan provider tersebut tidak tersedia saat runtime, memory_search mengembalikan hasil tidak tersedia alih-alih diam-diam menggunakan recall hanya FTS. Perbaiki konfigurasi provider/auth, beralih ke provider yang dapat dijangkau, atau atur provider: "none" jika Anda menginginkan recall hanya FTS secara sengaja.

ID provider kustom

memorySearch.provider dapat menunjuk ke entri models.providers.<id> kustom untuk adaptor provider khusus memori seperti ollama, atau untuk API model kompatibel OpenAI seperti openai-responses / openai-completions. OpenClaw menyelesaikan pemilik api provider tersebut untuk adaptor embedding sambil mempertahankan ID provider kustom untuk penanganan endpoint, auth, dan prefiks model. Ini memungkinkan setup multi-GPU atau multi-host mendedikasikan embedding memori ke endpoint lokal tertentu:

json5
{  models: {    providers: {      "ollama-5080": {        api: "ollama",        baseUrl: "http://gpu-box.local:11435",        apiKey: "ollama-local",        models: [{ id: "qwen3-embedding:0.6b" }],      },    },  },  agents: {    defaults: {      memorySearch: {        provider: "ollama-5080",        model: "qwen3-embedding:0.6b",      },    },  },}

Resolusi kunci API

Embedding jarak jauh memerlukan kunci API. Bedrock menggunakan rantai kredensial default AWS SDK sebagai gantinya (peran instance, SSO, kunci akses).

Provider Env var Kunci konfigurasi
Bedrock Rantai kredensial AWS Tidak perlu kunci API
DeepInfra DEEPINFRA_API_KEY models.providers.deepinfra.apiKey
Gemini GEMINI_API_KEY models.providers.google.apiKey
GitHub Copilot COPILOT_GITHUB_TOKEN, GH_TOKEN, GITHUB_TOKEN Profil auth melalui login perangkat
Mistral MISTRAL_API_KEY models.providers.mistral.apiKey
Ollama OLLAMA_API_KEY (placeholder) --
OpenAI OPENAI_API_KEY models.providers.openai.apiKey
Voyage VOYAGE_API_KEY models.providers.voyage.apiKey

Konfigurasi endpoint jarak jauh

Gunakan provider: "openai-compatible" untuk server /v1/embeddings generik yang kompatibel dengan OpenAI dan tidak boleh mewarisi kredensial chat OpenAI global.

remote.baseUrlstring

URL dasar API kustom.

remote.apiKeystring

Menimpa kunci API.

remote.headersobject

Header HTTP tambahan (digabungkan dengan default provider).

json5
{  agents: {    defaults: {      memorySearch: {        provider: "openai-compatible",        model: "text-embedding-3-small",        remote: {          baseUrl: "https://api.example.com/v1/",          apiKey: "YOUR_KEY",        },      },    },  },}

Konfigurasi khusus provider

Gemini
Kunci Tipe Default Deskripsi
model string gemini-embedding-001 Juga mendukung gemini-embedding-2-preview
outputDimensionality number 3072 Untuk Embedding 2: 768, 1536, atau 3072
Jenis input kompatibel OpenAI

Endpoint embedding yang kompatibel dengan OpenAI dapat memilih untuk menggunakan bidang permintaan input_type khusus provider. Ini berguna untuk model embedding asimetris yang memerlukan label berbeda untuk embedding kueri dan dokumen.

Kunci Tipe Default Deskripsi
inputType string tidak disetel input_type bersama untuk embedding kueri dan dokumen
queryInputType string tidak disetel input_type saat kueri; menimpa inputType
documentInputType string tidak disetel input_type indeks/dokumen; menimpa inputType
json5
{  agents: {    defaults: {      memorySearch: {        provider: "openai-compatible",        remote: {          baseUrl: "https://embeddings.example/v1",          apiKey: "${EMBEDDINGS_API_KEY}",        },        model: "asymmetric-embedder",        queryInputType: "query",        documentInputType: "passage",      },    },  },}

Mengubah nilai-nilai ini memengaruhi identitas cache embedding untuk pengindeksan batch provider dan sebaiknya diikuti dengan reindeks memori ketika model upstream memperlakukan label tersebut secara berbeda.

Bedrock

Konfigurasi embedding Bedrock

Bedrock menggunakan rantai kredensial default AWS SDK — tidak perlu kunci API. Jika OpenClaw berjalan di EC2 dengan peran instance yang mengaktifkan Bedrock, cukup atur provider dan model:

json5
{  agents: {    defaults: {      memorySearch: {        provider: "bedrock",        model: "amazon.titan-embed-text-v2:0",      },    },  },}
Kunci Tipe Default Deskripsi
model string amazon.titan-embed-text-v2:0 ID model embedding Bedrock apa pun
outputDimensionality number default model Untuk Titan V2: 256, 512, atau 1024

Model yang didukung (dengan deteksi family dan default dimensi):

ID Model Penyedia Dimensi Default Dimensi yang Dapat Dikonfigurasi
amazon.titan-embed-text-v2:0 Amazon 1024 256, 512, 1024
amazon.titan-embed-text-v1 Amazon 1536 --
amazon.titan-embed-g1-text-02 Amazon 1536 --
amazon.titan-embed-image-v1 Amazon 1024 --
amazon.nova-2-multimodal-embeddings-v1:0 Amazon 1024 256, 384, 1024, 3072
cohere.embed-english-v3 Cohere 1024 --
cohere.embed-multilingual-v3 Cohere 1024 --
cohere.embed-v4:0 Cohere 1536 256-1536
twelvelabs.marengo-embed-3-0-v1:0 TwelveLabs 512 --
twelvelabs.marengo-embed-2-7-v1:0 TwelveLabs 1024 --

Varian dengan sufiks throughput (misalnya, amazon.titan-embed-text-v1:2:8k) mewarisi konfigurasi model dasar.

Autentikasi: autentikasi Bedrock menggunakan urutan resolusi kredensial AWS SDK standar:

  1. Variabel lingkungan (AWS_ACCESS_KEY_ID + AWS_SECRET_ACCESS_KEY)
  2. Cache token SSO
  3. Kredensial token identitas web
  4. Kredensial bersama dan file konfigurasi
  5. Kredensial metadata ECS atau EC2

Region diselesaikan dari AWS_REGION, AWS_DEFAULT_REGION, baseUrl penyedia amazon-bedrock, atau default ke us-east-1.

Izin IAM: peran atau pengguna IAM memerlukan:

json
{  "Effect": "Allow",  "Action": "bedrock:InvokeModel",  "Resource": "*"}

Untuk hak akses paling minimal, batasi cakupan InvokeModel ke model spesifik:

Code
arn:aws:bedrock:*::foundation-model/amazon.titan-embed-text-v2:0
Local (GGUF + llama.cpp)
Kunci Tipe Default Deskripsi
local.modelPath string diunduh otomatis Jalur ke file model GGUF
local.modelCacheDir string default node-llama-cpp Direktori cache untuk model yang diunduh
local.contextSize number | "auto" 4096 Ukuran jendela konteks untuk konteks embedding. 4096 mencakup chunk umum (128–512 token) sambil membatasi VRAM non-weight. Turunkan ke 1024–2048 pada host terbatas. "auto" menggunakan maksimum terlatih model — tidak direkomendasikan untuk model 8B+ (Qwen3-Embedding-8B: 40 960 token → ~32 GB VRAM vs ~8,8 GB pada 4096).

Instal penyedia llama.cpp resmi terlebih dahulu: openclaw plugins install @openclaw/llama-cpp-provider. Model default: embeddinggemma-300m-qat-Q8_0.gguf (~0,6 GB, diunduh otomatis). Checkout sumber tetap memerlukan persetujuan build native: pnpm approve-builds lalu pnpm rebuild node-llama-cpp.

Gunakan CLI mandiri untuk memverifikasi jalur penyedia yang sama dengan yang digunakan Gateway:

bash
openclaw memory status --deep --agent mainopenclaw memory index --force --agent main

Tetapkan provider: "local" secara eksplisit untuk embedding GGUF lokal. Referensi model hf: dan HTTP(S) didukung untuk konfigurasi lokal eksplisit, tetapi tidak mengubah penyedia default.

Timeout embedding inline

sync.embeddingBatchTimeoutSecondsnumber

Timpa timeout untuk batch embedding inline selama pengindeksan memori.

Jika tidak disetel, default penyedia digunakan: 600 detik untuk penyedia lokal/di-hosting sendiri seperti local, ollama, dan lmstudio, serta 120 detik untuk penyedia ter-hosting. Tingkatkan ini saat batch embedding lokal yang terikat CPU berjalan sehat tetapi lambat.


Konfigurasi pencarian hibrida

Semuanya berada di bawah memorySearch.query.hybrid:

Kunci Tipe Default Deskripsi
enabled boolean true Aktifkan pencarian hibrida BM25 + vektor
vectorWeight number 0.7 Bobot untuk skor vektor (0-1)
textWeight number 0.3 Bobot untuk skor BM25 (0-1)
candidateMultiplier number 4 Pengali ukuran kumpulan kandidat

MMR (diversity)

Kunci Tipe Default Deskripsi
mmr.enabled boolean false Aktifkan pemeringkatan ulang MMR
mmr.lambda number 0.7 0 = keragaman maks, 1 = relevansi maks

Temporal decay (recency)

Kunci Tipe Default Deskripsi
temporalDecay.enabled boolean false Aktifkan peningkatan keterkinian
temporalDecay.halfLifeDays number 30 Skor berkurang setengah setiap N hari

File evergreen (MEMORY.md, file tanpa tanggal di memory/) tidak pernah mengalami decay.

Contoh lengkap

json5
{  agents: {    defaults: {      memorySearch: {        query: {          hybrid: {            vectorWeight: 0.7,            textWeight: 0.3,            mmr: { enabled: true, lambda: 0.7 },            temporalDecay: { enabled: true, halfLifeDays: 30 },          },        },      },    },  },}

Jalur memori tambahan

Kunci Tipe Deskripsi
extraPaths string[] Direktori atau file tambahan untuk diindeks
json5
{  agents: {    defaults: {      memorySearch: {        extraPaths: ["../team-docs", "/srv/shared-notes"],      },    },  },}

Jalur dapat berupa absolut atau relatif terhadap workspace. Direktori dipindai secara rekursif untuk file .md. Penanganan symlink bergantung pada backend aktif: mesin bawaan mengabaikan symlink, sementara QMD mengikuti perilaku pemindai QMD yang mendasarinya.

Untuk pencarian transkrip lintas agen dengan cakupan agen, gunakan agents.list[].memorySearch.qmd.extraCollections alih-alih memory.qmd.paths. Koleksi ekstra tersebut mengikuti bentuk { path, name, pattern? } yang sama, tetapi digabungkan per agen dan dapat mempertahankan nama bersama eksplisit ketika jalur mengarah ke luar workspace saat ini. Jika jalur terselesaikan yang sama muncul di memory.qmd.paths dan memorySearch.qmd.extraCollections, QMD mempertahankan entri pertama dan melewati duplikat.


Memori multimodal (Gemini)

Indeks gambar dan audio bersama Markdown menggunakan Gemini Embedding 2:

Kunci Tipe Default Deskripsi
multimodal.enabled boolean false Aktifkan pengindeksan multimodal
multimodal.modalities string[] -- ["image"], ["audio"], atau ["all"]
multimodal.maxFileBytes number 10000000 Ukuran file maksimum untuk pengindeksan

Format yang didukung: .jpg, .jpeg, .png, .webp, .gif, .heic, .heif (gambar); .mp3, .wav, .ogg, .opus, .m4a, .aac, .flac (audio).


Cache embedding

Kunci Tipe Default Deskripsi
cache.enabled boolean true Cache embedding chunk di SQLite
cache.maxEntries number 50000 Embedding cache maksimum

Mencegah embedding ulang teks yang tidak berubah selama pengindeksan ulang atau pembaruan transkrip.


Pengindeksan batch

Kunci Tipe Default Deskripsi
remote.nonBatchConcurrency number 4 Embedding inline paralel
remote.batch.enabled boolean false Aktifkan API embedding batch
remote.batch.concurrency number 2 Job batch paralel
remote.batch.wait boolean true Tunggu penyelesaian batch
remote.batch.pollIntervalMs number -- Interval polling
remote.batch.timeoutMinutes number -- Timeout batch

Tersedia untuk openai, gemini, dan voyage. Batch OpenAI biasanya paling cepat dan paling murah untuk backfill besar.

remote.nonBatchConcurrency mengontrol panggilan embedding inline yang digunakan oleh penyedia lokal/self-hosted dan penyedia hosted ketika API batch penyedia tidak aktif. Ollama default ke 1 untuk pengindeksan non-batch agar tidak membebani host lokal yang lebih kecil; tetapkan nilai lebih tinggi pada mesin yang lebih besar.

Ini terpisah dari sync.embeddingBatchTimeoutSeconds, yang mengontrol timeout untuk panggilan embedding inline.


Pencarian memori sesi (eksperimental)

Indeks transkrip sesi dan tampilkan melalui memory_search:

Kunci Tipe Default Deskripsi
experimental.sessionMemory boolean false Aktifkan pengindeksan sesi
sources string[] ["memory"] Tambahkan "sessions" untuk menyertakan transkrip
sync.sessions.deltaBytes number 100000 Ambang byte untuk pengindeksan ulang
sync.sessions.deltaMessages number 50 Ambang pesan untuk pengindeksan ulang

Hasil transkrip sesi juga mematuhi tools.sessions.visibility. Visibilitas default tree hanya mengekspos sesi saat ini dan sesi yang dibuat olehnya. Untuk memanggil kembali sesi tidak terkait yang dikirim Gateway untuk agen yang sama dari sesi berbeda, seperti DM, perluas visibilitas secara sengaja ke agent (atau all hanya ketika pemanggilan lintas agen juga diperlukan dan kebijakan agen-ke-agen mengizinkannya).

Contoh di bawah menempatkan pengaturan ini di bawah agents.defaults. Anda juga dapat menerapkan pengaturan memorySearch yang setara dalam override per agen ketika hanya satu agen yang harus mengindeks dan mencari transkrip sesi.

Untuk pemanggilan kembali dari Gateway ke DM pada agen yang sama:

Builtin backend

json5
{  agents: {    defaults: {      memorySearch: {        experimental: { sessionMemory: true },        sources: ["memory", "sessions"],      },    },  },  tools: {    sessions: { visibility: "agent" },  },}

QMD backend

json5
{  agents: {    defaults: {      memorySearch: {        experimental: { sessionMemory: true },        sources: ["memory", "sessions"],      },    },  },  memory: {    backend: "qmd",    qmd: {      sessions: { enabled: true },    },  },  tools: {    sessions: { visibility: "agent" },  },}

Saat menggunakan QMD, agents.defaults.memorySearch.experimental.sessionMemory dan sources: ["sessions"] saja tidak mengekspor transkrip ke QMD. Tetapkan juga memory.qmd.sessions.enabled: true.


Akselerasi vektor SQLite (sqlite-vec)

Kunci Tipe Default Deskripsi
store.vector.enabled boolean true Gunakan sqlite-vec untuk kueri vektor
store.vector.extensionPath string dibundel Timpa jalur sqlite-vec

Saat sqlite-vec tidak tersedia, OpenClaw secara otomatis beralih ke kemiripan kosinus dalam proses.


Penyimpanan indeks

Indeks memori bawaan berada di basis data SQLite OpenClaw milik setiap agen di agents/<agentId>/agent/openclaw-agent.sqlite.

Kunci Tipe Default Deskripsi
store.fts.tokenizer string unicode61 Tokenizer FTS5 (unicode61 atau trigram)

Konfigurasi backend QMD

Tetapkan memory.backend = "qmd" untuk mengaktifkannya. Semua pengaturan QMD berada di bawah memory.qmd:

Kunci Tipe Default Deskripsi
command string qmd Jalur executable QMD; tetapkan jalur absolut ketika PATH layanan berbeda dari shell Anda
searchMode string search Perintah pencarian: search, vsearch, query
rerank boolean -- Tetapkan ke false dengan searchMode: "query" dan QMD 2.1+ untuk melewati reranking QMD
includeDefaultMemory boolean true Indeks otomatis MEMORY.md + memory/**/*.md
paths[] array -- Jalur tambahan: { name, path, pattern? }
sessions.enabled boolean false Ekspor transkrip sesi ke QMD
sessions.retentionDays number -- Retensi transkrip
sessions.exportDir string -- Direktori ekspor

searchMode: "search" hanya leksikal/BM25. OpenClaw tidak menjalankan pemeriksaan kesiapan vektor semantik atau pemeliharaan embedding QMD untuk mode tersebut, termasuk selama memory status --deep; vsearch dan query tetap memerlukan kesiapan vektor dan embedding QMD.

rerank: false hanya mengubah mode query QMD dan memerlukan QMD 2.1 atau yang lebih baru. Dalam mode CLI langsung, OpenClaw meneruskan --no-rerank; dalam mode MCP yang didukung mcporter, OpenClaw meneruskan rerank: false ke alat kueri terpadu QMD. Biarkan tidak ditetapkan untuk menggunakan perilaku reranking kueri default QMD.

OpenClaw memprioritaskan bentuk koleksi QMD dan kueri MCP saat ini, tetapi tetap membuat rilis QMD lama berfungsi dengan mencoba flag pola koleksi yang kompatibel dan nama alat MCP lama bila diperlukan. Ketika QMD menyatakan dukungan untuk beberapa filter koleksi, koleksi dari sumber yang sama dicari dengan satu proses QMD; build QMD lama tetap menggunakan jalur kompatibilitas per koleksi. Sumber yang sama berarti koleksi memori tahan lama dikelompokkan bersama, sementara koleksi transkrip sesi tetap menjadi grup terpisah sehingga diversifikasi sumber tetap memiliki kedua input.

Jadwal pembaruan
Kunci Tipe Default Deskripsi
update.interval string 5m Interval penyegaran
update.debounceMs number 15000 Debounce perubahan file
update.onBoot boolean true Segarkan saat manajer QMD berumur panjang dibuka; atur false untuk melewati pembaruan boot langsung
update.startup string off Inisialisasi QMD saat Gateway dimulai yang opsional: off, idle, atau immediate
update.startupDelayMs number 120000 Penundaan sebelum penyegaran startup: "idle" berjalan
update.waitForBootSync boolean false Blokir pembukaan manajer hingga penyegaran awalnya selesai
update.embedInterval string -- Irama embed terpisah
update.commandTimeoutMs number -- Timeout untuk perintah QMD
update.updateTimeoutMs number -- Timeout untuk operasi pembaruan QMD
update.embedTimeoutMs number -- Timeout untuk operasi embed QMD
Batas
Kunci Tipe Default Deskripsi
limits.maxResults number 6 Hasil pencarian maksimum
limits.maxSnippetChars number -- Batasi panjang cuplikan
limits.maxInjectedChars number -- Batasi total karakter yang diinjeksi
limits.timeoutMs number 4000 Timeout pencarian
Cakupan

Mengontrol sesi mana yang dapat menerima hasil pencarian QMD. Skema yang sama seperti session.sendPolicy:

json5
{  memory: {    qmd: {      scope: {        default: "deny",        rules: [{ action: "allow", match: { chatType: "direct" } }],      },    },  },}

Default yang dikirimkan mengizinkan sesi langsung dan sesi kanal, sambil tetap menolak grup.

Defaultnya hanya DM. match.keyPrefix mencocokkan kunci sesi yang dinormalisasi; match.rawKeyPrefix mencocokkan kunci mentah termasuk agent:<id>:.

Sitasi

memory.citations berlaku untuk semua backend:

Nilai Perilaku
auto (default) Sertakan footer Source: <path#line> dalam cuplikan
on Selalu sertakan footer
off Hilangkan footer (path tetap diteruskan ke agen secara internal)

Saat inisialisasi QMD ketika Gateway dimulai diaktifkan, OpenClaw memulai QMD hanya untuk agen yang memenuhi syarat. Jika update.onBoot bernilai true dan tidak ada pemeliharaan interval/embed yang dikonfigurasi, startup menggunakan manajer sekali pakai untuk penyegaran boot dan menutupnya. Jika interval pembaruan atau embed dikonfigurasi, startup membuka manajer QMD berumur panjang agar dapat memiliki watcher dan timer interval; update.onBoot: false hanya melewati penyegaran boot langsung.

Contoh QMD lengkap

json5
{  memory: {    backend: "qmd",    citations: "auto",    qmd: {      includeDefaultMemory: true,      update: { interval: "5m", debounceMs: 15000 },      limits: { maxResults: 6, timeoutMs: 4000 },      scope: {        default: "deny",        rules: [{ action: "allow", match: { chatType: "direct" } }],      },      paths: [{ name: "docs", path: "~/notes", pattern: "**/*.md" }],    },  },}

Dreaming

Dreaming dikonfigurasi di bawah plugins.entries.memory-core.config.dreaming, bukan di bawah agents.defaults.memorySearch.

Dreaming berjalan sebagai satu sweep terjadwal dan menggunakan fase internal light/deep/REM sebagai detail implementasi.

Untuk perilaku konseptual dan perintah slash, lihat Dreaming.

Pengaturan pengguna

Kunci Tipe Default Deskripsi
enabled boolean false Aktifkan atau nonaktifkan dreaming sepenuhnya
frequency string 0 3 * * * Irama Cron opsional untuk sweep Dreaming penuh
model string model default Override model subagen Dream Diary opsional
phases.deep.maxPromotedSnippetTokens number 160 Token estimasi maksimum yang disimpan dari setiap cuplikan ingatan jangka pendek yang dipromosikan ke MEMORY.md; metadata asal-usul tetap terlihat

Contoh

json5
{  plugins: {    entries: {      "memory-core": {        subagent: {          allowModelOverride: true,          allowedModels: ["anthropic/claude-sonnet-4-6"],        },        config: {          dreaming: {            enabled: true,            frequency: "0 3 * * *",            model: "anthropic/claude-sonnet-4-6",          },        },      },    },  },}

Terkait

Was this useful?
On this page

On this page