@studyfetch/sdk 1.33.0 → 1.34.0

package/src/resources/v1/chat-analytics.ts

@@ -0,0 +1,413 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { type Uploadable } from '../../core/uploads';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class ChatAnalytics extends APIResource {
+  /**
+   * Get chat analytics and user statistics
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.chatAnalytics.analyze();
+   * ```
+   */
+  analyze(
+    query: ChatAnalyticAnalyzeParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ChatAnalyticAnalyzeResponse> {
+    return this._client.get('/api/v1/chat-analytics/analyze', { query, ...options });
+  }
+
+  /**
+   * Export chat analytics data as CSV
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.chatAnalytics.export();
+   * ```
+   */
+  export(
+    query: ChatAnalyticExportParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<string> {
+    return this._client.get('/api/v1/chat-analytics/export', {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: 'text/csv' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get chat analytics for a specific component
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.chatAnalytics.getComponent(
+   *   'componentId',
+   * );
+   * ```
+   */
+  getComponent(
+    componentID: string,
+    query: ChatAnalyticGetComponentParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ChatAnalyticGetComponentResponse> {
+    return this._client.get(path`/api/v1/chat-analytics/component/${componentID}`, { query, ...options });
+  }
+}
+
+export interface ChatAnalyticAnalyzeResponse {
+  /**
+   * Date when analytics were generated
+   */
+  generatedAt: string;
+
+  /**
+   * Analytics summary
+   */
+  summary: ChatAnalyticAnalyzeResponse.Summary;
+
+  /**
+   * User statistics
+   */
+  userStats: Array<ChatAnalyticAnalyzeResponse.UserStat>;
+}
+
+export namespace ChatAnalyticAnalyzeResponse {
+  /**
+   * Analytics summary
+   */
+  export interface Summary {
+    /**
+     * Average messages per user
+     */
+    averageMessagesPerUser: number;
+
+    /**
+     * Engagement metrics
+     */
+    engagement: unknown;
+
+    /**
+     * Natural language summary of chat usage
+     */
+    summary: string;
+
+    /**
+     * Top topics discussed
+     */
+    topTopics: Array<string>;
+
+    /**
+     * Total messages
+     */
+    totalMessages: number;
+
+    /**
+     * Total chat sessions
+     */
+    totalSessions: number;
+
+    /**
+     * Total unique users
+     */
+    totalUsers: number;
+  }
+
+  export interface UserStat {
+    /**
+     * Average messages per session
+     */
+    averageMessagesPerSession: number;
+
+    /**
+     * Average session duration in minutes
+     */
+    averageSessionDuration: number;
+
+    /**
+     * First active date
+     */
+    firstActive: string;
+
+    /**
+     * Last active date
+     */
+    lastActive: string;
+
+    /**
+     * Top topics discussed
+     */
+    topTopics: Array<string>;
+
+    /**
+     * Total messages sent by user
+     */
+    totalMessages: number;
+
+    /**
+     * Total chat sessions
+     */
+    totalSessions: number;
+
+    /**
+     * User ID
+     */
+    userId: string;
+
+    /**
+     * User email
+     */
+    email?: string;
+
+    /**
+     * Group IDs associated with the user
+     */
+    groupIds?: Array<string>;
+
+    /**
+     * User name
+     */
+    name?: string;
+  }
+}
+
+export type ChatAnalyticExportResponse = Uploadable;
+
+export interface ChatAnalyticGetComponentResponse {
+  /**
+   * Date when analytics were generated
+   */
+  generatedAt: string;
+
+  /**
+   * Analytics summary
+   */
+  summary: ChatAnalyticGetComponentResponse.Summary;
+
+  /**
+   * User statistics
+   */
+  userStats: Array<ChatAnalyticGetComponentResponse.UserStat>;
+}
+
+export namespace ChatAnalyticGetComponentResponse {
+  /**
+   * Analytics summary
+   */
+  export interface Summary {
+    /**
+     * Average messages per user
+     */
+    averageMessagesPerUser: number;
+
+    /**
+     * Engagement metrics
+     */
+    engagement: unknown;
+
+    /**
+     * Natural language summary of chat usage
+     */
+    summary: string;
+
+    /**
+     * Top topics discussed
+     */
+    topTopics: Array<string>;
+
+    /**
+     * Total messages
+     */
+    totalMessages: number;
+
+    /**
+     * Total chat sessions
+     */
+    totalSessions: number;
+
+    /**
+     * Total unique users
+     */
+    totalUsers: number;
+  }
+
+  export interface UserStat {
+    /**
+     * Average messages per session
+     */
+    averageMessagesPerSession: number;
+
+    /**
+     * Average session duration in minutes
+     */
+    averageSessionDuration: number;
+
+    /**
+     * First active date
+     */
+    firstActive: string;
+
+    /**
+     * Last active date
+     */
+    lastActive: string;
+
+    /**
+     * Top topics discussed
+     */
+    topTopics: Array<string>;
+
+    /**
+     * Total messages sent by user
+     */
+    totalMessages: number;
+
+    /**
+     * Total chat sessions
+     */
+    totalSessions: number;
+
+    /**
+     * User ID
+     */
+    userId: string;
+
+    /**
+     * User email
+     */
+    email?: string;
+
+    /**
+     * Group IDs associated with the user
+     */
+    groupIds?: Array<string>;
+
+    /**
+     * User name
+     */
+    name?: string;
+  }
+}
+
+export interface ChatAnalyticAnalyzeParams {
+  /**
+   * Component ID to analyze
+   */
+  componentId?: string;
+
+  /**
+   * End date for analysis
+   */
+  endDate?: string;
+
+  /**
+   * Group IDs to filter by
+   */
+  groupIds?: Array<string>;
+
+  /**
+   * AI model to use for analysis
+   */
+  modelKey?: string;
+
+  /**
+   * Organization ID to filter by
+   */
+  organizationId?: string;
+
+  /**
+   * Start date for analysis
+   */
+  startDate?: string;
+
+  /**
+   * User ID to filter by
+   */
+  userId?: string;
+}
+
+export interface ChatAnalyticExportParams {
+  /**
+   * Component ID to analyze
+   */
+  componentId?: string;
+
+  /**
+   * End date for analysis
+   */
+  endDate?: string;
+
+  /**
+   * Group IDs to filter by
+   */
+  groupIds?: Array<string>;
+
+  /**
+   * AI model to use for analysis
+   */
+  modelKey?: string;
+
+  /**
+   * Organization ID to filter by
+   */
+  organizationId?: string;
+
+  /**
+   * Start date for analysis
+   */
+  startDate?: string;
+
+  /**
+   * User ID to filter by
+   */
+  userId?: string;
+}
+
+export interface ChatAnalyticGetComponentParams {
+  /**
+   * End date for analysis
+   */
+  endDate?: string;
+
+  /**
+   * Group IDs to filter by
+   */
+  groupIds?: Array<string>;
+
+  /**
+   * AI model to use for analysis
+   */
+  modelKey?: string;
+
+  /**
+   * Organization ID to filter by
+   */
+  organizationId?: string;
+
+  /**
+   * Start date for analysis
+   */
+  startDate?: string;
+
+  /**
+   * User ID to filter by
+   */
+  userId?: string;
+}
+
+export declare namespace ChatAnalytics {
+  export {
+    type ChatAnalyticAnalyzeResponse as ChatAnalyticAnalyzeResponse,
+    type ChatAnalyticExportResponse as ChatAnalyticExportResponse,
+    type ChatAnalyticGetComponentResponse as ChatAnalyticGetComponentResponse,
+    type ChatAnalyticAnalyzeParams as ChatAnalyticAnalyzeParams,
+    type ChatAnalyticExportParams as ChatAnalyticExportParams,
+    type ChatAnalyticGetComponentParams as ChatAnalyticGetComponentParams,
+  };
+}