Este tópico descreve as etapas para configurar a autenticação do Microsoft Entra ID (antes, Azure AD) para definições de modelos personalizados no AI Agent Studio, permitindo a integração perfeita de seus modelos com o Automation 360.

O Entra ID é compatível apenas por meio de autenticação OAuth2, e esse método é necessário a integração com modelos hospedados pela Microsoft que exigem tokens de acesso baseados no Entra.
  • Use o Entra ID quando o fornecedor do modelo de destino oferecer suporte apenas à autenticação OAuth2.
  • Esse é frequentemente o caso dos serviços hospedados no Azure, quando a autenticação da chave de API não pode ser usada em paralelo com o OAuth2.
  • Por exemplo, os modelos Azure OpenAI usam autenticação por chave de API por padrão, mas se seus requisitos de segurança exigirem OAuth2 via Entra ID, é necessário configurar o modelo por meio da rota de definição de modelo personalizada.

Para baixar e usar a coleção do Postman (exemplo do Entra ID), clique neste link Coleção do Postman — amostra do Entra ID.

Pré-requisitos

  • Uma conta do Azure com o Entra ID ativado. Colete os detalhes necessários:
    • ID do cliente
    • Segredo do cliente
    • URL de autorização
    • URL do token
  • Configure uma conexão OAuth utilizando o Entra ID. Para mais informações, consulte Configuração do Microsoft Entra ID.

Por que usar modelos personalizados e o Entra ID?

O Azure OpenAI é compatível com autenticação por chave de API na interface do usuário; se, em vez disso, você precisar de OAuth2/Entra ID, defina-o por meio da API de modelo personalizado, pois um fornecedor só pode expor um mecanismo de autenticação na interface do usuário por vez.

Procedimento

  1. Uma vez que a conexão OAuth esteja estabelecida, você pode criar a definição do modelo personalizado usando o Criar API de modelo personalizado. Essa API requer um esquema de carga útil JSON que descreva seu modelo, incluindo nome do fornecedor, nome do modelo, protocolos de autenticação e detalhes do endpoint da API.
  2. Use o seguinte bloco authAction para criar uma conexão de modelo personalizada usando o Entra ID configurado. Observe os principais parâmetros de autenticação:
    "authAction": {
      "authType": "OAUTH2",
      "oAuth": {
        "location": "header",
        "keyName": "Authorization",
        "prefix": "Bearer "
      }
    }
    
    • authType: deve ser OAUTH2
    • localização: cabeçalho
    • keyName: Autorização
    • prefix: Portador e inclua o token (inclua um espaço após Portador)
  3. Envie a solicitação. A solicitação é descrita no exemplo a seguir. Em caso de sucesso, a definição do modelo personalizado é criada e torna-se selecionável ao criar uma Conexão de modelo no AI Agent Studio.

Definição de modelos personalizados usando o Entra ID

Aqui está um exemplo simplificado para uma implantação do Azure OpenAI GPT-4.1 mini usando Entra OAuth2:

POST https:/{{ControlRoomURL}}/gai/prompttools/v1/custommodel
Corpo da solicitação:
{
	"name": "AAI Docs Example - Entra",
	"version": "0",
	"authAction": {
		"authType": "OAUTH2",
		"oAuth": {
			"location": "header",
			"keyName": "Authorization",
			"prefix": "Bearer "
		}
	},
	"apiType": "REST",
	"actions": [
		{
			"name": "gpt-4.1-mini",
			"displayName": "GPT-4.1 mini",
			"description": "GPT-4.1 mini provides a balance between intelligence, speed, and cost that makes it an attractive model for many use cases.",
			"method": "POST",
			"uri": "https://{resourceName}.openai.azure.com/openai/deployments/{deployment}/chat/completions?api-version={apiVersion}",
			"params": [
				{
					"type": "PATH_PARAM",
					"attribute": [
						{
							"name": "resourceName",
							"label": "Resource Name",
							"value": {
								"type": "TEXT",
								"string": "genaitemplateplatformeastca"
							}
						}
					]
				},
				{
					"type": "PATH_PARAM",
					"attribute": [
						{
							"name": "deployment",
							"label": "Deployment",
							"value": {
								"type": "TEXT",
								"string": "deploy-gpt-4.1"
							}
						}
					]
				},
				{
					"type": "PATH_PARAM",
					"attribute": [
						{
							"name": "apiVersion",
							"label": "API Version",
							"value": {
								"type": "TEXT",
								"string": "2025-01-01-preview"
							}
						}
					]
				}
			],
			"request": {
				"raw": {
					"body": "{\"model\": \"gpt-4.1\",\"messages\":[{\"role\":\"system\",\"content\":\"system prompt\"},{\"role\":\"user\",\"content\":\"some prompt query\"}],\"max_completion_tokens\":500}",
					"variables": [
						{
							"path": "$.max_completion_tokens",
							"attribute": {
								"name": "max_completion_tokens",
								"label": "Max tokens",
								"value": {
									"type": "INTEGER",
									"number": "2048"
								},
								"annotations": [
									"MODEL_PARAMETER"
								],
								"canonicalName": "choices[0].completionTokens"
							}
						},
						{
							"path": "$.messages[1].content",
							"attribute": {
								"name": "prompt",
								"label": "prompt",
								"value": {
									"type": "TEXT"
								},
								"annotations": [
									"PROMPT_QUERY"
								]
							}
						},
						{
							"path": "$.messages[0].content",
							"attribute": {
								"name": "systemPrompt",
								"label": "System Prompt",
								"value": {
									"type": "TEXT"
								},
								"annotations": [
									"SYSTEM_PROMPT_MESSAGE"
								]
							}
						}
					]
				}
			},
			"response": {
				"body": "{\n    \"id\": \"chatcmpl-APwQdLa9WCQAdZg0dO5OjGr2ER4sX\",\n    \"object\": \"chat.completion\",\n    \"created\": 1730746163,\n    \"model\": \"o3-mini-2025-01-31\",\n    \"choices\": [\n        {\n            \"index\": 0,\n            \"message\": {\n                \"role\": \"assistant\",\n                \"content\": \"Sure! They are one of the most mysterious and exciting objects in space.\",\n                \"refusal\": null\n            },\n            \"finish_reason\": \"stop\"\n        }\n    ],\n    \"usage\": {\n        \"prompt_tokens\": 17,\n        \"completion_tokens\": 959,\n        \"total_tokens\": 976,\n        \"prompt_tokens_details\": {\n            \"cached_tokens\": 0\n        },\n        \"completion_tokens_details\": {\n            \"reasoning_tokens\": 64\n        }\n    },\n    \"system_fingerprint\": \"fp_35c19d48ca\"\n}",
				"variables": [
					{
						"path": "$.usage.completion_tokens",
						"attribute": {
							"name": "completion_tokens",
							"label": "completion_tokens",
							"value": {
								"type": "INTEGER"
							},
							"annotations": [
								"RESPONSE_PARAMETER"
							],
							"canonicalName": "choices[0].completionTokens"
						}
					},
					{
						"path": "$.choices[0].message.content",
						"attribute": {
							"name": "content",
							"label": "content",
							"value": {
								"type": "TEXT",
								"string": "Some response from LLM"
							},
							"annotations": [
								"RESPONSE_PARAMETER"
							],
							"canonicalName": "choices[0].value"
						}
					},
					{
						"path": "$.model",
						"attribute": {
							"name": "model",
							"label": "model",
							"value": {
								"type": "TEXT"
							},
							"annotations": [
								"RESPONSE_PARAMETER"
							],
							"canonicalName": "model_name"
						}
					},
					{
						"path": "$.usage.prompt_tokens",
						"attribute": {
							"name": "prompt_tokens",
							"label": "prompt_tokens",
							"value": {
								"type": "INTEGER"
							},
							"annotations": [
								"RESPONSE_PARAMETER"
							],
							"canonicalName": "choices[0].promptTokens"
						}
					},
					{
						"path": "$.usage.total_tokens",
						"attribute": {
							"name": "total_tokens",
							"label": "total_tokens",
							"value": {
								"type": "INTEGER"
							},
							"annotations": [
								"RESPONSE_PARAMETER"
							],
							"canonicalName": "choices[0].totalTokens"
						}
					}
				]
			}
		}
	]
}