Indexers - Reset Docs

Serviço:: Search Service

Versão da API:: 2026-05-01-preview

Redefine documentos específicos na fonte de dados para serem re-ingeridos seletivamente pelo indexador.

POST {endpoint}/indexers('{indexerName}')/search.resetdocs?api-version=2026-05-01-preview

Com parâmetros opcionais:

POST {endpoint}/indexers('{indexerName}')/search.resetdocs?api-version=2026-05-01-preview&overwrite={overwrite}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (uri)	A URL do ponto de extremidade do serviço de pesquisa.
indexerName	path	True	string	O nome do indexador.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
overwrite	query		boolean	Se for falso, as chaves ou ids serão anexadas às existentes. Se true, somente as chaves ou ids nessa carga serão enfileiradas para serem ingeridas novamente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Accept		Accept	O cabeçalho Aceitar.
x-ms-client-request-id		string (uuid)	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Corpo da solicitação

Nome	Tipo	Description
datasourceDocumentIds	string[]	Identificadores de documento de fonte de dados a serem redefinidos
documentKeys	string[]	chaves de documento a serem redefinidas

Respostas

Nome	Tipo	Description
204 No Content		Não há conteúdo a ser enviado para essa solicitação, mas os cabeçalhos podem ser úteis.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Escopos

Nome	Description
https://search.azure.com/.default

Exemplos

SearchServiceResetDocs

Solicitação de exemplo

HTTP

POST https://previewexampleservice.search.windows.net/indexers('myindexer')/search.resetdocs?api-version=2026-05-01-preview&overwrite=True


{
  "documentKeys": [
    "1",
    "2",
    "3"
  ]
}

Resposta de exemplo

Código de status:: 204

Definições

Nome	Description
Accept	O cabeçalho Aceitar.
DocumentKeysOrIds	O tipo das chaves ou dos Ides.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).

Accept

Enumeração

O cabeçalho Aceitar.

Valor	Description
application/json;odata.metadata=minimal

DocumentKeysOrIds

Objeto

O tipo das chaves ou dos Ides.

Nome	Tipo	Description
datasourceDocumentIds	string[]	Identificadores de documento de fonte de dados a serem redefinidos
documentKeys	string[]	chaves de documento a serem redefinidas

ErrorAdditionalInfo

Objeto

Informações adicionais sobre o erro de gerenciamento de recursos.

Nome	Tipo	Description
info		As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

ErrorResponse

Objeto

Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.