Merge pull request #281505 from jcodella/main

updated index guidance for nosql vectors

Author: prmerger-automator[bot]

articles/cosmos-db/index-policy.md

@@ -116,6 +116,9 @@ Here are some rules for included and excluded paths precedence in Azure Cosmos D
 
 ## Vector indexes
 
+> [!NOTE]
+>  You must enroll in the [Azure Cosmos DB NoSQL Vector Index preview feature](nosql/vector-search.md#enroll-in-the-vector-search-preview-feature) to specify a vector indexing policy.> 
+
 **Vector** indexes increase the efficiency when performing vector searches using the `VectorDistance` system function. Vectors searches will have significantly lower latency, higher throughput, and less RU consumption when leveraging a vector index.  You can specify the following types of vector index policies:
 
 | Type | Description | Max dimensions |
@@ -156,14 +159,12 @@ Here's an example of an indexing policy with a vector index:
 }
 ```
 
-> [!NOTE]
->  You must enroll in the [Azure Cosmos DB NoSQL Vector Index preview feature](nosql/vector-search.md#enroll-in-the-vector-search-preview-feature) to specify a vector indexing policy.> 
-
 > [!IMPORTANT]
 > A vector indexing policy must be on the path defined in the container's vector policy. [Learn more about container vector policies](nosql/vector-search.md#container-vector-policies).
 > Vector indexes must also be defined at the time of Container creation and cannot be modified once created. In a future release, vector indexes will be modifiable.
 
-
+>[!IMPORTANT]
+> The vector path added to the "excludedPaths" section of the indexing policy to ensure optimized performance for insertion. Not adding the vector path to "excludedPaths" will result in higher RU charge and latency for vector insertions.
 
 ## Spatial indexes
 

articles/cosmos-db/nosql/how-to-dotnet-vector-index-query.md

@@ -108,23 +108,27 @@ For our example with book details, the vector policy can look like the example J
 Once the vector embedding paths are decided, vector indexes need to be added to the indexing policy. Currently, the vector search feature for Azure Cosmos DB for NoSQL is supported only on new containers so you need to apply the vector policy during the time of container creation and it can’t be modified later.  For this example, the indexing policy would look something like this: 
 
 ```csharp 
-  Collection<Embedding> collection = new Collection<Embedding>(embeddings);
-  ContainerProperties properties = new ContainerProperties(id: "vector-container", partitionKeyPath: "/id")
-  {   
-      VectorEmbeddingPolicy = new(collection),
-      IndexingPolicy = new IndexingPolicy()
-      {
-          VectorIndexes = new()
-          {
-              new VectorIndexPath()
-              {
-                  Path = "/vector",
-                  Type = VectorIndexType.QuantizedFlat,
-              }
-          }
-      },
-  };
+    Collection<Embedding> collection = new Collection<Embedding>(embeddings);
+    ContainerProperties properties = new ContainerProperties(id: "vector-container", partitionKeyPath: "/id")
+    {   
+        VectorEmbeddingPolicy = new(collection),
+        IndexingPolicy = new IndexingPolicy()
+        {
+            VectorIndexes = new()
+            {
+                new VectorIndexPath()
+                {
+                    Path = "/vector",
+                    Type = VectorIndexType.QuantizedFlat,
+                }
+            }
+        },
+    };
+    properties.IndexingPolicy.IncludedPaths.Add(new IncludedPath { Path = "/*" });    
+    properties.IndexingPolicy.ExcludedPaths.Add(new ExcludedPath { Path = "/vector/*" });
 ``` 
+>[!IMPORTANT]
+> The vector path added to the "excludedPaths" section of the indexing policy to ensure optimized performance for insertion. Not adding the vector path to "excludedPaths" will result in higher RU charge and latency for vector insertions.
 
 > [!IMPORTANT]
 > Currently vector search in Azure Cosmos DB for NoSQL is supported on new containers only. You need to set both the container vector policy and any vector indexing policy during the time of container creation as it can’t be modified later. Both policies will be modifiable in a future improvement to the preview feature.

articles/cosmos-db/nosql/how-to-java-vector-index-query.md

@@ -115,12 +115,12 @@ Once the vector embedding paths are decided, vector indexes need to be added to
 ```java 
 IndexingPolicy indexingPolicy = new IndexingPolicy();
 indexingPolicy.setIndexingMode(IndexingMode.CONSISTENT);
-ExcludedPath excludedPath = new ExcludedPath("/*");
-indexingPolicy.setExcludedPaths(Collections.singletonList(excludedPath));
+ExcludedPath excludedPath1 = new ExcludedPath("/coverImageVector/*");
+ExcludedPath excludedPath2 = new ExcludedPath("/contentVector/*");
+indexingPolicy.setExcludedPaths(ImmutableList.of(excludedPath1, excludedPath2));
 
-IncludedPath includedPath1 = new IncludedPath("/name/?");
-IncludedPath includedPath2 = new IncludedPath("/description/?");
-indexingPolicy.setIncludedPaths(ImmutableList.of(includedPath1, includedPath2));
+IncludedPath includedPath1 = new IncludedPath("/*");
+indexingPolicy.setIncludedPaths(Collections.singletonList(includedPath1));
 
 // Creating vector indexes
 CosmosVectorIndexSpec cosmosVectorIndexSpec1 = new CosmosVectorIndexSpec();
@@ -143,6 +143,10 @@ database.createContainer(collectionDefinition).block();
 ```
 
 
+
+>[!IMPORTANT]
+> The vector path added to the "excludedPaths" section of the indexing policy to ensure optimized performance for insertion. Not adding the vector path to "excludedPaths" will result in higher RU charge and latency for vector insertions.
+
 > [!IMPORTANT]
 > Currently vector search in Azure Cosmos DB for NoSQL is supported on new containers only. You need to set both the container vector policy and any vector indexing policy during the time of container creation as it can’t be modified later. Both policies will be modifiable in a future improvement to the preview feature.
 

articles/cosmos-db/nosql/how-to-manage-indexing-policy.md

@@ -105,7 +105,7 @@ In addition to including or excluding paths for individual properties, you can a
 > You must enroll in the [Azure Cosmos DB NoSQL Vector Index preview feature](vector-search.md#enroll-in-the-vector-search-preview-feature) to use vector search in Azure Cosmos DB for NoSQL.> 
 
 >[!IMPORTANT]
-> A vector indexing policy must be on the path defined in the container's vector policy. [Learn more about container vector policies](vector-search.md#container-vector-policies).)
+> A vector indexing policy must be on the same path defined in the container's vector policy. [Learn more about container vector policies](vector-search.md#container-vector-policies).)
 
 ```json
 {
@@ -119,6 +119,9 @@ In addition to including or excluding paths for individual properties, you can a
     "excludedPaths": [
         {
             "path": "/_etag/?"
+        },
+        {
+            "path": "/vector/*"
         }
     ],
     "vectorIndexes": [
@@ -130,6 +133,10 @@ In addition to including or excluding paths for individual properties, you can a
 }
 ```
 
+>[!IMPORTANT]
+> The vector path added to the "excludedPaths" section of the indexing policy to ensure optimized performance for insertion. Not adding the vector path to "excludedPaths" will result in higher RU charge and latency for vector insertions.
+
+
 You can define the following types of vector index policies:
 
 | Type | Description | Max dimensions |

articles/cosmos-db/nosql/how-to-python-vector-index-query.md

@@ -97,10 +97,12 @@ vector_embedding_policy = {
             "distanceFunction": "cosine", 
             "dimensions": 10 
         } 
-    ] 
+    ]    
 } 
 ``` 
 
+
+
 ## Creating a vector index in the indexing policy 
 Once the vector embedding paths are decided, vector indexes need to be added to the indexing policy. For this example, the indexing policy would look something like this: 
 
@@ -113,7 +115,10 @@ indexing_policy = {
     ], 
     "excludedPaths": [ 
         { 
-            "path": "/\"_etag\"/?" 
+            "path": "/\"_etag\"/?",
+            "path": "/coverImageVector/*",
+            "path": "/contentVector/*"
+            
         } 
     ], 
     "vectorIndexes": [ 
@@ -127,6 +132,10 @@ indexing_policy = {
 } 
 ``` 
 
+>[!IMPORTANT]
+> The vector path added to the "excludedPaths" section of the indexing policy to ensure optimized performance for insertion. Not adding the vector path to "excludedPaths" will result in higher RU charge and latency for vector insertions.
+
+
 > [!IMPORTANT]
 > Currently vector search in Azure Cosmos DB for NoSQL is supported on new containers only. You need to set both the container vector policy and any vector indexing policy during the time of container creation as it can’t be modified later. Both policies will be modifiable in a future improvement to the preview feature.