Tools

Rank a candidate tool against PiperMatch on a set of cases

Dev / CI fixture for retrieval-quality probes. Embeds the candidate tool description against the live PiperMatch index and scores it on each case in cases (or the legacy queries shorthand). Each case carries an explicit expect — "candidate", {owner: "name"}, or "top_k" (with a sibling top_k integer). Aggregate pass is true when every case passes its expectation by min_margin.

post/v1/tools/probe

Request

  • Base URL: http://localhost:9998
  • URL: http://localhost:9998/v1/tools/probe
  • Auth: HTTP bearer

Request body

queriesstring[]

Legacy shorthand — expands to cases: [{query, expect: "candidate"}]. Mutually exclusive with cases.

min_marginnumber

Minimum cosine margin a passing case must achieve over the runner-up. Default 0.03.

Response

Probe results (per-case + aggregate)

candidatestring required
cases_totalinteger required
cases_passedinteger required
min_marginnumber required
passboolean required

True when every case passed its expectation by min_margin.

Changes

No recorded changes to this operation across all 1 revision of this API.