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/videos
Pedido de Exemplo:
curl -X POST "https://api.microsoft.ai/v3/search/videos" \
-H "host: api.microsoft.ai" \
-H "x-apikey: <Your key>" \
-H "content-type: application/json" \
-d '{
"query": "cute puppy videos",
"maxResults": 30,
"language": "en",
"region": "US"
}'
Parameters
| Parameter | Required | Tipo | Default | Description |
|---|---|---|---|---|
| consulta | Yes | cadeia (de caracteres) | - | Uma cadeia de consulta de pesquisa. O comprimento máximo é de 1000 caracteres. |
| maxResultados | No | número inteiro | 30 | Número máximo de resultados a retornar. O valor padrão é 30 e o valor máximo é 30. |
| linguagem | 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. |
| região | No | cadeia (de caracteres) | "US" | Um código de país/região de 2 letras para indicar de onde devem vir os resultados (por exemplo, "EUA", "JP", "GB", etc.). Consulte Regiões Suportadas para a lista completa. |
| enablePlaylist | No | boolean | falso | Se deve incluir a lista de reprodução resulta em resposta. |
| freshness | No | cadeia (de caracteres) | - | O intervalo de tempo para filtrar os resultados com base na data de descoberta. Suporta "semana", "mês", "ano" para tempo relativo, ou formato de intervalo de data ISO 8601: "YYYY-MM-DD/YYY-MM-DD" ou "YYYY-MM-DDTHH:mm:ssZ/YYYY-MM-DDTHH:mm:ssZ" para um intervalo de datas/data-hora, use .. Omitir a data de início ou fim. |
| Incorporável | No | Matriz de cadeia de caracteres | - | Filtra vídeos por capacidades de incorporação. Valores permitidos: "player" (tem player embeddable). Quando não está definido, não é aplicado qualquer filtragem. |
| resolução | No | cadeia (de caracteres) | - | Filtra os vídeos pela resolução mínima . Valores: "360p", "480p", "720p", "1080p". Quando não está definido, não é aplicado qualquer filtragem. |
| safeSearch | No | cadeia (de caracteres) | "Rigoroso" | Nível de filtragem segura na pesquisa. Valores: "off", "strict". O padrão é "estrito". |
| duration | No | cadeia (de caracteres) | - | Filtra vídeos por intervalo de duração. Valores: "curto" (<5 min), "médio" (5–20 min), "longo" (>20 min). Quando não está definido, não é aplicado qualquer filtragem. |
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
Respostas em vídeo
| Field | Tipo | Description |
|---|---|---|
| vídeoResultados | array de vídeoResultado | Lista de resultados em vídeo. |
| Playlists | array de playlistResultado (opcional) | Lista de resultados das playlists. |
| instrumentaçãoClickBase | 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. |
| instrumentaçãoCitaçãoBase | 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. |
Note
playlists é um campo opcional mesmo quando enablePlaylist está definido como verdadeiro.
vídeoResultado
| Field | Tipo | Description |
|---|---|---|
| title | cadeia (de caracteres) | O título ou nome do vídeo. |
| url | cadeia (de caracteres) | A URL de origem do vídeo. Para utilizadores da China com redirecionamento de URL ativada, este campo contém o mesmo URL de redirecionamento que clickUrl. |
| domínio | cadeia (de caracteres) | O anfitrião de destino para o resultado. Devolvido apenas para utilizadores chineses com redirecionamento de URL ativado. |
| description | cadeia (de caracteres) | Descrição do conteúdo do vídeo. Isto é fornecido pelo utilizador do vídeo ou gerado por um LLM. |
| publicado por | cadeia (de caracteres) | Uploader ou publicar o vídeo. |
| Contagem de visualizações | long | O número de visualizações que o vídeo tem. |
| resumo | cadeia (de caracteres) | Resumo em vídeo gerado por IA. |
| length | cadeia (de caracteres) | A duração do vídeo em formato HH:MM:SS. |
| allowHttpsEmbedding | boolean | Se a incorporação HTTPS é permitida. |
| allowMobileEmbedding | boolean | Se a incorporação móvel é permitida. |
| embeddingUrl | cadeia (de caracteres) | URL para incorporar o vídeo. |
| lastUpdatedAt | cadeia (de caracteres) | A última data atualizada como uma cadeia formatada. |
| BestMomentIndex | número inteiro | Índice do melhor momento ou destaque do vídeo. |
| momentos | Array de momentos | Variedade de segmentos/momentos de vídeo. |
| thumbnailUrl | cadeia (de caracteres) | URL miniatura do vídeo. |
| width | número inteiro | A largura do vídeo em píxeis. |
| height | número inteiro | A altura do vídeo em píxeis. |
| éAdulto | boolean | Indica se o resultado inclui conteúdo para adultos. |
| 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. |
| InstrumentaçãoSufixo | 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. |
Note
Vários dos campos acima são opcionais – são servidos se estiverem disponíveis.
momento
| Field | Tipo | Description |
|---|---|---|
| title | cadeia (de caracteres) | Título do segmento do momento. |
| description | cadeia (de caracteres) | Descrição do que acontece neste momento. |
| startTime | cadeia (de caracteres) | Hora de início do momento no formato 'd.hh:mm:ss'. |
| endTime | cadeia (de caracteres) | Fim do momento no formato 'd.hh:mm:ss'. |
| momentUrl | cadeia (de caracteres) | URL direto para este momento específico no vídeo. |
Note
moment é um objeto de resposta opcional. Não está disponível para todos os resultados de vídeo.
playlistResultado
| Field | Tipo | Description |
|---|---|---|
| title | cadeia (de caracteres) | Título da playlist. |
| description | cadeia (de caracteres) | Descrição da playlist. |
| vídeos | Array de vídeo | Variedade de vídeos na playlist. |
Note
playlistResult é um objeto de resposta opcional.
vídeo
| Field | Tipo | Description |
|---|---|---|
| title | cadeia (de caracteres) | Título do vídeo. |
| description | cadeia (de caracteres) | Descrição do vídeo. |
| url | cadeia (de caracteres) | URL do vídeo. |
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 | na WebNavegar | por Notícias Pesquisar | Imagens Pesquisar | MCP