Indexers - Reset Docs

Servicio:: Search Service

Versión de la API:: 2025-11-01-preview

Restablece documentos específicos en el origen de datos para que el indexador los vuelva a ingerir de forma selectiva.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (uri)	La dirección URL del punto de conexión del servicio de búsqueda.
indexerName	path	True	string	Nombre del indizador.
api-version	query	True	string minLength: 1	Versión de API que se usará para la operación.
overwrite	query		boolean	Si es false, las claves o identificadores se agregarán a los existentes. Si es true, solo las claves o identificadores de esta carga útil se pondrán en cola para volver a ingerirlas.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Accept		Accept	El encabezado Aceptar.
x-ms-client-request-id		string (uuid)	Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Cuerpo de la solicitud

Nombre	Tipo	Description
datasourceDocumentIds	string[]	Identificadores de documentos de origen de datos que se restablecerán
documentKeys	string[]	Claves de documento a restablecer

Respuestas

Nombre	Tipo	Description
204 No Content		No hay contenido que enviar para esta solicitud, pero los encabezados pueden ser útiles.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

api-key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ámbitos

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

Ejemplos

SearchServiceResetDocs

Solicitud de ejemplo

HTTP

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


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

Respuesta de muestra

status code:: 204

Definiciones

Nombre	Description
Accept	El encabezado Aceptar.
DocumentKeysOrIds	El tipo de las teclas o los Ids.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

Accept

Enumeración

El encabezado Aceptar.

Valor	Description
application/json;odata.metadata=minimal

DocumentKeysOrIds

Objeto

El tipo de las teclas o los Ids.

Nombre	Tipo	Description
datasourceDocumentIds	string[]	Identificadores de documentos de origen de datos que se restablecerán
documentKeys	string[]	Claves de documento a restablecer

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info		Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.