Skip to content

Commit 3f38133

Browse files
Merge pull request #910 from HeidiSteen/heidist-fresh
[azure search} Update vector wizard docs to include current field mapping feature
2 parents 6eadfc0 + 200cc94 commit 3f38133

File tree

2 files changed

+68
-17
lines changed

2 files changed

+68
-17
lines changed

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

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author: HeidiSteen
77
ms.author: heidist
88
ms.service: azure-ai-search
99
ms.topic: quickstart
10-
ms.date: 08/05/2024
10+
ms.date: 10/18/2024
1111
ms.custom:
1212
- references_regions
1313
---
@@ -112,6 +112,29 @@ The inclusion of plain text in the `chunk` field is useful if you want to use re
112112

113113
1. Select **Next**.
114114

115+
## Map new fields
116+
117+
On the **Advanced settings** page, you can optionally add new fields. By default, the wizard generates the following fields with these attributes:
118+
119+
| Field | Applies to | Description |
120+
|-------|------------|-------------|
121+
| chunk_id | Text and image vectors | Generated string field. Searchable, retrievable, sortable. This is the document key for the index. |
122+
| text_parent_id | Image vectors | Generated string field. Retrievable, filterable. Identifies the parent document from which the chunk originates. |
123+
| image_parent_id | Image vectors | Generated string field. Retrievable, filterable. Identifies the parent document from which the image originates. |
124+
| chunk | Text and image vectors | String field. Human readable version of the data chunk. Searchable and retrievable, but not filterable, facetable, or sortable. |
125+
| title | Text and image vectors | String field. Human readable document title or page title or page number. Searchable and retrievable, but not filterable, facetable, or sortable. |
126+
| image_vector | Image vectors | Collection(Edm.single). Vector representation of the image. Searchable and retrievable, but not filterable, facetable, or sortable.|
127+
128+
You can't modify the generated fields or their attributes, but you can add new fields if your data source provides them. For example, Azure Blob Storage provides a collection of metadata fields.
129+
130+
1. Select **Add new**.
131+
132+
1. Choose a source field from the list of available fields, provide a field name for the index, and accept the default data type or override as needed.
133+
134+
Metadata fields are searchable, but not retrievable, filterable, facetable, or sortable.
135+
136+
1. Select **Reset** if you want to restore the schema to its original version.
137+
115138
## Schedule indexing
116139

117140
1. On the **Advanced settings** page, under **Schedule indexing**, specify a [run schedule](search-howto-schedule-indexers.md) for the indexer. We recommend **Once** for this exercise. For data sources where the underlying data is volatile, you can schedule indexing to pick up the changes.
@@ -132,7 +155,7 @@ When the wizard completes the configuration, it creates the following objects:
132155

133156
+ An indexer that drives the indexing pipeline.
134157

135-
+ A data source connection to Blob Storage.
158+
+ A data source connection to Azure Blob Storage.
136159

137160
+ An index with vector fields, text fields, vectorizers, vector profiles, and vector algorithms. You can't modify the default index during the wizard workflow. Indexes conform to the [2024-05-01-preview REST API](/rest/api/searchservice/indexes/create-or-update?view=rest-searchservice-2024-05-01-preview&preserve-view=true) so that you can use preview features.
138161

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

Lines changed: 43 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.service: azure-ai-search
88
ms.custom:
99
- build-2024
1010
ms.topic: quickstart
11-
ms.date: 10/17/2024
11+
ms.date: 10/18/2024
1212
---
1313

1414
# Quickstart: Vectorize text and images by using the Azure portal
@@ -17,15 +17,19 @@ This quickstart helps you get started with [integrated vectorization](vector-sea
1717

1818
Key points about the wizard:
1919

20-
+ Source data is either Azure Blob Storage, Azure Data Lake Storage (ADLS) Gen2, or OneLake files and shortcuts.
21-
+ Document parsing mode is the default (one search document per blob or file).
22-
+ Index schema is nonconfigurable. It provides vector and nonvector fields for chunked data.
20+
+ Supported data sources are Azure Blob Storage, Azure Data Lake Storage (ADLS) Gen2, or OneLake files and shortcuts.
21+
+ Supported embedding models are hosted on Azure OpenAI, Azure AI Studio model catalog, Azure AI Vision multimodal.
22+
+ Index schema provides vector and nonvector fields for chunked data.
23+
+ You can add fields, but you can't delete or modify generated fields.
24+
+ Document parsing mode creates chunks (one search document per chunk).
2325
+ Chunking is nonconfigurable. The effective settings are:
2426

2527
```json
26-
textSplitMode: "pages",
27-
maximumPageLength: 2000,
28-
pageOverlapLength: 500
28+
"textSplitMode": "pages",
29+
"maximumPageLength": 2000,
30+
"pageOverlapLength": 500,
31+
"maximumPagesToTake": 0, #unlimited
32+
"unit": "characters",
2933
```
3034

3135
## Prerequisites
@@ -78,7 +82,7 @@ For more secure connections:
7882
7983
### Check for space
8084

81-
If you're starting with the free service, you're limited to 3 indexes, data sources, skillsets, and indexers. Basic limits you to 15. Make sure you have room for extra items before you begin. This quickstart creates one of each object.
85+
If you're starting with the free service, you're limited to three indexes, data sources, skillsets, and indexers. Basic limits you to 15. Make sure you have room for extra items before you begin. This quickstart creates one of each object.
8286

8387
### Check for semantic ranker
8488

@@ -88,7 +92,7 @@ The wizard supports semantic ranking, but only on the Basic tier and higher, and
8892

8993
This section points you to data that works for this quickstart.
9094

91-
### [Azure Blob storage](#tab/sample-data-storage)
95+
### [Azure Blob Storage](#tab/sample-data-storage)
9296

9397
1. Sign in to the [Azure portal](https://portal.azure.com/) with your Azure account, and go to your Azure Storage account.
9498

@@ -228,7 +232,7 @@ The wizard supports Azure, Cohere, and Facebook embedding models in the Azure AI
228232

229233
The next step is to connect to a data source to use for the search index.
230234

231-
### [Azure Blob storage](#tab/connect-data-storage)
235+
### [Azure Blob Storage](#tab/connect-data-storage)
232236

233237
1. On the **Set up your data connection** page, select **Azure Blob Storage**.
234238

@@ -351,17 +355,41 @@ Azure AI Search and your Azure AI resource must be in the same region.
351355

352356
1. Select **Next**.
353357

354-
## Choose advanced settings
358+
## Add semantic ranking
355359

356-
1. On the **Advanced settings** page, you can optionally add [semantic ranking](semantic-search-overview.md) to rerank results at the end of query execution. Reranking promotes the most semantically relevant matches to the top.
360+
On the **Advanced settings** page, you can optionally add [semantic ranking](semantic-search-overview.md) to rerank results at the end of query execution. Reranking promotes the most semantically relevant matches to the top.
357361

358-
1. Optionally, specify a [run schedule](search-howto-schedule-indexers.md) for the indexer.
362+
## Map new fields
359363

360-
1. Select **Next**.
364+
On the **Advanced settings** page, you can optionally add new fields. By default, the wizard generates the following fields with these attributes:
365+
366+
| Field | Applies to | Description |
367+
|-------|------------|-------------|
368+
| chunk_id | Text and image vectors | Generated string field. Searchable, retrievable, sortable. This is the document key for the index. |
369+
| parent_id | Text vectors | Generated string field. Retrievable, filterable. Identifies the parent document from which the chunk originates. |
370+
| chunk | Text and image vectors | String field. Human readable version of the data chunk. Searchable and retrievable, but not filterable, facetable, or sortable. |
371+
| title | Text and image vectors | String field. Human readable document title or page title or page number. Searchable and retrievable, but not filterable, facetable, or sortable. |
372+
| text_vector | Text vectors | Collection(Edm.single). Vector representation of the chunk. Searchable and retrievable, but not filterable, facetable, or sortable.|
373+
374+
You can't modify the generated fields or their attributes, but you can add new fields if your data source provides them. For example, Azure Blob Storage provides a collection of metadata fields.
375+
376+
1. Select **Add new**.
377+
378+
1. Choose a source field from the list of available fields, provide a field name for the index, and accept the default data type or override as needed.
379+
380+
Metadata fields are searchable, but not retrievable, filterable, facetable, or sortable.
381+
382+
1. Select **Reset** if you want to restore the schema to its original version.
383+
384+
## Schedule indexing
385+
386+
On the **Advanced settings** page, you can optionally specify a [run schedule](search-howto-schedule-indexers.md) for the indexer.
387+
388+
1. Select **Next** when you're done with the **Advanced settings** page.
361389

362390
## Finish the wizard
363391

364-
1. On the **Review your configuration** page, specify a prefix for the objects that the wizard will create. A common prefix helps you stay organized.
392+
1. On the **Review your configuration** page, specify a prefix for the objects that the wizard creates. A common prefix helps you stay organized.
365393

366394
1. Select **Create**.
367395

0 commit comments

Comments
 (0)