{
"version_timestamp": "2024-12-19T20:33:15.971617Z",
"heatmap_timestamp": "2024-12-19T20:33:15.971617Z",
"summary": {
"overall_feedback": "Overall feedback for the heatmap analysis."
},
"phrases": [
{
"phrase": "The prompt phrase.",
"attention_score": 1,
"color": "The color level assigned to the phrase.",
"reason": "The reason why the AI model assigned the phrase its attention score."
}
]
}
Zatomic API
- Overview
- Versioning
- Authentication
- Workspaces
- Status Codes and Errors
- Token Usage
- Expanding Objects
- OpenAPI Spec
- Prompts
- The Prompt Object
- Create Prompt
- Update Prompt
- Delete Prompt
- Retrieve Prompt
- Retrieve All Prompts
- Generate Prompt
- Versions
- The Version Object
- Create Version
- Update Version
- Delete Version
- Retrieve Version
- Retrieve All Versions
- Calculate Version Score
- Retrieve Version Score
- Analyze Version Risk
- Retrieve Version Risk
- Analyze Version Balance
- Retrieve Version Balance
- Generate Version Heatmap
- Retrieve Version Heatmap
- Improve Version
- Scoring Criteria
- The Scoring Criteria Object
- The Scoring Criterion Object
- Create Scoring Criteria
- Update Scoring Criteria
- Delete Scoring Sriteria
- Retrieve Scoring Criteria
- Retrieve All Scoring Criteria
- Generate Scoring Criteria
- Create Scoring Criterion
- Update Scoring Criterion
- Delete Scoring Criterion
- Retrieve Scoring Criterion
- Scoring Criteria Results
- The Scoring Criteria Results Object
- Scoring
- The Scoring Object
- Calculate Prompt Score
- Risk
- The Risk Object
- Analyze Prompt Risk
- Balance
- The Balance Object
- Analyze Prompt Balance
- Heatmaps
- The Heatmap Object
- Generate Prompt Heatmap
The Heatmap Object
NOTE: When generating heatmaps of prompts stored outside of Zatomic, the version_timestamp and heatmap_timestamp properties will both be null.
Properties | |||||||||
---|---|---|---|---|---|---|---|---|---|
version_timestamp
datetime, nullable
|
The timestamp of the prompt version used to generate the heatmap. | ||||||||
heatmap_timestamp
datetime, nullable
|
The timestamp for when the heatmap was generated. | ||||||||
summary
object
|
Properties of the summary object:
|
||||||||
phrases
list of objects
|
Properties of the phrases object:
|
The Heatmap Object