Documents - Index

Referencia

Servicio:: Search Service

Versión de la API:: 2023-11-01

Envía un lote de acciones de escritura de documentos al índice.

POST {endpoint}/indexes('{indexName}')/docs/search.index?api-version=2023-11-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Dirección URL del punto de conexión del servicio de búsqueda.
indexName	path	True	string	El nombre del índice.
api-version	query	True	string	Versión de api de cliente.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string uuid	Identificador de seguimiento enviado con la solicitud para ayudar con la depuración.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
value	True	IndexAction[]	Las acciones del lote.

Respuestas

Nombre	Tipo	Description
200 OK	IndexDocumentsResult	Respuesta que contiene el estado de las operaciones de todas las acciones del lote.
Other Status Codes	IndexDocumentsResult	Respuesta que contiene el estado de las operaciones de todas las acciones del lote.
Other Status Codes	SearchError	Respuesta de error.

Ejemplos

SearchIndexIndexDocuments

Solicitud de ejemplo

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.index?api-version=2023-11-01

{
  "value": [
    {
      "@search.action": "upload",
      "docId": "1",
      "title": "Fancy Stay",
      "description": "Best hotel in town"
    },
    {
      "@search.action": "merge",
      "docId": "2",
      "title": "Roach Motel"
    },
    {
      "@search.action": "mergeOrUpload",
      "docId": "3",
      "title": "Econo Motel"
    },
    {
      "@search.action": "delete",
      "docId": "4"
    }
  ]
}

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "key": "1",
      "status": true,
      "errorMessage": null,
      "statusCode": 201
    },
    {
      "key": "2",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "3",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "4",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    }
  ]
}

status code:: 207

{
  "value": [
    {
      "key": "1",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "2",
      "status": false,
      "errorMessage": "Document not found.",
      "statusCode": 404
    },
    {
      "key": "3",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "4",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    }
  ]
}

Definiciones

Nombre	Description
IndexAction	Representa una acción de índice que funciona en un documento.
IndexActionType	Operación que se va a realizar en un documento en un lote de indexación.
IndexBatch	Contiene un lote de acciones de escritura de documentos que se van a enviar al índice.
IndexDocumentsResult	Respuesta que contiene el estado de las operaciones de todos los documentos de la solicitud de indexación.
IndexingResult	Estado de una operación de indexación para un único documento.
SearchError	Describe una condición de error para la API.

IndexAction

Representa una acción de índice que funciona en un documento.

Nombre	Tipo	Description
@search.action	IndexActionType	Operación que se va a realizar en un documento en un lote de indexación.

IndexActionType

Operación que se va a realizar en un documento en un lote de indexación.

Nombre	Tipo	Description
delete	string	Quita el documento especificado del índice. Se omitirá cualquier campo que especifique en una operación de eliminación que no sea el campo de clave. Si desea quitar un campo individual de un documento, use merge en su lugar y establezca el campo explícitamente en NULL.
merge	string	Combina los valores de campo especificados con un documento existente. Si el documento no existe, se producirá un error en la combinación. Cualquier campo que se especifica en una combinación reemplazará al campo existente en el documento. Esto también se aplica a colecciones de tipos primitivos y complejos.
mergeOrUpload	string	Se comporta como combinar si ya existe un documento con la clave especificada en el índice. Si el documento no existe, se comporta como cargar con un nuevo documento.
upload	string	Inserta el documento en el índice si es nuevo y lo actualiza si existe. Todos los campos se reemplazan en el caso de actualización.

IndexBatch

Contiene un lote de acciones de escritura de documentos que se van a enviar al índice.

Nombre	Tipo	Description
value	IndexAction[]	Las acciones del lote.

IndexDocumentsResult

Respuesta que contiene el estado de las operaciones de todos los documentos de la solicitud de indexación.

Nombre	Tipo	Description
value	IndexingResult[]	Lista de información de estado para cada documento de la solicitud de indexación.

IndexingResult

Estado de una operación de indexación para un único documento.

Nombre	Tipo	Description
errorMessage	string	Mensaje de error que explica por qué se produjo un error en la operación de indexación para el documento identificado por la clave; null si la indexación se realizó correctamente.
key	string	Clave de un documento que estaba en la solicitud de indexación.
status	boolean	Valor que indica si la operación de indexación se realizó correctamente para el documento identificado por la clave.
statusCode	integer	Código de estado de la operación de indexación. Entre los valores posibles se incluyen: 200 para una actualización o eliminación correcta, 201 para la creación correcta de documentos, 400 para un documento de entrada con formato incorrecto, 404 para el documento no encontrado, 409 para un conflicto de versión, 422 cuando el índice no está disponible temporalmente o 503 para cuando el servicio está demasiado ocupado.

SearchError

Describe una condición de error para la API.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	SearchError[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
message	string	Representación legible del error.

Compartir a través de