{
  "opencollection": "1.0.0",
  "info": {
    "name": "OpenAI Assistants Evals API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Evals",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List evaluations for a project.\n",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.openai.com/v1/evals",
            "params": [
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Identifier for the last eval from the previous pagination request."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of evals to retrieve."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Sort order for evals by timestamp. Use `asc` for ascending order or `desc` for descending order."
              },
              {
                "name": "order_by",
                "value": "",
                "type": "query",
                "description": "Evals can be ordered by creation time or last updated time. Use\n`created_at` for creation time or `updated_at` for last updated time.\n"
              }
            ]
          },
          "docs": "List evaluations for a project.\n"
        },
        {
          "info": {
            "name": "Create the structure of an evaluation that can be used to test a model's performance.\nAn evaluation is a set of testing criteria and the config for a data source, which dictates the schema of the data used in the evaluation. After creating an evaluation, you can run it on different models and model parameters. We support several types of graders and datasources.\nFor more information, see the [Evals guide](/docs/guides/evals).\n",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/evals",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create the structure of an evaluation that can be used to test a model's performance.\nAn evaluation is a set of testing criteria and the config for a data source, which dictates the schema of the data used in the evaluation. After creating an evaluation, you can run it on different models and model parameters. We support several types of graders and datasources.\nFor more information, see the [Evals guide](/docs/guides/evals).\n"
        },
        {
          "info": {
            "name": "Get an evaluation by ID.\n",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.openai.com/v1/evals/:eval_id",
            "params": [
              {
                "name": "eval_id",
                "value": "",
                "type": "path",
                "description": "The ID of the evaluation to retrieve."
              }
            ]
          },
          "docs": "Get an evaluation by ID.\n"
        },
        {
          "info": {
            "name": "Update certain properties of an evaluation.\n",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/evals/:eval_id",
            "params": [
              {
                "name": "eval_id",
                "value": "",
                "type": "path",
                "description": "The ID of the evaluation to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update certain properties of an evaluation.\n"
        },
        {
          "info": {
            "name": "Delete an evaluation.\n",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.openai.com/v1/evals/:eval_id",
            "params": [
              {
                "name": "eval_id",
                "value": "",
                "type": "path",
                "description": "The ID of the evaluation to delete."
              }
            ]
          },
          "docs": "Delete an evaluation.\n"
        },
        {
          "info": {
            "name": "Get a list of runs for an evaluation.\n",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.openai.com/v1/evals/:eval_id/runs",
            "params": [
              {
                "name": "eval_id",
                "value": "",
                "type": "path",
                "description": "The ID of the evaluation to retrieve runs for."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Identifier for the last run from the previous pagination request."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of runs to retrieve."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Sort order for runs by timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `asc`."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter runs by status. One of `queued` | `in_progress` | `failed` | `completed` | `canceled`."
              }
            ]
          },
          "docs": "Get a list of runs for an evaluation.\n"
        },
        {
          "info": {
            "name": "Kicks off a new run for a given evaluation, specifying the data source, and what model configuration to use to test. The datasource will be validated against the schema specified in the config of the evaluation.\n",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/evals/:eval_id/runs",
            "params": [
              {
                "name": "eval_id",
                "value": "",
                "type": "path",
                "description": "The ID of the evaluation to create a run for."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Kicks off a new run for a given evaluation, specifying the data source, and what model configuration to use to test. The datasource will be validated against the schema specified in the config of the evaluation.\n"
        },
        {
          "info": {
            "name": "Get an evaluation run by ID.\n",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.openai.com/v1/evals/:eval_id/runs/:run_id",
            "params": [
              {
                "name": "eval_id",
                "value": "",
                "type": "path",
                "description": "The ID of the evaluation to retrieve runs for."
              },
              {
                "name": "run_id",
                "value": "",
                "type": "path",
                "description": "The ID of the run to retrieve."
              }
            ]
          },
          "docs": "Get an evaluation run by ID.\n"
        },
        {
          "info": {
            "name": "Cancel an ongoing evaluation run.\n",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/evals/:eval_id/runs/:run_id",
            "params": [
              {
                "name": "eval_id",
                "value": "",
                "type": "path",
                "description": "The ID of the evaluation whose run you want to cancel."
              },
              {
                "name": "run_id",
                "value": "",
                "type": "path",
                "description": "The ID of the run to cancel."
              }
            ]
          },
          "docs": "Cancel an ongoing evaluation run.\n"
        },
        {
          "info": {
            "name": "Delete an eval run.\n",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.openai.com/v1/evals/:eval_id/runs/:run_id",
            "params": [
              {
                "name": "eval_id",
                "value": "",
                "type": "path",
                "description": "The ID of the evaluation to delete the run from."
              },
              {
                "name": "run_id",
                "value": "",
                "type": "path",
                "description": "The ID of the run to delete."
              }
            ]
          },
          "docs": "Delete an eval run.\n"
        },
        {
          "info": {
            "name": "Get a list of output items for an evaluation run.\n",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.openai.com/v1/evals/:eval_id/runs/:run_id/output_items",
            "params": [
              {
                "name": "eval_id",
                "value": "",
                "type": "path",
                "description": "The ID of the evaluation to retrieve runs for."
              },
              {
                "name": "run_id",
                "value": "",
                "type": "path",
                "description": "The ID of the run to retrieve output items for."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Identifier for the last output item from the previous pagination request."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of output items to retrieve."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter output items by status. Use `failed` to filter by failed output\nitems or `pass` to filter by passed output items.\n"
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Sort order for output items by timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `asc`."
              }
            ]
          },
          "docs": "Get a list of output items for an evaluation run.\n"
        },
        {
          "info": {
            "name": "Get an evaluation run output item by ID.\n",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.openai.com/v1/evals/:eval_id/runs/:run_id/output_items/:output_item_id",
            "params": [
              {
                "name": "eval_id",
                "value": "",
                "type": "path",
                "description": "The ID of the evaluation to retrieve runs for."
              },
              {
                "name": "run_id",
                "value": "",
                "type": "path",
                "description": "The ID of the run to retrieve."
              },
              {
                "name": "output_item_id",
                "value": "",
                "type": "path",
                "description": "The ID of the output item to retrieve."
              }
            ]
          },
          "docs": "Get an evaluation run output item by ID.\n"
        }
      ]
    }
  ],
  "bundled": true
}