Indexers - Reset Docs

Сбрасывает определенные документы в источнике данных для выборочного повторного приема индексатором.

POST {endpoint}/indexers('{indexerName}')/search.resetdocs?api-version=2023-10-01-Preview
POST {endpoint}/indexers('{indexerName}')/search.resetdocs?overwrite={overwrite}&api-version=2023-10-01-Preview

Параметры URI

Имя В Обязательно Тип Описание
endpoint
path True

string

URL-адрес конечной точки службы поиска.

indexerName
path True

string

Имя индексатора для сброса документов.

api-version
query True

string

Версия клиентского API.

overwrite
query

boolean

Если значение false, ключи или идентификаторы будут добавлены к существующим. Если задано значение true, для повторного приема будут помещены только ключи или идентификаторы в этой полезные данные.

Заголовок запроса

Имя Обязательно Тип Описание
x-ms-client-request-id

string (uuid)

Идентификатор отслеживания, отправляемый запросом на отладку.

Текст запроса

Имя Тип Описание
datasourceDocumentIds

string[]

Идентификаторы документа источника данных для сброса

documentKeys

string[]

Ключи документов для сброса

Ответы

Имя Тип Описание
204 No Content
Other Status Codes

SearchError

Ответ на ошибку.

Примеры

SearchServiceResetDocs

Образец запроса

POST https://myservice.search.windows.net/indexers('myindexer')/search.resetdocs?overwrite=False&api-version=2023-10-01-Preview

{
  "documentKeys": [
    "documentKey1",
    "documentKey2"
  ]
}

Пример ответа

Определения

SearchError

Описывает условие ошибки для API.

Имя Тип Описание
code

string

Один из определяемых сервером кодов ошибок.

details

SearchError[]

Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.

message

string

Читаемое пользователем представление ошибки.