Encabezados de solicitud y respuesta HTTP comunes (Azure AI Search)
Artículo
Las API REST de Azure AI Search admiten un conjunto de encabezados comunes de solicitud/respuesta HTTP, que se resumen aquí como referencia:
Encabezado de la solicitud
Tipo
Descripción
Accept
Tipo de contenido
El tipo de contenido solicitado para la respuesta. El valor predeterminado es application/json;odata.metadata=minimal. Otros valores permitidos son application/json, application/json; odata.metadata=full, application/json; odata.metadata=none y text/plain (solo para $count).
Token de acceso de OAuth 2.0 para la solicitud. Requiere la configuración del servicio de búsqueda para el acceso basado en roles. Este encabezado de solicitud es para las aplicaciones cliente que usan Microsoft Entra ID autenticación y asignaciones de roles. El código de cliente debe proporcionar el token. Puede usar este encabezado de solicitud con cualquier versión compatible de la API REST siempre que el servicio de búsqueda esté configurado para la autenticación del plano de datos.
Content-Type
Content-Type
Tipo de contenido del cuerpo de solicitud (PUT y POST). El valor predeterminado es application/json.
client-request-id
GUID
Identificador de solicitud especificado por el autor de la llamada opcional, en forma de GUID sin decoración, como llaves (por ejemplo, client-request-id: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0). Valor definido por el autor de la llamada que identifica la solicitud determinada. Si se especifica, este valor se incluye en la información de respuesta como una manera de asignar la solicitud.
OData-MaxVersion
"4.0"
Especifica la versión máxima del protocolo de OData admitido por el cliente. El valor predeterminado es "4.0".
Prefer
"return=representation" o "return=minimal"
Se utiliza para controlar la carga de respuesta de las solicitudes PUT y POST /índices. El valor predeterminado es "return=representation" al crear un nuevo índice a través de POST o PUT, y "return=minimal" para actualizar un índice existente a través de PUT.
return-client-request-id
Verdadero o falso
Si se especifica cuando se especifica el identificador de la solicitud de cliente, indica al servidor que incluya el encabezado de identificador de la solicitud de cliente en la respuesta. El valor predeterminado es False.
If-Match
ETag o *
Se usa para cambiar un recurso solo si la versión actual coincide con la ETag especificada. Use este encabezado con métodos POST, PUT o DELETE en recursos (como indexadores, índices y orígenes de datos, pero no documentos) para habilitar el control de simultaneidad optimista.
If-None-Match
ETag o *
Se usa para cambiar un recurso solo si la versión actual no coincide con la ETag especificada. Use este encabezado con métodos POST, PUT o DELETE en recursos (como indexadores, índices y orígenes de datos, pero no documentos) para habilitar el control de simultaneidad optimista.
Encabezado de respuesta
Tipo
Descripción
client-request-id
GUID
Identificador especificado por el autor de la llamada en la solicitud original, si está presente.
Content-Type
Content-Type
Tipo de contenido del cuerpo de respuesta.
Location
Resolución
Dirección URL de la definición de índice recién creada para las solicitudes POST y PUT /indexes.
Versión de OData
"4.0"
Versión del Protocolo OData de la respuesta.
request-id
GUID
Un identificador único para la operación actual. Es igual al identificador de solicitud del cliente si se especifica; de lo contrario, el valor se genera en el servidor.
elapsed-time
Number
Tiempo, en milisegundos, que el servicio ha dedicado a procesar la solicitud. Este valor solo incluye el tiempo dedicado al procesamiento de la solicitud y no incluye el tiempo de transferencia de red.
ETag
String
Cadena opaca que representa la versión actual de un recurso (devuelto para indexadores, índices y orígenes de datos, pero no documentos). Use esta cadena en el encabezado If-Match o If-None-Match para el control de simultaneidad optimista.