Skip to the content

Read a label

GET /v1/prompt-eval-suites/{prompt_eval_suite_id}/labels/{label_id}

Property	Value
Operation	`get_prompt_eval_label`
Group	Prompt evaluations and experiments
Scope	`prompts:read`
Route class	`read`
Idempotency	No `Idempotency-Key`
Audit	Not audited: A metadata read; a label or a calibration holds ids, keys, verdict values and rates, never Call content.
Released in	1.63.0
Phase 0 host	Served (the hosted api pins 1.65.0)

Answers one label of the suite (1.63.0).

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the prompts:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/prompt-eval-suites/pes_.../labels/pel_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/prompt-eval-suites/pes_.../labels/pel_...`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/prompt-eval-suites/pes_.../labels/pel_...",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Name	In	Type	Required	Description
`prompt_eval_suite_id`	path	PromptEvalSuiteId	yes	The id of an evaluation suite: `pes_` and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
`label_id`	path	PromptEvalLabelId	yes	The id of a human label on one verdict of an evaluation run (1.63.0): `pel_` and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.

Responses

Status	Content type	Shape	Error codes
`200`	`application/json`	PromptEvalLabel
`400`	`application/json`	ErrorEnvelope	`invalid_request`
`401`	`application/json`	ErrorEnvelope	`unauthenticated`
`403`	`application/json`	ErrorEnvelope	`forbidden`
`404`	`application/json`	ErrorEnvelope	`not_found`
`429`	`application/json`	ErrorEnvelope	`rate_limited`
`500`	`application/json`	ErrorEnvelope	`internal_error`

Fields of the `200` answer

The shape is PromptEvalLabel.

Field	Type	Required	Description
`arm`	PromptEvalArm	yes
`calibration_id`	PromptEvalCalibrationId	yes
`call_id`	CallId	yes	The evaluation Call whose transcript was labelled.
`created_at`	Timestamp	yes
`created_by`	ActorRef	yes
`entry_index`	integer	yes	The sample entry it labels.
`id`	PromptEvalLabelId	yes
`items`	array of PromptEvalLabelItem	yes
`object`	`"prompt_eval_label"`	yes
`repetition`	integer	yes
`run_id`	PromptEvalRunId	yes
`scenario_id`	PromptEvalScenarioId	yes
`scenario_revision`	integer	yes
`suite_id`	PromptEvalSuiteId	yes