@voctiv/agent-sdk 0.2.13 → 0.2.14

package/dist/types/nlu.d.ts

@@ -6,26 +6,63 @@
  * `intents_exclude`) are mapped to `entities_policy` / `intents_policy`.
  */
 export interface NluExtractOptions {
-    /** Include only these entity types (e.g. `"date"`, `"phone"`); forwarded as `entities`. */
+    /**
+     * Entity names to search — always forwarded to nlu-engine as a JSON array.
+     * Prefer `['confirmation', 'check']`; comma-separated string is accepted for LE compat.
+     */
     entities?: string | string[] | null;
     /** Legacy compatibility field; mapped to exclude policy on nlu-engine. */
     entities_exclude?: string | string[] | null;
-    /** Include only these intent names; forwarded as `intents`. */
+    /**
+     * Intent names to search — always forwarded to nlu-engine as a JSON array.
+     * Prefer `['balance_check']`; comma-separated string is accepted for LE compat.
+     */
     intents?: string | string[] | null;
     /** Legacy compatibility field; mapped to exclude policy on nlu-engine. */
     intents_exclude?: string | string[] | null;
     /**
      * Additional context for disambiguation.
      *
-     * Objects and arrays are JSON-stringified before sending. Omitted when not set
-     * (logic-executor default).
+     * Objects and arrays are JSON-stringified before sending. When omitted, the runtime
+     * uses dialog `flag` (logic-executor scripts usually pass the same value explicitly).
      */
     context?: string | unknown[] | Record<string, unknown> | null;
+    /**
+     * BCP-47 / LE language for this call only (e.g. `es-ES`).
+     * Default NLU language comes from the LE agent (`_nlu.language`), not `context.lang`.
+     */
+    language?: string;
+    /** Alias for {@link language}. */
+    lang?: string;
     /** Forwarded as `use_neuro_api`; nlu-engine may call remote NLU API when true. */
     use_neuro_api?: boolean;
     /** Forwarded as `use_synonyms`; enables synonym expansion in nlu-engine. */
     use_synonyms?: boolean;
 }
-/** Raw parsed JSON response from nlu-engine `/nlu_engine` endpoint. */
-export type NluInferResult = Record<string, unknown>;
+export interface NluProbabilityValue {
+    value: unknown;
+    probability: number;
+}
+/**
+ * logic-executor `NeuroNluRecognitionResult` method surface returned from
+ * `platform.nlu.extract()` / `extract$()`.
+ */
+export interface NluInferResult {
+    utterance(): string | null;
+    context(): unknown;
+    entity(entityName: string): unknown;
+    intent(intentName: string): unknown;
+    has_entity(entityName: string): boolean;
+    has_intent(intentName: string): boolean;
+    has_entities(): boolean;
+    has_intents(): boolean;
+    entities(): Record<string, unknown>;
+    intents(): Record<string, unknown>;
+    entity_with_probability(entityName: string): NluProbabilityValue | null;
+    intent_with_probability(intentName: string): NluProbabilityValue | null;
+    entities_with_probability(): Record<string, NluProbabilityValue>;
+    intents_with_probability(): Record<string, NluProbabilityValue>;
+    dump(): Record<string, unknown>;
+    dump_json(): string;
+}
 //# sourceMappingURL=nlu.d.ts.map

package/dist/types/nlu.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nlu.d.ts","sourceRoot":"","sources":["../../src/types/nlu.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC,2FAA2F;IAC3F,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC;IACpC,0EAA0E;IAC1E,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC;IAC5C,+DAA+D;IAC/D,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC;IACnC,0EAA0E;IAC1E,eAAe,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC;IAC3C;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC9D,kFAAkF;IAClF,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,4EAA4E;IAC5E,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,uEAAuE;AACvE,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC"}
+{"version":3,"file":"nlu.d.ts","sourceRoot":"","sources":["../../src/types/nlu.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC;IACpC,0EAA0E;IAC1E,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC;IAC5C;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC;IACnC,0EAA0E;IAC1E,eAAe,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC;IAC3C;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC9D;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kCAAkC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kFAAkF;IAClF,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,4EAA4E;IAC5E,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,IAAI,MAAM,GAAG,IAAI,CAAC;IAC3B,OAAO,IAAI,OAAO,CAAC;IACnB,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;IACpC,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;IACpC,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;IACxC,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;IACxC,YAAY,IAAI,OAAO,CAAC;IACxB,WAAW,IAAI,OAAO,CAAC;IACvB,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,uBAAuB,CAAC,UAAU,EAAE,MAAM,GAAG,mBAAmB,GAAG,IAAI,CAAC;IACxE,uBAAuB,CAAC,UAAU,EAAE,MAAM,GAAG,mBAAmB,GAAG,IAAI,CAAC;IACxE,yBAAyB,IAAI,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IACjE,wBAAwB,IAAI,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAChE,IAAI,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,SAAS,IAAI,MAAM,CAAC;CACrB"}

package/dist/types/platform.d.ts

@@ -18,13 +18,13 @@ export interface NluScriptApi {
      * Extract intents and entities from one user utterance.
      *
      * The runtime sends a logic-executor-compatible recognition request to
-     * nlu-engine (`/nlu_engine?agent_id=…`). Context is included only when
-     * `options.context` is set explicitly.
+     * nlu-engine (`/nlu_engine?agent_id=…`). Pass `options.context` explicitly when
+     * needed (same as LE `nlu.extract(..., context=flag)`).
      *
      * @param utterance - User input text to analyze.
      * @param options - Optional NLU filters and flags. `entities`, `intents`,
-     *   `use_neuro_api`, and `use_synonyms` are forwarded by ScriptEngine.
-     * @returns Raw parsed JSON response from nlu-engine (recognition result dump).
+     *   `language` / `lang`, `use_neuro_api`, and `use_synonyms` are forwarded by ScriptEngine.
+     * @returns logic-executor-compatible {@link NluInferResult} (`entity()`, `has_entities()`, …).
      */
     extract(utterance: string, options?: NluExtractOptions): Promise<NluInferResult>;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voctiv/agent-sdk",
-  "version": "0.2.13",
+  "version": "0.2.14",
   "description": "Voctiv TypeScript agent SDK: defineScript and platform types for the voice/dialog scripting runtime.",
   "license": "UNLICENSED",
   "author": "",