docs: consolidate evals page updates (replaces #698, #704, #715, #716, #732) - #742
Draft
jordanc-relevanceai wants to merge 1 commit into
Draft
docs: consolidate evals page updates (replaces #698, #704, #715, #716, #732)#742jordanc-relevanceai wants to merge 1 commit into
jordanc-relevanceai wants to merge 1 commit into
Conversation
Folds #698, #704, #715, #732 and the evals half of #716 into one change. Omits the four cost-breakdown columns from #715: evals-cost-comparison targets a single internal email, so no customer can see them. Corrects the auto-diagnosis alert-channel source and drops two stale flag caveats. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This was referenced Jul 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Consolidates the five open PRs editing
build/agents/build-your-agent/evals.mdxinto one change. Branched frommain.create-a-workforce.mdxcross-linkReplaces these PRs (now closed)
Five PRs editing one file in five places would have conflicted on merge even though the sections themselves barely overlapped.
Omitted: the four cost-breakdown columns from #715
#715 documented Scenario credits, Execution credits, Checks credits and Checks actions as columns you toggle via the visibility picker. They are gated on the
evals-cost-comparisonflag, whose only release condition is a person-property match on one internal email address (danial@relevanceai.com).No customer can see these columns, so documenting them would send readers hunting for a picker entry that isn't there. Left out entirely rather than caveated. Worth revisiting when the flag widens — the rest of #715's table content is in, since
evals-column-sortingis at 100%.Two smaller notes on #715: some cost columns are additionally gated to
resourceType === "agent", so they would never have appeared for Workforces; and I could not verify the three-way credits breakdown modal, so that content is also left out.Corrections to #732's auto-diagnosis
The required alert channel is on Inventor, not the alarm. #732 said auto-diagnosis "requires at least one alert channel configured on the alarm" and delivers "to the alert channels configured by the alarm creator". In
ObservabilityEvalAlertConfig.vue, the check readsinventorSettingsQuery.data.value?.settings.notification_channels— the Inventor settings modal's alerts tab — and the toggle stays hidden until that is set up. The code comment adds: "once enabled, delivery uses the enabler's channels, not the viewer's.""Inventor is an Enterprise-only feature" softened to the pilot framing. There is no plan or tier gate in the code. Visibility requires three flags —
alarm-auto-diagnose-ui(100%),inventor-scheduled-check-ins-fe(100%), andinvent-v3, which is cohort-limited to "Relevance AI Employees" and "Invent + Evals Pilot (Mid 2026)". So the real constraint is the Inventor pilot, which is how the Invent page already describes itself.Stale caveats dropped
evals-toolusage-argument-matcherfeature flag" — that flag is at 100% rollout. It also named an internal flag key in customer docs, which we don't do elsewhere on the page.observability-alarmsis at 100%.Verified as accurate and kept
exact,contains,regex, and has-a-value, confirmed inMatcherEditor.vue. Update evals docs: Add tool-usage argument matching feature #704's "Exact match / Contains / Regex / Not empty" naming is closer to the UI than the changelog wording in the recently closed changelog: Tool Argument Matching Check Type for Evals #727, so Update evals docs: Add tool-usage argument matching feature #704's table is used.eval-version-pickeris at 100%, and the Workforce topology-pinning caveat comes straight from the tool schema.Test plan
/integrations/mcp/mcp-server#running-evaluationsresolves (depends on docs: consolidate MCP run-only access + cancellation tools, fix invented tool signatures (replaces #730, #733) #741)