POST
/
v1
/
evals
/
{evaluation_id}
/
iterations
/
create
curl --request POST \
  --url https://api.uiform.com/v1/evals/{evaluation_id}/iterations/create \
  --header 'Content-Type: application/json' \
  --data '{
  "inference_settings": {
    "model": "gpt-4o-mini",
    "temperature": 0,
    "modality": "native",
    "reasoning_effort": "low",
    "image_resolution_dpi": 96,
    "browser_canvas": "A4",
    "n_consensus": 1
  },
  "json_schema": {}
}'
{
  "id": "<string>",
  "inference_settings": {
    "model": "gpt-4o-mini",
    "temperature": 0,
    "modality": "native",
    "reasoning_effort": "low",
    "image_resolution_dpi": 96,
    "browser_canvas": "A4",
    "n_consensus": 1
  },
  "json_schema": {},
  "predictions": [
    {
      "prediction": {},
      "metadata": {
        "extraction_id": "<string>",
        "likelihoods": {},
        "field_locations": {},
        "agentic_field_locations": {},
        "consensus_details": [
          {}
        ],
        "api_cost": {
          "value": 123,
          "currency": "<string>"
        }
      }
    }
  ],
  "metric_results": {
    "item_metrics": [
      {
        "id": "<string>",
        "name": "<string>",
        "similarity": 123,
        "similarities": {},
        "flat_similarities": {},
        "aligned_similarity": 123,
        "aligned_similarities": {},
        "aligned_flat_similarities": {}
      }
    ],
    "mean_similarity": 123,
    "aligned_mean_similarity": 123,
    "metric_type": "levenshtein"
  },
  "schema_data_id": "<string>",
  "schema_id": "<string>"
}

Authorizations

Api-Key
string
header
required

Path Parameters

evaluation_id
string
required

Body

application/json

Request model for performing a new iteration with custom inference settings and optional JSON schema.

Response

200
application/json

Successful Response

The response is of type object.