beta_evaluation_taxonomies

Creates, updates, deletes, gets or lists a beta_evaluation_taxonomies resource.

Overview

Name	beta_evaluation_taxonomies
Type	Resource
Id	azure.ai_projects.beta_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.
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.
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 taxonomy. Retrieves the specified evaluation taxonomy.
list	select	endpoint	inputName, inputType	List evaluation taxonomies. Returns the evaluation taxonomies available in the project, optionally filtered by input name or input type.
create	insert	name, endpoint, taxonomyInput		Create an evaluation taxonomy. Creates or replaces the specified evaluation taxonomy with the provided definition.
update	update	name, endpoint, taxonomyInput		Update an evaluation taxonomy. Update an evaluation taxonomy.
delete	delete	name, endpoint		Delete an evaluation taxonomy. Removes the specified evaluation taxonomy from the project.

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 taxonomy. Retrieves the specified evaluation taxonomy.

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

list

List evaluation taxonomies. Returns the evaluation taxonomies available in the project, optionally filtered by input name or input type.

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

INSERT examples

create

Create an evaluation taxonomy. Creates or replaces the specified evaluation taxonomy with the provided definition.

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

Manifest

# Description fields are for documentation purposes
- name: beta_evaluation_taxonomies
props:
  - name: name
    value: "{{ name }}"
    description: Required parameter for the beta_evaluation_taxonomies resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the beta_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.
    value:
      - id: "{{ id }}"
        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 an evaluation taxonomy.

UPDATE azure.ai_projects.beta_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
RETURNING
id,
name,
description,
properties,
tags,
taxonomyCategories,
taxonomyInput,
version;

DELETE examples

delete

Delete an evaluation taxonomy. Removes the specified evaluation taxonomy from the project.

DELETE FROM azure.ai_projects.beta_evaluation_taxonomies
WHERE name = '{{ name }}' --required
AND endpoint = '{{ endpoint }}' --required
;