@iblai/iblai-api 4.90.2-ai → 4.90.3-ai

package/src/services/AiSearchService.ts

@@ -28,9 +28,14 @@ export class AiSearchService {
      * - Personalized results
      * - Access to tenant-specific mentors
      *
+     * **Required Parameters (Authenticated Users):**
+     * - `platform_key` OR `tenant`: Platform key for RBAC enforcement (required for authenticated requests)
+     * - Use `platform_key` (preferred) or `tenant` (backward compatibility) - both serve the same purpose
+     * - If both are provided, `platform_key` takes precedence
+     *
      * **Available Filters:**
      * - `query`: Search term to filter mentors by name or description
-     * - `tenant`: Filter by tenant/organization platform key(s)
+     * - `tenant`: Filter by tenant/organization platform key(s) - can also be used as alias for `platform_key` (backward compatibility)
      * - `category`: Filter by mentor category (comma-separated)
      * - `subjects`: Filter by mentor subject (comma-separated)
      * - `types`: Filter by mentor type (comma-separated)
@@ -47,30 +52,27 @@ export class AiSearchService {
      * Notes:
      * - Detail view is removed; use the ibl_ai_mentor app for mentor details
      * - include_main_public_mentors=true shows only VIEWABLE_BY_ANYONE mentors from the main tenant across tenants
-     * - For authenticated requests, platform_key is required when username is provided
+     * - For authenticated requests, either `platform_key` or `tenant` is required when username is provided
+     * - `tenant` parameter serves dual purpose: as a filter for multiple tenants, or as an alias for `platform_key` (backward compatibility)
      * - Frontend uses `llm` parameter name (backend maps to `llm_provider` automatically)
      *
      * @returns V2GlobalMentorSearchResponse
      * @throws ApiError
      */
     public static v2GlobalMentorSearch({
-        platformKey,
         category,
         createdBy,
         includeMainPublicMentors = false,
         limit,
         llm,
         offset,
+        platformKey,
         query,
         subjects,
         tenant,
         types,
         visibility,
     }: {
-        /**
-         * Platform key for RBAC enforcement
-         */
-        platformKey: string,
         /**
          * Mentor category filter
          */
@@ -95,6 +97,10 @@ export class AiSearchService {
          * Number of results to skip
          */
         offset?: number,
+        /**
+         * Platform key for RBAC enforcement. Required for authenticated requests. Can also use 'tenant' parameter as an alias (backward compatibility).
+         */
+        platformKey?: string,
         /**
          * Search query for mentors
          */
@@ -104,7 +110,7 @@ export class AiSearchService {
          */
         subjects?: string,
         /**
-         * Tenant key(s) (CSV)
+         * Tenant key(s) (CSV). Can be used as a filter for multiple tenants, or as an alias for 'platform_key' in authenticated requests (backward compatibility).
          */
         tenant?: string,
         /**
@@ -268,7 +274,9 @@ export class AiSearchService {
      *
      * **Authentication Required:**
      * - username: Required for personalized mentor access
-     * - platform_key: Required for tenant-specific content
+     * - platform_key OR tenant: Required for tenant-specific content (both serve the same purpose)
+     * - Use `platform_key` (preferred) or `tenant` (backward compatibility)
+     * - If both are provided, `platform_key` takes precedence
      *
      * **Features:**
      * - User's own mentors only
@@ -281,7 +289,6 @@ export class AiSearchService {
      * @throws ApiError
      */
     public static v2PersonalizedMentors({
-        platformKey,
         audience,
         category,
         limit,
@@ -289,16 +296,14 @@ export class AiSearchService {
         offset,
         orderBy,
         orderDirection,
+        platformKey,
         query,
         returnFacet,
         tags,
+        tenant,
         username,
         visibility,
     }: {
-        /**
-         * Platform key for authentication
-         */
-        platformKey: string,
         /**
          * Filter by audience
          */
@@ -330,6 +335,10 @@ export class AiSearchService {
          * * `desc` - desc
          */
         orderDirection?: 'asc' | 'desc',
+        /**
+         * Platform key for authentication. Required for authenticated requests. Can also use 'tenant' parameter as an alias (backward compatibility).
+         */
+        platformKey?: string,
         /**
          * Search query for personalized mentors
          */
@@ -342,6 +351,10 @@ export class AiSearchService {
          * Filter by tags
          */
         tags?: Array<string>,
+        /**
+         * Tenant key (alias for 'platform_key' for backward compatibility). Can be used instead of 'platform_key' - both serve the same purpose.
+         */
+        tenant?: string,
         /**
          * Username for authentication (required for unauthenticated requests)
          */
@@ -366,6 +379,7 @@ export class AiSearchService {
                 'query': query,
                 'return_facet': returnFacet,
                 'tags': tags,
+                'tenant': tenant,
                 'username': username,
                 'visibility': visibility,
             },