Self-Service and Support Guidelines for Clarity Custom Agents and API Access
Whether you are a current or prospective Custom Agent or API use case owner, this guide defines the self-service model for Custom Agents and API access through Clarity API and Portkey. Here, you will find a clear breakdown of your responsibilities and the platform support provided by the AI Platform Services team.
The Self-Service Partnership
The Clarity Platform offers self-service for Custom Agents upon approval of your use case. In this context, “self-service” denotes the user’s responsibility and obligation in creating and managing all elements of a Custom Agent. For Clarity API-related use cases, the AI Platform Services team will generate API keys as needed; in Portkey it will be your responsibility to generate API keys. Accordingly, while the AI Platform Services team oversees the core Clarity Platform and Portkey, users are accountable for their implementation of Custom Agents and for all development utilizing an API key either through Clarity or Portkey.
In short this means:
- Our Responsibility: The AI Platform Services team evaluates the suitability of your use case for the Clarity platform and Portkey.
- Your Responsibility: You are responsible for managing all details related to your use case. This includes, but is not limited to, setting up your Custom Agent and/or API solution, generating API keys and managing your workspace in Portkey, creating your own documentation, adhering to university policies, and the requirements related to technical architecture, coding/configuration, and testing of the solution you build.
Please review the table below carefully, which details the responsibilities within this self-service framework.
| Area | AI Platform Services Team Responsibility | Your Responsibility |
|---|---|---|
| Applying for Custom Agent or API Access | Providing overview and documentation for the process to apply for Custom Agent and API Access. | Familiarizing yourself with the process to apply for Custom Agent and API Access and make sure to complete all the steps to get your use case approved. |
| Data and Security Requirements |
The Clarity platform is approved for high-risk data; however, the Clarity team is not responsible for any data you feed into Clarity. The team is also not responsible for the security of applications that leverage API access via Clarity or Portkey. Note: We are not currently accepting API use cases involving PHI. |
Identifying your data and upholding the security requirements for it. For API use cases, where API is used in an application rather than being called on your local machine, and for medium and high-risk data, you must do the following after your use case has been approved by the Clarity team:
|
| Getting Started with Your Custom Agent or API | Providing documentation to get you started after your use case has been approved. | Reading the documentation to perform the self-service configuration of your Custom Agent or API. Any user-facing documentation needed for your specific solution is your responsibility to create and distribute. |
| Billing | Charging for use of API access on a monthly basis. Please refer to our API cost overview page to review the costs associated with API access. | Ensuring your API use case submission includes the correct Chart of Accounts (COA). Should an alternative COA be required, please notify the AI Platform Services team accordingly. |
| Availability and Disaster Recovery | Maintaining a disaster recovery plan to restore data in case of an outage. Clarity is designed for high availability but is not a critical system. Support is provided during business hours. | Designing your application(s) with the understanding that Clarity is not a mission-critical service and may experience occasional downtime and outages. |
| Platform Monitoring and Status | Monitoring the platform for performance issues and potential abuse. Updates about outages or maintenance are posted on the AI at Yale website and on the ITS System Status Page. | Checking the AI website and the ITS System Status Page to see if it is a known problem before reporting an issue. |
| Logging | Logging the activity of your Custom Agent and API key activity for security purposes. As with any IT system, the data you enter can be accessed by IT Systems Administrators; however, this would only be done in accordance with Policy 1607.2 Conditions for University Access. | |
| Maintain Contact Information | Maintaining records of the approved use cases and their owners. | Notifying ai.platforms@yale.edu of any changes to the department or primary contact information for your use case. If you decide to pivot your use case to one not approved, you must seek new approval for that use case (do not reuse an existing Custom Agent or API key for an unapproved use case). |
| University Policies | Ensuring that the Clarity platform adheres to the University’s policies. The platform is intended solely for approved University business and may not be used for personal or commercial purposes. | Adhering to the Clarity Platform’s Terms of Use. Any misuse of Clarity, such as using the Clarity platform to engage in activities that are illegal, infringe on the rights of others, conducting unauthorized security tests, or otherwise violate applicable University policy may result in restricted or prohibited access. |
| Artificial Intelligence | Offering Clarity and Portkey as AI services that provides Yale students, faculty, and staff with secure access to robust and secure generative AI services. | Accepting responsibility for any content that you produce or publish that includes AI-generated material. AI-generated content can be inaccurate, misleading, entirely fabricated (sometimes called “hallucinations”), or may contain copyrighted material. Review and validate your AI-generated content: you are responsible for helping to prevent AI hallucinations, ensure the accuracy of responses, and citing copyrighted material that may have been cited as a knowledge source in the chatbot’s response. |
| Alerts, Notices and Expiration | Sending email notices regarding Custom Agent or API misuse, Clarity API key expirations, re-attestation requirements, or other information. |
Addressing alerts and notices sent to you. In addition, if you want to decommission your use case at any time, please reach out to ai.platforms@yale.edu |
Clarity Support
Our team is here to support you. Here’s how and when to reach out.
Please note: Due to the self-service nature of this offering, our support focuses on the core Clarity platform and Portkey. We provide documentation to empower you, but our support does not extend to debugging your application code or co-developing the instructional logic and content for your Custom Agent or API solution.