Get an evaluation (deprecated)

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

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

Retrieves an evaluation and its results. Evaluations and datasets are deprecated and unavailable to new accounts.

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

Unique identifier of the AI Gateway within the account.

maxLength64

minLength1

id string

query EvaluationGetParams

AccountID param.Field[string]

ReturnsExpand Collapse

type EvaluationGetResponse struct{…}

ID string

CreatedAt Time

formatdate-time

Datasets []EvaluationGetResponseDataset

ID string

AccountID string

AccountTag string

CreatedAt Time

formatdate-time

Enable bool

Filters []EvaluationGetResponseDatasetsFilter

Key EvaluationGetResponseDatasetsFiltersKey

One of the following:

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

One of the following:

const EvaluationGetResponseDatasetsFiltersOperatorEq EvaluationGetResponseDatasetsFiltersOperator = "eq"

const EvaluationGetResponseDatasetsFiltersOperatorContains EvaluationGetResponseDatasetsFiltersOperator = "contains"

const EvaluationGetResponseDatasetsFiltersOperatorLt EvaluationGetResponseDatasetsFiltersOperator = "lt"

const EvaluationGetResponseDatasetsFiltersOperatorGt EvaluationGetResponseDatasetsFiltersOperator = "gt"

Value []EvaluationGetResponseDatasetsFiltersValueUnion

One of the following:

UnionString

UnionFloat

UnionBool

GatewayID string

Unique identifier of the AI Gateway within the account.

maxLength64

minLength1

ModifiedAt Time

formatdate-time

Name string

GatewayID string

Unique identifier of the AI Gateway within the account.

maxLength64

minLength1

ModifiedAt Time

formatdate-time

Name string

Processed bool

Results []EvaluationGetResponseResult

ID string

CreatedAt Time

formatdate-time

EvaluationID string

EvaluationTypeID string

ModifiedAt Time

formatdate-time

Result string

Status float64

StatusDescription string

TotalLogs float64

Get an evaluation (deprecated)

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

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