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 seletivamente re-ingeridos 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 do URI

Name	Em	Obrigatório	Tipo	Descrição
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 utilizar para esta operação.
overwrite	query		boolean	Se false, chaves ou ids serão anexadas às existentes. Se verdadeiro, apenas as chaves ou ids nesta carga serão enfileirados para serem novamente ingeridos.

Cabeçalho do Pedido

Name	Obrigatório	Tipo	Descrição
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 do Pedido

Name	Tipo	Descrição
datasourceDocumentIds	string[]	identificadores de documento da fonte de dados a serem redefinidos
documentKeys	string[]	chaves de documento a serem redefinidas

Respostas

Name	Tipo	Descrição
204 No Content		Não há conteúdo para enviar para esta 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
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Âmbitos

Name	Descrição
https://search.azure.com/.default

Exemplos

SearchServiceResetDocs

Pedido de amostra

HTTP

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


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

Resposta da amostra

Código de estado:

204

Definições

Name	Descrição
Accept	O cabeçalho Aceitar.
DocumentKeysOrIds	O tipo das teclas ou dos.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar 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	Descrição
application/json;odata.metadata=minimal

DocumentKeysOrIds

Object

O tipo das teclas ou dos.

Name	Tipo	Descrição
datasourceDocumentIds	string[]	identificadores de documento da fonte de dados a serem redefinidos
documentKeys	string[]	chaves de documento a serem redefinidas

ErrorAdditionalInfo

Object

Informações adicionais sobre o erro de gestão de recursos.

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

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Descrição
additionalInfo	ErrorAdditionalInfo[]	As 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

Object

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

Name	Tipo	Descrição
error	ErrorDetail	O objeto de erro.