Skip to main content
GET
List retrieval golden sets
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/knowledge/goldenSets/list lists the retrieval golden sets whose every namespace the credential can read, newest first: the newest 50 active sets, and with includeArchived=true the newest 50 archived sets too. It needs knowledge:read. See Retrieval golden sets. Each item is { set, latestRun, baseline, previousChunkerBaseline }: the KnowledgeGoldenSet, its newest run, the baseline that run was judged against, and the previous chunker’s baseline when the newest run is the first under a new chunker version. Each run has the KnowledgeGoldenSetRun shape and is null when absent. Each status is read in a bounded window of its newest 200 sets. meta.partial is true when a window stopped with sets unread or more than 50 matched. Page with limit and cursor. An unknown, empty or repeated parameter, or an includeArchived other than true or false, answers 400 bad_request.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

includeArchived
enum<string>
default:false

true to list archived sets as well; default false.

Available options:
true,
false
namespace
string

Only the sets that search this namespace; it must be one the caller may read.

Minimum string length: 1
limit
integer
default:50

Items per page, 1 to 100 (default 50); a larger value is a 400 too_big. A page may hold fewer items than limit while meta.hasMore is true; continue with meta.nextCursor.

Required range: 1 <= x <= 100
cursor
string

The previous page's meta.nextCursor; any other value is 400.

Minimum string length: 1

Response

Golden sets

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.