Zatomic
Zatomic API

The Balance object

NOTE: When analyzing the balance of prompts stored outside of Zatomic, the version_timestamp and balance_timestamp properties will both be null.

Properties
version_timestamp
datetime, nullable
 The timestamp of the prompt version used to analyze the balance.
balance_timestamp
datetime, nullable
 The timestamp for when the balance analysis occurred.
summary
object

Properties of the summary object:

overall_feedback
string
 Overall feedback based on the prompt balance.
recommendations
string
 Recommendations to improve the prompt balance.
categories
list of objects

Properties of the categories object:

category
string
 Name of the category. Will be Instruction, Entity, Concept, or Detail.
feedback
string
 Feedback about the balance of the category in the prompt.
phrase_count
integer
 Number of prompt phrases in the category.
phrase_percent
decimal
 Percent of prompt phrases for the category.
distribution
integer
 Distribution of the category. Will be Balanced, Overused, or Underused.
phrases
list of objects

Properties of the phrases object:

phrase
string
 The prompt phrase.
category
string
 The category for the phrase. Will be Instruction, Entity, Concept, or Detail.
reason
string
 The reason the phrase was assigned to its category.
The Balance Object 
{
   "version_timestamp": "2024-12-19T20:33:15.971617Z",
   "balance_timestamp": "2024-12-19T20:33:15.971617Z",
   "summary": {
      "overall_feedback": "Overall feedback based on the prompt balance.",
      "recommendations": "Recommendations to improve the prompt balance."
   },
   "categories": [
      {
         "category": "The category name.",
         "feedback": "Feedback about the balance of the category in the prompt.",
         "phrase_count": 0,
         "phrase_percent": 0.0,
         "distribution": "The category distribution."
      }
   ],
   "phrases": [
      {
         "phrase": "The prompt phrase.",
         "category": "The prompt category.",
         "reason": "Reason the phrase was assigned to its category."
      }
   ]
}