Update Agent Evaluation Test

PATCH

agents

{id}

tests

{testId}

Update Agent Evaluation Test

curl --request PATCH \
  --url https://api.dialnexa.com/v1/agents/{id}/tests/{testId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Answers a pricing question",
  "type": "simulation",
  "config": {
    "scenario": "Ask what the product costs.",
    "criteria": [
      "Uses the pricing in the agent prompt."
    ],
    "mock_strategy": "all",
    "mock_fallback": "error"
  }
}
'

import requests

url = "https://api.dialnexa.com/v1/agents/{id}/tests/{testId}"

payload = {
    "name": "Answers a pricing question",
    "type": "simulation",
    "config": {
        "scenario": "Ask what the product costs.",
        "criteria": ["Uses the pricing in the agent prompt."],
        "mock_strategy": "all",
        "mock_fallback": "error"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Answers a pricing question',
    type: 'simulation',
    config: {
      scenario: 'Ask what the product costs.',
      criteria: ['Uses the pricing in the agent prompt.'],
      mock_strategy: 'all',
      mock_fallback: 'error'
    }
  })
};

fetch('https://api.dialnexa.com/v1/agents/{id}/tests/{testId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/v1/agents/{id}/tests/{testId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Answers a pricing question',
    'type' => 'simulation',
    'config' => [
        'scenario' => 'Ask what the product costs.',
        'criteria' => [
                'Uses the pricing in the agent prompt.'
        ],
        'mock_strategy' => 'all',
        'mock_fallback' => 'error'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.dialnexa.com/v1/agents/{id}/tests/{testId}"

	payload := strings.NewReader("{\n  \"name\": \"Answers a pricing question\",\n  \"type\": \"simulation\",\n  \"config\": {\n    \"scenario\": \"Ask what the product costs.\",\n    \"criteria\": [\n      \"Uses the pricing in the agent prompt.\"\n    ],\n    \"mock_strategy\": \"all\",\n    \"mock_fallback\": \"error\"\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.dialnexa.com/v1/agents/{id}/tests/{testId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Answers a pricing question\",\n  \"type\": \"simulation\",\n  \"config\": {\n    \"scenario\": \"Ask what the product costs.\",\n    \"criteria\": [\n      \"Uses the pricing in the agent prompt.\"\n    ],\n    \"mock_strategy\": \"all\",\n    \"mock_fallback\": \"error\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/agents/{id}/tests/{testId}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Answers a pricing question\",\n  \"type\": \"simulation\",\n  \"config\": {\n    \"scenario\": \"Ask what the product costs.\",\n    \"criteria\": [\n      \"Uses the pricing in the agent prompt.\"\n    ],\n    \"mock_strategy\": \"all\",\n    \"mock_fallback\": \"error\"\n  }\n}"

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

{
  "success": true,
  "error": false,
  "statusCode": 200,
  "message": "Success",
  "data": {
    "id": "<string>",
    "agent_id": "<string>",
    "name": "<string>",
    "type": "next_reply",
    "config": {},
    "enabled": true,
    "folder": "<string>",
    "template_id": "<string>",
    "last_result": {
      "run_id": "<string>",
      "passed": 123,
      "total": 123,
      "finished_at": "2023-11-07T05:31:56Z",
      "version_number": 123,
      "target": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "timestamp": "2023-11-07T05:31:56Z"
}

Changes state - verify before retry Update an agent evaluation test to replace its saved name, folder, type, and configuration without starting a run.

Get the agent and test IDs from List Agent Evaluation Tests. Preserve any configuration you want to keep.

Minimal request

Send all three required fields: name, type, and config. This operation is not a partial merge of config. Omit folder, or send null or an empty string, to clear the folder.

{
  "name": "Answers a pricing question",
  "type": "simulation",
  "config": {
    "scenario": "Ask what the product costs.",
    "criteria": [
      "Uses the pricing in the agent prompt."
    ],
    "mock_strategy": "all",
    "mock_fallback": "error"
  }
}

For a simulation, scenario describes the caller’s task and criteria lists the expected behavior. For next_reply, provide history ending in a caller turn and criteria for the next reply. For tool_call, save the conversation history and expected tool configuration. The config object is saved as supplied, so review its contents before running.

Verify the result

A 200 response contains the updated test in data. List tests again and compare the saved definition before starting another evaluation run.

Errors and recovery

400 indicates an invalid definition; 404 means the agent or test was not found in this workspace. Repeating the same replacement does not create another test, but it can overwrite a newer edit. Read the current definition before retrying. Missing, expired, or invalid API credentials return 401. See API authentication.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Agent ID from List Agents.

testId

string

required

Saved test ID from List Agent Evaluation Tests.

Body

application/json

name

string

required

Test name. Surrounding whitespace is removed.

Maximum string length: 200

type

enum<string>

required

Available options:

next_reply,

tool_call,

simulation

config

object

required

Test definition for the selected type. Use a scenario and criteria for a simulation, or history and criteria for a reply check. Saved as supplied; saving does not run the test.

folder

string | null

Optional folder. Omit, send null or an empty string to use no folder.

Maximum string length: 100

Response

Successful response.

success

enum<boolean>

required

Available options:

true

error

enum<boolean>

required

Available options:

false

statusCode

integer

required

Example:

200

message

string

required

Example:

"Success"

data

object

required

Show child attributes

timestamp

string<date-time>

required

Update Agent Evaluation Test

curl --request PATCH \
  --url https://api.dialnexa.com/v1/agents/{id}/tests/{testId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Answers a pricing question",
  "type": "simulation",
  "config": {
    "scenario": "Ask what the product costs.",
    "criteria": [
      "Uses the pricing in the agent prompt."
    ],
    "mock_strategy": "all",
    "mock_fallback": "error"
  }
}
'

import requests

url = "https://api.dialnexa.com/v1/agents/{id}/tests/{testId}"

payload = {
    "name": "Answers a pricing question",
    "type": "simulation",
    "config": {
        "scenario": "Ask what the product costs.",
        "criteria": ["Uses the pricing in the agent prompt."],
        "mock_strategy": "all",
        "mock_fallback": "error"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Answers a pricing question',
    type: 'simulation',
    config: {
      scenario: 'Ask what the product costs.',
      criteria: ['Uses the pricing in the agent prompt.'],
      mock_strategy: 'all',
      mock_fallback: 'error'
    }
  })
};

fetch('https://api.dialnexa.com/v1/agents/{id}/tests/{testId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/v1/agents/{id}/tests/{testId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Answers a pricing question',
    'type' => 'simulation',
    'config' => [
        'scenario' => 'Ask what the product costs.',
        'criteria' => [
                'Uses the pricing in the agent prompt.'
        ],
        'mock_strategy' => 'all',
        'mock_fallback' => 'error'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.dialnexa.com/v1/agents/{id}/tests/{testId}"

	payload := strings.NewReader("{\n  \"name\": \"Answers a pricing question\",\n  \"type\": \"simulation\",\n  \"config\": {\n    \"scenario\": \"Ask what the product costs.\",\n    \"criteria\": [\n      \"Uses the pricing in the agent prompt.\"\n    ],\n    \"mock_strategy\": \"all\",\n    \"mock_fallback\": \"error\"\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.dialnexa.com/v1/agents/{id}/tests/{testId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Answers a pricing question\",\n  \"type\": \"simulation\",\n  \"config\": {\n    \"scenario\": \"Ask what the product costs.\",\n    \"criteria\": [\n      \"Uses the pricing in the agent prompt.\"\n    ],\n    \"mock_strategy\": \"all\",\n    \"mock_fallback\": \"error\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/agents/{id}/tests/{testId}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Answers a pricing question\",\n  \"type\": \"simulation\",\n  \"config\": {\n    \"scenario\": \"Ask what the product costs.\",\n    \"criteria\": [\n      \"Uses the pricing in the agent prompt.\"\n    ],\n    \"mock_strategy\": \"all\",\n    \"mock_fallback\": \"error\"\n  }\n}"

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

{
  "success": true,
  "error": false,
  "statusCode": 200,
  "message": "Success",
  "data": {
    "id": "<string>",
    "agent_id": "<string>",
    "name": "<string>",
    "type": "next_reply",
    "config": {},
    "enabled": true,
    "folder": "<string>",
    "template_id": "<string>",
    "last_result": {
      "run_id": "<string>",
      "passed": 123,
      "total": 123,
      "finished_at": "2023-11-07T05:31:56Z",
      "version_number": 123,
      "target": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "timestamp": "2023-11-07T05:31:56Z"
}

Overview

Endpoints

Update Agent Evaluation Test