Cabeçalhos comuns de requisição HTTP e resposta (Azure AI Search)

As APIs REST de Busca de IA do Azure suportam um conjunto de cabeçalhos comuns de requisição/resposta HTTP, resumidos aqui para referência:

Cabeçalho da solicitação Tipo Description
Aceitar Tipo de conteúdo O tipo de conteúdo solicitado para a resposta. O padrão é application/json; odata.metadata=mínimo. Outros valores permitidos são application/json, application/json; odata.metadata=full, application/json; odata.metadata=nenhum, e texto/plano (apenas para $count).
chave da API String Defina para sua consulta ou chave de administrador, dependendo da API.
autorização String O token de acesso OAuth 2.0 para a solicitação. Requer configuração do seu serviço de busca para acesso baseado em funções. Este cabeçalho de requisição é para aplicativos clientes que utilizam autenticação e atribuição de funções com ID Microsoft Entra. Seu código cliente deve fornecer o token. Você pode usar esse cabeçalho de requisição com qualquer versão da API REST suportada, desde que o serviço de busca esteja configurado para autenticação no plano de dados.
Tipo de conteúdo Tipo de conteúdo Tipo de conteúdo do corpo do pedido (PUT/POST). Deve estar configurado para application/json.
ID da solicitação de cliente GUID ID de pedido opcional especificado pelo chamador, na forma de um GUID sem decoração, como chaves enroladas (por exemplo, id-requerimento-cliente: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0). Um valor definido pelo chamador que identifica a solicitação dada. Se especificado, esse valor é incluído nas informações de resposta como uma forma de mapear a solicitação.
OData-MaxVersion "4.0" Especifica a versão máxima do protocolo OData suportada pelo cliente. O padrão é "4.0"
Preferir "retorno=representação" ou "retorno=mínimo" Usado para controlar a carga útil de resposta das requisições PUT e POST /indexes. O padrão é "return=representação" ao criar um novo índice via POST ou PUT, e "return=minimal" para atualizar um índice existente via PUT.
return-client-request-id Verdadeiro ou Falso Se especificado quando o id de requerimento do cliente for especificado, instrui o servidor a incluir o cabeçalho do id de requerimento do cliente na resposta. O padrão é False.
If-Match ETag ou * Usado para alterar um recurso somente se a versão atual corresponder ao ETag especificado. Use este cabeçalho com métodos POST, PUT ou DELETE em recursos (como indexadores, índices e fontes de dados, mas não em documentos) para permitir um controle otimista de concorrência.
If-None-Match ETag ou * Usado para alterar um recurso apenas se a versão atual não corresponder ao ETag especificado. Use este cabeçalho com métodos POST, PUT ou DELETE em recursos (como indexadores, índices e fontes de dados, mas não em documentos) para permitir um controle otimista de concorrência.
Cabeçalho de Resposta Tipo Description
ID da solicitação de cliente GUID Um identificador especificado pelo chamador na solicitação original, se presente.
Tipo de conteúdo Tipo de conteúdo O tipo de conteúdo do corpo da resposta.
Localização URL A URL da recém-criada definição de índice para solicitações POST e PUT /indexes.
OData-Version "4.0" Versão do protocolo OData da resposta.
request-id GUID Um identificador único para a operação atual. Igual ao cliente-request-id se especificado; caso contrário, o valor é gerado no servidor.
Tempo decorrido Número Tempo, em milissegundos, que o serviço gastou processando a solicitação. Esse valor inclui apenas o tempo gasto processando a solicitação, e não inclui o tempo de transferência de rede.
Etag String Uma string opaca que representa a versão atual de um recurso (retornada para indexadores, índices e fontes de dados, mas não para documentos). Use essa string no cabeçalho If-Match ou If-None-Match para um controle otimista de concorrência.

Consulte também

APIs REST da IA do Azure Search