Scorecards

Sections

Scorecards are organized into logical sections that group related evaluation criteria. For example, a customer service scorecard might have sections for "Greeting", "Problem Resolution", and "Closing".

Scores

Individual evaluation criteria that assess specific aspects of your content. Each score can be customized with its own evaluation logic and requirements. Scores are the building blocks of your evaluation framework.

Examples of scores include:

• Grammar and spelling accuracy
• Sentiment analysis (positive/negative/neutral)
• Compliance with specific regulations
• Presence of required information
• Custom business-specific metrics

Sections

Logical groupings of related scores within a scorecard. Sections help organize scores into categories for better management and understanding.

Weights

Importance factors that determine how much each score contributes to the overall evaluation result. Weights allow you to prioritize certain criteria over others based on their importance to your business objectives.

Versions

Score configurations are versioned, allowing you to track changes over time, compare different implementations, and promote specific versions to champion status.

Listing Scorecards

# List all scorecards for an account
plexus scorecards list "account-name"

# List with filtering
plexus scorecards list "account-name" --name "Scorecard Name"
plexus scorecards list "account-name" --key "scorecard-key"

# Performance options
plexus scorecards list "account-name" --fast  # Skip fetching scores for faster results
plexus scorecards list "account-name" --hide-scores  # Don't display scores in output

The list command uses an optimized single GraphQL query to fetch scorecards, sections, and scores in one request, providing significantly faster performance.

Viewing Score Details

# View a specific score by name, key, ID, or external ID
plexus scorecards score "Score Name" --account "account-name"
plexus scorecards score "score-key" --account "account-name"
plexus scorecards score "score-id" --show-versions --show-config

# Scope to a specific scorecard
plexus scorecards score "Score Name" --scorecard "Scorecard Name"

Listing Scores in a Scorecard

To list all scores within a scorecard, use the scores list command:

# List all scores in a scorecard
plexus scores list --scorecard "Scorecard Name"

# You can also use the singular form
plexus score list --scorecard "Scorecard Name"

This command displays all scores organized by section, including their IDs, keys, and external IDs.

Version Management

# View version history (coming soon)
plexus scorecards history --account-key "account-key" --score-key "score-key"

# Promote a version to champion (coming soon)
plexus scorecards promote --account-key "account-key" --score-id "score-id" --version-id "version-id"

# Pull latest champion versions (coming soon)
plexus scorecards pull --account-key "account-key"

# Push local changes as new versions
plexus scorecards push --scorecard "scorecard-name" --note "Updated configuration"

Scorecard Organization

Group related scores into logical sections to improve clarity and maintainability. Use consistent naming conventions for scorecards, sections, and scores.

Version Management

Add descriptive notes to new versions to document changes. Test new versions thoroughly before promoting them to champion status.

Performance Considerations

Use the --fast option when listing many scorecards to improve performance. This skips fetching score details when you only need basic scorecard information.