Relevance AI · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Relevance AI Endpoints Evals API
38 actions
38 updates
phrasing
extends
openapi/relevance-ai-evals-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Relevance AI's API. It is a proposal applied on top of the contract, not a document Relevance AI publishes.
What the actions change
x-apievangelist-phrasing
Targets 38 · first 16 shown; the file carries all of them
$.info
$.paths['/evals/{resource_type}/{resource_id}/test-cases'].get
$.paths['/evals/{resource_type}/{resource_id}/test-cases'].post
$.paths['/evals/{resource_type}/{resource_id}/batches'].get
$.paths['/evals/{resource_type}/{resource_id}/rules'].get
$.paths['/evals/{resource_type}/{resource_id}/rules'].post
$.paths['/evals/{resource_type}/{resource_id}/runs'].post
$.paths['/evals/{resource_type}/{resource_id}/evaluate'].post
$.paths['/evals/{resource_type}/{resource_id}/batches/{eval_batch_id}/summary'].get
$.paths['/evals/{resource_type}/{resource_id}/batches/{eval_batch_id}'].delete
$.paths['/evals/{resource_type}/{resource_id}/batches/{eval_batch_id}/cancel'].post
$.paths['/evals/{resource_type}/{resource_id}/runs/{eval_run_id}/cancel'].post
$.paths['/evals/{resource_type}/{resource_id}/rules/{eval_rule_id}'].delete
$.paths['/evals/{resource_type}/{resource_id}/rules/{eval_rule_id}'].patch
$.paths['/evals/{resource_type}/{resource_id}/observability/config'].get
$.paths['/evals/{resource_type}/{resource_id}/observability/config'].put
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Relevance AI Endpoints Evals API
version: 1.0.0
extends: openapi/relevance-ai-evals-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 37
- target: $.paths['/evals/{resource_type}/{resource_id}/test-cases'].get
update:
x-apievangelist-phrasing:
intent: List test cases for an agent or workforce
effect: read
questions:
- What test cases have I written for my agent?
- Can I list only the test cases in one test set?
- Is there a search filter when listing an agent's test cases?
instructions:
- text: List test cases for {resource_type} {resource_id}.
slots:
resource_type: path.resource_type
resource_id: path.resource_id
- text: List test cases in test set {test_set_id} for {resource_type} {resource_id}.
slots:
test_set_id: query.test_set_id
resource_type: path.resource_type
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/test-cases'].post
update:
x-apievangelist-phrasing:
intent: Create a test case with a scenario and checks
effect: write
questions:
- How do I write a new eval test case describing a scenario for my agent?
- Can a new test case be added straight into a specific test set?
instructions:
- text: Create test case {name} for {resource_type} {resource_id} with scenario {scenario} and checks {check_ids}.
slots:
name: requestBody.name
resource_type: path.resource_type
resource_id: path.resource_id
scenario: requestBody.scenario
check_ids: requestBody.check_ids
- text: Add a test case named {name} to test set {test_set_id} on agent {resource_id}.
slots:
name: requestBody.name
test_set_id: query.test_set_id
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/batches'].get
update:
x-apievangelist-phrasing:
intent: List eval batches for an agent or workforce
effect: read
questions:
- Which evaluation batches have been run against my agent?
- Can I sort an agent's eval batches by a field and direction?
instructions:
- text: List eval batches for {resource_type} {resource_id}.
slots:
resource_type: path.resource_type
resource_id: path.resource_id
- text: Search eval batches on {resource_type} {resource_id} for {search}.
slots:
resource_type: path.resource_type
resource_id: path.resource_id
search: query.search
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/rules'].get
update:
x-apievangelist-phrasing:
intent: List evaluator rules for an agent or workforce
effect: read
questions:
- What evaluator rules are defined for my workforce?
- Which grading rules is my agent being evaluated against?
instructions:
- text: List the evaluator rules for {resource_type} {resource_id}.
slots:
resource_type: path.resource_type
resource_id: path.resource_id
- text: Show all eval rules configured on agent {resource_id}.
slots:
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/rules'].post
update:
x-apievangelist-phrasing:
intent: Create an evaluator rule
effect: write
questions:
- How do I add a new evaluator rule that grades my agent's conversations?
- Can I define my own evaluation criteria for a workforce?
instructions:
- text: Create an evaluator rule on {resource_type} {resource_id} defined as {user_definition}.
slots:
resource_type: path.resource_type
resource_id: path.resource_id
user_definition: requestBody.user_definition
- text: 'Add a new eval rule to agent {resource_id}: {user_definition}.'
slots:
resource_id: path.resource_id
user_definition: requestBody.user_definition
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/runs'].post
update:
x-apievangelist-phrasing:
intent: List eval runs for an agent or workforce
effect: read
questions:
- What individual eval runs have been done on my agent recently?
- Can I filter eval runs by a date range?
instructions:
- text: List eval runs for {resource_type} {resource_id}.
slots:
resource_type: path.resource_type
resource_id: path.resource_id
- text: Show eval runs on {resource_type} {resource_id} within {date_range}.
slots:
resource_type: path.resource_type
resource_id: path.resource_id
date_range: requestBody.date_range
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/evaluate'].post
update:
x-apievangelist-phrasing:
intent: Run an evaluation on an agent or workforce
effect: write
questions:
- How do I evaluate a set of my agent's past conversations?
- Can I run an evaluation using a whole test set and selected rules?
instructions:
- text: Start an evaluation run named {evaluation_run_name} on {resource_type} {resource_id} for conversations {conversation_ids}.
slots:
evaluation_run_name: requestBody.evaluation_run_name
resource_type: path.resource_type
resource_id: path.resource_id
conversation_ids: requestBody.conversation_ids
- text: Evaluate agent {resource_id} against test set {test_set_id} as run {evaluation_run_name}.
slots:
resource_id: path.resource_id
test_set_id: requestBody.test_set_id
evaluation_run_name: requestBody.evaluation_run_name
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/batches/{eval_batch_id}/summary'].get
update:
x-apievangelist-phrasing:
intent: Get the summary of an eval batch
effect: read
questions:
- How did my agent score in a particular eval batch?
- Can I get summary results for one evaluation batch?
instructions:
- text: Summarize eval batch {eval_batch_id} for {resource_type} {resource_id}.
slots:
eval_batch_id: path.eval_batch_id
resource_type: path.resource_type
resource_id: path.resource_id
- text: Show results summary for batch {eval_batch_id} on agent {resource_id}.
slots:
eval_batch_id: path.eval_batch_id
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/batches/{eval_batch_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an eval batch
effect: destructive
questions:
- Can I delete an old evaluation batch I no longer need?
- What removes an eval batch from an agent's history?
instructions:
- text: Delete eval batch {eval_batch_id} from {resource_type} {resource_id}.
slots:
eval_batch_id: path.eval_batch_id
resource_type: path.resource_type
resource_id: path.resource_id
- text: Remove batch {eval_batch_id} from agent {resource_id}'s evals.
slots:
eval_batch_id: path.eval_batch_id
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/batches/{eval_batch_id}/cancel'].post
update:
x-apievangelist-phrasing:
intent: Cancel all pending runs in an eval batch
effect: destructive
questions:
- How do I stop an entire eval batch that's still running?
- Does cancelling a batch stop both pending and running eval runs?
instructions:
- text: Cancel eval batch {eval_batch_id} on {resource_type} {resource_id}.
slots:
eval_batch_id: path.eval_batch_id
resource_type: path.resource_type
resource_id: path.resource_id
- text: Stop every pending run in batch {eval_batch_id} for agent {resource_id}.
slots:
eval_batch_id: path.eval_batch_id
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/runs/{eval_run_id}/cancel'].post
update:
x-apievangelist-phrasing:
intent: Cancel a single eval run
effect: destructive
questions:
- Can I cancel just one eval run without stopping the rest of the batch?
- What stops a single stuck evaluation run?
instructions:
- text: Cancel eval run {eval_run_id} on {resource_type} {resource_id}.
slots:
eval_run_id: path.eval_run_id
resource_type: path.resource_type
resource_id: path.resource_id
- text: Stop only run {eval_run_id} for agent {resource_id}.
slots:
eval_run_id: path.eval_run_id
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/rules/{eval_rule_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an evaluator rule
effect: destructive
questions:
- How do I remove an evaluator rule from my agent?
- Can I delete a grading rule that's no longer relevant?
instructions:
- text: Delete evaluator rule {eval_rule_id} from {resource_type} {resource_id}.
slots:
eval_rule_id: path.eval_rule_id
resource_type: path.resource_type
resource_id: path.resource_id
- text: Remove eval rule {eval_rule_id} on agent {resource_id}.
slots:
eval_rule_id: path.eval_rule_id
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/rules/{eval_rule_id}'].patch
update:
x-apievangelist-phrasing:
intent: Update an evaluator rule
effect: write
questions:
- Can I change the definition of an existing evaluator rule?
- How would I tweak the criteria of a rule already grading my agent?
instructions:
- text: Update evaluator rule {eval_rule_id} on {resource_type} {resource_id} to {user_definition}.
slots:
eval_rule_id: path.eval_rule_id
resource_type: path.resource_type
resource_id: path.resource_id
user_definition: requestBody.user_definition
- text: Change the definition of eval rule {eval_rule_id} for agent {resource_id}.
slots:
eval_rule_id: path.eval_rule_id
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/observability/config'].get
update:
x-apievangelist-phrasing:
intent: Get the legacy observability config
effect: read
questions:
- Where is the older single observability config for an agent read from?
- Is the deprecated get-observability-config endpoint still usable?
instructions:
- text: Get the legacy single observability config for {resource_type} {resource_id}.
slots:
resource_type: path.resource_type
resource_id: path.resource_id
- text: Read the deprecated observability config on agent {resource_id}.
slots:
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/observability/config'].put
update:
x-apievangelist-phrasing:
intent: Update the legacy observability config
effect: write
questions:
- Can I still update an agent's observability settings through the older single-config endpoint?
- What does the deprecated observability config update change?
instructions:
- text: Update the legacy observability config on {resource_type} {resource_id} to use rules {rule_ids}.
slots:
resource_type: path.resource_type
resource_id: path.resource_id
rule_ids: requestBody.rule_ids
- text: Set the deprecated observability config sample rate to {sample_rate} for agent {resource_id} with rules {rule_ids}.
slots:
sample_rate: requestBody.sample_rate
resource_id: path.resource_id
rule_ids: requestBody.rule_ids
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/observability/config'].post
update:
x-apievangelist-phrasing:
intent: Create the legacy observability config
effect: write
questions:
- How was the single observability config created before multiple configs were supported?
- Can I still create an observability config via the deprecated endpoint?
instructions:
- text: Create the legacy single observability config on {resource_type} {resource_id} with rules {rule_ids}.
slots:
resource_type: path.resource_type
resource_id: path.resource_id
rule_ids: requestBody.rule_ids
- text: Use the deprecated endpoint to set up observability on agent {resource_id} using rules {rule_ids}.
slots:
resource_id: path.resource_id
rule_ids: requestBody.rule_ids
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/observability/config'].delete
update:
x-apievangelist-phrasing:
intent: Delete the legacy observability config
effect: destructive
questions:
- Can I remove an agent's single observability config through the old endpoint?
- What deletes the deprecated one-per-resource observability config?
instructions:
- text: Delete the legacy observability config on {resource_type} {resource_id}.
slots:
resource_type: path.resource_type
resource_id: path.resource_id
- text: Remove the deprecated observability config from agent {resource_id}.
slots:
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/observability/configs'].get
update:
x-apievangelist-phrasing:
intent: List observability configs for an agent or workforce
effect: read
questions:
- Which observability configurations are set up on my workforce?
- How many monitoring configs does my agent currently have?
instructions:
- text: List all observability configs for {resource_type} {resource_id}.
slots:
resource_type: path.resource_type
resource_id: path.resource_id
- text: Show every monitoring config on agent {resource_id}.
slots:
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/observability/configs'].post
update:
x-apievangelist-phrasing:
intent: Add an observability config
effect: write
questions:
- How do I add another observability config so live conversations get evaluated?
- Can I sample only a percentage of conversations for ongoing evaluation?
instructions:
- text: Add an observability config named {name} to {resource_type} {resource_id} with rules {rule_ids}.
slots:
name: requestBody.name
resource_type: path.resource_type
resource_id: path.resource_id
rule_ids: requestBody.rule_ids
- text: Create a new monitoring config on agent {resource_id} sampling {sample_rate} with rules {rule_ids}.
slots:
resource_id: path.resource_id
sample_rate: requestBody.sample_rate
rule_ids: requestBody.rule_ids
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/observability/configs/{config_id}'].put
update:
x-apievangelist-phrasing:
intent: Update a specific observability config
effect: write
questions:
- Can I change the rules or sample rate on one of several observability configs?
- How do I disable a particular monitoring config without deleting it?
instructions:
- text: Update observability config {config_id} on {resource_type} {resource_id} to use rules {rule_ids}.
slots:
config_id: path.config_id
resource_type: path.resource_type
resource_id: path.resource_id
rule_ids: requestBody.rule_ids
- text: Set enabled to {enabled} on monitoring config {config_id} for agent {resource_id}, keeping rules {rule_ids}.
slots:
enabled: requestBody.enabled
config_id: path.config_id
resource_id: path.resource_id
rule_ids: requestBody.rule_ids
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/observability/configs/{config_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a specific observability config
effect: destructive
questions:
- How do I delete one monitoring config by its ID?
- Can I remove a single observability config while keeping the others?
instructions:
- text: Delete observability config {config_id} from {resource_type} {resource_id}.
slots:
config_id: path.config_id
resource_type: path.resource_type
resource_id: path.resource_id
- text: Remove monitoring config {config_id} on agent {resource_id}.
slots:
config_id: path.config_id
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/pre-publish/config'].get
update:
x-apievangelist-phrasing:
intent: Get the pre-publish eval config
effect: read
questions:
- Which test sets must pass before my agent can be published?
- Does my workforce have a pre-publish check configured?
instructions:
- text: Get the pre-publish config for {resource_type} {resource_id}.
slots:
resource_type: path.resource_type
resource_id: path.resource_id
- text: Show the pre-publish test sets set on agent {resource_id}.
slots:
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/pre-publish/config'].post
update:
x-apievangelist-phrasing:
intent: Set the pre-publish eval config
effect: write
questions:
- How do I require certain test sets to run before an agent is published?
- Does saving a pre-publish config replace the whole existing one?
instructions:
- text: Set the pre-publish config for {resource_type} {resource_id} to test sets {test_sets}.
slots:
resource_type: path.resource_type
resource_id: path.resource_id
test_sets: requestBody.test_sets
- text: Replace agent {resource_id}'s pre-publish checks with test sets {test_sets}.
slots:
resource_id: path.resource_id
test_sets: requestBody.test_sets
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/pre-publish/config'].delete
update:
x-apievangelist-phrasing:
intent: Remove the pre-publish eval config
effect: destructive
questions:
- Can I turn off pre-publish checks by deleting the config?
- What removes the gate that runs test sets before publishing?
instructions:
- text: Delete the pre-publish config for {resource_type} {resource_id}.
slots:
resource_type: path.resource_type
resource_id: path.resource_id
- text: Remove pre-publish checks from agent {resource_id}.
slots:
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/pre-publish/trigger'].post
update:
x-apievangelist-phrasing:
intent: Run pre-publish checks on a draft version
effect: write
questions:
- How do I test my agent's draft against its pre-publish test sets?
- Does triggering pre-publish checks create one batch per test set?
instructions:
- text: Run pre-publish checks on draft {draft_version_id} of {resource_type} {resource_id}.
slots:
draft_version_id: requestBody.draft_version_id
resource_type: path.resource_type
resource_id: path.resource_id
- text: Trigger pre-publish evals for draft version {draft_version_id} of agent {resource_id}.
slots:
draft_version_id: requestBody.draft_version_id
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/pre-publish/checks'].get
update:
x-apievangelist-phrasing:
intent: List pre-publish check attempts
effect: read
questions:
- Did my agent's last pre-publish check pass?
- Can I see pre-publish results broken down by test set for a given version?
instructions:
- text: List pre-publish check attempts for {resource_type} {resource_id}.
slots:
resource_type: path.resource_type
resource_id: path.resource_id
- text: Show pre-publish checks for version {version_id} of agent {resource_id}.
slots:
version_id: query.version_id
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/observability/eval-scores/timeseries'].post
update:
x-apievangelist-phrasing:
intent: Chart observability eval scores over time
effect: read
questions:
- How have my agent's live evaluation scores trended over the past month?
- Can I chart eval scores for one observability config in my timezone?
instructions:
- text: Get the eval score timeseries for config {config_id} on {resource_type} {resource_id} from {start_date} to {end_date}.
slots:
config_id: requestBody.config_id
resource_type: path.resource_type
resource_id: path.resource_id
start_date: requestBody.start_date
end_date: requestBody.end_date
- text: Chart agent {resource_id}'s observability scores for config {config_id} since {start_date}.
slots:
resource_id: path.resource_id
config_id: requestBody.config_id
start_date: requestBody.start_date
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/test-cases/{test_case_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a single test case
effect: read
questions:
- What scenario and checks does a particular test case contain?
- Can I look up one eval test case by ID?
instructions:
- text: Get test case {test_case_id} for {resource_type} {resource_id}.
slots:
test_case_id: path.test_case_id
resource_type: path.resource_type
resource_id: path.resource_id
- text: Show the scenario of test case {test_case_id} on agent {resource_id}.
slots:
test_case_id: path.test_case_id
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/test-cases/{test_case_id}'].put
update:
x-apievangelist-phrasing:
intent: Update a test case
effect: write
questions:
- Can I edit the scenario or checks of an existing test case?
- How would I rename a test case I already created?
instructions:
- text: 'Update test case {test_case_id} on {resource_type} {resource_id}: name {name}, scenario {scenario}, checks {check_ids}.'
slots:
test_case_id: path.test_case_id
resource_type: path.resource_type
resource_id: path.resource_id
name: requestBody.name
scenario: requestBody.scenario
check_ids: requestBody.check_ids
- text: Change the scenario of existing test case {test_case_id} on agent {resource_id} to {scenario}.
slots:
test_case_id: path.test_case_id
resource_id: path.resource_id
scenario: requestBody.scenario
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/test-cases/{test_case_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a test case
effect: destructive
questions:
- How do I delete a test case I don't need anymore?
- Can I remove one eval test case from an agent?
instructions:
- text: Delete test case {test_case_id} from {resource_type} {resource_id}.
slots:
test_case_id: path.test_case_id
resource_type: path.resource_type
resource_id: path.resource_id
- text: Remove test case {test_case_id} on agent {resource_id}.
slots:
test_case_id: path.test_case_id
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/test-cases/copy'].post
update:
x-apievangelist-phrasing:
intent: Copy a test case into another test set
effect: write
questions:
- Can I reuse a test case in a second test set without moving it?
- What duplicates a test case into a different test set?
instructions:
- text: Copy test case {test_case_id} into test set {destination_test_set_id} on {resource_type} {resource_id}.
slots:
test_case_id: requestBody.test_case_id
destination_test_set_id: requestBody.destination_test_set_id
resource_type: path.resource_type
resource_id: path.resource_id
- text: Duplicate test case {test_case_id} into set {destination_test_set_id} for agent {resource_id}.
slots:
test_case_id: requestBody.test_case_id
destination_test_set_id: requestBody.destination_test_set_id
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/test-cases/move'].post
update:
x-apievangelist-phrasing:
intent: Move a test case to another test set
effect: write
questions:
- How do I move a test case out of one test set and into another?
- Can I relocate a test case between sets on the same agent?
instructions:
- text: Move test case {test_case_id} from set {source_test_set_id} to set {destination_test_set_id} on {resource_type} {resource_id}.
slots:
test_case_id: requestBody.test_case_id
source_test_set_id: requestBody.source_test_set_id
destination_test_set_id: requestBody.destination_test_set_id
resource_type: path.resource_type
resource_id: path.resource_id
- text: Relocate test case {test_case_id} out of {source_test_set_id} into {destination_test_set_id} for agent {resource_id}.
slots:
test_case_id: requestBody.test_case_id
source_test_set_id: requestBody.source_test_set_id
destination_test_set_id: requestBody.destination_test_set_id
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/test-sets'].get
update:
x-apievangelist-phrasing:
intent: List test sets for an agent or workforce
effect: read
questions:
- What test sets exist for my agent?
- Can I search an agent's test sets by name?
instructions:
- text: List test sets for {resource_type} {resource_id}.
slots:
resource_type: path.resource_type
resource_id: path.resource_id
- text: Find test sets named like {search} on agent {resource_id}.
slots:
search: query.search
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/test-sets'].post
update:
x-apievangelist-phrasing:
intent: Create a test set
effect: write
questions:
- How do I group test cases into a new test set?
- Can I create a test set and include existing test cases right away?
instructions:
- text: Create test set {name} for {resource_type} {resource_id}.
slots:
name: requestBody.name
resource_type: path.resource_type
resource_id: path.resource_id
- text: Create test set {name} on agent {resource_id} containing test cases {test_case_ids}.
slots:
name: requestBody.name
resource_id: path.resource_id
test_case_ids: requestBody.test_case_ids
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/test-sets/{test_set_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a single test set
effect: read
questions:
- What's inside a specific test set?
- Can I retrieve one test set by its ID?
instructions:
- text: Get test set {test_set_id} for {resource_type} {resource_id}.
slots:
test_set_id: path.test_set_id
resource_type: path.resource_type
resource_id: path.resource_id
- text: Show details of test set {test_set_id} on agent {resource_id}.
slots:
test_set_id: path.test_set_id
resource_id: path.resource_id
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/test-sets/{test_set_id}'].put
update:
x-apievangelist-phrasing:
intent: Rename or reconfigure a test set
effect: write
questions:
- Can I rename an existing test set?
- How do I change the tool simulation settings on a test set?
instructions:
- text: Rename test set {test_set_id} on {resource_type} {resource_id} to {name}.
slots:
test_set_id: path.test_set_id
resource_type: path.resource_type
resource_id: path.resource_id
name: requestBody.name
- text: Update test set {test_set_id} on agent {resource_id} with name {name} and simulation config {tool_simulation_config}.
slots:
test_set_id: path.test_set_id
resource_id: path.resource_id
name: requestBody.name
tool_simulation_config: requestBody.tool_simulation_config
method: generated
generated: '2026-09-26'
- target: $.paths['/evals/{resource_type}/{resource_id}/test-sets/{test_set_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a test set
effect: destructive
questions:
- How do I delete a test set?
- Can I delete a test set and its test cases together?
instructions:
- text: Delete test set {test_set_id} from {resource_type} {resource_id}.
slots:
test_set_id: path.test_set_id
resource_type: path.resource_type
resource_id: path.resource_id
- text: 'Delete test set {test_set_id} on agent {resource_id}, including its test cases: {delete_test_cases}.'
slots:
test_set_id: path.test_set_id
resource_id: path.resource_id
delete_test_cases: query.delete_test_cases
method: generated
generated: '2026-09-26'