EvaluationTaxonomiesClient Class

Package:

com.azure.ai.projects

Maven Artifact:

com.azure:azure-ai-projects:2.0.1

• java.lang.Object
• • com.azure.ai.projects.EvaluationTaxonomiesClient

public final class EvaluationTaxonomiesClient

Initializes a new instance of the synchronous AIProjectClient type.

Method Summary

Modifier and Type	Method and Description
EvaluationTaxonomy	createEvaluationTaxonomy(String name, EvaluationTaxonomy body) Create an evaluation taxonomy.
Response<BinaryData>	createEvaluationTaxonomyWithResponse(String name, BinaryData body, RequestOptions requestOptions) Create an evaluation taxonomy.
void	deleteEvaluationTaxonomy(String name) Delete an evaluation taxonomy by name.
Response<Void>	deleteEvaluationTaxonomyWithResponse(String name, RequestOptions requestOptions) Delete an evaluation taxonomy by name.
EvaluationTaxonomy	getEvaluationTaxonomy(String name) Get an evaluation run by name.
Response<BinaryData>	getEvaluationTaxonomyWithResponse(String name, RequestOptions requestOptions) Get an evaluation run by name.
PagedIterable<EvaluationTaxonomy>	listEvaluationTaxonomies() List evaluation taxonomies.
PagedIterable<BinaryData>	listEvaluationTaxonomies(RequestOptions requestOptions) List evaluation taxonomies.
PagedIterable<EvaluationTaxonomy>	listEvaluationTaxonomies(String inputName, String inputType) List evaluation taxonomies.
EvaluationTaxonomy	updateEvaluationTaxonomy(String name, EvaluationTaxonomy body) Update an evaluation taxonomy.
Response<BinaryData>	updateEvaluationTaxonomyWithResponse(String name, BinaryData body, RequestOptions requestOptions) Update an evaluation taxonomy.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

createEvaluationTaxonomy

public EvaluationTaxonomy createEvaluationTaxonomy(String name, EvaluationTaxonomy body)

Create an evaluation taxonomy.

Parameters:

name - The name of the evaluation taxonomy.

body - The evaluation taxonomy.

Returns:

evaluation Taxonomy Definition.

createEvaluationTaxonomyWithResponse

public Response<BinaryData> createEvaluationTaxonomyWithResponse(String name, BinaryData body, RequestOptions requestOptions)

Create an evaluation taxonomy.

Request Body Schema

{
     id: String (Optional)
     name: String (Required)
     version: String (Required)
     description: String (Optional)
     tags (Optional): {
         String: String (Required)
     }
     taxonomyInput (Required): {
         type: String(agent/policy) (Required)
     }
     taxonomyCategories (Optional): [
          (Optional){
             id: String (Required)
             name: String (Required)
             description: String (Optional)
             riskCategory: String(HateUnfairness/Violence/Sexual/SelfHarm/ProtectedMaterial/CodeVulnerability/UngroundedAttributes/ProhibitedActions/SensitiveDataLeakage/TaskAdherence) (Required)
             subCategories (Required): [
                  (Required){
                     id: String (Required)
                     name: String (Required)
                     description: String (Optional)
                     enabled: boolean (Required)
                     properties (Optional): {
                         String: String (Required)
                     }
                 }
             ]
             properties (Optional): {
                 String: String (Required)
             }
         }
     ]
     properties (Optional): {
         String: String (Required)
     }
 }

Response Body Schema

{
     id: String (Optional)
     name: String (Required)
     version: String (Required)
     description: String (Optional)
     tags (Optional): {
         String: String (Required)
     }
     taxonomyInput (Required): {
         type: String(agent/policy) (Required)
     }
     taxonomyCategories (Optional): [
          (Optional){
             id: String (Required)
             name: String (Required)
             description: String (Optional)
             riskCategory: String(HateUnfairness/Violence/Sexual/SelfHarm/ProtectedMaterial/CodeVulnerability/UngroundedAttributes/ProhibitedActions/SensitiveDataLeakage/TaskAdherence) (Required)
             subCategories (Required): [
                  (Required){
                     id: String (Required)
                     name: String (Required)
                     description: String (Optional)
                     enabled: boolean (Required)
                     properties (Optional): {
                         String: String (Required)
                     }
                 }
             ]
             properties (Optional): {
                 String: String (Required)
             }
         }
     ]
     properties (Optional): {
         String: String (Required)
     }
 }

Parameters:

name - The name of the evaluation taxonomy.

body - The evaluation taxonomy.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

evaluation Taxonomy Definition along with Response<T>.

deleteEvaluationTaxonomy

public void deleteEvaluationTaxonomy(String name)

Delete an evaluation taxonomy by name.

Parameters:

name - The name of the resource.

deleteEvaluationTaxonomyWithResponse

public Response<Void> deleteEvaluationTaxonomyWithResponse(String name, RequestOptions requestOptions)

Delete an evaluation taxonomy by name.

Parameters:

name - The name of the resource.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response<T>.

getEvaluationTaxonomy

public EvaluationTaxonomy getEvaluationTaxonomy(String name)

Get an evaluation run by name.

Parameters:

name - The name of the resource.

Returns:

an evaluation run by name.

getEvaluationTaxonomyWithResponse

public Response<BinaryData> getEvaluationTaxonomyWithResponse(String name, RequestOptions requestOptions)

Get an evaluation run by name.

Response Body Schema

{
     id: String (Optional)
     name: String (Required)
     version: String (Required)
     description: String (Optional)
     tags (Optional): {
         String: String (Required)
     }
     taxonomyInput (Required): {
         type: String(agent/policy) (Required)
     }
     taxonomyCategories (Optional): [
          (Optional){
             id: String (Required)
             name: String (Required)
             description: String (Optional)
             riskCategory: String(HateUnfairness/Violence/Sexual/SelfHarm/ProtectedMaterial/CodeVulnerability/UngroundedAttributes/ProhibitedActions/SensitiveDataLeakage/TaskAdherence) (Required)
             subCategories (Required): [
                  (Required){
                     id: String (Required)
                     name: String (Required)
                     description: String (Optional)
                     enabled: boolean (Required)
                     properties (Optional): {
                         String: String (Required)
                     }
                 }
             ]
             properties (Optional): {
                 String: String (Required)
             }
         }
     ]
     properties (Optional): {
         String: String (Required)
     }
 }

Parameters:

name - The name of the resource.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

an evaluation run by name along with Response<T>.

listEvaluationTaxonomies

public PagedIterable<EvaluationTaxonomy> listEvaluationTaxonomies()

List evaluation taxonomies.

Returns:

paged collection of EvaluationTaxonomy items as paginated response with PagedIterable<T>.

listEvaluationTaxonomies

public PagedIterable<BinaryData> listEvaluationTaxonomies(RequestOptions requestOptions)

List evaluation taxonomies.

Query Parameters

| --------- | ------ | -------- | ------------------------------------ |
| Name      | Type   | Required | Description                          |
| inputName | String | No       | Filter by the evaluation input name. |
| inputType | String | No       | Filter by taxonomy input type.       |

You can add these to a request with RequestOptions#addQueryParam

Response Body Schema

{
     id: String (Optional)
     name: String (Required)
     version: String (Required)
     description: String (Optional)
     tags (Optional): {
         String: String (Required)
     }
     taxonomyInput (Required): {
         type: String(agent/policy) (Required)
     }
     taxonomyCategories (Optional): [
          (Optional){
             id: String (Required)
             name: String (Required)
             description: String (Optional)
             riskCategory: String(HateUnfairness/Violence/Sexual/SelfHarm/ProtectedMaterial/CodeVulnerability/UngroundedAttributes/ProhibitedActions/SensitiveDataLeakage/TaskAdherence) (Required)
             subCategories (Required): [
                  (Required){
                     id: String (Required)
                     name: String (Required)
                     description: String (Optional)
                     enabled: boolean (Required)
                     properties (Optional): {
                         String: String (Required)
                     }
                 }
             ]
             properties (Optional): {
                 String: String (Required)
             }
         }
     ]
     properties (Optional): {
         String: String (Required)
     }
 }

Parameters:

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

paged collection of EvaluationTaxonomy items as paginated response with PagedIterable<T>.

listEvaluationTaxonomies

public PagedIterable<EvaluationTaxonomy> listEvaluationTaxonomies(String inputName, String inputType)

List evaluation taxonomies.

Parameters:

inputName - Filter by the evaluation input name.

inputType - Filter by taxonomy input type.

Returns:

paged collection of EvaluationTaxonomy items as paginated response with PagedIterable<T>.

updateEvaluationTaxonomy

public EvaluationTaxonomy updateEvaluationTaxonomy(String name, EvaluationTaxonomy body)

Update an evaluation taxonomy.

Parameters:

name - The name of the evaluation taxonomy.

body - The evaluation taxonomy.

Returns:

evaluation Taxonomy Definition.

updateEvaluationTaxonomyWithResponse

public Response<BinaryData> updateEvaluationTaxonomyWithResponse(String name, BinaryData body, RequestOptions requestOptions)

Update an evaluation taxonomy.

Request Body Schema

{
     id: String (Optional)
     name: String (Required)
     version: String (Required)
     description: String (Optional)
     tags (Optional): {
         String: String (Required)
     }
     taxonomyInput (Required): {
         type: String(agent/policy) (Required)
     }
     taxonomyCategories (Optional): [
          (Optional){
             id: String (Required)
             name: String (Required)
             description: String (Optional)
             riskCategory: String(HateUnfairness/Violence/Sexual/SelfHarm/ProtectedMaterial/CodeVulnerability/UngroundedAttributes/ProhibitedActions/SensitiveDataLeakage/TaskAdherence) (Required)
             subCategories (Required): [
                  (Required){
                     id: String (Required)
                     name: String (Required)
                     description: String (Optional)
                     enabled: boolean (Required)
                     properties (Optional): {
                         String: String (Required)
                     }
                 }
             ]
             properties (Optional): {
                 String: String (Required)
             }
         }
     ]
     properties (Optional): {
         String: String (Required)
     }
 }

Response Body Schema

{
     id: String (Optional)
     name: String (Required)
     version: String (Required)
     description: String (Optional)
     tags (Optional): {
         String: String (Required)
     }
     taxonomyInput (Required): {
         type: String(agent/policy) (Required)
     }
     taxonomyCategories (Optional): [
          (Optional){
             id: String (Required)
             name: String (Required)
             description: String (Optional)
             riskCategory: String(HateUnfairness/Violence/Sexual/SelfHarm/ProtectedMaterial/CodeVulnerability/UngroundedAttributes/ProhibitedActions/SensitiveDataLeakage/TaskAdherence) (Required)
             subCategories (Required): [
                  (Required){
                     id: String (Required)
                     name: String (Required)
                     description: String (Optional)
                     enabled: boolean (Required)
                     properties (Optional): {
                         String: String (Required)
                     }
                 }
             ]
             properties (Optional): {
                 String: String (Required)
             }
         }
     ]
     properties (Optional): {
         String: String (Required)
     }
 }

Parameters:

name - The name of the evaluation taxonomy.

body - The evaluation taxonomy.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

evaluation Taxonomy Definition along with Response<T>.