@operla-ai/sdk 1.1.8 → 1.2.0

package/dist/generated/types.gen.d.ts

@@ -4564,9 +4564,31 @@ export type SendMessageResponses = {
             reason?: string;
         }>;
         /**
-         * Information the AI needed on this turn and did not have, one short phrase per gap — use it to find what your knowledge base or the user context you send is missing. Empty when nothing was missing. Whether a gap also hands the turn to a human depends on your missing-information setting; the gap is reported either way.
+         * Information the AI needed on this turn and did not have, one entry per gap — use it to find what your knowledge base or the `user` you send is missing. Empty when nothing was missing. Whether a gap also hands the turn to a human depends on your missing-information setting; the gap is reported either way.
          */
-        missingInfo: Array<string>;
+        missingInfo: Array<{
+            /**
+             * The gap in one short phrase.
+             */
+            summary: string;
+            /**
+             * Where the point belongs, derived from `keys` — a shortcut, never a judgement. Resolved only when every cited key agrees; `null` when no key was cited, and when the cited keys span both stores, where naming one would hide the other. `null` says the shortcut does not apply, never that a point has no origin, and it has no bearing on `sources`. Read `keys` for the full picture.
+             */
+            store: 'kb' | 'user';
+            /**
+             * The keys this gap concerns. Empty when no field covers the point — the ordinary case, and `summary` then carries it alone. Never a key you did not declare.
+             */
+            keys: Array<{
+                /**
+                 * `kb`: a field of a knowledge base article's grid. `user`: a field of the `user.data` you send on the request.
+                 */
+                store: 'kb' | 'user';
+                /**
+                 * The key as you declared it, e.g. `warranty.duration` or `identity.phone`.
+                 */
+                key: string;
+            }>;
+        }>;
         /**
          * Sources of yours the user contradicted on this turn — use it to find what your knowledge base holds that is no longer true. The AI keeps answering from its sources; this is a doubt for you to verify, never a verdict. Group your report on `sources[].articleId`: two specialists reading the same article phrase the same doubt independently, so the same fiche can appear on two lines. Empty when nothing was contradicted. Whether a contradiction also hands the turn to a human depends on your stale-information setting; it is reported either way.
          */
@@ -4580,7 +4602,24 @@ export type SendMessageResponses = {
              */
             contradiction: string;
             /**
-             * The articles the specialist read on this turn. More than one when several were injected: the engine cannot tell which carried the claim.
+             * Where the point belongs, derived from `keys` — a shortcut, never a judgement. Resolved only when every cited key agrees; `null` when no key was cited, and when the cited keys span both stores, where naming one would hide the other. `null` says the shortcut does not apply, never that a point has no origin, and it has no bearing on `sources`. Read `keys` for the full picture.
+             */
+            store: 'kb' | 'user';
+            /**
+             * The keys carrying the contradicted fact. Empty when it came from an article's prose or from an action's result — `store` may still name the origin. Never a key you did not declare.
+             */
+            keys: Array<{
+                /**
+                 * `kb`: a field of a knowledge base article's grid. `user`: a field of the `user.data` you send on the request.
+                 */
+                store: 'kb' | 'user';
+                /**
+                 * The key as you declared it, e.g. `warranty.duration` or `identity.phone`.
+                 */
+                key: string;
+            }>;
+            /**
+             * The articles the specialist read on this turn. More than one when several were injected: the engine cannot tell which carried the claim. Empty when every cited key points at the `user` you send — the contradiction did not come from an article, so none is worth checking.
              */
             sources: Array<{
                 /**
@@ -5258,9 +5297,31 @@ export type SimulateResponses = {
             reason?: string;
         }>;
         /**
-         * Information the AI needed on this turn and did not have, one short phrase per gap — use it to find what your knowledge base or the user context you send is missing. Empty when nothing was missing. Whether a gap also hands the turn to a human depends on your missing-information setting; the gap is reported either way.
+         * Information the AI needed on this turn and did not have, one entry per gap — use it to find what your knowledge base or the `user` you send is missing. Empty when nothing was missing. Whether a gap also hands the turn to a human depends on your missing-information setting; the gap is reported either way.
          */
-        missingInfo: Array<string>;
+        missingInfo: Array<{
+            /**
+             * The gap in one short phrase.
+             */
+            summary: string;
+            /**
+             * Where the point belongs, derived from `keys` — a shortcut, never a judgement. Resolved only when every cited key agrees; `null` when no key was cited, and when the cited keys span both stores, where naming one would hide the other. `null` says the shortcut does not apply, never that a point has no origin, and it has no bearing on `sources`. Read `keys` for the full picture.
+             */
+            store: 'kb' | 'user';
+            /**
+             * The keys this gap concerns. Empty when no field covers the point — the ordinary case, and `summary` then carries it alone. Never a key you did not declare.
+             */
+            keys: Array<{
+                /**
+                 * `kb`: a field of a knowledge base article's grid. `user`: a field of the `user.data` you send on the request.
+                 */
+                store: 'kb' | 'user';
+                /**
+                 * The key as you declared it, e.g. `warranty.duration` or `identity.phone`.
+                 */
+                key: string;
+            }>;
+        }>;
         /**
          * Sources of yours the user contradicted on this turn — use it to find what your knowledge base holds that is no longer true. The AI keeps answering from its sources; this is a doubt for you to verify, never a verdict. Group your report on `sources[].articleId`: two specialists reading the same article phrase the same doubt independently, so the same fiche can appear on two lines. Empty when nothing was contradicted. Whether a contradiction also hands the turn to a human depends on your stale-information setting; it is reported either way.
          */
@@ -5274,7 +5335,24 @@ export type SimulateResponses = {
              */
             contradiction: string;
             /**
-             * The articles the specialist read on this turn. More than one when several were injected: the engine cannot tell which carried the claim.
+             * Where the point belongs, derived from `keys` — a shortcut, never a judgement. Resolved only when every cited key agrees; `null` when no key was cited, and when the cited keys span both stores, where naming one would hide the other. `null` says the shortcut does not apply, never that a point has no origin, and it has no bearing on `sources`. Read `keys` for the full picture.
+             */
+            store: 'kb' | 'user';
+            /**
+             * The keys carrying the contradicted fact. Empty when it came from an article's prose or from an action's result — `store` may still name the origin. Never a key you did not declare.
+             */
+            keys: Array<{
+                /**
+                 * `kb`: a field of a knowledge base article's grid. `user`: a field of the `user.data` you send on the request.
+                 */
+                store: 'kb' | 'user';
+                /**
+                 * The key as you declared it, e.g. `warranty.duration` or `identity.phone`.
+                 */
+                key: string;
+            }>;
+            /**
+             * The articles the specialist read on this turn. More than one when several were injected: the engine cannot tell which carried the claim. Empty when every cited key points at the `user` you send — the contradiction did not come from an article, so none is worth checking.
              */
             sources: Array<{
                 /**
@@ -7552,6 +7630,37 @@ export type List7Responses = {
              * True when an unpublished draft exists on this article.
              */
             hasDraft: boolean;
+            /**
+             * Structured field grid, when the article has one.
+             */
+            fields?: {
+                /**
+                 * Grouped rows of the grid, in display order.
+                 */
+                sections: Array<{
+                    /**
+                     * Section heading, e.g. `Coverage`.
+                     */
+                    label: string;
+                    /**
+                     * Keyed facts under this section.
+                     */
+                    fields: Array<{
+                        /**
+                         * Stable identifier your software routes on. Unique within the article.
+                         */
+                        key: string;
+                        /**
+                         * Human label, in your language.
+                         */
+                        label: string;
+                        /**
+                         * `null` means not filled in — the AI will not guess it.
+                         */
+                        value: string | null;
+                    }>;
+                }>;
+            };
             /**
              * ISO timestamp of the last publication.
              */
@@ -7585,11 +7694,42 @@ export type Create6Data = {
         /**
          * Article body (Markdown).
          */
-        content: string;
+        content?: string;
         /**
          * Intent IDs this article serves — a routing restriction, not a topic label. Empty means no restriction: the article reaches every agent that runs on every conversation in this article's scope (each specialist and the response agent). Non-empty means it reaches them only when one of those intents is detected, and only that intent's destination agent — its specialist when the intent routes to one, otherwise the response agent.
          */
         intents?: Array<string>;
+        /**
+         * Structured field grid. Additive to `content` — never derived from it.
+         */
+        fields?: {
+            /**
+             * Grouped rows of the grid, in display order.
+             */
+            sections: Array<{
+                /**
+                 * Section heading, e.g. `Coverage`.
+                 */
+                label: string;
+                /**
+                 * Keyed facts under this section.
+                 */
+                fields: Array<{
+                    /**
+                     * Stable identifier your software routes on. Unique within the article.
+                     */
+                    key: string;
+                    /**
+                     * Human label, in your language.
+                     */
+                    label: string;
+                    /**
+                     * `null` means not filled in — the AI will not guess it.
+                     */
+                    value: string | null;
+                }>;
+            }>;
+        };
     };
     path?: never;
     query?: {
@@ -7715,6 +7855,37 @@ export type Create6Responses = {
              * Article body (Markdown) at this version.
              */
             content: string;
+            /**
+             * Structured field grid at this version, when the article has one.
+             */
+            fields?: {
+                /**
+                 * Grouped rows of the grid, in display order.
+                 */
+                sections: Array<{
+                    /**
+                     * Section heading, e.g. `Coverage`.
+                     */
+                    label: string;
+                    /**
+                     * Keyed facts under this section.
+                     */
+                    fields: Array<{
+                        /**
+                         * Stable identifier your software routes on. Unique within the article.
+                         */
+                        key: string;
+                        /**
+                         * Human label, in your language.
+                         */
+                        label: string;
+                        /**
+                         * `null` means not filled in — the AI will not guess it.
+                         */
+                        value: string | null;
+                    }>;
+                }>;
+            };
             /**
              * ISO timestamp of the publication that produced this snapshot.
              */
@@ -7740,6 +7911,37 @@ export type Create6Responses = {
              * Article body (Markdown) at this version.
              */
             content: string;
+            /**
+             * Structured field grid at this version, when the article has one.
+             */
+            fields?: {
+                /**
+                 * Grouped rows of the grid, in display order.
+                 */
+                sections: Array<{
+                    /**
+                     * Section heading, e.g. `Coverage`.
+                     */
+                    label: string;
+                    /**
+                     * Keyed facts under this section.
+                     */
+                    fields: Array<{
+                        /**
+                         * Stable identifier your software routes on. Unique within the article.
+                         */
+                        key: string;
+                        /**
+                         * Human label, in your language.
+                         */
+                        label: string;
+                        /**
+                         * `null` means not filled in — the AI will not guess it.
+                         */
+                        value: string | null;
+                    }>;
+                }>;
+            };
             /**
              * ISO timestamp of the publication that produced this snapshot.
              */
@@ -7978,6 +8180,37 @@ export type Get7Responses = {
              * Article body (Markdown) at this version.
              */
             content: string;
+            /**
+             * Structured field grid at this version, when the article has one.
+             */
+            fields?: {
+                /**
+                 * Grouped rows of the grid, in display order.
+                 */
+                sections: Array<{
+                    /**
+                     * Section heading, e.g. `Coverage`.
+                     */
+                    label: string;
+                    /**
+                     * Keyed facts under this section.
+                     */
+                    fields: Array<{
+                        /**
+                         * Stable identifier your software routes on. Unique within the article.
+                         */
+                        key: string;
+                        /**
+                         * Human label, in your language.
+                         */
+                        label: string;
+                        /**
+                         * `null` means not filled in — the AI will not guess it.
+                         */
+                        value: string | null;
+                    }>;
+                }>;
+            };
             /**
              * ISO timestamp of the publication that produced this snapshot.
              */
@@ -8003,6 +8236,37 @@ export type Get7Responses = {
              * Article body (Markdown) at this version.
              */
             content: string;
+            /**
+             * Structured field grid at this version, when the article has one.
+             */
+            fields?: {
+                /**
+                 * Grouped rows of the grid, in display order.
+                 */
+                sections: Array<{
+                    /**
+                     * Section heading, e.g. `Coverage`.
+                     */
+                    label: string;
+                    /**
+                     * Keyed facts under this section.
+                     */
+                    fields: Array<{
+                        /**
+                         * Stable identifier your software routes on. Unique within the article.
+                         */
+                        key: string;
+                        /**
+                         * Human label, in your language.
+                         */
+                        label: string;
+                        /**
+                         * `null` means not filled in — the AI will not guess it.
+                         */
+                        value: string | null;
+                    }>;
+                }>;
+            };
             /**
              * ISO timestamp of the publication that produced this snapshot.
              */
@@ -8033,12 +8297,43 @@ export type Update5Data = {
          * New article body.
          */
         content?: string;
+        /**
+         * Replace the structured field grid. Additive to `content` — never derived from it.
+         */
+        fields?: {
+            /**
+             * Grouped rows of the grid, in display order.
+             */
+            sections: Array<{
+                /**
+                 * Section heading, e.g. `Coverage`.
+                 */
+                label: string;
+                /**
+                 * Keyed facts under this section.
+                 */
+                fields: Array<{
+                    /**
+                     * Stable identifier your software routes on. Unique within the article.
+                     */
+                    key: string;
+                    /**
+                     * Human label, in your language.
+                     */
+                    label: string;
+                    /**
+                     * `null` means not filled in — the AI will not guess it.
+                     */
+                    value: string | null;
+                }>;
+            }>;
+        };
         /**
          * Replace the intents list. Pass `[]` to drop the routing restriction — the article is then loaded into every agent on every conversation in its scope.
          */
         intents?: Array<string>;
         /**
-         * When true and `title`/`content` is provided, the changes are written to draft and immediately promoted to published (a version snapshot is still created so rollback remains possible). When false (default), the content stays in draft. Routing changes (`intents`) bypass this flag.
+         * When true and `title`/`content`/`fields` is provided, the changes are written to draft and immediately promoted to published (a version snapshot is still created so rollback remains possible). When false (default), the content stays in draft. Routing changes (`intents`) bypass this flag.
          */
         publish?: boolean;
     };
@@ -8166,6 +8461,37 @@ export type Update5Responses = {
              * Article body (Markdown) at this version.
              */
             content: string;
+            /**
+             * Structured field grid at this version, when the article has one.
+             */
+            fields?: {
+                /**
+                 * Grouped rows of the grid, in display order.
+                 */
+                sections: Array<{
+                    /**
+                     * Section heading, e.g. `Coverage`.
+                     */
+                    label: string;
+                    /**
+                     * Keyed facts under this section.
+                     */
+                    fields: Array<{
+                        /**
+                         * Stable identifier your software routes on. Unique within the article.
+                         */
+                        key: string;
+                        /**
+                         * Human label, in your language.
+                         */
+                        label: string;
+                        /**
+                         * `null` means not filled in — the AI will not guess it.
+                         */
+                        value: string | null;
+                    }>;
+                }>;
+            };
             /**
              * ISO timestamp of the publication that produced this snapshot.
              */
@@ -8191,6 +8517,37 @@ export type Update5Responses = {
              * Article body (Markdown) at this version.
              */
             content: string;
+            /**
+             * Structured field grid at this version, when the article has one.
+             */
+            fields?: {
+                /**
+                 * Grouped rows of the grid, in display order.
+                 */
+                sections: Array<{
+                    /**
+                     * Section heading, e.g. `Coverage`.
+                     */
+                    label: string;
+                    /**
+                     * Keyed facts under this section.
+                     */
+                    fields: Array<{
+                        /**
+                         * Stable identifier your software routes on. Unique within the article.
+                         */
+                        key: string;
+                        /**
+                         * Human label, in your language.
+                         */
+                        label: string;
+                        /**
+                         * `null` means not filled in — the AI will not guess it.
+                         */
+                        value: string | null;
+                    }>;
+                }>;
+            };
             /**
              * ISO timestamp of the publication that produced this snapshot.
              */
@@ -8366,6 +8723,37 @@ export type CreateManyResponses = {
                      * Article body (Markdown) at this version.
                      */
                     content: string;
+                    /**
+                     * Structured field grid at this version, when the article has one.
+                     */
+                    fields?: {
+                        /**
+                         * Grouped rows of the grid, in display order.
+                         */
+                        sections: Array<{
+                            /**
+                             * Section heading, e.g. `Coverage`.
+                             */
+                            label: string;
+                            /**
+                             * Keyed facts under this section.
+                             */
+                            fields: Array<{
+                                /**
+                                 * Stable identifier your software routes on. Unique within the article.
+                                 */
+                                key: string;
+                                /**
+                                 * Human label, in your language.
+                                 */
+                                label: string;
+                                /**
+                                 * `null` means not filled in — the AI will not guess it.
+                                 */
+                                value: string | null;
+                            }>;
+                        }>;
+                    };
                     /**
                      * ISO timestamp of the publication that produced this snapshot.
                      */
@@ -8391,6 +8779,37 @@ export type CreateManyResponses = {
                      * Article body (Markdown) at this version.
                      */
                     content: string;
+                    /**
+                     * Structured field grid at this version, when the article has one.
+                     */
+                    fields?: {
+                        /**
+                         * Grouped rows of the grid, in display order.
+                         */
+                        sections: Array<{
+                            /**
+                             * Section heading, e.g. `Coverage`.
+                             */
+                            label: string;
+                            /**
+                             * Keyed facts under this section.
+                             */
+                            fields: Array<{
+                                /**
+                                 * Stable identifier your software routes on. Unique within the article.
+                                 */
+                                key: string;
+                                /**
+                                 * Human label, in your language.
+                                 */
+                                label: string;
+                                /**
+                                 * `null` means not filled in — the AI will not guess it.
+                                 */
+                                value: string | null;
+                            }>;
+                        }>;
+                    };
                     /**
                      * ISO timestamp of the publication that produced this snapshot.
                      */
@@ -8485,6 +8904,37 @@ export type CreateManyResponses = {
                      * Article body (Markdown) at this version.
                      */
                     content: string;
+                    /**
+                     * Structured field grid at this version, when the article has one.
+                     */
+                    fields?: {
+                        /**
+                         * Grouped rows of the grid, in display order.
+                         */
+                        sections: Array<{
+                            /**
+                             * Section heading, e.g. `Coverage`.
+                             */
+                            label: string;
+                            /**
+                             * Keyed facts under this section.
+                             */
+                            fields: Array<{
+                                /**
+                                 * Stable identifier your software routes on. Unique within the article.
+                                 */
+                                key: string;
+                                /**
+                                 * Human label, in your language.
+                                 */
+                                label: string;
+                                /**
+                                 * `null` means not filled in — the AI will not guess it.
+                                 */
+                                value: string | null;
+                            }>;
+                        }>;
+                    };
                     /**
                      * ISO timestamp of the publication that produced this snapshot.
                      */
@@ -8510,6 +8960,37 @@ export type CreateManyResponses = {
                      * Article body (Markdown) at this version.
                      */
                     content: string;
+                    /**
+                     * Structured field grid at this version, when the article has one.
+                     */
+                    fields?: {
+                        /**
+                         * Grouped rows of the grid, in display order.
+                         */
+                        sections: Array<{
+                            /**
+                             * Section heading, e.g. `Coverage`.
+                             */
+                            label: string;
+                            /**
+                             * Keyed facts under this section.
+                             */
+                            fields: Array<{
+                                /**
+                                 * Stable identifier your software routes on. Unique within the article.
+                                 */
+                                key: string;
+                                /**
+                                 * Human label, in your language.
+                                 */
+                                label: string;
+                                /**
+                                 * `null` means not filled in — the AI will not guess it.
+                                 */
+                                value: string | null;
+                            }>;
+                        }>;
+                    };
                     /**
                      * ISO timestamp of the publication that produced this snapshot.
                      */
@@ -8692,6 +9173,37 @@ export type Publish2Responses = {
              * Article body (Markdown) at this version.
              */
             content: string;
+            /**
+             * Structured field grid at this version, when the article has one.
+             */
+            fields?: {
+                /**
+                 * Grouped rows of the grid, in display order.
+                 */
+                sections: Array<{
+                    /**
+                     * Section heading, e.g. `Coverage`.
+                     */
+                    label: string;
+                    /**
+                     * Keyed facts under this section.
+                     */
+                    fields: Array<{
+                        /**
+                         * Stable identifier your software routes on. Unique within the article.
+                         */
+                        key: string;
+                        /**
+                         * Human label, in your language.
+                         */
+                        label: string;
+                        /**
+                         * `null` means not filled in — the AI will not guess it.
+                         */
+                        value: string | null;
+                    }>;
+                }>;
+            };
             /**
              * ISO timestamp of the publication that produced this snapshot.
              */
@@ -8717,6 +9229,37 @@ export type Publish2Responses = {
              * Article body (Markdown) at this version.
              */
             content: string;
+            /**
+             * Structured field grid at this version, when the article has one.
+             */
+            fields?: {
+                /**
+                 * Grouped rows of the grid, in display order.
+                 */
+                sections: Array<{
+                    /**
+                     * Section heading, e.g. `Coverage`.
+                     */
+                    label: string;
+                    /**
+                     * Keyed facts under this section.
+                     */
+                    fields: Array<{
+                        /**
+                         * Stable identifier your software routes on. Unique within the article.
+                         */
+                        key: string;
+                        /**
+                         * Human label, in your language.
+                         */
+                        label: string;
+                        /**
+                         * `null` means not filled in — the AI will not guess it.
+                         */
+                        value: string | null;
+                    }>;
+                }>;
+            };
             /**
              * ISO timestamp of the publication that produced this snapshot.
              */
@@ -8868,6 +9411,37 @@ export type Rollback2Responses = {
              * Article body (Markdown) at this version.
              */
             content: string;
+            /**
+             * Structured field grid at this version, when the article has one.
+             */
+            fields?: {
+                /**
+                 * Grouped rows of the grid, in display order.
+                 */
+                sections: Array<{
+                    /**
+                     * Section heading, e.g. `Coverage`.
+                     */
+                    label: string;
+                    /**
+                     * Keyed facts under this section.
+                     */
+                    fields: Array<{
+                        /**
+                         * Stable identifier your software routes on. Unique within the article.
+                         */
+                        key: string;
+                        /**
+                         * Human label, in your language.
+                         */
+                        label: string;
+                        /**
+                         * `null` means not filled in — the AI will not guess it.
+                         */
+                        value: string | null;
+                    }>;
+                }>;
+            };
             /**
              * ISO timestamp of the publication that produced this snapshot.
              */
@@ -8893,6 +9467,37 @@ export type Rollback2Responses = {
              * Article body (Markdown) at this version.
              */
             content: string;
+            /**
+             * Structured field grid at this version, when the article has one.
+             */
+            fields?: {
+                /**
+                 * Grouped rows of the grid, in display order.
+                 */
+                sections: Array<{
+                    /**
+                     * Section heading, e.g. `Coverage`.
+                     */
+                    label: string;
+                    /**
+                     * Keyed facts under this section.
+                     */
+                    fields: Array<{
+                        /**
+                         * Stable identifier your software routes on. Unique within the article.
+                         */
+                        key: string;
+                        /**
+                         * Human label, in your language.
+                         */
+                        label: string;
+                        /**
+                         * `null` means not filled in — the AI will not guess it.
+                         */
+                        value: string | null;
+                    }>;
+                }>;
+            };
             /**
              * ISO timestamp of the publication that produced this snapshot.
              */