POST https://api.zatomic.ai/v1/prompts/scoring/criteria
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
Create Scoring Criteria
Creating new scoring criteria requires a name and at least 1 criterion in the criterion_set. For each criterion given, all fields are required.
Endpoint
Endpoint Request
Request Properties | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
name
string
|
The criteria name. | ||||||||||
use_case
string, optional
|
The use case for the criteria. | ||||||||||
criterion_set
list of criterion objects
|
Properties for the criterion object:
|
Request Body
{
"name": "Criteria name",
"use_case": "The criteria use case.",
"criterion_set": [
{
"slug": "criterion_slug",
"label": "The label of the criterion.",
"description": "The criterion description.",
"questions": "The question or questions the criterion is trying to answer.",
"weight": 0
}
]
}
Endpoint Response
A successful call returns a 201 status code with a response that contains the scoring criteria object.