@iblai/iblai-api 2025.11.14-teams-bot-renovation-2-ai → 2025.11.14-teams-bot-renovation-3-core

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

@@ -1,82 +1,7 @@
-import type { DocumentSearchResponse } from '../models/DocumentSearchResponse';
 import type { GlobalCatalogSearchResponse } from '../models/GlobalCatalogSearchResponse';
-import type { MentorSearchResponse } from '../models/MentorSearchResponse';
-import type { PromptSearchResponse } from '../models/PromptSearchResponse';
-import type { RecommendedCoursesResponse } from '../models/RecommendedCoursesResponse';
 import type { UserSearchResponse } from '../models/UserSearchResponse';
 import type { CancelablePromise } from '../core/CancelablePromise';
 export declare class SearchService {
-    /**
-     * Legacy endpoint for backward compatible mentor search
-     * @returns MentorSearchResponse
-     * @throws ApiError
-     */
-    static searchAiSearchRetrieve({ audience, category, createdBy, filterFacet, id, limit, llm, offset, orderBy, orderDirection, page, pageSize, query, tags, tenant, uniqueId, }: {
-        /**
-         * Filter by target audience
-         */
-        audience?: Array<string>;
-        /**
-         * Filter by mentor category
-         */
-        category?: Array<string>;
-        /**
-         * Filter mentors created by specific user
-         */
-        createdBy?: string;
-        /**
-         * If present, return only facets without results
-         */
-        filterFacet?: boolean;
-        /**
-         * Retrieve a specific mentor by ID
-         */
-        id?: number;
-        /**
-         * Number of results per page
-         */
-        limit?: number;
-        /**
-         * Filter by language model type
-         */
-        llm?: Array<string>;
-        /**
-         * Starting position for pagination
-         */
-        offset?: number;
-        /**
-         * Field to sort results by ('created_at', 'recently_accessed_at')
-         */
-        orderBy?: string;
-        /**
-         * Sort direction ('asc' or 'desc')
-         */
-        orderDirection?: string;
-        /**
-         * Page number (1-based, used with page_size)
-         */
-        page?: number;
-        /**
-         * Number of results per page
-         */
-        pageSize?: number;
-        /**
-         * Search term to filter mentors by name or description
-         */
-        query?: string;
-        /**
-         * Filter by tags
-         */
-        tags?: Array<string>;
-        /**
-         * Filter by tenant/organization
-         */
-        tenant?: string;
-        /**
-         * Retrieve a specific mentor by UUID
-         */
-        uniqueId?: string;
-    }): CancelablePromise<MentorSearchResponse>;
     /**
      * Search and filter content across the learning catalog.
      *
@@ -363,498 +288,6 @@ export declare class SearchService {
          */
         updateFacet?: string;
     }): CancelablePromise<GlobalCatalogSearchResponse>;
-    /**
-     * Search and filter AI mentors across the platform.
-     *
-     * This endpoint provides a powerful search interface for discovering AI mentors
-     * with support for filtering, pagination, and detailed mentor information.
-     *
-     * Query Parameters:
-     * # Identification parameters (for detail view)
-     * id (int, optional): Retrieve a specific mentor by ID
-     * unique_id (uuid, optional): Retrieve a specific mentor by UUID
-     *
-     * # Search and filtering parameters
-     * query (str, optional): Search term to filter mentors by name or description
-     * tenant (str, optional): Filter by tenant/organization
-     * llm (list, optional): Filter by language model type
-     * audience (list, optional): Filter by target audience
-     * category (list, optional): Filter by mentor category
-     * tags (list, optional): Filter by tags
-     * created_by (str, optional): Filter mentors created by specific user
-     *
-     * # Sorting and pagination
-     * order_by (str, optional): Field to sort results by ('created_at', 'recently_accessed_at')
-     * order_direction (str, optional): Sort direction ('asc' or 'desc', default: 'desc')
-     * limit (int, optional): Number of results per page (default: 12, max: 100)
-     * offset (int, optional): Starting position for pagination
-     *
-     * Returns:
-     * For detail view (when id or unique_id is provided):
-     * A JSON response containing a single mentor's details:
-     * {
-         * "id": 123,
-         * "unique_id": "550e8400-e29b-41d4-a716-446655440000",
-         * "name": "Professor Smith",
-         * "description": "AI mentor specializing in computer science",
-         * "image_url": "https://example.com/images/prof-smith.jpg",
-         * "llm": {
-             * "id": 1,
-             * "name": "GPT-4",
-             * "description": "Advanced language model"
-             * },
-             * "audience": {
-                 * "id": 2,
-                 * "name": "College Students",
-                 * "description": "For university-level learners"
-                 * },
-                 * "category": "Computer Science",
-                 * "tags": ["programming", "algorithms", "data structures"],
-                 * "created_at": "2023-01-15T12:00:00Z",
-                 * "recently_accessed_at": "2023-06-20T15:30:00Z",
-                 * "platform": {
-                     * "id": 1,
-                     * "name": "Example University",
-                     * "key": "example-university"
-                     * },
-                     * "visibility": "public",
-                     * "settings": {
-                         * "temperature": 0.7,
-                         * "max_tokens": 1024,
-                         * "system_prompt": "You are Professor Smith, an expert in computer science..."
-                         * }
-                         * }
-                         *
-                         * For list view:
-                         * A JSON response containing:
-                         * {
-                             * "results": [
-                                 * {
-                                     * "id": 123,
-                                     * "unique_id": "550e8400-e29b-41d4-a716-446655440000",
-                                     * "name": "Professor Smith",
-                                     * "description": "AI mentor specializing in computer science",
-                                     * "image_url": "https://example.com/images/prof-smith.jpg",
-                                     * "llm": {"id": 1, "name": "GPT-4"},
-                                     * "audience": {"id": 2, "name": "College Students"},
-                                     * "category": "Computer Science",
-                                     * "tags": ["programming", "algorithms"],
-                                     * "created_at": "2023-01-15T12:00:00Z",
-                                     * "recently_accessed_at": "2023-06-20T15:30:00Z"
-                                     * },
-                                     * // Additional mentor objects...
-                                     * ],
-                                     * "count": 50,
-                                     * "next": "https://api.example.com/api/search/mentors/?limit=12&offset=12",
-                                     * "previous": null,
-                                     * "current_page": 1,
-                                     * "num_pages": 5,
-                                     * "facets": {
-                                         * "llm": [
-                                             * {"key": "GPT-4", "doc_count": 30},
-                                             * {"key": "Claude", "doc_count": 20}
-                                             * ],
-                                             * "audience": [
-                                                 * {"key": "College Students", "doc_count": 35},
-                                                 * {"key": "Professionals", "doc_count": 15}
-                                                 * ],
-                                                 * "category": [
-                                                     * {"key": "Computer Science", "doc_count": 25},
-                                                     * {"key": "Mathematics", "doc_count": 15},
-                                                     * {"key": "Business", "doc_count": 10}
-                                                     * ]
-                                                     * }
-                                                     * }
-                                                     *
-                                                     * Error Responses:
-                                                     * 400 Bad Request: If the request parameters are invalid
-                                                     * 404 Not Found: If the requested mentor doesn't exist
-                                                     * 500 Internal Server Error: If an unexpected error occurs
-                                                     *
-                                                     * Notes:
-                                                     * - Results are cached for performance
-                                                     * - Public mentors are visible to all users
-                                                     * - Private mentors are only visible to authorized users
-                                                     * @returns MentorSearchResponse
-                                                     * @throws ApiError
-                                                     */
-    static searchMentorsRetrieve({ audience, category, createdBy, featured, id, includeMainPublicMentors, limit, llm, offset, orderBy, orderDirection, query, tags, tenant, uniqueId, }: {
-        /**
-         * Filter by target audience
-         */
-        audience?: Array<string>;
-        /**
-         * Filter by mentor category
-         */
-        category?: Array<string>;
-        /**
-         * Filter mentors created by specific user
-         */
-        createdBy?: string;
-        /**
-         * Filter by featured status
-         */
-        featured?: boolean;
-        /**
-         * Retrieve a specific mentor by ID
-         */
-        id?: number;
-        /**
-         * Include public mentors from main tenant
-         */
-        includeMainPublicMentors?: boolean;
-        /**
-         * Number of results per page
-         */
-        limit?: number;
-        /**
-         * Filter by language model type
-         */
-        llm?: Array<string>;
-        /**
-         * Starting position for pagination
-         */
-        offset?: number;
-        /**
-         * Field to sort results by ('created_at', 'recently_accessed_at')
-         */
-        orderBy?: string;
-        /**
-         * Sort direction ('asc' or 'desc')
-         */
-        orderDirection?: string;
-        /**
-         * Search term to filter mentors by name or description
-         */
-        query?: string;
-        /**
-         * Filter by tags
-         */
-        tags?: Array<string>;
-        /**
-         * Filter by tenant/organization
-         */
-        tenant?: string;
-        /**
-         * Retrieve a specific mentor by UUID
-         */
-        uniqueId?: string;
-    }): CancelablePromise<MentorSearchResponse>;
-    /**
-     * Search and filter documents associated with a specific mentor
-     * @returns DocumentSearchResponse
-     * @throws ApiError
-     */
-    static searchMentorsDocumentsRetrieve({ mentorUniqueId, access, documentType, limit, offset, orderBy, orderDirection, platformKey, query, trainingStatus, }: {
-        mentorUniqueId: string;
-        /**
-         * Filter by access level (e.g., 'public', 'private')
-         */
-        access?: string;
-        /**
-         * Filter by document type (e.g., 'pdf', 'text')
-         */
-        documentType?: string;
-        /**
-         * Number of results per page
-         */
-        limit?: number;
-        /**
-         * Starting position for pagination
-         */
-        offset?: number;
-        /**
-         * Field to sort results by ('date_created', 'last_modified', 'document_name')
-         */
-        orderBy?: string;
-        /**
-         * Sort direction ('asc' or 'desc')
-         */
-        orderDirection?: string;
-        /**
-         * Filter by platform key
-         */
-        platformKey?: string;
-        /**
-         * Search term to filter documents by name or content
-         */
-        query?: string;
-        /**
-         * Filter by training status (e.g., 'trained', 'pending')
-         */
-        trainingStatus?: string;
-    }): CancelablePromise<DocumentSearchResponse>;
-    /**
-     * Handle GET requests for tenant-specific mentor search.
-     *
-     * Args:
-     * request: HTTP request object
-     * org: Tenant/organization key
-     * username: Username of the user making the request
-     *
-     * Returns:
-     * Response: DRF Response object with search results
-     * @returns MentorSearchResponse
-     * @throws ApiError
-     */
-    static searchOrgsUsersMentorsRetrieve({ org, username, audience, category, createdBy, featured, id, includeMainPublicMentors, limit, llm, offset, orderBy, orderDirection, query, tags, tenant, uniqueId, }: {
-        org: string;
-        username: string;
-        /**
-         * Filter by target audience
-         */
-        audience?: Array<string>;
-        /**
-         * Filter by mentor category
-         */
-        category?: Array<string>;
-        /**
-         * Filter mentors created by specific user
-         */
-        createdBy?: string;
-        /**
-         * Filter by featured status
-         */
-        featured?: boolean;
-        /**
-         * Retrieve a specific mentor by ID
-         */
-        id?: number;
-        /**
-         * Include public mentors from main tenant
-         */
-        includeMainPublicMentors?: boolean;
-        /**
-         * Number of results per page
-         */
-        limit?: number;
-        /**
-         * Filter by language model type
-         */
-        llm?: Array<string>;
-        /**
-         * Starting position for pagination
-         */
-        offset?: number;
-        /**
-         * Field to sort results by ('created_at', 'recently_accessed_at')
-         */
-        orderBy?: string;
-        /**
-         * Sort direction ('asc' or 'desc')
-         */
-        orderDirection?: string;
-        /**
-         * Search term to filter mentors by name or description
-         */
-        query?: string;
-        /**
-         * Filter by tags
-         */
-        tags?: Array<string>;
-        /**
-         * Filter by tenant/organization
-         */
-        tenant?: string;
-        /**
-         * Retrieve a specific mentor by UUID
-         */
-        uniqueId?: string;
-    }): CancelablePromise<MentorSearchResponse>;
-    /**
-     * Search and filter AI prompts for a specific user within a tenant.
-     *
-     * This endpoint extends the base prompt search functionality but filters results
-     * to only show prompts that are available to a specific user within a specific
-     * organization/tenant.
-     *
-     * Path Parameters:
-     * org (str): The organization/tenant identifier
-     * username (str): The username to filter prompts for
-     *
-     * Query Parameters:
-     * Same as PromptSearchView, plus:
-     *
-     * # Identification parameters (for detail view)
-     * id (int, optional): Retrieve a specific prompt by ID
-     *
-     * Returns:
-     * Same format as PromptSearchView, but filtered to only include prompts
-     * that the specified user has access to within the specified organization.
-     *
-     * Error Responses:
-     * 400 Bad Request: If the request parameters are invalid
-     * 403 Forbidden: If the requested prompt exists but the user doesn't have access
-     * 404 Not Found: If the requested prompt doesn't exist
-     * 500 Internal Server Error: If an unexpected error occurs
-     *
-     * Access Control:
-     * - Results are filtered based on user's permissions within the organization
-     * - Private prompts are only visible to authorized users
-     * @returns PromptSearchResponse
-     * @throws ApiError
-     */
-    static searchOrgsUsersPromptsRetrieve({ org, username, alphabetical, category, createdBy, filterFacet, language, limit, mentor, offset, orderDirection, query, sortBy, style, tenant, tone, }: {
-        org: string;
-        username: string;
-        /**
-         * Sort alphabetically
-         */
-        alphabetical?: boolean;
-        /**
-         * Filter by prompt category
-         */
-        category?: string;
-        /**
-         * Filter prompts created by specific user
-         */
-        createdBy?: string;
-        /**
-         * If true, return only facets without results
-         */
-        filterFacet?: boolean;
-        /**
-         * Filter by prompt language
-         */
-        language?: string;
-        /**
-         * Number of results per page
-         */
-        limit?: number;
-        /**
-         * Filter by mentor UUID
-         */
-        mentor?: string;
-        /**
-         * Starting position for pagination
-         */
-        offset?: number;
-        /**
-         * Sort direction ('asc' or 'desc')
-         */
-        orderDirection?: string;
-        /**
-         * Search term to filter prompts by name or content
-         */
-        query?: string;
-        /**
-         * Field to sort results by
-         */
-        sortBy?: string;
-        /**
-         * Filter by prompt style
-         */
-        style?: string;
-        /**
-         * Filter by tenant/organization
-         */
-        tenant?: string;
-        /**
-         * Filter by prompt tone
-         */
-        tone?: string;
-    }): CancelablePromise<PromptSearchResponse>;
-    /**
-     * Determine whether to serve a detail view or a list view.
-     * @returns RecommendedCoursesResponse
-     * @throws ApiError
-     */
-    static searchOrgsUsersRecommendedRetrieve({ org, username, certificate, content, courseId, duration, language, level, limit, offset, pathwayId, price, programId, programType, query, resourceId, resourceType, roleId, selfPaced, skillId, skills, subject, tags, tenant, topics, }: {
-        org: string;
-        username: string;
-        /**
-         * Filter by certificate type
-         */
-        certificate?: Array<string>;
-        /**
-         * Content types to include in recommendations (courses, programs, pathways, skills, roles, resources)
-         */
-        content?: Array<string>;
-        /**
-         * Retrieve a specific course by ID
-         */
-        courseId?: string;
-        /**
-         * Filter by course duration range
-         */
-        duration?: Array<string>;
-        /**
-         * Filter by content language
-         */
-        language?: Array<string>;
-        /**
-         * Filter by difficulty level
-         */
-        level?: Array<string>;
-        /**
-         * Number of results per page
-         */
-        limit?: number;
-        /**
-         * Starting position for pagination
-         */
-        offset?: number;
-        /**
-         * Retrieve a specific pathway by ID
-         */
-        pathwayId?: string;
-        /**
-         * Filter by price/audit status
-         */
-        price?: string;
-        /**
-         * Retrieve a specific program by ID
-         */
-        programId?: string;
-        /**
-         * Filter by program type
-         */
-        programType?: Array<string>;
-        /**
-         * Search term to filter content by name or description
-         */
-        query?: string;
-        /**
-         * Retrieve a specific resource by ID
-         */
-        resourceId?: string;
-        /**
-         * Filter by resource type
-         */
-        resourceType?: Array<string>;
-        /**
-         * Retrieve a specific role by ID
-         */
-        roleId?: string;
-        /**
-         * Filter by course format (self-paced, instructor-led)
-         */
-        selfPaced?: Array<string>;
-        /**
-         * Retrieve a specific skill by ID
-         */
-        skillId?: string;
-        /**
-         * Filter by skills
-         */
-        skills?: Array<string>;
-        /**
-         * Filter by subject areas
-         */
-        subject?: Array<string>;
-        /**
-         * Filter by tags
-         */
-        tags?: Array<string>;
-        /**
-         * Filter by tenant/organization
-         */
-        tenant?: string;
-        /**
-         * Filter by topic areas
-         */
-        topics?: Array<string>;
-    }): CancelablePromise<RecommendedCoursesResponse>;
     /**
      * Determine whether to serve a detail view or a list view.
      * If any detail-identifying parameters are present (course_id, program_id, etc.)
@@ -993,177 +426,6 @@ export declare class SearchService {
          */
         updateFacet?: string;
     }): CancelablePromise<Record<string, any>>;
-    /**
-     * Search and filter AI prompts across the platform.
-     *
-     * This endpoint provides a search interface for discovering AI prompts
-     * with support for filtering, pagination, and detailed prompt information.
-     *
-     * Query Parameters:
-     * # Identification parameters (for detail view)
-     * id (int, optional): Retrieve a specific prompt by ID
-     *
-     * # Search and filtering parameters
-     * query (str, optional): Search term to filter prompts by name or content
-     * category (str, optional): Filter by prompt category
-     * language (str, optional): Filter by prompt language
-     * style (str, optional): Filter by writing style
-     * tone (str, optional): Filter by tone
-     * tenant (str, optional): Filter by tenant/organization
-     * mentor (str, optional): Filter by associated mentor (UUID)
-     *
-     * # Sorting and pagination
-     * sort_by (str, optional): Field to sort results by
-     * order_direction (str, optional): Sort direction ('asc' or 'desc', default: 'desc')
-     * alphabetical (bool, optional): Sort alphabetically by name (default: false)
-     * limit (int, optional): Number of results per page (default: 10)
-     * offset (int, optional): Starting position for pagination
-     *
-     * # Special parameters
-     * filter_facet (any, optional): If present, return only facets without results
-     *
-     * Returns:
-     * For detail view (when id is provided):
-     * A JSON response containing a single prompt's details:
-     * {
-         * "id": 456,
-         * "name": "Essay Writing Guide",
-         * "content": "Write a well-structured essay on the following topic: {{topic}}...",
-         * "category": "Academic Writing",
-         * "language": "English",
-         * "style": "Formal",
-         * "tone": "Professional",
-         * "mentor": {
-             * "id": 123,
-             * "unique_id": "550e8400-e29b-41d4-a716-446655440000",
-             * "name": "Professor Smith"
-             * },
-             * "platform": {
-                 * "id": 1,
-                 * "name": "Example University",
-                 * "key": "example-university"
-                 * },
-                 * "created_at": "2023-02-10T09:15:00Z",
-                 * "updated_at": "2023-05-05T14:20:00Z",
-                 * "visibility": "public",
-                 * "variables": ["topic", "length", "style"]
-                 * }
-                 *
-                 * For list view:
-                 * A JSON response containing:
-                 * {
-                     * "results": [
-                         * {
-                             * "id": 456,
-                             * "name": "Essay Writing Guide",
-                             * "content": "Write a well-structured essay on the following topic: {{topic}}...",
-                             * "category": "Academic Writing",
-                             * "language": "English",
-                             * "style": "Formal",
-                             * "tone": "Professional",
-                             * "mentor": {"id": 123, "name": "Professor Smith"},
-                             * "created_at": "2023-02-10T09:15:00Z",
-                             * "updated_at": "2023-05-05T14:20:00Z"
-                             * },
-                             * // Additional prompt objects...
-                             * ],
-                             * "count": 30,
-                             * "next": "?limit=10&offset=10",
-                             * "previous": null,
-                             * "current_page": 1,
-                             * "num_pages": 3,
-                             * "facets": {
-                                 * "category": [
-                                     * {"key": "Academic Writing", "doc_count": 15},
-                                     * {"key": "Creative Writing", "doc_count": 10},
-                                     * {"key": "Technical Documentation", "doc_count": 5}
-                                     * ],
-                                     * "language": [
-                                         * {"key": "English", "doc_count": 25},
-                                         * {"key": "Spanish", "doc_count": 5}
-                                         * ],
-                                         * "style": [
-                                             * {"key": "Formal", "doc_count": 20},
-                                             * {"key": "Casual", "doc_count": 10}
-                                             * ],
-                                             * "tone": [
-                                                 * {"key": "Professional", "doc_count": 15},
-                                                 * {"key": "Friendly", "doc_count": 10},
-                                                 * {"key": "Technical", "doc_count": 5}
-                                                 * ]
-                                                 * }
-                                                 * }
-                                                 *
-                                                 * Error Responses:
-                                                 * 400 Bad Request: If the request parameters are invalid
-                                                 * 403 Forbidden: If the requested prompt exists but is not publicly available
-                                                 * 404 Not Found: If the requested prompt doesn't exist
-                                                 * 500 Internal Server Error: If an unexpected error occurs
-                                                 *
-                                                 * Notes:
-                                                 * - Only publicly available prompts are returned by default
-                                                 * - When filtering by mentor, the mentor ID must be a valid UUID
-                                                 * @returns PromptSearchResponse
-                                                 * @throws ApiError
-                                                 */
-    static searchPromptsRetrieve({ alphabetical, category, createdBy, filterFacet, language, limit, mentor, offset, orderDirection, query, sortBy, style, tenant, tone, }: {
-        /**
-         * Sort alphabetically
-         */
-        alphabetical?: boolean;
-        /**
-         * Filter by prompt category
-         */
-        category?: string;
-        /**
-         * Filter prompts created by specific user
-         */
-        createdBy?: string;
-        /**
-         * If true, return only facets without results
-         */
-        filterFacet?: boolean;
-        /**
-         * Filter by prompt language
-         */
-        language?: string;
-        /**
-         * Number of results per page
-         */
-        limit?: number;
-        /**
-         * Filter by mentor UUID
-         */
-        mentor?: string;
-        /**
-         * Starting position for pagination
-         */
-        offset?: number;
-        /**
-         * Sort direction ('asc' or 'desc')
-         */
-        orderDirection?: string;
-        /**
-         * Search term to filter prompts by name or content
-         */
-        query?: string;
-        /**
-         * Field to sort results by
-         */
-        sortBy?: string;
-        /**
-         * Filter by prompt style
-         */
-        style?: string;
-        /**
-         * Filter by tenant/organization
-         */
-        tenant?: string;
-        /**
-         * Filter by prompt tone
-         */
-        tone?: string;
-    }): CancelablePromise<PromptSearchResponse>;
     /**
      * Search and filter users within a specific organization/tenant.
      *