evaluation_rules

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

Overview

Name	evaluation_rules
Type	Resource
Id	azure.ai_evaluation.evaluation_rules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Unique identifier for the evaluation rule. Required.
action	object	Definition of the evaluation rule action. Required.
description	string	Description for the evaluation rule.
displayName	string	Display Name for the evaluation rule.
enabled	boolean	Indicates whether the evaluation rule is enabled. Default is true. Required.
eventType	string	Event type that the evaluation rule applies to. Required. Known values are: "response.completed" and "manual". (response.completed, manual)
filter	object	Filter condition of the evaluation rule.
systemData	object	System metadata for the evaluation rule. Required.

list

Name	Datatype	Description
id	string	Unique identifier for the evaluation rule. Required.
action	object	Definition of the evaluation rule action. Required.
description	string	Description for the evaluation rule.
displayName	string	Display Name for the evaluation rule.
enabled	boolean	Indicates whether the evaluation rule is enabled. Default is true. Required.
eventType	string	Event type that the evaluation rule applies to. Required. Known values are: "response.completed" and "manual". (response.completed, manual)
filter	object	Filter condition of the evaluation rule.
systemData	object	System metadata for the evaluation rule. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, endpoint		Get an evaluation rule.
list	select	endpoint	actionType, agentName, enabled	List all evaluation rules.
create_or_update	insert	id, endpoint, action, eventType, enabled		Create or update an evaluation rule.
create_or_update	replace	id, endpoint, action, eventType, enabled		Create or update an evaluation rule.
delete	delete	id, endpoint		Delete an evaluation rule.

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
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
id	string	Unique identifier for the evaluation rule. Required.
actionType	string	Filter by the type of evaluation rule. Known values are: "continuousEvaluation" and "humanEvaluation". Default value is None.
agentName	string	Filter by the agent name. Default value is None.
enabled	boolean	Filter by the enabled status. Default value is None.

SELECT examples

get

Get an evaluation rule.

SELECT
id,
action,
description,
displayName,
enabled,
eventType,
filter,
systemData
FROM azure.ai_evaluation.evaluation_rules
WHERE id = '{{ id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

List all evaluation rules.

SELECT
id,
action,
description,
displayName,
enabled,
eventType,
filter,
systemData
FROM azure.ai_evaluation.evaluation_rules
WHERE endpoint = '{{ endpoint }}' -- required
AND actionType = '{{ actionType }}'
AND agentName = '{{ agentName }}'
AND enabled = '{{ enabled }}'
;

INSERT examples

create_or_update

Create or update an evaluation rule.

INSERT INTO azure.ai_evaluation.evaluation_rules (
displayName,
description,
action,
filter,
eventType,
enabled,
id,
endpoint
)
SELECT 
'{{ displayName }}',
'{{ description }}',
'{{ action }}' /* required */,
'{{ filter }}',
'{{ eventType }}' /* required */,
{{ enabled }} /* required */,
'{{ id }}',
'{{ endpoint }}'
RETURNING
id,
action,
description,
displayName,
enabled,
eventType,
filter,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: evaluation_rules
props:
  - name: id
    value: "{{ id }}"
    description: Required parameter for the evaluation_rules resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the evaluation_rules resource.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Display Name for the evaluation rule.
  - name: description
    value: "{{ description }}"
    description: |
      Description for the evaluation rule.
  - name: action
    description: |
      Definition of the evaluation rule action. Required.
    value:
      type: "{{ type }}"
  - name: filter
    description: |
      Filter condition of the evaluation rule.
    value:
      agentName: "{{ agentName }}"
  - name: eventType
    value: "{{ eventType }}"
    description: |
      Event type that the evaluation rule applies to. Required. Known values are: "response.completed" and "manual".
    valid_values: ['response.completed', 'manual']
  - name: enabled
    value: {{ enabled }}
    description: |
      Indicates whether the evaluation rule is enabled. Default is true. Required.

REPLACE examples

create_or_update

Create or update an evaluation rule.

REPLACE azure.ai_evaluation.evaluation_rules
SET 
displayName = '{{ displayName }}',
description = '{{ description }}',
action = '{{ action }}',
filter = '{{ filter }}',
eventType = '{{ eventType }}',
enabled = {{ enabled }}
WHERE 
id = '{{ id }}' --required
AND endpoint = '{{ endpoint }}' --required
AND action = '{{ action }}' --required
AND eventType = '{{ eventType }}' --required
AND enabled = {{ enabled }} --required
RETURNING
id,
action,
description,
displayName,
enabled,
eventType,
filter,
systemData;

DELETE examples

delete

Delete an evaluation rule.

DELETE FROM azure.ai_evaluation.evaluation_rules
WHERE id = '{{ id }}' --required
AND endpoint = '{{ endpoint }}' --required
;