You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/search/search-how-to-create-search-index.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,14 +2,12 @@
2
2
title: Create an index
3
3
titleSuffix: Azure AI Search
4
4
description: Create a search index using the Azure portal, REST APIs, or an Azure SDK.
5
-
6
5
manager: nitinme
7
6
author: HeidiSteen
8
7
ms.author: heidist
9
-
10
8
ms.service: azure-ai-search
11
9
ms.topic: how-to
12
-
ms.date: 07/01/2024
10
+
ms.date: 10/20/2024
13
11
---
14
12
15
13
# Create an index in Azure AI Search
@@ -20,7 +18,7 @@ In this article, learn the steps for defining a schema for a [**search index**](
20
18
21
19
+ Write permissions as a [**Search Service Contributor**](search-security-rbac.md) or an [admin API key](search-security-api-keys.md) for key-based authentication.
22
20
23
-
+ An understanding of the data you want to index. A search index is based on external content that you want to make searchable. Searchable content is stored as fields in an index. You should have a clear idea of which source fields you want to make searchable, retrievable, filterable, facetable, and sortable (see the [schema checklist](#schema-checklist) for guidance).
21
+
+ An understanding of the data you want to index. A search index is based on external content that you want to make searchable. Searchable content is stored as fields in an index. You should have a clear idea of which source fields you want to make searchable, retrievable, filterable, facetable, and sortable. See the [schema checklist](#schema-checklist) for guidance.
24
22
25
23
+ You must also have a unique field in source data that can be used as the [document key (or ID)](#document-keys) in the index.
26
24
@@ -46,7 +44,7 @@ Use this checklist to assist the design decisions for your search index.
46
44
47
45
1. Review [supported data types](/rest/api/searchservice/supported-data-types). The data type affects how the field is used. For example, numeric content is filterable but not full text searchable. The most common data type is `Edm.String` for searchable text, which is tokenized and queried using the full text search engine. The most common data type for a vector field is `Edm.Single` but you can use other types as well.
48
46
49
-
1. Identify a [document key](#document-keys). A document key is an index requirement. It's a single string field and it's populated from a source data field that contains unique values. For example, if you're indexing from Blob Storage, the metadata storage path is often used as the document key because it uniquely identifies each blob in the container.
47
+
1. Identify a [document key](#document-keys). A document key is an index requirement. It's a single string field populated from a source data field that contains unique values. For example, if you're indexing from Blob Storage, the metadata storage path is often used as the document key because it uniquely identifies each blob in the container.
50
48
51
49
1. Identify the fields in your data source that contribute searchable content in the index.
52
50
@@ -93,16 +91,18 @@ Index design through the portal enforces requirements and schema rules for speci
93
91
94
92
1. Check for space. Search services are subject to [maximum number of indexes](search-limits-quotas-capacity.md), varying by service tier. Make sure you have room for a second index.
95
93
96
-
1. In the search service Overview page, choose either option for creating a search index:
94
+
1. In the search service **Overview** page, choose either option for creating a search index:
97
95
98
96
+**Add index**, an embedded editor for specifying an index schema
The wizard is an end-to-end workflow that creates an indexer, a data source, and a finished index. It also loads the data. If this is more than what you want, use **Add index** instead.
102
100
103
-
The following screenshot highlights where **Add index** and **Import data** appear on the command bar. After an index is created, you can find it again in the **Indexes** tab.
101
+
The following screenshot highlights where **Add index**, **Import data**, and **Import and vectorize data** appear on the command bar.
102
+
103
+
:::image type="content" source="media/search-what-is-an-index/add-index.png" alt-text="Screenshot of the options to add an index." border="true":::
104
104
105
-
:::image type="content" source="media/search-what-is-an-index/add-index.png" alt-text="Add index command" border="true":::
105
+
After an index is created, you can find it again on the **Indexes** page from the left navigation pane.
106
106
107
107
> [!TIP]
108
108
> After creating an index in the portal, you can copy the JSON representation and add it to your application code.
Copy file name to clipboardExpand all lines: articles/search/search-import-data-portal.md
+10-4Lines changed: 10 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,13 +31,19 @@ This article isn't a step by step. For help with using the wizard with built-in
31
31
32
32
## Starting the wizards
33
33
34
-
In the [Azure portal](https://portal.azure.com), open the search service page from the dashboard or [find your service](https://portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.Search%2FsearchServices) in the service list.
34
+
1.In the [Azure portal](https://portal.azure.com), open the search service page from the dashboard or [find your service](https://portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.Search%2FsearchServices) in the service list.
35
35
36
-
In the service Overview page at the top, select **Import data** or **Import and vectorize data**.
36
+
1.In the service Overview page at the top, select **Import data** or **Import and vectorize data**.
37
37
38
-
:::image type="content" source="media/search-import-data-portal/import-data-cmd.png" alt-text="Screenshot of the import wizard options on the action bar.":::
38
+
:::image type="content" source="media/search-what-is-an-index/add-index.png" alt-text="Screenshot of the add index options." border="true":::
39
39
40
-
The wizards open fully expanded in the browser window so that you have more room to work.
40
+
The wizards open fully expanded in the browser window so that you have more room to work.
41
+
42
+
1. If you selected **Import data**, you can select the **Samples** option to use a prebuilt sample of data from a supported data source.
43
+
44
+
:::image type="content" source="media/search-what-is-an-index/add-index-import-samples.png" alt-text="Screenshot of the import data page with the samples option selected." border="true":::
45
+
46
+
1. Follow the remaining steps in the wizard to create the index and indexer.
41
47
42
48
You can also launch **Import data** from other Azure services, including Azure Cosmos DB, Azure SQL Database, SQL Managed Instance, and Azure Blob Storage. Look for **Add Azure AI Search** in the left-navigation pane on the service overview page.
Copy file name to clipboardExpand all lines: articles/search/semantic-how-to-configure.md
+16-21Lines changed: 16 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,14 @@
2
2
title: Configure semantic ranker
3
3
titleSuffix: Azure AI Search
4
4
description: Add a semantic configuration to a search index.
5
-
6
5
manager: nitinme
7
6
author: HeidiSteen
8
7
ms.author: heidist
9
8
ms.service: azure-ai-search
10
9
ms.custom:
11
10
- ignite-2023
12
11
ms.topic: how-to
13
-
ms.date: 09/24/2024
12
+
ms.date: 10/20/2024
14
13
---
15
14
16
15
# Configure semantic ranker and return captions in search results
@@ -29,7 +28,7 @@ This article explains how to configure a search index for semantic reranking.
29
28
30
29
## Choose a client
31
30
32
-
You can use any of the following tools and SDKs to add a semantic configuration:
31
+
You can use any of the following tools and software development kits (SDKs) to add a semantic configuration:
33
32
34
33
+[Azure portal](https://portal.azure.com), using the index designer to add a semantic configuration.
35
34
+[Visual Studio Code](https://code.visualstudio.com/download) with the [REST client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client)
@@ -61,15 +60,18 @@ Across all semantic configuration properties, the fields you assign must be:
61
60
62
61
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to a search service that has [semantic ranking enabled](semantic-how-to-enable-disable.md).
63
62
64
-
1. From **Indexes** on the left-navigation pane, open an index.
63
+
1. From **Indexes** on the left-navigation pane, select an index.
64
+
65
+
1. Select **Semantic configurations** and then select **Add semantic configuration**.
65
66
66
-
1. Select **Semantic Configurations** and then select **Add Semantic Configuration**.
67
+
:::image type="content" source="./media/semantic-search-overview/add-semantic-config.png" alt-text="Screenshot that shows the option to add a semantic configuration in the Azure portal." lightbox="./media/semantic-search-overview/add-semantic-config.png" border="true":::
67
68
68
-
The **New Semantic Configuration** page opens with options for selecting a title field, content fields, and keyword fields. Only searchable and retrievable string fields are eligible. Make sure to list content fields and keyword fields in priority order.
69
+
1. On the **New semantic configuration** page, enter a semantic configuration name and select the fields to use in the semantic configuration. Only searchable and retrievable string fields are eligible. Make sure to list content fields and keyword fields in priority order.
69
70
70
71
:::image type="content" source="./media/semantic-search-overview/create-semantic-config.png" alt-text="Screenshot that shows how to create a semantic configuration in the Azure portal." lightbox="./media/semantic-search-overview/create-semantic-config.png" border="true":::
71
72
72
-
Select **OK** to save the changes.
73
+
1. Select **Save** to save the configuration settings.
74
+
1. Select **Save** again on the index page to save the semantic configuration in the index.
73
75
74
76
### [**REST API**](#tab/rest)
75
77
@@ -163,27 +165,20 @@ If your semantic ranking code is using preview APIs, this section explains how t
163
165
+[Azure SDK for Java (11.6) change log](https://github.com/Azure/azure-sdk-for-java/blob/azure-search-documents_11.6.1/sdk/search/azure-search-documents/CHANGELOG.md#1160-2023-11-13)
164
166
+[Azure SDK for JavaScript (12.0) change log](https://github.com/Azure/azure-sdk-for-js/blob/%40azure/search-documents_12.0.0/sdk/search/search-documents/CHANGELOG.md#1200-2023-11-13)
165
167
166
-
**Behavior changes:**
167
-
168
-
+ As of July 14, 2023, semantic ranker is language agnostic. It can rerank results composed of multilingual content, with no bias towards a specific language. In preview versions, semantic ranking would deprioritize results differing from the language specified by the field analyzer.
169
-
170
-
+ In 2021-04-30-Preview and all later versions, for the REST API and all SDK packages targeting the same version: `semanticConfiguration` (in an index definition) defines which search fields are used in semantic ranking. Previously in the 2020-06-30-Preview REST API, `searchFields` (in a query request) was used for field specification and prioritization. This approach only worked in 2020-06-30-Preview and is obsolete in all other versions.
171
-
172
-
### Step 1: Remove queryLanguage
173
168
174
-
The semantic ranking engine is now language agnostic. If `queryLanguage` is specified in your query logic, it's no longer used for semantic ranking, but still applies to [spell correction](speller-how-to-add.md).
169
+
### queryLanguagefor semantic ranker
175
170
176
-
Keep `queryLanguage` if you're using speller, and if the language value is [supported by speller](speller-how-to-add.md#supported-languages). Spell check has limited availability across languages.
171
+
As of July 14, 2023, semantic ranker is language agnostic. It can rerank results composed of multilingual content, with no bias towards a specific language. In preview versions, semantic ranking would deprioritize results differing from the language specified by the field analyzer.
177
172
178
-
Otherwise, delete`queryLanguage`.
173
+
Stop using`queryLanguage` in your code if you were using it for semantic ranking. The `queryLanguage` property is still applicable to features such as [spell correction](speller-how-to-add.md), but not to semantic ranking.
179
174
180
-
### Step 2: Replace `searchFields` with `semanticConfiguration`
175
+
### searchFields for semantic ranker
181
176
182
-
If your code calls the 2020-06-30-Preview REST API or beta SDK packages targeting that REST API version, you might be using `searchFields` in a query request to specify semantic fields and priorities. In initial beta versions, `searchFields` had a dual purpose, constraining the initial query to the fields listed in `searchFields`, and also setting field priority if semantic ranking was used. In later versions, `searchFields` retains its original purpose, but is no longer used for semantic ranking.
177
+
For the REST API and all SDK packages targeting version`2021-04-30-Preview`and later, the `searchFields` property is no longer used for semantic ranking.
183
178
184
-
Keep `searchFields`in query requests if you're using it to limit full text search to the list of named fields.
179
+
Instead, use the `semanticConfiguration` property (in a search index) to determine which search fields are used in semantic ranking. To specify field prioritization, add a `semanticConfiguration`to in an index schema following the [instructions in this article](#add-a-semantic-configuration).
185
180
186
-
Add a `semanticConfiguration` to an index schema to specify field prioritization, following the [instructions in this article](#add-a-semantic-configuration).
181
+
You can keep `searchFields` in query requests if you're using it to limit full text search to the list of named fields.
Copy file name to clipboardExpand all lines: articles/search/semantic-how-to-enable-disable.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ ms.date: 09/24/2024
15
15
16
16
# Enable or disable semantic ranker
17
17
18
-
Semantic ranker is a premium feature that's billed by usage. By default, semantic ranker is turned off on a new search service, but it can be enabled by anyone with **Contributor** permissions. If you don't want anyone enabling it inadvertently, you can [disable it using the REST API](#disable-semantic-ranker-using-the-rest-api).
18
+
Semantic ranker is a premium feature billed by usage. By default, semantic ranker is turned off on a new search service, but it can be enabled by anyone with **Contributor** permissions. If you don't want anyone enabling it inadvertently, you can [disable it using the REST API](#disable-semantic-ranker-using-the-rest-api).
19
19
20
20
## Check availability
21
21
@@ -31,13 +31,13 @@ Follow these steps to enable [semantic ranker](semantic-search-overview.md) at t
31
31
32
32
1. Navigate to your search service. On the **Overview** page, make sure the service is a billable tier, Basic or higher.
33
33
34
-
1. On the left-nav pane, select **Settings** > **Semantic ranking**.
34
+
1. On the left-navigation pane, select **Settings** > **Semantic ranker**.
35
35
36
36
1. Select either the **Free plan** or the **Standard plan**. You can switch between the free plan and the standard plan at any time.
37
37
38
38
:::image type="content" source="media/semantic-search-overview/semantic-search-billing.png" alt-text="Screenshot of enabling semantic ranking in the Azure portal." border="true":::
39
39
40
-
The free plan is capped at 1,000 queries per month. After the first 1,000 queries in the free plan, an error message indicates you've exhausted your quota on the next semantic query. When quota is exhausted, you should upgrade to the standard plan to continue using semantic ranking.
40
+
The free plan is capped at 1,000 queries per month. After the first 1,000 queries in the free plan, an error message indicates you exhausted your quota on the next semantic query. When quota is exhausted, you should upgrade to the standard plan to continue using semantic ranking.
0 commit comments