stentor-models 1.56.76 → 1.56.80

package/lib/Request/InputUnknownRequest.d.ts

@@ -1,11 +1,11 @@
 /*! Copyright (c) 2019, XAPPmedia */
 import { KnowledgeBaseResult } from "./KnowledgeBase";
-import { BaseRequest } from "./Request";
+import { BaseRequest, SentimentedRequest } from "./Request";
 import { InputUnknownID, InputUnknownRequestType } from "./Types";
 /**
  * Request when a user requests something not in the interaction model.
  */
-export interface InputUnknownRequest extends BaseRequest {
+export interface InputUnknownRequest extends BaseRequest, SentimentedRequest {
     type: InputUnknownRequestType;
     /**
      * Input Unknowns have a constant intentId.

package/lib/Request/IntentRequest.d.ts

@@ -1,7 +1,7 @@
 /*! Copyright (c) 2019, XAPPmedia */
 import { DateTime, DateTimeRange, Duration } from "../DateTime";
 import { Data } from "../Handler";
-import { BaseRequest } from "./Request";
+import { BaseRequest, SentimentedRequest } from "./Request";
 import { IntentRequestType } from "./Types";
 import { KnowledgeAnswer, KnowledgeBaseResult } from "./KnowledgeBase";
 export declare type RequestSlotValues = string | number | object | DateTimeRange | DateTime | Duration | (string)[];
@@ -75,7 +75,7 @@ export interface RequestSlotMap {
  *
  * For Alexa see {@link https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/handling-requests-sent-by-alexa#intentrequest}
  */
-export interface IntentRequest extends BaseRequest {
+export interface IntentRequest extends BaseRequest, SentimentedRequest {
     /**
      * The type of an intent request is always "INTENT_REQUEST"
      */

package/lib/Request/Request.d.ts

@@ -114,6 +114,31 @@ export interface BaseRequest {
      */
     attributes?: Record<string, unknown>;
 }
+/**
+ * A request with sentiment analysis information
+ */
+export interface SentimentedRequest {
+    /**
+     * An analysis on the user's query text sentiment
+     */
+    sentimentAnalysis?: {
+        /**
+         * An abstracted measure of the sentiment.
+         *
+         * * POSITIVE - Query has positive sentiment
+         * * NEUTRAL - Query has either positive or negative sentiment
+         * * NEGATIVE - Query has negative sentiment
+         * * MIXED - Query has both positive and negative sentiment
+         */
+        sentiment: "POSITIVE" | "NEUTRAL" | "NEGATIVE" | "MIXED";
+        /**
+         * The original payload from the sentiment analysis engine stringified
+         *
+         * You can use `JSON.parse` on this data to extract more information.
+         */
+        original?: string;
+    };
+}
 export interface ApiAccessData {
     apiBaseUrl: string;
     apiAuthToken: string;

package/lib/Response/Response.d.ts

@@ -46,7 +46,7 @@ export interface ResponseData {
     /**
      * Provides context to the user for select system responses.
      *
-     * Used for SURFACE_CHANGE, ACCOUNT_LINK,
+     * Used for SURFACE_CHANGE, ACCOUNT_LINK, or generically to pass information to the client surface.
      */
     content?: string;
     /**
@@ -56,7 +56,7 @@ export interface ResponseData {
      */
     title?: string;
     /**
-     * If a request ({@link see IntentRequest.canFulfill}) has canFufill as true,
+     * If a request ({@link see IntentRequest.canFulfill}) has canFulfill as true,
      * this provides information about it's ability to fulfill the request.
      *
      */
@@ -112,7 +112,7 @@ export interface SimpleResponse<T = string | ResponseOutput> extends Partial<Act
     /**
      * System responses to perform account links, control media, surface changes, and permission requests.
      */
-    system?: "ACCOUNT_LINK" | "MEDIA_ENQUEUE" | "MEDIA_STOP" | "SURFACE_CHANGE" | "PERMISSION_LIST" | "PERMISSION_EMAIL" | "PERMISSION_PHONE_NUMBER" | "PERMISSION_LOCATION_PRECISE" | "PERMISSION_LOCATION_COARSE" | "PERMISSION_NOTIFICATION" | "TRANSFER_CALL" | "HANDOFF" | "TRANSACTION_REQUIREMENTS_CHECK" | "TRANSACTION_DELIVERY_ADDRESS" | "TRANSACTION_DECISION" | "TRANSACTION_STATUS";
+    system?: "ACCOUNT_LINK" | "HANDOFF" | "MEDIA_ENQUEUE" | "MEDIA_STOP" | "PERMISSION_EMAIL" | "PERMISSION_LIST" | "PERMISSION_LOCATION_COARSE" | "PERMISSION_LOCATION_PRECISE" | "PERMISSION_NOTIFICATION" | "PERMISSION_PHONE_NUMBER" | "SURFACE_CHANGE" | "SURFACE_CLOSE" | "SURFACE_MINIMIZE" | "SURFACE_RESET" | "TRANSACTION_DECISION" | "TRANSACTION_DELIVERY_ADDRESS" | "TRANSACTION_REQUIREMENTS_CHECK" | "TRANSACTION_STATUS" | "TRANSFER_CALL";
     /**
      * Supplemental data to augment the response.
      */

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.56.76",
+  "version": "1.56.80",
   "description": "Models for 📣 stentor",
   "types": "lib/index",
   "typings": "lib/index",
@@ -33,5 +33,5 @@
   "dependencies": {
     "@xapp/patterns": "1.40.260"
   },
-  "gitHead": "0a1263eac73fa208404e2674ce99d16d11a3f6d6"
+  "gitHead": "9aa313f608b16a86eeb82b5a9fba894ec2c648bb"
 }