@wix/auto_sdk_ai-site-chat_assistant-training 1.0.0 → 1.0.2

package/build/cjs/src/innovation-playground-v2-message-assistant-training.types.d.ts

@@ -1,7 +1,13 @@
 export interface Message {
-    /** Message ID. */
+    /**
+     * Message ID.
+     * @format GUID
+     */
     id?: string;
-    /** Conversation ID. */
+    /**
+     * Conversation ID.
+     * @format GUID
+     */
     conversationId?: string;
     /** Message sender type. */
     sender?: Sender;
@@ -26,7 +32,10 @@ export interface Message {
     revision?: string | null;
     /** Message body. */
     body?: Body;
-    /** ID of the message that this message is answering. */
+    /**
+     * ID of the message that this message is answering.
+     * @format GUID
+     */
     answerTo?: string | null;
     /** Extended fields. */
     extendedFields?: ExtendedFields;
@@ -42,7 +51,10 @@ export declare enum Sender {
     ASSISTANT = "ASSISTANT"
 }
 export interface Feedback {
-    /** Feedback text. */
+    /**
+     * Feedback text.
+     * @maxLength 4096
+     */
     text?: string | null;
     /**
      * Document attached to the feedback.
@@ -51,6 +63,7 @@ export interface Feedback {
     document?: Document;
     /**
      * Defined if there's an error attaching the document.
+     * @maxLength 4096
      * @readonly
      */
     error?: string | null;
@@ -58,15 +71,31 @@ export interface Feedback {
     type?: FeedbackType;
 }
 export interface Document {
-    /** ID of the external document. */
+    /**
+     * ID of the external document.
+     * @maxLength 36
+     */
     id?: string;
-    /** Title of the external document. */
+    /**
+     * Title of the external document.
+     * @maxLength 1000
+     */
     title?: string;
-    /** Description of the external document. */
+    /**
+     * Description of the external document.
+     * @maxLength 100000
+     */
     description?: string;
-    /** Tags of the external document. */
+    /**
+     * Tags of the external document.
+     * @maxLength 1000
+     * @maxSize 10
+     */
     tags?: string[];
-    /** URL of the external document. */
+    /**
+     * URL of the external document.
+     * @maxLength 1000
+     */
     url?: string;
     /** Category of the external document. */
     category?: Category;
@@ -113,11 +142,20 @@ export declare enum FeedbackType {
     OTHER = "OTHER"
 }
 export interface Body {
-    /** Main text of the message. */
+    /**
+     * Main text of the message.
+     * @maxLength 4096
+     */
     mainText?: string | null;
-    /** Footer text of the message. */
+    /**
+     * Footer text of the message.
+     * @maxLength 4096
+     */
     footerText?: string | null;
-    /** Additional data. */
+    /**
+     * Additional data.
+     * @maxSize 30
+     */
     additionalData?: Record<string, any>[] | null;
 }
 export interface ExtendedFields {
@@ -160,7 +198,11 @@ export interface Tags {
     tags?: TagList;
 }
 export interface TagList {
-    /** List of tag IDs */
+    /**
+     * List of tag IDs
+     * @maxSize 100
+     * @maxLength 5
+     */
     tagIds?: string[];
 }
 export interface QueryMessagesRequest {
@@ -184,6 +226,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
      * Sort object.
      *
      * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * @maxSize 5
      */
     sort?: Sorting[];
 }
@@ -197,7 +240,10 @@ export interface CursorQueryPagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -207,18 +253,25 @@ export declare enum SortOrder {
     DESC = "DESC"
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
      *
      * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
      * Not relevant for the first request.
+     * @maxLength 16000
      */
     cursor?: string | null;
 }
 export interface QueryMessagesResponse {
-    /** List of messages. */
+    /**
+     * List of messages.
+     * @maxSize 1000
+     */
     messages?: Message[];
     /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
@@ -237,9 +290,15 @@ export interface CursorPagingMetadata {
     hasNext?: boolean | null;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
     next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
 export interface AskQuestionRequest {
@@ -251,7 +310,10 @@ export interface AskQuestionResponse {
     answer?: Message;
 }
 export interface AddFeedbackRequest {
-    /** ID of the message to add feedback to. */
+    /**
+     * ID of the message to add feedback to.
+     * @format GUID
+     */
     messageId: string;
     /** Feedback to add to the message. */
     feedback: Feedback;
@@ -263,7 +325,12 @@ export interface AddFeedbackResponse {
     message?: Message;
 }
 export interface BulkUpdateMessageTagsRequest {
-    /** Message IDs. Tags are updated for messages included in this list. */
+    /**
+     * Message IDs. Tags are updated for messages included in this list.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
     ids: string[] | null;
     /** Tags to assign. */
     assignTags: Tags;
@@ -271,13 +338,20 @@ export interface BulkUpdateMessageTagsRequest {
     unassignTags?: Tags;
 }
 export interface BulkUpdateMessageTagsResponse {
-    /** List of metadata for each message updated. */
+    /**
+     * List of metadata for each message updated.
+     * @minSize 1
+     * @maxSize 100
+     */
     results?: BulkUpdateMessageTagsResult[];
     /** Metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 export interface ItemMetadata {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @format GUID
+     */
     id?: string | null;
     /** Index of the item within the request array. Allows for correlation between request and response items. */
     originalIndex?: number;
@@ -315,7 +389,10 @@ export interface BulkUpdateMessageTagsByFilterRequest {
     unassignTags?: Tags;
 }
 export interface BulkUpdateMessageTagsByFilterResponse {
-    /** Job ID. */
+    /**
+     * Job ID.
+     * @format GUID
+     */
     jobId?: string;
 }
 export interface UpdateExtendedFieldsRequest {
@@ -405,9 +482,15 @@ export interface ActionEvent {
     bodyAsJson?: string;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -415,26 +498,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {

package/build/cjs/src/innovation-playground-v2-message-assistant-training.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"innovation-playground-v2-message-assistant-training.types.js","sourceRoot":"","sources":["../../../src/innovation-playground-v2-message-assistant-training.types.ts"],"names":[],"mappings":";;;AAoCA,IAAY,MAOX;AAPD,WAAY,MAAM;IAChB,2BAA2B;IAC3B,2CAAiC,CAAA;IACjC,2CAA2C;IAC3C,uBAAa,CAAA;IACb,oBAAoB;IACpB,iCAAuB,CAAA;AACzB,CAAC,EAPW,MAAM,sBAAN,MAAM,QAOjB;AA8CD,yCAAyC;AACzC,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,uCAA2B,CAAA;IAC3B,qCAAyB,CAAA;IACzB,oBAAoB;IACpB,uCAA2B,CAAA;AAC7B,CAAC,EALW,QAAQ,wBAAR,QAAQ,QAKnB;AAED,8EAA8E;AAC9E,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,iCAAuB,CAAA;IACvB,iCAAuB,CAAA;IACvB,6BAAmB,CAAA;AACrB,CAAC,EAJW,MAAM,sBAAN,MAAM,QAIjB;AAED,IAAY,YAeX;AAfD,WAAY,YAAY;IACtB,6BAA6B;IAC7B,mCAAmB,CAAA;IACnB,8DAA8D;IAC9D,uCAAuB,CAAA;IACvB,+CAA+C;IAC/C,yCAAyB,CAAA;IACzB,mDAAmD;IACnD,uCAAuB,CAAA;IACvB,yDAAyD;IACzD,uDAAuC,CAAA;IACvC,iEAAiE;IACjE,iCAAiB,CAAA;IACjB,aAAa;IACb,+BAAe,CAAA;AACjB,CAAC,EAfW,YAAY,4BAAZ,YAAY,QAevB;AAoGD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAqQD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
+{"version":3,"file":"innovation-playground-v2-message-assistant-training.types.js","sourceRoot":"","sources":["../../../src/innovation-playground-v2-message-assistant-training.types.ts"],"names":[],"mappings":";;;AA6CA,IAAY,MAOX;AAPD,WAAY,MAAM;IAChB,2BAA2B;IAC3B,2CAAiC,CAAA;IACjC,2CAA2C;IAC3C,uBAAa,CAAA;IACb,oBAAoB;IACpB,iCAAuB,CAAA;AACzB,CAAC,EAPW,MAAM,sBAAN,MAAM,QAOjB;AAkED,yCAAyC;AACzC,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,uCAA2B,CAAA;IAC3B,qCAAyB,CAAA;IACzB,oBAAoB;IACpB,uCAA2B,CAAA;AAC7B,CAAC,EALW,QAAQ,wBAAR,QAAQ,QAKnB;AAED,8EAA8E;AAC9E,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,iCAAuB,CAAA;IACvB,iCAAuB,CAAA;IACvB,6BAAmB,CAAA;AACrB,CAAC,EAJW,MAAM,sBAAN,MAAM,QAIjB;AAED,IAAY,YAeX;AAfD,WAAY,YAAY;IACtB,6BAA6B;IAC7B,mCAAmB,CAAA;IACnB,8DAA8D;IAC9D,uCAAuB,CAAA;IACvB,+CAA+C;IAC/C,yCAAyB,CAAA;IACzB,mDAAmD;IACnD,uCAAuB,CAAA;IACvB,yDAAyD;IACzD,uDAAuC,CAAA;IACvC,iEAAiE;IACjE,iCAAiB,CAAA;IACjB,aAAa;IACb,+BAAe,CAAA;AACjB,CAAC,EAfW,YAAY,4BAAZ,YAAY,QAevB;AAqHD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAkUD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}