Skip to content
Overmind
Get started
API Reference
Jobs

List jobs

jobs.list(JobListParams**kwargs) -> JobListResponse
GET/api/jobs/

List jobs

ParametersExpand Collapse
agent: Optional[str]
formatuuid
analyzer_model: Optional[str]
created_after: Optional[Union[str, datetime]]
formatdate-time
created_before: Optional[Union[str, datetime]]
formatdate-time
data_source: Optional[str]
job_type: Optional[Literal["inference", "judge_scoring", "model_backtesting", 2 more]]
  • inference - Inference
  • uploaded_outputs_setup - Uploaded Outputs Setup
  • judge_scoring - Judge Scoring
  • prompt_tuning - Prompt Tuning
  • model_backtesting - Model Backtesting
Accepts one of the following:
"inference"
"judge_scoring"
"model_backtesting"
"prompt_tuning"
"uploaded_outputs_setup"
ordering: Optional[str]

Which field to use when ordering the results.

page: Optional[int]

A page number within the paginated result set.

project: Optional[str]
formatuuid
prompt_slug: Optional[str]
score_max: Optional[float]
formatfloat
score_min: Optional[float]
formatfloat
status: Optional[Literal["cancelled", "completed", "failed", 2 more]]
  • pending - Pending
  • running - Running
  • completed - Completed
  • failed - Failed
  • cancelled - Cancelled
Accepts one of the following:
"cancelled"
"completed"
"failed"
"pending"
"running"
ReturnsExpand Collapse
class JobListResponse: …
count: int
results: List[Result]
id: str
formatuuid
created_at: datetime
formatdate-time
updated_at: datetime
formatdate-time
agent: Optional[str]
formatuuid
analyzer_model: Optional[str]
maxLength128
baseline_score: Optional[float]
formatdouble
best_score: Optional[float]
formatdouble
improvement: Optional[float]
formatdouble
job_type: Optional[Literal["inference", "uploaded_outputs_setup", "judge_scoring", 2 more]]
  • inference - Inference
  • uploaded_outputs_setup - Uploaded Outputs Setup
  • judge_scoring - Judge Scoring
  • prompt_tuning - Prompt Tuning
  • model_backtesting - Model Backtesting
Accepts one of the following:
"inference"
"uploaded_outputs_setup"
"judge_scoring"
"prompt_tuning"
"model_backtesting"
num_iterations: Optional[int]
maximum9223372036854776000
minimum-9223372036854776000
formatint64
project: Optional[str]
formatuuid
prompt_slug: Optional[str]
maxLength255
status: Optional[Literal["pending", "running", "completed", 2 more]]
  • pending - Pending
  • running - Running
  • completed - Completed
  • failed - Failed
  • cancelled - Cancelled
Accepts one of the following:
"pending"
"running"
"completed"
"failed"
"cancelled"
List jobs
from overmind_lab import OvermindLab

client = OvermindLab()
jobs = client.jobs.list()
print(jobs.count)
{
  "count": 123,
  "results": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "agent": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "analyzer_model": "analyzer_model",
      "baseline_score": 0,
      "best_score": 0,
      "improvement": 0,
      "job_type": "inference",
      "num_iterations": -9007199254740991,
      "project": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "prompt_slug": "prompt_slug",
      "status": "pending"
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}
Returns Examples
{
  "count": 123,
  "results": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "agent": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "analyzer_model": "analyzer_model",
      "baseline_score": 0,
      "best_score": 0,
      "improvement": 0,
      "job_type": "inference",
      "num_iterations": -9007199254740991,
      "project": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "prompt_slug": "prompt_slug",
      "status": "pending"
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}