Criar e implantar um recurso do Serviço OpenAI do Azure

Este artigo descreve como começar a usar o Serviço OpenAI do Azure e fornece instruções passo a passo para criar um recurso e implantar um modelo. Você pode criar recursos no Azure de várias maneiras diferentes:

  • O Portal do Azure
  • As APIs REST, a CLI do Azure, o PowerShell ou as bibliotecas de cliente
  • Modelos do Azure Resource Manager (ARM)

Neste artigo, você examinará exemplos de criação e implantação de recursos no portal do Azure e com a CLI do Azure.

Pré-requisitos

Observação

Atualmente, você deve enviar um aplicativo para acessar o Serviço OpenAI do Azure. Para solicitar acesso, preencha este formulário. Se precisar de assistência, abra uma notificação de problema neste repositório para entrar em contato com a Microsoft.

Criar um recurso

As etapas a seguir mostram como criar um recurso OpenAI do Azure no portal do Azure.

Identificar o recurso

  1. Entre com sua assinatura do Azure no portal do Azure.

  2. Selecione Criar um recurso e pesquise o OpenAI do Azure. Ao localizar o serviço, selecione Criar.

    Screenshot that shows how to create a new Azure OpenAI Service resource in the Azure portal.

  3. Na página Criar OpenAI do Azure, forneça as seguintes informações para os campos na guia Básico:

    Campo Descrição
    Assinatura A assinatura do Azure usada no aplicativo de integração do Serviço OpenAI do Azure.
    Grupo de recursos O grupo de recursos do Azure para conter o recurso do OpenAI do Azure. Você pode criar um novo grupo ou usar um grupo pré-existente.
    Região O local de sua instância. Locais diferentes podem introduzir latência, mas não afetam a disponibilidade de runtime do seu recurso.
    Nome Um nome descritivo para o recurso do Serviço OpenAI do Azure, como MyOpenAIResource.
    Tipo de preço O tipo de preço do recurso. Atualmente, apenas a camada Standard está disponível para o Serviço OpenAI do Azure. Para obter mais informações sobre preços, visite a página de preços do OpenAI do Azure

    Screenshot that shows how to configure an Azure OpenAI resource in the Azure portal.

  4. Selecione Avançar.

Configurar a segurança de rede

A guia Rede apresenta três opções para o Tipo de segurança:

  • Opção 1: Todas as redes, incluindo a Internet, podem acessar esse recurso.
  • Opção 2: Redes selecionadas, configure a segurança de rede para o recurso de serviços de IA do Azure.
  • Opção 3: Desabilitado, nenhuma rede pode acessar esse recurso. Você pode configurar conexões de ponto de extremidade privado que serão o modo exclusivo de acessar esse recurso.

Screenshot that shows the network security options for an Azure OpenAI resource in the Azure portal.

Dependendo da opção selecionada, talvez seja necessário fornecer informações adicionais.

Opção 1: Permitir todas as redes

A primeira opção permite que todas as redes, incluindo a Internet, acessem seu recurso. Essa opção é a configuração padrão. Nenhuma configuração extra é necessária para essa opção.

Opção 2: Permitir somente redes específicas

A segunda opção permite identificar redes específicas que podem acessar seu recurso. Quando você selecionar essa opção, a página é atualizada para incluir os seguintes campos obrigatórios:

Campo Descrição
Rede virtual Especifique as redes virtuais que têm acesso autorizado ao recurso. Você pode editar o nome da rede virtual padrão no portal do Azure.
Sub-redes Especifique as sub-redes que têm acesso autorizado ao recurso. Você pode editar o nome da sub-rede padrão no portal do Azure.

Screenshot that shows how to configure network security for an Azure OpenAI resource to allow specific networks only.

A seção Firewall fornece um campo Intervalo de endereços opcional que você pode usar para definir as configurações do firewall para o recurso.

Opção 3: Desabilitar o acesso à rede

A terceira opção permite desabilitar o acesso à rede ao recurso. Quando você seleciona essa opção, a página é atualizada para incluir a tabela Ponto de extremidade privado.

Screenshot that shows how to disable network security for an Azure OpenAI resource in the Azure portal.

Como uma opção, você pode adicionar um ponto de extremidade privado para acesso o recurso. Selecione Adicionar ponto de extremidade privado e conclua a configuração do ponto de extremidade.

Confirme a configuração e crie o recurso

  1. Selecione Avançar e configure as Marcas para o recurso, conforme desejado.

  2. Selecione Avançar para passar para o estágio final no processo: Examinar + enviar.

  3. Confirme as definições de configuração e selecione Criar.

O portal do Azure exibe uma notificação quando o novo recurso está disponível.

Implantar um modelo

Antes de gerar texto ou inferência, você precisa implantar um modelo. Você pode selecionar um dos vários modelos disponíveis no Estúdio do Azure OpenAI.

Para implantar um modelo, siga estas etapas:

  1. Entre no Estúdio do OpenAI do Azure.

  2. Escolha a assinatura e o recurso do OpenAI do Azure com o qual trabalhar e selecione Usar recurso.

  3. Em Gerenciamento selecione Implantações.

  4. Selecione Criar nova implantação e configure os seguintes campos:

    Campo Descrição
    Selecionar um modelo A disponibilidade do modelo varia de acordo com a região. Confira a Tabela de resumo de modelos e disponibilidade de região para ver uma lista de modelos disponíveis por região.
    Nome da implantação Escolha um nome com cuidado. O nome da implantação é usado em seu código para chamar o modelo usando as bibliotecas de cliente e as APIs REST.
    Opções avançadas (opcional) Você pode definir configurações avançadas opcionais, conforme necessário para o recurso.
    – Para o Filtro de Conteúdo, atribua um filtro de conteúdo à sua implantação.
    – Para o Limite de Taxa de Tokens por Minuto, ajuste os Tokens por Minuto (TPM) para definir o limite de taxa efetivo para sua implantação. Você pode modificar esse valor a qualquer momento usando o menu Cotas. A Cota Dinâmica permite aproveitar mais cota quando a capacidade extra estiver disponível.
  5. Selecione um modelo na lista de seleção.

  6. Digite um nome de implantação para identificar o modelo.

    Importante

    Ao acessar o modelo por meio da API, você precisará fazer referência ao nome da implantação em vez do nome do modelo subjacente nas chamadas de API. Essa é uma das principais diferenças entre o OpenAI e o OpenAI do Azure. O OpenAI requer apenas o nome do modelo, o OpenAI do Azure sempre requer o nome da implantação, mesmo ao usar o parâmetro de modelo. Em nossa documentação, geralmente temos exemplos em que os nomes de implantação são representados como idênticos aos nomes de modelo para ajudar a indicar qual modelo funciona com um ponto de extremidade específico da API. Em última análise, os nomes de suas implantações podem seguir qualquer convenção de nomenclatura que seja melhor para seu caso de uso.

  7. Para sua primeira implantação, deixe as Opções avançadas definidas como os padrões.

  8. Selecione Criar.

A tabela de implantações mostra uma nova entrada que corresponde ao modelo recém-criado.

Quando a implantação for concluída, seu status de implantação do modelo mudará para bem-sucedida.

Pré-requisitos

Observação

Atualmente, você deve enviar um aplicativo para acessar o Serviço OpenAI do Azure. Para solicitar acesso, preencha este formulário. Se precisar de assistência, abra uma notificação de problema neste repositório para entrar em contato com a Microsoft.

Fazer logon na CLI do Azure

Entre na CLI do Azure ou selecione Abrir Cloudshell nas etapas a seguir.

Criar um grupo de recursos do Azure

Para criar um recurso do OpenAI do Azure, você precisa de um grupo de recursos do Azure. Ao criar um novo recurso por meio da CLI do Azure, você também pode criar um novo grupo de recursos ou instruir o Azure a usar um grupo existente. O exemplo a seguir mostra como criar um novo grupo de recursos chamado OAIResourceGroup com o comando az group create. O grupo de recursos é criado na localização Leste dos EUA.

az group create \
--name OAIResourceGroup \
--location eastus

Criar um recurso

Use o comando az cognitiveservices account create para criar um recurso do OpenAI do Azure no grupo de recursos. No exemplo a seguir, você cria um recurso chamado MyOpenAIResource no grupo de recursos OAIResourceGroup. Ao experimentar o exemplo, atualize o código para usar os valores desejados para o grupo de recursos e o nome do recurso, juntamente com sua ID de assinatura do Azure <subscriptionID>.

az cognitiveservices account create \
--name MyOpenAIResource \
--resource-group OAIResourceGroup \
--location eastus \
--kind OpenAI \
--sku s0 \
--subscription <subscriptionID>

Recuperar informações sobre o recurso

Depois de criar o recurso, você pode usar comandos diferentes para encontrar informações úteis sobre sua instância do Serviço OpenAI do Azure. Os exemplos a seguir demonstram como recuperar a URL base do ponto de extremidade da API REST e as chaves de acesso para o novo recurso.

Obter a URL do ponto de extremidade

Use o comando az cognitiveservices account show para recuperar a URL base do ponto de extremidade da API REST para o recurso. Neste exemplo, direcionamos a saída do comando por meio do processador JSON jq para localizar o valor .properties.endpoint.

Ao experimentar o exemplo, atualize o código para usar seus valores para o grupo de recursos <myResourceGroupName> e o recurso <myResourceName>.

az cognitiveservices account show \
--name <myResourceName> \
--resource-group  <myResourceGroupName> \
| jq -r .properties.endpoint

Obter a chave de API primária

Para recuperar as chaves de acesso para o recurso, use o comando az cognitiveservices account keys list. Neste exemplo, direcionamos a saída do comando por meio do processador JSON jq para localizar o valor .key1.

Ao experimentar o exemplo, atualize o código para usar seus valores para o grupo de recursos e o recurso.

az cognitiveservices account keys list \
--name <myResourceName> \
--resource-group  <myResourceGroupName> \
| jq -r .key1

Implantar um modelo

Para implantar um modelo, use o comando az cognitiveservices account deployment create. No exemplo a seguir, você implanta uma instância do modelo text-embedding-ada-002 e dá a ele o nome MyModel. Ao experimentar o exemplo, atualize o código para usar seus valores para o grupo de recursos e o recurso. Não é necessário alterar os valores model-version, model-format, sku-capacity e sku-name.

az cognitiveservices account deployment create \
--name <myResourceName> \
--resource-group  <myResourceGroupName> \
--deployment-name MyModel \
--model-name text-embedding-ada-002 \
--model-version "1"  \
--model-format OpenAI \
--sku-capacity "1" \
--sku-name "Standard"

Importante

Ao acessar o modelo por meio da API, você precisará fazer referência ao nome da implantação em vez do nome do modelo subjacente nas chamadas de API. Essa é uma das principais diferenças entre o OpenAI e o OpenAI do Azure. O OpenAI requer apenas o nome do modelo, o OpenAI do Azure sempre requer o nome da implantação, mesmo ao usar o parâmetro de modelo. Em nossa documentação, geralmente temos exemplos em que os nomes de implantação são representados como idênticos aos nomes de modelo para ajudar a indicar qual modelo funciona com um ponto de extremidade específico da API. Em última análise, os nomes de suas implantações podem seguir qualquer convenção de nomenclatura que seja melhor para seu caso de uso.

Excluir um modelo de seu recurso

Você pode excluir modelos implantados do recurso com o comando az cognitiveservices account deployment delete. No exemplo a seguir, você exclui um modelo chamado MyModel. Ao experimentar o exemplo, atualize o código para usar seus valores para o grupo de recursos, o recurso e o modelo implantado.

az cognitiveservices account deployment delete \
--name <myResourceName> \
--resource-group  <myResourceGroupName> \
--deployment-name MyModel

Excluir um recurso

Se você quiser efetuar uma limpeza após esses exercícios, poderá remover o recurso do OpenAI do Azure excluindo o recurso por meio da CLI do Azure. Você também pode excluir o grupo de recursos. Se você optar por excluir o grupo de recursos, todos os recursos contidos no grupo também serão excluídos.

Para remover o grupo de recursos e os recursos associados, use o comando az cognitiveservices account delete.

Caso não pretenda continuar a usar os recursos criados nesses exercícios, executando o comando a seguir para excluir o grupo de recursos. Atualize o código de exemplo para usar seus valores para o grupo de recursos e o recurso.

az cognitiveservices account delete \
--name <myResourceName> \
--resource-group  <myResourceGroupName>

Pré-requisitos

Observação

Atualmente, você deve enviar um aplicativo para acessar o Serviço OpenAI do Azure. Para solicitar acesso, preencha este formulário. Se precisar de assistência, abra uma notificação de problema neste repositório para entrar em contato com a Microsoft.

Entre no Azure PowerShell

Entre no Azure PowerShell ou selecione Abrir Cloudshell nas etapas a seguir.

Criar um grupo de recursos do Azure

Para criar um recurso do OpenAI do Azure, você precisa de um grupo de recursos do Azure. Ao criar um novo recurso por meio do Azure PowerShell, você também pode criar um novo grupo de recursos ou instruir o Azure a usar um grupo existente. O exemplo a seguir mostra como criar um novo grupo de recursos chamado OAIResourceGroup com o comando New-AzResourceGroup. O grupo de recursos é criado na localização Leste dos EUA.

New-AzResourceGroup -Name OAIResourceGroup -Location eastus

Criar um recurso

Use o comando New-AzCognitiveServicesAccount para criar um recurso do OpenAI do Azure no grupo de recursos. No exemplo a seguir, você cria um recurso chamado MyOpenAIResource no grupo de recursos OAIResourceGroup. Ao experimentar o exemplo, atualize o código para usar os valores desejados para o grupo de recursos e o nome do recurso, juntamente com sua ID de assinatura do Azure <subscriptionID>.

New-AzCognitiveServicesAccount -ResourceGroupName OAIResourceGroup -Name MyOpenAIResource -Type OpenAI -SkuName S0 -Location eastus

Recuperar informações sobre o recurso

Depois de criar o recurso, você pode usar comandos diferentes para encontrar informações úteis sobre sua instância do Serviço OpenAI do Azure. Os exemplos a seguir demonstram como recuperar a URL base do ponto de extremidade da API REST e as chaves de acesso para o novo recurso.

Obter a URL do ponto de extremidade

Use o comando Get-AzCognitiveServicesAccount para recuperar a URL base do ponto de extremidade da API REST para o recurso. Neste exemplo, direcionamos a saída do comando por meio do cmdlet Select-Object para localizar o valor endpoint.

Ao experimentar o exemplo, atualize o código para usar seus valores para o grupo de recursos <myResourceGroupName> e o recurso <myResourceName>.

Get-AzCognitiveServicesAccount -ResourceGroupName OAIResourceGroup -Name MyOpenAIResource |
  Select-Object -Property endpoint

Obter a chave de API primária

Para recuperar as chaves de acesso para o recurso, use o comando Get-AzCognitiveServicesAccountKey. Neste exemplo, direcionamos a saída do comando por meio do cmdlet Select-Object para localizar o valor Key1.

Ao experimentar o exemplo, atualize o código para usar seus valores para o grupo de recursos e o recurso .

Get-AzCognitiveServicesAccountKey -Name MyOpenAIResource -ResourceGroupName OAIResourceGroup |
  Select-Object -Property Key1

Implantar um modelo

Para implantar um modelo, use o comando New-AzCognitiveServicesAccountDeployment. No exemplo a seguir, você implanta uma instância do modelo text-embedding-ada-002 e dá a ele o nome MyModel. Ao experimentar o exemplo, atualize o código para usar seus valores para o grupo de recursos e o recurso. Não é necessário alterar os valores model-version, model-format, sku-capacity e sku-name.

$model = New-Object -TypeName 'Microsoft.Azure.Management.CognitiveServices.Models.DeploymentModel' -Property @{
    Name = 'text-embedding-ada-002'
    Version = '2'
    Format = 'OpenAI'
}

$properties = New-Object -TypeName 'Microsoft.Azure.Management.CognitiveServices.Models.DeploymentProperties' -Property @{
    Model = $model
}

$sku = New-Object -TypeName "Microsoft.Azure.Management.CognitiveServices.Models.Sku" -Property @{
    Name = 'Standard'
    Capacity = '1'
}

New-AzCognitiveServicesAccountDeployment -ResourceGroupName OAIResourceGroup -AccountName MyOpenAIResource -Name MyModel -Properties $properties -Sku $sku

Importante

Ao acessar o modelo por meio da API, você precisará fazer referência ao nome da implantação em vez do nome do modelo subjacente nas chamadas de API. Essa é uma das principais diferenças entre o OpenAI e o OpenAI do Azure. O OpenAI requer apenas o nome do modelo, o OpenAI do Azure sempre requer o nome da implantação, mesmo ao usar o parâmetro de modelo. Em nossa documentação, geralmente temos exemplos em que os nomes de implantação são representados como idênticos aos nomes de modelo para ajudar a indicar qual modelo funciona com um ponto de extremidade específico da API. Em última análise, os nomes de suas implantações podem seguir qualquer convenção de nomenclatura que seja melhor para seu caso de uso.

Excluir um modelo de seu recurso

Você pode excluir modelos implantados do recurso com o comando Remove-AzCognitiveServicesAccountDeployment. No exemplo a seguir, você exclui um modelo chamado MyModel. Ao experimentar o exemplo, atualize o código para usar seus valores para o grupo de recursos, o recurso e o modelo implantado.

Remove-AzCognitiveServicesAccountDeployment -ResourceGroupName OAIResourceGroup -AccountName MyOpenAIResource -Name MyModel

Excluir um recurso

Se você quiser efetuar uma limpeza após esses exercícios, poderá remover o recurso do OpenAI do Azure excluindo o recurso por meio do Azure PowerShell. Você também pode excluir o grupo de recursos. Se você optar por excluir o grupo de recursos, todos os recursos contidos no grupo também serão excluídos.

Para remover o grupo de recursos e os recursos associados, use o comando Remove-AzCognitiveServicesAccount.

Caso não pretenda continuar a usar os recursos criados nesses exercícios, executando o comando a seguir para excluir o grupo de recursos. Atualize o código de exemplo para usar seus valores para o grupo de recursos e o recurso.

Remove-AzCognitiveServicesAccount -Name MyOpenAIResource -ResourceGroupName OAIResourceGroup

Próximas etapas