Add/Edit a Scorecard

Learn how to create and manage scorecards using the Plexus dashboard interface.

Creating a Scorecard in the Dashboard

Scorecards define the criteria for evaluating your content. The dashboard provides an intuitive interface for creating and managing scorecards.

Step-by-Step Guide

  1. Access Scorecards:

    Navigate to the "Scorecards" section in the main navigation menu.

  2. Create New Scorecard:

    Click the "New Scorecard" button in the top-right corner.

  3. Basic Information:

    Fill in the scorecard details:

    • Scorecard name
    • Description
    • Category/tags (optional)
  4. Add Scores:

    Click "Add Score" to include evaluation criteria:

    • Select score type
    • Configure score parameters
    • Set weight and threshold
  5. Save Scorecard:

    Click "Create" to save your new scorecard.

Editing a Scorecard

  1. Find the Scorecard:

    Locate the scorecard you want to modify in the Scorecards list.

  2. Enter Edit Mode:

    Click the edit icon or select "Edit" from the actions menu.

  3. Make Changes:

    Modify scorecard details, add/remove scores, or adjust weights.

  4. Save Updates:

    Click "Save Changes" to apply your modifications.

Scorecard Management Tips

Organization

Use meaningful names and descriptions to keep your scorecards organized. Consider using tags to group related scorecards.

Score Weights

Balance score weights to reflect the relative importance of each criterion in your evaluation process.

Templates

Save commonly used scorecard configurations as templates for quick reuse.

Using the CLI

For automated scorecard management, you can use the Plexus CLI:

# List scorecards with optimized performance
plexus scorecards list "account-name" --fast

# View a specific scorecard by filtering
plexus scorecards list "account-name" --name "Content Quality"

# View detailed information about a score
plexus scorecards score "score-name" --account "account-name" --show-versions

# Coming soon:
# Create a new scorecard
plexus scorecards create --name "Content Quality" --description "Evaluates content quality"

# Get detailed information about a specific scorecard
plexus scorecards info --scorecard "Content Quality"

# List all scores in a scorecard
plexus scorecards list-scores --scorecard "Content Quality"

# Pull scorecard configuration to YAML
plexus scorecards pull --scorecard "Content Quality" --output ./my-scorecards

# Push scorecard configuration from YAML
plexus scorecards push --scorecard "Content Quality" --file ./my-scorecard.yaml --note "Updated configuration"

# Delete a scorecard
plexus scorecards delete --scorecard "Content Quality"

Performance Considerations

The CLI now uses optimized GraphQL queries to fetch scorecard data efficiently:

  • Single Query Approach: Instead of making separate queries for each scorecard's sections and scores, the system now fetches all data in a single comprehensive GraphQL query.
  • Fast Mode: Use the --fast option to skip fetching sections and scores when you only need basic scorecard information.
  • Hide Scores: Use --hide-scores to exclude score details from the output while still fetching basic scorecard data.

Python SDK Reference

For programmatic scorecard management, you can use the Python SDK:

from plexus import Plexus

plexus = Plexus(api_key="your-api-key")

# Get a scorecard using any identifier (name, key, ID, or external ID)
scorecard = plexus.scorecards.get("Content Quality")

# List all scorecards
scorecards = plexus.scorecards.list()

# Get all scores in a scorecard
scores = scorecard.get_scores()

# Export scorecard to YAML
yaml_config = scorecard.to_yaml()
with open("scorecard.yaml", "w") as f:
    f.write(yaml_config)

# Import scorecard from YAML
with open("scorecard.yaml", "r") as f:
    yaml_content = f.read()
    
new_scorecard = plexus.scorecards.from_yaml(yaml_content)

Like the CLI, the Python SDK also supports the flexible identifier system, allowing you to reference scorecards using different types of identifiers.

Coming Soon

Additional scorecard features are being developed. Check back soon for:

  • Advanced score configuration options
  • Scorecard version control
  • Collaborative editing features
  • Performance analytics
  • YAML synchronization for offline editing