@lpextend/node-sdk 1.1.4 → 1.1.5

package/dist/index.d.mts

@@ -1480,6 +1480,87 @@ interface CBConsumerQueryMetricsExtendedParams {
     /** Optional progress callback */
     onProgress?: (completed: number, total: number) => void;
 }
+/**
+ * Request parameters for KB search events API
+ * Used to retrieve actual customer queries and their outcomes
+ */
+interface CBKbSearchEventsRequest {
+    /** Start time in milliseconds since epoch */
+    startTime: string;
+    /** End time in milliseconds since epoch */
+    endTime: string;
+    /** Page number (1-based) */
+    pageNumber?: number;
+    /** Number of results per page */
+    pageSize?: number;
+    /** Event types to filter by */
+    eventType?: CBConsumerQueryEventType[];
+    /** Optional KB ID to filter by (omit for all KBs) */
+    kbId?: string;
+}
+/**
+ * Individual KB search event record
+ * Represents a single customer query to the knowledge base
+ */
+interface CBKbSearchEvent {
+    /** Document/Article ID that matched (if answered) */
+    documentId: string;
+    /** Event index */
+    eventIndex: number;
+    /** Unique event ID */
+    eventId: string;
+    /** Conversation ID where this query occurred */
+    conversationId: string;
+    /** LP Account ID */
+    accountId: string;
+    /** Knowledge Base ID */
+    kbId: string;
+    /** Knowledge Base name */
+    kbName: string;
+    /** Message ID */
+    messageId: string;
+    /** The actual customer query/question */
+    question: string;
+    /** Search mode used */
+    searchMode: string;
+    /** When the event was generated (timestamp) */
+    eventGeneratedTime: number;
+    /** Client that made the KAI request */
+    kbClient: string;
+    /** Threshold used for the search */
+    requestedThreshold: string;
+}
+/**
+ * Pagination info for search events response
+ */
+interface CBKbSearchEventsPagination {
+    /** Next page number (0 if no more pages) */
+    nextPage: number;
+    /** Current page number */
+    page: number;
+    /** Total number of events */
+    totalSize: number;
+    /** Total number of pages */
+    totalPages: number;
+    /** Number of results on this page */
+    size: number;
+}
+/**
+ * Response from KB search events API
+ */
+interface CBKbSearchEventsResponse {
+    /** Whether the request was successful */
+    success: boolean;
+    /** Success result containing pagination and events */
+    successResult?: {
+        pagination: CBKbSearchEventsPagination;
+        KbSearchEvents: CBKbSearchEvent[];
+    };
+    /** Error result if request failed */
+    errorResult?: {
+        message: string;
+    };
+}
 
 /**
  * AI Studio Types
@@ -3627,6 +3708,36 @@ declare class KnowledgeBasesAPI {
      * ```
      */
     getConsumerQueryMetricsExtended(params: CBConsumerQueryMetricsExtendedParams): Promise<CBConsumerQueryMetric[]>;
+    /**
+     * Get KB search events (real customer queries)
+     *
+     * Retrieves actual customer queries made to knowledge bases and their outcomes.
+     * This API returns the raw questions customers asked, whether they were answered,
+     * and which KB/articles were involved.
+     *
+     * @param request - Search events request parameters
+     * @returns Promise resolving to search events with pagination
+     *
+     * @example
+     * ```typescript
+     * // Get unanswered questions from the last 7 days
+     * const events = await sdk.conversationBuilder.knowledgeBases.getSearchEvents({
+     *   startTime: String(Date.now() - 7 * 24 * 60 * 60 * 1000),
+     *   endTime: String(Date.now()),
+     *   eventType: ['EVENT_KB_UN_ANSWERED'],
+     *   pageSize: 50,
+     * });
+     *
+     * // Get all events for a specific KB
+     * const kbEvents = await sdk.conversationBuilder.knowledgeBases.getSearchEvents({
+     *   startTime: String(Date.now() - 7 * 24 * 60 * 60 * 1000),
+     *   endTime: String(Date.now()),
+     *   kbId: 'kb-123',
+     *   eventType: ['EVENT_KB_ANSWERED', 'EVENT_KB_UN_ANSWERED'],
+     * });
+     * ```
+     */
+    getSearchEvents(request: CBKbSearchEventsRequest): Promise<CBKbSearchEventsResponse>;
 }
 /**
  * Bot Agents API

package/dist/index.d.ts

@@ -1480,6 +1480,87 @@ interface CBConsumerQueryMetricsExtendedParams {
     /** Optional progress callback */
     onProgress?: (completed: number, total: number) => void;
 }
+/**
+ * Request parameters for KB search events API
+ * Used to retrieve actual customer queries and their outcomes
+ */
+interface CBKbSearchEventsRequest {
+    /** Start time in milliseconds since epoch */
+    startTime: string;
+    /** End time in milliseconds since epoch */
+    endTime: string;
+    /** Page number (1-based) */
+    pageNumber?: number;
+    /** Number of results per page */
+    pageSize?: number;
+    /** Event types to filter by */
+    eventType?: CBConsumerQueryEventType[];
+    /** Optional KB ID to filter by (omit for all KBs) */
+    kbId?: string;
+}
+/**
+ * Individual KB search event record
+ * Represents a single customer query to the knowledge base
+ */
+interface CBKbSearchEvent {
+    /** Document/Article ID that matched (if answered) */
+    documentId: string;
+    /** Event index */
+    eventIndex: number;
+    /** Unique event ID */
+    eventId: string;
+    /** Conversation ID where this query occurred */
+    conversationId: string;
+    /** LP Account ID */
+    accountId: string;
+    /** Knowledge Base ID */
+    kbId: string;
+    /** Knowledge Base name */
+    kbName: string;
+    /** Message ID */
+    messageId: string;
+    /** The actual customer query/question */
+    question: string;
+    /** Search mode used */
+    searchMode: string;
+    /** When the event was generated (timestamp) */
+    eventGeneratedTime: number;
+    /** Client that made the KAI request */
+    kbClient: string;
+    /** Threshold used for the search */
+    requestedThreshold: string;
+}
+/**
+ * Pagination info for search events response
+ */
+interface CBKbSearchEventsPagination {
+    /** Next page number (0 if no more pages) */
+    nextPage: number;
+    /** Current page number */
+    page: number;
+    /** Total number of events */
+    totalSize: number;
+    /** Total number of pages */
+    totalPages: number;
+    /** Number of results on this page */
+    size: number;
+}
+/**
+ * Response from KB search events API
+ */
+interface CBKbSearchEventsResponse {
+    /** Whether the request was successful */
+    success: boolean;
+    /** Success result containing pagination and events */
+    successResult?: {
+        pagination: CBKbSearchEventsPagination;
+        KbSearchEvents: CBKbSearchEvent[];
+    };
+    /** Error result if request failed */
+    errorResult?: {
+        message: string;
+    };
+}
 
 /**
  * AI Studio Types
@@ -3627,6 +3708,36 @@ declare class KnowledgeBasesAPI {
      * ```
      */
     getConsumerQueryMetricsExtended(params: CBConsumerQueryMetricsExtendedParams): Promise<CBConsumerQueryMetric[]>;
+    /**
+     * Get KB search events (real customer queries)
+     *
+     * Retrieves actual customer queries made to knowledge bases and their outcomes.
+     * This API returns the raw questions customers asked, whether they were answered,
+     * and which KB/articles were involved.
+     *
+     * @param request - Search events request parameters
+     * @returns Promise resolving to search events with pagination
+     *
+     * @example
+     * ```typescript
+     * // Get unanswered questions from the last 7 days
+     * const events = await sdk.conversationBuilder.knowledgeBases.getSearchEvents({
+     *   startTime: String(Date.now() - 7 * 24 * 60 * 60 * 1000),
+     *   endTime: String(Date.now()),
+     *   eventType: ['EVENT_KB_UN_ANSWERED'],
+     *   pageSize: 50,
+     * });
+     *
+     * // Get all events for a specific KB
+     * const kbEvents = await sdk.conversationBuilder.knowledgeBases.getSearchEvents({
+     *   startTime: String(Date.now() - 7 * 24 * 60 * 60 * 1000),
+     *   endTime: String(Date.now()),
+     *   kbId: 'kb-123',
+     *   eventType: ['EVENT_KB_ANSWERED', 'EVENT_KB_UN_ANSWERED'],
+     * });
+     * ```
+     */
+    getSearchEvents(request: CBKbSearchEventsRequest): Promise<CBKbSearchEventsResponse>;
 }
 /**
  * Bot Agents API

package/dist/index.js

@@ -2149,6 +2149,57 @@ var KnowledgeBasesAPI = class {
     });
     return uniqueMetrics;
   }
+  /**
+   * Get KB search events (real customer queries)
+   *
+   * Retrieves actual customer queries made to knowledge bases and their outcomes.
+   * This API returns the raw questions customers asked, whether they were answered,
+   * and which KB/articles were involved.
+   *
+   * @param request - Search events request parameters
+   * @returns Promise resolving to search events with pagination
+   *
+   * @example
+   * ```typescript
+   * // Get unanswered questions from the last 7 days
+   * const events = await sdk.conversationBuilder.knowledgeBases.getSearchEvents({
+   *   startTime: String(Date.now() - 7 * 24 * 60 * 60 * 1000),
+   *   endTime: String(Date.now()),
+   *   eventType: ['EVENT_KB_UN_ANSWERED'],
+   *   pageSize: 50,
+   * });
+   *
+   * // Get all events for a specific KB
+   * const kbEvents = await sdk.conversationBuilder.knowledgeBases.getSearchEvents({
+   *   startTime: String(Date.now() - 7 * 24 * 60 * 60 * 1000),
+   *   endTime: String(Date.now()),
+   *   kbId: 'kb-123',
+   *   eventType: ['EVENT_KB_ANSWERED', 'EVENT_KB_UN_ANSWERED'],
+   * });
+   * ```
+   */
+  async getSearchEvents(request) {
+    const body = {
+      startTime: request.startTime,
+      endTime: request.endTime
+    };
+    if (request.pageNumber !== void 0) {
+      body.pageNumber = request.pageNumber;
+    }
+    if (request.pageSize !== void 0) {
+      body.pageSize = request.pageSize;
+    }
+    if (request.eventType !== void 0) {
+      body.eventType = request.eventType;
+    }
+    if (request.kbId !== void 0) {
+      body.kbId = request.kbId;
+    }
+    return this.cb.request("cbKb", "/kb/searchEvents", {
+      method: "POST",
+      body
+    });
+  }
 };
 var BotAgentsAPI = class {
   constructor(cb) {