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.

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 Write

ParametersExpand Collapse

gatewayID string

gateway id

maxLength64

minLength1

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

ReturnsExpand Collapse

type EvaluationNewResponse struct{…}

ID string

CreatedAt Time

formatdate-time

Datasets []EvaluationNewResponseDataset

ID string

AccountID string

AccountTag string

CreatedAt Time

formatdate-time

Enable bool

Filters []EvaluationNewResponseDatasetsFilter

Key EvaluationNewResponseDatasetsFiltersKey

One of the following:

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

One of the following:

const EvaluationNewResponseDatasetsFiltersOperatorEq EvaluationNewResponseDatasetsFiltersOperator = "eq"

const EvaluationNewResponseDatasetsFiltersOperatorContains EvaluationNewResponseDatasetsFiltersOperator = "contains"

const EvaluationNewResponseDatasetsFiltersOperatorLt EvaluationNewResponseDatasetsFiltersOperator = "lt"

const EvaluationNewResponseDatasetsFiltersOperatorGt EvaluationNewResponseDatasetsFiltersOperator = "gt"

Value []EvaluationNewResponseDatasetsFiltersValueUnion

One of the following:

UnionString

UnionFloat

UnionBool

GatewayID string

gateway id

maxLength64

minLength1

ModifiedAt Time

formatdate-time

Name string

GatewayID string

gateway id

maxLength64

minLength1

ModifiedAt Time

formatdate-time

Name string

Processed bool

Results []EvaluationNewResponseResult

ID string

CreatedAt Time

formatdate-time

EvaluationID string

EvaluationTypeID string

ModifiedAt Time

formatdate-time

Result string

Status float64

StatusDescription string

TotalLogs float64

Create a new Evaluation

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)
}

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