evaluation_taxonomies

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

Overview

Name	evaluation_taxonomies
Type	Resource
Id	azure.ai_evaluation.evaluation_taxonomies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Asset ID, a unique identifier for the asset.
name	string	The name of the resource. Required.
description	string	The asset description text.
properties	object	Additional properties for the evaluation taxonomy.
tags	object	Tag dictionary. Tags can be added, removed, and updated.
taxonomyCategories	array	List of taxonomy categories. Required.
taxonomyInput	object	Input configuration for the evaluation taxonomy. Required.
version	string	The version of the resource. Required.

list

Name	Datatype	Description
id	string	Asset ID, a unique identifier for the asset.
name	string	The name of the resource. Required.
description	string	The asset description text.
properties	object	Additional properties for the evaluation taxonomy.
tags	object	Tag dictionary. Tags can be added, removed, and updated.
taxonomyCategories	array	List of taxonomy categories. Required.
taxonomyInput	object	Input configuration for the evaluation taxonomy. Required.
version	string	The version of the resource. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	name, endpoint		Get an evaluation run by name.
list	select	endpoint	inputName, inputType	List evaluation taxonomies.
create	insert	name, endpoint, taxonomyInput, taxonomyCategories		Create an evaluation taxonomy.
update	update	name, endpoint, taxonomyInput, taxonomyCategories		Update an evaluation taxonomy.
delete	delete	name, endpoint		Delete an evaluation taxonomy by name.

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: )
name	string	The name of the resource. Required.
inputName	string	Filter by the evaluation input name. Default value is None.
inputType	string	Filter by taxonomy input type. Default value is None.

SELECT examples

get

Get an evaluation run by name.

SELECT
id,
name,
description,
properties,
tags,
taxonomyCategories,
taxonomyInput,
version
FROM azure.ai_evaluation.evaluation_taxonomies
WHERE name = '{{ name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

List evaluation taxonomies.

SELECT
id,
name,
description,
properties,
tags,
taxonomyCategories,
taxonomyInput,
version
FROM azure.ai_evaluation.evaluation_taxonomies
WHERE endpoint = '{{ endpoint }}' -- required
AND inputName = '{{ inputName }}'
AND inputType = '{{ inputType }}'
;

INSERT examples

create

Create an evaluation taxonomy.

INSERT INTO azure.ai_evaluation.evaluation_taxonomies (
description,
tags,
taxonomyInput,
taxonomyCategories,
properties,
name,
endpoint
)
SELECT 
'{{ description }}',
'{{ tags }}',
'{{ taxonomyInput }}' /* required */,
'{{ taxonomyCategories }}' /* required */,
'{{ properties }}',
'{{ name }}',
'{{ endpoint }}'
RETURNING
id,
name,
description,
properties,
tags,
taxonomyCategories,
taxonomyInput,
version
;

Manifest

# Description fields are for documentation purposes
- name: evaluation_taxonomies
props:
  - name: name
    value: "{{ name }}"
    description: Required parameter for the evaluation_taxonomies resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the evaluation_taxonomies resource.
  - name: description
    value: "{{ description }}"
    description: |
      The asset description text.
  - name: tags
    value: "{{ tags }}"
    description: |
      Tag dictionary. Tags can be added, removed, and updated.
  - name: taxonomyInput
    description: |
      Input configuration for the evaluation taxonomy. Required.
    value:
      type: "{{ type }}"
  - name: taxonomyCategories
    description: |
      List of taxonomy categories. Required.
    value:
      - name: "{{ name }}"
        description: "{{ description }}"
        riskCategory: "{{ riskCategory }}"
        subCategories: "{{ subCategories }}"
        properties: "{{ properties }}"
  - name: properties
    value: "{{ properties }}"
    description: |
      Additional properties for the evaluation taxonomy.

UPDATE examples

update

Update an evaluation taxonomy.

UPDATE azure.ai_evaluation.evaluation_taxonomies
SET 
description = '{{ description }}',
tags = '{{ tags }}',
taxonomyInput = '{{ taxonomyInput }}',
taxonomyCategories = '{{ taxonomyCategories }}',
properties = '{{ properties }}'
WHERE 
name = '{{ name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND taxonomyInput = '{{ taxonomyInput }}' --required
AND taxonomyCategories = '{{ taxonomyCategories }}' --required
RETURNING
id,
name,
description,
properties,
tags,
taxonomyCategories,
taxonomyInput,
version;

DELETE examples

delete

Delete an evaluation taxonomy by name.

DELETE FROM azure.ai_evaluation.evaluation_taxonomies
WHERE name = '{{ name }}' --required
AND endpoint = '{{ endpoint }}' --required
;