Merge pull request #1984 from abdonpijpelink/asciifolding

[v1.16.0] Documentation for ASCII folding (and lowercasing)

qdrant-landing/content/documentation/headless/snippets/create-payload-index/asciifolding-full-text/_description.md

@@ -0,0 +1 @@
+This code snippet demonstrates how to create a full-text index with ASCII folding support for a specified field in a collection. The index configuration includes details such as the field name, type (text), tokenizer (word), and whether to ASCII-fold tokens. This setup enables filtering points based on the presence of specific words while ignoring diacritics in the field, allowing for efficient full-text search functionality within the payload.

qdrant-landing/content/documentation/headless/snippets/create-payload-index/asciifolding-full-text/csharp.md

@@ -0,0 +1,21 @@
+```csharp
+using Qdrant.Client;
+using Qdrant.Client.Grpc;
+
+var client = new QdrantClient("localhost", 6334);
+
+await client.CreatePayloadIndexAsync(
+    collectionName: "{collection_name}",
+    fieldName: "name_of_the_field_to_index",
+    schemaType: PayloadSchemaType.Text,
+    indexParams: new PayloadIndexParams
+    {
+        TextIndexParams = new TextIndexParams
+        {
+            Tokenizer = TokenizerType.Word,
+            Lowercase = true,
+			AsciiFolding = true,
+        }
+    }
+);
+```

qdrant-landing/content/documentation/headless/snippets/create-payload-index/asciifolding-full-text/go.md

@@ -0,0 +1,24 @@
+```go
+import (
+    "context"
+
+    "github.com/qdrant/go-client/qdrant"
+)
+
+client, err := qdrant.NewClient(&qdrant.Config{
+    Host: "localhost",
+    Port: 6334,
+})
+
+client.CreateFieldIndex(context.Background(), &qdrant.CreateFieldIndexCollection{
+	CollectionName: "{collection_name}",
+	FieldName:      "name_of_the_field_to_index",
+	FieldType:      qdrant.FieldType_FieldTypeText.Enum(),
+	FieldIndexParams: qdrant.NewPayloadIndexParamsText(
+		&qdrant.TextIndexParams{
+			Tokenizer:    qdrant.TokenizerType_Word,
+			Lowercase:    qdrant.PtrOf(true),
+			AsciiFolding: qdrant.PtrOf(true),
+		}),
+})
+```

qdrant-landing/content/documentation/headless/snippets/create-payload-index/asciifolding-full-text/http.md

@@ -0,0 +1,11 @@
+```http
+PUT /collections/{collection_name}/index
+{
+    "field_name": "name_of_the_field_to_index",
+    "field_schema": {
+        "type": "text",
+        "tokenizer": "word",
+        "ascii_folding": true
+    }
+}
+```

qdrant-landing/content/documentation/headless/snippets/create-payload-index/asciifolding-full-text/java.md

@@ -0,0 +1,29 @@
+```java
+import io.qdrant.client.QdrantClient;
+import io.qdrant.client.QdrantGrpcClient;
+import io.qdrant.client.grpc.Collections.PayloadIndexParams;
+import io.qdrant.client.grpc.Collections.PayloadSchemaType;
+import io.qdrant.client.grpc.Collections.TextIndexParams;
+import io.qdrant.client.grpc.Collections.TokenizerType;
+
+QdrantClient client =
+    new QdrantClient(QdrantGrpcClient.newBuilder("localhost", 6334, false).build());
+
+client
+    .createPayloadIndexAsync(
+        "{collection_name}",
+        "name_of_the_field_to_index",
+        PayloadSchemaType.Text,
+        PayloadIndexParams.newBuilder()
+            .setTextIndexParams(
+                TextIndexParams.newBuilder()
+                    .setTokenizer(TokenizerType.Word)
+                    .setLowercase(true)
+                    .setAsciiFolding(true)
+                    .build())
+            .build(),
+        null,
+        null,
+        null)
+    .get();
+```

qdrant-landing/content/documentation/headless/snippets/create-payload-index/asciifolding-full-text/python.md

@@ -0,0 +1,15 @@
+```python
+from qdrant_client import QdrantClient, models
+
+client = QdrantClient(url="http://localhost:6333")
+
+client.create_payload_index(
+    collection_name="{collection_name}",
+    field_name="name_of_the_field_to_index",
+    field_schema=models.TextIndexParams(
+        type="text",
+        tokenizer=models.TokenizerType.WORD,
+        ascii_folding=True,
+    ),
+)
+```

qdrant-landing/content/documentation/headless/snippets/create-payload-index/asciifolding-full-text/rust.md

@@ -0,0 +1,24 @@
+```rust
+use qdrant_client::qdrant::{
+    CreateFieldIndexCollectionBuilder,
+    TextIndexParamsBuilder,
+    FieldType,
+    TokenizerType,
+};
+use qdrant_client::Qdrant;
+
+let client = Qdrant::from_url("http://localhost:6334").build()?;
+
+let text_index_params = TextIndexParamsBuilder::new(TokenizerType::Word)
+    .ascii_folding(true);
+
+client
+    .create_field_index(
+        CreateFieldIndexCollectionBuilder::new(
+            "{collection_name}",
+            "name_of_the_field_to_index",
+            FieldType::Text,
+        ).field_index_params(text_index_params.build()),
+    )
+    .await?;
+```

qdrant-landing/content/documentation/headless/snippets/create-payload-index/asciifolding-full-text/typescript.md

@@ -0,0 +1,14 @@
+```typescript
+import { QdrantClient } from "@qdrant/js-client-rest";
+
+const client = new QdrantClient({ host: "localhost", port: 6333 });
+
+client.createPayloadIndex("{collection_name}", {
+  field_name: "name_of_the_field_to_index",
+  field_schema: {
+    type: "text",
+    tokenizer: "word",
+    ascii_folding: true,
+  },
+});
+```

qdrant-landing/content/documentation/headless/snippets/create-payload-index/lowercase-full-text/_description.md

@@ -0,0 +1 @@
+This code snippet demonstrates how to configure a full-text index for case-sensitive match support for a specified field in a collection. The index configuration includes details such as the field name, type (text), tokenizer (word), and whether to convert tokens to lowercase. Lowercasing is enabled by default, enabling case-sensitive matching. This setup disables lowercasing, enabling the filtering og points based on the presence of exact words in the field.

qdrant-landing/content/documentation/headless/snippets/create-payload-index/lowercase-full-text/csharp.md

@@ -0,0 +1,20 @@
+```csharp
+using Qdrant.Client;
+using Qdrant.Client.Grpc;
+
+var client = new QdrantClient("localhost", 6334);
+
+await client.CreatePayloadIndexAsync(
+    collectionName: "{collection_name}",
+    fieldName: "name_of_the_field_to_index",
+    schemaType: PayloadSchemaType.Text,
+    indexParams: new PayloadIndexParams
+    {
+        TextIndexParams = new TextIndexParams
+        {
+            Tokenizer = TokenizerType.Word,
+            Lowercase = true,
+        }
+    }
+);
+```

qdrant-landing/content/documentation/headless/snippets/create-payload-index/lowercase-full-text/go.md

@@ -0,0 +1,23 @@
+```go
+import (
+    "context"
+
+    "github.com/qdrant/go-client/qdrant"
+)
+
+client, err := qdrant.NewClient(&qdrant.Config{
+    Host: "localhost",
+    Port: 6334,
+})
+
+client.CreateFieldIndex(context.Background(), &qdrant.CreateFieldIndexCollection{
+    CollectionName: "{collection_name}",
+    FieldName:      "name_of_the_field_to_index",
+    FieldType:      qdrant.FieldType_FieldTypeText.Enum(),
+    FieldIndexParams: qdrant.NewPayloadIndexParamsText(
+        &qdrant.TextIndexParams{
+            Tokenizer:   qdrant.TokenizerType_Word,
+            Lowercase:   qdrant.PtrOf(true),
+        }),
+})
+```

qdrant-landing/content/documentation/headless/snippets/create-payload-index/lowercase-full-text/http.md

@@ -0,0 +1,11 @@
+```http
+PUT /collections/{collection_name}/index
+{
+    "field_name": "name_of_the_field_to_index",
+    "field_schema": {
+        "type": "text",
+        "tokenizer": "word",
+        "lowercase": false
+    }
+}
+```

qdrant-landing/content/documentation/headless/snippets/create-payload-index/lowercase-full-text/java.md

@@ -0,0 +1,28 @@
+```java
+import io.qdrant.client.QdrantClient;
+import io.qdrant.client.QdrantGrpcClient;
+import io.qdrant.client.grpc.Collections.PayloadIndexParams;
+import io.qdrant.client.grpc.Collections.PayloadSchemaType;
+import io.qdrant.client.grpc.Collections.TextIndexParams;
+import io.qdrant.client.grpc.Collections.TokenizerType;
+
+QdrantClient client =
+    new QdrantClient(QdrantGrpcClient.newBuilder("localhost", 6334, false).build());
+
+client
+    .createPayloadIndexAsync(
+        "{collection_name}",
+        "name_of_the_field_to_index",
+        PayloadSchemaType.Text,
+        PayloadIndexParams.newBuilder()
+            .setTextIndexParams(
+                TextIndexParams.newBuilder()
+                    .setTokenizer(TokenizerType.Word)
+                    .setLowercase(true)
+                    .build())
+            .build(),
+        null,
+        null,
+        null)
+    .get();
+```

qdrant-landing/content/documentation/headless/snippets/create-payload-index/lowercase-full-text/python.md

@@ -0,0 +1,15 @@
+```python
+from qdrant_client import QdrantClient, models
+
+client = QdrantClient(url="http://localhost:6333")
+
+client.create_payload_index(
+    collection_name="{collection_name}",
+    field_name="name_of_the_field_to_index",
+    field_schema=models.TextIndexParams(
+        type="text",
+        tokenizer=models.TokenizerType.WORD,
+        lowercase=False,
+    ),
+)
+```

qdrant-landing/content/documentation/headless/snippets/create-payload-index/lowercase-full-text/rust.md

@@ -0,0 +1,24 @@
+```rust
+use qdrant_client::qdrant::{
+    CreateFieldIndexCollectionBuilder,
+    TextIndexParamsBuilder,
+    FieldType,
+    TokenizerType,
+};
+use qdrant_client::Qdrant;
+
+let client = Qdrant::from_url("http://localhost:6334").build()?;
+
+let text_index_params = TextIndexParamsBuilder::new(TokenizerType::Word)
+    .lowercase(false);
+
+client
+    .create_field_index(
+        CreateFieldIndexCollectionBuilder::new(
+            "{collection_name}",
+            "name_of_the_field_to_index",
+            FieldType::Text,
+        ).field_index_params(text_index_params.build()),
+    )
+    .await?;
+```

qdrant-landing/content/documentation/headless/snippets/create-payload-index/lowercase-full-text/typescript.md

@@ -0,0 +1,14 @@
+```typescript
+import { QdrantClient } from "@qdrant/js-client-rest";
+
+const client = new QdrantClient({ host: "localhost", port: 6333 });
+
+client.createPayloadIndex("{collection_name}", {
+  field_name: "name_of_the_field_to_index",
+  field_schema: {
+    type: "text",
+    tokenizer: "word",
+    lowercase: false,
+  },
+});
+```