Skip to content

Commit 460ed07

Browse files
authored
Merge pull request #1834 from HeidiSteen/heidist-uuf
[azure search] Demo app updates using hotels sample data
2 parents 4ec4e0b + 6855f36 commit 460ed07

File tree

8 files changed

+20
-49
lines changed

8 files changed

+20
-49
lines changed
1.85 KB
Loading
69.2 KB
Loading
75.6 KB
Loading
Binary file not shown.
-107 KB
Loading
Binary file not shown.
-73.2 KB
Loading

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

Lines changed: 20 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ Before you begin, have the following prerequisites in place:
3131

3232
+ A [search index](search-what-is-an-index.md) to use as the basis of your generated application.
3333

34-
This quickstart uses the built-in Real Estate sample data and index because it has thumbnail images (the wizard supports adding images to the results page). To create the index used in this exercise, run the **Import data** wizard, choosing the *realestate-us-sample* data source.
34+
This quickstart uses the built-in hotels sample dataset. To create the index used in this exercise, run the **Import data** wizard, choosing the *hotels-sample* source and accepting all defaults.
3535

36-
:::image type="content" source="media/search-create-app-portal/import-data-realestate.png" alt-text="data source page for sample data" border="false":::
36+
:::image type="content" source="media/search-create-app-portal/import-data-hotels.png" alt-text="Screenshot of the data source page for sample data.":::
3737

3838
When the index is ready to use, move on to the next step.
3939

@@ -43,25 +43,25 @@ When the index is ready to use, move on to the next step.
4343

4444
1. Under **Search Management** > **Indexes**
4545

46-
1. Choose *realestate-us-sample-index* from the list of existing indexes.
46+
1. Select *hotels-sample-index*.
4747

4848
1. On the index page, at the top, select **Create demo app** to start the wizard.
4949

5050
1. On the first wizard page, select **Enable Cross Origin Resource Sharing (CORS)** to add CORS support to your index definition. This step is optional, but your local web app won't connect to the remote index without it.
5151

52-
:::image type="content" source="media/search-create-app-portal/start-app-enable-cors.png" alt-text="Screenshot of the enable CORS option for the real estate sample index.":::
52+
:::image type="content" source="media/search-create-app-portal/enable-cors.png" alt-text="Screenshot of the enable CORS action.":::
5353

5454
## Configure search results
5555

56-
The wizard provides a basic layout for rendered search results that includes space for a thumbnail image, a title, and description. Backing each of these elements is a field in your index that provides the data.
56+
The wizard provides a basic layout for rendered search results that includes space for a thumbnail image, a title, and description. Backing each of these elements is a field in your index that provides the data.
5757

58-
1. In Thumbnail, choose the *thumbnail* field in the *realestate-us-sample* index. This sample happens to include image thumbnails in the form of URL-addressed images stored in a field called *thumbnail*. If your index doesn't have images, leave this field blank.
58+
1. Skip **Thumbnail** because this index doesn't have images, but if you have an index field that's populated with URLs resolving to publically available images, you should specify that field for the thumbnail area. If your index doesn't have image URLs, leave this field blank.
5959

60-
1. In Title, choose a field that conveys the uniqueness of each document. In this sample, the listing ID is a reasonable selection.
60+
1. In Title, choose a field that conveys the uniqueness of each document. In this sample, the Hotel Name is a reasonable selection.
6161

62-
1. In Description, choose a field that provides details that might help someone decide whether to drill down to that particular document.
62+
1. In Description, choose a field that provides details that might help someone decide whether to drill down to that particular document. In this sample, the Description is a good candidate.
6363

64-
:::image type="content" source="media/search-create-app-portal/configure-results.png" alt-text="configure results for sample data" border="false":::
64+
:::image type="content" source="media/search-create-app-portal/configure-results.png" lightbox="media/search-create-app-portal/configure-results.png" alt-text="Screenshot of the search results configuration page." :::
6565

6666
## Add a sidebar
6767

@@ -70,62 +70,33 @@ The search service supports faceted navigation, which is often rendered as a sid
7070
In Azure AI Search, faceted navigation is a cumulative filtering experience. Within a category, selecting multiple filters expands the results (for example, selecting Seattle and Bellevue within City). Across categories, selecting multiple filters narrows results.
7171

7272
> [!TIP]
73-
> You can view the full index schema in the portal. Look for the **Index definition (JSON)** link in each index's overview page. Fields that qualify for faceted navigation have "filterable: true" and "facetable: true" attributes.
73+
> You can view fields attributes on the **Fields** tab of the index in the Azure portal. Fields marked as filterable and facetable can be used in the sidebar
7474
75-
1. In the wizard, select the **Sidebar** tab at the top of the page. You'll see a list of all fields that are attributed as filterable and facetable in the index.
75+
1. In the wizard, select the **Sidebar** tab at the top of the page. You should see a list of all fields that are attributed as filterable and facetable in the index.
7676

77-
1. Accept the current selection of faceted fields and continue to the next page.
78-
79-
## Add typeahead
80-
81-
Typeahead functionality is available in the form of autocomplete and query suggestions. The wizard supports query suggestions. Based on keystroke inputs provided by the user, the search service returns a list of "completed" query strings that can be selected as the input.
82-
83-
Suggestions are enabled on specific field definitions. The wizard gives you options for configuring how much information is included in a suggestion.
84-
85-
The following screenshot shows options in the wizard, juxtaposed with a rendered page in the app. You can see how field selections are used, and how "Show Field Name" is used to include or exclude labeling within the suggestion.
86-
87-
:::image type="content" source="media/search-create-app-portal/suggestions.png" alt-text="Query suggestion configuration":::
77+
1. Remove some of the fields to shorten the sidebar so that you don't have scroll in the finished app.
8878

8979
## Add suggestions
9080

91-
Suggestions refer to automated query prompts that are attached to the search box. Azure AI Search supports two: *autocompletion* of a partially entered search term, and *suggestions* for a dropdown list of potential matching documents based.
92-
93-
Select fields for which suggested queries are provided. You should choose shorter string fields. Avoid verbose fields such as descriptions.
94-
95-
The wizard supports suggestions, and the fields that can provide suggested results are derived from a [`Suggesters`](index-add-suggesters.md) construct in the index:
81+
Suggestions refer to automated query prompts that are attached to the search box. The demo app supports *suggestions* that provide a dropdown list of potential matching documents based on partial text inputs.
9682

97-
```JSON
98-
"suggesters": [
99-
{
100-
"name": "sg",
101-
"searchMode": "analyzingInfixMatching",
102-
"sourceFields": [
103-
"number",
104-
"street",
105-
"city",
106-
"region",
107-
"postCode",
108-
"tags"
109-
]
110-
}
111-
]
112-
```
83+
In this page, select fields for which suggested queries are provided. You should choose shorter string fields. Avoid verbose fields such as descriptions.
11384

114-
1. In the wizard, select the **Suggestions** tab at the top of the page. You'll see a list of all fields that are designated in the index schema as suggestion providers.
85+
The following screenshot shows the suggestions page, juxtaposed with a rendered page in the app. You can see how field selections are used, and how "Show Field Name" is used to include or exclude labeling within the suggestion.
11586

116-
1. Accept the current selection and continue to the next page.
87+
:::image type="content" source="media/search-create-app-portal/suggestions.png" lightbox="media/search-create-app-portal/suggestions.png" alt-text="Screenshot of the suggestion configuration page.":::
11788

118-
## Create, download and execute
89+
## Create, download, and execute
11990

12091
1. Select **Create demo app** at the bottom of the page to generate the HTML file.
12192

12293
1. When prompted, select **Download your app** to download the file.
12394

124-
1. Open the file and select the **Search** button. This action executes a query, which can be an empty query (`*`) that returns an arbitrary result set. The page should look similar to the following screenshot. Enter a term and use filters to narrow results.
95+
1. Open the file and select the **Search** button. This action executes a query, which can be an empty query (`*`) that returns an arbitrary result set. The page should look similar to the following screenshot.
12596

126-
The underlying index is composed of fictitious, generated data that has been duplicated across documents, and descriptions sometimes don't match the image. You can expect a more cohesive experience when you create an app based on your own indexes.
97+
1. Enter a term and use filters to narrow results. If you don't see suggested queries, check browser settings or try a different browser.
12798

128-
:::image type="content" source="media/search-create-app-portal/run-app.png" alt-text="Run the app":::
99+
:::image type="content" source="media/search-create-app-portal/run-app.png" lightbox="media/search-create-app-portal/run-app.png" alt-text="Screenshot of the search application in a browser window.":::
129100

130101
## Clean up resources
131102

0 commit comments

Comments
 (0)