featurebase-node 0.14.3 → 0.15.1

package/resources/training-data/qna.mjs

@@ -0,0 +1,173 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { CursorPage } from "../../core/pagination.mjs";
+import { buildHeaders } from "../../internal/headers.mjs";
+import { path } from "../../internal/utils/path.mjs";
+/**
+ * Training data teaches the AI agent about your product beyond your public Help Center: training files (documents, policies, internal notes) and Q&A entries (question variants with the exact answer to give). Use these endpoints to keep that knowledge in sync from your own systems — for example, pushing resolved support conversations, internal runbooks, or SOP documents automatically.
+ */
+export class QnaResource extends APIResource {
+    /**
+     * Creates or updates question variants and an answer. Optional externalId is a
+     * stable, caller-owned key, unique within workspace Q&A. Otherwise a normalized
+     * question addresses an existing entry. POST appends variants (maximum 50) and
+     * replaces supplied content; PATCH replaces the question list. Questions cannot
+     * belong to multiple entries: ambiguous ownership returns 409
+     * question_already_used. New entries return 201; updates and no-ops return 200.
+     * Responses include externalId, revision, and indexStatus. Indexing is attempted
+     * before returning; verify indexStatus rather than assuming HTTP success means
+     * searchable.
+     *
+     * Writes omit semantic checks by default. Optional onMatch runs a bounded check
+     * against the addressed entry and retrieved knowledge: reject refuses overlap;
+     * update explicitly permits answer replacement, including contradictions, but
+     * refuses unclear results; create explicitly overrides the check. Without an
+     * addressed entry, update can merge a matching Q&A, subject to source ownership.
+     * Articles and files are never edited. Check failures return 503 before writing.
+     * This is not a transaction over the knowledge base: other entries can change
+     * concurrently. After a separate oracle call, use PATCH with the checked
+     * expectedRevision; stale writes return 409 revision_conflict.
+     *
+     * @example
+     * ```ts
+     * const qna = await client.trainingData.qna.create({
+     *   answer:
+     *     'You can request a refund within 30 days from **Settings → Billing**.',
+     *   questions: [
+     *     'How do I request a refund?',
+     *     'Can I get my money back?',
+     *   ],
+     * });
+     * ```
+     */
+    create(params, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+        return this._client.post('/v2/training_data/qna', {
+            body,
+            ...options,
+            headers: buildHeaders([
+                {
+                    ...(featurebaseVersion?.toString() != null ?
+                        { 'Featurebase-Version': featurebaseVersion?.toString() }
+                        : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Returns a single Q&A entry by ID.
+     *
+     * @example
+     * ```ts
+     * const qna = await client.trainingData.qna.retrieve(
+     *   '67ec1234abcd5678ef901235',
+     * );
+     * ```
+     */
+    retrieve(id, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get(path `/v2/training_data/qna/${id}`, {
+            ...options,
+            headers: buildHeaders([
+                {
+                    ...(featurebaseVersion?.toString() != null ?
+                        { 'Featurebase-Version': featurebaseVersion?.toString() }
+                        : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Updates title, questions, answer, or source. Questions replaces the whole list;
+     * preserve the union yourself when merging. Supply expectedRevision from GET or
+     * oracle.existing / oracle.target to apply only to the version you reviewed. A
+     * stale revision returns 409 revision_conflict; a question owned by another entry
+     * returns 409 question_already_used. Content changes attempt indexing before
+     * returning; check indexStatus.
+     *
+     * Optional onMatch checks changed questions or answer against the addressed entry
+     * and retrieved candidates. reject refuses overlap; update permits deliberate
+     * replacement but refuses unclear results; create overrides the result. PATCH
+     * never merges entries. Checks are bounded advice and do not lock the rest of the
+     * knowledge base. A missing onMatch applies the requested update without semantic
+     * judging.
+     *
+     * @example
+     * ```ts
+     * const qna = await client.trainingData.qna.update(
+     *   '67ec1234abcd5678ef901235',
+     * );
+     * ```
+     */
+    update(id, params, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+        return this._client.patch(path `/v2/training_data/qna/${id}`, {
+            body,
+            ...options,
+            headers: buildHeaders([
+                {
+                    ...(featurebaseVersion?.toString() != null ?
+                        { 'Featurebase-Version': featurebaseVersion?.toString() }
+                        : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Returns Q&A entries, newest first, with cursor pagination. Filter by
+     * `externalId` or `source`. Entries include their full questions and answer.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const qna of client.trainingData.qna.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+        return this._client.getAPIList('/v2/training_data/qna', (CursorPage), {
+            query,
+            ...options,
+            headers: buildHeaders([
+                {
+                    ...(featurebaseVersion?.toString() != null ?
+                        { 'Featurebase-Version': featurebaseVersion?.toString() }
+                        : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Removes a Q&A entry from the workspace and attempts search-index cleanup. Delete
+     * only entries your pipeline owns; a merged entry may have several contributing
+     * sources.
+     *
+     * @example
+     * ```ts
+     * const qna = await client.trainingData.qna.delete(
+     *   '67ec1234abcd5678ef901235',
+     * );
+     * ```
+     */
+    delete(id, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.delete(path `/v2/training_data/qna/${id}`, {
+            ...options,
+            headers: buildHeaders([
+                {
+                    ...(featurebaseVersion?.toString() != null ?
+                        { 'Featurebase-Version': featurebaseVersion?.toString() }
+                        : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+}
+//# sourceMappingURL=qna.mjs.map

package/resources/training-data/qna.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"qna.mjs","sourceRoot":"","sources":["../../src/resources/training-data/qna.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,UAAU,EAAsC,kCAA8B;AACvF,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,MAAM,CAAC,MAAuB,EAAE,OAAwB;QACtD,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE;YAChD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAU,EACV,SAA+C,EAAE,EACjD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,EAAE,EAAE,EAAE;YACzD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,EAAU,EAAE,MAAuB,EAAE,OAAwB;QAClE,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,yBAAyB,EAAE,EAAE,EAAE;YAC3D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,SAA2C,EAAE,EAC7C,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,uBAAuB,EAAE,CAAA,UAAe,CAAA,EAAE;YACvE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAU,EACV,SAA6C,EAAE,EAC/C,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,yBAAyB,EAAE,EAAE,EAAE;YAC5D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/training-data/training-data.d.mts

@@ -0,0 +1,442 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as FilesAPI from "./files.mjs";
+import { FileCreateParams, FileDeleteParams, FileDeleteResponse, FileListParams, FileRetrieveParams, FileUpdateParams, Files, TrainingFile, TrainingFilesCursorPage } from "./files.mjs";
+import * as QnaAPI from "./qna.mjs";
+import { Qna, QnaCreateParams, QnaDeleteParams, QnaDeleteResponse, QnaListParams, QnaResource, QnaRetrieveParams, QnaUpdateParams, QnasCursorPage } from "./qna.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Training data teaches the AI agent about your product beyond your public Help Center: training files (documents, policies, internal notes) and Q&A entries (question variants with the exact answer to give). Use these endpoints to keep that knowledge in sync from your own systems — for example, pushing resolved support conversations, internal runbooks, or SOP documents automatically.
+ */
+export declare class TrainingData extends APIResource {
+    files: FilesAPI.Files;
+    qna: QnaAPI.QnaResource;
+    /**
+     * Checks a proposed Q&A without writing. Optional externalId or an existing
+     * normalized question addresses a target. Changed content is compared with that
+     * entry even if retrieval or excludeIds misses it. The judge continues past
+     * agreement to detect later contradictions; uncertainty takes precedence over
+     * agreement. Another agreeing Q&A remains visible for duplicate review.
+     *
+     * Actions: create means no overlap found in checked candidates; update_target
+     * refers to existing; update_qna refers to target; review_qna / review_article /
+     * review_file require review of the source; skip means an identical payload or
+     * already-covered answer. existing and Q&A candidates include revisions: use PATCH
+     * expectedRevision for a subsequent reviewed update.
+     *
+     * The evidence is bounded: retrieval can miss knowledge, document excerpts omit
+     * context, and checks observe changing data. checkTruncated reports verification
+     * shortlist or text limits and yields unclear unless a contradiction was found.
+     * False does not imply exhaustive coverage or factual correctness. Inspect full
+     * sources before promotion. Dependencies failing returns 503; this endpoint never
+     * writes.
+     *
+     * @example
+     * ```ts
+     * const oracle = await client.trainingData.oracle({
+     *   answer:
+     *     'You can request a refund within 30 days from **Settings → Billing**.',
+     *   questions: [
+     *     'How do I request a refund?',
+     *     'Can I get my money back?',
+     *   ],
+     * });
+     * ```
+     */
+    oracle(params: TrainingDataOracleParams, options?: RequestOptions): APIPromise<Oracle>;
+    /**
+     * 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.
+     *
+     * @example
+     * ```ts
+     * const knowledgeSearch = await client.trainingData.search({
+     *   query:
+     *     'Refunds are processed within 14 days of the request.',
+     * });
+     * ```
+     */
+    search(params: TrainingDataSearchParams, options?: RequestOptions): APIPromise<KnowledgeSearch>;
+}
+export interface KnowledgeSearch {
+    /**
+     * 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.
+     */
+    candidates: Array<KnowledgeSearch.Candidate>;
+    /**
+     * Object type identifier
+     */
+    object: 'knowledge_search';
+    /**
+     * The query as searched (trimmed)
+     */
+    query: string;
+    /**
+     * Where the time went
+     */
+    timings: KnowledgeSearch.Timings;
+}
+export declare namespace KnowledgeSearch {
+    interface Candidate {
+        /**
+         * ID of the existing item
+         */
+        id: string;
+        /**
+         * The item's source identity, for training files and Q&A
+         */
+        externalId: string | null;
+        /**
+         * What kind of knowledge item matched: a Q&A entry, a training file / crawled
+         * page, or a live help-center article.
+         */
+        kind: 'qna' | 'training_file' | 'help_center_article';
+        /**
+         * Question variants, for Q&A entries
+         */
+        questions: Array<string> | null;
+        /**
+         * Q&A revision compared by the judge; null for other kinds. Use with PATCH
+         * expectedRevision.
+         */
+        revision: number | null;
+        /**
+         * Heading breadcrumb of the matching section, for training files
+         */
+        section: string | null;
+        /**
+         * Cosine similarity between the query and item. Calibrate any threshold using
+         * representative examples; it is not a correctness or contradiction score. `null`
+         * when the item was found by keywords only. Arrays are already ordered closest
+         * first.
+         */
+        similarity: number | null;
+        /**
+         * The item's `source` label, for Q&A entries and training files
+         */
+        source: string | null;
+        /**
+         * Excerpt of the existing content the judge compared against (Q&A answer, matching
+         * document section, or article body), up to 1200 characters plus an ellipsis when
+         * cut.
+         */
+        text: string;
+        /**
+         * Title of the existing item
+         */
+        title: string;
+        /**
+         * Public URL of the item when it has one
+         */
+        url: string | null;
+    }
+    /**
+     * Where the time went
+     */
+    interface Timings {
+        /**
+         * Time spent searching and loading the items
+         */
+        retrievalMs: number;
+    }
+}
+export interface Oracle {
+    /**
+     * Suggested next step. `create`: no overlap found in the checked candidates;
+     * verify the source before writing. `update_target`: an entry already carries one
+     * of these questions (`existing`) and should be updated with this content — use
+     * PATCH with expectedRevision from existing to bind the write to this check.
+     * `update_qna`: an existing Q&A entry already answers this with the same facts —
+     * merge into it (`target`) instead of adding a second one. `review_qna` /
+     * `review_article` / `review_file`: an existing item (`target`) contradicts this
+     * answer or the judge could not decide — a human should pick the right fact and
+     * fix the source. `skip`: the knowledge already exists (an article or file answers
+     * it, or the payload is identical to the entry that already carries the question);
+     * nothing to write.
+     */
+    action: 'create' | 'update_target' | 'update_qna' | 'review_qna' | 'review_article' | 'review_file' | 'skip';
+    /**
+     * Retrieved items and the addressed entry (first when present), at most 10.
+     * Excerpts are partial evidence.
+     */
+    candidates: Array<Oracle.Candidate>;
+    /**
+     * A candidate or text budget limited verification (including clipped proposed
+     * answers or Q&A answers). This yields unclear unless a contradiction was already
+     * found. False does not mean the entire workspace was exhaustively checked.
+     */
+    checkTruncated: boolean;
+    /**
+     * The Q&A entry addressed by externalId or a normalized question, including its
+     * checked revision, or null
+     */
+    existing: Oracle.Existing | null;
+    /**
+     * Per-candidate judge verdicts, in the order they were judged. Judging continues
+     * after agreement or uncertainty and stops on a contradiction. The addressed entry
+     * is always compared when its content changes. Only shortlisted candidates are
+     * judged, so this is usually shorter than `candidates`.
+     */
+    judged: Array<Oracle.Judged>;
+    /**
+     * Object type identifier
+     */
+    object: 'oracle';
+    /**
+     * One or two sentences explaining the action, from the judge when it ran
+     */
+    reason: string;
+    target: Oracle.Target;
+    /**
+     * Where the time went
+     */
+    timings: Oracle.Timings;
+    /**
+     * How the closest existing item relates to the entry. `same_topic`: it answers the
+     * same customer question (the entry would be a duplicate, rewording, or updated
+     * version). `contradicts`: same question, incompatible facts. `different`: a
+     * different question, even if the wording overlaps. `unclear`: the judge could not
+     * decide. `no_match`: nothing similar was found.
+     */
+    verdict: 'same_topic' | 'contradicts' | 'different' | 'unclear' | 'no_match';
+}
+export declare namespace Oracle {
+    interface Candidate {
+        /**
+         * ID of the existing item
+         */
+        id: string;
+        /**
+         * The item's source identity, for training files and Q&A
+         */
+        externalId: string | null;
+        /**
+         * What kind of knowledge item matched: a Q&A entry, a training file / crawled
+         * page, or a live help-center article.
+         */
+        kind: 'qna' | 'training_file' | 'help_center_article';
+        /**
+         * Question variants, for Q&A entries
+         */
+        questions: Array<string> | null;
+        /**
+         * Q&A revision compared by the judge; null for other kinds. Use with PATCH
+         * expectedRevision.
+         */
+        revision: number | null;
+        /**
+         * Heading breadcrumb of the matching section, for training files
+         */
+        section: string | null;
+        /**
+         * Cosine similarity between the query and item. Calibrate any threshold using
+         * representative examples; it is not a correctness or contradiction score. `null`
+         * when the item was found by keywords only. Arrays are already ordered closest
+         * first.
+         */
+        similarity: number | null;
+        /**
+         * The item's `source` label, for Q&A entries and training files
+         */
+        source: string | null;
+        /**
+         * Excerpt of the existing content the judge compared against (Q&A answer, matching
+         * document section, or article body), up to 1200 characters plus an ellipsis when
+         * cut.
+         */
+        text: string;
+        /**
+         * Title of the existing item
+         */
+        title: string;
+        /**
+         * Public URL of the item when it has one
+         */
+        url: string | null;
+    }
+    /**
+     * The Q&A entry addressed by externalId or a normalized question, including its
+     * checked revision, or null
+     */
+    interface Existing {
+        /**
+         * Q&A entry ID
+         */
+        id: string;
+        /**
+         * Matching question from your request, or its first question when addressed by
+         * externalId
+         */
+        question: string;
+        /**
+         * Revision of the addressed entry at check time. Use with PATCH expectedRevision.
+         */
+        revision: number;
+    }
+    interface Judged {
+        /**
+         * ID of the judged candidate
+         */
+        candidateId: string;
+        /**
+         * What kind of knowledge item matched: a Q&A entry, a training file / crawled
+         * page, or a live help-center article.
+         */
+        kind: 'qna' | 'training_file' | 'help_center_article';
+        /**
+         * The judge's one-line explanation
+         */
+        reason: string;
+        /**
+         * The judge's verdict for this candidate
+         */
+        verdict: 'same_topic' | 'contradicts' | 'different' | 'unclear';
+    }
+    interface Target {
+        /**
+         * ID of the existing item
+         */
+        id: string;
+        /**
+         * The item's source identity, for training files and Q&A
+         */
+        externalId: string | null;
+        /**
+         * What kind of knowledge item matched: a Q&A entry, a training file / crawled
+         * page, or a live help-center article.
+         */
+        kind: 'qna' | 'training_file' | 'help_center_article';
+        /**
+         * Question variants, for Q&A entries
+         */
+        questions: Array<string> | null;
+        /**
+         * Q&A revision compared by the judge; null for other kinds. Use with PATCH
+         * expectedRevision.
+         */
+        revision: number | null;
+        /**
+         * Heading breadcrumb of the matching section, for training files
+         */
+        section: string | null;
+        /**
+         * Cosine similarity between the query and item. Calibrate any threshold using
+         * representative examples; it is not a correctness or contradiction score. `null`
+         * when the item was found by keywords only. Arrays are already ordered closest
+         * first.
+         */
+        similarity: number | null;
+        /**
+         * The item's `source` label, for Q&A entries and training files
+         */
+        source: string | null;
+        /**
+         * Excerpt of the existing content the judge compared against (Q&A answer, matching
+         * document section, or article body), up to 1200 characters plus an ellipsis when
+         * cut.
+         */
+        text: string;
+        /**
+         * Title of the existing item
+         */
+        title: string;
+        /**
+         * Public URL of the item when it has one
+         */
+        url: string | null;
+    }
+    /**
+     * Where the time went
+     */
+    interface Timings {
+        /**
+         * Number of judge calls made
+         */
+        judgeCalls: number;
+        /**
+         * Time spent in the judge
+         */
+        judgeMs: number;
+        /**
+         * Time spent searching
+         */
+        retrievalMs: number;
+    }
+}
+export interface TrainingDataOracleParams {
+    /**
+     * Body param: The answer the entry would give. Compared by the judge, never used
+     * as a search query.
+     */
+    answer: string;
+    /**
+     * Body param: Question variants this answer applies to (1–50). Phrase them the way
+     * customers ask.
+     */
+    questions: Array<string>;
+    /**
+     * Body param: Format of `answer`. `markdown` (default) is stored as-is; `html` is
+     * converted to markdown.
+     */
+    answerFormat?: 'markdown' | 'html';
+    /**
+     * Body param: Q&A entry / training file IDs to omit from retrieval. The addressed
+     * Q&A entry is still compared when its content changes.
+     */
+    excludeIds?: Array<string>;
+    /**
+     * Body param: Stable identity of the would-be Q&A entry. The oracle only reads; it
+     * never creates or updates it.
+     */
+    externalId?: string;
+    /**
+     * Body param: Short label for the would-be entry (also used as a search query)
+     */
+    title?: string;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
+}
+export interface TrainingDataSearchParams {
+    /**
+     * Body param: 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.
+     */
+    query: string;
+    /**
+     * Body param: Q&A entry / training file IDs to leave out — typically the item you
+     * are about to update.
+     */
+    excludeIds?: Array<string>;
+    /**
+     * Body param: Restrict to some kinds of knowledge. Default: all three (Q&A
+     * entries, training files, live help-center articles).
+     */
+    kinds?: Array<'qna' | 'training_file' | 'help_center_article'>;
+    /**
+     * Body param: How many items to return (1–20).
+     */
+    topK?: number;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
+}
+export declare namespace TrainingData {
+    export { type KnowledgeSearch as KnowledgeSearch, type Oracle as Oracle, type TrainingDataOracleParams as TrainingDataOracleParams, type TrainingDataSearchParams as TrainingDataSearchParams, };
+    export { Files as Files, type TrainingFile as TrainingFile, type FileDeleteResponse as FileDeleteResponse, type TrainingFilesCursorPage as TrainingFilesCursorPage, type FileCreateParams as FileCreateParams, type FileRetrieveParams as FileRetrieveParams, type FileUpdateParams as FileUpdateParams, type FileListParams as FileListParams, type FileDeleteParams as FileDeleteParams, };
+    export { QnaResource as QnaResource, type Qna as Qna, type QnaDeleteResponse as QnaDeleteResponse, type QnasCursorPage as QnasCursorPage, type QnaCreateParams as QnaCreateParams, type QnaRetrieveParams as QnaRetrieveParams, type QnaUpdateParams as QnaUpdateParams, type QnaListParams as QnaListParams, type QnaDeleteParams as QnaDeleteParams, };
+}
+//# sourceMappingURL=training-data.d.mts.map

package/resources/training-data/training-data.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"training-data.d.mts","sourceRoot":"","sources":["../../src/resources/training-data/training-data.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,gBAAgB,EAChB,KAAK,EACL,YAAY,EACZ,uBAAuB,EACxB,oBAAgB;AACjB,OAAO,KAAK,MAAM,kBAAc;AAChC,OAAO,EACL,GAAG,EACH,eAAe,EACf,eAAe,EACf,iBAAiB,EACjB,aAAa,EACb,WAAW,EACX,iBAAiB,EACjB,eAAe,EACf,cAAc,EACf,kBAAc;AACf,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAEhE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,GAAG,EAAE,MAAM,CAAC,WAAW,CAAwC;IAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,MAAM,CAAC,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAgBtF;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;CAehG;AAED,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,UAAU,EAAE,KAAK,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IAE7C;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC,OAAO,CAAC;CAClC;AAED,yBAAiB,eAAe,CAAC;IAC/B,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,IAAI,EAAE,KAAK,GAAG,eAAe,GAAG,qBAAqB,CAAC;QAEtD;;WAEG;QACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEhC;;;WAGG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;;;;WAKG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;;WAIG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,MAAM;IACrB;;;;;;;;;;;;OAYG;IACH,MAAM,EACF,QAAQ,GACR,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,gBAAgB,GAChB,aAAa,GACb,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC;;;;OAIG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEjC;;;;;OAKG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;IAExB;;;;;;OAMG;IACH,OAAO,EAAE,YAAY,GAAG,aAAa,GAAG,WAAW,GAAG,SAAS,GAAG,UAAU,CAAC;CAC9E;AAED,yBAAiB,MAAM,CAAC;IACtB,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,IAAI,EAAE,KAAK,GAAG,eAAe,GAAG,qBAAqB,CAAC;QAEtD;;WAEG;QACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEhC;;;WAGG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;;;;WAKG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;;WAIG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;IAED;;;OAGG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED,UAAiB,MAAM;QACrB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,IAAI,EAAE,KAAK,GAAG,eAAe,GAAG,qBAAqB,CAAC;QAEtD;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,OAAO,EAAE,YAAY,GAAG,aAAa,GAAG,WAAW,GAAG,SAAS,CAAC;KACjE;IAED,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,IAAI,EAAE,KAAK,GAAG,eAAe,GAAG,qBAAqB,CAAC;QAEtD;;WAEG;QACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEhC;;;WAGG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;;;;WAKG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;;WAIG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;;OAGG;IACH,YAAY,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC;IAEnC;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,KAAK,GAAG,eAAe,GAAG,qBAAqB,CAAC,CAAC;IAE/D;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAKD,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,GAAG,IAAI,GAAG,EACf,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}