Guia de Início Rápido – Implantar um modelo e gerar um texto usando o Serviço OpenAI do Azure

Artigo
05/25/2023

Neste artigo

Use este artigo para começar a fazer suas primeiras chamadas ao OpenAI do Azure.

Pré-requisitos

Uma assinatura do Azure – Crie uma gratuitamente.
Acesso permitido ao OpenAI do Azure na assinatura do Azure desejada.

No momento, o acesso a esse serviço é permitido somente por aplicativo. Você pode solicitar acesso ao Serviço OpenAI do Azure preenchendo o formulário em https://aka.ms/oai/access. Abra um problema neste repositório para entrar em contato conosco se você tiver algum problema.
Um recurso do OpenAI do Azure com um modelo implantado. Para obter mais informações sobre a implantação do modelo, consulte o Guia de implantação de recursos.

Vá para o Estúdio OpenAI do Azure

Navegue até o Estúdio do OpenAI do Azure em https://oai.azure.com/ e entre com credenciais que tenham acesso ao recurso do OpenAI. Durante o fluxo de trabalho de entrada, selecione o diretório apropriado, a assinatura do Azure e o recurso OpenAI do Azure.

Navegue na página de aterrissagem do Azure OpenAI Studio para explorar exemplos de conclusão de prompt, gerenciar suas implantações e modelos e encontrar recursos de aprendizagem, como documentação e fóruns da comunidade.

Vá para o Playground para experimentação e fluxo de trabalho de ajuste fino.

Playground

Comece a explorar as funcionalidades do OpenAI do Azure com uma abordagem sem código por meio do Playground GPT-3. É apenas uma caixa de texto em que você pode enviar um prompt para gerar uma conclusão. Nesta página, você pode iterar e experimentar as funcionalidades rapidamente.

Você pode selecionar uma implantação e escolher entre alguns exemplos pré-carregados para começar. Se o recurso não tiver uma implantação, selecione Criar uma implantação e siga as instruções fornecidas pelo assistente. Para obter mais informações sobre a implantação do modelo, consulte o Guia de implantação de recursos.

Você pode experimentar as configurações, como temperatura e texto de pré-resposta, para melhorar o desempenho da tarefa. Você pode ler mais sobre cada parâmetro na API REST.

Selecionar o botão Gerar enviará o texto inserido para a API de conclusões e transmitirá os resultados de volta à caixa de texto.
Selecione o botão Desfazer para desfazer a chamada de geração anterior.
Selecione o botão Regenerar para completar uma ação de desfazer e uma chamada de geração juntas.

O OpenAI do Azure também faz a moderação de conteúdo nas entradas de prompt e nas saídas geradas. Os prompts ou respostas poderão ser filtrados se conteúdo prejudicial for detectado. Para obter mais informações, consulte o artigo filtro de conteúdo.

No playground GPT-3, você também pode visualizar amostras de código Python e curl pré-preenchidas de acordo com as configurações selecionadas. Basta selecionar Exibir código ao lado da lista suspensa de exemplos. Você pode escrever um aplicativo para concluir a mesma tarefa com o SDK do OpenAI Python, curl ou outro cliente da API REST.

Experimentar resumo de texto

Para usar o OpenAI do Azure para resumo de texto no Playground GPT-3, siga estas etapas:

Entre no Estúdio do OpenAI do Azure.
Selecione a assinatura e o recurso OpenAI para trabalhar.
Selecione GPT-3 Playground na parte superior da página de aterrissagem.
Selecione sua implantação na lista suspensa Implantações. Se o recurso não tiver uma implantação, selecione Criar uma implantação e revisite esta etapa.
Selecione Resumir Texto na lista suspensa Exemplos.
Selecione Generate. O OpenAI do Azure tentará capturar o contexto do texto e reformulá-lo de forma sucinta. Você deve obter um resultado semelhante ao seguinte texto:

Tl;dr A neutron star is the collapsed core of a supergiant star. These incredibly dense objects are incredibly fascinating due to their strange properties and their potential for phenomena such as extreme gravitational forces and a strong magnetic field.

A precisão da resposta pode variar por modelo. O modelo baseado em Davinci neste exemplo é adequado para este tipo de resumo, ao passo que um modelo baseado em Codex não teria um desempenho tão bom nessa tarefa específica.

Limpar os recursos

Caso queria limpar e remover um recurso OpenAI, é possível excluir o recurso ou o grupo de recursos. Excluir o grupo de recursos também exclui todos os recursos associados a ele.

Próximas etapas

Código-fonte | Pacote (NuGet) | Exemplos

Pré-requisitos

Uma assinatura do Azure – crie uma gratuitamente
Acesso permitido ao Serviço OpenAI do Azure na assinatura do Azure desejada. No momento, o acesso a esse serviço é permitido somente por aplicativo. Você pode solicitar acesso ao Serviço OpenAI do Azure preenchendo o formulário em https://aka.ms/oai/access.
Versão atual do .NET Core
Um recurso do Serviço OpenAI do Azure com o modelo implantado text-davinci-003. Para obter mais informações sobre a implantação do modelo, consulte o Guia de implantação de recursos.

Configuração

Criar um aplicativo .NET Core

Em uma janela de console (como cmd, PowerShell ou Bash), use o comando dotnet new para criar um novo aplicativo do console com o nome azure-openai-quickstart. Este comando cria um projeto “Olá, Mundo” simples com um único arquivo de origem C#: Program.cs.

dotnet new console -n azure-openai-quickstart

Altere o diretório para a pasta do aplicativo recém-criado. É possível criar o aplicativo com:

dotnet build

A saída de compilação não deve conter nenhum aviso ou erro.

… Build succeeded. 0 Warning(s) 0 Error(s) …

Instalar a biblioteca de clientes do OpenAI .NET com:

dotnet add package Azure.AI.OpenAI –prerelease

Recuperar chave e ponto de extremidade

Para efetuar uma chamada com êxito no Serviço OpenAI do Azure, um ponto de extremidade e uma chave serão necessários.

Nome da variável	Valor
ENDPOINT	Esse valor pode ser encontrado na seção Chaves e ponto de extremidade ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor em Estúdio OpenAI do Azure>Playground>Exibição de código. Um ponto de extremidade de exemplo é: https://docs-test-001.openai.azure.com/.
API-KEY	Esse valor pode ser encontrado na seção Chaves e ponto de extremidade ao examinar o recurso no portal do Azure. Você pode usar KEY1 ou KEY2.

Acesse o seu recurso no portal do Azure. O Ponto de extremidade e as Chaves podem ser encontrados na seção Gerenciamento de recursos. Copie o ponto de extremidade e as chave de acesso, pois você precisará de ambos para autenticar suas chamadas à API. Você pode usar KEY1 ou KEY2. Ter sempre duas chaves permite girar e regenerar chaves com segurança, sem causar interrupção de serviço.

Crie e atribua variáveis de ambiente persistentes para sua chave e ponto de extremidade.

Variáveis de ambiente

setx AZURE_OPENAI_KEY “REPLACE_WITH_YOUR_KEY_VALUE_HERE” setx AZURE_OPENAI_ENDPOINT “REPLACE_WITH_YOUR_ENDPOINT_HERE” [System.Environment]::SetEnvironmentVariable(‘AZURE_OPENAI_KEY’, ‘REPLACE_WITH_YOUR_KEY_VALUE_HERE’, ‘User’) [System.Environment]::SetEnvironmentVariable(‘AZURE_OPENAI_ENDPOINT’, ‘REPLACE_WITH_YOUR_ENDPOINT_HERE’, ‘User’) echo export AZURE_OPENAI_KEY=”REPLACE_WITH_YOUR_KEY_VALUE_HERE” >> /etc/environment && source /etc/environment echo export AZURE_OPENAI_ENDPOINT=”REPLACE_WITH_YOUR_ENDPOINT_HERE” >> /etc/environment && source /etc/environment

Criar aplicativo .NET

No diretório do projeto, abra o arquivo program.cs e substitua pelo seguinte código:

using Azure; using Azure.AI.OpenAI; using static System.Environment; string endpoint = GetEnvironmentVariable(“AZURE_OPENAI_ENDPOINT”); string key = GetEnvironmentVariable(“AZURE_OPENAI_KEY”); // Enter the deployment name you chose when you deployed the model. string engine = “text-davinci-003”; OpenAIClient client = new(new Uri(endpoint), new AzureKeyCredential(key)); string prompt = “When was Microsoft founded?”; Console.Write($”Input: {prompt}n”); Response completionsResponse = await client.GetCompletionsAsync(engine, prompt); string completion = completionsResponse.Value.Choices[0].Text; Console.WriteLine($”Chatbot: {completion}”);

Importante

Para produção, use uma maneira segura de armazenar e acessar suas credenciais, como o Azure Key Vault. Para obter mais informações sobre segurança de credenciais, consulte o artigo segurança dos Serviços Cognitivos.

dotnet run program.cs

Saída

Input: When was Microsoft founded? Chatbot: Microsoft was founded on April 4, 1975

Limpar os recursos

Caso queria limpar e remover um recurso OpenAI, é possível excluir o recurso. Antes de excluir o recurso, primeiro você deve excluir todos os modelos implantados.

Próximas etapas

Código-fonte da biblioteca | Pacote (PyPi) |

Pré-requisitos

Uma assinatura do Azure – crie uma gratuitamente
Acesso concedido ao Serviço OpenAI do Azure na assinatura do Azure desejada

No momento, o acesso a esse serviço é permitido somente por aplicativo. Você pode solicitar acesso ao Serviço OpenAI do Azure preenchendo o formulário em https://aka.ms/oai/access. Abra um problema neste repositório para entrar em contato conosco se você tiver algum problema.
Python versão 3.7.1 ou posteriores
As seguintes bibliotecas do Python: sistema operacional, solicitações, JSON
Um recurso do Serviço OpenAI do Azure com um modelo implantado. Para obter mais informações sobre a implantação do modelo, consulte o Guia de implantação de recursos.

Configuração

Instalar a biblioteca de clientes do OpenAI Python com:

pip install openai

Recuperar chave e ponto de extremidade

Para efetuar uma chamada com êxito no Serviço OpenAI do Azure, será preciso o seguinte:

Nome da variável	Valor
ENDPOINT	Esse valor pode ser encontrado na seção Chaves e ponto de extremidade ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor em Estúdio do OpenAI do Azure>Playground>Exibição de Código. Um ponto de extremidade de exemplo é: https://docs-test-001.openai.azure.com/.
API-KEY	Esse valor pode ser encontrado na seção Chaves e ponto de extremidade ao examinar o recurso no portal do Azure. Você pode usar KEY1 ou KEY2.
DEPLOYMENT-NAME	Esse valor corresponderá ao nome personalizado escolhido para sua implantação ao implantar um modelo. Esse valor pode ser encontrado emGerenciamento de recursos>Implantações no portal do Azure ou, como alternativa, em Gerenciamento>Implantações no Estúdio OpenAI do Azure.

Crie e atribua variáveis de ambiente persistentes para sua chave e ponto de extremidade.

Variáveis de ambiente

Criar um novo aplicativo Python

Criar um arquivo Python chamado quickstart.py. Depois, abra-o no editor ou IDE de sua preferência.
Substitua o conteúdo do arquivo quickstart.py pelo código a seguir. Modifique o código para adicionar sua chave, seu ponto de extremidade e o nome da sua implantação:

import os import requests import json import openai openai.api_key = os.getenv(“AZURE_OPENAI_KEY”) openai.api_base = os.getenv(“AZURE_OPENAI_ENDPOINT”) # your endpoint should look like the following https://YOUR_RESOURCE_NAME.openai.azure.com/ openai.api_type = ‘azure’ openai.api_version = ‘2023-05-15′ # this may change in the future deployment_name=’REPLACE_WITH_YOUR_DEPLOYMENT_NAME’ #This will correspond to the custom name you chose for your deployment when you deployed a model. # Send a completion call to generate an answer print(‘Sending a test completion job’) start_phrase = ‘Write a tagline for an ice cream shop. ‘ response = openai.Completion.create(engine=deployment_name, prompt=start_phrase, max_tokens=10) text = response[‘choices’][0][‘text’].replace(‘n’, ”).replace(‘ .’, ‘.’).strip() print(start_phrase+text)

Importante

Para produção, use uma maneira segura de armazenar e acessar suas credenciais, como o Azure Key Vault. Para obter mais informações sobre segurança de credenciais, consulte o artigo segurança dos Serviços Cognitivos.
Execute o aplicativo com o comando python no seu arquivo de início rápido:

python quickstart.py

Saída

A saída incluirá o texto de resposta após o prompt Write a tagline for an ice cream shop.. O OpenAI do Azure retornou The coldest ice cream in town! neste exemplo.

Sending a test completion job Write a tagline for an ice cream shop. The coldest ice cream in town!

Execute o código mais algumas vezes para ver quais outros tipos de respostas você obtém, pois a resposta nem sempre será a mesma.

Compreensão dos resultados

Como nosso exemplo de Write a tagline for an ice cream shop. fornece pouco contexto, é normal que o modelo nem sempre retorne os resultados esperados. Você poderá ajustar o número máximo de tokens se a resposta parecer inesperada ou truncada.

Limpar os recursos

Caso queria limpar e remover um recurso OpenAI, é possível excluir o recurso ou o grupo de recursos. Excluir o grupo de recursos também exclui todos os recursos associados a ele.

Próximas etapas

Pré-requisitos

Uma assinatura do Azure – crie uma gratuitamente
Acesso concedido ao Serviço OpenAI do Azure na assinatura do Azure desejada

No momento, o acesso a esse serviço é permitido somente por aplicativo. Você pode solicitar acesso ao Serviço OpenAI do Azure preenchendo o formulário em https://aka.ms/oai/access. Abra um problema neste repositório para entrar em contato conosco se você tiver algum problema.
Python versão 3.7.1 ou posteriores
As seguintes bibliotecas do Python: sistema operacional, solicitações, JSON
Um recurso do OpenAI do Azure com um modelo implantado. Para obter mais informações sobre a implantação do modelo, consulte o Guia de implantação de recursos.

Configuração

Recuperar chave e ponto de extremidade

Para fazer uma chamada com sucesso no OpenAI do Azure, você precisará ter o seguinte:

Nome da variável	Valor
ENDPOINT	Esse valor pode ser encontrado na seção Chaves e ponto de extremidade ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor em Estúdio do OpenAI do Azure>Playground>Exibição de Código. Um ponto de extremidade de exemplo é: https://docs-test-001.openai.azure.com/.
API-KEY	Esse valor pode ser encontrado na seção Chaves e ponto de extremidade ao examinar o recurso no portal do Azure. Você pode usar KEY1 ou KEY2.
DEPLOYMENT-NAME	Esse valor corresponderá ao nome personalizado escolhido para sua implantação ao implantar um modelo. Esse valor pode ser encontrado emGerenciamento de recursos>Implantações no portal do Azure ou, como alternativa, em Gerenciamento>Implantações no Estúdio OpenAI do Azure.

Crie e atribua variáveis de ambiente persistentes para sua chave e ponto de extremidade.

Variáveis de ambiente

Criar um novo aplicativo Python

Criar um arquivo Python chamado quickstart.py. Depois, abra-o no editor ou IDE de sua preferência.

Substitua o conteúdo do arquivo quickstart.py pelo código a seguir.

import os import requests import json api_key = os.getenv(“AZURE_OPENAI_KEY”) base_url = os.getenv(“AZURE_OPENAI_ENDPOINT”) deployment_name =”REPLACE_WITH_YOUR_DEPLOYMENT_NAME_HERE” url = base_url + “/openai/deployments/” + deployment_name + “/completions?api-version=2023-05-15” prompt = “Once upon a time” payload = { “prompt”:prompt } r = requests.post(url, headers={ “api-key”: api_key, “Content-Type”: “application/json” }, json = payload ) response = json.loads(r.text) formatted_response = json.dumps(response, indent=4) print(formatted_response)

Importante

Para produção, use uma maneira segura de armazenar e acessar suas credenciais, como o Azure Key Vault. Para obter mais informações sobre segurança de credenciais, consulte o artigo segurança dos Serviços Cognitivos.
Execute o aplicativo com o comando python no seu arquivo de início rápido:

python quickstart.py

Saída

A saída da API de conclusões será conforme a seguir.

{ “id”: “ID of your call”, “object”: “text_completion”, “created”: 1675444965, “model”: “text-davinci-002”, “choices”: [ { “text”: ” there lived in a little village a woman who was known as the meanest”, “index”: 0, “finish_reason”: “length”, “logprobs”: null } ], “usage”: { “completion_tokens”: 16, “prompt_tokens”: 3, “total_tokens”: 19 } }

O Serviço OpenAI do Azure também executa a moderação de conteúdo nas entradas de prompt e nas saídas geradas. Os prompts ou respostas poderão ser filtrados se conteúdo prejudicial for detectado. Para obter mais informações, consulte o artigo filtro de conteúdo.

Limpar os recursos

Caso queria limpar e remover um recurso OpenAI, é possível excluir o recurso ou o grupo de recursos. Excluir o grupo de recursos também exclui todos os recursos associados a ele.

Guia de Início Rápido – Implantar um modelo e gerar um texto usando o Serviço OpenAI do Azure

Neste artigo

Pré-requisitos

Vá para o Estúdio OpenAI do Azure