Instalar as bibliotecas de cliente da Vertex AI

As bibliotecas de cliente oferecem uma experiência de desenvolvedor otimizada para chamar a API Vertex AI. As bibliotecas de cliente usam as convenções naturais de cada linguagem compatível e reduzem o código de boilerplate que você precisa escrever. O guia a seguir explica como instalá-los.

Antes de começar

1. Faça login na sua conta do Google Cloud. Se você começou a usar o Google Cloud agora, crie uma conta para avaliar o desempenho de nossos produtos em situações reais. Clientes novos também recebem US$ 300 em créditos para executar, testar e implantar cargas de trabalho.

2. No console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

   Observação: se você não pretende manter os recursos criados neste procedimento, crie um projeto novo em vez de selecionar um que já existe. Depois de concluir essas etapas, é possível excluir o projeto. Para fazer isso, basta remover todos os recursos associados a ele.

   Acessar o seletor de projetos

3. Ative a Vertex AI API.

   Ative a API

4. Crie uma conta de serviço:

   1. No Console do Google Cloud, acesse a página Criar conta de serviço.

      Acesse "Criar conta de serviço"
   2. Selecione o projeto.

   3. No campo Nome da conta de serviço, insira um nome. O Console do Google Cloud preenche o campo ID da conta de serviço com base nesse nome.

      No campo Descrição da conta de serviço, insira uma descrição. Por exemplo, Service account for quickstart.

   4. Clique em Criar e continuar.

   5. Conceda o papel Project > Owner à conta de serviço do.

      Para conceder o papel, encontre a lista Selecionar um papel e clique em Project > Owner.

      Observação: o campo Papel afeta quais recursos a conta de serviço pode acessar no projeto. É possível revogar esses papéis ou conceder outros papéis posteriormente. Em ambientes de produção, não conceda os papéis de proprietário, editor ou visualizador. Em vez disso, conceda um papel predefinido ou um papel personalizado que atenda às suas necessidades.
   6. Clique em Continuar.

   7. Clique em Concluído para terminar a criação da conta de serviço.

      Não feche a janela do navegador. Você vai usá-la na próxima etapa.

5. Crie uma chave de conta de serviço:

   1. No console do Google Cloud, clique no endereço de e-mail da conta de serviço que você criou.
   2. Clique em Chaves.
   3. Clique em Adicionar chave e em Criar nova chave.
   4. Clique em Criar. O download de um arquivo de chave JSON é feito no seu computador.
   5. Clique em Fechar.

6. Defina a variável de ambiente GOOGLE_APPLICATION_CREDENTIALS como o caminho do arquivo JSON que contém suas credenciais. Essa variável só se aplica à sessão de shell atual. Assim, se você abrir uma nova sessão, precisará definir a variável novamente.

   Exemplo: Linux ou macOS

   export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

   Substitua KEY_PATH pelo caminho do arquivo JSON que contém suas credenciais.

   Exemplo:

   export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

   Exemplo: Windows

   Para PowerShell:

   $env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

   Substitua KEY_PATH pelo caminho do arquivo JSON que contém suas credenciais.

   Exemplo:

   $env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

   Para prompt de comando:

   set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

   Substitua KEY_PATH pelo caminho do arquivo JSON que contém suas credenciais.

7. No console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

   Observação: se você não pretende manter os recursos criados neste procedimento, crie um projeto novo em vez de selecionar um que já existe. Depois de concluir essas etapas, é possível excluir o projeto. Para fazer isso, basta remover todos os recursos associados a ele.

   Acessar o seletor de projetos

8. Ative a Vertex AI API.

   Ative a API

9. Crie uma conta de serviço:

   1. No Console do Google Cloud, acesse a página Criar conta de serviço.

      Acesse "Criar conta de serviço"
   2. Selecione o projeto.

   3. No campo Nome da conta de serviço, insira um nome. O Console do Google Cloud preenche o campo ID da conta de serviço com base nesse nome.

      No campo Descrição da conta de serviço, insira uma descrição. Por exemplo, Service account for quickstart.

   4. Clique em Criar e continuar.

   5. Conceda o papel Project > Owner à conta de serviço do.

      Para conceder o papel, encontre a lista Selecionar um papel e clique em Project > Owner.

      Observação: o campo Papel afeta quais recursos a conta de serviço pode acessar no projeto. É possível revogar esses papéis ou conceder outros papéis posteriormente. Em ambientes de produção, não conceda os papéis de proprietário, editor ou visualizador. Em vez disso, conceda um papel predefinido ou um papel personalizado que atenda às suas necessidades.
   6. Clique em Continuar.

   7. Clique em Concluído para terminar a criação da conta de serviço.

      Não feche a janela do navegador. Você vai usá-la na próxima etapa.

10. Crie uma chave de conta de serviço:

    1. No console do Google Cloud, clique no endereço de e-mail da conta de serviço que você criou.
    2. Clique em Chaves.
    3. Clique em Adicionar chave e em Criar nova chave.
    4. Clique em Criar. O download de um arquivo de chave JSON é feito no seu computador.
    5. Clique em Fechar.

11. Defina a variável de ambiente GOOGLE_APPLICATION_CREDENTIALS como o caminho do arquivo JSON que contém suas credenciais. Essa variável só se aplica à sessão de shell atual. Assim, se você abrir uma nova sessão, precisará definir a variável novamente.

    Exemplo: Linux ou macOS

    export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

    Substitua KEY_PATH pelo caminho do arquivo JSON que contém suas credenciais.

    Exemplo:

    export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

    Exemplo: Windows

    Para PowerShell:

    $env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

    Substitua KEY_PATH pelo caminho do arquivo JSON que contém suas credenciais.

    Exemplo:

    $env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

    Para prompt de comando:

    set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

    Substitua KEY_PATH pelo caminho do arquivo JSON que contém suas credenciais.

Bibliotecas de cliente

A Vertex AI fornece bibliotecas de cliente nos idiomas a seguir. Selecione o idioma que você quer usar.

C#

Execute o seguinte comando para adicionar a referência do pacote Google.Cloud.AIPlatform.V1 ao arquivo de projeto:

dotnet add package Google.Cloud.AIPlatform.V1

Testar amostras de

Para conferir ou acessar exemplos de código individuais, acesse o repositório dotnet-aiplatform do GitHub.

Documentação da biblioteca de cliente

Para mais informações, consulte a documentação da biblioteca de cliente .NET da Vertex AI.

Java

Se você estiver usando o Gradle, adicione isto às dependências:

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-aiplatform</artifactId>
  <version>3.35.0</version>
</dependency>

Se você estiver usando o Gradle, adicione isto às dependências:

compile 'com.google.cloud:google-cloud-aiplatform:3.35.0'

Se você estiver usando o sbt, adicione o seguinte às suas dependências:

libraryDependencies += "com.google.cloud" % "google-cloud-aiplatform" % "3.35.0"

Testar amostras de

Para ver ou ver amostras de código individuais, acesse o repositório java-aiplatform no GitHub.

Documentação da biblioteca de cliente

Para mais informações, consulte a documentação do cliente da Vertex AI para Java (em inglês).

Node.js

Antes de instalar a biblioteca, prepare o ambiente para o desenvolvimento do Node.js.

Execute o seguinte comando no seu ambiente para instalar a biblioteca de cliente:

npm install @google-cloud/aiplatform

Documentação da biblioteca de cliente

Para mais informações, consulte a documentação do cliente Vertex AI para documentação do Node.js (em inglês).

Python

A biblioteca de cliente Python da Vertex AI é instalada quando você instala o SDK da Vertex AI para Python.

Para mais informações, consulte Instalar o SDK da Vertex AI para Python.

Go

Antes de instalar a biblioteca, prepare o ambiente para desenvolvimento em Go.

Analisar pacotes disponíveis

Analise os pacotes disponíveis da API Vertex AI em Go para determinar qual deles atende melhor às necessidades do seu projeto:

• Pacote cloud.google.com/go/vertexai (recomendado)

  vertexai é um pacote criado por humanos que fornece acesso a recursos e capabilities comuns.

  Esse pacote é recomendado como ponto de partida para a maioria dos desenvolvedores que criam usando a API Vertex AI. Para acessar recursos e capabilities ainda não cobertos por esse pacote, use o aiplatform gerado automaticamente.

• Pacote cloud.google.com/go/aiplatform

  aiplatform é um pacote gerado automaticamente.

  Esse pacote é destinado a projetos que exigem acesso a recursos e capabilities da API Vertex AI ainda não fornecidos pelo pacote vertexai criado por humanos.

Instalação

• Pacote cloud.google.com/go/vertexai (recomendado)

  Execute o seguinte comando para instalar o pacote no seu ambiente:

  go get cloud.google.com/go/vertexai
  

• Pacote cloud.google.com/go/aiplatform

  Execute o seguinte comando para instalar o pacote no seu ambiente:

  go get cloud.google.com/go/aiplatform
  

Amostras

• Pacote cloud.google.com/go/vertexai (recomendado)

  Exemplos de uso desse pacote estão disponíveis no repositório golang-samples do GitHub do diretório de nível superior vertexai:

  github.com/GoogleCloudPlatform/golang-samples > vertexai

• Pacote cloud.google.com/go/aiplatform

  Exemplos de uso desse pacote estão disponíveis no repositório golang-samples do GitHub do diretório de nível superior aiplatform:

  github.com/GoogleCloudPlatform/golang-samples > aiplatform

Documentação da biblioteca de cliente

Para mais informações sobre a biblioteca, consulte a documentação da biblioteca de cliente da Vertex AI para Go:

• Pacote cloud.google.com/go/vertexai (recomendado)

  • Referência da API Vertex AI cloud.google.com/go/vertexai

• Pacote cloud.google.com/go/aiplatform

  • Referência da API Vertex AI v1 cloud.google.com/go/aiplatform
  • Referência da API Vertex AI v1beta1 cloud.google.com/go/aiplatform