# Evaluations

## List Evaluations

`client.AIGateway.Evaluations.List(ctx, gatewayID, params) (*V4PagePaginationArray[EvaluationListResponse], error)`

**get** `/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations`

Lists all AI Gateway evaluator types configured for the account.

### Parameters

- `gatewayID string`

  gateway id

- `params EvaluationListParams`

  - `AccountID param.Field[string]`

    Path param

  - `Name param.Field[string]`

    Query param

  - `Page param.Field[int64]`

    Query param

  - `PerPage param.Field[int64]`

    Query param

  - `Processed param.Field[bool]`

    Query param

  - `Search param.Field[string]`

    Query param: Search by id, name

### Returns

- `type EvaluationListResponse struct{…}`

  - `ID string`

  - `CreatedAt Time`

  - `Datasets []EvaluationListResponseDataset`

    - `ID string`

    - `AccountID string`

    - `AccountTag string`

    - `CreatedAt Time`

    - `Enable bool`

    - `Filters []EvaluationListResponseDatasetsFilter`

      - `Key EvaluationListResponseDatasetsFiltersKey`

        - `const EvaluationListResponseDatasetsFiltersKeyCreatedAt EvaluationListResponseDatasetsFiltersKey = "created_at"`

        - `const EvaluationListResponseDatasetsFiltersKeyRequestContentType EvaluationListResponseDatasetsFiltersKey = "request_content_type"`

        - `const EvaluationListResponseDatasetsFiltersKeyResponseContentType EvaluationListResponseDatasetsFiltersKey = "response_content_type"`

        - `const EvaluationListResponseDatasetsFiltersKeySuccess EvaluationListResponseDatasetsFiltersKey = "success"`

        - `const EvaluationListResponseDatasetsFiltersKeyCached EvaluationListResponseDatasetsFiltersKey = "cached"`

        - `const EvaluationListResponseDatasetsFiltersKeyProvider EvaluationListResponseDatasetsFiltersKey = "provider"`

        - `const EvaluationListResponseDatasetsFiltersKeyModel EvaluationListResponseDatasetsFiltersKey = "model"`

        - `const EvaluationListResponseDatasetsFiltersKeyCost EvaluationListResponseDatasetsFiltersKey = "cost"`

        - `const EvaluationListResponseDatasetsFiltersKeyTokens EvaluationListResponseDatasetsFiltersKey = "tokens"`

        - `const EvaluationListResponseDatasetsFiltersKeyTokensIn EvaluationListResponseDatasetsFiltersKey = "tokens_in"`

        - `const EvaluationListResponseDatasetsFiltersKeyTokensOut EvaluationListResponseDatasetsFiltersKey = "tokens_out"`

        - `const EvaluationListResponseDatasetsFiltersKeyDuration EvaluationListResponseDatasetsFiltersKey = "duration"`

        - `const EvaluationListResponseDatasetsFiltersKeyFeedback EvaluationListResponseDatasetsFiltersKey = "feedback"`

      - `Operator EvaluationListResponseDatasetsFiltersOperator`

        - `const EvaluationListResponseDatasetsFiltersOperatorEq EvaluationListResponseDatasetsFiltersOperator = "eq"`

        - `const EvaluationListResponseDatasetsFiltersOperatorContains EvaluationListResponseDatasetsFiltersOperator = "contains"`

        - `const EvaluationListResponseDatasetsFiltersOperatorLt EvaluationListResponseDatasetsFiltersOperator = "lt"`

        - `const EvaluationListResponseDatasetsFiltersOperatorGt EvaluationListResponseDatasetsFiltersOperator = "gt"`

      - `Value []EvaluationListResponseDatasetsFiltersValueUnion`

        - `UnionString`

        - `UnionFloat`

        - `UnionBool`

    - `GatewayID string`

      gateway id

    - `ModifiedAt Time`

    - `Name string`

  - `GatewayID string`

    gateway id

  - `ModifiedAt Time`

  - `Name string`

  - `Processed bool`

  - `Results []EvaluationListResponseResult`

    - `ID string`

    - `CreatedAt Time`

    - `EvaluationID string`

    - `EvaluationTypeID string`

    - `ModifiedAt Time`

    - `Result string`

    - `Status float64`

    - `StatusDescription string`

    - `TotalLogs float64`

  - `TotalLogs float64`

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/ai_gateway"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.AIGateway.Evaluations.List(
    context.TODO(),
    "my-gateway",
    ai_gateway.EvaluationListParams{
      AccountID: cloudflare.F("3ebbcb006d4d46d7bb6a8c7f14676cb0"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}
```

#### Response

```json
{
  "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
}
```

## Fetch a Evaluation

`client.AIGateway.Evaluations.Get(ctx, gatewayID, id, query) (*EvaluationGetResponse, error)`

**get** `/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations/{id}`

Retrieves details for a specific AI Gateway dataset.

### Parameters

- `gatewayID string`

  gateway id

- `id string`

- `query EvaluationGetParams`

  - `AccountID param.Field[string]`

### Returns

- `type EvaluationGetResponse struct{…}`

  - `ID string`

  - `CreatedAt Time`

  - `Datasets []EvaluationGetResponseDataset`

    - `ID string`

    - `AccountID string`

    - `AccountTag string`

    - `CreatedAt Time`

    - `Enable bool`

    - `Filters []EvaluationGetResponseDatasetsFilter`

      - `Key EvaluationGetResponseDatasetsFiltersKey`

        - `const EvaluationGetResponseDatasetsFiltersKeyCreatedAt EvaluationGetResponseDatasetsFiltersKey = "created_at"`

        - `const EvaluationGetResponseDatasetsFiltersKeyRequestContentType EvaluationGetResponseDatasetsFiltersKey = "request_content_type"`

        - `const EvaluationGetResponseDatasetsFiltersKeyResponseContentType EvaluationGetResponseDatasetsFiltersKey = "response_content_type"`

        - `const EvaluationGetResponseDatasetsFiltersKeySuccess EvaluationGetResponseDatasetsFiltersKey = "success"`

        - `const EvaluationGetResponseDatasetsFiltersKeyCached EvaluationGetResponseDatasetsFiltersKey = "cached"`

        - `const EvaluationGetResponseDatasetsFiltersKeyProvider EvaluationGetResponseDatasetsFiltersKey = "provider"`

        - `const EvaluationGetResponseDatasetsFiltersKeyModel EvaluationGetResponseDatasetsFiltersKey = "model"`

        - `const EvaluationGetResponseDatasetsFiltersKeyCost EvaluationGetResponseDatasetsFiltersKey = "cost"`

        - `const EvaluationGetResponseDatasetsFiltersKeyTokens EvaluationGetResponseDatasetsFiltersKey = "tokens"`

        - `const EvaluationGetResponseDatasetsFiltersKeyTokensIn EvaluationGetResponseDatasetsFiltersKey = "tokens_in"`

        - `const EvaluationGetResponseDatasetsFiltersKeyTokensOut EvaluationGetResponseDatasetsFiltersKey = "tokens_out"`

        - `const EvaluationGetResponseDatasetsFiltersKeyDuration EvaluationGetResponseDatasetsFiltersKey = "duration"`

        - `const EvaluationGetResponseDatasetsFiltersKeyFeedback EvaluationGetResponseDatasetsFiltersKey = "feedback"`

      - `Operator EvaluationGetResponseDatasetsFiltersOperator`

        - `const EvaluationGetResponseDatasetsFiltersOperatorEq EvaluationGetResponseDatasetsFiltersOperator = "eq"`

        - `const EvaluationGetResponseDatasetsFiltersOperatorContains EvaluationGetResponseDatasetsFiltersOperator = "contains"`

        - `const EvaluationGetResponseDatasetsFiltersOperatorLt EvaluationGetResponseDatasetsFiltersOperator = "lt"`

        - `const EvaluationGetResponseDatasetsFiltersOperatorGt EvaluationGetResponseDatasetsFiltersOperator = "gt"`

      - `Value []EvaluationGetResponseDatasetsFiltersValueUnion`

        - `UnionString`

        - `UnionFloat`

        - `UnionBool`

    - `GatewayID string`

      gateway id

    - `ModifiedAt Time`

    - `Name string`

  - `GatewayID string`

    gateway id

  - `ModifiedAt Time`

  - `Name string`

  - `Processed bool`

  - `Results []EvaluationGetResponseResult`

    - `ID string`

    - `CreatedAt Time`

    - `EvaluationID string`

    - `EvaluationTypeID string`

    - `ModifiedAt Time`

    - `Result string`

    - `Status float64`

    - `StatusDescription string`

    - `TotalLogs float64`

  - `TotalLogs float64`

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/ai_gateway"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  evaluation, err := client.AIGateway.Evaluations.Get(
    context.TODO(),
    "my-gateway",
    "id",
    ai_gateway.EvaluationGetParams{
      AccountID: cloudflare.F("3ebbcb006d4d46d7bb6a8c7f14676cb0"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", evaluation.ID)
}
```

#### Response

```json
{
  "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
}
```

## Create a new Evaluation

`client.AIGateway.Evaluations.New(ctx, gatewayID, params) (*EvaluationNewResponse, error)`

**post** `/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations`

Creates a new AI Gateway.

### Parameters

- `gatewayID string`

  gateway id

- `params EvaluationNewParams`

  - `AccountID param.Field[string]`

    Path param

  - `DatasetIDs param.Field[[]string]`

    Body param

  - `EvaluationTypeIDs param.Field[[]string]`

    Body param

  - `Name param.Field[string]`

    Body param

### Returns

- `type EvaluationNewResponse struct{…}`

  - `ID string`

  - `CreatedAt Time`

  - `Datasets []EvaluationNewResponseDataset`

    - `ID string`

    - `AccountID string`

    - `AccountTag string`

    - `CreatedAt Time`

    - `Enable bool`

    - `Filters []EvaluationNewResponseDatasetsFilter`

      - `Key EvaluationNewResponseDatasetsFiltersKey`

        - `const EvaluationNewResponseDatasetsFiltersKeyCreatedAt EvaluationNewResponseDatasetsFiltersKey = "created_at"`

        - `const EvaluationNewResponseDatasetsFiltersKeyRequestContentType EvaluationNewResponseDatasetsFiltersKey = "request_content_type"`

        - `const EvaluationNewResponseDatasetsFiltersKeyResponseContentType EvaluationNewResponseDatasetsFiltersKey = "response_content_type"`

        - `const EvaluationNewResponseDatasetsFiltersKeySuccess EvaluationNewResponseDatasetsFiltersKey = "success"`

        - `const EvaluationNewResponseDatasetsFiltersKeyCached EvaluationNewResponseDatasetsFiltersKey = "cached"`

        - `const EvaluationNewResponseDatasetsFiltersKeyProvider EvaluationNewResponseDatasetsFiltersKey = "provider"`

        - `const EvaluationNewResponseDatasetsFiltersKeyModel EvaluationNewResponseDatasetsFiltersKey = "model"`

        - `const EvaluationNewResponseDatasetsFiltersKeyCost EvaluationNewResponseDatasetsFiltersKey = "cost"`

        - `const EvaluationNewResponseDatasetsFiltersKeyTokens EvaluationNewResponseDatasetsFiltersKey = "tokens"`

        - `const EvaluationNewResponseDatasetsFiltersKeyTokensIn EvaluationNewResponseDatasetsFiltersKey = "tokens_in"`

        - `const EvaluationNewResponseDatasetsFiltersKeyTokensOut EvaluationNewResponseDatasetsFiltersKey = "tokens_out"`

        - `const EvaluationNewResponseDatasetsFiltersKeyDuration EvaluationNewResponseDatasetsFiltersKey = "duration"`

        - `const EvaluationNewResponseDatasetsFiltersKeyFeedback EvaluationNewResponseDatasetsFiltersKey = "feedback"`

      - `Operator EvaluationNewResponseDatasetsFiltersOperator`

        - `const EvaluationNewResponseDatasetsFiltersOperatorEq EvaluationNewResponseDatasetsFiltersOperator = "eq"`

        - `const EvaluationNewResponseDatasetsFiltersOperatorContains EvaluationNewResponseDatasetsFiltersOperator = "contains"`

        - `const EvaluationNewResponseDatasetsFiltersOperatorLt EvaluationNewResponseDatasetsFiltersOperator = "lt"`

        - `const EvaluationNewResponseDatasetsFiltersOperatorGt EvaluationNewResponseDatasetsFiltersOperator = "gt"`

      - `Value []EvaluationNewResponseDatasetsFiltersValueUnion`

        - `UnionString`

        - `UnionFloat`

        - `UnionBool`

    - `GatewayID string`

      gateway id

    - `ModifiedAt Time`

    - `Name string`

  - `GatewayID string`

    gateway id

  - `ModifiedAt Time`

  - `Name string`

  - `Processed bool`

  - `Results []EvaluationNewResponseResult`

    - `ID string`

    - `CreatedAt Time`

    - `EvaluationID string`

    - `EvaluationTypeID string`

    - `ModifiedAt Time`

    - `Result string`

    - `Status float64`

    - `StatusDescription string`

    - `TotalLogs float64`

  - `TotalLogs float64`

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/ai_gateway"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  evaluation, err := client.AIGateway.Evaluations.New(
    context.TODO(),
    "my-gateway",
    ai_gateway.EvaluationNewParams{
      AccountID: cloudflare.F("3ebbcb006d4d46d7bb6a8c7f14676cb0"),
      DatasetIDs: cloudflare.F([]string{"string"}),
      EvaluationTypeIDs: cloudflare.F([]string{"string"}),
      Name: cloudflare.F("name"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", evaluation.ID)
}
```

#### Response

```json
{
  "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
}
```

## Delete a Evaluation

`client.AIGateway.Evaluations.Delete(ctx, gatewayID, id, body) (*EvaluationDeleteResponse, error)`

**delete** `/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations/{id}`

Deletes an AI Gateway dataset.

### Parameters

- `gatewayID string`

  gateway id

- `id string`

- `body EvaluationDeleteParams`

  - `AccountID param.Field[string]`

### Returns

- `type EvaluationDeleteResponse struct{…}`

  - `ID string`

  - `CreatedAt Time`

  - `Datasets []EvaluationDeleteResponseDataset`

    - `ID string`

    - `AccountID string`

    - `AccountTag string`

    - `CreatedAt Time`

    - `Enable bool`

    - `Filters []EvaluationDeleteResponseDatasetsFilter`

      - `Key EvaluationDeleteResponseDatasetsFiltersKey`

        - `const EvaluationDeleteResponseDatasetsFiltersKeyCreatedAt EvaluationDeleteResponseDatasetsFiltersKey = "created_at"`

        - `const EvaluationDeleteResponseDatasetsFiltersKeyRequestContentType EvaluationDeleteResponseDatasetsFiltersKey = "request_content_type"`

        - `const EvaluationDeleteResponseDatasetsFiltersKeyResponseContentType EvaluationDeleteResponseDatasetsFiltersKey = "response_content_type"`

        - `const EvaluationDeleteResponseDatasetsFiltersKeySuccess EvaluationDeleteResponseDatasetsFiltersKey = "success"`

        - `const EvaluationDeleteResponseDatasetsFiltersKeyCached EvaluationDeleteResponseDatasetsFiltersKey = "cached"`

        - `const EvaluationDeleteResponseDatasetsFiltersKeyProvider EvaluationDeleteResponseDatasetsFiltersKey = "provider"`

        - `const EvaluationDeleteResponseDatasetsFiltersKeyModel EvaluationDeleteResponseDatasetsFiltersKey = "model"`

        - `const EvaluationDeleteResponseDatasetsFiltersKeyCost EvaluationDeleteResponseDatasetsFiltersKey = "cost"`

        - `const EvaluationDeleteResponseDatasetsFiltersKeyTokens EvaluationDeleteResponseDatasetsFiltersKey = "tokens"`

        - `const EvaluationDeleteResponseDatasetsFiltersKeyTokensIn EvaluationDeleteResponseDatasetsFiltersKey = "tokens_in"`

        - `const EvaluationDeleteResponseDatasetsFiltersKeyTokensOut EvaluationDeleteResponseDatasetsFiltersKey = "tokens_out"`

        - `const EvaluationDeleteResponseDatasetsFiltersKeyDuration EvaluationDeleteResponseDatasetsFiltersKey = "duration"`

        - `const EvaluationDeleteResponseDatasetsFiltersKeyFeedback EvaluationDeleteResponseDatasetsFiltersKey = "feedback"`

      - `Operator EvaluationDeleteResponseDatasetsFiltersOperator`

        - `const EvaluationDeleteResponseDatasetsFiltersOperatorEq EvaluationDeleteResponseDatasetsFiltersOperator = "eq"`

        - `const EvaluationDeleteResponseDatasetsFiltersOperatorContains EvaluationDeleteResponseDatasetsFiltersOperator = "contains"`

        - `const EvaluationDeleteResponseDatasetsFiltersOperatorLt EvaluationDeleteResponseDatasetsFiltersOperator = "lt"`

        - `const EvaluationDeleteResponseDatasetsFiltersOperatorGt EvaluationDeleteResponseDatasetsFiltersOperator = "gt"`

      - `Value []EvaluationDeleteResponseDatasetsFiltersValueUnion`

        - `UnionString`

        - `UnionFloat`

        - `UnionBool`

    - `GatewayID string`

      gateway id

    - `ModifiedAt Time`

    - `Name string`

  - `GatewayID string`

    gateway id

  - `ModifiedAt Time`

  - `Name string`

  - `Processed bool`

  - `Results []EvaluationDeleteResponseResult`

    - `ID string`

    - `CreatedAt Time`

    - `EvaluationID string`

    - `EvaluationTypeID string`

    - `ModifiedAt Time`

    - `Result string`

    - `Status float64`

    - `StatusDescription string`

    - `TotalLogs float64`

  - `TotalLogs float64`

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/ai_gateway"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  evaluation, err := client.AIGateway.Evaluations.Delete(
    context.TODO(),
    "my-gateway",
    "id",
    ai_gateway.EvaluationDeleteParams{
      AccountID: cloudflare.F("3ebbcb006d4d46d7bb6a8c7f14676cb0"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", evaluation.ID)
}
```

#### Response

```json
{
  "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
}
```