Skip to content

Commit 9419842

Browse files
Merge pull request #279697 from HeidiSteen/heidist-june28
[azure search] misc edits
2 parents e3622bd + 0ad7bd9 commit 9419842

8 files changed

+30
-18
lines changed

articles/search/search-get-started-portal-image-search.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ Sample data consists of image files in the [azure-search-sample-data](https://gi
3232

3333
+ An Azure subscription. [Create one for free](https://azure.microsoft.com/free/).
3434

35-
+ Azure AI services, a multiservice account, in a region that provides Azure AI Vision multimodal embeddings.
35+
+ [Azure AI services multiservice account](/azure/ai-services/multi-service-resource), in a region that provides Azure AI Vision multimodal embeddings.
3636

3737
Currently, those regions are: SwedenCentral, EastUS, NorthEurope, WestEurope, WestUS, SoutheastAsia, KoreaCentral, FranceCentral, AustraliaEast, WestUS2, SwitzerlandNorth, JapanEast. [Check the documentation](/azure/ai-services/computer-vision/how-to/image-retrieval) for an updated list.
3838

3939
+ Azure AI Search, on any tier, but in the same region as Azure AI services.
4040

4141
Service tier determines how many blobs you can index. We used the free tier to create this walkthrough and limited the content to 10 JPG files.
4242

43-
+ Azure Storage, a standard performance (general-purpose v2) account. Access tiers can be hot, cool, and cold.
43+
+ Azure Blob storage, a standard performance (general-purpose v2) account. Access tiers can be hot, cool, and cold. ADLS Gen2 isn't supported, so if you enabled hierarchical namespace on your account, it won't work with this version of the wizard.
4444

4545
All of the above resources must have public access enabled for the portal nodes to be able to access them. Otherwise, the wizard fails. After the wizard runs, firewalls and private endpoints can be enabled on the different integration components for security.
4646

articles/search/search-get-started-portal-import-vectors.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,15 @@ For fewer limitations or more data source options, try a code-base approach. See
4444

4545
+ An Azure subscription. [Create one for free](https://azure.microsoft.com/free/).
4646

47-
+ For data, use either an [Azure Storage account](/azure/storage/common/storage-account-overview) or a [OneLake lakehouse](search-how-to-index-onelake-files.md). For Azure Storage, use a standard performance (general-purpose v2) account. Access tiers can be hot, cool, and cold.
47+
+ For data, use either an [Azure Storage account](/azure/storage/common/storage-account-overview) or a [OneLake lakehouse](search-how-to-index-onelake-files.md). For Azure Storage, use a standard performance (general-purpose v2) account. Access tiers can be hot, cool, and cold. ADLS Gen2 isn't supported, so if you enabled hierarchical namespace on your account, it won't work with this version of the wizard.
4848

49-
+ For vectorization, have an Azure AI services multiservice account or [Azure OpenAI](https://aka.ms/oai/access) endpoint with deployments.
49+
+ For vectorization, have an [Azure AI services multiservice account](/azure/ai-services/multi-service-resource) or [Azure OpenAI](https://aka.ms/oai/access) endpoint with deployments.
5050

5151
For [multimodal with Azure AI Vision](/azure/ai-services/computer-vision/how-to/image-retrieval), create an Azure AI service in SwedenCentral, EastUS, NorthEurope, WestEurope, WestUS, SoutheastAsia, KoreaCentral, FranceCentral, AustraliaEast, WestUS2, SwitzerlandNorth, JapanEast. [Check the documentation](/azure/ai-services/computer-vision/how-to/image-retrieval?tabs=csharp) for an updated list.
5252

5353
You can also use [Azure AI Studio model catalog](/azure/ai-studio/what-is-ai-studio) (and hub and project) with model deployments.
5454

55-
+ Azure AI Search, in the same region as your Azure AI service. We recommend Basic tier or higher.s
55+
+ Azure AI Search, in the same region as your Azure AI service. We recommend Basic tier or higher.
5656

5757
+ Role assignments or API keys are required for connections to embedding models and data sources. Instructions for role-based access are provided in this article.
5858

articles/search/search-get-started-portal.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ The wizard creates multiple objects on your search service - [searchable index](
2828

2929
- An Azure AI Search service for any tier and any region. [Create a service](search-create-service-portal.md) or [find an existing service](https://portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.Search%2FsearchServices) under your current subscription. You can use a free service for this quickstart.
3030

31+
For this quickstart, make sure the search service doesn't have [network access controls](service-configure-firewall.md) in place. The portal connects to the hosted sample data over a public endpoint. If search is behind a firewall, the wizard can't create the data source.
32+
3133
### Check for space
3234

3335
Many customers start with the free service. The free tier is limited to three indexes, three data sources, and three indexers. Make sure you have room for extra items before you begin. This quickstart creates one of each object.
@@ -50,7 +52,7 @@ In this section, create and load an index in four steps.
5052

5153
### Connect to a data source
5254

53-
The wizard creates a data source connection to sample data hosted by Microsoft on Azure Cosmos DB. This sample data is retrieved accessed over an internal connection. You don't need your own Azure Cosmos DB account or source files to run this quickstart.
55+
The wizard creates a data source connection to sample data hosted by Microsoft on Azure Cosmos DB. This sample data is retrieved accessed over a public endpoint. You don't need your own Azure Cosmos DB account or source files to run this quickstart.
5456

5557
1. On **Connect to your data**, expand the **Data Source** dropdown list and select **Samples**.
5658

articles/search/search-security-api-keys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ ms.date: 06/28/2024
1717

1818
Azure AI Search offers key-based authentication that you can use on connections to your search service. An API key is a unique string composed of 52 randomly generated numbers and letters. A request made to a search service endpoint is accepted if both the request and the API key are valid.
1919

20-
Key-based authentication is the default. You can disable it if you opt in for [role-based authentication](search-security-enable-roles.md).
20+
Key-based authentication is the default. You can replace it with [role-based access](search-security-enable-roles.md), which eliminates the need for hardcoded keys in your code.
2121

2222
## Types of API keys
2323

articles/search/search-security-enable-roles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.date: 06/18/2024
1414

1515
# Enable or disable role-based access control in Azure AI Search
1616

17-
If you want to use Azure role assignments for authorized access to Azure AI Search, this article explains how to enable role-based access for your search service.
17+
If you want to use roles for authorized access to Azure AI Search, this article explains how to enable role-based access control for your search service.
1818

1919
Role-based access for data plane operations is optional, but recommended as the more secure option. The alternative is [key-based authentication](search-security-api-keys.md), which is the default.
2020

articles/search/search-security-rbac.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.custom: subject-rbac-steps, references_regions, devx-track-azurepowershell
1414

1515
# Connect to Azure AI Search using role-based access controls
1616

17-
Azure provides a global [role-based access control authorization system](../role-based-access-control/role-assignments-portal.yml) for all services running on the platform. In Azure AI Search, you can assign Azure roles for:
17+
Azure provides a global authentication and [role-based authorization system](../role-based-access-control/role-assignments-portal.yml) for all services running on the platform. In Azure AI Search, you can assign Azure roles for:
1818

1919
> [!div class="checklist"]
2020
> + [Service administration](#assign-roles-for-service-administration)

articles/search/service-configure-firewall.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ There are a few drawbacks to locking down the public endpoint.
4242

4343
+ It takes time to fully identify IP ranges and set up firewalls, and if you're in early stages of proof-of-concept testing and investigation and using sample data, you might want to defer network access controls until you actually need them.
4444

45-
+ Some workflows require access to a public endpoint. Specifically, the [Import and vectorize data wizard](search-get-started-portal-import-vectors.md) in the Azure portal currently connects to embedding models over the public endpoint, and the response from the embedding model is returned over the public endpoint. You can switch to code or script to complete the same tasks, but if you want to try the wizard, the public endpoint must be available.
45+
+ Some workflows require access to a public endpoint. Specifically, the import wizards in the Azure portal, such as the [Import data wizard](search-get-started-portal.md) and [Import and vectorize data wizard](search-get-started-portal-import-vectors.md), connect to built-in (hosted) sample data and embedding models over the public endpoint. You can switch to code or script to complete the same tasks with firewall rules in place, but if you want to run the wizards, the public endpoint must be available.
4646

4747
<a id="configure-ip-policy"></a>
4848

@@ -147,9 +147,17 @@ Once your Azure resource has a managed identity, [assign roles on Azure AI Searc
147147

148148
The trusted services are used for vectorization workloads: generating vectors from text and image content, and sending payloads back to the search service for query execution or indexing. Connections from a trusted service are used to deliver payloads to Azure AI search.
149149

150-
+ To load a search index with vectors generated by an embedding model, assign **Search Index Data Contributor**.
150+
1. [Find your search service](https://portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.Search%2FsearchServices).
151+
1. On the leftmost pane, under **Access control (IAM)**, select **Identity**.
152+
1. Select **Add** and then select **Add role assignment**.
153+
1. On the **Roles** page:
151154

152-
+ To provide queries with a vector generated by an embedding model, assign **Search Index Data Reader**. The embedding used in a query isn't written to an index, so no write permissions are required.
155+
+ Select **Search Index Data Contributor** to load a search index with vectors generated by an embedding model. Choose this role if you intend to use integrated vectorization during indexing.
156+
+ Or, select **Search Index Data Reader** to provide queries with a vector generated by an embedding model. The embedding used in a query isn't written to an index, so no write permissions are required.
157+
158+
1. Select **Next**.
159+
1. On the **Members** page, select **Managed identity** and **Select members**.
160+
1. Filter by system-managed identity and then select the managed identity of your Azure AI multiservice account.
153161

154162
> [!NOTE]
155163
> This article covers the trusted exception for admitting requests to your search service, but Azure AI Search is itself on the trusted services list of other Azure resources. Specifically, you can use the trusted service exception for [connections from Azure AI Search to Azure Storage](search-indexer-howto-access-trusted-service-exception.md).

articles/search/vector-search-how-to-configure-compression-storage.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ author: heidisteen
77
ms.author: heidist
88
ms.service: cognitive-search
99
ms.topic: how-to
10-
ms.date: 06/19/2024
10+
ms.date: 06/28/2024
1111
---
1212

1313
# Configure vector quantization and reduced storage for smaller vectors in Azure AI Search
1414

1515
> [!IMPORTANT]
16-
> These features are in public preview under [Supplemental Terms of Use](https://azure.microsoft.com/support/legal/preview-supplemental-terms/). The [2024-03-01-Preview REST API](/rest/api/searchservice/operation-groups?view=rest-searchservice-2024-03-01-preview&preserve-view=true) and later preview APIs provide the new data types, vector compression properties, and the `stored` property.
16+
> These features are in public preview under [Supplemental Terms of Use](https://azure.microsoft.com/support/legal/preview-supplemental-terms/). The [2024-03-01-preview REST API](/rest/api/searchservice/operation-groups?view=rest-searchservice-2024-03-01-preview&preserve-view=true) and later preview APIs provide the new data types, vector compression properties, and the `stored` property. We recommend using the lates preview APIs.
1717
1818
This article describes vector quantization and other techniques for compressing vector indexes in Azure AI Search.
1919

@@ -161,14 +161,16 @@ Using preview APIs, you can assign narrow primitive data types to reduce the sto
161161
162162
## Option 3: Set the `stored` property to remove retrievable storage
163163

164-
The `stored` property is a new boolean on a vector field definition that determines whether storage is allocated for retrievable vector field content. If you don't need vector content in a query response, you can save up to 50 percent storage per field by setting `stored` to false.
164+
The `stored` property is a new boolean on a vector field definition that determines whether storage is allocated for retrievable vector field content. The `stored` property is set to true by default. If you don't need vector content in a query response, you can save up to 50 percent storage per field by setting `stored` to false.
165165

166-
Because vectors aren't human readable, they're typically omitted in a query response that's rendered on a search page. However, if you're using vectors in downstream processing, such as passing query results to a model or process that consumes vector content, you should keep `stored` set to true and choose a different technique for minimizing vector size.
166+
When considering whether to set this property, consider whether you need vectors in the response. Because vectors aren't human readable, they're typically omitted in a query response that's rendered on a search page. However, if you're using vectors in downstream processing, such as passing query results to a model or process that consumes vector content, you should keep `stored` set to true and choose a different technique for minimizing vector size.
167+
168+
Another consideration is that `stored` settings are irreversible. It's set during index creation on vector fields when physical data structures are created. If you want retrievable content later, you must drop and rebuild the index, or create and load a new field that has the new attribution.
167169

168170
The following example shows the fields collection of a search index. Set `stored` to false to permanently remove retrievable storage for the vector field.
169171

170172
```http
171-
PUT https://[service-name].search.windows.net/indexes/[index-name]?api-version=2024-03-01-preview 
173+
PUT https://[service-name].search.windows.net/indexes/[index-name]?api-version=2024-05-01-preview 
172174
  Content-Type: application/json 
173175
  api-key: [admin key] 
174176
@@ -389,7 +391,7 @@ On the query, you can override the oversampling default value. For example, if `
389391
You can set the oversampling parameter even if the index doesn't explicitly have a `rerankWithOriginalVectors` or `defaultOversampling` definition. Providing `oversampling` at query time overrides the index settings for that query and executes the query with an effective `rerankWithOriginalVectors` as true.
390392

391393
```http
392-
POST https://[service-name].search.windows.net/indexes/[index-name]/docs/search?api-version=2024-03-01-Preview  
394+
POST https://[service-name].search.windows.net/indexes/[index-name]/docs/search?api-version=2024-05-01-Preview  
393395
  Content-Type: application/json  
394396
  api-key: [admin key]  
395397

0 commit comments

Comments
 (0)