evaluations

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

Overview

Name	evaluations
Type	Resource
Id	azure.ai_personalizer.evaluations

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_evaluation	insert	evaluation_id, endpoint		Create Offline Evaluation. Submit a new Offline Evaluation job.
delete_evaluation	delete	evaluation_id, endpoint		Offline Evaluation. Delete the Offline Evaluation associated with the Id.
list_evaluations	exec	endpoint	filter, top, skip	All Offline Evaluations. List of all Offline Evaluations.
get_evaluation	exec	evaluation_id, startTime, endTime, endpoint	intervalInMinutes, window	Offline Evaluation. Get the Offline Evaluation associated with the Id.

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
endTime	string (date-time)	End of aggregation time interval. Required.
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client Endpoint parameter. (default: )
evaluation_id	string	Id of the Offline Evaluation. Required.
startTime	string (date-time)	Start of aggregation time interval. Required.
filter	string	An expression to filter the evaluations against evaluation metadata. Only evaluations where the expression evaluates to true are included in the response. Here is an example, metadata=evaluationType eq 'Manual'. Default value is None.
intervalInMinutes	integer	"Time interval for aggregation of events in minutes. Allowed intervals: 5 minutes, 60 minutes, 360 minutes, 720 minutes and 1440 minutes. Defaults to 5 minutes. Default value is None.
skip	integer	An offset into the collection of the first resource to be returned. Defaults to 0. Default value is 0.
top	integer	The maximum number of resources to return from the collection. Defaults to maximum value of integer. Default value is None.
window	string	Rolling or Expanding time. Rolling compatible with 60 minutes, 360 minutes, 720 minutes and 1440 minutes intervals. Expanding compatible with 5 minute time interval only. Defaults to Expanding. Known values are: "Expanding" and "Rolling". Default value is None.

INSERT examples

create_evaluation

Create Offline Evaluation. Submit a new Offline Evaluation job.

INSERT INTO azure.ai_personalizer.evaluations (
evaluation_id,
endpoint
)
SELECT 
'{{ evaluation_id }}',
'{{ endpoint }}'
;

Manifest

# Description fields are for documentation purposes
- name: evaluations
props:
  - name: evaluation_id
    value: "{{ evaluation_id }}"
    description: Required parameter for the evaluations resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the evaluations resource.

DELETE examples

delete_evaluation

Offline Evaluation. Delete the Offline Evaluation associated with the Id.

DELETE FROM azure.ai_personalizer.evaluations
WHERE evaluation_id = '{{ evaluation_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

list_evaluations

All Offline Evaluations. List of all Offline Evaluations.

EXEC azure.ai_personalizer.evaluations.list_evaluations 
@endpoint='{{ endpoint }}' --required, 
@filter='{{ filter }}', 
@top='{{ top }}', 
@skip='{{ skip }}'
;

get_evaluation

Offline Evaluation. Get the Offline Evaluation associated with the Id.

EXEC azure.ai_personalizer.evaluations.get_evaluation 
@evaluation_id='{{ evaluation_id }}' --required, 
@startTime='{{ startTime }}' --required, 
@endTime='{{ endTime }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@intervalInMinutes='{{ intervalInMinutes }}', 
@window='{{ window }}'
;