From 8922840a820119943238f2f79119b849052b21c4 Mon Sep 17 00:00:00 2001
From: generall <andrey@vasnetsov.com>
Date: Tue, 14 Jul 2026 18:28:16 +0200
Subject: [PATCH] fix: rename stale `payloads:` key in upload-config example,
 add hybrid example
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

`examples/upload-config.yaml` still used the pre-386995c `payloads:` key,
which `deny_unknown_fields` rejects — the example failed to parse. Rename
it to `fields:`.

Add `examples/simple-hybrid.yaml`: a minimal dense + sparse collection
with turbo-2bit quantization and a couple of payload fields.

Also ignore `/datasets/`, the default dataset download cache.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
---
 .gitignore                  |  1 +
 examples/simple-hybrid.yaml | 47 +++++++++++++++++++++++++++++++++++++
 examples/upload-config.yaml |  2 +-
 3 files changed, 49 insertions(+), 1 deletion(-)
 create mode 100644 examples/simple-hybrid.yaml

diff --git a/.gitignore b/.gitignore
index a96793f..5f83ab8 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,6 +3,7 @@
 *.iml
 
 # Local benchmark data & outputs
+/datasets/
 /tmp-data/
 /logs/
 *.fbin
diff --git a/examples/simple-hybrid.yaml b/examples/simple-hybrid.yaml
new file mode 100644
index 0000000..e4ae11f
--- /dev/null
+++ b/examples/simple-hybrid.yaml
@@ -0,0 +1,47 @@
+# Example bfb upload config for a simple hybrid (dense + sparse) collection:
+# one 768-d dense vector with turbo-2bit quantization and one zipf-distributed
+# sparse vector, plus a couple of payload fields to filter on.
+#
+#   bfb upload --file examples/simple-hybrid.yaml -n 1M -b 256 -p 16 -t 8 \
+#       --uri http://localhost:6334
+
+collection:
+  name: benchmark
+  id: uuid
+  on_disk_payload: true
+
+  optimizers:
+    default_segment_number: 3
+
+  quantization:
+    type: turbo-2bit
+    always_ram: true
+
+  vectors:
+    - name: image
+      size: 768
+      distance: cosine
+      datatype: float32
+      on_disk: true
+      source: random
+
+  sparse_vectors:
+    - name: bm25
+      on_disk: true
+      source:
+        type: random
+        vocab_size: 100000
+        length: 100
+        distribution: zipf
+
+  fields:
+    - name: a
+      type: keyword
+      source:
+        type: random
+        cardinality: 10
+        values_per_point: 1
+    - name: b
+      type: float
+      source: { type: random, min: -1.0, max: 1.0 }
+
diff --git a/examples/upload-config.yaml b/examples/upload-config.yaml
index b09a6c9..8109e6a 100644
--- a/examples/upload-config.yaml
+++ b/examples/upload-config.yaml
@@ -51,7 +51,7 @@ collection:
         length: 1000
         distribution: zipf        # uniform | zipf
 
-  payloads:
+  fields:
     - name: color
       type: keyword
       source: