@iblai/iblai-api 3.34.5-ai

package/dist/types/services/AiAnalyticsService.d.ts

@@ -0,0 +1,1056 @@
+import type { AnalyticsOverview } from '../models/AnalyticsOverview';
+import type { ChatHistoryFilterData } from '../models/ChatHistoryFilterData';
+import type { ConversationMessage } from '../models/ConversationMessage';
+import type { Conversations } from '../models/Conversations';
+import type { ConversationSummary } from '../models/ConversationSummary';
+import type { ConversationVolume } from '../models/ConversationVolume';
+import type { Cost } from '../models/Cost';
+import type { CostPerTenant } from '../models/CostPerTenant';
+import type { LLMTracesListResponse } from '../models/LLMTracesListResponse';
+import type { MentorDetailAnalytics } from '../models/MentorDetailAnalytics';
+import type { MessageStatistics } from '../models/MessageStatistics';
+import type { ModelCost } from '../models/ModelCost';
+import type { PaginatedConversationsList } from '../models/PaginatedConversationsList';
+import type { PaginatedTopicStatisticsResponse } from '../models/PaginatedTopicStatisticsResponse';
+import type { PatchedConversations } from '../models/PatchedConversations';
+import type { PieChartData } from '../models/PieChartData';
+import type { RatingRecord } from '../models/RatingRecord';
+import type { SentimentSummary } from '../models/SentimentSummary';
+import type { StudentChatMessage } from '../models/StudentChatMessage';
+import type { TenantMentorTraces } from '../models/TenantMentorTraces';
+import type { TopicRecord } from '../models/TopicRecord';
+import type { TopicStatisticsResponse } from '../models/TopicStatisticsResponse';
+import type { TopicSummaryView } from '../models/TopicSummaryView';
+import type { TrendEntry } from '../models/TrendEntry';
+import type { UserChatByPeriod } from '../models/UserChatByPeriod';
+import type { UserChatFeedbackCount } from '../models/UserChatFeedbackCount';
+import type { UserCountRecord } from '../models/UserCountRecord';
+import type { UserMetricsResponse } from '../models/UserMetricsResponse';
+import type { UserSentimentCountView } from '../models/UserSentimentCountView';
+import type { UserTrendByPeriod } from '../models/UserTrendByPeriod';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class AiAnalyticsService {
+    /**
+     * Retrieve paginated LLM usage costs aggregated by tenant.
+     * @param endDate
+     * @param startDate
+     * @returns CostPerTenant
+     * @throws ApiError
+     */
+    static aiAnalyticsCostsPertenantList(endDate: string, startDate: string): CancelablePromise<Array<CostPerTenant>>;
+    /**
+     * Retrieve average message counts per session over time.
+     *
+     * This endpoint returns data on the average number of messages exchanged in each
+     * conversation session within a specified date range, with options for filtering
+     * by mentor and aggregating by different time periods (hourly, daily, weekly).
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: Time series of average message counts and session totals.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     * BadRequest: If the provided parameters are invalid.
+     *
+     * Query Parameters:
+     * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
+     * end_date (str): End date for filtering (YYYY-MM-DD) - required.
+     * mentor_id (str): Filter by mentor unique ID.
+     * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
+     * @param endDate End date for filtering (YYYY-MM-DD)
+     * @param org
+     * @param startDate Start date for filtering (YYYY-MM-DD)
+     * @param userId
+     * @param aggregation Time aggregation level (hourly, daily, weekly)
+     * @param groupBy
+     * @param mentorId Filter by mentor unique ID
+     * @returns MessageStatistics
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersAverageMessagesPerSessionList(endDate: string, org: string, startDate: string, userId: string, aggregation?: 'daily' | 'hourly' | 'weekly', groupBy?: string, mentorId?: string): CancelablePromise<Array<MessageStatistics>>;
+    /**
+     * API viewset for retrieving and filtering chat message history.
+     *
+     * This viewset provides endpoints for retrieving chat message history
+     * within an organization, with extensive filtering options by date range,
+     * user, topic, mentor, and sentiment.
+     *
+     * Permissions:
+     * - Restricted to platform administrators only
+     * @param org
+     * @param userId
+     * @param endDate
+     * @param mentor
+     * @param page A page number within the paginated result set.
+     * @param pageSize Number of results to return per page.
+     * @param sentiment
+     * @param startDate
+     * @param topics
+     * @param userId
+     * @returns PaginatedConversationsList
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersChatHistoryList(org: string, userId: string, endDate?: string, mentor?: string, page?: number, pageSize?: number, sentiment?: string, startDate?: string, topics?: string): CancelablePromise<PaginatedConversationsList>;
+    /**
+     * API viewset for retrieving and filtering chat message history.
+     *
+     * This viewset provides endpoints for retrieving chat message history
+     * within an organization, with extensive filtering options by date range,
+     * user, topic, mentor, and sentiment.
+     *
+     * Permissions:
+     * - Restricted to platform administrators only
+     * @param org
+     * @param userId
+     * @param requestBody
+     * @param endDate
+     * @param mentor
+     * @param sentiment
+     * @param startDate
+     * @param topics
+     * @param userId
+     * @returns Conversations
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersChatHistoryCreate(org: string, userId: string, requestBody: Conversations, endDate?: string, mentor?: string, sentiment?: string, startDate?: string, topics?: string): CancelablePromise<Conversations>;
+    /**
+     * Retrieve filter options for chat message history.
+     *
+     * This endpoint returns data on available filter options for the chat message
+     * history endpoint, including topics, date ranges (weekly or monthly),
+     * sentiments, and users who have chat history.
+     *
+     * Args:
+     * request: The HTTP request containing query parameters.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: Available filter options for chat message history.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     *
+     * Query Parameters:
+     * monthly_range (bool): Whether to return monthly or weekly date ranges.
+     * mentor_id (str): Filter users by those who have chatted with a specific mentor.
+     * @param org
+     * @param userId
+     * @param endDate
+     * @param mentorId
+     * @param monthlyRange
+     * @param startDate
+     * @returns ChatHistoryFilterData
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersChatHistoryFilterRetrieve(org: string, userId: string, endDate?: string, mentorId?: string, monthlyRange?: boolean, startDate?: string): CancelablePromise<ChatHistoryFilterData>;
+    /**
+     * API viewset for retrieving and filtering chat message history.
+     *
+     * This viewset provides endpoints for retrieving chat message history
+     * within an organization, with extensive filtering options by date range,
+     * user, topic, mentor, and sentiment.
+     *
+     * Permissions:
+     * - Restricted to platform administrators only
+     * @param id A UUID string identifying this session.
+     * @param org
+     * @param userId
+     * @param endDate
+     * @param mentor
+     * @param sentiment
+     * @param startDate
+     * @param topics
+     * @param userId
+     * @returns Conversations
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersChatHistoryRetrieve(id: string, org: string, userId: string, endDate?: string, mentor?: string, sentiment?: string, startDate?: string, topics?: string): CancelablePromise<Conversations>;
+    /**
+     * API viewset for retrieving and filtering chat message history.
+     *
+     * This viewset provides endpoints for retrieving chat message history
+     * within an organization, with extensive filtering options by date range,
+     * user, topic, mentor, and sentiment.
+     *
+     * Permissions:
+     * - Restricted to platform administrators only
+     * @param id A UUID string identifying this session.
+     * @param org
+     * @param userId
+     * @param requestBody
+     * @param endDate
+     * @param mentor
+     * @param sentiment
+     * @param startDate
+     * @param topics
+     * @param userId
+     * @returns Conversations
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersChatHistoryUpdate(id: string, org: string, userId: string, requestBody: Conversations, endDate?: string, mentor?: string, sentiment?: string, startDate?: string, topics?: string): CancelablePromise<Conversations>;
+    /**
+     * API viewset for retrieving and filtering chat message history.
+     *
+     * This viewset provides endpoints for retrieving chat message history
+     * within an organization, with extensive filtering options by date range,
+     * user, topic, mentor, and sentiment.
+     *
+     * Permissions:
+     * - Restricted to platform administrators only
+     * @param id A UUID string identifying this session.
+     * @param org
+     * @param userId
+     * @param endDate
+     * @param mentor
+     * @param sentiment
+     * @param startDate
+     * @param topics
+     * @param userId
+     * @param requestBody
+     * @returns Conversations
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersChatHistoryPartialUpdate(id: string, org: string, userId: string, endDate?: string, mentor?: string, sentiment?: string, startDate?: string, topics?: string, requestBody?: PatchedConversations): CancelablePromise<Conversations>;
+    /**
+     * API viewset for retrieving and filtering chat message history.
+     *
+     * This viewset provides endpoints for retrieving chat message history
+     * within an organization, with extensive filtering options by date range,
+     * user, topic, mentor, and sentiment.
+     *
+     * Permissions:
+     * - Restricted to platform administrators only
+     * @param id A UUID string identifying this session.
+     * @param org
+     * @param userId
+     * @param endDate
+     * @param mentor
+     * @param sentiment
+     * @param startDate
+     * @param topics
+     * @param userId
+     * @returns void
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersChatHistoryDestroy(id: string, org: string, userId: string, endDate?: string, mentor?: string, sentiment?: string, startDate?: string, topics?: string): CancelablePromise<void>;
+    /**
+     * Retrieve conversation volume data over time.
+     *
+     * This endpoint returns data on the number of conversations that occurred
+     * within a specified date range, with options for different time aggregations
+     * (hourly, daily, weekly). Results can be filtered by mentor.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     * user_id: User identifier (not used in the implementation).
+     *
+     * Returns:
+     * Response: Time series data of conversation counts.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     * BadRequest: If the provided parameters are invalid.
+     *
+     * Query Parameters:
+     * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
+     * end_date (str): End date for filtering (YYYY-MM-DD) - required.
+     * mentor_id (str): Filter by mentor unique ID.
+     * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
+     * @param endDate End date for filtering (YYYY-MM-DD)
+     * @param org
+     * @param startDate Start date for filtering (YYYY-MM-DD)
+     * @param userId
+     * @param aggregation Time aggregation level (hourly, daily, weekly)
+     * @param mentorId Filter by mentor unique ID
+     * @returns ConversationVolume
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersConversationList(endDate: string, org: string, startDate: string, userId: string, aggregation?: 'daily' | 'hourly' | 'weekly', mentorId?: string): CancelablePromise<Array<ConversationVolume>>;
+    /**
+     * Retrieve a summary of conversation metrics.
+     *
+     * This endpoint returns aggregated metrics about conversations within an organization,
+     * including:
+     * - Total number of conversations
+     * - Total number of human messages
+     * - Total number of AI messages
+     *
+     * Results can be filtered by mentor.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: Summary of conversation metrics.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     *
+     * Query Parameters:
+     * mentor_id (str): Filter by mentor unique ID.
+     * @param org
+     * @param userId
+     * @param groupBy
+     * @param mentorId Filter by mentor unique ID
+     * @returns ConversationSummary
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersConversationSummaryRetrieve(org: string, userId: string, groupBy?: string, mentorId?: string): CancelablePromise<ConversationSummary>;
+    /**
+     * Retrieve the  model costs for a tenant
+     *
+     * Filter parameters for period are start_date and enddate
+     *
+     * Accessible to tenant Admins only.
+     * @param endDate
+     * @param org
+     * @param startDate
+     * @param userId
+     * @returns ModelCost
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersCostsModelRetrieve(endDate: string, org: string, startDate: string, userId: string): CancelablePromise<ModelCost>;
+    /**
+     * Retrieve LLM usage costs aggregated by mentor.
+     *
+     * This endpoint returns data on the total cost of LLM usage for each mentor
+     * within a specified date range, with pagination support. The costs are
+     * calculated by summing the costs of all observations associated with
+     * traces from the mentor's sessions.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: Paginated list of mentors with their total LLM usage costs.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     * BadRequest: If the provided parameters are invalid.
+     *
+     * Query Parameters:
+     * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
+     * end_date (str): End date for filtering (YYYY-MM-DD) - required.
+     * limit (int): Number of results per page - default: 5.
+     * offset (int): Offset for pagination - default: 0.
+     * @param endDate
+     * @param org
+     * @param startDate
+     * @param userId
+     * @returns TenantMentorTraces
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersCostsPermentorRetrieve(endDate: string, org: string, startDate: string, userId: string): CancelablePromise<TenantMentorTraces>;
+    /**
+     * Retrieve LLM usage costs aggregated by user.
+     *
+     * This endpoint returns data on the total cost of LLM usage for each user
+     * within a specified date range, with pagination support. The costs are
+     * calculated by summing the costs of all observations associated with
+     * traces from the user's sessions.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: Paginated list of users with their total LLM usage costs.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     * BadRequest: If the provided parameters are invalid.
+     *
+     * Query Parameters:
+     * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
+     * end_date (str): End date for filtering (YYYY-MM-DD) - required.
+     * limit (int): Number of results per page - default: 10.
+     * offset (int): Offset for pagination - default: 0.
+     * @param endDate
+     * @param org
+     * @param startDate
+     * @param userId
+     * @returns LLMTracesListResponse
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersCostsPeruserRetrieve(endDate: string, org: string, startDate: string, userId: string): CancelablePromise<LLMTracesListResponse>;
+    /**
+     * Retrieve summary statistics about mentors.
+     *
+     * This endpoint returns aggregated statistics about mentors within an organization,
+     * including total mentors, active mentors (mentors with at least one session),
+     * questions answered, and ratings.
+     *
+     * Args:
+     * request: The HTTP request.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: Summary statistics about mentors.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     * @param org
+     * @param userId
+     * @returns MentorDetailAnalytics
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersMentorDetailRetrieve(org: string, userId: string): CancelablePromise<MentorDetailAnalytics>;
+    /**
+     * Retrieve summary statistics about mentors.
+     *
+     * This endpoint returns aggregated statistics about mentors within an organization,
+     * including total mentors, active mentors (mentors with at least one session),
+     * questions answered, and ratings.
+     *
+     * Args:
+     * request: The HTTP request.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: Summary statistics about mentors.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     * @param org
+     * @param userId
+     * @returns MentorDetailAnalytics
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersMentorSummaryRetrieve(org: string, userId: string): CancelablePromise<MentorDetailAnalytics>;
+    /**
+     * Retrieve LLM usage costs for a specific mentor.
+     *
+     * This endpoint returns data on the total cost of LLM usage for a specific mentor
+     * within a specified date range. The cost is calculated by summing the costs
+     * of all observations associated with traces from the tenant's sessions.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     * mentor_unique_id: User key identifier.
+     *
+     * Returns:
+     * Response: Total LLM usage cost for the specified tenant.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     * BadRequest: If the provided parameters are invalid.
+     *
+     * Query Parameters:
+     * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
+     * end_date (str): End date for filtering (YYYY-MM-DD) - required.
+     * @param endDate
+     * @param mentorUniqueId
+     * @param org
+     * @param startDate
+     * @param userId
+     * @returns Cost
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersMentorsCostRetrieve(endDate: string, mentorUniqueId: string, org: string, startDate: string, userId: string): CancelablePromise<Cost>;
+    /**
+     * Retrieve the most discussed topics over time.
+     *
+     * This endpoint returns data on the frequency of topics discussed in conversations
+     * within a specified date range, with options for filtering by mentor and
+     * aggregating by different time periods (hourly, daily, weekly).
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: List of topics with their conversation counts, ordered by frequency.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     * BadRequest: If the provided parameters are invalid.
+     *
+     * Query Parameters:
+     * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
+     * end_date (str): End date for filtering (YYYY-MM-DD) - required.
+     * mentor_id (str): Filter by mentor unique ID.
+     * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
+     * @param endDate End date for filtering (YYYY-MM-DD)
+     * @param org
+     * @param startDate Start date for filtering (YYYY-MM-DD)
+     * @param userId
+     * @param aggregation Time aggregation level (hourly, daily, weekly)
+     * @param groupBy
+     * @param mentorId Filter by mentor unique ID
+     * @returns TopicRecord
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersMostDiscussedTopicsList(endDate: string, org: string, startDate: string, userId: string, aggregation?: 'daily' | 'hourly' | 'weekly', groupBy?: string, mentorId?: string): CancelablePromise<Array<TopicRecord>>;
+    /**
+     * Retrieve an overview of key analytics metrics.
+     *
+     * This endpoint returns a comprehensive overview of key analytics metrics
+     * for an organization, including:
+     * - Conversation volume: Total sessions and month-over-month change
+     * - Users: Total unique users and month-over-month change
+     * - Topics: Total unique topics and month-over-month change
+     * - User ratings: Total ratings and month-over-month change
+     *
+     * Results can be filtered by mentor.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     * user_id: User identifier (not used in the implementation).
+     *
+     * Returns:
+     * Response: Overview of key analytics metrics with month-over-month changes.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     *
+     * Query Parameters:
+     * mentor_id (str): Filter analytics by mentor unique ID.
+     * @param org
+     * @param userId
+     * @param groupBy
+     * @param mentorId Filter analytics by mentor unique ID
+     * @returns AnalyticsOverview
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersOverviewSummaryRetrieve(org: string, userId: string, groupBy?: string, mentorId?: string): CancelablePromise<AnalyticsOverview>;
+    /**
+     * Retrieve user rating metrics over time.
+     *
+     * This endpoint returns data on the number of user ratings submitted
+     * within a specified date range, aggregated by day or hour.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: Time series of rating counts aggregated by day or hour.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     * BadRequest: If the provided parameters are invalid.
+     *
+     * Query Parameters:
+     * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
+     * end_date (str): End date for filtering (YYYY-MM-DD) - required.
+     * group_by (str): Aggregation level (day or hour) - default: day.
+     * @param endDate End date for filtering (YYYY-MM-DD)
+     * @param org
+     * @param startDate Start date for filtering (YYYY-MM-DD)
+     * @param userId
+     * @param groupBy Aggregation level (day or hour)
+     * @returns RatingRecord
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersRatingSummaryList(endDate: string, org: string, startDate: string, userId: string, groupBy?: 'day' | 'hour'): CancelablePromise<Array<RatingRecord>>;
+    /**
+     * Retrieve trends of registered users over time.
+     *
+     * This endpoint returns data on the number of new user registrations
+     * within a specified date range, with options for different time aggregations
+     * (hourly, daily, weekly, monthly). The data is backfilled to ensure
+     * continuous time series even for periods with zero registrations.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: Time series of user registration counts.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     * BadRequest: If the provided parameters are invalid.
+     *
+     * Query Parameters:
+     * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
+     * end_date (str): End date for filtering (YYYY-MM-DD) - required.
+     * aggregation (str): Time aggregation level (hourly, daily, weekly, monthly) - default: daily.
+     * @param endDate End date for filtering (YYYY-MM-DD)
+     * @param org
+     * @param startDate Start date for filtering (YYYY-MM-DD)
+     * @param userId
+     * @param aggregation Time aggregation level (hourly, daily, weekly, monthly)
+     * @param groupBy
+     * @returns TrendEntry
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersRegisteredUsersTrendList(endDate: string, org: string, startDate: string, userId: string, aggregation?: 'daily' | 'hourly' | 'monthly' | 'weekly', groupBy?: string): CancelablePromise<Array<TrendEntry>>;
+    /**
+     * Retrieve user sentiment counts over time.
+     *
+     * This endpoint returns data on the number of user sentiment entries
+     * within a specified time period, aggregated by date.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     * user_id: User identifier.
+     *
+     * Returns:
+     * Response: Time series data of sentiment counts.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     * ValidationError: If the provided query parameters are invalid.
+     *
+     * Query Parameters:
+     * period (str): Time period filter (today, yesterday, 7d, 30d, 90d) - default: 7d.
+     * @param org
+     * @param userId
+     * @param period
+     * @returns UserSentimentCountView
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersSentimentCountList(org: string, userId: string, period?: string): CancelablePromise<Array<UserSentimentCountView>>;
+    /**
+     * Retrieve LLM usage costs for a specific tenant.
+     *
+     * This endpoint returns data on the total cost of LLM usage for a specific tenant
+     * within a specified date range. The cost is calculated by summing the costs
+     * of all observations associated with traces from the tenant's sessions.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: Total LLM usage cost for the specified tenant.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     * BadRequest: If the provided parameters are invalid.
+     *
+     * Query Parameters:
+     * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
+     * end_date (str): End date for filtering (YYYY-MM-DD) - required.
+     * @param endDate
+     * @param org
+     * @param startDate
+     * @param userId
+     * @returns Cost
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersTenantCostRetrieve(endDate: string, org: string, startDate: string, userId: string): CancelablePromise<Cost>;
+    /**
+     * Retrieve the most engaged students based on chat message count.
+     *
+     * This endpoint returns data on the top 20 students with the highest number of
+     * chat messages, with optional filtering by mentor and date range.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     * user_id: User identifier (not used in the implementation).
+     *
+     * Returns:
+     * Response: List of top students with their chat message counts.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     * BadRequest: If the provided parameters are invalid.
+     *
+     * Query Parameters:
+     * mentor_id (str): Filter by mentor unique ID.
+     * start_date (str): Start date for filtering (YYYY-MM-DD).
+     * end_date (str): End date for filtering (YYYY-MM-DD).
+     * @param org
+     * @param userId
+     * @param groupBy
+     * @returns StudentChatMessage
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersTopStudentsByChatMessagesList(org: string, userId: string, groupBy?: string): CancelablePromise<Array<StudentChatMessage>>;
+    /**
+     * Retrieve aggregated topic statistics.
+     *
+     * This endpoint returns statistical information about topics within an organization,
+     * including total topics, new topics, and percentage changes compared to the
+     * previous month. Results can be filtered by mentor.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: Statistical information about topics.
+     *
+     * Raises:
+     * NotFound: If the specified organization or mentor does not exist.
+     *
+     * Query Parameters:
+     * mentor_id (str): Filter statistics by mentor unique ID.
+     * @param org
+     * @param userId
+     * @param mentorId Filter statistics by mentor unique ID
+     * @returns TopicStatisticsResponse
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersTopicOverviewRetrieve(org: string, userId: string, mentorId?: string): CancelablePromise<TopicStatisticsResponse>;
+    /**
+     * Retrieve paginated statistics about topics.
+     *
+     * This endpoint returns detailed statistics about topics, including:
+     * - Number of conversations related to each topic
+     * - Total message count for each topic
+     * - Average sentiment of conversations about each topic
+     * - Average user rating for conversations about each topic
+     *
+     * Results can be filtered by mentor and date range, and are paginated.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: Paginated list of topic statistics.
+     *
+     * Raises:
+     * NotFound: If the specified organization or mentor does not exist.
+     * BadRequest: If the provided parameters are invalid.
+     *
+     * Query Parameters:
+     * start_date (str): Start date for filtering (YYYY-MM-DD).
+     * end_date (str): End date for filtering (YYYY-MM-DD).
+     * mentor_id (str): Filter by mentor unique ID.
+     * page (int): Page number for pagination - default: 1.
+     * page_size (int): Number of results per page - default: 20.
+     * @param org
+     * @param userId
+     * @param endDate End date for filtering (YYYY-MM-DD)
+     * @param groupBy
+     * @param mentorId Filter by mentor unique ID
+     * @param page Page number for pagination
+     * @param pageSize Number of results per page
+     * @param startDate Start date for filtering (YYYY-MM-DD)
+     * @returns PaginatedTopicStatisticsResponse
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersTopicStatisticsRetrieve(org: string, userId: string, endDate?: string, groupBy?: string, mentorId?: string, page?: number, pageSize?: number, startDate?: string): CancelablePromise<PaginatedTopicStatisticsResponse>;
+    /**
+     * Retrieve a summary of the most frequent topics.
+     *
+     * This endpoint returns a summary of the top 10 topics discussed in chat sessions,
+     * ordered by conversation count. Results can be filtered by mentor and date range.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: A list of the top 10 topics with their conversation counts.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     * BadRequest: If the provided date format is invalid.
+     *
+     * Query Parameters:
+     * mentor_id (str): Filter by mentor unique ID.
+     * start_date (str): Start date for filtering (YYYY-MM-DD).
+     * end_date (str): End date for filtering (YYYY-MM-DD).
+     * @param org
+     * @param userId
+     * @param endDate
+     * @param startDate
+     * @returns TopicSummaryView
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersTopicsSummaryList(org: string, userId: string, endDate?: string, startDate?: string): CancelablePromise<Array<TopicSummaryView>>;
+    /**
+     * Retrieve the total number of users interacting with mentors over time.
+     *
+     * This endpoint returns data on the number of unique users who interacted with
+     * mentors each day or hour within a specified date range, with optional
+     * filtering by specific mentor. If no date range is provided, the last 30 days
+     * are used by default.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: Time series of unique user counts.
+     *
+     * Raises:
+     * NotFound: If the specified organization or mentor does not exist.
+     * BadRequest: If the provided parameters are invalid.
+     *
+     * Query Parameters:
+     * start_date (str): Start date for filtering (YYYY-MM-DD) - defaults to 30 days ago.
+     * end_date (str): End date for filtering (YYYY-MM-DD) - defaults to today.
+     * aggregation (str): Time aggregation level (hourly, daily) - default: daily.
+     * mentor_id (str): Filter by mentor unique ID.
+     * @param org
+     * @param userId
+     * @param aggregation Time aggregation level (hourly, daily)
+     * @param endDate End date for filtering (YYYY-MM-DD)
+     * @param groupBy
+     * @param mentorId Filter by mentor unique ID
+     * @param startDate Start date for filtering (YYYY-MM-DD)
+     * @returns UserChatByPeriod
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersTotalUsersByMentorList(org: string, userId: string, aggregation?: 'daily' | 'hourly', endDate?: string, groupBy?: string, mentorId?: string, startDate?: string): CancelablePromise<Array<UserChatByPeriod>>;
+    /**
+     * Retrieve message data from conversations.
+     *
+     * This endpoint returns data on messages within conversations, with options
+     * for filtering by date range, topics, and mentor.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     * user_id: User identifier (not used in the implementation).
+     *
+     * Returns:
+     * Response: A list of conversation message data.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     * ValidationError: If the provided query parameters are invalid.
+     *
+     * Query Parameters:
+     * start_date (str): Start date for filtering (YYYY-MM-DD).
+     * end_date (str): End date for filtering (YYYY-MM-DD).
+     * topics (str): Comma-separated list of topics to filter by.
+     * mentor (str): Filter by mentor unique ID.
+     * @param org
+     * @param userId
+     * @param endDate
+     * @param mentor
+     * @param startDate
+     * @param topics
+     * @returns ConversationMessage
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersTranscriptsList(org: string, userId: string, endDate?: string, mentor?: string, startDate?: string, topics?: string): CancelablePromise<Array<ConversationMessage>>;
+    /**
+     * Retrieve daily user engagement metrics with mentors.
+     *
+     * This endpoint returns data on the number of unique users who interact with
+     * mentors each day within a specified date range.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: Daily time series of unique user counts.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     * BadRequest: If the provided parameters are invalid.
+     *
+     * Query Parameters:
+     * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
+     * end_date (str): End date for filtering (YYYY-MM-DD) - required.
+     * @param endDate End date for filtering (YYYY-MM-DD)
+     * @param org
+     * @param startDate Start date for filtering (YYYY-MM-DD)
+     * @param userId
+     * @param groupBy
+     * @returns UserCountRecord
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersUsageSummaryList(endDate: string, org: string, startDate: string, userId: string, groupBy?: string): CancelablePromise<Array<UserCountRecord>>;
+    /**
+     * Retrieve user cohort trends over time.
+     *
+     * This endpoint returns data on the distribution of new versus veteran users
+     * over time, with options for different time aggregations and filtering by mentor.
+     * New users are those who registered within the specified date range, while
+     * veteran users are those who registered before the date range but were active
+     * during it.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: Time series of new and veteran user counts.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     * BadRequest: If the provided parameters are invalid.
+     *
+     * Query Parameters:
+     * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
+     * end_date (str): End date for filtering (YYYY-MM-DD) - required.
+     * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
+     * mentor_id (str): Filter by mentor unique ID.
+     * @param endDate End date for filtering (YYYY-MM-DD)
+     * @param org
+     * @param startDate Start date for filtering (YYYY-MM-DD)
+     * @param userId
+     * @param aggregation Time aggregation level (hourly, daily, weekly)
+     * @param mentorId Filter by mentor unique ID
+     * @returns UserTrendByPeriod
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersUserCohortsOverTimeRetrieve(endDate: string, org: string, startDate: string, userId: string, aggregation?: 'daily' | 'hourly' | 'weekly', mentorId?: string): CancelablePromise<UserTrendByPeriod>;
+    /**
+     * Retrieve LLM usage costs for a specific user.
+     *
+     * This endpoint returns data on the total cost of LLM usage for a specific user
+     * within a specified date range. The cost is calculated by summing the costs
+     * of all observations associated with traces from the tenant's sessions.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     * user_id: User key identifier.
+     *
+     * Returns:
+     * Response: Total LLM usage cost for the specified tenant.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     * BadRequest: If the provided parameters are invalid.
+     *
+     * Query Parameters:
+     * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
+     * end_date (str): End date for filtering (YYYY-MM-DD) - required.
+     * @param endDate
+     * @param org
+     * @param startDate
+     * @param userId
+     * @param username
+     * @returns Cost
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersUserCostRetrieve(endDate: string, org: string, startDate: string, userId: string, username: string): CancelablePromise<Cost>;
+    /**
+     * Retrieve aggregated user chat feedback counts.
+     *
+     * This endpoint returns data on the number of user chat feedback entries
+     * within a specified date range, with options for different time aggregations
+     * (hourly, daily, weekly). Results can be filtered by mentor.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: Time series data of feedback counts.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     * BadRequest: If the provided parameters are invalid.
+     *
+     * Query Parameters:
+     * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
+     * end_date (str): End date for filtering (YYYY-MM-DD) - required.
+     * mentor_id (str): Filter by mentor unique ID.
+     * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
+     * @param endDate End date for filtering (YYYY-MM-DD)
+     * @param org
+     * @param startDate Start date for filtering (YYYY-MM-DD)
+     * @param userId
+     * @param aggregation Time aggregation level (hourly, daily, weekly)
+     * @param mentorId Filter by mentor unique ID
+     * @returns UserChatFeedbackCount
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersUserFeedbackList(endDate: string, org: string, startDate: string, userId: string, aggregation?: 'daily' | 'hourly' | 'weekly', mentorId?: string): CancelablePromise<Array<UserChatFeedbackCount>>;
+    /**
+     * Retrieve comprehensive user metrics.
+     *
+     * This endpoint returns data on various user metrics with month-over-month
+     * change calculations:
+     * - Registered users: Total users registered on the platform
+     * - New users: Users who joined in the current month
+     * - Unique users: Distinct users who have had sessions
+     * - Veteran users: Users who have been active for at least 6 months
+     *
+     * Results can be filtered by mentor.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: Comprehensive user metrics with month-over-month changes.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     *
+     * Query Parameters:
+     * mentor_id (str): Filter metrics by mentor unique ID.
+     * @param org
+     * @param userId
+     * @param groupBy
+     * @param mentorId Filter metrics by mentor unique ID
+     * @returns UserMetricsResponse
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersUserMetricsRetrieve(org: string, userId: string, groupBy?: string, mentorId?: string): CancelablePromise<UserMetricsResponse>;
+    /**
+     * Retrieve user distribution data for pie charts.
+     *
+     * This endpoint returns data on the distribution of new versus returning users
+     * within a specified date range, including both counts and percentages,
+     * suitable for pie chart visualization.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: Distribution of new versus returning users with counts and percentages.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     * BadRequest: If the provided parameters are invalid.
+     *
+     * Query Parameters:
+     * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
+     * end_date (str): End date for filtering (YYYY-MM-DD) - required.
+     * mentor_id (str): Filter by mentor unique ID.
+     * @param endDate End date for filtering (YYYY-MM-DD)
+     * @param org
+     * @param startDate Start date for filtering (YYYY-MM-DD)
+     * @param userId
+     * @param mentorId Filter by mentor unique ID
+     * @returns PieChartData
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersUserMetricsPieChartRetrieve(endDate: string, org: string, startDate: string, userId: string, mentorId?: string): CancelablePromise<PieChartData>;
+    /**
+     * Retrieve user sentiment distribution.
+     *
+     * This endpoint returns data on the distribution of user sentiments (positive,
+     * negative, neutral) within a specified date range, expressed as percentages.
+     *
+     * Args:
+     * request: The HTTP request containing filter query parameters.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: Sentiment distribution percentages and total sentiment count.
+     *
+     * Raises:
+     * NotFound: If the specified organization does not exist.
+     * BadRequest: If the provided parameters are invalid.
+     *
+     * Query Parameters:
+     * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
+     * end_date (str): End date for filtering (YYYY-MM-DD) - required.
+     * @param endDate End date for filtering (YYYY-MM-DD)
+     * @param org
+     * @param startDate Start date for filtering (YYYY-MM-DD)
+     * @param userId
+     * @param groupBy
+     * @returns SentimentSummary
+     * @throws ApiError
+     */
+    static aiAnalyticsOrgsUsersUserSentimentRetrieve(endDate: string, org: string, startDate: string, userId: string, groupBy?: string): CancelablePromise<SentimentSummary>;
+}