evaluations

Creates, updates, deletes, gets or lists an evaluations resource.

Overview

Name	evaluations
Type	Resource
Id	cloudflare.ai_gateway.evaluations

Fields

The following fields are returned by SELECT queries:

get

Returns a single object if found

Name	Datatype	Description
id	string
name	string
gateway_id	string	gateway id
created_at	string (date-time)
datasets	array
modified_at	string (date-time)
processed	boolean
results	array
total_logs	number

list

List objects

Name	Datatype	Description
id	string
name	string
gateway_id	string	gateway id
created_at	string (date-time)
datasets	array
modified_at	string (date-time)
processed	boolean
results	array
total_logs	number

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, gateway_id, id		Retrieves details for a specific AI Gateway dataset.
list	select	account_id, gateway_id	page, per_page, name, processed, search	Lists all AI Gateway evaluator types configured for the account.
create	insert	gateway_id, account_id, name, dataset_ids, evaluation_type_ids		Creates a new AI Gateway.
delete	delete	account_id, gateway_id, id		Deletes an AI Gateway dataset.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
gateway_id	string	The AI Gateway ID.
id	string	Resource ID.
name	string
page	integer
per_page	integer
processed	boolean
search	string

SELECT examples

get

Retrieves details for a specific AI Gateway dataset.

SELECT
id,
name,
gateway_id,
created_at,
datasets,
modified_at,
processed,
results,
total_logs
FROM cloudflare.ai_gateway.evaluations
WHERE account_id = '{{ account_id }}' -- required
AND gateway_id = '{{ gateway_id }}' -- required
AND id = '{{ id }}' -- required
;

list

Lists all AI Gateway evaluator types configured for the account.

SELECT
id,
name,
gateway_id,
created_at,
datasets,
modified_at,
processed,
results,
total_logs
FROM cloudflare.ai_gateway.evaluations
WHERE account_id = '{{ account_id }}' -- required
AND gateway_id = '{{ gateway_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND name = '{{ name }}'
AND processed = '{{ processed }}'
AND search = '{{ search }}'
;

INSERT examples

create

Creates a new AI Gateway.

INSERT INTO cloudflare.ai_gateway.evaluations (
dataset_ids,
evaluation_type_ids,
name,
gateway_id,
account_id
)
SELECT 
'{{ dataset_ids }}' /* required */,
'{{ evaluation_type_ids }}' /* required */,
'{{ name }}' /* required */,
'{{ gateway_id }}',
'{{ account_id }}'
RETURNING
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: evaluations
props:
  - name: gateway_id
    value: "{{ gateway_id }}"
    description: Required parameter for the evaluations resource.
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the evaluations resource.
  - name: dataset_ids
    value:
      - "{{ dataset_ids }}"
  - name: evaluation_type_ids
    value:
      - "{{ evaluation_type_ids }}"
  - name: name
    value: "{{ name }}"

DELETE examples

delete

Deletes an AI Gateway dataset.

DELETE FROM cloudflare.ai_gateway.evaluations
WHERE account_id = '{{ account_id }}' --required
AND gateway_id = '{{ gateway_id }}' --required
AND id = '{{ id }}' --required
;