@aiqa/sdk 3.1.0 → 3.2.0

package/README.md

@@ -363,6 +363,21 @@ a timeout, a rejected payload.
     answer_format: { type: "STRING" }
     /** Optional (default: `false`). Use `true` when the fact was collected before the conversation started. It is stored, not verified. */
     prefilled?: boolean
+    /**
+     * Optional. Use `true` for a value you already know is correct, such as data
+     * from your own records. Unlike `prefilled`, it is about trusting the value, not
+     * when it was collected. It is stored and visible to whoever reviews the call,
+     * never verified, and left out of the verification summary counts.
+     */
+    reference?: boolean
+    /**
+     * Optional. Use "watch" to check the fact over the whole call instead of
+     * at one moment, about every 15 seconds. addFact() then resolves right
+     * away with verification_status: "awaiting_question", and the result
+     * (matched or unmatched) arrives later on FACT_VERIFIED, at the latest
+     * when the call ends.
+     */
+    evaluation?: "watch"
     /**
      * Optional. Your own identifiers for this fact — a form field ID, a
      * section name, anything that lets your UI map the result back to the
@@ -579,6 +594,12 @@ Rules:
 - **Handle a `verification_status` you don't recognize as `processing`.**
 - **A fact sent with `prefilled: true` is never verified**, so it gets no
   `verification_status` and no `FACT_VERIFIED` event.
+- **A fact sent with `reference: true` is never verified either.** Use it for
+  a value you already know is correct, such as the plan name from your own
+  records. It is stored, visible to whoever reviews the call, and left out of
+  the verification summary counts. `addFact()` still resolves, with
+  `is_valid_answer: false` and no `verification_status`, and no `FACT_VERIFIED`
+  event is emitted for it.
 - **`pending_confirmation_*` is never final.** The answer can still change,
   so don't show it as a decision.
 - **A fact can be revised after `addFact()` has resolved.** If you keep its
@@ -829,6 +850,21 @@ type ApplicationFactInput = {
   is_skipped?: boolean;
   /** Optional (default: `false`). Use `true` when the fact was collected before the conversation started. It is stored, not verified. */
   prefilled?: boolean;
+  /**
+   * Optional. Use `true` for a value you already know is correct, such as data
+   * from your own records. Unlike `prefilled`, it is about trusting the value, not
+   * when it was collected. It is stored and visible to whoever reviews the call,
+   * never verified, and left out of the verification summary counts.
+   */
+  reference?: boolean;
+  /**
+   * Optional. Use `"watch"` to check the fact over the whole call instead of
+   * at one moment, about every 15 seconds. `addFact()` then resolves right
+   * away with `verification_status: "awaiting_question"`, and the result
+   * (`matched` or `unmatched`) arrives later on `FACT_VERIFIED`, at the latest
+   * when the call ends.
+   */
+  evaluation?: "watch";
   /**
    * Optional. Your own identifiers for this fact — a form field ID, a section
    * name, anything that lets your UI map the result back to the right place.

package/dist/browser/browser.d.ts

@@ -208,6 +208,21 @@ type ApplicationFactInput = {
     is_skipped?: boolean;
     /** Optional (default: `false`). Use `true` when the fact was collected before the conversation started. It is stored, not verified. */
     prefilled?: boolean;
+    /**
+     * Optional. Use `true` for a value you already know is correct, such as data
+     * from your own records. Unlike `prefilled`, it is about trusting the value, not
+     * when it was collected. It is stored and visible to whoever reviews the call,
+     * never verified, and left out of the verification summary counts.
+     */
+    reference?: boolean;
+    /**
+     * Optional. Use `"watch"` to check the fact over the whole call instead of
+     * at one moment, about every 15 seconds. `addFact()` then resolves right
+     * away with `verification_status: "awaiting_question"`, and the result
+     * (`matched` or `unmatched`) arrives later on `FACT_VERIFIED`, at the latest
+     * when the call ends.
+     */
+    evaluation?: "watch";
     /**
      * Your own identifiers for this fact — a form field ID, a section name,
      * anything that lets your UI map the result back to the right place.
@@ -266,7 +281,7 @@ interface AddFactResult {
     answer_type?: string;
     agent_answer?: string;
     ai_answer?: string;
-    /** `false` for a fact that was never verified, such as a prefilled one. */
+    /** `false` for a fact that was never verified, such as a prefilled or reference one. */
     is_valid_answer: boolean;
     question_asked?: boolean;
     /**

package/dist/browser/browser.js

@@ -3407,7 +3407,7 @@ var compareVersions = (left, right) => {
 // package.json
 var package_default = {
   name: "@aiqa/sdk",
-  version: "3.0.0-develop.2",
+  version: "3.1.0-develop.3",
   main: "dist/node/node.js",
   module: "dist/node/node.js",
   types: "dist/node/node.d.ts",