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-api-preview.md
+19-17Lines changed: 19 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,16 +8,16 @@ author: brjohnstmsft
8
8
ms.author: brjohnst
9
9
ms.service: cognitive-search
10
10
ms.topic: conceptual
11
-
ms.date: 02/03/2020
11
+
ms.date: 02/11/2020
12
12
---
13
13
# Preview features in Azure Cognitive Search
14
14
15
15
This article lists features currently in preview. Features that transition from preview to general availability are removed from this list. You can check [Service Updates](https://azure.microsoft.com/updates/?product=search) or [What's New](whats-new.md) for announcements regarding general availability.
16
16
17
-
While some preview features might be available in the portal and .NET SDK, the REST API always has preview features.
17
+
While some preview features might be available in the portal and .NET SDK, the REST API always has preview features.
18
18
19
-
+ For search operations, the current preview API version is [`2019-05-06-Preview`](https://docs.microsoft.com/rest/api/searchservice/index-2019-05-06-preview)
20
-
+ For management operations, the current preview version is [`2019-10-01-Preview`](https://docs.microsoft.com/rest/api/searchmanagement/index-2019-10-01-preview)
19
+
+ For search operations, [**`2019-05-06-Preview`**](https://docs.microsoft.com/rest/api/searchservice/index-2019-05-06-preview) is the current preview version.
20
+
+ For management operations, [**`2019-10-01-Preview`**](https://docs.microsoft.com/rest/api/searchmanagement/index-2019-10-01-preview) is the current preview version.
21
21
22
22
> [!IMPORTANT]
23
23
> Preview functionality is provided without a service level agreement, and is not recommended for production workloads. For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
@@ -26,27 +26,29 @@ While some preview features might be available in the portal and .NET SDK, the R
26
26
27
27
Explore the latest enhancements to AI enrichment through the [preview Search API](https://docs.microsoft.com/rest/api/searchservice/index-2019-05-06-preview).
28
28
29
-
+[Custom Entity Lookup skill (preview)](cognitive-search-skill-custom-entity-lookup.md) is a cognitive skill that looks for text from a custom, user-defined list of words and phrases. Using this list, it labels all documents with any matching entities. The skill also supports a degree of fuzzy matching that can be applied to find matches that are similar but not quite exact.
30
-
31
-
+[PII Detection skill (preview)](cognitive-search-skill-pii-detection.md) is a cognitive skill used during indexing that extracts personally identifiable information from an input text and gives you the option to mask it from that text in various ways.
32
-
33
-
+[Incremental enrichment (preview)](cognitive-search-incremental-indexing-conceptual.md) adds caching to an enrichment pipeline, allowing you to reuse existing output if a targeted modification, such as an update to a skillset or another object, does not change the content. Caching applies only to enriched documents produced by a skillset.
34
-
35
-
+[Knowledge store (preview)](knowledge-store-concept-intro.md) is a new destination of an AI-based enrichment pipeline. The physical data structure exists in Azure Blob storage and Azure Table storage, and it is created and populated when you run an indexer that has an attached cognitive skillset. The definition of a knowledge store itself is specified within a skillset definition. Within the knowledge store definition, you control the physical structures of your data through *projection* elements that determine how data is shaped, whether data is stored in Table storage or Blob storage, and whether there are multiple views.
29
+
|||
30
+
|-|-|
31
+
|[Custom Entity Lookup skill (preview)](cognitive-search-skill-custom-entity-lookup.md)| A cognitive skill that looks for text from a custom, user-defined list of words and phrases. Using this list, it labels all documents with any matching entities. The skill also supports a degree of fuzzy matching that can be applied to find matches that are similar but not quite exact. |
32
+
|[PII Detection skill (preview)](cognitive-search-skill-pii-detection.md)| A cognitive skill used during indexing that extracts personally identifiable information from an input text and gives you the option to mask it from that text in various ways.|
33
+
|[Incremental enrichment (preview)](cognitive-search-incremental-indexing-conceptual.md)| Adds caching to an enrichment pipeline, allowing you to reuse existing output if a targeted modification, such as an update to a skillset or another object, does not change the content. Caching applies only to enriched documents produced by a skillset.|
34
+
|[Knowledge store (preview)](knowledge-store-concept-intro.md)| A new destination of an AI-based enrichment pipeline. The physical data structure exists in Azure Blob storage and Azure Table storage, and it is created and populated when you run an indexer that has an attached cognitive skillset. The definition of a knowledge store itself is specified within a skillset definition. Within the knowledge store definition, you control the physical structures of your data through *projection* elements that determine how data is shaped, whether data is stored in Table storage or Blob storage, and whether there are multiple views.|
36
35
37
36
## Indexing and query features
38
37
39
38
Indexer preview features are available in preview Search API.
40
39
41
-
+[Cosmos DB indexer](search-howto-index-cosmosdb.md) supports MongoDB API (preview), Gremlin API (preview), and Cassandra API (preview).
42
-
43
-
+[Azure Data Lake Storage Gen2 indexer (preview)](search-howto-index-azure-data-lake-storage.md)can index content and metadata from Data Lake Storage Gen2.
44
-
45
-
+[moreLikeThis query parameter (preview)](search-more-like-this.md)finds documents that are relevant to a specific document. This feature has been in earlier previews.
40
+
|||
41
+
|-|-|
42
+
|[Cosmos DB indexer](search-howto-index-cosmosdb.md)| Support for MongoDB API (preview), Gremlin API (preview), and Cassandra API (preview) API types. |
43
+
|[Azure Data Lake Storage Gen2 indexer (preview)](search-howto-index-azure-data-lake-storage.md)| Index content and metadata from Data Lake Storage Gen2.|
44
+
|[moreLikeThis query parameter (preview)](search-more-like-this.md)| Finds documents that are relevant to a specific document. This feature has been in earlier previews.|
46
45
47
46
## Management features
48
47
49
-
+[Private Endpoint support](service-create-private-endpoint.md) through [`api-version=2019-10-01-Preview`](https://docs.microsoft.com/rest/api/searchmanagement/index-2019-10-01-preview) of the Management REST API. You can create a service that has restrictions on how its endpoint is accessed.
48
+
|||
49
+
|-|-|
50
+
|[Private Endpoint support](service-create-private-endpoint.md)| You can create a virtual network with a secure client (such as a virtual machine), and then create a search service that uses Private Endpoint. |
51
+
| IP access restriction | Using [`api-version=2019-10-01-Preview`](https://docs.microsoft.com/rest/api/searchmanagement/index-2019-10-01-preview) of the Management REST API, you can create a service that has restrictions on which IP addresses are allowed access. |
You can run PowerShell cmdlets and scripts on Windows, Linux, or in [Azure Cloud Shell](https://docs.microsoft.com/azure/cloud-shell/overview) to create and configure Azure Cognitive Search. The **Az.Search** module extends Azure PowerShell] with full parity to the [Azure Cognitive Search Management REST APIs](https://docs.microsoft.com/rest/api/searchmanagement). With Azure PowerShell and **Az.Search**, you can perform the following tasks:
23
+
You can run PowerShell cmdlets and scripts on Windows, Linux, or in [Azure Cloud Shell](https://docs.microsoft.com/azure/cloud-shell/overview) to create and configure Azure Cognitive Search. The **Az.Search** module extends [Azure PowerShell](https://docs.microsoft.com/powershell/) with full parity to the [Search Management REST APIs](https://docs.microsoft.com/rest/api/searchmanagement)and the ability to perform the following tasks:
24
24
25
25
> [!div class="checklist"]
26
-
> *[List all of the search services in your subscription](#list-search-services)
27
-
> *[Get information about a specific search service](#get-search-service-information)
26
+
> *[List search services in a subscription](#list-search-services)
27
+
> *[Return service information](#get-search-service-information)
28
28
> *[Create or delete a service](#create-or-delete-a-service)
> *[Create or delete query api-keys](#create-or-delete-query-keys)
31
-
> *[Scale a service by increasing or decreasing replicas and partitions](#scale-replicas-and-partitions)
31
+
> *[Scale up or down with replicas and partitions](#scale-replicas-and-partitions)
32
32
33
-
PowerShell cannot be used to change the name, region, or tier of your service. Dedicated resources are allocated when a service is created. Changing the underlying hardware (location or node type) requires a new service. There are no tools or APIs for transferring content from one service to another. All content management is through [REST](https://docs.microsoft.com/rest/api/searchservice/) or [.NET](https://docs.microsoft.com/dotnet/api/?term=microsoft.azure.search) APIs, and if you want to move indexes, you will need to recreate and reload them on a new service.
33
+
Occasionally, questions are asked about tasks *not* on the above list. Currently, you cannot use either the **Az.Search** module or the management REST API to change a server name, region, or tier. Dedicated resources are allocated when a service is created. As such, changing the underlying hardware (location or node type) requires a new service. Similarly, there are no tools or APIs for transferring content, such as an index, from one service to another.
34
34
35
-
While there are no dedicated PowerShell commands for content management, you can write PowerShell script that calls REST or .NET to create and load indexes. The **Az.Search** module by itself does not provide these operations.
36
-
37
-
Other tasks not supported through PowerShell or any other API (portal-only) include:
38
-
+[Attach a cognitive services resource](cognitive-search-attach-cognitive-services.md) for [AI-enriched indexing](cognitive-search-concept-intro.md). A cognitive service is attached to a skillset, not a subscription or service.
39
-
+[Add-on monitoring solutions](search-monitor-usage.md#add-on-monitoring-solutions) for monitoring Azure Cognitive Search.
35
+
Within a service, content creation and management is through [Search Service REST API](https://docs.microsoft.com/rest/api/searchservice/) or [.NET SDK](https://docs.microsoft.com/dotnet/api/?term=microsoft.azure.search). While there are no dedicated PowerShell commands for content, you can write PowerShell script that calls REST or .NET APIs to create and load indexes.
## List all Azure Cognitive Search services in your subscription
87
+
## List services in a subscription
92
88
93
89
The following commands are from [**Az.Resources**](https://docs.microsoft.com/powershell/module/az.resources/?view=azps-1.4.0#resources), returning information about existing resources and services already provisioned in your subscription. If you don't know how many search services are already created, these commands return that information, saving you a trip to the portal.
0 commit comments