Evals

Update an Evaluator

Changed on

Update an evaluator by ID with the provided fields.

patch/v2/evaluators/{id}

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/evaluators/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Request body

typestring

Evaluator type. Optional on update — inferred from existing evaluator.

pathstring

Legacy alternative to project_id. Project path. Optional on update — the evaluator keeps its current project when both are omitted. Mutually exclusive with project_id.

project_idstring

Unique identifier of the project that owns the evaluator, as returned by GET /v2/projects. Optional on update — the evaluator keeps its current project when omitted; supplying a different id moves it. Mutually exclusive with path.

keystring
descriptionstring
promptstring
output_typestring
categoriesstring[] nullable
dataset_idstring nullable
repetitionsnumber
mode'single' | 'jury'
modelstring
schemastring
urlstring
methodstring
headersobject
payloadobject
codestring
versionIncrement'major' | 'minor' | 'patch'
versionDescriptionstring

Example request

{
  "path": "Default",
  "project_id": "01JMDPA3QW5C1V0NJ1PW34T4E5"
}

Response

Successfully updated an eval

OR
OR
OR
OR
OR
OR

Changes

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status