Adding a New Industry
This guide provides a step-by-step process for adding a new industry to AgentV.
Step 1: Create the Directory Structure
Section titled “Step 1: Create the Directory Structure”- Navigate to the
industries/directory in the root of the project. - Create a new folder for your industry. The name should be lowercase and use underscores instead of spaces (e.g.,
real_estate, notReal Estate). - Inside your new industry folder, create two sub-folders:
scenariosdatasets
Step 2: Add Your First Scenario
Section titled “Step 2: Add Your First Scenario”- Inside the
scenariosfolder, you may want to create sub-folders for different use cases (e.g.,crop_managementin theagricultureindustry). - Create your first scenario
.jsonfile. The name should be numbered and descriptive (e.g.,01_mortgage_application_check.json). - Populate the JSON file using the structure defined in the Evaluation Guide. Use existing scenarios as a reference.
Step 3: Document Core Functions
Section titled “Step 3: Document Core Functions”- Add your new industry, its use cases, and core functions to the Core Functions Guide. These constructs relate to the
industry,use_case, andcore_functionfields in your JSON files. - Define the core functions to document their scope for future evaluators.
Step 4: Include Synthetic Datasets
Section titled “Step 4: Include Synthetic Datasets”Realistic environments require data. If your scenarios require data (e.g., a CSV of customer transactions), you should link them via the dataset attribute.
Place your industry-specific database or transaction CSV/JSON files directly inside your industry’s datasets/ directory (e.g. industries/YOUR_INDUSTRY/datasets/records.csv), and reference them in your scenario metadata.
Validation
Section titled “Validation”All scenarios are validated at load time against the AES schema. Your scenario must include these required fields:
Scenario level:
metadata: Containsid,name,capabilities, andaes_version(set to"1.4").workflow: Containsnodesandedges.
Task Node level (each item in workflow.nodes):
id,task_description,success_criteria- (Optional)
expected_outcome
Run schema validation locally:
agentv aes validate --path industries/YOUR_INDUSTRY/scenarios/YOUR_SCENARIO.jsonStep 5: Verify in Visual Debugger
Section titled “Step 5: Verify in Visual Debugger”Launch the dashboard to ensure your new industry and scenarios are appearing correctly in the library:
agentv consoleNavigate to the Library tab to view your JSON structure and trigger a test run visually.