[New docs] Java v6 & C# client docs

.vscode/settings.json

@@ -9,7 +9,11 @@
             "other": "on",
             "comments": "inline",
             "strings": "inline"
-        }
+        },
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[mdx]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
     },
     "files.associations": {
         "*.mdx": "markdown"
@@ -108,4 +112,5 @@
         "editor.insertSpaces": true
     },
     "java.configuration.updateBuildConfiguration": "interactive",
+    "java.compile.nullAnalysis.mode": "automatic",
 }

_includes/code/client-libraries/get_started.py

@@ -7,10 +7,16 @@
 client = weaviate.connect_to_local()
 # highlight-end
 
+# END GetStarted
+client.collections.delete("Question")  # Clean up from previous runs
+# START GetStarted
 # highlight-start
 questions = client.collections.create(
     name="Question",
-    vector_config=Configure.Vectors.text2vec_ollama(),  # Configure the Ollama embedding model
+    vector_config=Configure.Vectors.text2vec_ollama(
+        api_endpoint="http://ollama:11434",  # If using Docker you might need: http://host.docker.internal:11434
+        model="nomic-embed-text",  # The model to use
+    ),  # Configure the Ollama embedding model
 )
 # highlight-end
 
@@ -38,6 +44,10 @@
 if failed_objects:
     print(f"Number of failed imports: {len(failed_objects)}")
     print(f"First failed object: {failed_objects[0]}")
+# END GetStarted
+import time
+time.sleep(2)  # Wait for the batch to be indexed
+# START GetStarted
 
 # highlight-start
 response = questions.query.near_text(query="biology", limit=2)

_includes/code/connections/timeouts-cloud.mdx

@@ -1,25 +1,43 @@
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBlock';
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import FilteredTextBlock from "@site/src/components/Documentation/FilteredTextBlock";
 
-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 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">
-         <FilteredTextBlock
-         text={PyV4Code}
-         startMarker="# START TimeoutWCD"
-         endMarker="# END TimeoutWCD"
-         language="py"
-         />
-    </TabItem>
-    <TabItem value="ts3" label="JS/TS">
-         <FilteredTextBlock
-         text={TsV3Code}
-         startMarker="// START TimeoutWCD"
-         endMarker="// END TimeoutWCD"
-         language="js"
-         />
-    </TabItem>
+  <TabItem value="py4" label="Python">
+    <FilteredTextBlock
+      text={PyV4Code}
+      startMarker="# START TimeoutWCD"
+      endMarker="# END TimeoutWCD"
+      language="py"
+    />
+  </TabItem>
+  <TabItem value="ts3" label="JS/TS">
+    <FilteredTextBlock
+      text={TsV3Code}
+      startMarker="// START TimeoutWCD"
+      endMarker="// END TimeoutWCD"
+      language="js"
+    />
+  </TabItem>
+  <TabItem value="java6" label="Java v6 (Beta)">
+    <FilteredTextBlock
+      text={JavaV6Code}
+      startMarker="// START TimeoutWCD"
+      endMarker="// END TimeoutWCD"
+      language="java"
+    />
+  </TabItem>
+  <TabItem value="csharp" label="C# (Beta)">
+    <FilteredTextBlock
+      text={CSharpCode}
+      startMarker="// START TimeoutWCD"
+      endMarker="// END TimeoutWCD"
+      language="csharp"
+    />
+  </TabItem>
 </Tabs>

_includes/code/connections/timeouts-custom.mdx

@@ -1,25 +1,43 @@
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBlock';
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import FilteredTextBlock from "@site/src/components/Documentation/FilteredTextBlock";
 
-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 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">
-         <FilteredTextBlock
-         text={PyV4Code}
-         startMarker="# START TimeoutCustom"
-         endMarker="# END TimeoutCustom"
-         language="py"
-         />
-    </TabItem>
-    <TabItem value="ts3" label="JS/TS">
-         <FilteredTextBlock
-         text={TsV3Code}
-         startMarker="// START TimeoutCustom"
-         endMarker="// END TimeoutCustom"
-         language="js"
-         />
-    </TabItem>
+  <TabItem value="py4" label="Python">
+    <FilteredTextBlock
+      text={PyV4Code}
+      startMarker="# START TimeoutCustom"
+      endMarker="# END TimeoutCustom"
+      language="py"
+    />
+  </TabItem>
+  <TabItem value="ts3" label="JS/TS">
+    <FilteredTextBlock
+      text={TsV3Code}
+      startMarker="// START TimeoutCustom"
+      endMarker="// END TimeoutCustom"
+      language="js"
+    />
+  </TabItem>
+  <TabItem value="java6" label="Java v6 (Beta)">
+    <FilteredTextBlock
+      text={JavaV6Code}
+      startMarker="// START TimeoutCustom"
+      endMarker="// END TimeoutCustom"
+      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

@@ -1,26 +1,43 @@
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBlock';
-
-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 Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import FilteredTextBlock from "@site/src/components/Documentation/FilteredTextBlock";
 
+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">
-         <FilteredTextBlock
-         text={PyV4Code}
-         startMarker="# START TimeoutLocal"
-         endMarker="# END TimeoutLocal"
-         language="py"
-         />
-    </TabItem>
-    <TabItem value="ts3" label="JS/TS">
-         <FilteredTextBlock
-         text={TsV3Code}
-         startMarker="// START TimeoutLocal"
-         endMarker="// END TimeoutLocal"
-         language="js"
-         />
-    </TabItem>
+  <TabItem value="py4" label="Python">
+    <FilteredTextBlock
+      text={PyV4Code}
+      startMarker="# START TimeoutLocal"
+      endMarker="# END TimeoutLocal"
+      language="py"
+    />
+  </TabItem>
+  <TabItem value="ts3" label="JS/TS">
+    <FilteredTextBlock
+      text={TsV3Code}
+      startMarker="// START TimeoutLocal"
+      endMarker="// END TimeoutLocal"
+      language="js"
+    />
+  </TabItem>
+  <TabItem value="java6" label="Java v6 (Beta)">
+    <FilteredTextBlock
+      text={JavaV6Code}
+      startMarker="// START TimeoutLocal"
+      endMarker="// END TimeoutLocal"
+      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
+    }
+}