Update job

Replace an existing prompt optimization job with a new, modified job.

PATCH /api/v1/repos/{owner}/{repo}/optimization-jobs/{job_id}

Error

A valid request URL is required to generate request examples

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "repo_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "config": {
    "message_index": 123,
    "task_description": "<string>",
    "dataset_name": "<string>",
    "train_split": "<string>",
    "dev_split": "<string>",
    "test_split": "<string>",
    "evaluators": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "num_epochs": 123,
    "auto_commit": true
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "results": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "x": 123,
      "y": 123
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Path Parameters

job_id · string<uuid> · required

Body

application/json

status · enum<string> | null

Available options: created, running, successful, failed

result · PromptOptimizationResult · object | null

Show child attributes

Response

200

application/json

Successful Response

id · string<uuid> · required

repo_id · string<uuid> · required

status · enum<string> · required

Available options: created, running, successful, failed

tenant_id · string<uuid> · required

algorithm · enum<string> · required

Available options: promptim, demo

config · PromptimConfig · object · required

PromptimConfig

DemoConfig

Show child attributes

created_at · string<date-time> · required

updated_at · string<date-time> · required

results · PromptOptimizationResult · object[]

Show child attributes