Credo AI: Use Case Bulk Upload

This tool converts a CSV of use cases into formatted JSON for Credo AI's Bulk Upload feature, according to personal context for AI use cases.

• From the app homepage, the bulk upload feature is found via:
  • AI registry > Use cases > ${\underline{\uparrow}}$.
    • $\underline{\uparrow}$ is the button for bulk upload (left of the + Add use case button).

🗂️ Table of Contents

• 🗺️ 1. Overview
• 🔁 2. Mapping Rules
• 🐣 3. Simple Example
• 🕹️ 4. Usage
  • 🧰 4.1 Requirements
  • 🛠️ 4.2 Support

🗺️ 1. Overview

• Each row in the input CSV represents a single use case, to be transformed into a single JSON dict, which is then added to a running list.
• Once all JSON dicts are appended, they're wrapped in a properly formatted payload for Credo AI’s Bulk Upload feature (per the defined schema).
• Optional metadata like Jira tickets and prompts are embedded in each use case's description.
• The formatted payload is then dumped to a JSON file.

🔁 2. Mapping Rules

CSV Column	JSON Field	Notes
use_case_name	name	Name of the use case
purpose_of_use	description	Appended under "Purpose of Use"
response_to_request	description	Appended under "Response to Request"
prompts	description	Appended under "Prompts"
product	description	Appended under "Product"
ticket_number	description	Appended under "Ticket Number"
jira_ticket	description	Appended under "JIRA Ticket"

🐣 3. Simple Example

The JSON below is formatted for Credo AI's Bulk Upload and represents two use cases. In this small example, for each use case, optional metadata in the description field is not included.

{
   "data":{
      "items":[
         {
            "name":"Customer Use Case Demo #1",
            "description":"The very first Customer AI use case to be uploaded into Credo AI."
         },
         {
            "name":"Customer Use Case Demo #2",
            "description":"The second Customer AI use case."
         }
      ]
   }
}

🕹️ 4. Usage

This script only generates a JSON file. Bulk upload must be performed manually through the UI by a user with the appropriate access level.

🧰 4.1 Requirements

• Python >= 3.8
• Install required packages with: pip install -r requirements.txt
• See requirements.txt for specifics.

🛠️ 4.2 Support

• Coordinate with your Credo AI technical contact before running a bulk upload.
• Review the official Credo AI bulk upload docs.
  • Pay special attention to the "Things to note" section.