@iblai/iblai-api 2025.11.13-teams-bot-renovation-4-ai → 2025.11.14-teams-bot-renovation-2-ai

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/sdk_schema.yml CHANGED
@@ -1,7 +1,7 @@
1
1
  openapi: 3.0.3
2
2
  info:
3
3
  title: ibl-data-manager
4
- version: 4.90.2-ai-plus
4
+ version: 4.90.4-ai-plus
5
5
  description: API for iblai
6
6
  paths:
7
7
  /api/ai-account/connected-services/callback/:
@@ -33268,26 +33268,33 @@ paths:
33268
33268
  \ - Limited search capabilities\n - No personalization\n\n \
33269
33269
  \ **Authenticated Users:**\n - Full access based on platform\
33270
33270
  \ permissions (scoped to requested platform)\n - Personalized results\n\
33271
- \ - Access to tenant-specific mentors\n\n **Available Filters:**\n\
33272
- \ - `query`: Search term to filter mentors by name or description\n\
33273
- \ - `tenant`: Filter by tenant/organization platform key(s)\n \
33274
- \ - `category`: Filter by mentor category (comma-separated)\n - `subjects`:\
33275
- \ Filter by mentor subject (comma-separated)\n - `types`: Filter by\
33276
- \ mentor type (comma-separated)\n - `llm`: Filter by LLM provider (comma-separated,\
33277
- \ e.g., GPT-4, Claude)\n - `visibility`: Filter by visibility level\
33278
- \ (comma-separated: viewable_by_anyone, viewable_by_tenant_students, viewable_by_tenant_admins)\n\
33279
- \ - `created_by`: Filter mentors created by specific user (for personalized\
33280
- \ search)\n - `include_main_public_mentors`: Include main tenant public\
33281
- \ mentors\n\n **Facets:**\n The response includes facets with\
33282
- \ aggregated counts for all filterable attributes:\n - categories,\
33283
- \ subjects, types, llm_providers, visibility\n All facet values can\
33284
- \ be used as filter parameters in subsequent requests.\n\n Notes:\n\
33285
- \ - Detail view is removed; use the ibl_ai_mentor app for mentor details\n\
33286
- \ - include_main_public_mentors=true shows only VIEWABLE_BY_ANYONE\
33287
- \ mentors from the main tenant across tenants\n - For authenticated\
33288
- \ requests, platform_key is required when username is provided\n -\
33289
- \ Frontend uses `llm` parameter name (backend maps to `llm_provider` automatically)\n\
33290
- \ "
33271
+ \ - Access to tenant-specific mentors\n\n **Required Parameters\
33272
+ \ (Authenticated Users):**\n - `platform_key` OR `tenant`: Platform\
33273
+ \ key for RBAC enforcement (required for authenticated requests)\n \
33274
+ \ - Use `platform_key` (preferred) or `tenant` (backward compatibility)\
33275
+ \ - both serve the same purpose\n - If both are provided, `platform_key`\
33276
+ \ takes precedence\n\n **Available Filters:**\n - `query`: Search\
33277
+ \ term to filter mentors by name or description\n - `tenant`: Filter\
33278
+ \ by tenant/organization platform key(s) - can also be used as alias for `platform_key`\
33279
+ \ (backward compatibility)\n - `category`: Filter by mentor category\
33280
+ \ (comma-separated)\n - `subjects`: Filter by mentor subject (comma-separated)\n\
33281
+ \ - `types`: Filter by mentor type (comma-separated)\n - `llm`:\
33282
+ \ Filter by LLM provider (comma-separated, e.g., GPT-4, Claude)\n -\
33283
+ \ `visibility`: Filter by visibility level (comma-separated: viewable_by_anyone,\
33284
+ \ viewable_by_tenant_students, viewable_by_tenant_admins)\n - `created_by`:\
33285
+ \ Filter mentors created by specific user (for personalized search)\n \
33286
+ \ - `include_main_public_mentors`: Include main tenant public mentors\n\
33287
+ \n **Facets:**\n The response includes facets with aggregated\
33288
+ \ counts for all filterable attributes:\n - categories, subjects, types,\
33289
+ \ llm_providers, visibility\n All facet values can be used as filter\
33290
+ \ parameters in subsequent requests.\n\n Notes:\n - Detail view\
33291
+ \ is removed; use the ibl_ai_mentor app for mentor details\n - include_main_public_mentors=true\
33292
+ \ shows only VIEWABLE_BY_ANYONE mentors from the main tenant across tenants\n\
33293
+ \ - For authenticated requests, either `platform_key` or `tenant` is\
33294
+ \ required when username is provided\n - `tenant` parameter serves\
33295
+ \ dual purpose: as a filter for multiple tenants, or as an alias for `platform_key`\
33296
+ \ (backward compatibility)\n - Frontend uses `llm` parameter name (backend\
33297
+ \ maps to `llm_provider` automatically)\n "
33291
33298
  summary: Search and filter AI mentors across the platform
33292
33299
  parameters:
33293
33300
  - in: query
@@ -33333,8 +33340,8 @@ paths:
33333
33340
  schema:
33334
33341
  type: string
33335
33342
  minLength: 1
33336
- description: Platform key for RBAC enforcement
33337
- required: true
33343
+ description: Platform key for RBAC enforcement. Required for authenticated
33344
+ requests. Can also use 'tenant' parameter as an alias (backward compatibility).
33338
33345
  - in: query
33339
33346
  name: query
33340
33347
  schema:
@@ -33352,7 +33359,8 @@ paths:
33352
33359
  schema:
33353
33360
  type: string
33354
33361
  minLength: 1
33355
- description: Tenant key(s) (CSV)
33362
+ description: Tenant key(s) (CSV). Can be used as a filter for multiple tenants,
33363
+ or as an alias for 'platform_key' in authenticated requests (backward compatibility).
33356
33364
  - in: query
33357
33365
  name: types
33358
33366
  schema:
@@ -33549,11 +33557,13 @@ paths:
33549
33557
  \ organization/platform.\n This endpoint provides a personalized view\
33550
33558
  \ of the user's own mentors with\n support for filtering, pagination,\
33551
33559
  \ and detailed mentor information.\n\n **Authentication Required:**\n\
33552
- \ - username: Required for personalized mentor access\n - platform_key:\
33553
- \ Required for tenant-specific content\n\n **Features:**\n -\
33554
- \ User's own mentors only\n - Personalization data (access counts,\
33555
- \ last used)\n - Filtering and faceted search\n - Pagination\
33556
- \ support\n - Detail and list views\n "
33560
+ \ - username: Required for personalized mentor access\n - platform_key\
33561
+ \ OR tenant: Required for tenant-specific content (both serve the same purpose)\n\
33562
+ \ - Use `platform_key` (preferred) or `tenant` (backward compatibility)\n\
33563
+ \ - If both are provided, `platform_key` takes precedence\n\n \
33564
+ \ **Features:**\n - User's own mentors only\n - Personalization\
33565
+ \ data (access counts, last used)\n - Filtering and faceted search\n\
33566
+ \ - Pagination support\n - Detail and list views\n "
33557
33567
  summary: Get mentors created by a specific user
33558
33568
  parameters:
33559
33569
  - in: query
@@ -33610,8 +33620,8 @@ paths:
33610
33620
  schema:
33611
33621
  type: string
33612
33622
  minLength: 1
33613
- description: Platform key for authentication
33614
- required: true
33623
+ description: Platform key for authentication. Required for authenticated requests.
33624
+ Can also use 'tenant' parameter as an alias (backward compatibility).
33615
33625
  - in: query
33616
33626
  name: query
33617
33627
  schema:
@@ -33630,6 +33640,13 @@ paths:
33630
33640
  items:
33631
33641
  type: string
33632
33642
  description: Filter by tags
33643
+ - in: query
33644
+ name: tenant
33645
+ schema:
33646
+ type: string
33647
+ minLength: 1
33648
+ description: Tenant key (alias for 'platform_key' for backward compatibility).
33649
+ Can be used instead of 'platform_key' - both serve the same purpose.
33633
33650
  - in: query
33634
33651
  name: username
33635
33652
  schema:
@@ -72072,6 +72089,11 @@ components:
72072
72089
  type: string
72073
72090
  nullable: true
72074
72091
  description: Course short description from edx_data
72092
+ edx_data:
72093
+ type: object
72094
+ additionalProperties: {}
72095
+ nullable: true
72096
+ description: Full edx_data from CourseInfo model (includes all edX metadata)
72075
72097
  required:
72076
72098
  - course_id
72077
72099
  - course_title
@@ -75612,6 +75634,15 @@ components:
75612
75634
  description: Disclaimer to be shown to the user when the mentor is used.
75613
75635
  enable_disclaimer:
75614
75636
  type: boolean
75637
+ show_attachment:
75638
+ type: boolean
75639
+ description: Show attachments on mentor.
75640
+ show_voice_call:
75641
+ type: boolean
75642
+ description: Show voice call button on mentor.
75643
+ show_voice_record:
75644
+ type: boolean
75645
+ description: Show voice recording button on mentor.
75615
75646
  embed_is_context_aware:
75616
75647
  type: boolean
75617
75648
  description: Allow embedded mentor to read content on the embedded web page.
@@ -75927,6 +75958,15 @@ components:
75927
75958
  description: Disclaimer to be shown to the user when the mentor is used.
75928
75959
  enable_disclaimer:
75929
75960
  type: boolean
75961
+ show_attachment:
75962
+ type: boolean
75963
+ description: Show attachments on mentor.
75964
+ show_voice_call:
75965
+ type: boolean
75966
+ description: Show voice call button on mentor.
75967
+ show_voice_record:
75968
+ type: boolean
75969
+ description: Show voice recording button on mentor.
75930
75970
  embed_is_context_aware:
75931
75971
  type: boolean
75932
75972
  description: Allow embedded mentor to read content on the embedded web page.
@@ -76324,6 +76364,12 @@ components:
76324
76364
  type: string
76325
76365
  enable_disclaimer:
76326
76366
  type: boolean
76367
+ show_attachment:
76368
+ type: boolean
76369
+ show_voice_call:
76370
+ type: boolean
76371
+ show_voice_record:
76372
+ type: boolean
76327
76373
  embed_is_context_aware:
76328
76374
  type: boolean
76329
76375
  embed_open_by_default:
@@ -76685,6 +76731,15 @@ components:
76685
76731
  enable_disclaimer:
76686
76732
  type: boolean
76687
76733
  readOnly: true
76734
+ show_attachment:
76735
+ type: boolean
76736
+ readOnly: true
76737
+ show_voice_call:
76738
+ type: boolean
76739
+ readOnly: true
76740
+ show_voice_record:
76741
+ type: boolean
76742
+ readOnly: true
76688
76743
  embed_is_context_aware:
76689
76744
  type: boolean
76690
76745
  readOnly: true
@@ -76911,6 +76966,9 @@ components:
76911
76966
  - safety_response
76912
76967
  - safety_system_prompt
76913
76968
  - seo_tags
76969
+ - show_attachment
76970
+ - show_voice_call
76971
+ - show_voice_record
76914
76972
  - subjects
76915
76973
  - suggested_prompts
76916
76974
  - system_prompt
@@ -77012,6 +77070,15 @@ components:
77012
77070
  enable_disclaimer:
77013
77071
  type: boolean
77014
77072
  readOnly: true
77073
+ show_attachment:
77074
+ type: boolean
77075
+ readOnly: true
77076
+ show_voice_call:
77077
+ type: boolean
77078
+ readOnly: true
77079
+ show_voice_record:
77080
+ type: boolean
77081
+ readOnly: true
77015
77082
  embed_is_context_aware:
77016
77083
  type: boolean
77017
77084
  readOnly: true
@@ -77155,6 +77222,9 @@ components:
77155
77222
  - proactive_prompt
77156
77223
  - proactive_response
77157
77224
  - recently_accessed_at
77225
+ - show_attachment
77226
+ - show_voice_call
77227
+ - show_voice_record
77158
77228
  - subjects
77159
77229
  - suggested_prompts
77160
77230
  - types
@@ -77272,6 +77342,12 @@ components:
77272
77342
  items:
77273
77343
  type: integer
77274
77344
  nullable: true
77345
+ show_attachment:
77346
+ type: boolean
77347
+ show_voice_call:
77348
+ type: boolean
77349
+ show_voice_record:
77350
+ type: boolean
77275
77351
  embed_is_context_aware:
77276
77352
  type: boolean
77277
77353
  embed_open_by_default:
@@ -80723,6 +80799,15 @@ components:
80723
80799
  description: Disclaimer to be shown to the user when the mentor is used.
80724
80800
  enable_disclaimer:
80725
80801
  type: boolean
80802
+ show_attachment:
80803
+ type: boolean
80804
+ description: Show attachments on mentor.
80805
+ show_voice_call:
80806
+ type: boolean
80807
+ description: Show voice call button on mentor.
80808
+ show_voice_record:
80809
+ type: boolean
80810
+ description: Show voice recording button on mentor.
80726
80811
  embed_is_context_aware:
80727
80812
  type: boolean
80728
80813
  description: Allow embedded mentor to read content on the embedded web page.
@@ -21,7 +21,7 @@ export type OpenAPIConfig = {
21
21
 
22
22
  export const OpenAPI: OpenAPIConfig = {
23
23
  BASE: 'https://base.manager.iblai.app',
24
- VERSION: '4.90.2-ai-plus',
24
+ VERSION: '4.90.4-ai-plus',
25
25
  WITH_CREDENTIALS: false,
26
26
  CREDENTIALS: 'include',
27
27
  TOKEN: undefined,
@@ -46,5 +46,9 @@ export type CourseRecommendation = {
46
46
  * Course short description from edx_data
47
47
  */
48
48
  short_description?: string | null;
49
+ /**
50
+ * Full edx_data from CourseInfo model (includes all edX metadata)
51
+ */
52
+ edx_data?: Record<string, any> | null;
49
53
  };
50
54
 
@@ -61,6 +61,18 @@ export type Mentor = {
61
61
  */
62
62
  disclaimer?: string;
63
63
  enable_disclaimer?: boolean;
64
+ /**
65
+ * Show attachments on mentor.
66
+ */
67
+ show_attachment?: boolean;
68
+ /**
69
+ * Show voice call button on mentor.
70
+ */
71
+ show_voice_call?: boolean;
72
+ /**
73
+ * Show voice recording button on mentor.
74
+ */
75
+ show_voice_record?: boolean;
64
76
  /**
65
77
  * Allow embedded mentor to read content on the embedded web page.
66
78
  */
@@ -51,6 +51,18 @@ export type MentorCreate = {
51
51
  */
52
52
  disclaimer?: string;
53
53
  enable_disclaimer?: boolean;
54
+ /**
55
+ * Show attachments on mentor.
56
+ */
57
+ show_attachment?: boolean;
58
+ /**
59
+ * Show voice call button on mentor.
60
+ */
61
+ show_voice_call?: boolean;
62
+ /**
63
+ * Show voice recording button on mentor.
64
+ */
65
+ show_voice_record?: boolean;
54
66
  /**
55
67
  * Allow embedded mentor to read content on the embedded web page.
56
68
  */
@@ -39,6 +39,9 @@ export type MentorFromTemplateWithSettingRequest = {
39
39
  proactive_prompt?: string;
40
40
  disclaimer?: string;
41
41
  enable_disclaimer?: boolean;
42
+ show_attachment?: boolean;
43
+ show_voice_call?: boolean;
44
+ show_voice_record?: boolean;
42
45
  embed_is_context_aware?: boolean;
43
46
  embed_open_by_default?: boolean;
44
47
  embed_show_attachment?: boolean;
@@ -44,6 +44,9 @@ export type MentorSettings = {
44
44
  readonly proactive_prompt: string;
45
45
  readonly disclaimer: string;
46
46
  readonly enable_disclaimer: boolean;
47
+ readonly show_attachment: boolean;
48
+ readonly show_voice_call: boolean;
49
+ readonly show_voice_record: boolean;
47
50
  readonly embed_is_context_aware: boolean;
48
51
  readonly embed_open_by_default: boolean;
49
52
  readonly embed_show_attachment: boolean;
@@ -42,6 +42,9 @@ export type MentorSettingsPublic = {
42
42
  readonly proactive_prompt: string;
43
43
  readonly disclaimer: string;
44
44
  readonly enable_disclaimer: boolean;
45
+ readonly show_attachment: boolean;
46
+ readonly show_voice_call: boolean;
47
+ readonly show_voice_record: boolean;
45
48
  readonly embed_is_context_aware: boolean;
46
49
  readonly embed_open_by_default: boolean;
47
50
  readonly embed_show_attachment: boolean;
@@ -53,6 +53,9 @@ export type MentorSettingsRequest = {
53
53
  enable_suggested_prompts?: boolean | null;
54
54
  enable_guided_prompts?: boolean | null;
55
55
  mcp_servers?: Array<number> | null;
56
+ show_attachment?: boolean;
57
+ show_voice_call?: boolean;
58
+ show_voice_record?: boolean;
56
59
  embed_is_context_aware?: boolean;
57
60
  embed_open_by_default?: boolean;
58
61
  embed_show_attachment?: boolean;
@@ -51,6 +51,18 @@ export type PatchedMentorCreate = {
51
51
  */
52
52
  disclaimer?: string;
53
53
  enable_disclaimer?: boolean;
54
+ /**
55
+ * Show attachments on mentor.
56
+ */
57
+ show_attachment?: boolean;
58
+ /**
59
+ * Show voice call button on mentor.
60
+ */
61
+ show_voice_call?: boolean;
62
+ /**
63
+ * Show voice recording button on mentor.
64
+ */
65
+ show_voice_record?: boolean;
54
66
  /**
55
67
  * Allow embedded mentor to read content on the embedded web page.
56
68
  */
@@ -28,9 +28,14 @@ export class AiSearchService {
28
28
  * - Personalized results
29
29
  * - Access to tenant-specific mentors
30
30
  *
31
+ * **Required Parameters (Authenticated Users):**
32
+ * - `platform_key` OR `tenant`: Platform key for RBAC enforcement (required for authenticated requests)
33
+ * - Use `platform_key` (preferred) or `tenant` (backward compatibility) - both serve the same purpose
34
+ * - If both are provided, `platform_key` takes precedence
35
+ *
31
36
  * **Available Filters:**
32
37
  * - `query`: Search term to filter mentors by name or description
33
- * - `tenant`: Filter by tenant/organization platform key(s)
38
+ * - `tenant`: Filter by tenant/organization platform key(s) - can also be used as alias for `platform_key` (backward compatibility)
34
39
  * - `category`: Filter by mentor category (comma-separated)
35
40
  * - `subjects`: Filter by mentor subject (comma-separated)
36
41
  * - `types`: Filter by mentor type (comma-separated)
@@ -47,30 +52,27 @@ export class AiSearchService {
47
52
  * Notes:
48
53
  * - Detail view is removed; use the ibl_ai_mentor app for mentor details
49
54
  * - include_main_public_mentors=true shows only VIEWABLE_BY_ANYONE mentors from the main tenant across tenants
50
- * - For authenticated requests, platform_key is required when username is provided
55
+ * - For authenticated requests, either `platform_key` or `tenant` is required when username is provided
56
+ * - `tenant` parameter serves dual purpose: as a filter for multiple tenants, or as an alias for `platform_key` (backward compatibility)
51
57
  * - Frontend uses `llm` parameter name (backend maps to `llm_provider` automatically)
52
58
  *
53
59
  * @returns V2GlobalMentorSearchResponse
54
60
  * @throws ApiError
55
61
  */
56
62
  public static v2GlobalMentorSearch({
57
- platformKey,
58
63
  category,
59
64
  createdBy,
60
65
  includeMainPublicMentors = false,
61
66
  limit,
62
67
  llm,
63
68
  offset,
69
+ platformKey,
64
70
  query,
65
71
  subjects,
66
72
  tenant,
67
73
  types,
68
74
  visibility,
69
75
  }: {
70
- /**
71
- * Platform key for RBAC enforcement
72
- */
73
- platformKey: string,
74
76
  /**
75
77
  * Mentor category filter
76
78
  */
@@ -95,6 +97,10 @@ export class AiSearchService {
95
97
  * Number of results to skip
96
98
  */
97
99
  offset?: number,
100
+ /**
101
+ * Platform key for RBAC enforcement. Required for authenticated requests. Can also use 'tenant' parameter as an alias (backward compatibility).
102
+ */
103
+ platformKey?: string,
98
104
  /**
99
105
  * Search query for mentors
100
106
  */
@@ -104,7 +110,7 @@ export class AiSearchService {
104
110
  */
105
111
  subjects?: string,
106
112
  /**
107
- * Tenant key(s) (CSV)
113
+ * 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).
108
114
  */
109
115
  tenant?: string,
110
116
  /**
@@ -268,7 +274,9 @@ export class AiSearchService {
268
274
  *
269
275
  * **Authentication Required:**
270
276
  * - username: Required for personalized mentor access
271
- * - platform_key: Required for tenant-specific content
277
+ * - platform_key OR tenant: Required for tenant-specific content (both serve the same purpose)
278
+ * - Use `platform_key` (preferred) or `tenant` (backward compatibility)
279
+ * - If both are provided, `platform_key` takes precedence
272
280
  *
273
281
  * **Features:**
274
282
  * - User's own mentors only
@@ -281,7 +289,6 @@ export class AiSearchService {
281
289
  * @throws ApiError
282
290
  */
283
291
  public static v2PersonalizedMentors({
284
- platformKey,
285
292
  audience,
286
293
  category,
287
294
  limit,
@@ -289,16 +296,14 @@ export class AiSearchService {
289
296
  offset,
290
297
  orderBy,
291
298
  orderDirection,
299
+ platformKey,
292
300
  query,
293
301
  returnFacet,
294
302
  tags,
303
+ tenant,
295
304
  username,
296
305
  visibility,
297
306
  }: {
298
- /**
299
- * Platform key for authentication
300
- */
301
- platformKey: string,
302
307
  /**
303
308
  * Filter by audience
304
309
  */
@@ -330,6 +335,10 @@ export class AiSearchService {
330
335
  * * `desc` - desc
331
336
  */
332
337
  orderDirection?: 'asc' | 'desc',
338
+ /**
339
+ * Platform key for authentication. Required for authenticated requests. Can also use 'tenant' parameter as an alias (backward compatibility).
340
+ */
341
+ platformKey?: string,
333
342
  /**
334
343
  * Search query for personalized mentors
335
344
  */
@@ -342,6 +351,10 @@ export class AiSearchService {
342
351
  * Filter by tags
343
352
  */
344
353
  tags?: Array<string>,
354
+ /**
355
+ * Tenant key (alias for 'platform_key' for backward compatibility). Can be used instead of 'platform_key' - both serve the same purpose.
356
+ */
357
+ tenant?: string,
345
358
  /**
346
359
  * Username for authentication (required for unauthenticated requests)
347
360
  */
@@ -366,6 +379,7 @@ export class AiSearchService {
366
379
  'query': query,
367
380
  'return_facet': returnFacet,
368
381
  'tags': tags,
382
+ 'tenant': tenant,
369
383
  'username': username,
370
384
  'visibility': visibility,
371
385
  },