List Evaluations

client.aiGateway.evaluations.list(, , ?): V4PagePaginationArray<EvaluationListResponse { id, created_at, datasets, 6 more } >

GET/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations

Lists all AI Gateway evaluator types configured for the account.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

AI Gateway WriteAI Gateway Read

ParametersExpand Collapse

gatewayId: string

gateway id

maxLength64

minLength1

params: EvaluationListParams { account_id, name, page, 3 more }

account_id: string

Path param

name?: string

Query param

page?: number

Query param

minimum1

per_page?: number

Query param

maximum100

minimum1

processed?: boolean

Query param

search?: string

Query param: Search by id, name

ReturnsExpand Collapse

EvaluationListResponse { id, created_at, datasets, 6 more }

id: string

created_at: string

formatdate-time

datasets: Array<Dataset>

id: string

account_id: string

account_tag: string

created_at: string

formatdate-time

enable: boolean

filters: Array<Filter>

key: "created_at" | "request_content_type" | "response_content_type" | 10 more

One of the following:

"created_at"

"request_content_type"

"response_content_type"

"success"

"cached"

"provider"

"model"

"cost"

"tokens"

"tokens_in"

"tokens_out"

"duration"

"feedback"

operator: "eq" | "contains" | "lt" | "gt"

One of the following:

"eq"

"contains"

"lt"

"gt"

value: Array<string | number | boolean>

One of the following:

string

number

boolean

gateway_id: string

gateway id

maxLength64

minLength1

modified_at: string

formatdate-time

name: string

gateway_id: string

gateway id

maxLength64

minLength1

modified_at: string

formatdate-time

name: string

processed: boolean

results: Array<Result>

id: string

created_at: string

formatdate-time

evaluation_id: string

evaluation_type_id: string

modified_at: string

formatdate-time

result: string

status: number

status_description: string

total_logs: number

List Evaluations

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const evaluationListResponse of client.aiGateway.evaluations.list('my-gateway', {
  account_id: '3ebbcb006d4d46d7bb6a8c7f14676cb0',
})) {
  console.log(evaluationListResponse.id);
}

{
  "result": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "datasets": [
        {
          "id": "id",
          "account_id": "account_id",
          "account_tag": "account_tag",
          "created_at": "2019-12-27T18:11:19.117Z",
          "enable": true,
          "filters": [
            {
              "key": "created_at",
              "operator": "eq",
              "value": [
                "string"
              ]
            }
          ],
          "gateway_id": "my-gateway",
          "modified_at": "2019-12-27T18:11:19.117Z",
          "name": "name"
        }
      ],
      "gateway_id": "my-gateway",
      "modified_at": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "processed": true,
      "results": [
        {
          "id": "id",
          "created_at": "2019-12-27T18:11:19.117Z",
          "evaluation_id": "evaluation_id",
          "evaluation_type_id": "evaluation_type_id",
          "modified_at": "2019-12-27T18:11:19.117Z",
          "result": "result",
          "status": 0,
          "status_description": "status_description",
          "total_logs": 0
        }
      ],
      "total_logs": 0
    }
  ],
  "success": true
}

Returns Examples

{
  "result": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "datasets": [
        {
          "id": "id",
          "account_id": "account_id",
          "account_tag": "account_tag",
          "created_at": "2019-12-27T18:11:19.117Z",
          "enable": true,
          "filters": [
            {
              "key": "created_at",
              "operator": "eq",
              "value": [
                "string"
              ]
            }
          ],
          "gateway_id": "my-gateway",
          "modified_at": "2019-12-27T18:11:19.117Z",
          "name": "name"
        }
      ],
      "gateway_id": "my-gateway",
      "modified_at": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "processed": true,
      "results": [
        {
          "id": "id",
          "created_at": "2019-12-27T18:11:19.117Z",
          "evaluation_id": "evaluation_id",
          "evaluation_type_id": "evaluation_type_id",
          "modified_at": "2019-12-27T18:11:19.117Z",
          "result": "result",
          "status": 0,
          "status_description": "status_description",
          "total_logs": 0
        }
      ],
      "total_logs": 0
    }
  ],
  "success": true
}