Managing attachments for AI factsheets and use cases

Define attachment placeholders and organize them in groups for an AI use case or factsheet.

Attachment placeholders and groups

If you have the manage_catalog role for an inventory, you can define attachment placeholders for the AI use cases or factsheets in the inventory. Use an attachment group to organize a set of related attachment facts and render them together. Attachments can provide supporting information and extra details for a use case. For example, data scientists might want to attach visualizations from their model. Model requesters might want to attach a file of requirements to describe a business need.

When you define attachment groups and placeholders for a factsheet, you associate them with a lifecycle phase. This allows for attachments to display with the phase they relate to. For example, if you define attachment placeholders for the Validate section, data scientists can attach visualizations of validation results in that section.

For AI use cases, you can add attachment placeholders to the AI use case's folder.

Creating a group for attachment placeholders for a factsheet

  1. Click Administration > Configuration and settings from the main navigation.
  2. Click AI factsheet & use case definitions.
  3. Click the Attachments tab. If you do not see this tab, you might have insufficient access.
  4. Click Factsheets.
  5. Click the lifecyle phase where you want the group to display.
  6. Click Add group from the toolbar.
  7. Type a name and an optional description for the group An identifier is created from the name of the group. The identifier can be used for programmatic access to the group.

Creating an attachment placeholder

  1. Click Administration > Configuration and settings from the main navigation.
  2. Click AI factsheet & use case definitions.
  3. Click the Attachments tab. If you do not see this tab, you might have insufficient access.
  4. Click AI use cases or Factsheets.
  5. Click the group where you want to add a placeholder.
  6. Click the Add attachment placeholder icon from the toolbar.
  7. Enter a name and an optional description for the attachment placeholder. An identifier is created from the name of the attachment placeholder. The identifier can be used for programmatic access to the attachment.
  8. Save your changes and optionally repeat to create additional placeholders.
  9. Optionally use the toolbar to move, edit, or remove attachment placeholder.

In the following example, the factsheet will have a group named Model approval for attachment placeholders in the Develop phase, and a group named Validation results in the Validate phase.

Adding attachment placeholder groups to a factsheet

Supported attachment types

The following file types are supported for file attachments:

Image file types:

  • png
  • jpg
  • jpeg

Other file types:

  • html
  • csv
  • docx
  • pdf
  • zip
  • text file
  • Markdown

Viewing the attachment placeholders

Attachment placeholders you define display in the Attachments section of the lifecycle phase. In the following image, the attachment group Approvals displays two placeholders in the Attachments section of the Develop phase of a factsheet. Users can upload the relevant files to the attachment placeholders.

Viewing attachment groups and placeholders

Attachments from previous releases

If you created attachments in earlier versions of AI Factsheets or watsonx.governance before support was added for associating attachment placeholders with lifecycle phases, the attachment placeholders display in the Legacy section of the administration page. You can edit or remove the legacy attachment placeholders, but you cannot add new ones. Existing attachments display at the bottom of factsheets.