BetaEvaluationTaxonomiesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

AIProjectClient's

<xref:evaluation_taxonomies> attribute.

Constructor

BetaEvaluationTaxonomiesOperations(*args, **kwargs)

Methods

create

Create an evaluation taxonomy.

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

delete

Delete an evaluation taxonomy.

Removes the specified evaluation taxonomy from the project.

get

Get an evaluation taxonomy.

Retrieves the specified evaluation taxonomy.

list

List evaluation taxonomies.

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

update

Update an evaluation taxonomy.

Update an evaluation taxonomy.

create

Create an evaluation taxonomy.

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

create(name: str, taxonomy: _models.EvaluationTaxonomy, *, content_type: str = 'application/json', **kwargs: Any) -> _models.EvaluationTaxonomy

Parameters

Name Description
name
Required
str

The name of the evaluation taxonomy. Required.

taxonomy
Required
EvaluationTaxonomy or <xref:JSON> or IO[bytes]

The evaluation taxonomy. Is one of the following types: EvaluationTaxonomy, JSON, IO[bytes] Required.

Returns

Type Description

EvaluationTaxonomy. The EvaluationTaxonomy is compatible with MutableMapping

Exceptions

Type Description

delete

Delete an evaluation taxonomy.

Removes the specified evaluation taxonomy from the project.

delete(name: str, **kwargs: Any) -> None

Parameters

Name Description
name
Required
str

The name of the resource. Required.

Returns

Type Description

None

Exceptions

Type Description

get

Get an evaluation taxonomy.

Retrieves the specified evaluation taxonomy.

get(name: str, **kwargs: Any) -> EvaluationTaxonomy

Parameters

Name Description
name
Required
str

The name of the resource. Required.

Returns

Type Description

EvaluationTaxonomy. The EvaluationTaxonomy is compatible with MutableMapping

Exceptions

Type Description

list

List evaluation taxonomies.

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

list(*, input_name: str | None = None, input_type: str | None = None, **kwargs: Any) -> ItemPaged[EvaluationTaxonomy]

Keyword-Only Parameters

Name Description
input_name
str

Filter by the evaluation input name. Default value is None.

Default value: None
input_type
str

Filter by taxonomy input type. Default value is None.

Default value: None

Returns

Type Description

An iterator like instance of EvaluationTaxonomy

Exceptions

Type Description

update

Update an evaluation taxonomy.

Update an evaluation taxonomy.

update(name: str, taxonomy: _models.EvaluationTaxonomy, *, content_type: str = 'application/json', **kwargs: Any) -> _models.EvaluationTaxonomy

Parameters

Name Description
name
Required
str

The name of the evaluation taxonomy. Required.

taxonomy
Required
EvaluationTaxonomy or <xref:JSON> or IO[bytes]

The evaluation taxonomy. Is one of the following types: EvaluationTaxonomy, JSON, IO[bytes] Required.

Returns

Type Description

EvaluationTaxonomy. The EvaluationTaxonomy is compatible with MutableMapping

Exceptions

Type Description