{
"version_timestamp": "2024-12-19T20:33:15.971617Z",
"scoring_timestamp": "2024-12-19T20:33:15.971617Z",
"overall_score": 0,
"rating": "Excellent",
"summary": {
"strengths": "The strengths of the prompt.",
"areas_for_improvement": "Areas where the prompt could improve.",
"overall_feedback": "Overall feedback for the prompt."
},
"criteria": {
"criteria_id": "sca_2rjp9HFpIsiYQrAiSbZlz85r3GC",
"name": "Default",
"criterion_results": [
{
"slug": "criterion_slug",
"score": 0,
"weight": 0,
"weighted_score": 0,
"feedback": "Specific feedback for the criterion."
}
]
}
}
Zatomic API
- Introduction
- Versioning
- Authentication
- Workspaces
- Status codes and errors
- Token usage
- Expanding objects
- OpenAPI spec
- Prompts
- The Prompt object
- Creating a prompt
- Updating a prompt
- Deleting a prompt
- Retrieving a prompt
- Retrieving all prompts
- Generating a prompt
- Versions
- The Version object
- Creating a version
- Updating a version
- Deleting a version
- Retrieving a version
- Retrieving all versions
- Retrieving a version score
- Calculating a version score
- Retrieving a version risk
- Analyzing a version risk
- Retrieving a version balance
- Analyzing a version balance
- Retrieving a version heatmap
- Generating a version heatmap
- Improving a version
- Scoring Criteria
- The Scoring Criteria object
- The Scoring Criterion object
- Creating scoring criteria
- Updating a scoring criteria
- Deleting a scoring criteria
- Retrieving a scoring criteria
- Retrieving all scoring criteria
- Generating scoring criteria
- Creating a scoring criterion
- Updating a scoring criterion
- Deleting a scoring criterion
- Retrieving a scoring criterion
- Scoring Criteria Results
- The Scoring Criteria Results object
- Scoring
- The Scoring object
- Calculating a prompt score
- Risk
- The Risk object
- Analyzing prompt risk
- Balance
- The Balance object
- Analyzing prompt balance
- Heatmaps
- The Heatmap object
- Generating a prompt heatmap
The Scoring object
NOTE: When scoring prompts stored outside of Zatomic, the version_timestamp and scoring_timestamp properties will both be null.
Properties | |||||||
---|---|---|---|---|---|---|---|
version_timestamp
datetime, nullable
|
The timestamp of the prompt version used to calculate the score. | ||||||
scoring_timestamp
datetime, nullable
|
The timestamp for when the scoring occurred. | ||||||
overall_score
integer
|
The overall score for the prompt version, from 0.0 to 100.0. | ||||||
rating
string
|
The rating for the prompt version. Will be one of Excellent, Good, Fair, or Poor. | ||||||
summary
object
|
Contains summary info about the prompt version.
|
||||||
criteria
scoring criteria results object
|
The criteria that was used to score the prompt version, with results for each criterion. |
The Scoring Object