Events¶
Once you have configured the resources, you can use the same resources for multiple events. This guide will walk you through the process of setting up events.
Setting up events¶
From the AI Proxy Admin portal, you can create and manage events. An event is a time bound access to the AI Proxy service.
- Sign into the AI Proxy Admin portal and authenticate using your organization's Entra credentials.
- Select the
Events
tab, then add a new event.
-
Add the event details, including the event name, start and end date.
-
Event Name: The name of the event.
-
Event Shared Code: In most cases, you can leave this field blank.
-
The
Event Shared Code
is used where attendees may not have a GitHub account or for various reasons are unable to authenticate using their existing GitHub account. The shared code should only be used for short (eg 1hr) workshops at in-person events or online events, it's not recommended for longer running hacks. -
The API KEY authentication format is
event-id@shared-code/email-address
. For example, if the Event Shared Code isBUILD2024
, and the event-id is1111-1111
, then the API Key for the event will be1111-1111@BUILD2024/attendee@mail.com
. -
The
event-id
is a unique identifier for and event, its generated by the system and can be found in the URL of the eventATTENDEE
page. -
Note, no PII is stored, the API KEY is one way hashed (sha256) and stored in the database for per user usage tracking.
-
-
Event Image URL: In most cases, you can leave this field blank.
- The URL of the event image used to provide some branding for the event on the AI Playground. The image should be rectangular, approximately 24 pixels high, and approximately 200 pixels wide. If the image bigger or smaller, it will be resized to fit the space in the top left hand side of the Playground.
-
Organizer Name: The name of the event organizer.
- Organizer Email: The email of the event organizer.
- Start Date: The start date/time of the event. You can set the date/time using the date picker or by typing the date/time in the format
YYYY-MM-DDTHH:MM:SS
. - End Date: The end date/time of the event. You can set the date/time using the date picker or by typing the date/time in the format
YYYY-MM-DDTHH:MM:SS
. - Max Token Cap: The maximum number of tokens needed for a prompt to complete successfully. For a short 1 hour event, set the
Max Token Cap
to 512. For a longer multi day event, and depending on the models deployed, set theMax Token Cap
to a larger number like 4000. See the Capacity planning section for more information. - Daily Request Cap: The maximum number of requests that can be made by a user to the Azure OpenAI resources per day. The goal of the Daily Request Cap is to prevent runaway usage and abuse of the model. The
Daily Request Cap
resets at midnight UTC. - Description: The
Markdown
description of the event. This description is displayed when an event attendee registers for a time bound API Key to access the AI Proxy service. - Select
Save
to create the event.
Assigning resources to events¶
Once you have created an event, you can assign resources to the event. This allows you to control the resources that are available to the event attendees.
- Select the
Events
tab, then select the event you want to assign resources to.
- From the event details page, select the
Resources
tab. - From the
Resources
tab, select the resources that you want to assign to the event.
- Select on white space to close the resource selection dialog.
- Select
UPDATE RESOURCES
to assign the resources to the event. - Select
Save
to save the event with the updated resources.
Note
Remember, if you are load balancing across multiple models, ensure the model deployments names are the same, and add each deployment to the event.