Skip to content

Commit 354b402

Browse files
authored
Merge pull request #66750 from HeidiSteen/heidist-master
Azure Search: Revisions to Create a basic index and Reindexing
2 parents a9a115e + e014915 commit 354b402

File tree

9 files changed

+82
-72
lines changed

9 files changed

+82
-72
lines changed

articles/search/TOC.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@
109109
href: search-dotnet-mgmt-sdk-migration.md
110110
- name: Upgrade the REST API
111111
href: search-api-migration.md
112-
- name: Designing Indexes
112+
- name: Design indexes
113113
items:
114114
- name: Create a basic index
115115
href: search-what-is-an-index.md
@@ -135,7 +135,7 @@
135135
href: search-example-adventureworks-modeling.md
136136
- name: Model multi-level facets
137137
href: search-example-adventureworks-multilevel-faceting.md
138-
- name: Indexing data
138+
- name: Load data
139139
items:
140140
- name: Data import overview
141141
href: search-what-is-data-import.md
@@ -189,7 +189,7 @@
189189
href: cognitive-search-concept-troubleshooting.md
190190
- name: Documentation links
191191
href: cognitive-search-resources-documentation.md
192-
- name: Querying data
192+
- name: Query data
193193
items:
194194
- name: Create a basic query
195195
href: search-query-overview.md
@@ -203,11 +203,11 @@
203203
href: search-query-simple-examples.md
204204
- name: Query examples (full Lucene)
205205
href: search-query-lucene-examples.md
206-
- name: Handlings results
206+
- name: Handle results
207207
items:
208208
- name: Page-related features
209209
href: search-pagination-page-layout.md
210-
- name: Filtering and sorting data
210+
- name: Filter and sort data
211211
items:
212212
- name: Filter overview
213213
href: search-filters.md
-38.8 KB
Loading
16.1 KB
Loading
16.2 KB
Loading
Binary file not shown.

articles/search/search-analyzers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ The best time to add and assign analyzers is during active development, when dro
6464

6565
As an index definition solidifies, you can append new analysis constructs to an index, but you will need to pass the **allowIndexDowntime** flag to [Update Index](https://docs.microsoft.com/rest/api/searchservice/update-index) if you want to avoid this error:
6666

67-
*Index update not allowed because it would cause downtime. In order to add new analyzers, tokenizers, token filters, or character filters to an existing index, set the 'allowIndexDowntime' query parameter to 'true' in the index update request. Note that this operation will put your index offline for at least a few seconds, causing your indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes.*
67+
*"Index update not allowed because it would cause downtime. In order to add new analyzers, tokenizers, token filters, or character filters to an existing index, set the 'allowIndexDowntime' query parameter to 'true' in the index update request. Note that this operation will put your index offline for at least a few seconds, causing your indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes."*
6868

6969
The same holds true when assigning an analyzer to a field. An analyzer is an integral part of the field's definition, so you can only add it when the field is created. If you want to add analyzers to existing fields, you'll have to [drop and rebuild](search-howto-reindex.md) the index, or add a new field with the analyzer you want.
7070

articles/search/search-create-index-portal.md

Lines changed: 18 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,61 @@
11
---
22
title: Create an Azure Search index in Azure portal - Azure Search
3-
description: Learn how to create an index for Azure Search using built-in portal index designers.
3+
description: Learn how to create an index for Azure Search using a built-in portal index designers.
44
manager: cgronlun
55
author: heidisteen
66
services: search
77
ms.service: search
88
ms.devlang: NA
99
ms.topic: conceptual
10-
ms.date: 07/10/2018
10+
ms.date: 02/16/2019
1111
ms.author: heidist
1212
ms.custom: seodec2018
1313
---
14-
# How to create an Azure Search index using the Azure portal
14+
# Create an Azure Search index in the portal
1515

1616
Azure Search includes a built-in index designer in the portal useful for prototypes or creating a [search index](search-what-is-an-index.md) hosted on your Azure Search service. The tool is used for schema construction. When you save the definition, an empty index becomes fully expressed in Azure Search. How you load it with searchable data is up to you.
1717

1818
The index designer is only one approach for creating an index. Programmatically, you can create an index using the [.NET](search-create-index-dotnet.md) or [REST](search-create-index-rest-api.md) APIs.
1919

20-
## Prerequisites
21-
22-
This article assumes an [Azure subscription](https://azure.microsoft.com/pricing/free-trial/?WT.mc_id=A261C142F) and [Azure Search service](search-create-service-portal.md).
23-
24-
## Open index designer and name an index
20+
## Start index designer
2521

2622
1. Sign in to the [Azure portal](https://portal.azure.com) and open the service dashboard. You can click **All services** in the jump bar to search for existing "search services" in the current subscription.
2723

28-
2. Click the **Add index** button in the command bar at the top of the page.
24+
2. Click the **Add index** link in the command bar at the top of the page.
25+
26+
![Add index link in the command bar](media/search-create-index-portal/add-index.png "Add index link in the command bar")
2927

3028
3. Name your Azure Search index. Index names are referenced in indexing and query operations. The index name becomes part of the endpoint URL used on connections to the index and for sending HTTP requests in the Azure Search REST API.
3129

3230
* Start with a letter.
3331
* Use only lowercase letters, digits, or dashes ("-").
3432
* Limit the name to 60 characters.
3533

36-
## Define the fields of your index
34+
## Add fields
3735

3836
Index composition includes a *Fields collection* that defines the searchable data in your index. Altogether, the fields collection specifies the structure of documents that you upload separately. A Fields collection includes required and optional fields, named and typed, with index attributes that determine how the field can be used.
3937

40-
1. In the **Add Index** blade, click **Fields >** to slide open the field definition blade.
41-
42-
2. Accept the generated *key* field of type Edm.String. By default, the field is named *id* but you can rename it as long as the string satisfies [naming rules](https://docs.microsoft.com/rest/api/searchservice/Naming-rules). A key field is mandatory for every Azure Search index and it must be a string.
43-
44-
3. Add fields to fully specify the documents you will upload. If documents consist of an *id*, *hotel name*, *address*, *city*, and *region*, create a corresponding field for each one in the index. Review the [design guidance in the section below](#design) for help in setting attributes.
45-
46-
4. Optionally, add any fields that are used internally in filter expressions. Attributes on the field can be set to exclude fields from search operations.
38+
1. Add fields to fully specify the documents you will upload, setting a [data type](https://docs.microsoft.com/rest/api/searchservice/supported-data-types) for each one. For example, if documents consist of a *hotel-id*, *hotel-name*, *address*, *city*, and *region*, create a corresponding field for each one in the index. Review the [design guidance in the section below](#design) for help with setting attributes.
4739

48-
5. When finished, click **OK** to save and create the index.
40+
2. Specify a *key* field of type Edm.String. Values for this field must uniquely identify each document. By default, the field is named *id* but you can rename it as long as the string satisfies [naming rules](https://docs.microsoft.com/rest/api/searchservice/Naming-rules). For example, if your fields collection includes *hotel-id*, you would choose that for your key. A key field is mandatory for every Azure Search index and it must be a string.
4941

50-
## Tips for adding fields
42+
3. Set attributes on each field. The index designer excludes any attributes that are invalid for the data type, but doesn't suggest what to include. Review the guidance in the next section to understand what the attributes are for.
5143

52-
Creating an index in the portal is keyboard intensive. Minimize steps by following this workflow:
44+
Azure Search API documentation includes code examples featuring a simple *hotels* index. In the screenshot below, you can see the index definition, including the French language analyzer specified during index definition, which you can recreate as a practice exercise in the portal.
5345

54-
1. First, build the field list by entering names and setting data types.
46+
![Hotels demo index](media/search-create-index-portal/field-definitions.png "Hotels demo index")
5547

56-
2. Next, use the check boxes at the top of each attribute to bulk enable the setting for all fields, and then selectively clear boxes for the few fields that don't require it. For example, string fields are typically searchable. As such, you might click **Retrievable** and **Searchable** to both return the values of the field in search results, as well as allow full text search on the field.
48+
4. When finished, click **Create** to save and create the index.
5749

5850
<a name="design"></a>
5951

60-
## Design guidance for setting attributes
52+
## Set attributes
6153

6254
Although you can add new fields at any time, existing field definitions are locked in for the lifetime of the index. For this reason, developers typically use the portal for creating simple indexes, testing ideas, or using the portal pages to look up a setting. Frequent iteration over an index design is more efficient if you follow a code-based approach so that you can rebuild the index easily.
6355

64-
Analyzers and suggesters are associated with fields before the index is saved. Be sure to click through each tabbed page to add language analyzers or suggesters to your index definition.
56+
Analyzers and suggesters are associated with fields before the index is saved. Be sure to add language analyzers or suggesters to your index definition while you are creating it.
6557

66-
String fields are often marked as **Searchable** and **Retrievable**.
67-
68-
Fields used to narrow search results include **Sortable**, **Filterable**, and **Facetable**.
58+
String fields are often marked as **Searchable** and **Retrievable**. Fields used to narrow search results include **Sortable**, **Filterable**, and **Facetable**.
6959

7060
Field attributes determine how a field is used, such as whether it is used in full text search, faceted navigation, sort operations, and so forth. The following table describes each attribute.
7161

@@ -78,19 +68,11 @@ Field attributes determine how a field is used, such as whether it is used in fu
7868
|**key**|Unique identifier for documents within the index. Exactly one field must be chosen as the key field and it must be of type `Edm.String`.|
7969
|**retrievable**|Determines whether the field can be returned in a search result. This is useful when you want to use a field (such as *profit margin*) as a filter, sorting, or scoring mechanism, but do not want the field to be visible to the end user. This attribute must be `true` for `key` fields.|
8070

81-
## Create the hotels index used in example API sections
82-
83-
Azure Search API documentation includes code examples featuring a simple *hotels* index. In the screenshots below, you can see the index definition, including the French language analyzer specified during index definition, which you can recreate as a practice exercise in the portal.
84-
85-
![](./media/search-create-index-portal/field-definitions.png)
86-
87-
![](./media/search-create-index-portal/set-analyzer.png)
88-
8971
## Next steps
9072

9173
After creating an Azure Search index, you can move to the next step: [upload searchable data into the index](search-what-is-data-import.md).
9274

93-
Alternatively, you could also take a deeper look at indexes. In addition to the Fields collection, an index also specifies analyzers, suggesters, scoring profiles, and CORS settings. The portal provides tabbed pages for defining the most common elements: Fields, analyzers, and suggesters. To create or modify other elements, you can use the REST API or .NET SDK.
75+
Alternatively, you could also take a [deeper look at indexes](search-what-is-an-index.md). In addition to the Fields collection, an index also specifies analyzers, suggesters, scoring profiles, and CORS settings. The portal provides tabbed pages for defining the most common elements: Fields, analyzers, and suggesters. To create or modify other elements, you can use the REST API or .NET SDK.
9476

9577
## See also
9678

0 commit comments

Comments
 (0)