VertexAI: Add service account key authentication support

[multiplegeorges]

What this does

This pull request adds support for authenticating to Google Vertex AI using a Service Account JSON key in addition to the existing Application Default Credentials (ADC) method. It updates both the documentation and the implementation to allow users to provide a Service Account key for Vertex AI authentication, improving flexibility and compatibility with Google Cloud best practices.

Vertex AI Authentication Enhancements:

• Added a new configuration option vertexai_service_account_key to the RubyLLM configuration, allowing users to specify a Service Account JSON key as a string for Vertex AI authentication. [1] [2] [3]
• Updated the Vertex AI provider logic to use the Service Account key for authentication if provided; otherwise, it falls back to Application Default Credentials (ADC). This includes refactoring the authorizer initialization to support both methods and defining the required OAuth scopes. [1] [2]

Documentation Updates:

• Expanded the configuration documentation to explain the new vertexai_service_account_key option, how authentication works, and Google Cloud’s recommendations regarding API keys and Service Accounts.

Test/Spec Configuration:

• Updated the test configuration to include a default value for vertexai_service_account_key, ensuring test environments can utilize the new authentication method.

Type of change

• Bug fix
• New feature
• Breaking change
• Documentation
• Performance improvement

Scope check

• I read the Contributing Guide
• This aligns with RubyLLM's focus on LLM communication
• This isn't application-specific logic that belongs in user code
• This benefits most users, not just my specific use case

Quality check

• [x ] I ran overcommit --install and all hooks pass
• I tested my changes thoroughly
  • For provider changes: Re-recorded VCR cassettes with bundle exec rake vcr:record[provider_name]
  • All tests pass: bundle exec rspec
• I updated documentation if needed
• I didn't modify auto-generated files manually (models.json, aliases.json)

API changes

• Breaking change
• New public methods/classes
• Changed method signatures
• No API changes

Related issues

None.

[multiplegeorges]

Looks like #520 is making related changes to the Vertex provider, so probably a good idea to review both in tandem/together.

[crespire]

+1, could use this!

[Kcharle]

+1

[NielsKSchjoedt]

in the mean time something like this can be done:

  credentials = Rails.application.credentials.dig(:google_cloud, :credentials)

  if credentials.present?
    # Write credentials to temp file for Google Cloud SDK authentication
    require "tempfile"
    require "json"

    credentials_file = Tempfile.new([ "vertex_ai_credentials", ".json" ])
    credentials_file.write(credentials.to_json)
    credentials_file.close

    # Set environment variable for Google Cloud SDK
    ENV["GOOGLE_APPLICATION_CREDENTIALS"] = credentials_file.path

    # Clean up temp file on exit
    at_exit { credentials_file.unlink }

    # Configure Vertex AI
    config.vertexai_project_id = Rails.application.credentials.dig(:google_cloud, :project_id)
    config.vertexai_location = Rails.application.credentials.dig(:google_cloud, :location)
  end