Training Data

Search existing knowledge for a passage

Searches one passage or claim across Q&A, training files, and live help-center articles. Returns ranked candidates and query-focused excerpts without judging or writing. Similarity is an embedding score, not factual confidence; calibrate thresholds on representative examples and retain keyword-only results (similarity null). Retrieval and excerpts can miss relevant facts. Fetch full sources for decisions. Split long documents into bounded sections and audit each section before upload. Latency and embedding work depend on query size and service load.

POST

/v2/training_data/search

curl --request POST \
  --url https://do.featurebase.app/v2/training_data/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-08-19.orbit' \
  --header 'Content-Type: application/json' \
  --data '
{
  "excludeIds": [
    "67ec1234abcd5678ef901235"
  ],
  "kinds": [
    "help_center_article",
    "qna"
  ],
  "query": "Refunds are processed within 14 days of the request.",
  "topK": 8
}
'

{
  "candidates": [
    {
      "externalId": null,
      "id": "67ec1234abcd5678ef901236",
      "kind": "qna",
      "questions": [
        "How do I request a refund?"
      ],
      "revision": 1,
      "section": null,
      "similarity": 0.61,
      "source": null,
      "text": "You can request a refund within 30 days from **Settings → Billing**.",
      "title": "Refund requests",
      "url": null
    }
  ],
  "object": "knowledge_search",
  "query": "Refunds are processed within 14 days of the request.",
  "timings": {
    "retrievalMs": 690
  }
}

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover

Example: 2026-08-19.orbit

Body

excludeIdsstring[]

Q&A entry / training file IDs to leave out — typically the item you are about to update.

Maximum array length: 20

kindsenum<string>[]

Restrict to some kinds of knowledge. Default: all three (Q&A entries, training files, live help-center articles).

Required array length: 1 - 3

querystringrequired

A passage, claim, or question to find existing knowledge for — for example one section of a document you are about to upload. Compared by meaning and by keywords.

Required string length: 1 - 4000

Example: Refunds are processed within 14 days of the request.

topKintegerdefault:8

How many items to return (1–20).

Required range: 1 <= x <= 20

Example: 8

Response

Success

candidatesobject[]required

Existing items closest to the query, best first, at most topK. text is an excerpt focused on the query; section is the heading path inside a file when known.

Show child attributes

objectenum<string>required

Object type identifier

Available options: knowledge_search

Example: knowledge_search

querystringrequired

The query as searched (trimmed)

Example: Refunds are processed within 14 days of the request.

timingsobjectrequired

Where the time went

Show child attributes

Still need help? Ask the team