> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://www.comet.com/docs/opik/llms.txt.

# Update Automation Rule Evaluator by id

PATCH http://localhost:5173/api/v1/private/automations/evaluators/{id}
Content-Type: application/json

Update Automation Rule Evaluator by id

Reference: https://www.comet.com/docs/opik/reference/rest-api/automation-rule-evaluators/update-automation-rule-evaluator

## Servers

- `http://localhost:5173/api` (Local server, default)
- `https://www.comet.com/opik/api` (Opik Cloud)

## Request

### Path parameters

- `id` (string, required)

### Body (application/json)

This endpoint expects an AutomationRuleEvaluatorUpdate.

- `AutomationRuleEvaluatorUpdate`
  - `type`: `llm_as_judge` (llm_as_judge)
    - `action` (enum, required)
      - Allowed values: `evaluator`, `annotation_queue_router`
    - `code` (LlmAsJudgeCode, required)
    - `name` (string, required)
    - `enabled` (boolean, optional)
    - `filters` (list of TraceFilter, optional)
    - `project_id` (string, optional) — Primary project ID (legacy field, maintained for backwards compatibility)
    - `project_ids` (list of string, optional) — Multiple project IDs (new field for multi-project support)
    - `sampling_rate` (float, optional) — Fraction of production (SDK-logged) items this rule scores, from 0 to 1. Trace rules ignore this value for experiment, playground and optimization traces and score them in full; span and thread rules only ever evaluate SDK-logged data.
    - `trigger_scope` (enum, optional)
      - Allowed values: `production`, `experiment`, `both`
  - `type`: `user_defined_metric_python` (user_defined_metric_python)
    - `action` (enum, required)
      - Allowed values: `evaluator`, `annotation_queue_router`
    - `code` (UserDefinedMetricPythonCode, required)
    - `name` (string, required)
    - `enabled` (boolean, optional)
    - `filters` (list of TraceFilter, optional)
    - `project_id` (string, optional) — Primary project ID (legacy field, maintained for backwards compatibility)
    - `project_ids` (list of string, optional) — Multiple project IDs (new field for multi-project support)
    - `sampling_rate` (float, optional) — Fraction of production (SDK-logged) items this rule scores, from 0 to 1. Trace rules ignore this value for experiment, playground and optimization traces and score them in full; span and thread rules only ever evaluate SDK-logged data.
    - `trigger_scope` (enum, optional)
      - Allowed values: `production`, `experiment`, `both`
  - `type`: `trace_thread_llm_as_judge` (trace_thread_llm_as_judge)
    - `action` (enum, required)
      - Allowed values: `evaluator`, `annotation_queue_router`
    - `code` (TraceThreadLlmAsJudgeCode, required)
    - `name` (string, required)
    - `enabled` (boolean, optional)
    - `filters` (list of TraceThreadFilter, optional)
    - `project_id` (string, optional) — Primary project ID (legacy field, maintained for backwards compatibility)
    - `project_ids` (list of string, optional) — Multiple project IDs (new field for multi-project support)
    - `sampling_rate` (float, optional) — Fraction of production (SDK-logged) items this rule scores, from 0 to 1. Trace rules ignore this value for experiment, playground and optimization traces and score them in full; span and thread rules only ever evaluate SDK-logged data.
    - `trigger_scope` (enum, optional)
      - Allowed values: `production`, `experiment`, `both`
  - `type`: `trace_thread_user_defined_metric_python` (trace_thread_user_defined_metric_python)
    - `action` (enum, required)
      - Allowed values: `evaluator`, `annotation_queue_router`
    - `code` (TraceThreadUserDefinedMetricPythonCode, required)
    - `name` (string, required)
    - `enabled` (boolean, optional)
    - `filters` (list of TraceThreadFilter, optional)
    - `project_id` (string, optional) — Primary project ID (legacy field, maintained for backwards compatibility)
    - `project_ids` (list of string, optional) — Multiple project IDs (new field for multi-project support)
    - `sampling_rate` (float, optional) — Fraction of production (SDK-logged) items this rule scores, from 0 to 1. Trace rules ignore this value for experiment, playground and optimization traces and score them in full; span and thread rules only ever evaluate SDK-logged data.
    - `trigger_scope` (enum, optional)
      - Allowed values: `production`, `experiment`, `both`
  - `type`: `span_llm_as_judge` (span_llm_as_judge)
    - `action` (enum, required)
      - Allowed values: `evaluator`, `annotation_queue_router`
    - `code` (SpanLlmAsJudgeCode, required)
    - `name` (string, required)
    - `enabled` (boolean, optional)
    - `filters` (list of SpanFilter, optional)
    - `project_id` (string, optional) — Primary project ID (legacy field, maintained for backwards compatibility)
    - `project_ids` (list of string, optional) — Multiple project IDs (new field for multi-project support)
    - `sampling_rate` (float, optional) — Fraction of production (SDK-logged) items this rule scores, from 0 to 1. Trace rules ignore this value for experiment, playground and optimization traces and score them in full; span and thread rules only ever evaluate SDK-logged data.
    - `trigger_scope` (enum, optional)
      - Allowed values: `production`, `experiment`, `both`
  - `type`: `span_user_defined_metric_python` (span_user_defined_metric_python)
    - `action` (enum, required)
      - Allowed values: `evaluator`, `annotation_queue_router`
    - `code` (SpanUserDefinedMetricPythonCode, required)
    - `name` (string, required)
    - `enabled` (boolean, optional)
    - `filters` (list of SpanFilter, optional)
    - `project_id` (string, optional) — Primary project ID (legacy field, maintained for backwards compatibility)
    - `project_ids` (list of string, optional) — Multiple project IDs (new field for multi-project support)
    - `sampling_rate` (float, optional) — Fraction of production (SDK-logged) items this rule scores, from 0 to 1. Trace rules ignore this value for experiment, playground and optimization traces and score them in full; span and thread rules only ever evaluate SDK-logged data.
    - `trigger_scope` (enum, optional)
      - Allowed values: `production`, `experiment`, `both`

## Response

### 204

No content

## Types

### LlmAsJudgeCode

- `model` (LlmAsJudgeModelParameters, required)
- `messages` (list of LlmAsJudgeMessage, required)
- `variables` (map from string to string, required)
- `schema` (list of LlmAsJudgeOutputSchema, required)
- `max_cost_usd` (double, optional)

### TraceFilter

- `field` (string, optional)
- `operator` (enum, optional)
  - Allowed values: `contains`, `not_contains`, `starts_with`, `ends_with`, `=`, `!=`, `>`, `>=`, `<`, `<=`, `is_empty`, `is_not_empty`, `in`, `not_in`
- `key` (string, optional)
- `value` (string, optional)

### UserDefinedMetricPythonCode

- `metric` (string, required)
- `arguments` (map from string to string, required)

### TraceThreadLlmAsJudgeCode

- `model` (LlmAsJudgeModelParameters, required)
- `messages` (list of LlmAsJudgeMessage, required)
- `schema` (list of LlmAsJudgeOutputSchema, required)
- `max_cost_usd` (double, optional)

### TraceThreadFilter

- `field` (string, optional)
- `operator` (enum, optional)
  - Allowed values: `contains`, `not_contains`, `starts_with`, `ends_with`, `=`, `!=`, `>`, `>=`, `<`, `<=`, `is_empty`, `is_not_empty`, `in`, `not_in`
- `key` (string, optional)
- `value` (string, optional)

### TraceThreadUserDefinedMetricPythonCode

- `metric` (string, required)

### SpanLlmAsJudgeCode

- `model` (LlmAsJudgeModelParameters, required)
- `messages` (list of LlmAsJudgeMessage, required)
- `variables` (map from string to string, required)
- `schema` (list of LlmAsJudgeOutputSchema, required)

### SpanFilter

- `field` (string, optional)
- `operator` (enum, optional)
  - Allowed values: `contains`, `not_contains`, `starts_with`, `ends_with`, `=`, `!=`, `>`, `>=`, `<`, `<=`, `is_empty`, `is_not_empty`, `in`, `not_in`
- `key` (string, optional)
- `value` (string, optional)

### SpanUserDefinedMetricPythonCode

- `metric` (string, required)
- `arguments` (map from string to string, required)

### LlmAsJudgeModelParameters

- `name` (string, required)
- `temperature` (double, optional)
- `seed` (integer, optional)
- `custom_parameters` (JsonNode, optional)

### LlmAsJudgeMessage

- `role` (enum, required)
  - Allowed values: `SYSTEM`, `USER`, `AI`, `TOOL_EXECUTION_RESULT`, `CUSTOM`
- `content` (string, optional)
- `content_array` (list of LlmAsJudgeMessageContent, optional)
- `string_content` (boolean, optional)
- `structured_content` (boolean, optional)

### LlmAsJudgeOutputSchema

- `name` (string, required)
- `type` (enum, required)
  - Allowed values: `BOOLEAN`, `INTEGER`, `DOUBLE`
- `description` (string, required)

### JsonNode

### LlmAsJudgeMessageContent

- `type` (string, required)
- `text` (string, optional)
- `image_url` (ImageUrl, optional)
- `video_url` (VideoUrl, optional)
- `audio_url` (AudioUrl, optional)

### ImageUrl

- `url` (string, required)
- `detail` (string, optional)

### VideoUrl

- `url` (string, required)

### AudioUrl

- `url` (string, required)

## Examples

**Request**

```json
{
  "action": "evaluator",
  "name": "string"
}
```

**SDK Code**

```python
import requests

url = "http://localhost:5173/api/v1/private/automations/evaluators/id"

payload = {
    "action": "evaluator",
    "name": "string"
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'http://localhost:5173/api/v1/private/automations/evaluators/id';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: '{"action":"evaluator","name":"string"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:5173/api/v1/private/automations/evaluators/id"

	payload := strings.NewReader("{\n  \"action\": \"evaluator\",\n  \"name\": \"string\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:5173/api/v1/private/automations/evaluators/id")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"action\": \"evaluator\",\n  \"name\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("http://localhost:5173/api/v1/private/automations/evaluators/id")
  .header("Content-Type", "application/json")
  .body("{\n  \"action\": \"evaluator\",\n  \"name\": \"string\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'http://localhost:5173/api/v1/private/automations/evaluators/id', [
  'body' => '{
  "action": "evaluator",
  "name": "string"
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("http://localhost:5173/api/v1/private/automations/evaluators/id");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"action\": \"evaluator\",\n  \"name\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [
  "action": "evaluator",
  "name": "string"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:5173/api/v1/private/automations/evaluators/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```