Reset Skills (Preview REST API)
Applies to: 2023-07-01-Preview, 2021-04-30-Preview, 2020-06-30-Preview
Important
2023-07-01-Preview (no changes).
2021-04-30-Preview (no changes).
2020-06-30-Preview adds the API. It supports cached enrichments and reset scenarios.
The Reset Skills request selectively processes one or more skills on the next indexer run. For indexers that have caching enabled, you can explicitly request processing for skill updates that the indexer cannot detect. For example, if you make external changes, such as revisions to a custom skill, you can use this API to rerun the skill. Outputs, such as a knowledge store or search index, are refreshed using reusable data from the cache and new content per the updated skill.
You can reset an existing skillset using an HTTP POST, specifying the name of the skillset to update on the request URI.
POST https://[servicename].search.windows.net/skillsets/[skillset name]/resetskills?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
URI Parameters
| Parameter | Description |
|---|---|
| service name | Required. Set this to the unique, user-defined name of your search service. |
| skillset name | Required. The request URI specifies the name of the skillset to reset. |
| api-version | Required. The current preview version is 2023-07-01-Preview. See API versions for more versions. |
Request Headers
The following table describes the required and optional request headers.
| Fields | Description |
|---|---|
| Content-Type | Required. Set this to application/json |
| api-key | Optional if you're using Azure roles and a bearer token is provided on the request, otherwise a key is required. An api-key is a unique, system-generated string that authenticates the request to your search service. Reset requests must include an api-key header set to your admin key (as opposed to a query key). See Connect to Azure AI Search using key authentication for details. |
Request Body
The body of the request is an array of skill names.
{
"skillNames" : ["<SKILL-1>", "SKILL-n"]
}
Response
Status Code: 204 No Content for a successful response.