Cabeçalhos de pedido e resposta HTTP comuns (Azure AI Search)
Artigo
As APIs REST da Pesquisa de IA do Azure suportam um conjunto de cabeçalhos de pedido/resposta HTTP comuns, resumidos aqui para referência:
Cabeçalho do Pedido
Tipo
Description
Aceitar
Tipo do conteúdo
O tipo de conteúdo pedido para a resposta. A predefinição é application/json; odata.metadata=minimal. Outros valores permitidos são application/json, application/json; odata.metadata=full, application/json; odata.metadata=none e texto/simples (apenas para $count).
O token de acesso OAuth 2.0 para o pedido. Requer configuração para o seu serviço de pesquisa para acesso baseado em funções. Este cabeçalho de pedido destina-se a aplicações cliente que utilizam Microsoft Entra ID autenticação e atribuições de funções. O código de cliente tem de fornecer o token. Pode utilizar este cabeçalho de pedido com qualquer versão da API REST suportada, desde que o serviço de pesquisa esteja configurado para autenticação do plano de dados.
Content-Type
Content-Type
Tipo de conteúdo do corpo do pedido (PUT/POST). A predefinição é application/json.
client-request-id
GUID
ID de pedido opcional especificado pelo autor da chamada, sob a forma de um GUID sem decoração, como chavetas (por exemplo, client-request-id: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0). Um valor definido pelo autor da chamada que identifica o pedido especificado. Se for especificado, este valor é incluído nas informações de resposta como forma de mapear o pedido.
OData-MaxVersion
"4.0"
Especifica a versão máxima do protocolo OData suportado pelo cliente. A predefinição é "4.0"
Preferir
"return=representation" ou "return=minimal"
Utilizado para controlar o payload de resposta a partir de pedidos PUT e POST /indexes. A predefinição é "return=representation" ao criar um novo índice através de POST ou PUT e "return=minimal" para atualizar um índice existente através de PUT.
return-client-request-id
Verdadeiro ou Falso
Se especificado quando client-request-id é especificado, instrui o servidor a incluir o cabeçalho client-request-id na resposta. A predefinição é Falso.
If-Match
ETag ou *
Utilizado para alterar um recurso apenas se a versão atual corresponder à ETag especificada. Utilize este cabeçalho com métodos POST, PUT ou DELETE em recursos (como indexadores, índices e origens de dados, mas não documentos) para ativar o controlo de simultaneidade otimista.
If-None-Match
ETag ou *
Utilizado para alterar um recurso apenas se a versão atual não corresponder à ETag especificada. Utilize este cabeçalho com métodos POST, PUT ou DELETE em recursos (como indexadores, índices e origens de dados, mas não documentos) para ativar o controlo de simultaneidade otimista.
Cabeçalho de Resposta
Tipo
Description
client-request-id
GUID
Um identificador especificado pelo autor da chamada no pedido original, se estiver presente.
Content-Type
Content-Type
O tipo de conteúdo do corpo da resposta.
Localização
URL
O URL da definição de índice recentemente criada para pedidos POST e PUT /indexes.
OData-Version
"4.0"
Versão do protocolo OData da resposta.
request-id
GUID
Um identificador exclusivo para a operação atual. Igual a client-request-id, se especificado; caso contrário, o valor é gerado no servidor.
tempo decorrido
Número
Tempo, em milissegundos, que o serviço gastou a processar o pedido. Este valor inclui apenas o tempo gasto no processamento do pedido e não inclui o tempo de transferência de rede.
ETag
String
Uma cadeia opaca que representa a versão atual de um recurso (devolvida para indexadores, índices e origens de dados, mas não para documentos). Utilize esta cadeia no cabeçalho If-Match ou If-None-Match para controlo de simultaneidade otimista.