Skip to content

Commit 03141dc

Browse files
Merge pull request #251296 from HeidiSteen/heidist-fix
[azure search] GH fix, links
2 parents c93b972 + dee4556 commit 03141dc

5 files changed

+21
-23
lines changed

articles/search/cognitive-search-tutorial-blob-dotnet.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: nitinme
88

99
ms.service: cognitive-search
1010
ms.topic: tutorial
11-
ms.date: 06/29/2023
11+
ms.date: 09/13/2023
1212
ms.custom: devx-track-csharp, devx-track-dotnet
1313
---
1414

@@ -125,9 +125,6 @@ To interact with your Azure Cognitive Search service you will need the service U
125125
126126
1. In **Settings** > **Keys**, get an admin key for full rights on the service. You can copy either the primary or secondary key.
127127
128-
<!-- This code sample doesn't include a query so the following sentence should be deleted.
129-
Get the query key as well. It's a best practice to issue query requests with read-only access. -->
130-
131128
![Get the service name and admin key](media/search-get-started-javascript/service-name-and-keys.png)
132129
133130
Having a valid key establishes trust, on a per request basis, between the application sending the request and the service that handles it.
@@ -164,10 +161,11 @@ For this project, install version 11 or later of the `Azure.Search.Documents` an
164161
165162
```json
166163
{
167-
"SearchServiceUri": "Put your search service URI here",
168-
"SearchServiceAdminApiKey": "Put your primary or secondary API key here",
169-
"SearchServiceQueryApiKey": "Put your query API key here",
170-
"AzureBlobConnectionString": "Put your Azure Blob connection string here",
164+
"SearchServiceUri": "<YourSearchServiceUri>",
165+
"SearchServiceAdminApiKey": "<YourSearchServiceAdminApiKey>",
166+
"SearchServiceQueryApiKey": "<YourSearchServiceQueryApiKey>",
167+
"AzureAIServicesKey": "<YourMultiRegionAzureAIServicesKey>",
168+
"AzureBlobConnectionString": "<YourAzureBlobConnectionString>"
171169
}
172170
```
173171
@@ -204,7 +202,7 @@ public static void Main(string[] args)
204202

205203
string searchServiceUri = configuration["SearchServiceUri"];
206204
string adminApiKey = configuration["SearchServiceAdminApiKey"];
207-
string cognitiveServicesKey = configuration["CognitiveServicesKey"];
205+
string azureAiServicesKey = configuration["AzureAIServicesKey"];
208206

209207
SearchIndexClient indexClient = new SearchIndexClient(new Uri(searchServiceUri), new AzureKeyCredential(adminApiKey));
210208
SearchIndexerClient indexerClient = new SearchIndexerClient(new Uri(searchServiceUri), new AzureKeyCredential(adminApiKey));
@@ -512,12 +510,14 @@ private static KeyPhraseExtractionSkill CreateKeyPhraseExtractionSkill()
512510
Build the [`SearchIndexerSkillset`](/dotnet/api/azure.search.documents.indexes.models.searchindexerskillset) using the skills you created.
513511

514512
```csharp
515-
private static SearchIndexerSkillset CreateOrUpdateDemoSkillSet(SearchIndexerClient indexerClient, IList<SearchIndexerSkill> skills,string cognitiveServicesKey)
513+
private static SearchIndexerSkillset CreateOrUpdateDemoSkillSet(SearchIndexerClient indexerClient, IList<SearchIndexerSkill> skills,string azureAiServicesKey)
516514
{
517515
SearchIndexerSkillset skillset = new SearchIndexerSkillset("demoskillset", skills)
518516
{
517+
// Azure AI services was formerly known as Cognitive Services.
518+
// The APIs still use the old name, so we need to create a CognitiveServicesAccountKey object.
519519
Description = "Demo skillset",
520-
CognitiveServicesAccount = new CognitiveServicesAccountKey(cognitiveServicesKey)
520+
CognitiveServicesAccount = new CognitiveServicesAccountKey(azureAiServicesKey)
521521
};
522522

523523
// Create the skillset in your search service.
@@ -559,7 +559,7 @@ skills.Add(splitSkill);
559559
skills.Add(entityRecognitionSkill);
560560
skills.Add(keyPhraseExtractionSkill);
561561

562-
SearchIndexerSkillset skillset = CreateOrUpdateDemoSkillSet(indexerClient, skills, cognitiveServicesKey);
562+
SearchIndexerSkillset skillset = CreateOrUpdateDemoSkillSet(indexerClient, skills, azureAiServicesKey);
563563
```
564564

565565
### Step 3: Create an index

articles/search/cognitive-search-tutorial-blob-python.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.author: heidist
99
ms.service: cognitive-search
1010
ms.devlang: python
1111
ms.topic: tutorial
12-
ms.date: 08/26/2022
12+
ms.date: 09/13/2023
1313
ms.custom: devx-track-python
1414
---
1515

articles/search/cognitive-search-tutorial-blob.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: HeidiSteen
66
ms.author: heidist
77
ms.service: cognitive-search
88
ms.topic: tutorial
9-
ms.date: 01/31/2023
9+
ms.date: 09/13/2023
1010
---
1111

1212
# Tutorial: Use REST and AI to generate searchable content from Azure blobs

articles/search/retrieval-augmented-generation-overview.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ author: HeidiSteen
88
ms.author: heidist
99
ms.service: cognitive-search
1010
ms.topic: conceptual
11-
ms.date: 08/31/2023
11+
ms.date: 09/13/2023
1212
---
1313

1414
# Retrieval Augmented Generation (RAG) in Azure Cognitive Search
1515

16-
Retrieval Augmentation Generation (RAG) is an architecture that augments the capabilities of a Large Language Model (LLM) like ChatGPT by adding an information retrieval system that provides the data. Adding an information retrieval system gives you control over the data used by an LLM. For an enterprise solution, RAG architecture means that you can constrain natural language processing to *your enterprise content* sourced from documents, images, audio, and video.
16+
Retrieval Augmentation Generation (RAG) is an architecture that augments the capabilities of a Large Language Model (LLM) like ChatGPT by adding an information retrieval system that provides the data. Adding an information retrieval system gives you control over the data used by an LLM when it formulates a response. For an enterprise solution, RAG architecture means that you can constrain natural language processing to *your enterprise content* sourced from vectorized documents, images, audio, and video.
1717

1818
The decision about which information retrieval system to use is critical because it determines the inputs to the LLM. The information retrieval system should provide:
1919

@@ -25,7 +25,7 @@ The decision about which information retrieval system to use is critical because
2525

2626
+ Integration with LLMs.
2727

28-
Azure Cognitive Search is a [proven solution for information retrieval](https://github.com/Azure-Samples/azure-search-openai-demo) in a RAG architecture because it provides compatible indexing and query capabilities, with the infrastructure and security of the Azure cloud. Through code and other components, you can design a comprehensive RAG solution that includes all of the elements for generative AI over your proprietary content.
28+
Azure Cognitive Search is a [proven solution for information retrieval](https://github.com/Azure-Samples/azure-search-openai-demo) in a RAG architecture. It provides indexing and query capabilities, with the infrastructure and security of the Azure cloud. Through code and other components, you can design a comprehensive RAG solution that includes all of the elements for generative AI over your proprietary content.
2929

3030
> [!NOTE]
3131
> New to LLM and RAG concepts? This [video clip](https://youtu.be/2meEvuWAyXs?t=404) from a Microsoft presentation offers a simple explanation.
@@ -38,7 +38,7 @@ Microsoft has several built-in implementations for using Cognitive Search in a R
3838

3939
+ Azure Machine Learning, a search index can be used as a [vector store](/azure/machine-learning/concept-vector-stores). You can [create a vector index in an Azure Machine Learning prompt flow](/azure/machine-learning/how-to-create-vector-index) that uses your Cognitive Search service for storage and retrieval.
4040

41-
If you need a custom approach however, you can create your own custom RAG solution. The remainder of this article explores how Cognitive Search fits into a custom solution.
41+
If you need a custom approach however, you can create your own custom RAG solution. The remainder of this article explores how Cognitive Search fits into a custom RAG solution.
4242

4343
> [!NOTE]
4444
> Prefer to look at code? You can review the [Azure Cognitive Search OpenAI demo](https://github.com/Azure-Samples/azure-search-openai-demo) for an example.
@@ -77,7 +77,7 @@ Cognitive Search doesn't provide native LLM integration, web frontends, or vecto
7777

7878
In Cognitive Search, all searchable content is stored in a search index that's hosted on your search service in the cloud. A search index is designed for fast queries with millisecond response times, so its internal data structures exist to support that objective. To that end, a search index stores *indexed content*, and not whole content files like entire PDFs or images. Internally, the data structures include inverted indexes of [tokenized text](https://lucene.apache.org/core/7_5_0/test-framework/org/apache/lucene/analysis/Token.html), vector indexes for embeddings, and unaltered text for cases where verbatim matching is required (for example, in filters, fuzzy search, regular expression queries).
7979

80-
When you set up the data for your RAG solution, you use the features that create and load an index in Cognitive Search. An index includes fields that duplicate or represent your source content. An index field might be simple transference (a title or description in a source document becomes a title or description in a search index), or a field might contain the output of an external process, such as vectorization or skill processing that generates a text description of an image.
80+
When you set up the data for your RAG solution, you use the features that create and load an index in Cognitive Search. An index includes fields that duplicate or represent your source content. An index field might be simple transference (a title or description in a source document becomes a title or description in a search index), or a field might contain the output of an external process, such as vectorization or skill processing that generates a representation or text description of an image.
8181

8282
Since you probably know what kind of content you want to search over, consider the indexing features that are applicable to each content type:
8383

@@ -244,10 +244,8 @@ print("\n-------------------\nPrompt:\n" + prompt)
244244
> [!NOTE]
245245
> Some Cognitive Search features are intended for human interaction and aren't useful in a RAG pattern. Specifically, you can skip autocomplete and suggestions. Other features like facets and orderby might be useful, but would be uncommon in a RAG scenario.
246246
247-
<!-- Vanity URL for this article, currently used only in the vector search overview doc
248-
https://aka.ms/what-is-rag -->
249-
250247
## See also
251248

252249
+ [Retrieval Augmented Generation: Streamlining the creation of intelligent natural language processing models](https://ai.meta.com/blog/retrieval-augmented-generation-streamlining-the-creation-of-intelligent-natural-language-processing-models/)
253250
+ [Retrieval Augmented Generation using Azure Machine Learning prompt flow](/azure/machine-learning/concept-retrieval-augmented-generation)
251+
+ [Azure Cognitive Search and LangChain: A Seamless Integration for Enhanced Vector Search Capabilities](https://techcommunity.microsoft.com/t5/azure-ai-services-blog/azure-cognitive-search-and-langchain-a-seamless-integration-for/ba-p/3901448)

articles/search/vector-search-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,4 +134,4 @@ Azure Cognitive Search uses Hierarchical Navigable Small Worlds (HNSW), which is
134134
+ [Try the quickstart](search-get-started-vector.md)
135135
+ [Learn more about vector indexing](vector-search-how-to-create-index.md)
136136
+ [Learn more about vector queries](vector-search-how-to-query.md)
137-
137+
+ [Azure Cognitive Search and LangChain: A Seamless Integration for Enhanced Vector Search Capabilities](https://techcommunity.microsoft.com/t5/azure-ai-services-blog/azure-cognitive-search-and-langchain-a-seamless-integration-for/ba-p/3901448)

0 commit comments

Comments
 (0)