[New docs] C# client docs (new branch)

_includes/code/connections/timeouts-custom.mdx

@@ -5,6 +5,7 @@ import FilteredTextBlock from "@site/src/components/Documentation/FilteredTextBl
 import PyV4Code from "!!raw-loader!/_includes/code/connections/connect-python-v4.py";
 import TsV3Code from "!!raw-loader!/_includes/code/connections/connect-ts-v3.ts";
 import JavaV6Code from "!!raw-loader!/_includes/code/java-v6/src/test/java/ConnectionTest.java";
+import CSharpCode from "!!raw-loader!/_includes/code/csharp/ConnectionTest.cs";
 
 <Tabs groupId="languages">
   <TabItem value="py4" label="Python">
@@ -31,4 +32,12 @@ import JavaV6Code from "!!raw-loader!/_includes/code/java-v6/src/test/java/Conne
       language="java"
     />
   </TabItem>
+  <TabItem value="csharp" label="C# (Beta)">
+    <FilteredTextBlock
+      text={CSharpCode}
+      startMarker="// START TimeoutCustom"
+      endMarker="// END TimeoutCustom"
+      language="csharp"
+    />
+  </TabItem>
 </Tabs>

_includes/code/connections/timeouts-local.mdx

@@ -5,6 +5,7 @@ import FilteredTextBlock from "@site/src/components/Documentation/FilteredTextBl
 import PyV4Code from "!!raw-loader!/_includes/code/connections/connect-python-v4.py";
 import TsV3Code from "!!raw-loader!/_includes/code/connections/connect-ts-v3.ts";
 import JavaV6Code from "!!raw-loader!/_includes/code/java-v6/src/test/java/ConnectionTest.java";
+import CSharpCode from "!!raw-loader!/_includes/code/csharp/ConnectionTest.cs";
 
 <Tabs groupId="languages">
   <TabItem value="py4" label="Python">
@@ -31,4 +32,12 @@ import JavaV6Code from "!!raw-loader!/_includes/code/java-v6/src/test/java/Conne
       language="java"
     />
   </TabItem>
+  <TabItem value="csharp" label="C# (Beta)">
+    <FilteredTextBlock
+      text={CSharpCode}
+      startMarker="// START TimeoutLocal"
+      endMarker="// END TimeoutLocal"
+      language="csharp"
+    />
+  </TabItem>
 </Tabs>

_includes/code/csharp/ConfigureBQTest.cs

@@ -0,0 +1,106 @@
+using Xunit;
+using Weaviate.Client;
+using Weaviate.Client.Models;
+using System;
+using System.Threading.Tasks;
+
+namespace WeaviateProject.Tests;
+
+public class ConfigureBQTest : IAsyncLifetime
+{
+    private WeaviateClient client;
+    private const string COLLECTION_NAME = "MyCollection";
+
+    // Runs before each test
+    public async Task InitializeAsync()
+    {
+        // START ConnectCode
+        // Note: The C# client doesn't support setting headers like 'X-OpenAI-Api-Key' via the constructor for local connections.
+        // This must be configured in Weaviate's environment variables.
+        client = new WeaviateClient(new ClientConfiguration { RestAddress = "localhost", RestPort = 8080 });
+        // END ConnectCode
+
+        // Clean slate for each test
+        if (await client.Collections.Exists(COLLECTION_NAME))
+        {
+            await client.Collections.Delete(COLLECTION_NAME);
+        }
+    }
+
+    // Runs after each test
+    public Task DisposeAsync()
+    {
+        // No action needed here, as cleanup happens in InitializeAsync before the next test.
+        return Task.CompletedTask;
+    }
+
+    [Fact]
+    public async Task TestEnableBQ()
+    {
+        // START EnableBQ
+        await client.Collections.Create(new Collection
+        {
+            Name = "MyCollection",
+            Properties = [Property.Text("title")],
+            VectorConfig = new VectorConfig(
+                "default",
+                new Vectorizer.Text2VecContextionary(),
+                new VectorIndex.HNSW
+                {
+                    // highlight-start
+                    Quantizer = new VectorIndex.Quantizers.BQ()
+                    // highlight-end
+                }
+            )
+        });
+        // END EnableBQ
+    }
+
+    [Fact]
+    public async Task TestUpdateSchema()
+    {
+        // Note: Updating quantization settings on an existing collection is not supported by Weaviate
+        // and will result in an error, as noted in the Java test. This test demonstrates the syntax for attempting the update.
+        var collection = await client.Collections.Create(new Collection
+        {
+            Name = "MyCollection",
+            Properties = [Property.Text("title")],
+            VectorConfig = new VectorConfig("default", new Vectorizer.Text2VecContextionary())
+        });
+
+        // START UpdateSchema
+        await collection.Config.Update(c =>
+        {
+            var vectorConfig = c.VectorConfig["default"];
+            vectorConfig.VectorIndexConfig.UpdateHNSW(h => h.Quantizer = new VectorIndex.Quantizers.BQ());
+        });
+        // END UpdateSchema
+    }
+
+    [Fact]
+    public async Task TestBQWithOptions()
+    {
+        // START BQWithOptions
+        await client.Collections.Create(new Collection
+        {
+            Name = "MyCollection",
+            Properties = [Property.Text("title")],
+            VectorConfig = new VectorConfig(
+                "default",
+                new Vectorizer.Text2VecContextionary(),
+                // highlight-start
+                new VectorIndex.HNSW
+                {
+                    VectorCacheMaxObjects = 100000,
+                    Quantizer = new VectorIndex.Quantizers.BQ
+                    {
+                        Cache = true,
+                        RescoreLimit = 200
+                    }
+                }
+                // highlight-end
+            )
+        });
+        // END BQWithOptions
+    }
+}

_includes/code/csharp/ConfigurePQTest.cs

@@ -0,0 +1,218 @@
+using Xunit;
+using Weaviate.Client;
+using Weaviate.Client.Models;
+using System;
+using System.Threading.Tasks;
+using System.Collections.Generic;
+using System.Text.Json;
+using System.Net.Http;
+using System.Linq;
+using System.Text.Json.Serialization;
+
+namespace WeaviateProject.Tests;
+
+public class ConfigurePQTest : IAsyncLifetime
+{
+    private static WeaviateClient client;
+    private static List<JsonElement> data;
+    private const string COLLECTION_NAME = "Question";
+
+    // Runs once before any tests in the class
+    public async Task InitializeAsync()
+    {
+        // START DownloadData
+        using var httpClient = new HttpClient();
+        var responseBody = await httpClient.GetStringAsync(
+            "https://raw.githubusercontent.com/weaviate-tutorials/intro-workshop/main/data/jeopardy_1k.json");
+
+        data = JsonSerializer.Deserialize<List<JsonElement>>(responseBody);
+
+        Console.WriteLine($"Data type: {data.GetType().Name}, Length: {data.Count}");
+        Console.WriteLine(JsonSerializer.Serialize(data[1], new JsonSerializerOptions { WriteIndented = true }));
+        // END DownloadData
+
+        // START ConnectCode
+        // Note: The C# client doesn't support setting headers like 'X-OpenAI-Api-Key' via the constructor for local connections.
+        // This must be configured in Weaviate's environment variables.
+        client = new WeaviateClient(new ClientConfiguration { RestAddress = "localhost", RestPort = 8080 });
+
+        var meta = await client.GetMeta();
+        Console.WriteLine($"Weaviate info: {meta.Version}");
+        // END ConnectCode
+    }
+
+    // Runs once after all tests in the class
+    public async Task DisposeAsync()
+    {
+        if (await client.Collections.Exists(COLLECTION_NAME))
+        {
+            await client.Collections.Delete(COLLECTION_NAME);
+        }
+    }
+
+    // This helper runs before each test to ensure a clean collection state
+    private async Task BeforeEach()
+    {
+        if (await client.Collections.Exists(COLLECTION_NAME))
+        {
+            await client.Collections.Delete(COLLECTION_NAME);
+        }
+    }
+
+    // TODO[g-despot] Why is Encoder required?
+    // TODO[g-despot] Why are properties required? ERROR: didn't find a single property which is of type string or text and is not excluded from indexing
+    [Fact]
+    public async Task TestCollectionWithAutoPQ()
+    {
+        await BeforeEach();
+
+        // START CollectionWithAutoPQ
+        await client.Collections.Create(new Collection
+        {
+            Name = "Question",
+            VectorConfig = new VectorConfig(
+                "default",
+                new Vectorizer.Text2VecContextionary(),
+                new VectorIndex.HNSW
+                {
+                    // highlight-start
+                    Quantizer = new VectorIndex.Quantizers.PQ
+                    {
+                        TrainingLimit = 50000, // Set the threshold to begin training
+                        Encoder = new VectorIndex.Quantizers.PQ.EncoderConfig
+                        {
+                            Type = VectorIndex.Quantizers.EncoderType.Tile,
+                            Distribution = VectorIndex.Quantizers.DistributionType.Normal,
+                        },
+                    }
+                    // highlight-end
+                }
+            ),
+            Properties =
+            [
+                Property.Text("question"),
+                Property.Text("answer"),
+                Property.Text("category")
+            ]
+        });
+        // END CollectionWithAutoPQ
+
+        // Confirm that the collection has been created with the right settings
+        var collection = client.Collections.Use(COLLECTION_NAME);
+        var config = await collection.Get();
+        Assert.NotNull(config);
+        var hnswConfig = config.VectorConfig["default"].VectorIndexConfig as VectorIndex.HNSW;
+        Assert.NotNull(hnswConfig?.Quantizer);
+    }
+
+    [Fact]
+    public async Task TestUpdateSchemaWithPQ()
+    {
+        await BeforeEach();
+
+        // START InitialSchema
+        await client.Collections.Create(new Collection
+        {
+            Name = "Question",
+            Description = "A Jeopardy! question",
+            VectorConfig = new VectorConfig("default", new Vectorizer.Text2VecContextionary()),
+            Properties =
+            [
+                Property.Text("question"),
+                Property.Text("answer"),
+                Property.Text("category")
+            ]
+        });
+        // END InitialSchema
+
+        var collection = client.Collections.Use(COLLECTION_NAME);
+        var initialConfig = await collection.Get();
+        Assert.NotNull(initialConfig);
+
+        // START LoadData
+        var objectList = data.Select(obj => new
+        {
+            question = obj.GetProperty("Question").GetString(),
+            answer = obj.GetProperty("Answer").GetString()
+        }).ToArray();
+
+        await collection.Data.InsertMany(objectList);
+        // END LoadData
+
+        var aggregateResponse = await collection.Aggregate.OverAll(totalCount: true);
+        Assert.Equal(1000, aggregateResponse.TotalCount);
+
+        // START UpdateSchema
+        await collection.Config.Update(c =>
+        {
+            var vectorConfig = c.VectorConfig["default"];
+            vectorConfig.VectorIndexConfig.UpdateHNSW(h =>
+                h.Quantizer = new VectorIndex.Quantizers.PQ
+                {
+                    TrainingLimit = 50000,
+                    Encoder = new VectorIndex.Quantizers.PQ.EncoderConfig
+                    {
+                        Type = VectorIndex.Quantizers.EncoderType.Tile,
+                        Distribution = VectorIndex.Quantizers.DistributionType.Normal,
+                    },
+                });
+        });
+        // END UpdateSchema
+
+        var updatedConfig = await collection.Get();
+        Assert.NotNull(updatedConfig);
+        var hnswConfig = updatedConfig.VectorConfig["default"].VectorIndexConfig as VectorIndex.HNSW;
+        Assert.IsType<VectorIndex.Quantizers.PQ>(hnswConfig?.Quantizer);
+    }
+
+    [Fact]
+    public async Task TestGetSchema()
+    {
+        await BeforeEach();
+
+        // Create a collection with PQ enabled to inspect its schema
+        await client.Collections.Create(new Collection
+        {
+            Name = "Question",
+            VectorConfig = new VectorConfig(
+                "default",
+                new Vectorizer.Text2VecContextionary(),
+                new VectorIndex.HNSW
+                {
+                    Quantizer = new VectorIndex.Quantizers.PQ
+                    {
+                        Encoder = new VectorIndex.Quantizers.PQ.EncoderConfig
+                        {
+                            Type = VectorIndex.Quantizers.EncoderType.Tile,
+                            Distribution = VectorIndex.Quantizers.DistributionType.Normal,
+                        },
+                        TrainingLimit = 50000
+                    }
+                }
+            ),
+            Properties =
+            [
+                Property.Text("question"),
+                Property.Text("answer"),
+                Property.Text("category")
+            ]
+        });
+
+        // START GetSchema
+        var jeopardy = client.Collections.Use("Question");
+        var config = await jeopardy.Get();
+
+        Console.WriteLine(JsonSerializer.Serialize(config, new JsonSerializerOptions { WriteIndented = true }));
+        // END GetSchema
+        Assert.NotNull(config);
+
+        var hnswConfig = config.VectorConfig["default"].VectorIndexConfig as VectorIndex.HNSW;
+        var pqConfig = hnswConfig?.Quantizer as VectorIndex.Quantizers.PQ;
+        Assert.NotNull(pqConfig);
+
+        // Print some of the config properties
+        Console.WriteLine($"Training: {pqConfig.TrainingLimit}");
+        Console.WriteLine($"Segments: {pqConfig.Segments}");
+        Console.WriteLine($"Centroids: {pqConfig.Centroids}");
+    }
+}