Skip to content

Commit 323cbb3

Browse files
committed
Freshness pass #2
1 parent f07449c commit 323cbb3

11 files changed

+111
-119
lines changed

articles/search/search-faq-frequently-asked-questions.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ metadata:
1111
ms.custom:
1212
- ignite-2023
1313
ms.topic: faq
14-
ms.date: 12/12/2023
14+
ms.date: 02/21/2024
1515
title: Azure AI Search Frequently Asked Questions
1616
summary: Find answers to commonly asked questions about Azure AI Search.
1717

@@ -36,7 +36,7 @@ sections:
3636
- question: |
3737
What languages are supported?
3838
answer: |
39-
The default analyzer used for tokenization is standard Lucene and its language agnostic. Otherwise, language support is expressed through [language analyzers](index-add-language-analyzers.md#supported-language-analyzers) that apply linguistic rules to inbound (indexing) and outbound (queries) content. Some features, such as [semantic ranking](/rest/api/searchservice/preview-api/search-documents#queryLanguage) and [speller](speller-how-to-add.md#supported-languages), are limited to a subset of languages.
39+
The default analyzer used for tokenization is standard Lucene and it is language agnostic. Otherwise, language support is expressed through [language analyzers](index-add-language-analyzers.md#supported-language-analyzers) that apply linguistic rules to inbound (indexing) and outbound (queries) content. Some features, such as [speller](speller-how-to-add.md#supported-languages), are limited to a subset of languages.
4040
4141
- question: |
4242
How do I integrate search into my solution?
@@ -70,14 +70,14 @@ sections:
7070
- question: |
7171
What does "indexing" mean in Azure AI Search?
7272
answer: |
73-
It refers to the ingestion, parsing, and storing of textual content and tokens that populate a search index. Indexing creates inverted indexes and other physical data structures that support information retrieval.
73+
It refers to the ingestion, parsing, and storing of textual content and tokens that populate a search index. Indexing creates inverted indexes and other physical data structures that support information retrieval. It creates vector indexes if the schema includes vector fields.
7474
7575
- question: |
7676
Can I move, backup, and restore indexes?
7777
answer: |
78-
There's no native support for index management. Search indexes are considered downstream data structures, accepting content from other data sources that collect operational data. As such, there's no built-in support for backing up and restoring indexes because the expectation is that you would rebuild an index from source data if you deleted it, or wanted to move it.
78+
There's no native support for porting indexes. Search indexes are considered downstream data structures, accepting content from other data sources that collect operational data. As such, there's no built-in support for backing up and restoring indexes because the expectation is that you would rebuild an index from source data if you deleted it, or wanted to move it.
7979
80-
However, if you want to move an index between search services, you can try the **index-backup-restore** sample code in this [Azure AI Search .NET sample repo](https://github.com/Azure-Samples/azure-search-dotnet-utilities).
80+
However, if you want to move an index between search services, you can try the **index-backup-restore** sample code in this [Azure AI Search .NET sample repo](https://github.com/Azure-Samples/azure-search-dotnet-utilities). There's also a [Python version of backup and restore](https://github.com/Azure/azure-search-vector-samples/blob/main/demo-python/code/azure-search-backup-and-restore.ipynb).
8181
8282
- question: |
8383
Can I restore my index or service once it's deleted?
@@ -94,7 +94,7 @@ sections:
9494
- question: |
9595
What is vector search?
9696
answer: |
97-
Vector search is a technique that finds the most similar documents by comparing their vector representations. Since the goal of a vector representation is to capture the essential characteristics of an item in a numerical format, it can capture abstract concepts and identify matches even if there are no explicit matches based on keywords or tags. When a user performs a search, the query is summarized into a vector representation and the vector search engine identifies the most similar documents. To improve efficiency on large databases, vector search often provides the approximate nearest neighbors for a query vector. See [Vector search overview](vector-search-overview.md) for the specifics of Azure AI Search's vector search product offering.
97+
Vector search is a technique that finds the most similar documents by comparing their vector representations. Since the goal of a vector representation is to capture the essential characteristics of an item in a numerical format, vector queries can identify similar content even if there are no explicit matches based on keywords or tags. When a user performs a search, the query is summarized into a vector representation and the vector search engine identifies the most similar documents. To improve efficiency on large databases, vector search often provides the approximate nearest neighbors for a query vector. See [Vector search overview](vector-search-overview.md) for the specifics of Azure AI Search's vector offering.
9898
9999
- question: |
100100
Does Azure AI Search support vector search?
@@ -135,11 +135,11 @@ sections:
135135
answer: |
136136
To enable vector search in an index, you should:
137137
138-
* Add one or more fields of type `Collection(Edm.Single)`, with a "dimensions" property and an "vectorSearchConfiguration" property.
138+
* Add one or more vector fields to a field collection.
139139
140140
* Add a "vectorSearch" section to the index schema specifying the configuration used by vector search fields, including the parameters of the Approximate Nearest Neighbor algorithm used, like HNSW.
141141
142-
* Use the [**2023-11-01**](/rest/api/searchservice) or an Azure SDK to create or update the index, load documents, and issue queries.
142+
* Use [**2023-11-01**](/rest/api/searchservice) or an Azure SDK to create or update the index, load documents, and issue queries.
143143
144144
- name: Queries
145145
questions:

articles/search/search-howto-connecting-azure-sql-iaas-to-azure-search-using-indexers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.service: cognitive-search
1010
ms.custom:
1111
- ignite-2023
1212
ms.topic: conceptual
13-
ms.date: 08/24/2022
13+
ms.date: 02/24/2024
1414
---
1515

1616
# Indexer connections to a SQL Server instance on an Azure virtual machine

articles/search/search-howto-incremental-index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.service: cognitive-search
88
ms.custom:
99
- ignite-2023
1010
ms.topic: how-to
11-
ms.date: 01/31/2023
11+
ms.date: 02/22/2024
1212
---
1313

1414
# Enable caching for incremental enrichment in Azure AI Search

articles/search/search-howto-indexing-azure-tables.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.service: cognitive-search
1111
ms.custom:
1212
- ignite-2023
1313
ms.topic: how-to
14-
ms.date: 03/22/2023
14+
ms.date: 02/22/2024
1515
---
1616

1717
# Index data from Azure Table Storage
@@ -37,7 +37,7 @@ The data source definition specifies the source data to index, credentials, and
3737
1. [Create or update a data source](/rest/api/searchservice/create-data-source) to set its definition:
3838

3939
```http
40-
POST https://[service name].search.windows.net/datasources?api-version=2020-06-30
40+
POST https://[service name].search.windows.net/datasources?api-version=2023-11-01
4141
{
4242
"name": "my-table-storage-ds",
4343
"description": null,
@@ -123,7 +123,7 @@ In a [search index](search-what-is-an-index.md), add fields to accept the conten
123123
1. [Create or update an index](/rest/api/searchservice/create-index) to define search fields that will store content from entities:
124124

125125
```http
126-
POST https://[service name].search.windows.net/indexes?api-version=2020-06-30
126+
POST https://[service name].search.windows.net/indexes?api-version=2023-11-01
127127
{
128128
"name" : "my-search-index",
129129
"fields": [
@@ -163,7 +163,7 @@ Once you have an index and data source, you're ready to create the indexer. Inde
163163
1. [Create or update an indexer](/rest/api/searchservice/create-indexer) by giving it a name and referencing the data source and target index:
164164

165165
```http
166-
POST https://[service name].search.windows.net/indexers?api-version=2020-06-30
166+
POST https://[service name].search.windows.net/indexers?api-version=2023-11-01
167167
{
168168
"name" : "my-table-indexer",
169169
"dataSourceName" : "my-table-storage-ds",
@@ -203,7 +203,7 @@ An indexer runs automatically when it's created. You can prevent this by setting
203203
To monitor the indexer status and execution history, send a [Get Indexer Status](/rest/api/searchservice/get-indexer-status) request:
204204

205205
```http
206-
GET https://myservice.search.windows.net/indexers/myindexer/status?api-version=2020-06-30
206+
GET https://myservice.search.windows.net/indexers/myindexer/status?api-version=2023-11-01
207207
Content-Type: application/json
208208
api-key: [admin key]
209209
```

articles/search/search-howto-managed-identities-cosmos-db.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: Set up an indexer connection to Azure Cosmos DB via a managed identity
33
titleSuffix: Azure AI Search
4-
description: Learn how to set up an indexer connection to an Azure Cosmos DB account via a managed identity
4+
description: Learn how to set up an indexer connection to an Azure Cosmos DB account via a managed identity.
55
author: gmndrg
66
ms.author: gimondra
77

88
ms.service: cognitive-search
99
ms.topic: how-to
10-
ms.date: 09/19/2022
10+
ms.date: 02/22/2024
1111
ms.custom:
1212
- subject-rbac-steps
1313
- ignite-2023
@@ -43,11 +43,12 @@ Role assignment for system-assigned identity:
4343
```azurepowershell
4444
az cosmosdb sql role assignment create --account-name $cosmosdbname --resource-group $resourcegroup --role-definition-id $readOnlyRoleDefinitionId --principal-id $sys_principal --scope $scope
4545
```
46-
* For Cosmos DB for NoSQL, you can optionally [Enforcing RBAC as the only authentication method](../cosmos-db/how-to-setup-rbac.md#disable-local-auth)
46+
47+
* For Cosmos DB for NoSQL, you can optionally [enforce role-based access as the only authentication method](../cosmos-db/how-to-setup-rbac.md#disable-local-auth)
4748
for data connections by setting `disableLocalAuth` to `true` for your Cosmos DB account.
4849

4950
* *For Gremlin and MongoDB Collections*:
50-
Indexer support is currently in preview. At this time, a preview limitation exists that requires Azure AI Search to connect using keys. You can still set up a managed identity and role assignment, but Azure AI Search will only use the role assignment to get keys for the connection. This limitation means that you can't configure an [RBAC-only approach](../cosmos-db/how-to-setup-rbac.md#disable-local-auth) if your indexers are connecting to Gremlin or MongoDB using Search with managed identities to connect to Azure Cosmos DB.
51+
Indexer support is currently in preview. At this time, a preview limitation exists that requires Azure AI Search to connect using keys. You can still set up a managed identity and role assignment, but Azure AI Search will only use the role assignment to get keys for the connection. This limitation means that you can't configure a [role-based approach](../cosmos-db/how-to-setup-rbac.md#disable-local-auth) if your indexers are connecting to Gremlin or MongoDB using Search with managed identities to connect to Azure Cosmos DB.
5152

5253
* You should be familiar with [indexer concepts](search-indexer-overview.md) and [configuration](search-howto-index-cosmosdb.md).
5354

@@ -62,7 +63,7 @@ The [REST API](/rest/api/searchservice/create-data-source), Azure portal, and th
6263
When you're connecting with a system-assigned managed identity, the only change to the data source definition is the format of the "credentials" property. You'll provide the database name and a ResourceId that has no account key or password. The ResourceId must include the subscription ID of Azure Cosmos DB, the resource group, and the Azure Cosmos DB account name.
6364

6465
* For SQL collections, the connection string doesn't require "ApiKind".
65-
* For SQL collections add "IdentityAuthType=AccessToken" if RBAC is enforced as the only authentication method. It is not applicable for MongoDB and Gremlin collections.
66+
* For SQL collections, add "IdentityAuthType=AccessToken" if role-based access is enforced as the only authentication method. It isn't applicable for MongoDB and Gremlin collections.
6667
* For MongoDB collections, add "ApiKind=MongoDb" to the connection string and use a preview REST API.
6768
* For Gremlin graphs, add "ApiKind=Gremlin" to the connection string and use a preview REST API.
6869

@@ -93,11 +94,11 @@ The 2021-04-30-preview REST API supports connections based on a user-assigned ma
9394
* First, the format of the "credentials" property is the database name and a ResourceId that has no account key or password. The ResourceId must include the subscription ID of Azure Cosmos DB, the resource group, and the Azure Cosmos DB account name.
9495

9596
* For SQL collections, the connection string doesn't require "ApiKind".
96-
* For SQL collections add "IdentityAuthType=AccessToken" if RBAC is enforced as the only authentication method. It is not applicable for MongoDB and Gremlin collections.
97+
* For SQL collections, add "IdentityAuthType=AccessToken" if role-based access is enforced as the only authentication method. It isn't applicable for MongoDB and Gremlin collections.
9798
* For MongoDB collections, add "ApiKind=MongoDb" to the connection string
9899
* For Gremlin graphs, add "ApiKind=Gremlin" to the connection string.
99100

100-
* Second, you'll add an "identity" property that contains the collection of user-assigned managed identities. Only one user-assigned managed identity should be provided when creating the data source. Set it to type "userAssignedIdentities".
101+
* Second, you add an "identity" property that contains the collection of user-assigned managed identities. Only one user-assigned managed identity should be provided when creating the data source. Set it to type "userAssignedIdentities".
101102

102103
Here's an example of how to create an indexer data source object using the [preview Create or Update Data Source](/rest/api/searchservice/preview-api/create-or-update-data-source) REST API:
103104

@@ -148,7 +149,7 @@ api-key: [admin key]
148149

149150
An indexer connects a data source with a target search index and provides a schedule to automate the data refresh. Once the index and data source have been created, you're ready to create and run the indexer. If the indexer is successful, the connection syntax and role assignments are valid.
150151

151-
Here's a [Create Indexer](/rest/api/searchservice/create-indexer) REST API call with an Azure Cosmos DB indexer definition. The indexer will run when you submit the request.
152+
Here's a [Create Indexer](/rest/api/searchservice/create-indexer) REST API call with an Azure Cosmos DB indexer definition. The indexer runs when you submit the request.
152153

153154
```http
154155
POST https://[service name].search.windows.net/indexers?api-version=2020-06-30
@@ -164,7 +165,7 @@ Here's a [Create Indexer](/rest/api/searchservice/create-indexer) REST API call
164165

165166
## Troubleshooting
166167

167-
If you recently rotated your Azure Cosmos DB account keys, you'll need to wait up to 15 minutes for the managed identity connection string to work.
168+
If you recently rotated your Azure Cosmos DB account keys, you need to wait up to 15 minutes for the managed identity connection string to work.
168169

169170
Check to see if the Azure Cosmos DB account has its access restricted to select networks. You can rule out any firewall issues by trying the connection without restrictions in place.
170171

articles/search/search-howto-managed-identities-sql.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Connect to Azure SQL
33
titleSuffix: Azure AI Search
4-
description: Learn how to set up an indexer connection to Azure SQL Database using a managed identity
4+
description: Learn how to set up an indexer connection to Azure SQL Database using a managed identity.
55
author: gmndrg
66
ms.author: gimondra
77
manager: nitinme
@@ -10,7 +10,7 @@ ms.custom:
1010
- ignite-2023
1111
ms.service: cognitive-search
1212
ms.topic: how-to
13-
ms.date: 09/19/2022
13+
ms.date: 02/22/2024
1414
---
1515

1616
# Set up an indexer connection to Azure SQL using a managed identity
@@ -31,11 +31,11 @@ You can use a system-assigned managed identity or a user-assigned managed identi
3131

3232
Follow the below steps to assign the search service or user-assigned managed identity permission to read the database.
3333

34-
1. Connect to Visual Studio
34+
1. Connect to Visual Studio.
3535

3636
![Connect to Visual Studio](./media/search-managed-identities/connect-with-visual-studio.png "Connect to Visual Studio")
3737

38-
2. Authenticate with your Microsoft Entra account
38+
2. Authenticate with your Microsoft Entra account.
3939

4040
![Authenticate](./media/search-managed-identities/visual-studio-authenticate.png "Authenticate")
4141

@@ -97,7 +97,7 @@ When you're connecting with a system-assigned managed identity, the only change
9797
Here's an example of how to create a data source to index data from a storage account using the [Create Data Source](/rest/api/searchservice/create-data-source) REST API and a managed identity connection string. The managed identity connection string format is the same for the REST API, .NET SDK, and the Azure portal.
9898

9999
```http
100-
POST https://[service name].search.windows.net/datasources?api-version=2020-06-30
100+
POST https://[service name].search.windows.net/datasources?api-version=2023-11-01
101101
Content-Type: application/json
102102
api-key: [admin key]
103103
@@ -119,7 +119,7 @@ The 2021-04-30-preview REST API supports connections based on a user-assigned ma
119119
120120
* First, the format of the "credentials" property is an Initial Catalog or Database name and a ResourceId that has no account key or password. The ResourceId must include the subscription ID of Azure SQL Database, the resource group of SQL Database, and the name of the SQL database. This is the same format as the system-assigned managed identity.
121121
122-
* Second, you'll add an "identity" property that contains the collection of user-assigned managed identities. Only one user-assigned managed identity should be provided when creating the data source. Set it to type "userAssignedIdentities".
122+
* Second, add an "identity" property that contains the collection of user-assigned managed identities. Only one user-assigned managed identity should be provided when creating the data source. Set it to type "userAssignedIdentities".
123123
124124
Here's an example of how to create an indexer data source object using the [preview Create or Update Data Source](/rest/api/searchservice/preview-api/create-or-update-data-source) REST API:
125125

@@ -151,7 +151,7 @@ The index specifies the fields in a document, attributes, and other constructs t
151151
Here's a [Create Index](/rest/api/searchservice/create-index) REST API call with a searchable `booktitle` field:
152152
153153
```http
154-
POST https://[service name].search.windows.net/indexes?api-version=2020-06-30
154+
POST https://[service name].search.windows.net/indexes?api-version=2023-11-01
155155
Content-Type: application/json
156156
api-key: [admin key]
157157
@@ -168,25 +168,22 @@ api-key: [admin key]
168168
169169
An indexer connects a data source with a target search index, and provides a schedule to automate the data refresh. Once the index and data source have been created, you're ready to create the indexer. If the indexer is successful, the connection syntax and role assignments are valid.
170170

171-
Here's a [Create Indexer](/rest/api/searchservice/create-indexer) REST API call with an Azure SQL indexer definition. The indexer will run when you submit the request.
171+
Here's a [Create Indexer](/rest/api/searchservice/create-indexer) REST API call with an Azure SQL indexer definition. The indexer runs when you submit the request.
172172
173173
```http
174-
POST https://[service name].search.windows.net/indexers?api-version=2020-06-30
174+
POST https://[service name].search.windows.net/indexers?api-version=2023-11-01
175175
Content-Type: application/json
176176
api-key: [admin key]
177177
178178
{
179179
"name" : "sql-indexer",
180180
"dataSourceName" : "sql-datasource",
181181
"targetIndexName" : "my-target-index"
182+
}
182183
```
183184
184-
## Troubleshooting
185-
186185
If you get an error when the indexer tries to connect to the data source that says that the client isn't allowed to access the server, take a look at [common indexer errors](./search-indexer-troubleshooting.md).
187186

188-
You can also rule out any firewall issues by trying the connection with and without restrictions in place.
189-
190187
## See also
191188

192-
* [Azure SQL indexer](search-howto-connecting-azure-sql-database-to-azure-search-using-indexers.md)
189+
[Azure SQL indexer](search-howto-connecting-azure-sql-database-to-azure-search-using-indexers.md)

0 commit comments

Comments
 (0)