Definições de modelo personalizado
- Última atualização2024/12/09
Definições de modelo personalizado
As definições de modelos personalizados permitem que você integre e aproveite modelos externos de IA generativa, hospedados em diversas plataformas em vários ambientes, incluindo a infraestrutura No local, nuvens privadas e plataformas de nuvem pública.
As APIs de modelo personalizado permitem que você se conecte a qualquer modelo compatível com REST API, dando a você a capacidade de acessar uma gama mais ampla de soluções de IA.
A necessidade de modelos personalizados
O rápido avanço das tecnologias de IA generativa resultou em uma ampla gama de modelos fundamentais disponíveis, cada um com seus próprios pontos fortes e especializações. Embora a Automation Anywhere ofereça uma seleção de modelos pré-integrados dentro do AI Agent Studio, talvez haja a necessidade de utilizar outros modelos devido a:
- Modelos especializados
-
Você desenvolveu ou adquiriu modelos treinados em conjuntos de dados específicos ou ajustados para tarefas únicas relevantes para as necessidades do seu negócio.
- Segurança e residência de dados
-
Organizações com Políticas de segurança de dados rigorosas ou requisitos regulatórios podem precisar usar modelos hospedados em seus próprios ambientes seguros, como infraestrutura local ou nuvens privadas.
- Aproveitando os investimentos existentes
-
As organizações que já investiram no desenvolvimento e implantação de modelos de IA em plataformas podem se beneficiar da capacidade de integrar esses modelos diretamente em seus fluxos de trabalho Automation Anywhere.
APIs de modelo personalizado
Para atender a essas necessidades, a Automation Anywhere desenvolveu APIs de modelo personalizadas para definir e conectar a modelos de IA generativa personalizados. Essas APIs funcionam inserindo informações sobre o modelo, incluindo seu fornecedor, nome, mecanismo de autenticação, parâmetros de entrada e mapeamento de saída, no banco de dados de uma instância da Control Room.
-
POST https:/{{ControlRoomURL}}/gai/prompttools/v1/custommodel
- Esta API cria uma nova definição de modelo personalizado.
- Requer um esquema de payload JSON, que encapsula informações sobre o modelo. O esquema define atributos como o nome do fornecedor, nome específico do modelo, protocolos de autenticação, detalhes de endpoint de API (incluindo parâmetros de caminho, parâmetros de consulta e cabeçalhos obrigatórios), e a estrutura de solicitações e respostas.
- A API permite que os usuários definam variáveis dentro da solicitação e
corpos de resposta que podem ser preenchidos dinamicamente durante a execução.
Essas variáveis podem ser designadas para diferentes propósitos usando
anotações específicas:
-
CONSULTA_DE_PROMPT
: Esta anotação indica que a variável correspondente deve ser substituída pelo prompt fornecido pelo usuário na página Habilidades de IA. Isso é essencial para passar os prompts de entrada do usuário para o modelo. -
PARÂMETRO_DE_SOLICITAÇÃO
: Esta anotação indica que a variável deve ser exposta como um parâmetro configurável na página Conexões de modelo. -
PARÂMETRO_DO_MODELO
: Semelhante aPARÂMETRO_DE_SOLICITAÇÃO
, esta anotação designa a variável para configuração na página Habilidades de IA. -
PARÂMETRO_DE_RESPOSTA
: Esta anotação significa que a variável será retornada em na resposta do modelo de IA.
-
- A API retorna uma resposta
200 OK
com o modelo criado com êxito.
-
GET https:/{{ControlRoomURL}}/gai/prompttools/v1/custommodel/vendors/{vendorName}/models/{modelName}
- Esta API recupera a definição de modelos personalizados existentes.
- É necessário o nome do fornecedor (
vendorName
) e o nome do modelo (modelName
) como parâmetros de caminho. - A API retorna uma resposta
200 OK
contendo os objetos que representam o modelo solicitado.
-
DELETE https:/{{ControlRoomURL}}/gai/prompttools/v1/custommodel/vendors/{vendorName}/models/{modelName}
- Esta API exclui um modelo personalizado existente.
- Semelhante à API GET, usa (
vendorName
) e (modelName
) como parâmetros de caminho para identificar o modelo de destino.Nota: O modelo só poderá ser excluído se não estiver atualmente associado a quaisquer Conexões de modelo ativas. Isso significa que você deve primeiro remover qualquer Habilidades de IA e Task Bots que dependem do Conexão de modelo antes de tentar excluir a definição do modelo. - A API retorna uma resposta
204 No Content
após a exclusão bem-sucedida.
-
POST https:/{{ControlRoomURL}}/gai/prompttools/v1/custommodel/list
- Esta API recupera uma lista de todos os modelos personalizados definidos para todos os fornecedores dentro da Control Room.
- Ela aceita um corpo de solicitação opcional contendo um
objeto
FilterRequest
, que permite que os usuários filtrem os resultados com base em critérios específicos. - A API retorna uma resposta
200 OK
com objetos contendo os modelos solicitados.
Para mais detalhes sobre essas APIs, veja API do AI Agente Studio. Você pode baixar aqui uma coleção do Postman para AI Agent Studio - definições de modelos personalizados que contêm exemplos de chamadas de API para se conectar aos modelos personalizados.