Cabeçalhos comuns de solicitação e resposta HTTP (Azure AI Search)
Artigo
As APIs REST do Azure AI Search dão suporte a um conjunto de cabeçalhos de solicitação/resposta HTTP comuns, resumidos aqui para referência:
Cabeçalho da solicitação
Tipo
Descrição
Aceitar
Tipo de conteúdo
O tipo de conteúdo solicitado da resposta. O padrão é application/json;odata.metadata=minimal. Outros valores permitidos são application/json, application/json; odata.metadata=full, application/json; odata.metadata=none e text/plain (somente para $count).
O token de acesso do OAuth 2.0 para a solicitação. Requer configuração para seu serviço de pesquisa para acesso baseado em função. Esse cabeçalho de solicitação é para aplicativos cliente que usam autenticação Microsoft Entra ID e atribuições de função. O código do cliente deve fornecer o token. Você pode usar esse cabeçalho de solicitação com qualquer versão da API REST com suporte, desde que o serviço de pesquisa esteja configurado para autenticação do plano de dados.
Tipo de conteúdo
Tipo de conteúdo
Tipo de conteúdo do corpo da solicitação (PUT/POST). O padrão é application/json.
ID da solicitação de cliente
GUID
ID de solicitação opcional especificada pelo chamador, na forma de um GUID sem decoração, como chaves (por exemplo, client-request-id: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0). Um valor definido pelo chamador que identifica a solicitação em questão. Se especificado, esse valor será incluído nas informações de resposta como uma maneira de mapear a solicitação.
OData-MaxVersion
"4.0"
Especifica a versão máxima do protocolo OData com suporte no cliente. O padrão é "4.0"
Prefira
"return=representation" ou "return=minimal"
Usado para controlar a carga de resposta das solicitações de /índices PUT e POST. O padrão é "return=representation" ao criar um novo índice por meio de POST ou PUT e "return=minimal" para atualizar um índice existente via PUT.
return-client-request-id
Verdadeiro ou Falso
Se for especificado quando client-request-id foi especificado, instrui o servidor para incluir o cabeçalho client-request-id na resposta. O padrão é Falso.
If-Match
ETag ou *
Usado para alterar um recurso somente se a versão atual corresponder à ETag especificada. Use esse cabeçalho com métodos POST, PUT ou DELETE em recursos (como indexadores, índices e fontes de dados, mas não documentos) para habilitar o controle de simultaneidade otimista.
If-None-Match
ETag ou *
Usado para alterar um recurso somente se a versão atual não corresponder à ETag especificada. Use esse cabeçalho com métodos POST, PUT ou DELETE em recursos (como indexadores, índices e fontes de dados, mas não documentos) para habilitar o controle de simultaneidade otimista.
Cabeçalho de Resposta
Tipo
Descrição
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 definição de índice recém-criada para solicitações POST e PUT /indexes.
OData-Version
"4.0"
Versão do protocolo OData da resposta.
ID da solicitação
GUID
O identificador exclusivo da operação atual. Igual a client-request-id, se especificado; caso contrário, o valor é gerado no servidor.
elapsed-time
Número
Tempo, em milissegundos, que o serviço gastou processando a solicitação. Esse valor inclui apenas o tempo gasto no processamento da solicitação e não inclui o tempo de transferência de rede.
ETag
Cadeia de caracteres
Uma cadeia de caracteres opaca que representa a versão atual de um recurso (retornada para indexadores, índices e fontes de dados, mas não documentos). Use essa cadeia de caracteres no cabeçalho If-Match ou If-None-Match para controle de simultaneidade otimista.