Change Updates

Do not miss any API changes, ever again

Subscribe to the API changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
40 structure changes including:
22 Breaking changes
7 Additions
11 Modifications
22 Removals
Modified 11 Breaking
POST /v2/files
  • Path went from /v2/files/ to /v2/files (same operationId)
  • Body
  • application/json content type Modified
    • test_uuid, answers properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • string-1, files properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • string-1, files properties Added
POST /v2/evals
  • Path went from /v2/evals/ to /v2/evals (same operationId)
  • Body
  • application/json content type Modified
    • string-1 property Modified
      • Property is no longer required
      • Type went from string to string | null
    • string-1 property Modified
      • Type went from string to string | null
    • integer-1 property Modified
      • Type went from integer to integer | null
    • array-1 property Modified
      • string-1 property Added
    • string-1, Status, string-1, string-1 properties Added
    • ground_truth property Added
      • string-1, FileReference, null-3 properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • string-1, string-1, Status properties Modified
        • Properties are no longer required
        • Type went from string to string | null
      • string-1 property Modified
        • Type went from string to string | null
      • integer-1 property Modified
        • Type went from integer to integer | null
      • array-1 property Modified
        • string-1 property Added
      • string-1, string-1 properties Modified
        • Properties are no longer required
        • Type went from string(date-time) to string(date-time) | null
      • ground_truth property Added
        • string-1, FileReference, null-3 properties Added
POST /v2/eval-runs/-/score-responses
  • Body
  • application/json content type Modified
    • array-1 property Modified
      • string-1 property Added
    • responses property Modified
      • content property Modified
        • Combinator is now anyOf
        • content alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • string-1, FileReference alternatives Added
      • generate_prompt property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • continue_thread property Added
    • boolean-1 property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • boolean-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Eval property Modified
        • string-1, string-1, Status properties Modified
          • Properties are no longer required
          • Type went from string to string | null
        • string-1 property Modified
          • Type went from string to string | null
        • integer-1 property Modified
          • Type went from integer to integer | null
        • array-1 property Modified
        • string-1, string-1 properties Modified
          • Properties are no longer required
          • Type went from string(date-time) to string(date-time) | null
        • ground_truth property Added
      • array-1 property Modified
        • content property Modified
          • Combinator is now anyOf
        • string-1 property Modified
          • Property is no longer required
          • Type went from string to string | null
        • generate_prompt, prompt properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • continue_thread property Added
      • eval_uuid, string-1 properties Added
POST /v2/eval-runs
  • Path went from /v2/eval-runs/ to /v2/eval-runs (same operationId)
  • Body
  • application/json content type Modified
    • array-1 property Modified
      • string-1 property Added
    • responses property Modified
      • content property Modified
        • Combinator is now anyOf
        • content alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • string-1, FileReference alternatives Added
      • generate_prompt property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • continue_thread property Added
    • boolean-1 property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • boolean-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Eval property Modified
        • string-1, string-1, Status properties Modified
          • Properties are no longer required
          • Type went from string to string | null
        • string-1 property Modified
          • Type went from string to string | null
        • integer-1 property Modified
          • Type went from integer to integer | null
        • array-1 property Modified
        • string-1, string-1 properties Modified
          • Properties are no longer required
          • Type went from string(date-time) to string(date-time) | null
        • ground_truth property Added
      • eval_uuid, string-1, array-1 properties Added
GET /v2/evals/{eval_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • string-1, string-1, Status properties Modified
        • Properties are no longer required
        • Type went from string to string | null
      • string-1 property Modified
        • Type went from string to string | null
      • integer-1 property Modified
        • Type went from integer to integer | null
      • array-1 property Modified
        • string-1 property Added
      • string-1, string-1 properties Modified
        • Properties are no longer required
        • Type went from string(date-time) to string(date-time) | null
      • ground_truth property Added
        • string-1, FileReference, null-3 properties Added
GET /v2/evals
  • Path went from /v2/evals/ to /v2/evals (same operationId)
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • string-1, string-1, Status properties Modified
          • Properties are no longer required
          • Type went from string to string | null
        • string-1 property Modified
          • Type went from string to string | null
        • integer-1 property Modified
          • Type went from integer to integer | null
        • array-1 property Modified
        • string-1, string-1 properties Modified
          • Properties are no longer required
          • Type went from string(date-time) to string(date-time) | null
        • ground_truth property Added
GET /v2/eval-runs
  • Path went from /v2/eval-runs/ to /v2/eval-runs (same operationId)
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • Eval property Modified
        • eval_uuid, string-1, array-1 properties Added
GET /v2/eval-runs/{eval_run_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Eval property Modified
        • string-1, string-1, Status properties Modified
          • Properties are no longer required
          • Type went from string to string | null
        • string-1 property Modified
          • Type went from string to string | null
        • integer-1 property Modified
          • Type went from integer to integer | null
        • array-1 property Modified
        • string-1, string-1 properties Modified
          • Properties are no longer required
          • Type went from string(date-time) to string(date-time) | null
        • ground_truth property Added
      • eval_uuid, string-1, array-1 properties Added
GET /v2/eval-runs/{eval_run_uuid}/responses
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • content property Modified
          • Combinator is now anyOf
        • string-1 property Modified
          • Property is no longer required
          • Type went from string to string | null
        • generate_prompt, prompt properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • continue_thread property Added
GET /v2/eval-types
  • Path went from /v2/eval-types/ to /v2/eval-types (same operationId)
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from array[object] to object
        Breaking
      • items, count properties Added
  • Query
  • limit, offset query parameters Added
GET /v2/eval-types/{eval_type_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • supported_generation_inputs property Added
Removed 22 Breaking
POST /v1/integration-test/
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v2/eval-runs/summary/{summary_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v2/eval-runs/summary/
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/tests/{test_uuid}/questions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/tests/{test_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/tests/
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/scores/{score_run_uuid}/answers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/scores/{score_run_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/scores/
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/scores/image/get-presigned-urls
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/scores/summary/
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/tests/
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/tests/multiturn/continue
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v2/eval-runs/image/get-presigned-urls
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v2/eval-runs/summary/
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/scores/summary/{summary_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/scores/summary/
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/scores/
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /v2/eval-runs/summary/{summary_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /v1/tests/{test_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /v1/scores/{score_run_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /v1/scores/summary/{summary_uuid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 7
POST /v2/files/-/uploads
POST /v2/eval-reports
GET /v2/eval-types/{eval_type_uuid}/instructions
GET /v2/eval-types/-/instructions
GET /v2/eval-reports/{report_uuid}
GET /v2/eval-reports
DELETE /v2/eval-reports/{report_uuid}