Restablecer documentos (API REST de versión preliminar)
Se aplica a: 2023-07-01-Preview, 2021-04-30-Preview, 2020-06-30-Preview, 2019-05-06-Preview
Importante
2023-07-01-Preview (sin cambios).
2021-04-30-Preview (sin cambios).
2020-06-30-Preview (sin cambios).
2019-05-06-Preview agrega compatibilidad con escenarios de restablecimiento.
Restablecer documentos es una API asincrónica. Permite volver a procesar documentos de forma selectiva desde el origen de datos.
La API acepta dos tipos de identificadores de documento como entrada. Son claves de documento (claves que identifican de forma única documentos en un índice de búsqueda) y identificadores de documento de origen de datos (claves que identifican de forma única documentos en un origen de datos). Al invocar la API, se agregan las claves de documento o los identificadores de documento del origen de datos que se van a restablecer a los metadatos del indexador. En la siguiente ejecución programada o a petición del indexador, el indexador procesa solo los documentos de restablecimiento.
- En el caso de los indexadores con un conjunto de aptitudes y el enriquecimiento incremental habilitados, la API borra la memoria caché y vuelve a ejecutar el conjunto de aptitudes completo solo para los documentos especificados.
- En el caso de los indexadores sin un conjunto de aptitudes, la API lee el documento de origen del origen de datos y actualiza o inserta el contenido en el índice.
Si usa claves de documento para restablecer documentos y se hace referencia a las claves de documento en una asignación de campos del indexador, el indexador usa la asignación de campos para buscar el campo adecuado en el origen de datos subyacente.
La API funciona para todos los indexadores (con o sin un conjunto de aptitudes). Puede invocarlo mediante una solicitud HTTP POST. Si la llamada se realiza correctamente, obtendrá una respuesta 204 NoContent. Especifique el nombre del indexador que se va a actualizar en el URI de solicitud:
POST https://[service name].search.windows.net/indexers/[indexer name]/resetdocs?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Parámetros de identificador URI
| Parámetro | Descripción |
|---|---|
| nombre del servicio | Necesario. Establézcalo en el nombre único definido por el usuario del servicio de búsqueda. |
| nombre del indexador | Necesario. El URI de solicitud especifica el nombre del indexador que se va a actualizar. |
| api-version | Necesario. La versión preliminar actual es 2023-07-01-Preview. Consulte Versiones de API para obtener más versiones. |
| sobrescribir | Opcional. Este parámetro determina si las operaciones consecutivas restablecer documento se combinan o sobrescriben. El valor predeterminado es False. Cuando es false, la carga de la llamada de claves de documento o identificadores de documento de origen de datos se agrega a la lista de claves ya en cola para el reprocesamiento. Si es true, la carga de la llamada de claves de documento o identificadores de documento de origen de datos sobrescribe la lista existente, incluida la eliminación de la lista de documentos de restablecimiento si establece las claves en null. |
Encabezados de solicitud
En la siguiente tabla se describen los encabezados de solicitud obligatorios y opcionales.
| Campos | Descripción |
|---|---|
| Content-Type | Necesario. Establézcalo en application/json |
| api-key | Opcional si usa roles de Azure y se proporciona un token de portador en la solicitud; de lo contrario, se requiere una clave. Una clave de API es una cadena única generada por el sistema que autentica la solicitud en el servicio de búsqueda. Las solicitudes de restablecimiento deben incluir un api-key encabezado establecido en la clave de administrador (en lugar de una clave de consulta). Consulte Conexión a Azure AI Search mediante la autenticación de claves para más información. |
Cuerpo de la solicitud
El cuerpo debe contener una lista de claves de documento o una lista de identificadores de documento de origen de datos que el indexador busca en el origen de datos.
El siguiente JSON es una representación de alto nivel de las partes principales de la definición.
{
"documentKeys" : [
"key1",
"key2",
"key3"
],
"datasourceDocumentIds" : [
"key1",
"key2",
"key3"
],
}
La solicitud contiene las siguientes propiedades y tenga en cuenta que se debe proporcionar una y una de las "documentKeys" y "datasourceDocumentIds":
| Propiedad | Descripción |
|---|---|
| documentKeys | Este es el conjunto de claves de documento que el indexador vuelve a procesar selectivamente desde su origen de datos. De forma predeterminada, al llamar a esta acción varias veces se anexan los conjuntos de claves del documento. Este comportamiento se puede cambiar para sobrescribir en lugar de anexar a través del parámetro URI de sobrescritura (consulte anteriormente). Si desea que el indexador deje de intentar procesar el restablecimiento de documentos, puede establecer "documentKeys" en una lista vacía "[]". Esto da como resultado que el indexador reanude la indexación regular en función de la marca de agua alta. Se omiten las claves de documento o las claves de documento no válidas. |
| datasourceDocumentIds | Este es el conjunto de identificadores de documento de origen de datos que el indexador vuelve a procesar de forma selectiva desde su origen de datos. De forma predeterminada, al llamar a esta acción varias veces se anexan los identificadores de documento del origen de datos. Este comportamiento se puede cambiar para sobrescribir en lugar de anexar a través del parámetro URI de sobrescritura (consulte anteriormente). Si desea que el indexador deje de intentar procesar el restablecimiento de documentos, puede establecer "datasourceDocumentIds" en una lista vacía "[]". Esto da como resultado que el indexador reanude la indexación regular en función de la marca de agua alta. Se omiten los identificadores de documento de origen de datos no válidos o los identificadores de documento de origen de datos que no existen. |
Response
204 No hay contenido para una solicitud correcta.