[v1.33] Release docs

.gitignore

@@ -259,5 +259,6 @@ __marimo__/
 # Streamlit
 .streamlit/secrets.toml
 
-_includes/code/csharp/bin/
-_includes/code/csharp/obj/
+# C# code
+_includes/code/csharp/bin
+_includes/code/csharp/obj

_includes/code/automated-testing.py

@@ -17,6 +17,11 @@
     headers=headers,
 )
 
+# Instantiate the v4 Weaviate client using the local helper.
+# client = weaviate.connect_to_local(
+#     headers=headers,
+# )
+
 client.collections.delete("JeopardyQuestion")
 client.collections.delete("JeopardyCategory")
 

_includes/code/howto/configure-rq/rq-compression-v3.ts

@@ -11,7 +11,7 @@ import { configure } from 'weaviate-client';
 
 const client = await weaviate.connectToLocal({
     headers: {
-        "X-OpenAI-Api-Key": process.env.OPENAI_API_KEY as  string, // Replace with your OpenAI API key
+        "X-OpenAI-Api-Key": process.env.OPENAI_API_KEY as string, // Replace with your OpenAI API key
     }
 })
 
@@ -27,7 +27,7 @@ await client.collections.delete("MyCollection")
 
 await client.collections.create({
     name: "MyCollection",
-    vectorizers : configure.vectors.text2VecOpenAI({
+    vectorizers: configure.vectors.text2VecOpenAI({
         // highlight-start
         quantizer: configure.vectorIndex.quantizer.rq()
         // highlight-end
@@ -38,6 +38,29 @@ await client.collections.create({
 })
 // END EnableRQ
 
+// ==============================
+// =====  EnableRQ 1-BIT ========
+// ==============================
+
+await client.collections.delete("MyCollection")
+
+// START 1BitEnableRQ
+
+await client.collections.create({
+    name: "MyCollection",
+    vectorizers: configure.vectors.text2VecOpenAI({
+        // highlight-start
+        quantizer: configure.vectorIndex.quantizer.rq({
+            bits: 1,
+        })
+        // highlight-end
+    }),
+    properties: [
+        { name: "title", dataType: weaviate.configure.dataType.TEXT }
+    ]
+})
+// END 1BitEnableRQ
+
 // ==============================
 // =====  EnableRQ with Options =====
 // ==============================
@@ -51,7 +74,7 @@ await client.collections.create({
     vectorizers: configure.vectors.text2VecOpenAI({
         // highlight-start
         quantizer: configure.vectorIndex.quantizer.rq({
-            bits: 8,  // Number of bits, only 8 is supported for now
+            bits: 8,  // Number of bits
         }),
         // highlight-end
     }),

_includes/code/howto/configure-rq/rq-compression-v4.py

@@ -41,6 +41,50 @@
 )
 # END EnableRQ
 
+# ==============================
+# =====  EnableRQ 1-BIT ========
+# ==============================
+
+client.collections.delete("MyCollection")
+
+# START 1BitEnableRQ
+from weaviate.classes.config import Configure, Property, DataType
+
+client.collections.create(
+    name="MyCollection",
+    vector_config=Configure.Vectors.text2vec_openai(
+        # highlight-start
+        quantizer=Configure.VectorIndex.Quantizer.rq(bits=1)
+        # highlight-end
+    ),
+    properties=[
+        Property(name="title", data_type=DataType.TEXT),
+    ],
+)
+# END 1BitEnableRQ
+
+# =========================
+# =====  Uncompressed =====
+# =========================
+
+client.collections.delete("MyCollection")
+
+# START Uncompressed
+from weaviate.classes.config import Configure, Property, DataType
+
+client.collections.create(
+    name="MyCollection",
+    vector_config=Configure.Vectors.text2vec_openai(
+        # highlight-start
+        quantizer=Configure.VectorIndex.Quantizer.none()
+        # highlight-end
+    ),
+    properties=[
+        Property(name="title", data_type=DataType.TEXT),
+    ],
+)
+# END Uncompressed
+
 # ==============================
 # =====  EnableRQ with Options =====
 # ==============================
@@ -55,7 +99,7 @@
     vector_config=Configure.Vectors.text2vec_openai(
         # highlight-start
         quantizer=Configure.VectorIndex.Quantizer.rq(
-            bits=8,  # Optional: Number of bits, only 8 is supported for now
+            bits=8,  # Optional: Number of bits
             rescore_limit=20,  # Optional: Number of candidates to fetch before rescoring
         ),
         # highlight-end
@@ -70,6 +114,19 @@
 # =====  UPDATE SCHEMA =====
 # ==============================
 
+client.collections.delete("MyCollection")
+client.collections.create(
+    name="MyCollection",
+    vector_config=Configure.Vectors.text2vec_openai(
+        # highlight-start
+        quantizer=Configure.VectorIndex.Quantizer.none(),
+        # highlight-end
+    ),
+    properties=[
+        Property(name="title", data_type=DataType.TEXT),
+    ],
+)
+
 # START UpdateSchema
 from weaviate.classes.config import Reconfigure
 
@@ -78,14 +135,43 @@
     vector_config=Reconfigure.Vectors.update(
         name="default",
         vector_index_config=Reconfigure.VectorIndex.hnsw(
-            quantizer=Reconfigure.VectorIndex.Quantizer.rq(
-                rescore_limit=20,  # Optional: Number of candidates to fetch before rescoring
-            ),
+            quantizer=Reconfigure.VectorIndex.Quantizer.rq(),
         ),
     )
 )
 # END UpdateSchema
 
+# ================================
+# =====  UPDATE SCHEMA 1-BIT =====
+# ================================
+
+client.collections.delete("MyCollection")
+client.collections.create(
+    name="MyCollection",
+    vector_config=Configure.Vectors.text2vec_openai(
+        # highlight-start
+        quantizer=Configure.VectorIndex.Quantizer.none(),
+        # highlight-end
+    ),
+    properties=[
+        Property(name="title", data_type=DataType.TEXT),
+    ],
+)
+
+# START 1BitUpdateSchema
+from weaviate.classes.config import Reconfigure
+
+collection = client.collections.use("MyCollection")
+collection.config.update(
+    vector_config=Reconfigure.Vectors.update(
+        name="default",
+        vector_index_config=Reconfigure.VectorIndex.hnsw(
+            quantizer=Reconfigure.VectorIndex.Quantizer.rq(bits=1),
+        ),
+    )
+)
+# END 1BitUpdateSchema
+
 from weaviate.collections.classes.config import _RQConfig
 
 config = client.collections.use("MyCollection").config.get()

_includes/code/howto/go/docs/configure/compression.rq_test.go

@@ -89,6 +89,56 @@ func TestRQConfiguration(t *testing.T) {
 		assert.Equal(t, true, rqConfig["enabled"])
 	})
 
+	t.Run("Enable 1-bit RQ", func(t *testing.T) {
+		className := "MyCollectionRQDefault"
+		// Delete the collection if it already exists to ensure a clean start
+		err := client.Schema().ClassDeleter().WithClassName(className).Do(context.Background())
+		if err != nil {
+			// This is not a fatal error, the collection might not exist
+			log.Printf("Could not delete collection '%s', it might not exist: %v\n", className, err)
+		}
+
+		// START 1BitEnableRQ
+		// Define the configuration for RQ. Setting 'enabled' to true
+		// highlight-start
+		rq_config := map[string]interface{}{
+			"enabled": true,
+			"bits":    1,
+		}
+		// highlight-end
+
+		// Define the class schema
+		class := &models.Class{
+			Class:      className,
+			Vectorizer: "text2vec-openai",
+			// highlight-start
+			// Assign the RQ configuration to the vector index config
+			VectorIndexConfig: map[string]interface{}{
+				"rq": rq_config,
+			},
+			// highlight-end
+		}
+
+		// Create the collection in Weaviate
+		err = client.Schema().ClassCreator().
+			WithClass(class).
+			Do(context.Background())
+		// END 1BitEnableRQ
+		require.NoError(t, err)
+
+		// Assertions to verify the configuration
+		classInfo, err := client.Schema().ClassGetter().WithClassName(className).Do(ctx)
+		require.NoError(t, err)
+		require.NotNil(t, classInfo)
+
+		vic, ok := classInfo.VectorIndexConfig.(map[string]interface{})
+		require.True(t, ok)
+		rqConfig, ok := vic["rq"].(map[string]interface{})
+		require.True(t, ok)
+		assert.Equal(t, true, rqConfig["enabled"])
+		assert.Equal(t, float64(1), rqConfig["bits"])
+	})
+
 	t.Run("Enable RQ with Options", func(t *testing.T) {
 		className := "MyCollectionRQWithOptions"
 		// Delete the collection to recreate it with new options
@@ -102,7 +152,7 @@ func TestRQConfiguration(t *testing.T) {
 		// highlight-start
 		rq_with_options_config := map[string]interface{}{
 			"enabled":      true,
-			"bits":         8,  // Optional: Number of bits, only 8 is supported for now
+			"bits":         8,  // Optional: Number of bits
 			"rescoreLimit": 20, // Optional: Number of candidates to fetch before rescoring
 		}
 		// highlight-end
@@ -176,10 +226,9 @@ func TestRQConfiguration(t *testing.T) {
 		// Get the current vector index configuration
 		cfg := class.VectorIndexConfig.(map[string]interface{})
 
-		// Add RQ configuration to enable scalar quantization
+		// Add RQ configuration to enable quantization
 		cfg["rq"] = map[string]interface{}{
-			"enabled":      true,
-			"rescoreLimit": 20, // Optional: Number of candidates to fetch before rescoring
+			"enabled": true,
 		}
 
 		// Update the class configuration
@@ -207,4 +256,71 @@ func TestRQConfiguration(t *testing.T) {
 		assert.Equal(t, true, rqConfig["enabled"])
 		assert.Equal(t, float64(20), rqConfig["rescoreLimit"])
 	})
+
+	t.Run("Enable 1-bit RQ on Existing Collection", func(t *testing.T) {
+		className := "MyExistingCollection"
+
+		// First, create a collection without RQ
+		err := client.Schema().ClassDeleter().WithClassName(className).Do(context.Background())
+		if err != nil {
+			log.Printf("Could not delete collection '%s', it might not exist: %v\n", className, err)
+		}
+
+		// Create initial collection without RQ
+		initialClass := &models.Class{
+			Class:      className,
+			Vectorizer: "text2vec-openai",
+			VectorIndexConfig: map[string]interface{}{
+				"distance": "cosine",
+			},
+		}
+
+		err = client.Schema().ClassCreator().
+			WithClass(initialClass).
+			Do(context.Background())
+		require.NoError(t, err)
+
+		// START 1BitUpdateSchema
+		// Get the existing collection configuration
+		class, err := client.Schema().ClassGetter().
+			WithClassName(className).Do(context.Background())
+
+		if err != nil {
+			log.Fatalf("get class for vec idx cfg update: %v", err)
+		}
+
+		// Get the current vector index configuration
+		cfg := class.VectorIndexConfig.(map[string]interface{})
+
+		// Add RQ configuration to enable scalar quantization
+		cfg["rq"] = map[string]interface{}{
+			"enabled": true,
+			"bits":    1,
+		}
+
+		// Update the class configuration
+		class.VectorIndexConfig = cfg
+
+		// Apply the updated configuration to the collection
+		err = client.Schema().ClassUpdater().
+			WithClass(class).Do(context.Background())
+
+		if err != nil {
+			log.Fatalf("update class to use rq: %v", err)
+		}
+		// END 1BitUpdateSchema
+
+		// Verify the RQ configuration was applied
+		updatedClass, err := client.Schema().ClassGetter().
+			WithClassName(className).Do(context.Background())
+		require.NoError(t, err)
+
+		vic, ok := updatedClass.VectorIndexConfig.(map[string]interface{})
+		require.True(t, ok)
+
+		rqConfig, ok := vic["rq"].(map[string]interface{})
+		require.True(t, ok)
+		assert.Equal(t, true, rqConfig["enabled"])
+		assert.Equal(t, float64(1), rqConfig["bits"])
+	})
 }