Cabeceras comunes de solicitudes y respuestas HTTP (Azure AI Search)

Las APIs REST de Azure AI Search soportan un conjunto de encabezados comunes de solicitud/respuesta HTTP, resumidos aquí como referencia:

Encabezado de solicitud	Tipo	Description
Aceptar	Tipo de contenido	El tipo de contenido solicitado para la respuesta. Por defecto es application/json; odata.metadatos=mínimo. Otros valores permitidos son application/json, application/json; odata.metadata=full, application/json; odata.metadata=ninguno, y texto/plano (solo para $count).
clave de API	String	Configura tu consulta o clave de administración, dependiendo de la API.
autorización	String	El token de acceso OAuth 2.0 para la solicitud. Requiere configuración en tu servicio de búsqueda para acceso basado en roles. Este encabezado de solicitud es para aplicaciones cliente que utilizan autenticación de ID Microsoft Entra y asignación de roles. Tu código de cliente debe proporcionar el token. Puedes usar este encabezado de solicitud con cualquier versión de API REST soportada siempre que el servicio de búsqueda esté configurado para la autenticación del plano de datos.
Tipo de contenido	Tipo de contenido	Tipo de contenido del cuerpo de la solicitud (PUT/POST). Debe estar configurado en application/json.
ID de solicitud del cliente	Identificador Único Global (GUID)	ID de solicitud opcional especificado por el llamante, en forma de GUID sin decoración como brackets rizados (por ejemplo, id-solicitud-cliente: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0). Un valor definido por el llamador que identifica la solicitud dada. Si se especifica, este valor se incluye en la información de respuesta como forma de mapear la solicitud.
OData-MaxVersion	"4.0"	Especifica la versión máxima del protocolo OData soportada por el cliente. El predeterminado es "4.0"
Preferir	"retorno=representación" o "retorno=mínimo"	Se utiliza para controlar la carga útil de respuesta de las solicitudes PUT y POST /indexes. Por defecto, "return=representación" al crear un nuevo índice mediante POST o PUT, y "return=minimal" para actualizar un índice existente mediante PUT.
return-client-request-id	Verdadero o Falso	Si se especifica cuando se especifica el id de solicitud-cliente, indica al servidor que incluya el encabezado de id-solicitud-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 el ETag especificado. Utiliza este encabezado con métodos POST, PUT o DELETE en recursos (como indexadores, índices y fuentes de datos, pero no en documentos) para permitir un control optimista de la concurrencia.
If-None-Match	ETag o *	Se usa para cambiar un recurso solo si la versión actual no coincide con el ETag especificado. Utiliza este encabezado con métodos POST, PUT o DELETE en recursos (como indexadores, índices y fuentes de datos, pero no en documentos) para permitir un control optimista de la concurrencia.

Encabezado de respuesta	Tipo	Description
ID de solicitud del cliente	Identificador Único Global (GUID)	Un identificador especificado por el llamante en la solicitud original, si está presente.
Tipo de contenido	Tipo de contenido	El tipo de contenido del cuerpo de respuesta.
Ubicación	URL	La URL de la nueva definición de índice para las solicitudes POST y PUT /indexes.
OData-Version	"4.0"	Versión del protocolo OData de la respuesta.
Request-ID	Identificador Único Global (GUID)	Un identificador único para la operación actual. Igual a client-request-id si se especifica; de lo contrario, el valor se genera en el servidor.
Tiempo transcurrido	Number	Tiempo, en milisegundos, que el servicio dedicó a procesar la solicitud. Este valor solo incluye el tiempo dedicado a procesar la solicitud, y no incluye el tiempo de transferencia de red.
ETag	String	Una cadena opaca que representa la versión actual de un recurso (devuelta para indexadores, índices y fuentes de datos, pero no para documentos). Utiliza esta cadena en el encabezado If-Match o If-None-Match para un control optimista de la concurrencia.

Consulte también

API REST de Azure AI Search