Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Ponto de extremidade:POST https://api.microsoft.ai/v3/search/images
Solicitação 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
| Parâmetro | Required | Tipo | Default | Description |
|---|---|---|---|---|
query |
Yes | cadeia | - | Uma cadeia de caracteres de consulta de pesquisa. O comprimento máximo é de 1000 caracteres. |
maxResults |
No | inteiro | 30 | Número máximo de resultados a serem retornados. O padrão é 30 e o valor máximo é 30. |
language |
No | cadeia | "en" | Um código de idioma ISO 639-1 de 2 letras para linguagem de interface nos resultados da pesquisa. Consulte idiomas com suporte para a lista completa. |
region |
No | cadeia | "US" | Um código de país/região de duas letras de onde os resultados devem vir (por exemplo, "EUA", "JP", "CN"). Consulte regiões com suporte para obter a lista completa. |
aspectRatio |
No | string(enum) | - | Filtrar imagens por proporção. Valores: "quadrado" (aproximadamente 1:1), "largo" (altura da largura > ), "alto" (largura da altura > ). Quando não definido, nenhuma filtragem é aplicada. |
color |
No | string(enum) | - | Filtrar imagens por cor da imagem. Valores: "colorOnly" (retornar somente imagens coloridas), "monocromático" (retornar somente imagens em preto e branco). Quando não definido, nenhuma filtragem é aplicada. |
safeSearch |
No | string(enum) | "estrito" | Nível de filtragem de pesquisa segura. Valores: "off", "strict". O padrão é "estrito". |
imageSize |
No | string(enum) | - | Filtrar imagens por categoria de tamanho. Valores: "small" (<200x200px), "medium" (width ou height 200-500px), "large" (width ou height >=500px), "extraLarge" (>1024x768px). Também pode usar restrições de pixel (maxHeight, minHeight, maxWidth, minWidth) para limites personalizados; as restrições de pixel têm precedência sobre imageSize quando entram em conflito. Quando não definido, nenhuma filtragem é aplicada. |
watermarkFree |
No | boolean | falso | Excluir imagens com marca d'água. O padrão é false. |
maxHeight |
No | inteiro | - | Altura máxima da imagem em pixels. Usado com imageSize para limites personalizados. |
minHeight |
No | inteiro | - | Altura mínima da imagem em pixels. |
maxWidth |
No | inteiro | - | Largura máxima da imagem em pixels. |
minWidth |
No | inteiro | - | Largura mínima da imagem em pixels. |
Cabeçalhos da solicitação
| Field | Tipo | Description |
|---|---|---|
| hospedar | cadeia | Host para APIs de IA Microsoft: api.microsoft.ai. |
| x-apikey ou Autorização | cadeia | Sua chave de API ou Entra ID token de acesso para autenticação. |
| tipo de conteúdo | cadeia | Tipo MIME do corpo da solicitação. Use application/json. |
Resposta
ImagesResponse
| Field | Tipo | Description |
|---|---|---|
imageResults |
matriz de ImageResult | Lista de resultados de imagem. |
instrumentationClickBase |
cadeia | URL base para clicar em solicitações de ping. Acrescente um instrumentationSuffix valor de um item de resultado para formar a URL de ping completa. Presente apenas para aplicativos com o sinalizador de perfil EnableInstrumentationPing. Observação: os cliques do usuário também podem ser registrados usando o redirecionamento de URL. Quando o redirecionamento estiver habilitado, nenhuma ação será necessária para registrar cliques do usuário e instrumentationClickBase não será incluída na resposta. Consulte o guia de Instrumentação para obter instruções de instalação. |
instrumentationCitationBase |
cadeia | URL base para solicitações de ping de log llm. Acrescente um conteúdo de DADOS para formar a URL de ping completa. Presente apenas para aplicativos com o sinalizador de perfil EnableInstrumentationPing. |
traceId |
cadeia | ID de rastreamento para depuração e acompanhamento. |
ImageResult
| Field | Tipo | Description |
|---|---|---|
title |
cadeia | O título da imagem. |
url |
cadeia | A URL de origem da imagem. Para usuários da China com redirecionamento de URL habilitado, esse campo contém a mesma URL de redirecionamento que clickUrl. |
domain |
cadeia | O host de destino para o resultado. Retornado somente para usuários da China com redirecionamento de URL habilitado. |
hostPageUrl |
cadeia | A URL da página da Web que hospeda a imagem. |
caption |
cadeia | Descrição gerada da imagem. |
width |
inteiro | A largura da imagem, em pixels. |
height |
inteiro | A altura da imagem, em pixels. |
thumbnailUrl |
cadeia | A URL de origem da miniatura da imagem. |
lastUpdatedAt |
cadeia | A última data atualizada da imagem segue ISO8601 formato. |
isAdult |
boolean | Indica se o conteúdo é adulto. |
clickUrl |
cadeia | URL de redirecionamento que faz o proxie do clique por meio do Bing. Só está presente quando o redirecionamento de clique está habilitado. |
instrumentationSuffix |
cadeia | Sufixo a ser acrescentado à base de URL de ping de instrumentação para este item de resultado. Usado como o valor K para a URL de ping de instrumentação e o clickUrl redirecionamento. Presente quando o ping de instrumentação estiver habilitado. |
Códigos de erro
| Código de Status | Categoria do Erro | Description | Causas comuns |
|---|---|---|---|
| 200 | Êxito | O pedido foi bem-sucedido. | - |
| 400 | Solicitação incorreta | Parâmetros de solicitação inválidos. | Campos necessários ausentes, valores de parâmetro inválidos, JSON malformado |
| 401 | Unauthorized | Falha ou falha na autenticação. | Chave de API inválida, cabeçalho x-apikey ausente |
| 403 | Proibido | Credenciais válidas, mas permissões insuficientes. | A chave de API não tem permissões necessárias |
| 410 | Sumiu (Gone) | HTTPS necessário. | Solicitação feita por HTTP em vez de HTTPS |
| 415 | Tipo de mídia sem suporte | Não há suporte para o tipo de conteúdo. | Cabeçalho de tipo de conteúdo ausente ou incorreto |
| 429 | Número Excessivo de Solicitações | Limite de taxa excedido. | Muitas solicitações na janela de tempo |
| 500 | Erro interno do servidor | Erro de servidor inesperado. | Problema temporário do servidor |
| 503 | Serviço indisponível | Serviço temporariamente indisponível. | Manutenção ou interrupção temporária |
| 504 | Tempo de Espera do Gateway (Gateway Timeout) | A solicitação expirou. | Tempo limite do serviço upstream |
Para obter diretrizes detalhadas de tratamento de erros, consulte Tratamento de Erros.
Consulte também:Pesquisa | deVídeosde Pesquisa | na WebProcurar | MCPde Pesquisa de | Notícias