@lpextend/node-sdk 1.1.3 → 1.1.5

package/dist/index.mjs

@@ -2048,6 +2048,156 @@ var KnowledgeBasesAPI = class {
   async getDefaultPrompt() {
     return this.cb.request("cbKb", "/default-prompt");
   }
+  /**
+   * Get consumer query metrics for a knowledge base
+   *
+   * Retrieves answered and/or unanswered query metrics within a date range.
+   * Note: The API only supports 7-day ranges. For longer ranges, use getConsumerQueryMetricsExtended().
+   *
+   * @param params - Query parameters including kbId, startTime, endTime, and eventType
+   * @returns Promise resolving to consumer query metrics
+   *
+   * @example
+   * ```typescript
+   * const metrics = await sdk.conversationBuilder.knowledgeBases.getConsumerQueryMetrics({
+   *   kbId: 'kb-123',
+   *   startTime: Date.now() - 7 * 24 * 60 * 60 * 1000, // 7 days ago
+   *   endTime: Date.now(),
+   *   eventType: ['EVENT_KB_UN_ANSWERED'],
+   * });
+   * ```
+   */
+  async getConsumerQueryMetrics(params) {
+    const body = {
+      startTime: String(params.startTime),
+      endTime: String(params.endTime),
+      eventType: params.eventType,
+      kbId: params.kbId
+    };
+    return this.cb.request("cbKb", "/kb/consumerQueryMetrics", {
+      method: "POST",
+      body
+    });
+  }
+  /**
+   * Get consumer query metrics for extended date ranges (up to 3 months)
+   *
+   * Automatically iterates through 7-day chunks to retrieve all metrics within
+   * the specified date range. Useful for historical analysis beyond the 7-day API limit.
+   *
+   * @param params - Extended query parameters including startDate, endDate, kbId, and eventType
+   * @returns Promise resolving to aggregated consumer query metrics from all chunks
+   *
+   * @example
+   * ```typescript
+   * const metrics = await sdk.conversationBuilder.knowledgeBases.getConsumerQueryMetricsExtended({
+   *   kbId: 'kb-123',
+   *   startDate: new Date('2024-01-01'),
+   *   endDate: new Date('2024-03-01'),
+   *   eventType: ['EVENT_KB_ANSWERED', 'EVENT_KB_UN_ANSWERED'],
+   *   onProgress: (completed, total) => console.log(`${completed}/${total} chunks processed`),
+   * });
+   * ```
+   */
+  async getConsumerQueryMetricsExtended(params) {
+    const { startDate, endDate, eventType, kbId, onProgress } = params;
+    const startMs = typeof startDate === "number" ? startDate : startDate.getTime();
+    const endMs = typeof endDate === "number" ? endDate : endDate.getTime();
+    const maxRangeMs = 90 * 24 * 60 * 60 * 1e3;
+    if (endMs - startMs > maxRangeMs) {
+      throw new LPExtendSDKError(
+        "Date range exceeds maximum of 90 days. Please use a smaller range.",
+        ErrorCodes.INVALID_CONFIG
+      );
+    }
+    const chunkSizeMs = 7 * 24 * 60 * 60 * 1e3;
+    const chunks = [];
+    let chunkStart = startMs;
+    while (chunkStart < endMs) {
+      const chunkEnd = Math.min(chunkStart + chunkSizeMs, endMs);
+      chunks.push({ start: chunkStart, end: chunkEnd });
+      chunkStart = chunkEnd;
+    }
+    const allMetrics = [];
+    for (let i = 0; i < chunks.length; i++) {
+      const chunk = chunks[i];
+      try {
+        const response = await this.getConsumerQueryMetrics({
+          kbId,
+          startTime: chunk.start,
+          endTime: chunk.end,
+          eventType
+        });
+        if (response.data && Array.isArray(response.data)) {
+          allMetrics.push(...response.data);
+        }
+      } catch (error) {
+        console.warn(`Failed to fetch metrics for chunk ${i + 1}/${chunks.length}:`, error);
+      }
+      if (onProgress) {
+        onProgress(i + 1, chunks.length);
+      }
+    }
+    const seen = /* @__PURE__ */ new Set();
+    const uniqueMetrics = allMetrics.filter((metric) => {
+      const key = metric.id || `${metric.consumerQuery}-${metric.timestamp}`;
+      if (seen.has(key)) return false;
+      seen.add(key);
+      return true;
+    });
+    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) {