Guia de início rápido: usar a API

Importante

Devido ao anúncio da desativação dos Serviços de Mídia do Azure, o Indexador de Vídeo de IA do Azure anuncia ajustes de recursos do Indexador de Vídeo de IA do Azure. Consulte Alterações relacionadas à desativação do AMS (Serviço de Mídia do Azure) para entender o que isso significa para sua conta do Indexador de Vídeo de IA do Azure. Consulte o Guia de atualização e migração Preparando para a aposentadoria do AMS: VI.

O Indexador de Vídeo da IA do Azure consolida várias tecnologias de inteligência artificial (IA) de áudio e vídeo oferecidas pela Microsoft em um único serviço integrado, tornando o desenvolvimento mais simples. O Indexador de Vídeo de IA do Azure foi projetado para permitir que os desenvolvedores se concentrem no uso de tecnologias de IA de mídia sem se preocupar com escala, alcance global, disponibilidade e confiabilidade de plataformas de nuvem. Você pode usar a API para carregar seus arquivos, obter insights de vídeo detalhados, obter URLs de insights incorporáveis, widgets do player e muito mais.

Quando você visitar o site do Indexador de Vídeo da IA do Azure pela primeira vez, uma conta de avaliação gratuita será criada automaticamente para você. Com a conta de avaliação gratuita, você obtém alguns minutos de indexação gratuita. Mais tarde, você pode adicionar uma conta paga. Com a opção paga, você paga por minutos indexados. Para obter detalhes sobre contas disponíveis (opções de avaliação gratuita e paga), confira oa tipos de conta do Indexador de Vídeo da IA do Azure.

Este artigo mostra como usar a API do Indexador de Vídeo de IA do Azure.

Pré-requisitos

Carregue um arquivo de mídia. Há duas maneiras:

  1. Carregue um arquivo de mídia para a URL de sua escolha (recomendado). Você pode usar um local de rede pública. Depois de carregar o arquivo, você pode verificar se o arquivo está acessível ao AVI copiando-o e colando-o na barra de localização do navegador. Se você pode reproduzir o arquivo de mídia, então é provável que o VI também possa acessá-lo. Se você quiser proteger o local de armazenamento usando o Blob de Armazenamento do Azure, carregue o arquivo e obtenha uma URL SAS. Para obter mais informações sobre como obter uma URL segura para seu arquivo, consulte URLs SAS do Armazenamento de Blobs do Azure. Essa URL é usada para copiar seu arquivo para o Indexador de Vídeo de IA do Azure para indexação.

  2. Envie ao arquivo de vídeo uma matriz de bytes no corpo da solicitação. Para obter mais informações sobre como carregar um arquivo de mídia como uma matriz de bytes em um corpo de solicitação, consulte Carregar um blob com .NET.

Observação

Há um limite de solicitações de API de 10 solicitações por segundo e até 120 solicitações por minuto.

Inscrever-se à API

Importante

  • Você deve usar o mesmo email usado quando se inscreveu no Indexador de Vídeo de IA do Azure.
  • As contas pessoais Google e Microsoft (Outlook/Live) só podem ser usadas para contas de avaliação gratuita. As contas conectadas ao Azure exigem a ID do Entra.
  • Só é permitida apenas uma conta ativa por email. Se um usuário tenta entrar com a conta user@gmail.com no LinkedIn e, em seguida, com a conta user@gmail.com no Google, este último exibirá uma página de erro, informando que o usuário já existe.
  • As chaves devem ser protegidas. As chaves só devem ser usadas pelo seu código do servidor. Elas não devem estar disponíveis no lado do cliente (.js, .html, e assim por diante).
  1. Entre no portal do desenvolvedor da API do Indexador de Vídeo de IA do Azure.
  2. Inscreva-se selecionando a guia Produtos . Em seguida, selecione Autorização e assine. Novos usuários são automaticamente inscritos na Autorização.
  3. Encontre, copie e salve as chaves primária e secundária. Você pode encontrar sua assinatura em seu Perfil. As chaves primária e secundária estão na seção Assinaturas .
  4. Selecione o link Mostrar para a chave primária e a chave secundária. Copie-os e cole-os em um editor de texto até que esteja pronto para usá-los no arquivo de variáveis de ambiente.

Obter um token de acesso usando a API de Autorização

Você não quer dar acesso total a todos os usuários do seu aplicativo. Existem vários níveis de acesso para VI.

Nível Ver vídeos Processar vídeos Ver projetos Projetos de processo Ver contas Gerenciar contas
Leitor de Vídeo ✔️
Colaborador de vídeo ✔️ ✔️
Leitor de Projetos ✔️ ✔️
Colaborador do Projeto ✔️ ✔️ ✔️ ✔️
Leitor de Conta ✔️ ✔️ ✔️
Colaborador da Conta ✔️ ✔️ ✔️ ✔️ ✔️ ✔️

Criar e enviar a solicitação de token de acesso

Defina o subscription-id, o resource-group-name, o VI account-name na solicitação e defina o scope parâmetro e permissionType no corpo da solicitação para o nível de acesso necessário.

Por exemplo, se você quiser fornecer acesso a um usuário para que ele possa trabalhar com projetos, mas não possa trabalhar com contas, defina o permissionType como "Colaborador" e o scope como "Projeto". SE definindo permissões para um projeto, forneça o projectIdarquivo .


POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.VideoIndexer/accounts/{account-name}/generateAccessToken?api-version=2024-01-01

{
  "permissionType": "Reader",
  "scope": "Project",
  "projectId": "07ec9e38d4"
}

Resposta de exemplo

{
  "accessToken": "<jwt token of 1260 characters length>"
}

Para obter mais exemplos de configuração do escopo e dos tipos de permissão, consulte a API REST do VI.

Comece a usar a API

Você está pronto para começar a usar a API. Encontre a descrição detalhada de cada API REST do Indexador de Vídeo da IA do Azure.

Para obter um exemplo detalhado de como usar as chaves em seu arquivo de variável de ambiente e usar tokens de acesso, consulte o exemplo do Indexador de Vídeo de IA do Azure.

Recomendações

  • Quando você chama a API que recebe insights de vídeo para o vídeo especificado, você obtém uma saída JSON detalhada como o conteúdo da resposta. Ver detalhes sobre o JSON retornado neste artigo.
  • A saída JSON produzida pela API contémInsightseSummarizedInsightselementos. É altamente recomendável usar Insights e não usar SummarizedInsights (o que está presente para compatibilidade com versões anteriores).
  • Não recomendamos que você use dados diretamente da pasta de artefatos para fins de produção. Os artefatos são saídas intermediárias do processo de indexação e são saídas brutas dos vários mecanismos de IA que analisam os vídeos. O esquema de artefatos pode mudar ao longo do tempo.
  • Use a API Get Video Index , conforme descrito em Obter insights e artefatos produzidos pela API e nãoGet-Video-Artifact-Download-Url.