Skip to content

03-providers.md

Latest commit

 

History

History
131 lines (92 loc) · 9.34 KB

03-providers.md

File metadata and controls

131 lines (92 loc) · 9.34 KB

Escolher e Configurar um Provedor LLM 🔑

As tarefas podem também ser configuradas para funcionar com uma ou mais implementações de Modelos de Linguagem Grande (LLM) através de um provedor de serviço suportado como OpenAI, Azure ou Hugging Face. Estes fornecem um endpoint hospedado (API) ao qual podemos aceder programaticamente com as credenciais corretas (chave API ou token). Neste curso, discutimos estes provedores:

  • OpenAI com modelos diversos incluindo a série principal GPT.
  • Azure OpenAI para modelos OpenAI com foco em prontidão empresarial
  • Hugging Face para modelos open-source e servidor de inferência

Vai precisar de usar as suas próprias contas para estes exercícios. As tarefas são opcionais, por isso pode escolher configurar um, todos - ou nenhum - dos provedores conforme os seus interesses. Algumas orientações para inscrição:

Inscrição Custo Chave API Playground Comentários
OpenAI Preços Baseado em projeto Sem Código, Web Vários Modelos Disponíveis
Azure Preços Início Rápido SDK Início Rápido Studio É Necessário Solicitar Acesso
Hugging Face Preços Tokens de Acesso Hugging Chat Hugging Chat tem modelos limitados

Siga as instruções abaixo para configurar este repositório para uso com diferentes provedores. As tarefas que requerem um provedor específico conterão uma destas etiquetas no nome do ficheiro:

  • aoai - requer endpoint e chave Azure OpenAI
  • oai - requer endpoint e chave OpenAI
  • hf - requer token Hugging Face

Pode configurar um, nenhum ou todos os provedores. As tarefas relacionadas simplesmente gerarão erro se as credenciais estiverem em falta.

Criar ficheiro .env

Assumimos que já leu as orientações acima, inscreveu-se no provedor relevante e obteve as credenciais de autenticação necessárias (API_KEY ou token). No caso do Azure OpenAI, assumimos também que tem uma implementação válida de um Serviço Azure OpenAI (endpoint) com pelo menos um modelo GPT implementado para conclusão de chat.

O próximo passo é configurar as suas variáveis de ambiente locais da seguinte forma:

  1. Procure na pasta raiz um ficheiro .env.copy que deverá ter um conteúdo como este:

    # Fornecedor OpenAI
OPENAI_API_KEY='<add your OpenAI API key here>'

## Azure OpenAI
AZURE_OPENAI_API_VERSION='2024-02-01' # Padrão definido!
AZURE_OPENAI_API_KEY='<add your AOAI key here>'
AZURE_OPENAI_ENDPOINT='<add your AOIA service endpoint here>'
AZURE_OPENAI_DEPLOYMENT='<add your chat completion model name here>' 
AZURE_OPENAI_EMBEDDINGS_DEPLOYMENT='<add your embeddings model name here>'

## Hugging Face
HUGGING_FACE_API_KEY='<add your HuggingFace API or token here>'

  2. Copie esse ficheiro para .env usando o comando abaixo. Este ficheiro está gitignore-d, mantendo os segredos seguros.

    cp .env.copy .env

  3. Preencha os valores (substitua os espaços reservados do lado direito do =) conforme descrito na secção seguinte.

  4. (Opcional) Se usar GitHub Codespaces, tem a opção de guardar variáveis de ambiente como segredos Codespaces associados a este repositório. Nesse caso, não precisará de configurar um ficheiro .env local. No entanto, note que esta opção funciona apenas se usar GitHub Codespaces. Ainda precisará de configurar o ficheiro .env se usar Docker Desktop.

Preencher ficheiro .env

Vamos dar uma vista rápida aos nomes das variáveis para entender o que representam:

Variável Descrição
HUGGING_FACE_API_KEY Este é o token de acesso do utilizador que configurou no seu perfil
OPENAI_API_KEY Esta é a chave de autorização para usar o serviço para endpoints OpenAI não Azure
AZURE_OPENAI_API_KEY Esta é a chave de autorização para usar esse serviço
AZURE_OPENAI_ENDPOINT Este é o endpoint implementado para um recurso Azure OpenAI
AZURE_OPENAI_DEPLOYMENT Este é o endpoint de implementação do modelo de geração de texto
AZURE_OPENAI_EMBEDDINGS_DEPLOYMENT Este é o endpoint de implementação do modelo de embeddings de texto

Nota: As duas últimas variáveis Azure OpenAI refletem um modelo padrão para conclusão de chat (geração de texto) e pesquisa vetorial (embeddings), respetivamente. As instruções para configurá-las serão definidas nas tarefas relevantes.

Configurar Azure: Pelo Portal

Os valores do endpoint e chave Azure OpenAI serão encontrados no Portal Azure, por isso vamos começar por aí.

  1. Vá ao Portal Azure
  2. Clique na opção Chaves e Endpoint na barra lateral (menu à esquerda).
  3. Clique em Mostrar Chaves - deverá ver o seguinte: CHAVE 1, CHAVE 2 e Endpoint.
  4. Use o valor da CHAVE 1 para AZURE_OPENAI_API_KEY
  5. Use o valor do Endpoint para AZURE_OPENAI_ENDPOINT

De seguida, precisamos dos endpoints para os modelos específicos que implementámos.

  1. Clique na opção Implementações de modelo na barra lateral (menu à esquerda) para o recurso Azure OpenAI.
  2. Na página de destino, clique em Gerir Implementações

Isto levará ao website Azure OpenAI Studio, onde encontraremos os outros valores conforme descrito abaixo.

Configurar Azure: Pelo Studio

  1. Navegue para o Azure OpenAI Studio a partir do seu recurso conforme descrito acima.
  2. Clique no separador Implementações (barra lateral, esquerda) para ver os modelos atualmente implementados.
  3. Se o modelo desejado não estiver implementado, use Criar nova implementação para o implementar.
  4. Vai precisar de um modelo de geração de texto - recomendamos: gpt-35-turbo
  5. Vai precisar de um modelo de embedding de texto - recomendamos text-embedding-ada-002

Agora atualize as variáveis de ambiente para refletir o Nome da implementação usado. Normalmente será o mesmo que o nome do modelo, a menos que o tenha alterado explicitamente. Por exemplo, poderá ter:

AZURE_OPENAI_DEPLOYMENT='gpt-35-turbo'
AZURE_OPENAI_EMBEDDINGS_DEPLOYMENT='text-embedding-ada-002'

Não se esqueça de guardar o ficheiro .env quando terminar. Pode agora sair do ficheiro e voltar às instruções para executar o notebook.

Configurar OpenAI: Pelo Perfil

A sua chave API OpenAI pode ser encontrada na sua conta OpenAI. Se não tiver uma, pode inscrever-se para uma conta e criar uma chave API. Depois de ter a chave, pode usá-la para preencher a variável OPENAI_API_KEY no ficheiro .env.

Configurar Hugging Face: Pelo Perfil

O seu token Hugging Face pode ser encontrado no seu perfil em Tokens de Acesso. Não publique nem partilhe estes publicamente. Em vez disso, crie um novo token para uso neste projeto e copie-o para o ficheiro .env na variável HUGGING_FACE_API_KEY. Nota: Tecnicamente, isto não é uma chave API, mas é usado para autenticação, por isso mantemos essa convenção de nomenclatura para consistência.

Aviso Legal: Este documento foi traduzido utilizando o serviço de tradução automática Co-op Translator. Embora nos esforcemos para garantir a precisão, por favor tenha em conta que traduções automáticas podem conter erros ou imprecisões. O documento original na sua língua nativa deve ser considerado a fonte autorizada. Para informações críticas, recomenda-se a tradução profissional humana. Não nos responsabilizamos por quaisquer mal-entendidos ou interpretações erradas decorrentes do uso desta tradução.