EvaluationRulesClient Class

public EvaluationRule createOrUpdateEvaluationRule(String id, EvaluationRule evaluationRule)

Create or update an evaluation rule Creates a new evaluation rule, or replaces the existing rule when the identifier matches.

Parameters:

Returns:

public Response<BinaryData> createOrUpdateEvaluationRuleWithResponse(String id, BinaryData evaluationRule, RequestOptions requestOptions)

Create or update an evaluation rule Creates a new evaluation rule, or replaces the existing rule when the identifier matches.

Request Body Schema

{
     id: String (Required)
     displayName: String (Optional)
     description: String (Optional)
     action (Required): {
         type: String(continuousEvaluation/humanEvaluationPreview) (Required)
     }
     filter (Optional): {
         agentName: String (Required)
     }
     eventType: String(responseCompleted/manual) (Required)
     enabled: boolean (Required)
     systemData (Required): {
         String: String (Required)
     }
 }

Response Body Schema

{
     id: String (Required)
     displayName: String (Optional)
     description: String (Optional)
     action (Required): {
         type: String(continuousEvaluation/humanEvaluationPreview) (Required)
     }
     filter (Optional): {
         agentName: String (Required)
     }
     eventType: String(responseCompleted/manual) (Required)
     enabled: boolean (Required)
     systemData (Required): {
         String: String (Required)
     }
 }

Parameters:

Returns:

public void deleteEvaluationRule(String id)

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

Parameters:

public Response<Void> deleteEvaluationRuleWithResponse(String id, RequestOptions requestOptions)

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

Parameters:

Returns:

public EvaluationRule getEvaluationRule(String id)

Get an evaluation rule Retrieves the specified evaluation rule and its configuration.

Parameters:

Returns:

public Response<BinaryData> getEvaluationRuleWithResponse(String id, RequestOptions requestOptions)

Get an evaluation rule Retrieves the specified evaluation rule and its configuration.

Response Body Schema

{
     id: String (Required)
     displayName: String (Optional)
     description: String (Optional)
     action (Required): {
         type: String(continuousEvaluation/humanEvaluationPreview) (Required)
     }
     filter (Optional): {
         agentName: String (Required)
     }
     eventType: String(responseCompleted/manual) (Required)
     enabled: boolean (Required)
     systemData (Required): {
         String: String (Required)
     }
 }

Parameters:

Returns:

public PagedIterable<EvaluationRule> listEvaluationRules()

List evaluation rules Returns the evaluation rules configured for the project, optionally filtered by action type, agent name, or enabled state.

Returns:

public PagedIterable<EvaluationRule> listEvaluationRules(EvaluationRuleActionType actionType, String agentName, Boolean enabled)

List evaluation rules Returns the evaluation rules configured for the project, optionally filtered by action type, agent name, or enabled state.

Parameters:

Returns:

public PagedIterable<BinaryData> listEvaluationRules(RequestOptions requestOptions)

List evaluation rules Returns the evaluation rules configured for the project, optionally filtered by action type, agent name, or enabled state.

Query Parameters

| ---------- | ------- | -------- | -------------------------------------------------------------------------------------------------------- |
| Name       | Type    | Required | Description                                                                                              |
| actionType | String  | No       | Filter by the type of evaluation rule. Allowed values: "continuousEvaluation", "humanEvaluationPreview". |
| agentName  | String  | No       | Filter by the agent name.                                                                                |
| enabled    | Boolean | No       | Filter by the enabled status.                                                                            |

You can add these to a request with RequestOptions#addQueryParam

Response Body Schema

{
     id: String (Required)
     displayName: String (Optional)
     description: String (Optional)
     action (Required): {
         type: String(continuousEvaluation/humanEvaluationPreview) (Required)
     }
     filter (Optional): {
         agentName: String (Required)
     }
     eventType: String(responseCompleted/manual) (Required)
     enabled: boolean (Required)
     systemData (Required): {
         String: String (Required)
     }
 }

Parameters:

Returns: