Migre para a versão de disponibilidade geral da Vertex AI no Firebase


O Vertex AI in Firebase foi lançado em disponibilidade geral (GA) em 21 de outubro de 2024.

Se você usou a versão Beta da biblioteca Vertex AI in Firebase (firebase-vertexai:16.0.0-betaXX), faça as seguintes mudanças para fazer upgrade e usar a versão GA da biblioteca (firebase-vertexai:16.0.0 ou mais recente).

Confira uma lista geral das mudanças necessárias para a migração:

Ative a nova API necessária no seu projeto do Firebase (obrigatória para todos)

É necessário ativar a API Vertex AI in Firebase no seu projeto do Firebase e adicioná-la à lista de permissões da chave da API do Firebase. Essa é uma nova API necessária para usar a versão GA de Vertex AI in Firebase.

  1. No console do Firebase, acesse a página Criar com o Gemini.

  2. No card Vertex AI in Firebase, clique em Começar para iniciar um fluxo de trabalho que ajuda a ativar essa API e adicioná-la à lista de permissões da chave de API do Firebase.

  3. Você pode pular o restante do fluxo de trabalho no console.

Atualização para a versão GA da biblioteca (obrigatória para todos)

Siga estas instruções para atualizar as dependências e usar a versão mais recente do Firebase Android BoM. O uso do BoM não é obrigatório, mas é altamente recomendado, porque ajuda a garantir que o app esteja usando versões compatíveis de cada biblioteca do Firebase.

  1. No arquivo Gradle do módulo (nível do app) (geralmente <project>/<app-module>/build.gradle.kts ou <project>/<app-module>/build.gradle)), substitua a dependência de Vertex AI in Firebase por este código:

    // BEFORE
    dependencies {
      implementation("com.google.firebase:firebase-vertexai:16.0.0-betaXX")
    }
    
    // AFTER
    dependencies {
      // Import the BoM for the Firebase platform
      implementation(platform("com.google.firebase:firebase-bom:33.10.0"))
    
      // Add the dependency for the Vertex AI in Firebase library
      // When using the BoM, you don't specify versions in Firebase library dependencies
      implementation("com.google.firebase:firebase-vertexai")
    }
  2. Sincronize seu projeto do Android com os arquivos Gradle.

Se você optar por não usar o Firebase BoM, aceite a versão mais recente de firebase-vertexai sugerida pelo Android Studio.

Outras mudanças (obrigatórias dependendo dos recursos usados)

Várias mudanças foram implementadas nas versões GA dos SDKs. Analise as listas a seguir para conferir se há mudanças que você precisa fazer no código para usar a versão GA do SDK no seu app.

  • Chamada de função
    Se você implementou esse recurso antes do GA, será necessário fazer atualizações na maneira como define seu esquema. Recomendamos que você revise o guia atualizado de chamadas de função para saber como escrever as declarações de função.

  • Como gerar saída estruturada (como JSON) usando responseSchema
    Se você implementou esse recurso antes do lançamento oficial, será necessário fazer atualizações na maneira como o esquema é definido. Recomendamos que você revise o novo guia de saída estruturada para saber como escrever esquemas JSON.

  • Tempo limite

    • O tempo limite padrão para solicitações foi alterado para 180 segundos.
  • Enumerações

    • As classes enum e sealed foram substituídas por classes normais. Essa mudança permite mais flexibilidade para evoluir a API de uma forma compatível com versões anteriores.

    • A enumeração BlockThreshold foi renomeada como HarmBlockThreshold.

    • Valores removidos das seguintes enumerações: HarmBlockThreshold, HarmProbability, HarmSeverity, BlockReason e FinishReason.

  • Métodos de blob

    • Renomeação de todos os métodos que incluíam Blob como parte do nome para usar InlineData.
  • Configurações de segurança

    • O campo method foi mudado para ser anulável.
  • Classe de duração

    • Todos os usos da classe Duration do Kotlin foram removidos e substituídos por long. Essa mudança oferece uma melhor interoperabilidade com o Java.
  • Metadados de citação

    • Todos os campos declarados anteriormente em CitationMetadata foram agrupados em uma nova classe chamada Citation. As citações podem ser encontradas na lista chamada citations em CitationMetadata. Essa mudança permite um melhor alinhamento de tipos em várias plataformas.
  • Contar tokens

    • O campo totalBillableCharacters foi mudado para ser anulável.
  • Total de caracteres faturáveis

    • A propriedade totalBillableCharacters em CountTokensResponse foi alterada para ser opcional e refletir situações em que nenhum caractere é enviado.
  • Instanciar um modelo

    • O parâmetro requestOptions foi movido para o final da lista de parâmetros para se alinhar a outras plataformas.

Possíveis erros relacionados à migração

Ao migrar para a versão GA do Vertex AI in Firebase, você pode encontrar erros se não tiver concluído todas as mudanças necessárias, conforme descrito neste guia de migração.

Erro 403: Requests to this API firebasevertexai.googleapis.com ... are blocked.

Se você receber um erro 403 com a mensagem Requests to this API firebasevertexai.googleapis.com ... are blocked., geralmente significa que a chave de API no arquivo/objeto de configuração do Firebase não tem uma API necessária na lista de permissões para o produto que você está tentando usar.

Verifique se a chave de API usada pelo app tem todas as APIs necessárias incluídas na lista de permissões "Restrições de API". Para Vertex AI in Firebase, a chave de API precisa ter pelo menos a API Vertex AI in Firebase na lista de permissões. Essa API precisa ter sido adicionada automaticamente à lista de permissões da chave de API quando você ativou a nova API pelo console Firebase.

É possível conferir todas as chaves de API no painel APIs e serviços > Credenciais no console Google Cloud.