Red Hat SummitChapter 3. Enrich AI model metadata for enhanced Red Hat Developer Hub experience
While RHOAI provides essential data, an AI platform engineer using RHOAI can enrich the Backstage/RHDH experience by adding custom properties to the ModelVersion or RegisteredModel (or annotations to the KServe InferenceService if the model registry is not used) so that the OpenShift AI Connector for Red Hat Developer Hub can add the information to the RHDH entities it creates. For more details, see Editing model version metadata in a model registry.
| Property Key | Entity Field Populated | Description |
|---|---|---|
|
| API Definition Tab | The OpenAPI / Swagger JSON specification for the model REST API. |
|
| API Type |
Correlates to supported RHDH/Backstage API types (defaults to |
|
| TechDocs | URL pointing to a Git repository that follows RHDH TechDocs conventions for the Model Card. Use this setting only if the Model Card to TechDocs mapping is not active. |
|
| Links | A URL considered the home page for the model. |
|
| Owner | Overrides the default OpenShift user as the entity owner. |
|
| Lifecycle | Serves a means to express the lifecycle notion of RHDH/Backstage. |
|
| Links | A URL that points to usage documentation. |
|
| Links | A URL to the license file of the model. |
|
| Annotations |
A key piece of metadata is the name of the model used when communicating with the model server’s REST API. OpenShift AI Connector for Red Hat Developer Hub stores this name in the |
3.1. Populating the API Definition tab in RHDH API entities
Because RHOAI does not expose the OpenAPI specification by default, the AI platform engineer can take the following steps to provide this information:
Procedure
Retrieve OpenAPI JSON: Use a tool such as
curlto fetch the specification directly from the running endpoint of the AI model server. The following command provides the precise endpoint (/openapi.json) and shows how to include aBearertoken if the model requires authentication for access.$ curl -k -H "Authorization: Bearer $MODEL_API_KEY" https://$MODEL_ROOT_URL_INCLUDING_PORT/openapi.json | jq > open-api.jsonSet Property in RHOAI.
In the RHOAI dashboard, go to Model Registry and select the appropriate Model Version.
NoteWe recommend using Model Version instead of Registered Model to maintain stability if the API changes between versions.
-
In the Properties section, set a key/value pair where the key is
API Specand the value is the entire JSON content from theopen-api.jsonfile.
- Propagation: The OpenShift AI Connector for Red Hat Developer Hub periodically polls the RHOAI Model Registry, propagates this JSON, and renders the interactive API documentation in the Definition tab of the RHDH API entity.
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}