v2.1

Release Notes

Overview

This release introduces enhanced Group Management features, including improved API key security, a redesigned interface for billing information, and new options for pre-configured billing accounts. This update also includes Azure OpenAI Service support on PingPong and other features, bug fixes and improvements.

Canvas Sync

New Features

• Logs are now less noisy for issues with Canvas Sync, including raising a warning instead of an exception when the user does not have permissions to access SIS information in a course roster. (#623)

Groups

New Features

• Access to the entirety of an API Key has been removed for all users from the Manage Group page UI. Instead, users will see redacted versions of the API with 4-character prefixes and suffixes. (#373)
• The Group Billing API key permissions have been updated, allowing users who entered the group API key details to view the redacted API key in the UI, besides root and institutional admins. (#373)
• PingPong now supports OAI inference services through Azure deployment endpoints. (#444)
• The Billing API key details section on the Manage Group page has been updated with an Azure and OpenAI Provider selector. (#444)
• The Billing API key details section on the Manage Group page has been revamped with a streamlined design after API key details have been configured. (#624)
• A new APIKey table provides better support for managing API keys on the backend. (#626)
• The Create Group page now includes a Billing account selection menu, which allows users to select whether to use a preconfigured Billing account for access to AI services, or set up access later from the Manage Group page. Selecting a pre-configured option automatically sets up the API key configuration for the Group. (#598)
• A new command allows setting an API key to be displayed on the Create Group page as a pre-configured option. The command requires setting a display name. (#628)
• A new command allows moving all API keys of a specific OpenAI project to another API key. (#597)

Resolved Issues

• Fixed: Clicking the Save API button on the Billing section of the Manage Group page might not trigger a form submission. (#609)

Deployment Information

Schema Upgrade	Migration Script	Permissions Update	Task Definition Update	Configuration Update
Yes	Yes	Yes	No	No

Deployment Details

• Schema Upgrade: New api_keys table for storing API keys and updated relationship fields in the classes table.
• Migration Script: migrate-api-keys to copy all existing API keys to the new APIKey table.
• Migration Script: migrate-oai-keys to change all API keys in a specific project_id to a new_api_key.
• Migration Script: set-api-as-default to set an API key as a preconfigured option in the Create Group page.
• Permissions Update: Changed permissions of can_view_api_key.

Related PRs

• Bump aiohttp from 3.10.2 to 3.10.11 in the pip group across 1 directory by @dependabot in #616
• Updates to OAI API key visibility by @ekassos in #615
• Fix: Clicking Save on API Key field doesn't save by @ekassos in #614
• Log CanvasAccessException as a Warning and not an Exception by @ekassos in #623
• Bump cross-spawn from 7.0.3 to 7.0.6 in /web/pingpong in the npm_and_yarn group across 1 directory by @dependabot in #622
• Configure groups to use OpenAI models deployed on Azure by @ekassos in #624
• Migrate all API Keys to APIKey table by @ekassos in #626
• Offer option to use default PingPong HKS API key when creating a class by @ekassos in #625
• Move all classes under the same service account API key by @ekassos in #627
• CLI command to set an API key as default for UI by @ekassos in #628
• Remove extraneous @db.command line by @ekassos in #629

Full Changelog: 490-srv137-web102...501-srv147-web107