Skip to content

Commit 810cff5

Browse files
committed
updates to Cosmos DB for NoSQL naming
aka remove some vCore-based references
1 parent 9b90849 commit 810cff5

File tree

6 files changed

+16
-16
lines changed

6 files changed

+16
-16
lines changed

02_Overview_Cosmos_DB/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The focus for this developer guide is [Azure Cosmos DB for NoSQL](https://learn.
1414

1515
The [RU architecture](https://learn.microsoft.com/azure/cosmos-db/request-units) for Azure Cosmos DB for NoSQL offers instantaneous scalability with zero warmup period, automatic and transparent sharding, and 99.999% availability. It supports active-active databases across multiple regions, cost-efficient, granular, unlimited scalability, real-time analytics, and serverless deployments paying only per operation.
1616

17-
[vCore-based Azure Cosmos DB for NoSQL architecture](https://learn.microsoft.com/azure/cosmos-db/convert-vcore-to-request-unit) integrates AI-based applications with private organizational data, with text indexing for easy querying. Simplify the development process with high-capacity vertical scaling and free 35-day backups with a point-in-time restore (PITR).
17+
[Azure Cosmos DB for NoSQL architecture](https://learn.microsoft.com/azure/cosmos-db/convert-vcore-to-request-unit) integrates AI-based applications with private organizational data, with text indexing for easy querying. Simplify the development process with high-capacity vertical scaling and free 35-day backups with a point-in-time restore (PITR).
1818

1919
The [choice between vCore and Request Units (RU)](hhttps://learn.microsoft.com/azure/cosmos-db/convert-vcore-to-request-unit) in Azure Cosmos DB for NoSQL API depends on the workload. A list of [compatibility and feature support between RU and vCore](https://learn.microsoft.com/azure/cosmos-db/mongodb/vcore/compatibility) is available.
2020

03_Overview_Azure_OpenAI/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Developers can use Azure AI Services, along with other Azure services, to build
4646

4747
### Azure AI Services
4848

49-
While this guide focuses on building intelligent apps using Azure OpenAI combined with vCore-based Azure Cosmos DB for NoSQL, the Azure AI Platform consists of many additional AI services. Each AI service is built to fit a specific AI and/or Machine Learning (ML) need.
49+
While this guide focuses on building intelligent apps using Azure OpenAI combined with Azure Cosmos DB for NoSQL, the Azure AI Platform consists of many additional AI services. Each AI service is built to fit a specific AI and/or Machine Learning (ML) need.
5050

5151
Here's a list of the AI services within the [Azure AI platform](https://learn.microsoft.com/azure/ai-services/what-are-ai-services):
5252

07_Create_First_Cosmos_DB_Project/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Learn more about the pre-requisites and installation of the emulator [here](http
1414

1515
>**NOTE**: When using the Azure CosmosDB emulator using the API for MongoDB it must be started with the [MongoDB endpoint options enabled](https://learn.microsoft.com/azure/cosmos-db/how-to-develop-emulator?tabs=windows%2Cpython&pivots=api-mongodb#start-the-emulator) at the command-line.
1616
17-
**The Azure Cosmos DB emulator does not support vector search. To complete the vector search and AI-related labs, a vCore-based Azure Cosmos DB for NoSQL account in Azure is required.**
17+
**The Azure Cosmos DB emulator does not support vector search. To complete the vector search and AI-related labs, a Azure Cosmos DB for NoSQL account in Azure is required.**
1818

1919
## Authentication
2020

09_Vector_Search_Cosmos_DB/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Use vector search on embeddings in Azure Cosmos DB for NoSQL
22

3-
>**NOTE**: vCore-based Azure Cosmos DB for NoSQL supports vector search on embeddings. This functionality is not supported on RUs-based accounts.
3+
>**NOTE**: Azure Cosmos DB for NoSQL supports vector search on embeddings. This functionality is not supported on RUs-based accounts.
44
55
## Embeddings and vector search
66

77
Embedding is a way of serializing the semantic meaning of data into a vector representation. Because the generated vector embedding represents the semantic meaning, it means that when it is searched, it can find similar data based on the semantic meaning of the data rather than exact text. Data can come from many sources, including text, images, audio, and video. Because the data is represented as a vector, vector search can, therefore, find similar data across all different types of data.
88

9-
Embeddings are created by sending data to an embedding model, where it is transformed into a vector, which then can be stored as a vector field within its source document in vCore-based Azure Cosmos DB for NoSQL. vCore-based Azure Cosmos DB for NoSQL supports the creation of vector search indexes on top of these vector fields. A vector search index is a collection of vectors in [latent space](https://idl.cs.washington.edu/papers/latent-space-cartography/) that enables a semantic similarity search across all data (vectors) contained within.
9+
Embeddings are created by sending data to an embedding model, where it is transformed into a vector, which then can be stored as a vector field within its source document in Azure Cosmos DB for NoSQL. Azure Cosmos DB for NoSQL supports the creation of vector search indexes on top of these vector fields. A vector search index is a collection of vectors in [latent space](https://idl.cs.washington.edu/papers/latent-space-cartography/) that enables a semantic similarity search across all data (vectors) contained within.
1010

1111
![A typical embedding pipeline that demonstrates how source data is transformed into vectors using an embedding model then stored in a document in an Azure Cosmos DB vCore database and exposed via a vector search index.](media/embedding_pipeline.png)
1212

@@ -16,15 +16,15 @@ Vector search is an important RAG (Retrieval Augmented Generation) pattern compo
1616

1717
A vector index search allows for a prompt pre-processing step where information can be semantically retrieved from an index and then used to generate a factually accurate prompt for the LLM to reason over. This provides the knowledge augmentation and focus (attention) to the LLM.
1818

19-
In this example, assume textual data is vectorized and stored within an vCore-based Azure Cosmos DB for NoSQL database. The text data and embeddings/vector field are stored in the same document. A vector search index has been created on the vector field. When a message is received from a chat application, this message is also vectorized using the same embedding model (ex., Azure OpenAI text-embedding-ada-002), which is then used as input to the vector search index. The vector search index returns a list of documents whose vector field is semantically similar to the incoming message. The unvectorized text stored within the same document is then used to augment the LLM prompt. The LLM receives the prompt and responds to the requestor based on the information it has been given.
19+
In this example, assume textual data is vectorized and stored within an Azure Cosmos DB for NoSQL database. The text data and embeddings/vector field are stored in the same document. A vector search index has been created on the vector field. When a message is received from a chat application, this message is also vectorized using the same embedding model (ex., Azure OpenAI text-embedding-ada-002), which is then used as input to the vector search index. The vector search index returns a list of documents whose vector field is semantically similar to the incoming message. The unvectorized text stored within the same document is then used to augment the LLM prompt. The LLM receives the prompt and responds to the requestor based on the information it has been given.
2020

2121
![A typical vector search request in a RAG scenario depicts an incoming message getting vectorized and used as input to a vector store index search. Multiple results of the vector search are used to build a prompt fed to the LLM. The LLM returns a response to the requestor.](media/vector_search_flow.png)
2222

23-
## Why use vCore-based Azure Cosmos DB for NoSQL as a vector store?
23+
## Why use Azure Cosmos DB for NoSQL as a vector store?
2424

25-
It is common practice to store vectorized data in a dedicated vector store as vector search indexing is not a common capability of most databases. However, this introduces additional complexity to the solution as the data must be stored in two different locations. vCore-based Azure Cosmos DB for NoSQL supports vector search indexing, which means that the vectorized data can be stored in the same document as the original data. This reduces the complexity of the solution and allows for a single database to be used for both the vector store and the original data.
25+
It is common practice to store vectorized data in a dedicated vector store as vector search indexing is not a common capability of most databases. However, this introduces additional complexity to the solution as the data must be stored in two different locations. Azure Cosmos DB for NoSQL supports vector search indexing, which means that the vectorized data can be stored in the same document as the original data. This reduces the complexity of the solution and allows for a single database to be used for both the vector store and the original data.
2626

27-
## Lab - Use vector search on embeddings in vCore-based Azure Cosmos DB for NoSQL
27+
## Lab - Use vector search on embeddings in Azure Cosmos DB for NoSQL
2828

2929
In this lab, a notebook demonstrates how to add an embedding field to a document, create a vector search index, and perform a vector search query. The notebook ends with a demonstration of utilizing vector search with an LLM in a RAG scenario using Azure OpenAI.
3030

@@ -36,7 +36,7 @@ On the **Settings** screen, select the **Resource** tab, then copy and record th
3636

3737
![The Azure OpenAI resource settings screen displays with the endpoint and key values highlighted.](media/azure_openai_settings.png)
3838

39-
>**NOTE**: This lab can only be completed using a deployed vCore-based Azure Cosmos DB for NoSQL account due to the use of vector search. The Azure Cosmos DB Emulator does not support vector search.
39+
>**NOTE**: This lab can only be completed using a deployed Azure Cosmos DB for NoSQL account due to the use of vector search. The Azure Cosmos DB Emulator does not support vector search.
4040
4141
This lab also requires the data provided in the previous lab titled [Load data into Azure Cosmos DB API for NoSQL collections](../08_Load_Data/README.md#lab---load-data-into-azure-cosmos-db-api-for-mongodb-collections). Run all cells in this notebook to prepare the data for use in this lab.
4242

Labs/lab_3_mongodb_vector_search.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# Vector Search using vCore-based Azure Cosmos DB for NoSQL\n",
7+
"# Vector Search using Azure Cosmos DB for NoSQL\n",
88
"\n",
99
"This notebook demonstrates using an Azure OpenAI embedding model to vectorize documents already stored in Azure Cosmos DB API for MongoDB, storing the embedding vectors and the creation of a vector index. Lastly, the notebook will demonstrate how to query the vector index to find similar documents.\n",
1010
"\n",
@@ -270,9 +270,9 @@
270270
"cell_type": "markdown",
271271
"metadata": {},
272272
"source": [
273-
"## Use vector search in vCore-based Azure Cosmos DB for NoSQL\n",
273+
"## Use vector search in Azure Cosmos DB for NoSQL\n",
274274
"\n",
275-
"Now that each document has its associated vector embedding and the vector indexes have been created on each collection, we can now use the vector search capabilities of vCore-based Azure Cosmos DB for NoSQL."
275+
"Now that each document has its associated vector embedding and the vector indexes have been created on each collection, we can now use the vector search capabilities of Azure Cosmos DB for NoSQL."
276276
]
277277
},
278278
{

Labs/lab_4_langchain.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,9 @@
7676
"source": [
7777
"## Vector search with LangChain\n",
7878
"\n",
79-
"In the previous lab, the `pymongo` library was used to perform a vector search through a db command to find product documents that were most similar to the user's input. In this lab, you will use the `langchain` library to perform the same search. LangChain has a vector store class named **AzureCosmosDBVectorSearch**, a community contribution, that supports vector search in vCore-based Azure Cosmos DB for NoSQL.\n",
79+
"In the previous lab, the `pymongo` library was used to perform a vector search through a db command to find product documents that were most similar to the user's input. In this lab, you will use the `langchain` library to perform the same search. LangChain has a vector store class named **AzureCosmosDBVectorSearch**, a community contribution, that supports vector search in Azure Cosmos DB for NoSQL.\n",
8080
"\n",
81-
"When establishing the connection to the vector store (vCore-based Azure Cosmos DB for NoSQL), recall that in previous labs the products collection was populated and a contentVector field added that contains the vectorized embeddings of the document itself. Finally, a vector index was also created on the contentVector field to enable vector search. The vector index in each collection is named `VectorSearchIndex`.\n",
81+
"When establishing the connection to the vector store (Azure Cosmos DB for NoSQL), recall that in previous labs the products collection was populated and a contentVector field added that contains the vectorized embeddings of the document itself. Finally, a vector index was also created on the contentVector field to enable vector search. The vector index in each collection is named `VectorSearchIndex`.\n",
8282
"\n",
8383
"The return value of a vector search in LangChain is a list of `Document` objects. The LangChain `Document` class contains two properties: `page_content`, that represents the textual content that is typically used to augment the prompt, and `metadata` that contains all other attributes of the document. In the cell below, we'll use the `_id` field as the page_content, and the rest of the fields are returned as metadata.\n",
8484
"\n",
@@ -272,7 +272,7 @@
272272
"metadata": {},
273273
"outputs": [],
274274
"source": [
275-
"# Create tools that will use vector search in vCore-based Azure Cosmos DB for NoSQL collections\n",
275+
"# Create tools that will use vector search in Azure Cosmos DB for NoSQL collections\n",
276276
"\n",
277277
"# create a chain on the retriever to format the documents as JSON\n",
278278
"products_retriever_chain = products_retriever | format_docs\n",

0 commit comments

Comments
 (0)