Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
Ponto final:POST https://api.microsoft.ai/v3/search/images
Pedido de Exemplo:
curl -X POST "https://api.microsoft.ai/v3/search/images" \
-H "host: api.microsoft.ai" \
-H "x-apikey: <Your key>" \
-H 'content-type: application/json' \
-d '{
"query": "cats",
"maxResults": 2,
"language": "en",
"region": "US"
}'
Parameters
| Parameter | Required | Tipo | Default | Description |
|---|---|---|---|---|
query |
Yes | cadeia (de caracteres) | - | Uma cadeia de consulta de pesquisa. O comprimento máximo é de 1000 caracteres. |
maxResults |
No | número inteiro | 30 | Número máximo de resultados a retornar. O valor padrão é 30 e o valor máximo é 30. |
language |
No | cadeia (de caracteres) | "en" | Um código de língua ISO 639-1 de 2 letras para a linguagem de interface nos resultados de pesquisa. Consulte Linguagens Suportadas para a lista completa. |
region |
No | cadeia (de caracteres) | "US" | Um código país/região de 2 letras para indicar de onde devem vir os resultados (por exemplo, "US", "JP", "CN"). Consulte Regiões Suportadas para a lista completa. |
aspectRatio |
No | string(enum) | - | Filtra as imagens por proporção de aspeto. Valores: "quadrado" (aproximadamente 1:1), "largo" (largura > , altura), "alto" (altura > largura). Quando não está definido, não é aplicado qualquer filtragem. |
color |
No | string(enum) | - | Filtra as imagens por cor da imagem. Valores: "colorOnly" (apenas devolve imagens a cores), "monocromático" (só devolve imagens a preto e branco). Quando não está definido, não é aplicado qualquer filtragem. |
safeSearch |
No | string(enum) | "Rigoroso" | Nível de filtragem segura na pesquisa. Valores: "off", "strict". O padrão é "estrito". |
imageSize |
No | string(enum) | - | Filtrar imagens por categoria de tamanho. Valores: "pequeno" (<200x200px), "médio" (largura ou altura 200-500px), "grande" (largura ou altura >= 500px), "extraGrande" (>1024x768px). Também pode usar restrições de píxeis (maxHeight, minHeight, maxWidth, minWidth) para limites personalizados; as restrições de pixel têm prioridade sobre imageSize quando entram em conflito. Quando não está definido, não é aplicado qualquer filtragem. |
watermarkFree |
No | boolean | falso | Excluir imagens com marca de água. O valor predefinido é falso. |
maxHeight |
No | número inteiro | - | Altura máxima da imagem em pixels. Usado com imageSize para limites personalizados. |
minHeight |
No | número inteiro | - | Altura mínima da imagem em pixels. |
maxWidth |
No | número inteiro | - | Largura máxima da imagem em pixels. |
minWidth |
No | número inteiro | - | Largura mínima da imagem em pixels. |
Cabeçalhos dos Pedidos
| Field | Tipo | Description |
|---|---|---|
| alojar | cadeia (de caracteres) | Alojamento para APIs de IA da Microsoft: api.microsoft.ai. |
| x-apikey ou Autorização | cadeia (de caracteres) | A sua chave API ou token de acesso do Entra ID para autenticação. |
| tipo de conteúdo | cadeia (de caracteres) | Tipo MIME do corpo do pedido. Utilize application/json. |
Resposta
ImagensResposta
| Field | Tipo | Description |
|---|---|---|
imageResults |
array de ImageResult | Lista de resultados de imagens. |
instrumentationClickBase |
cadeia (de caracteres) | URL base para pedidos de ping de clique. Adicione um instrumentationSuffix valor a partir de um item de resultado para formar o URL completo do ping. Está presente apenas para aplicações com a flag de perfil EnableInstrumentationPing. Nota: Os cliques do utilizador também podem ser registados usando redirecionamento de URL. Quando o redirecionamento está ativado, não é necessária qualquer ação para registar os cliques do Utilizador, e instrumentationClickBase não será incluído na resposta. Consulte o guia de instrumentação para instruções de configuração. |
instrumentationCitationBase |
cadeia (de caracteres) | URL base para pedidos de ping de registo LLM. Adicione um payload DATA para formar o URL completo do ping. Está presente apenas para aplicações com a flag de perfil EnableInstrumentationPing. |
traceId |
cadeia (de caracteres) | ID de rastreio para depuração e rastreio. |
ImageResult
| Field | Tipo | Description |
|---|---|---|
title |
cadeia (de caracteres) | O título da imagem. |
url |
cadeia (de caracteres) | A URL de origem da imagem. Para utilizadores da China com redirecionamento de URL ativada, este campo contém o mesmo URL de redirecionamento que clickUrl. |
domain |
cadeia (de caracteres) | O anfitrião de destino para o resultado. Devolvido apenas para utilizadores chineses com redirecionamento de URL ativado. |
hostPageUrl |
cadeia (de caracteres) | O URL da página web que aloja a imagem. |
caption |
cadeia (de caracteres) | Descrição gerada da imagem. |
width |
número inteiro | A largura da imagem, em pixels. |
height |
número inteiro | A altura da imagem, em píxeis. |
thumbnailUrl |
cadeia (de caracteres) | A URL da fonte da miniatura da imagem. |
lastUpdatedAt |
cadeia (de caracteres) | A última data de atualização da imagem segue ISO8601 formato. |
isAdult |
boolean | Indica se o conteúdo é conteúdo adulto. |
clickUrl |
cadeia (de caracteres) | URL de redirecionamento que proxie o clique através do Bing. Só está presente quando o redirecionamento por clique está ativado. |
instrumentationSuffix |
cadeia (de caracteres) | Sufixo para anexar à base de URL de ping da instrumentação para este item de resultado. Usado como valor K tanto para o ping URL da instrumentação como para o clickUrl redirecionamento. Presente quando o ping de instrumentação estiver ativado. |
Códigos de erro
| Código de estado | Categoria de Erro | Description | Causas Comuns |
|---|---|---|---|
| 200 | Sucesso | O pedido foi bem-sucedido. | - |
| 400 | Pedido Incorreto | Parâmetros de pedido inválidos. | Campos obrigatórios em falta, valores de parâmetros inválidos, JSON mal formado |
| 401 | Não autorizado | Autenticação falhada ou em falta. | Chave API inválida, falta do cabeçalho x-apikey |
| 403 | Proibido | Credenciais válidas mas permissões insuficientes. | A chave API não tem as permissões necessárias |
| 410 | Desapareceu | HTTPS necessário. | Pedido feito por HTTP em vez de HTTPS |
| 415 | Tipo de Media Não Suportado | Tipo de conteúdo não suportado. | Cabeçalho de tipo de conteúdo em falta ou incorreto |
| 429 | Demasiados Pedidos | Limite de taxa ultrapassado. | Demasiados pedidos numa janela temporal |
| 500 | Erro interno do servidor | Erro inesperado do servidor. | Problema temporário com o servidor |
| 503 | Serviço Indisponível | Serviço temporariamente indisponível. | Manutenção ou interrupção temporária |
| 504 | Tempo limite do gateway | O tempo limite da solicitação expirou. | Tempo de extinção do serviço a montante |
Para orientações detalhadas sobre o tratamento de erros, consulte Gestão de Erros.
Ver também:Pesquisa | naWeb Vídeos Pesquisa | Navegar | por Notícias Pesquisa | MCP