@cimulate/copilot-sdk 3.5.0 → 3.7.0

package/dist/types/model/ConversationResetAck.d.ts

@@ -0,0 +1,10 @@
+import { ConversationReset } from './ConversationReset';
+interface ConversationResetAck {
+    name: 'conversation_reset';
+    request: ConversationReset;
+    sessionId: string;
+    id: string;
+    createdAt: string;
+    status: number;
+}
+export { ConversationResetAck };

package/dist/types/model/CopilotApiAck.d.ts

@@ -3,7 +3,9 @@
  For any new event, manually create an entry here.
  */
 import { CancelAck } from "./CancelAck";
+import { ConversationResetAck } from "./ConversationResetAck";
 import { CopilotError } from "./CopilotError";
 import { CopilotSearchAck } from "./CopilotSearchAck";
 import { FacetedNavigationAck } from "./FacetedNavigationAck";
-export type CopilotAPIAck = CancelAck | CopilotSearchAck | FacetedNavigationAck | CopilotError;
+import { ProductViewAck } from "./ProductViewAck";
+export type CopilotAPIAck = CancelAck | CopilotSearchAck | ConversationResetAck | FacetedNavigationAck | ProductViewAck | CopilotError;

package/dist/types/model/FollowUp.d.ts

@@ -1,12 +1,13 @@
 import { CopilotSearchSuggestion } from './CopilotSearchSuggestion';
 import { FacetedNavigationSuggestion } from './FacetedNavigationSuggestion';
+import { ProductViewSuggestion } from './ProductViewSuggestion';
 interface FollowUp {
     sessionId: string;
     id: string;
     createdAt: string;
     eventSourceId: string;
     message: string;
-    suggestions: (CopilotSearchSuggestion | FacetedNavigationSuggestion)[];
+    suggestions: (CopilotSearchSuggestion | FacetedNavigationSuggestion | ProductViewSuggestion)[];
     name: 'follow_up';
 }
 export { FollowUp };

package/dist/types/model/ProductView.d.ts

@@ -0,0 +1,6 @@
+interface ProductView {
+    productId: string;
+    pdpLink?: string;
+    userPrompt?: string;
+}
+export { ProductView };

package/dist/types/model/ProductViewAck.d.ts

@@ -0,0 +1,10 @@
+import { ProductView } from './ProductView';
+interface ProductViewAck {
+    name: 'product_view';
+    request: ProductView;
+    sessionId: string;
+    id: string;
+    createdAt: string;
+    status: number;
+}
+export { ProductViewAck };

package/dist/types/model/ProductViewSuggestion.d.ts

@@ -0,0 +1,7 @@
+import { ProductView } from './ProductView';
+interface ProductViewSuggestion {
+    displayText: string;
+    action: 'product_view';
+    params: ProductView;
+}
+export { ProductViewSuggestion };

package/dist/types/model/SessionData.d.ts

@@ -1,4 +1,6 @@
 interface SessionData {
     eventSourceMap?: Record<string, string[]>;
+    conversationIds?: string[];
+    activeConversationId?: string;
 }
 export { SessionData };

package/dist/types/model/index.d.ts

@@ -6,6 +6,8 @@ export * from './CommonRequiredFields';
 export * from './ConnectAck';
 export * from './ConnectAckMetadata';
 export * from './ConnectError';
+export * from './ConversationReset';
+export * from './ConversationResetAck';
 export * from './CopilotApiAck';
 export * from './CopilotAPIEvent';
 export * from './CopilotError';
@@ -25,6 +27,9 @@ export * from './FollowUp';
 export * from './Inquiry';
 export * from './OperationAck';
 export * from './PartialInquiry';
+export * from './ProductView';
+export * from './ProductViewAck';
+export * from './ProductViewSuggestion';
 export * from './Progress';
 export * from './ProgressToolKwargs';
 export * from './RefinedSearch';

package/examples/conversationReset.ts

@@ -0,0 +1,52 @@
+import { CimulateCopilot } from "@cimulate/copilot-sdk";
+
+
+async function main() {
+    const copilot = new CimulateCopilot({
+        apiKey: "API_KEY",
+        // Alternatively, a JWT token of the form `Bearer {token}` can be used for authentication.
+        // apiToken: "token123",
+        baseUrl: "https://qa.copilot.search.cimulate.ai",
+    });
+
+    // Register handlers.
+    const connectAckHandler = copilot.on("connect_ack", function connectAck(event) {
+        console.log("Connect Ack: ", event);
+    });
+
+    const errorHandler = copilot.on("error", function errorEvent(event) {
+        console.error("Error received: ", event);
+    });
+
+    const connectErrorHandler = copilot.on("connect_error", function errorEvent(error) {
+        console.error("Error message received: ", error.message);
+    });
+
+    console.log("Establish a new connection");
+    copilot.connect();
+    
+    console.log("Reset conversaton with empty payload");
+    const response = await copilot.conversationReset({});
+    console.log("Conversation reset response: ", response);
+
+    console.log("Reset conversaton with empty payload");
+    const responseWithUserReason = await copilot.conversationReset({
+        reason: "Clear the copilot context."
+    });
+    console.log("Conversation reset response: ", responseWithUserReason);
+
+    const sessionData = await copilot.requestSessionInformation();
+    console.log("Conversations related to this session: ", sessionData.data.conversationIds);
+    console.log("Current active conversation in this session: ", sessionData.data.activeConversationId);
+
+    console.log("Disconnect");
+    copilot.disconnect();
+
+    console.log("De-register handler");
+    copilot.off("connect_ack", connectAckHandler);
+    copilot.off("error", errorHandler);
+    copilot.off("connect_error", connectErrorHandler);
+
+}
+
+main();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cimulate/copilot-sdk",
-  "version": "3.5.0",
+  "version": "3.7.0",
   "description": "A lightweight API client SDK for Cimulate Copilot",
   "files": [
     "dist/**",

package/src/copilot.ts

@@ -13,8 +13,12 @@ import type {
   CopilotSearchAck,
   FacetedNavigation,
   FacetedNavigationAck,
+  ProductView,
+  ProductViewAck,
   ReturnedFields,
   SessionInformation,
+  ConversationReset,
+  ConversationResetAck,
 } from "./model";
 import CimulateCopilotException from "./exceptions";
 import { SnakeCaseParser } from "./parser";
@@ -251,6 +255,40 @@ export default class CimulateCopilot<
     );
   }
 
+  async conversationReset(args: ConversationReset): Promise<CopilotResult<T, ConversationResetAck>>;
+  async conversationReset(
+    args: ConversationReset,
+    callback?: (event: ConversationResetAck) => void
+  ): Promise<void>;
+  conversationReset(
+    args: ConversationReset,
+    callback?: (event: ConversationResetAck) => void
+  ): Promise<CopilotResult<T, ConversationResetAck> | void> {
+    return this.asyncResponse<ConversationReset, ConversationResetAck>(
+      "conversation_reset",
+      args,
+      callback
+    );
+  }
+
+  async productView(
+    args: ProductView
+  ): Promise<CopilotResult<T, ProductViewAck>>;
+  async productView(
+    args: ProductView,
+    callback?: (event: ProductViewAck) => void
+  ): Promise<void>;
+  async productView(
+    args: ProductView,
+    callback?: (event: ProductViewAck) => void
+  ): Promise<CopilotResult<T, ProductViewAck> | void> {
+    return this.asyncResponse<ProductView, ProductViewAck>(
+      "product_view",
+      args,
+      callback
+    );
+  }
+
   async requestSessionInformation(): Promise<
     CopilotResult<T, SessionInformation>
   >;

package/src/model/ConversationReset.ts

@@ -0,0 +1,6 @@
+
+interface ConversationReset {
+  conversationId?: string;
+  reason?: string;
+}
+export { ConversationReset };

package/src/model/ConversationResetAck.ts

@@ -0,0 +1,10 @@
+import { ConversationReset } from './ConversationReset';
+interface ConversationResetAck {
+  name: 'conversation_reset';
+  request: ConversationReset;
+  sessionId: string;
+  id: string;
+  createdAt: string;
+  status: number;
+}
+export { ConversationResetAck };

package/src/model/CopilotApiAck.ts

@@ -3,12 +3,16 @@
  For any new event, manually create an entry here.
  */
 import { CancelAck } from "./CancelAck";
+import { ConversationResetAck } from "./ConversationResetAck";
 import { CopilotError } from "./CopilotError";
 import { CopilotSearchAck } from "./CopilotSearchAck";
 import { FacetedNavigationAck } from "./FacetedNavigationAck";
+import { ProductViewAck } from "./ProductViewAck"
 
 export type CopilotAPIAck =
   | CancelAck
   | CopilotSearchAck
+  | ConversationResetAck
   | FacetedNavigationAck
+  | ProductViewAck
   | CopilotError;

package/src/model/FollowUp.ts

@@ -1,12 +1,13 @@
 import { CopilotSearchSuggestion } from './CopilotSearchSuggestion';
 import { FacetedNavigationSuggestion } from './FacetedNavigationSuggestion';
+import { ProductViewSuggestion } from './ProductViewSuggestion';
 interface FollowUp {
   sessionId: string;
   id: string;
   createdAt: string;
   eventSourceId: string;
   message: string;
-  suggestions: (CopilotSearchSuggestion | FacetedNavigationSuggestion)[];
+  suggestions: (CopilotSearchSuggestion | FacetedNavigationSuggestion | ProductViewSuggestion)[];
   name: 'follow_up';
 }
 export { FollowUp };

package/src/model/ProductView.ts

@@ -0,0 +1,7 @@
+
+interface ProductView {
+  productId: string;
+  pdpLink?: string;
+  userPrompt?: string;
+}
+export { ProductView };

package/src/model/ProductViewAck.ts

@@ -0,0 +1,10 @@
+import { ProductView } from './ProductView';
+interface ProductViewAck {
+  name: 'product_view';
+  request: ProductView;
+  sessionId: string;
+  id: string;
+  createdAt: string;
+  status: number;
+}
+export { ProductViewAck };

package/src/model/ProductViewSuggestion.ts

@@ -0,0 +1,7 @@
+import { ProductView } from './ProductView';
+interface ProductViewSuggestion {
+  displayText: string;
+  action: 'product_view';
+  params: ProductView;
+}
+export { ProductViewSuggestion };

package/src/model/SessionData.ts

@@ -1,5 +1,7 @@
 
 interface SessionData {
   eventSourceMap?: Record<string, string[]>;
+  conversationIds?: string[];
+  activeConversationId?: string;
 }
 export { SessionData };

package/src/model/index.ts

@@ -6,6 +6,8 @@ export * from './CommonRequiredFields';
 export * from './ConnectAck';
 export * from './ConnectAckMetadata';
 export * from './ConnectError';
+export * from './ConversationReset';
+export * from './ConversationResetAck';
 export * from './CopilotApiAck';
 export * from './CopilotAPIEvent';
 export * from './CopilotError';
@@ -25,6 +27,9 @@ export * from './FollowUp';
 export * from './Inquiry';
 export * from './OperationAck';
 export * from './PartialInquiry';
+export * from './ProductView';
+export * from './ProductViewAck';
+export * from './ProductViewSuggestion';
 export * from './Progress';
 export * from './ProgressToolKwargs';
 export * from './RefinedSearch';