@sanity/ailf-studio 2.3.0 → 2.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +115 -3
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -530,6 +530,41 @@ var GLOSSARY = {
|
|
|
530
530
|
triggerCrossRepo: {
|
|
531
531
|
label: "Cross-Repo",
|
|
532
532
|
long: "Cross-repo \u2014 triggered from another repository via the dispatch API. Used when external repos want to validate their docs against AILF tasks."
|
|
533
|
+
},
|
|
534
|
+
// -- Variant values (per-test docs condition) ------------------------------
|
|
535
|
+
variantGold: {
|
|
536
|
+
label: "Gold",
|
|
537
|
+
long: "Gold variant \u2014 the relevant docs were injected into the prompt as context. This is the ceiling condition: the best the documentation can do."
|
|
538
|
+
},
|
|
539
|
+
variantBaseline: {
|
|
540
|
+
label: "Baseline",
|
|
541
|
+
long: "Baseline variant \u2014 no documentation in the prompt. This is the floor condition: what the model already knows from its training data, used as the control for doc lift."
|
|
542
|
+
},
|
|
543
|
+
// -- Execution mode values (how the model was driven) ----------------------
|
|
544
|
+
engineNaive: {
|
|
545
|
+
label: "Naive",
|
|
546
|
+
long: "Naive \u2014 the in-house agentic harness with naive prompting. The model runs in an agent loop with no doc-targeting strategy."
|
|
547
|
+
},
|
|
548
|
+
engineOptimized: {
|
|
549
|
+
label: "Optimized",
|
|
550
|
+
long: "Optimized \u2014 the in-house agentic harness with optimized prompting. The model runs in an agent loop tuned for documentation retrieval."
|
|
551
|
+
},
|
|
552
|
+
engineNormal: {
|
|
553
|
+
label: "Normal",
|
|
554
|
+
long: "Normal \u2014 a direct vendor-API call. The model produces a single-shot completion with no agent loop."
|
|
555
|
+
},
|
|
556
|
+
// -- Status values (per-test outcome) --------------------------------------
|
|
557
|
+
statusFail: {
|
|
558
|
+
label: "Fail",
|
|
559
|
+
long: "Fail \u2014 the model produced no usable output (empty response, API error, or token exhaustion). Distinct from a low score on output that was produced."
|
|
560
|
+
},
|
|
561
|
+
statusLowDim: {
|
|
562
|
+
label: "Low dim",
|
|
563
|
+
long: "Low dim \u2014 the run produced output but at least one grading dimension scored below 60."
|
|
564
|
+
},
|
|
565
|
+
statusOk: {
|
|
566
|
+
label: "OK",
|
|
567
|
+
long: "OK \u2014 the run produced output and every grading dimension scored 60 or above."
|
|
533
568
|
}
|
|
534
569
|
};
|
|
535
570
|
|
|
@@ -682,11 +717,88 @@ Click into any report for the full breakdown: per-area scores, diagnostics, and
|
|
|
682
717
|
},
|
|
683
718
|
{
|
|
684
719
|
"id": "reading-score-trends",
|
|
685
|
-
"title": "Reading
|
|
686
|
-
"body":
|
|
720
|
+
"title": "Reading the Analytics View",
|
|
721
|
+
"body": `## What this view answers
|
|
722
|
+
|
|
723
|
+
The Analytics view is built around one question: **did your doc changes move the
|
|
724
|
+
score, and why?** Rather than open on a chart and leave you to find the story,
|
|
725
|
+
it leads with the answer \u2014 a plain-language verdict and the areas that moved
|
|
726
|
+
most \u2014 then lets you drill down into the evidence.
|
|
727
|
+
|
|
728
|
+
## The control bar
|
|
729
|
+
|
|
730
|
+
The top row picks what you're looking at:
|
|
731
|
+
|
|
732
|
+
- **Metric** \u2014 which number to track (composite score, doc lift, retrieval gap,
|
|
733
|
+
and so on).
|
|
734
|
+
- **Break down by** \u2014 how to split it (feature area, team, model, source).
|
|
735
|
+
- **Bucket** \u2014 how to group runs over time (per run, per day).
|
|
736
|
+
- **Range** \u2014 how far back to look (for example, the last 30 days).
|
|
737
|
+
|
|
738
|
+
The second row holds the active **filter chips** \u2014 use _Add filter_ to scope to
|
|
739
|
+
a team, source, or mode \u2014 and a scope hint (reports in scope vs. total). Every
|
|
740
|
+
knob and filter is saved in the URL, so a shared link reproduces exactly what
|
|
741
|
+
you see. Use **Copy link** to grab it.
|
|
742
|
+
|
|
743
|
+
## Overall \u2014 the read
|
|
744
|
+
|
|
745
|
+
The **verdict strip** is the headline. In plain language it says whether docs
|
|
746
|
+
are pulling ahead or slipping, and shows the headline metric with its change (\u0394)
|
|
747
|
+
since the start of the range, a model \u2192 agent \u2192 docs decomposition bar, and a
|
|
748
|
+
coverage cell (how many reports and high-confidence groups are in scope).
|
|
749
|
+
|
|
750
|
+
## Movers
|
|
751
|
+
|
|
752
|
+
The **movers board** leads with the top **Improved** and **Regressed** areas as
|
|
753
|
+
cards \u2014 not the average. Each card shows the area, its value and \u0394, a
|
|
754
|
+
decomposition bar, the release that most likely caused the move, and a
|
|
755
|
+
confidence read. A low-confidence **watch** callout flags big swings backed by
|
|
756
|
+
too few runs: watch them, don't celebrate them yet.
|
|
757
|
+
|
|
758
|
+
Click a mover card to reveal and decompose that series in the evidence chart.
|
|
759
|
+
|
|
760
|
+
## The evidence
|
|
761
|
+
|
|
762
|
+
The **focus chart** has two modes:
|
|
763
|
+
|
|
764
|
+
- **Compare** plots the selected series over time. It defaults to a focused set
|
|
765
|
+
(the movers plus the highest-volume areas) with a _show all_ expansion, and
|
|
766
|
+
draws release markers inline.
|
|
767
|
+
- **Decompose** shows the ceiling / floor / actual band for a single series,
|
|
768
|
+
with causal story cards anchored to each release marker (for example, _"Docs
|
|
769
|
+
+3 ~5 \u22121 \u2192 doc-lift +8 measured around this release"_).
|
|
770
|
+
|
|
771
|
+
Decompose is offered for the composite metric broken down by feature area \u2014 the
|
|
772
|
+
case where the model \u2192 agent \u2192 docs story is meaningful.
|
|
773
|
+
|
|
774
|
+
## The breakdown table
|
|
775
|
+
|
|
776
|
+
One row per area (or per whatever you broke down by), each with an inline
|
|
777
|
+
decomposition bar, a sparkline, confidence, \u0394, "docs add," and a report count.
|
|
778
|
+
Sort any column, and click a row to cross-highlight it in the chart. Export the
|
|
779
|
+
table to CSV.
|
|
780
|
+
|
|
781
|
+
## Meaningful change vs. noise
|
|
782
|
+
|
|
783
|
+
Small movements between runs are normal \u2014 they come from model non-determinism
|
|
784
|
+
and grader variance. This view leans on **confidence** (how many runs back a
|
|
785
|
+
number) and the **movers ranking** rather than a single \xB1point threshold: trust
|
|
786
|
+
a sustained move in a high-confidence area over a large swing in a
|
|
787
|
+
low-confidence one. The low-confidence watch exists precisely to stop you
|
|
788
|
+
over-reading thin data.
|
|
789
|
+
|
|
790
|
+
## Measured, not invented
|
|
791
|
+
|
|
792
|
+
The causal story is computed from real data, never fabricated. Release markers
|
|
793
|
+
come from the doc-change counts already recorded in each report, and the
|
|
794
|
+
"measured around this release" doc-lift effect is derived from the real ceiling
|
|
795
|
+
\u2212 floor series around the marker. Per-area prose ("the editor API changed") is
|
|
796
|
+
intentionally not shown \u2014 the data carries change counts, not hand-written
|
|
797
|
+
explanations.`,
|
|
687
798
|
"source": "docs/help/reading-score-trends.md",
|
|
688
799
|
"related": [
|
|
689
800
|
"scoring-model",
|
|
801
|
+
"doc-lift",
|
|
690
802
|
"comparing-runs"
|
|
691
803
|
]
|
|
692
804
|
},
|
|
@@ -817,7 +929,7 @@ the evaluated tasks.`,
|
|
|
817
929
|
{
|
|
818
930
|
"id": "glossary",
|
|
819
931
|
"title": "Glossary",
|
|
820
|
-
"body": "**Overall Score**\n: A weighted average across all feature areas, using the gold scoring profile: Task Completion (50%), Code Correctness (25%), and Doc Coverage (25%).\n\n**Doc Lift**\n: How much the docs help, compared to the model's training data alone. Calculated as ceiling minus floor, where ceiling includes Doc Coverage and floor does not. Higher is better.\n\n**Actual Score**\n: How well an AI agent scores when it has to find docs on its own through web search and page fetching. This is the real-world scenario. Only available in full mode.\n\n**Retrieval Gap**\n: The score lost because agents can't find or use all the relevant docs. Calculated as ceiling minus actual. Lower is better; zero means agents find everything.\n\n**Infra Efficiency**\n: What percentage of the docs' potential quality actually reaches agents (actual \xF7 ceiling). 100% means agents find and use all relevant docs perfectly.\n\n**Floor**\n: Output-quality composite without documentation \u2014 Task Completion (60%) and Code Correctness (40%) only. Doc Coverage is excluded because it's undefined when no docs are provided. This tells you what the model already knows from its training data.\n\n**Ceiling**\n: Score with gold-standard docs injected directly into the prompt. This is the best the documentation can do.\n\n**Actual**\n: Score when an AI agent finds docs on its own through web search and page fetching. This is the real-world experience.\n\n**Ret. Gap**\n: Quality lost to discoverability (ceiling minus actual). The gap between what the docs could deliver and what agents actually get.\n\n**Efficiency**\n: What fraction of the docs' quality reaches agents in practice (actual \xF7 ceiling, shown as a percentage).\n\n**Inverted Retrieval Gap**\n: \u26A0\uFE0F Inverted retrieval gap: agents that can't find the docs actually score higher, because the docs hurt performance. This usually means there's a doc quality problem.\n\n**Score**\n: Ceiling composite for this feature area: Task Completion \xD7 50% + Code Correctness \xD7 25% + Doc Coverage \xD7 25%.\n\n**Task Completion**\n: Can the LLM implement the requested feature? Graded 0\u2013100.\n\n**Code Correctness**\n: Is the generated code idiomatic, correct, and following best practices? Graded 0\u2013100.\n\n**Doc Coverage**\n: Did the docs provide the information needed to implement the feature? Graded 0\u2013100. This dimension only contributes to the ceiling composite (with docs) \u2014 it's excluded from the floor composite because it's undefined without documentation.\n\n**Tests**\n: Number of test cases in this feature area.\n\n**Overall \u0394**\n: Change in overall score between the two runs. Positive means the experiment scored higher.\n\n**Actual \u0394**\n: Change in actual (agent-retrieved) score between runs. Positive means agents did better.\n\n**Ret. Gap \u0394**\n: Change in retrieval gap between runs. Negative is good here: it means the gap shrank and agents found more relevant docs.\n\n**Efficiency \u0394**\n: Change in infrastructure efficiency between runs. Positive means agents are capturing more of the docs' potential.\n\n**Baseline**\n: The reference run you're comparing against.\n\n**Experiment**\n: The new run you're evaluating.\n\n**Delta**\n: Difference between experiment and baseline. Positive means improvement, negative means regression.\n\n**Change**\n: Whether the change is meaningful: improved, regressed, or unchanged (within the noise threshold).\n\n**Low-Scoring Judgments**\n: The grading model's explanations for tests that scored below 70/100.\n\n**Judgment Reason**\n: The grading model's natural language explanation of what went wrong.\n\n**Strong (80+)**\n: Feature areas scoring 80 or above. The docs are working well for these features \u2014 AI agents produce correct, complete implementations.\n\n**Needs Attention (70\u201379)**\n: Feature areas scoring 70\u201379. These are okay but could be improved \u2014 there may be gaps in specific dimensions like doc coverage or code correctness.\n\n**Weak (<70)**\n: Feature areas scoring below 70. The docs are not providing enough support for AI agents to implement these features correctly.\n\n**Negative Doc Lift**\n: Number of areas where the documentation actually hurts AI performance \u2014 the model scores higher without docs than with them. This usually means the docs contain outdated patterns or incorrect examples.\n\n**Weak Areas**\n: Feature areas where the overall score is below 70. These need the most attention \u2014 low scores mean AI agents consistently struggle to implement these features.\n\n**Docs Hurt Performance**\n: Areas where the floor score (no docs) is higher than the ceiling score (with docs). The documentation may be actively misleading the model. These docs should be reviewed.\n\n**Retrieval Issues**\n: Areas where AI agents can find less than 70% of the available doc quality. The docs exist and are good, but agents can't discover them through search. Consider improving page titles, metadata, or search engine indexing.\n\n**Dimension Weaknesses**\n: Individual grading dimensions scoring below 50 within an area. These are the specific skills where AI agents fail most \u2014 task completion (can it build the feature?), code correctness (is the code right?), or doc coverage (did it use the docs?).\n\n**Efficiency Anomalies**\n: Areas where agent efficiency exceeds 100% \u2014 meaning agents perform better with self-found docs than with gold-standard docs injected directly. This can indicate doc quality issues (injected docs confuse the model) or agent memorization.\n\n**Doc Lift Wins**\n: Areas where documentation boosts AI performance by 5 or more points. Higher doc lift means the docs are providing crucial information that the model doesn't already know.\n\n**Retrieval Excellence**\n: Areas where AI agents successfully find and use at least 85% of the available doc quality through web search. Good retrieval means your docs are well-indexed and easy for agents to discover.\n\n**Model Breakdown**\n: Break down scores by individual LLM model. The default 'All Models' view shows the cross-model average. Select a specific model to see how it performed independently \u2014 useful for spotting models that struggle with specific feature areas.\n\n**Strengths**\n: What's working well: high-scoring areas, dimensions where the docs are strong, and areas where AI agents successfully find and use the documentation.\n\n**Recommendations**\n: Prioritized remediation plan from gap analysis. Each recommendation identifies a documentation problem, the affected feature area, and the estimated score lift from fixing it.\n\n**Total Potential Lift**\n: Aggregate potential score lift if all identified gaps were fixed. This is a conservative estimate \u2014 each gap targets the median of non-bottlenecked dimensions, not 100.\n\n**Failure Mode**\n: The type of failure the grader emitted. Cross-cutting modes apply to any dimension (api-error, model-limitation, false-floor, unclassified). Per-dimension extensions cover documentation problems (missing-docs, incorrect-docs, outdated-docs, poor-structure), spec adherence (spec-mismatch), tool use (tool-misuse, chaotic-process, missing-recovery), and knowledge probes (factual-error, incompleteness, currency-violation, hallucination).\n\n**Estimated Lift**\n: Estimated composite score improvement if this gap is fully fixed. Based on raising bottleneck dimensions to the median of non-bottlenecked dimensions.\n\n**Confidence**\n: How confident we are in this diagnosis (D0049 ceiling-cross-check derivation). High = the grader's emitted failure mode agrees with the structural ceiling-decomposition signal. Medium = signals disagree (or the ceiling pattern is not informative for this score). Low = passing scores never classify; treat as absent.\n\n**Agent Behavior**\n: How AI agents interacted with your documentation during evaluation: what they searched for, which pages they visited, and how much time they spent on network requests.\n\n**Search Queries**\n: The exact search queries agents used to find documentation. Helps you understand how agents discover your content and whether your docs appear for relevant queries.\n\n**Unique Doc Slugs**\n: Documentation page slugs that agents actually visited during evaluation. Compare against canonical docs to see if agents found the right pages.\n\n**External Domains**\n: Non-Sanity domains that agents contacted during evaluation. High external domain counts may indicate agents couldn't find what they needed in your docs.\n\n**Avg Pages Visited**\n: Average number of documentation pages visited per test. Higher counts can mean agents need to consult many pages (complex task) or can't find the right one quickly.\n\n**Avg Searches**\n: Average number of web searches performed per test. High search counts can indicate docs are hard to discover through search engines.\n\n**Avg Network Time**\n: Average time spent on network requests per test. Includes page fetches, search queries, and API calls.\n\n**Total Requests**\n: Total number of HTTP requests the agent made during the test, including searches, page visits, and API calls.\n\n**Total Bytes Downloaded**\n: Total bytes downloaded by the agent. Large downloads may indicate the agent is fetching many pages or very large documents.\n\n**Task Completion \u0394**\n: Change in task completion between runs. Positive means implementations are more complete.\n\n**Code Correctness \u0394**\n: Change in code correctness between runs. Positive means better code quality.\n\n**Doc Coverage \u0394**\n: Change in doc coverage between runs. Positive means the docs are providing more useful information.\n\n**Area \u0394**\n: Score change for this area compared to the previous evaluation run.\n\n**Production**\n: Production source \u2014 docs fetched from the live production dataset. Scores reflect what real users and AI agents experience today.\n\n**Branch**\n: Branch source \u2014 docs fetched from a branch or draft dataset. Use this to preview how content changes affect scores before publishing.\n\n**Local**\n: Local source \u2014 docs fetched from local files or a local dev server. Useful for testing doc changes before pushing.\n\n**Score**\n: The overall ceiling composite for this evaluation run: Task Completion (50%), Code Correctness (25%), and Doc Coverage (25%), averaged across all feature areas.\n\n**Mode**\n: The evaluation mode determines which reference points are measured. Different modes test different aspects of how AI agents interact with documentation.\n\n**Trigger**\n: What initiated this evaluation run. Knowing the trigger helps you understand whether a score change was from a content edit, a code deploy, or a scheduled check.\n\n**Baseline**\n: Baseline mode \u2014 tests the model with gold-standard docs injected directly. Measures ceiling performance (best the docs can do).\n\n**Full**\n: Full mode \u2014 runs baseline + agentic. Compares ceiling (injected docs) against actual (agent-retrieved docs) to measure retrieval gap and infrastructure efficiency.\n\n**Agentic**\n: Agentic mode \u2014 the AI agent finds docs on its own via web search. Measures real-world performance: can agents actually discover and use your documentation?\n\n**Observed**\n: Observed mode \u2014 records how agents interact with docs without scoring. Captures search queries, pages visited, and browsing patterns for analysis.\n\n**Debug**\n: Debug mode \u2014 a diagnostic run for pipeline development. May use non-standard configurations or limited task sets.\n\n**Manual**\n: Manually triggered \u2014 someone ran the evaluation pipeline by hand, either locally or via the Studio UI.\n\n**CI**\n: CI-triggered \u2014 the evaluation ran automatically as part of a pull request or merge pipeline.\n\n**Scheduled**\n: Scheduled \u2014 the evaluation ran on a recurring schedule (e.g. nightly or weekly) to track score trends over time.\n\n**Webhook**\n: Webhook-triggered \u2014 a content change in Sanity triggered the evaluation automatically. Helps catch doc regressions early.\n\n**Cross-Repo**\n: Cross-repo \u2014 triggered from another repository via the dispatch API. Used when external repos want to validate their docs against AILF tasks.",
|
|
932
|
+
"body": "**Overall Score**\n: A weighted average across all feature areas, using the gold scoring profile: Task Completion (50%), Code Correctness (25%), and Doc Coverage (25%).\n\n**Doc Lift**\n: How much the docs help, compared to the model's training data alone. Calculated as ceiling minus floor, where ceiling includes Doc Coverage and floor does not. Higher is better.\n\n**Actual Score**\n: How well an AI agent scores when it has to find docs on its own through web search and page fetching. This is the real-world scenario. Only available in full mode.\n\n**Retrieval Gap**\n: The score lost because agents can't find or use all the relevant docs. Calculated as ceiling minus actual. Lower is better; zero means agents find everything.\n\n**Infra Efficiency**\n: What percentage of the docs' potential quality actually reaches agents (actual \xF7 ceiling). 100% means agents find and use all relevant docs perfectly.\n\n**Floor**\n: Output-quality composite without documentation \u2014 Task Completion (60%) and Code Correctness (40%) only. Doc Coverage is excluded because it's undefined when no docs are provided. This tells you what the model already knows from its training data.\n\n**Ceiling**\n: Score with gold-standard docs injected directly into the prompt. This is the best the documentation can do.\n\n**Actual**\n: Score when an AI agent finds docs on its own through web search and page fetching. This is the real-world experience.\n\n**Ret. Gap**\n: Quality lost to discoverability (ceiling minus actual). The gap between what the docs could deliver and what agents actually get.\n\n**Efficiency**\n: What fraction of the docs' quality reaches agents in practice (actual \xF7 ceiling, shown as a percentage).\n\n**Inverted Retrieval Gap**\n: \u26A0\uFE0F Inverted retrieval gap: agents that can't find the docs actually score higher, because the docs hurt performance. This usually means there's a doc quality problem.\n\n**Score**\n: Ceiling composite for this feature area: Task Completion \xD7 50% + Code Correctness \xD7 25% + Doc Coverage \xD7 25%.\n\n**Task Completion**\n: Can the LLM implement the requested feature? Graded 0\u2013100.\n\n**Code Correctness**\n: Is the generated code idiomatic, correct, and following best practices? Graded 0\u2013100.\n\n**Doc Coverage**\n: Did the docs provide the information needed to implement the feature? Graded 0\u2013100. This dimension only contributes to the ceiling composite (with docs) \u2014 it's excluded from the floor composite because it's undefined without documentation.\n\n**Tests**\n: Number of test cases in this feature area.\n\n**Overall \u0394**\n: Change in overall score between the two runs. Positive means the experiment scored higher.\n\n**Actual \u0394**\n: Change in actual (agent-retrieved) score between runs. Positive means agents did better.\n\n**Ret. Gap \u0394**\n: Change in retrieval gap between runs. Negative is good here: it means the gap shrank and agents found more relevant docs.\n\n**Efficiency \u0394**\n: Change in infrastructure efficiency between runs. Positive means agents are capturing more of the docs' potential.\n\n**Baseline**\n: The reference run you're comparing against.\n\n**Experiment**\n: The new run you're evaluating.\n\n**Delta**\n: Difference between experiment and baseline. Positive means improvement, negative means regression.\n\n**Change**\n: Whether the change is meaningful: improved, regressed, or unchanged (within the noise threshold).\n\n**Low-Scoring Judgments**\n: The grading model's explanations for tests that scored below 70/100.\n\n**Judgment Reason**\n: The grading model's natural language explanation of what went wrong.\n\n**Strong (80+)**\n: Feature areas scoring 80 or above. The docs are working well for these features \u2014 AI agents produce correct, complete implementations.\n\n**Needs Attention (70\u201379)**\n: Feature areas scoring 70\u201379. These are okay but could be improved \u2014 there may be gaps in specific dimensions like doc coverage or code correctness.\n\n**Weak (<70)**\n: Feature areas scoring below 70. The docs are not providing enough support for AI agents to implement these features correctly.\n\n**Negative Doc Lift**\n: Number of areas where the documentation actually hurts AI performance \u2014 the model scores higher without docs than with them. This usually means the docs contain outdated patterns or incorrect examples.\n\n**Weak Areas**\n: Feature areas where the overall score is below 70. These need the most attention \u2014 low scores mean AI agents consistently struggle to implement these features.\n\n**Docs Hurt Performance**\n: Areas where the floor score (no docs) is higher than the ceiling score (with docs). The documentation may be actively misleading the model. These docs should be reviewed.\n\n**Retrieval Issues**\n: Areas where AI agents can find less than 70% of the available doc quality. The docs exist and are good, but agents can't discover them through search. Consider improving page titles, metadata, or search engine indexing.\n\n**Dimension Weaknesses**\n: Individual grading dimensions scoring below 50 within an area. These are the specific skills where AI agents fail most \u2014 task completion (can it build the feature?), code correctness (is the code right?), or doc coverage (did it use the docs?).\n\n**Efficiency Anomalies**\n: Areas where agent efficiency exceeds 100% \u2014 meaning agents perform better with self-found docs than with gold-standard docs injected directly. This can indicate doc quality issues (injected docs confuse the model) or agent memorization.\n\n**Doc Lift Wins**\n: Areas where documentation boosts AI performance by 5 or more points. Higher doc lift means the docs are providing crucial information that the model doesn't already know.\n\n**Retrieval Excellence**\n: Areas where AI agents successfully find and use at least 85% of the available doc quality through web search. Good retrieval means your docs are well-indexed and easy for agents to discover.\n\n**Model Breakdown**\n: Break down scores by individual LLM model. The default 'All Models' view shows the cross-model average. Select a specific model to see how it performed independently \u2014 useful for spotting models that struggle with specific feature areas.\n\n**Strengths**\n: What's working well: high-scoring areas, dimensions where the docs are strong, and areas where AI agents successfully find and use the documentation.\n\n**Recommendations**\n: Prioritized remediation plan from gap analysis. Each recommendation identifies a documentation problem, the affected feature area, and the estimated score lift from fixing it.\n\n**Total Potential Lift**\n: Aggregate potential score lift if all identified gaps were fixed. This is a conservative estimate \u2014 each gap targets the median of non-bottlenecked dimensions, not 100.\n\n**Failure Mode**\n: The type of failure the grader emitted. Cross-cutting modes apply to any dimension (api-error, model-limitation, false-floor, unclassified). Per-dimension extensions cover documentation problems (missing-docs, incorrect-docs, outdated-docs, poor-structure), spec adherence (spec-mismatch), tool use (tool-misuse, chaotic-process, missing-recovery), and knowledge probes (factual-error, incompleteness, currency-violation, hallucination).\n\n**Estimated Lift**\n: Estimated composite score improvement if this gap is fully fixed. Based on raising bottleneck dimensions to the median of non-bottlenecked dimensions.\n\n**Confidence**\n: How confident we are in this diagnosis (D0049 ceiling-cross-check derivation). High = the grader's emitted failure mode agrees with the structural ceiling-decomposition signal. Medium = signals disagree (or the ceiling pattern is not informative for this score). Low = passing scores never classify; treat as absent.\n\n**Agent Behavior**\n: How AI agents interacted with your documentation during evaluation: what they searched for, which pages they visited, and how much time they spent on network requests.\n\n**Search Queries**\n: The exact search queries agents used to find documentation. Helps you understand how agents discover your content and whether your docs appear for relevant queries.\n\n**Unique Doc Slugs**\n: Documentation page slugs that agents actually visited during evaluation. Compare against canonical docs to see if agents found the right pages.\n\n**External Domains**\n: Non-Sanity domains that agents contacted during evaluation. High external domain counts may indicate agents couldn't find what they needed in your docs.\n\n**Avg Pages Visited**\n: Average number of documentation pages visited per test. Higher counts can mean agents need to consult many pages (complex task) or can't find the right one quickly.\n\n**Avg Searches**\n: Average number of web searches performed per test. High search counts can indicate docs are hard to discover through search engines.\n\n**Avg Network Time**\n: Average time spent on network requests per test. Includes page fetches, search queries, and API calls.\n\n**Total Requests**\n: Total number of HTTP requests the agent made during the test, including searches, page visits, and API calls.\n\n**Total Bytes Downloaded**\n: Total bytes downloaded by the agent. Large downloads may indicate the agent is fetching many pages or very large documents.\n\n**Task Completion \u0394**\n: Change in task completion between runs. Positive means implementations are more complete.\n\n**Code Correctness \u0394**\n: Change in code correctness between runs. Positive means better code quality.\n\n**Doc Coverage \u0394**\n: Change in doc coverage between runs. Positive means the docs are providing more useful information.\n\n**Area \u0394**\n: Score change for this area compared to the previous evaluation run.\n\n**Production**\n: Production source \u2014 docs fetched from the live production dataset. Scores reflect what real users and AI agents experience today.\n\n**Branch**\n: Branch source \u2014 docs fetched from a branch or draft dataset. Use this to preview how content changes affect scores before publishing.\n\n**Local**\n: Local source \u2014 docs fetched from local files or a local dev server. Useful for testing doc changes before pushing.\n\n**Score**\n: The overall ceiling composite for this evaluation run: Task Completion (50%), Code Correctness (25%), and Doc Coverage (25%), averaged across all feature areas.\n\n**Mode**\n: The evaluation mode determines which reference points are measured. Different modes test different aspects of how AI agents interact with documentation.\n\n**Trigger**\n: What initiated this evaluation run. Knowing the trigger helps you understand whether a score change was from a content edit, a code deploy, or a scheduled check.\n\n**Baseline**\n: Baseline mode \u2014 tests the model with gold-standard docs injected directly. Measures ceiling performance (best the docs can do).\n\n**Full**\n: Full mode \u2014 runs baseline + agentic. Compares ceiling (injected docs) against actual (agent-retrieved docs) to measure retrieval gap and infrastructure efficiency.\n\n**Agentic**\n: Agentic mode \u2014 the AI agent finds docs on its own via web search. Measures real-world performance: can agents actually discover and use your documentation?\n\n**Observed**\n: Observed mode \u2014 records how agents interact with docs without scoring. Captures search queries, pages visited, and browsing patterns for analysis.\n\n**Debug**\n: Debug mode \u2014 a diagnostic run for pipeline development. May use non-standard configurations or limited task sets.\n\n**Manual**\n: Manually triggered \u2014 someone ran the evaluation pipeline by hand, either locally or via the Studio UI.\n\n**CI**\n: CI-triggered \u2014 the evaluation ran automatically as part of a pull request or merge pipeline.\n\n**Scheduled**\n: Scheduled \u2014 the evaluation ran on a recurring schedule (e.g. nightly or weekly) to track score trends over time.\n\n**Webhook**\n: Webhook-triggered \u2014 a content change in Sanity triggered the evaluation automatically. Helps catch doc regressions early.\n\n**Cross-Repo**\n: Cross-repo \u2014 triggered from another repository via the dispatch API. Used when external repos want to validate their docs against AILF tasks.\n\n**Gold**\n: Gold variant \u2014 the relevant docs were injected into the prompt as context. This is the ceiling condition: the best the documentation can do.\n\n**Baseline**\n: Baseline variant \u2014 no documentation in the prompt. This is the floor condition: what the model already knows from its training data, used as the control for doc lift.\n\n**Naive**\n: Naive \u2014 the in-house agentic harness with naive prompting. The model runs in an agent loop with no doc-targeting strategy.\n\n**Optimized**\n: Optimized \u2014 the in-house agentic harness with optimized prompting. The model runs in an agent loop tuned for documentation retrieval.\n\n**Normal**\n: Normal \u2014 a direct vendor-API call. The model produces a single-shot completion with no agent loop.\n\n**Fail**\n: Fail \u2014 the model produced no usable output (empty response, API error, or token exhaustion). Distinct from a low score on output that was produced.\n\n**Low dim**\n: Low dim \u2014 the run produced output but at least one grading dimension scored below 60.\n\n**OK**\n: OK \u2014 the run produced output and every grading dimension scored 60 or above.",
|
|
821
933
|
"source": "packages/shared/src/glossary.ts",
|
|
822
934
|
"tags": [
|
|
823
935
|
"reference",
|