Economize custos de infraestrutura usando APIs do AI Center

Com as solicitações de API, você pode alterar programaticamente o estado de uma habilidade de ML. Essas APIs podem ser usadas mesmo dentro de um fluxo de trabalho de automação para implantar e desfazer a implantação de uma Habilidade de ML, otimizando o tempo de atividade da infraestrutura e economizando custos. Consulte o conjunto completo de APIs do AI Center documentadas no swagger.

Observe que accountname e tenantname são específicos da sua conta. Para mais informações, consulte a lista de APIs .

Você usa as APIs do AI Center para:

1. Encontre o ID da Habilidade de ML de sampleClassifierSkill
2. Interromper (desfazer a implantação) da Habilidade de ML
3. Inicie ( reimplantar ) e verifique a atualização do status.

Em novembro de 2022, anunciamos a disponibilidade de APIs para interagir programaticamente com cada componente do AI Center. Agora, é possível gerenciar conjuntos de dados, treinar modelos de ML e implantar Habilidades de ML usando APIs, sem ter que usar a Interface do usuário.

Um dos principais casos de uso para aproveitar APIs é gerenciar o status da implantação de uma Habilidade de ML. Dependendo da automação, você pode não precisar que uma Habilidade de ML esteja ativa o tempo todo. Desfazer a implantação de Habilidades de ML quando não estão em uso pode ajudar você a economizar em custos de hardware (AI Units).

As etapas para acessar as APIs do AI Center são:

1. Registrando um aplicativo externo (configuração única)
2. Gerar um token de autenticação (renovar após a expiração)
3. Fazendo chamadas de API do AI Center

Observação: as duas primeiras etapas impõem o controle de acesso, assegurando que o aplicativo seja registrado e autenticado

Registro de um aplicativo externo

Para usar as APIs, seu aplicativo precisa se registrar como um aplicativo externo com um escopo do AI Center.

1. No painel de navegação esquerdo, vá para a página Admin e selecione External Applications.
2. Para adicionar um novo aplicativo externo, selecione + Add Application

   e nomeie-a.

   Observação: apenas o tipoconfidential application pode acessar as APIs do AI Center.
3. Para habilitar o escopo do AI Center para o aplicativo externo:
   1. Selecionar Add scope
   2. Escolha AI Center API Access (preview) no menu suspenso Recurso
   3. Navegue para a guia Application Scope
   4. Selecione as APIs para as quais você deseja habilitar o acesso.
   No exemplo abaixo, todas as APIs são selecionadas para simplificar, mas você pode optar por atribuir acesso a APIs específicas a aplicativos externos específicos.
   
   

   

   
   
4. Selecione Add. Uma mensagem com o ID do aplicativo e um Segredo do aplicativo será gerada.
   Dica: você pode visualizar o ID do aplicativo e Segredo do aplicativo a qualquer momento no aplicativo Editar externo. Essas credenciais serão usadas para gerar um token de autenticação na etapa seguinte. Consulte informações adicionais sobre gerenciamento de aplicativos externos.
   
   

   

   
   

Gerar um token de autenticação

Para autenticação e acesso seguro, o aplicativo externo solicita um token de acesso do UiPath® Identity Server. O token de autenticação gerado expira em uma hora, após a qual você precisa gerar novamente um novo token de autenticação.

Se você quiser usar o Postman, você pode se registrar gratuitamente e escolher usar a interface baseada na web do Postman ou o aplicativo para download. Consulte o site oficial do Postman .

1. Gere uma solicitação POST para o endpoint do Identity Server https://cloud.uipath.com/identity_/connect/token que inclua o seguinte no corpo da solicitação.

   client_id: App ID from previous step
   client_secret: App Secret from previous step
   grant_type: “client_credentials”

2. Defina grant_type como client_credentials.

Use o tipo de conteúdo application/x-www-form-urlencoded para o Postman.

Essa solicitação gera um token de autenticação semelhante ao abaixo, listando as permissões habilitadas para esse aplicativo externo. Use este token de autenticação ao fazer chamadas de API do AI Center.

Consulte as informações adicionais sobre credenciais e tokens de autenticação.

Fazendo chamadas de API do AI Center

As chamadas de API seguem a seguinte estrutura: https://cloud.uipath.com/accountname/tenantname/aifabric_/ em que “accountname" e "tenantname " são específicos da sua conta. A maioria das APIs precisa das seguintes informações:

1. ID da conta e ID do Tenant. Você pode encontrar as informações da conta e do tenant na seção informações do perfil dentro do tenant. Consulte as informações do perfil.
2. Autorização. O campo de autorização deve ser preenchido com o token de autenticação gerado na etapa anterior.
   Importante: ao usar o token de autenticação, prefixe-o com Bearer , como na captura de tela abaixo.

Agora você pode acessar APIs específicas. Use sampleClassifierSkill para este exemplo. Na lista de Habilidades de ML, você pode ver que essa habilidade existe e está atualmente no estado Disponível .

Encontrar detalhes da Habilidade de ML

Usando a chamada GET ML Skills , você pode buscar uma lista de todas as Habilidades de ML dentro da conta e do tenant. Você também pode adicionar o nome da Habilidade de ML como parte da consulta para pesquisar uma Habilidade de ML específica e recuperar seus detalhes. Nesse caso, você encontra a Habilidade de ML idpara o sampleClassifierSkill

GET /ai-deployer/v1/mlskills?name=sampleClassifierSkill

Na resposta abaixo, os campos-chave estão destacados em amarelo. Verifique novamente se o sampleClassifierSkill está no estado Disponível . A habilidade de ML id é usada nas APIs subsequentes para atualizar o estado.

Parar ML Skill

Para interromper uma Habilidade de ML:

• A consulta da solicitação deve conter a ação de atualização stop e a Habilidade de ML id
• O cabeçalho deve conter informações da conta, tenant e autenticação

PUT /ai-deployer/v2/mlskills/stop/{mlSkillId}

A resposta mostra que a alteração do status da habilidade de ML foi bem-sucedida:

Verificando a UI, é possível verificar se a implantação de sampleClassifierSkill foi desfeita.

Retomar ML Skill

Para reiniciar (implantar) a Habilidade de ML, faça as chamadas de API com o updateType definido para Retomar.

POST /ai-deployer/v1/mlskills/{mlSkillId}?updateType=RESUME

{ "deploymentsRequired": 1, 
"gpuRequired": 0, 
"mlPackageVersionId": <package-version-id>, 
"processor": "CPU", 
"publicSkill": false, 
"autoUpdate": false, 
"inactivityPeriodInDays": 7, 
"replicas": 1, 
"requestMemory": 2, 
"requestCPU": 0.5, 
"limitMemory": 9, 
"limitCPU": 2 
}

Na resposta, você pode ver que a solicitação foi bem-sucedida, e o estado da habilidade foi atualizado para Implantando.

Aguarde a habilidade ficar disponível e verifique o status da habilidade de ML usando a API de detalhes do GET ML Skill .

A partir da resposta, a Habilidade de ML agora está implantada e disponível. Verifique a disponibilidade de habilidades na Interface Gráfica. Agora suas automações podem aproveitar a Habilidade de ML sampleClassifierSkill implantada dentro de fluxos de trabalho para fazer previsões.