Get Benchmark Status
Benchmark
Get Benchmark Status
Get the status of a benchmark generation task.
This endpoint retrieves the current status and details of a benchmark generation task. Use this to track the progress of benchmark generation initiated by the create endpoint.
Path Parameters:
id: Unique identifier returned from the create endpoint
Returns:
id: unique identifierbenchmark_name: Generated name for the benchmarkstatus: status (pendingwhile running,completedwhen finished)start_time: Timestamp when task was createdend_time: Timestamp when task completed (null if still pending)
Raises:
404: If benchmark task not found or documents not found for the task
Example Request:
GET /api/v3/benchmark/status/task-abc123
Headers: {"Authorization": "Bearer <api_key>"}
Example Response:
{
"id": "task-abc123",
"benchmark_name": "Benchmark_doc-123",
"status": "completed",
"start_time": "2024-01-15T10:30:00Z",
"end_time": "2024-01-15T10:32:45Z",
}
Notes:
- Status remains
pendingwhile the generation process is running - Status changes to
completedonce all questions are generated
GET
Get Benchmark Status
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Get the status of a benchmark generation task, including current progress, associated documents, and timestamps for task creation and completion
Benchmark id
Example:
"benchmark-123"
Name of the benchmark
Example:
"Customer Support Q&A"
Benchmark status
Available options:
pending, completed, deploying, evaluating, undeployed, evaluated, failed Example:
"pending"
Benchmark generation start time
Example:
"2024-01-15T10:30:00Z"
Benchmark generation end time
Example:
"2024-01-15T12:30:00Z"