@fluid-topics/public-api 1.0.114 → 1.0.117

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.
@@ -10,7 +10,6 @@ export const isFtHttpErrorDetails = (o) => {
10
10
  && (isString(o.body))
11
11
  && (isNumber(o.status));
12
12
  };
13
- // From: MyLibraryColors
14
13
  export var FtMyLibraryColors;
15
14
  (function (FtMyLibraryColors) {
16
15
  FtMyLibraryColors["black"] = "black";
@@ -22,7 +21,6 @@ export var FtMyLibraryColors;
22
21
  FtMyLibraryColors["yellow"] = "yellow";
23
22
  })(FtMyLibraryColors || (FtMyLibraryColors = {}));
24
23
  export const isFtMyLibraryColors = (o) => Object.keys(FtMyLibraryColors).includes(o);
25
- // From: SourceType
26
24
  export var FtTopicOriginType;
27
25
  (function (FtTopicOriginType) {
28
26
  FtTopicOriginType["OFFICIAL"] = "OFFICIAL";
@@ -30,7 +28,6 @@ export var FtTopicOriginType;
30
28
  FtTopicOriginType["SHARED"] = "SHARED";
31
29
  })(FtTopicOriginType || (FtTopicOriginType = {}));
32
30
  export const isFtTopicOriginType = (o) => Object.keys(FtTopicOriginType).includes(o);
33
- // From: AnalyticsDocumentType
34
31
  export var FtAnalyticsDocumentType;
35
32
  (function (FtAnalyticsDocumentType) {
36
33
  FtAnalyticsDocumentType["STRUCTURED_DOCUMENT"] = "STRUCTURED_DOCUMENT";
@@ -47,10 +44,22 @@ export const isFtAnalyticsEventAIProfile = (o) => {
47
44
  && (o.chatbotDetails == null || isFtAnalyticsEventAIProfileChatbotDetails(o.chatbotDetails))
48
45
  && (o.translationDetails == null || isFtAnalyticsEventAIProfileTranslationDetails(o.translationDetails))
49
46
  && (o.completionDetails == null || isFtAnalyticsEventAIProfileCompletionDetails(o.completionDetails))
47
+ && (o.caseDeflectionDetails == null || isFtAnalyticsEventAIProfileCaseDeflectionDetails(o.caseDeflectionDetails))
50
48
  && (isString(o.name))
49
+ && (o.agenticChatbotDetails == null || isFtAnalyticsEventAIProfileAgenticChatbotDetails(o.agenticChatbotDetails))
51
50
  && (isString(o.id))
52
51
  && (isString(o.type));
53
52
  };
53
+ export const isFtAnalyticsEventAIProfileAgenticChatbotDetails = (o) => {
54
+ return isObject(o)
55
+ && (isString(o.provider))
56
+ && (o.model == null || isString(o.model));
57
+ };
58
+ export const isFtAnalyticsEventAIProfileCaseDeflectionDetails = (o) => {
59
+ return isObject(o)
60
+ && (isString(o.provider))
61
+ && (o.model == null || isString(o.model));
62
+ };
54
63
  export const isFtAnalyticsEventAIProfileChatbotDetails = (o) => {
55
64
  return isObject(o)
56
65
  && (isString(o.provider))
@@ -85,6 +94,11 @@ export const isFtAnalyticsEventDocumentSearchQuery = (o) => {
85
94
  return isObject(o)
86
95
  && (isString(o.terms));
87
96
  };
97
+ export const isFtAnalyticsEventLanguage = (o) => {
98
+ return isObject(o)
99
+ && (isString(o.countryCode))
100
+ && (isString(o.languageCode));
101
+ };
88
102
  export const isFtAnalyticsEventLocation = (o) => {
89
103
  return isObject(o)
90
104
  && (isString(o.type))
@@ -140,7 +154,6 @@ export const isFtAnalyticsEventTopic = (o) => {
140
154
  && (o.mapId == null || isString(o.mapId))
141
155
  && (isString(o.title));
142
156
  };
143
- // From: AnalyticsPublicationType
144
157
  export var FtAnalyticsPublicationType;
145
158
  (function (FtAnalyticsPublicationType) {
146
159
  FtAnalyticsPublicationType["STRUCTURED_DOCUMENT"] = "STRUCTURED_DOCUMENT";
@@ -163,7 +176,6 @@ export const isFtAnalyticsSearchFacet = (o) => {
163
176
  && (o.type == null || isFtAnalyticsSearchFacetType(o.type))
164
177
  && (isString(o.key));
165
178
  };
166
- // From: AnalyticsSearchDateFacetValue
167
179
  export var FtAnalyticsSearchDateFacetValue;
168
180
  (function (FtAnalyticsSearchDateFacetValue) {
169
181
  FtAnalyticsSearchDateFacetValue["LAST_WEEK"] = "LAST_WEEK";
@@ -172,7 +184,6 @@ export var FtAnalyticsSearchDateFacetValue;
172
184
  FtAnalyticsSearchDateFacetValue["LAST_YEAR"] = "LAST_YEAR";
173
185
  })(FtAnalyticsSearchDateFacetValue || (FtAnalyticsSearchDateFacetValue = {}));
174
186
  export const isFtAnalyticsSearchDateFacetValue = (o) => Object.keys(FtAnalyticsSearchDateFacetValue).includes(o);
175
- // From: AnalyticsSearchFacetType
176
187
  export var FtAnalyticsSearchFacetType;
177
188
  (function (FtAnalyticsSearchFacetType) {
178
189
  FtAnalyticsSearchFacetType["VALUE"] = "VALUE";
@@ -210,7 +221,6 @@ export const isFtAnalyticsEvent = (o) => {
210
221
  && (isString(o.appName))
211
222
  && (isFtAnalyticsEventName(o.name));
212
223
  };
213
- // From: WsAnalyticsEventName
214
224
  export var FtAnalyticsEventName;
215
225
  (function (FtAnalyticsEventName) {
216
226
  FtAnalyticsEventName["BOOKMARK__CREATE"] = "BOOKMARK__CREATE";
@@ -223,8 +233,7 @@ export var FtAnalyticsEventName;
223
233
  FtAnalyticsEventName["COLLECTION__UPDATE"] = "COLLECTION__UPDATE";
224
234
  FtAnalyticsEventName["COLLECTION__DELETE"] = "COLLECTION__DELETE";
225
235
  FtAnalyticsEventName["CUSTOM_EVENT__TRIGGER"] = "CUSTOM_EVENT__TRIGGER";
226
- FtAnalyticsEventName["DOCUMENT__AI_TRANSLATE"] = "DOCUMENT__AI_TRANSLATE";
227
- FtAnalyticsEventName["DOCUMENT__DISPLAY"] = "DOCUMENT__DISPLAY";
236
+ FtAnalyticsEventName["DOCUMENT__ON_DEMAND_TRANSLATE"] = "DOCUMENT__ON_DEMAND_TRANSLATE";
228
237
  FtAnalyticsEventName["DOCUMENT__DOWNLOAD"] = "DOCUMENT__DOWNLOAD";
229
238
  FtAnalyticsEventName["DOCUMENT__PRINT"] = "DOCUMENT__PRINT";
230
239
  FtAnalyticsEventName["DOCUMENT__PROCESS"] = "DOCUMENT__PROCESS";
@@ -254,7 +263,6 @@ export var FtAnalyticsEventName;
254
263
  FtAnalyticsEventName["SEARCH_PAGE__SELECT"] = "SEARCH_PAGE__SELECT";
255
264
  FtAnalyticsEventName["SEARCH_RESULT__OPEN_BROWSER_CONTEXT_MENU"] = "SEARCH_RESULT__OPEN_BROWSER_CONTEXT_MENU";
256
265
  FtAnalyticsEventName["TOPIC__AI_TRANSLATE"] = "TOPIC__AI_TRANSLATE";
257
- FtAnalyticsEventName["TOPIC__DISPLAY"] = "TOPIC__DISPLAY";
258
266
  FtAnalyticsEventName["TOPIC__RATE"] = "TOPIC__RATE";
259
267
  FtAnalyticsEventName["TOPIC__START_DISPLAY"] = "TOPIC__START_DISPLAY";
260
268
  FtAnalyticsEventName["TOPIC__UNRATE"] = "TOPIC__UNRATE";
@@ -276,16 +284,22 @@ export const isFtCustomTriggerEvent = (o) => {
276
284
  && (isString(o.eventName))
277
285
  && (isFtAnalyticsEventPage(o.page));
278
286
  };
279
- export const isFtDocumentDisplayEvent = (o) => {
287
+ export const isFtDocumentDownloadEvent = (o) => {
280
288
  return isObject(o)
281
289
  && (isFtAnalyticsEventDocument(o.document))
282
- && (isNumber(o.viewDurationMs))
283
290
  && (isFtAnalyticsEventLocation(o.location));
284
291
  };
285
- export const isFtDocumentDownloadEvent = (o) => {
292
+ export const isFtDocumentOnDemandTranslateEvent = (o) => {
286
293
  return isObject(o)
294
+ && (isBoolean(o.offline))
295
+ && (isString(o.appVersion))
296
+ && (o.internal == null || isBoolean(o.internal))
297
+ && (isString(o.appName))
298
+ && (isString(o.profileId))
287
299
  && (isFtAnalyticsEventDocument(o.document))
288
- && (isFtAnalyticsEventLocation(o.location));
300
+ && (isFtAnalyticsEventName(o.name))
301
+ && (isFtAnalyticsEventLanguage(o.destinationLanguage))
302
+ && (o.sourceLanguage == null || isFtAnalyticsEventLanguage(o.sourceLanguage));
289
303
  };
290
304
  export const isFtDocumentPrintEvent = (o) => {
291
305
  return isObject(o)
@@ -342,14 +356,6 @@ export const isFtSearchResultOpenContextMenuEvent = (o) => {
342
356
  && (o.externalLink == null || isString(o.externalLink))
343
357
  && (isFtAnalyticsEventSearchQuery(o.searchQuery));
344
358
  };
345
- export const isFtTopicDisplayEvent = (o) => {
346
- return isObject(o)
347
- && ((Array.isArray(o.breadcrumb)
348
- && o.breadcrumb.every((v) => isFtAnalyticsEventTopic(v))))
349
- && (isFtAnalyticsEventDocument(o.document))
350
- && (isNumber(o.viewDurationMs))
351
- && (isFtAnalyticsEventLocation(o.location));
352
- };
353
359
  export const isFtTopicStartDisplayEvent = (o) => {
354
360
  return isObject(o)
355
361
  && ((Array.isArray(o.breadcrumb)
@@ -520,6 +526,7 @@ export const isFtUnstructuredDocument = (o) => {
520
526
  && (o.prettyUrl == null || isString(o.prettyUrl))
521
527
  && ((Array.isArray(o.metadata)
522
528
  && o.metadata.every((v) => isFtMetadata(v))))
529
+ && (o.watermark == null || isFtWatermark(o.watermark))
523
530
  && (isString(o.openMode))
524
531
  && (o.description == null || isString(o.description))
525
532
  && (isString(o.mimeType))
@@ -538,7 +545,6 @@ export const isFtUnstructuredDocument = (o) => {
538
545
  && (isString(o.id))
539
546
  && (o.lang == null || isString(o.lang));
540
547
  };
541
- // From: WsTopicContentTarget
542
548
  export var FtTopicContentTarget;
543
549
  (function (FtTopicContentTarget) {
544
550
  FtTopicContentTarget["THIRD_PARTY"] = "THIRD_PARTY";
@@ -553,7 +559,6 @@ export const isFtTranslationContent = (o) => {
553
559
  && (isBoolean(o.isTranslationError))
554
560
  && (isString(o.content));
555
561
  };
556
- // From: ExternalWebComponentContext
557
562
  export var FtExternalWebComponentContext;
558
563
  (function (FtExternalWebComponentContext) {
559
564
  FtExternalWebComponentContext["HOMEPAGE"] = "HOMEPAGE";
@@ -565,6 +570,8 @@ export var FtExternalWebComponentContext;
565
570
  FtExternalWebComponentContext["SEARCH_RESULT"] = "SEARCH_RESULT";
566
571
  FtExternalWebComponentContext["SEARCH_ANNOUNCEMENT"] = "SEARCH_ANNOUNCEMENT";
567
572
  FtExternalWebComponentContext["LINK_PREVIEW"] = "LINK_PREVIEW";
573
+ FtExternalWebComponentContext["UD_VIEWER"] = "UD_VIEWER";
574
+ FtExternalWebComponentContext["ASSET_VIEWER"] = "ASSET_VIEWER";
568
575
  })(FtExternalWebComponentContext || (FtExternalWebComponentContext = {}));
569
576
  export const isFtExternalWebComponentContext = (o) => Object.keys(FtExternalWebComponentContext).includes(o);
570
577
  export const isFtFeedbackCreation = (o) => {
@@ -572,7 +579,6 @@ export const isFtFeedbackCreation = (o) => {
572
579
  && (o.from == null || isString(o.from))
573
580
  && (isString(o.message));
574
581
  };
575
- // From: HomeLayout
576
582
  export var FtMetadataHomeLayout;
577
583
  (function (FtMetadataHomeLayout) {
578
584
  FtMetadataHomeLayout["CLASSIC"] = "CLASSIC";
@@ -628,7 +634,6 @@ export const isFtUserAssetLabel = (o) => {
628
634
  return isObject(o)
629
635
  && (isString(o.title));
630
636
  };
631
- // From: WsFacetType
632
637
  export var FtFacetType;
633
638
  (function (FtFacetType) {
634
639
  FtFacetType["AND"] = "AND";
@@ -646,7 +651,6 @@ export const isFtMetadata = (o) => {
646
651
  && (isString(o.label))
647
652
  && (isString(o.key));
648
653
  };
649
- // From: WsMetadataSortRule
650
654
  export var FtMetadataSortRule;
651
655
  (function (FtMetadataSortRule) {
652
656
  FtMetadataSortRule["NONE"] = "NONE";
@@ -720,7 +724,6 @@ export const isFtPrivacyPolicyConfiguration = (o) => {
720
724
  && (isBoolean(o.agreementRequired))
721
725
  && (isString(o.userAgreementMessage));
722
726
  };
723
- // From: RatingType
724
727
  export var FtRatingType;
725
728
  (function (FtRatingType) {
726
729
  FtRatingType["STARS"] = "STARS";
@@ -763,7 +766,7 @@ export const isFtTopicsRatingSummary = (o) => {
763
766
  && o.ratings.every((v) => isFtTopicRating(v))))
764
767
  && (isFtRatingType(o.type));
765
768
  };
766
- export const isFtMapResource = (o) => {
769
+ export const isFtMapResourceSummary = (o) => {
767
770
  return isObject(o)
768
771
  && (isString(o.contentUrl))
769
772
  && (isString(o.filename))
@@ -783,7 +786,6 @@ export const isFtSearchPreferencesConfiguration = (o) => {
783
786
  && Object.keys(o.metadata).every((k) => isString(k))
784
787
  && Object.values(o.metadata).every((v) => isFtMetadataPreferenceConfiguration(v))));
785
788
  };
786
- // From: PeriodFilterType
787
789
  export var FtPeriodFilterType;
788
790
  (function (FtPeriodFilterType) {
789
791
  FtPeriodFilterType["LAST_WEEK"] = "LAST_WEEK";
@@ -793,7 +795,6 @@ export var FtPeriodFilterType;
793
795
  FtPeriodFilterType["CUSTOM"] = "CUSTOM";
794
796
  })(FtPeriodFilterType || (FtPeriodFilterType = {}));
795
797
  export const isFtPeriodFilterType = (o) => Object.keys(FtPeriodFilterType).includes(o);
796
- // From: SearchKeywordMatch
797
798
  export var FtSearchKeywordMatch;
798
799
  (function (FtSearchKeywordMatch) {
799
800
  FtSearchKeywordMatch["OPTIONAL"] = "OPTIONAL";
@@ -808,21 +809,18 @@ export const isFtSearchPreset = (o) => {
808
809
  && ((Array.isArray(o.metadataFilters)
809
810
  && o.metadataFilters.every((v) => isFtMetadataFilter(v))));
810
811
  };
811
- // From: SearchSortCriterionOrder
812
812
  export var FtSearchSortCriterionOrder;
813
813
  (function (FtSearchSortCriterionOrder) {
814
814
  FtSearchSortCriterionOrder["ASC"] = "ASC";
815
815
  FtSearchSortCriterionOrder["DESC"] = "DESC";
816
816
  })(FtSearchSortCriterionOrder || (FtSearchSortCriterionOrder = {}));
817
817
  export const isFtSearchSortCriterionOrder = (o) => Object.keys(FtSearchSortCriterionOrder).includes(o);
818
- // From: SearchSortCriterionType
819
818
  export var FtSearchSortCriterionType;
820
819
  (function (FtSearchSortCriterionType) {
821
820
  FtSearchSortCriterionType["ALPHA"] = "ALPHA";
822
821
  FtSearchSortCriterionType["NATURAL"] = "NATURAL";
823
822
  })(FtSearchSortCriterionType || (FtSearchSortCriterionType = {}));
824
823
  export const isFtSearchSortCriterionType = (o) => Object.keys(FtSearchSortCriterionType).includes(o);
825
- // From: VirtualField
826
824
  export var FtVirtualField;
827
825
  (function (FtVirtualField) {
828
826
  FtVirtualField["EVERYWHERE"] = "EVERYWHERE";
@@ -837,7 +835,6 @@ export const isFtSearchResultsPageInfo = (o) => {
837
835
  && (isNumber(o.currentPage))
838
836
  && (isNumber(o.totalClustersCount));
839
837
  };
840
- // From: WsEditorialType
841
838
  export var FtEditorialType;
842
839
  (function (FtEditorialType) {
843
840
  FtEditorialType["ARTICLE"] = "ARTICLE";
@@ -846,7 +843,6 @@ export var FtEditorialType;
846
843
  FtEditorialType["HTML_PACKAGE"] = "HTML_PACKAGE";
847
844
  })(FtEditorialType || (FtEditorialType = {}));
848
845
  export const isFtEditorialType = (o) => Object.keys(FtEditorialType).includes(o);
849
- // From: WsOpenMode
850
846
  export var FtOpenMode;
851
847
  (function (FtOpenMode) {
852
848
  FtOpenMode["FLUIDTOPICS"] = "FLUIDTOPICS";
@@ -862,7 +858,6 @@ export const isFtPublicClusterSortCriterion = (o) => {
862
858
  return isObject(o)
863
859
  && (isString(o.key));
864
860
  };
865
- // From: WsPublicCollectionDocumentType
866
861
  export var FtCollectionDocumentType;
867
862
  (function (FtCollectionDocumentType) {
868
863
  FtCollectionDocumentType["MAP"] = "MAP";
@@ -877,7 +872,6 @@ export const isFtDateFilter = (o) => {
877
872
  return isObject(o)
878
873
  && (isFtDateFilterType(o.type));
879
874
  };
880
- // From: WsPublicDateFilterType
881
875
  export var FtDateFilterType;
882
876
  (function (FtDateFilterType) {
883
877
  FtDateFilterType["LAST_WEEK"] = "LAST_WEEK";
@@ -1081,7 +1075,6 @@ export const isFtSearchResultTopic = (o) => {
1081
1075
  && (o.lastEditionDate == null || isString(o.lastEditionDate))
1082
1076
  && (isString(o.htmlExcerpt));
1083
1077
  };
1084
- // From: WsPublicSearchResultType
1085
1078
  export var FtSearchResultType;
1086
1079
  (function (FtSearchResultType) {
1087
1080
  FtSearchResultType["MAP"] = "MAP";
@@ -1091,7 +1084,6 @@ export var FtSearchResultType;
1091
1084
  FtSearchResultType["HTML_PACKAGE_PAGE"] = "HTML_PACKAGE_PAGE";
1092
1085
  })(FtSearchResultType || (FtSearchResultType = {}));
1093
1086
  export const isFtSearchResultType = (o) => Object.keys(FtSearchResultType).includes(o);
1094
- // From: WsPublicSearchScope
1095
1087
  export var FtSearchScope;
1096
1088
  (function (FtSearchScope) {
1097
1089
  FtSearchScope["DEFAULT"] = "DEFAULT";
@@ -1150,7 +1142,6 @@ export const isFtTopicResource = (o) => {
1150
1142
  && (isString(o.resourceContentUrl))
1151
1143
  && (isString(o.viewerUrl));
1152
1144
  };
1153
- // From: LocalizableLabelType
1154
1145
  export var FtLocalizableLabelType;
1155
1146
  (function (FtLocalizableLabelType) {
1156
1147
  FtLocalizableLabelType["PLAIN_TEXT"] = "PLAIN_TEXT";
@@ -1184,7 +1175,6 @@ export const isFtSuggestResults = (o) => {
1184
1175
  && ((Array.isArray(o.suggestions)
1185
1176
  && o.suggestions.every((v) => isFtSuggestResult(v))));
1186
1177
  };
1187
- // From: Role
1188
1178
  export var FtUserRole;
1189
1179
  (function (FtUserRole) {
1190
1180
  FtUserRole["PERSONAL_BOOK_USER"] = "PERSONAL_BOOK_USER";
@@ -1194,7 +1184,6 @@ export var FtUserRole;
1194
1184
  FtUserRole["SAVED_SEARCH_USER"] = "SAVED_SEARCH_USER";
1195
1185
  FtUserRole["COLLECTION_USER"] = "COLLECTION_USER";
1196
1186
  FtUserRole["OFFLINE_USER"] = "OFFLINE_USER";
1197
- FtUserRole["BEHAVIOR_DATA_USER"] = "BEHAVIOR_DATA_USER";
1198
1187
  FtUserRole["ANALYTICS_USER"] = "ANALYTICS_USER";
1199
1188
  FtUserRole["BETA_USER"] = "BETA_USER";
1200
1189
  FtUserRole["DEBUG_USER"] = "DEBUG_USER";
@@ -1204,6 +1193,7 @@ export var FtUserRole;
1204
1193
  FtUserRole["GENERATIVE_AI_USER"] = "GENERATIVE_AI_USER";
1205
1194
  FtUserRole["GENERATIVE_AI_EXPORT_USER"] = "GENERATIVE_AI_EXPORT_USER";
1206
1195
  FtUserRole["CONTENT_PUBLISHER"] = "CONTENT_PUBLISHER";
1196
+ FtUserRole["BEHAVIOR_DATA_USER"] = "BEHAVIOR_DATA_USER";
1207
1197
  FtUserRole["ANNOUNCEMENT_ADMIN"] = "ANNOUNCEMENT_ADMIN";
1208
1198
  FtUserRole["KHUB_ADMIN"] = "KHUB_ADMIN";
1209
1199
  FtUserRole["USERS_ADMIN"] = "USERS_ADMIN";
@@ -1211,7 +1201,6 @@ export var FtUserRole;
1211
1201
  FtUserRole["ADMIN"] = "ADMIN";
1212
1202
  })(FtUserRole || (FtUserRole = {}));
1213
1203
  export const isFtUserRole = (o) => Object.keys(FtUserRole).includes(o);
1214
- // From: UserAssetType
1215
1204
  export var FtUserAssetType;
1216
1205
  (function (FtUserAssetType) {
1217
1206
  FtUserAssetType["SEARCHES"] = "SEARCHES";
@@ -1258,7 +1247,6 @@ export const isFtUserProfile = (o) => {
1258
1247
  && ((Array.isArray(o.tags)
1259
1248
  && o.tags.every((v) => isString(v))));
1260
1249
  };
1261
- // From: WsPublicSessionStatus
1262
1250
  export var FtSessionStatus;
1263
1251
  (function (FtSessionStatus) {
1264
1252
  FtSessionStatus["UNAUTHENTICATED"] = "UNAUTHENTICATED";
@@ -1,3 +1,4 @@
1
+ import { FtTocNode, FtTopicOrigin, FtWatermark, FtMetadata } from "../ft-common/public";
1
2
  export declare enum FtConfigurationHistoryEntryStatus {
2
3
  VALID = "VALID",
3
4
  INVALID = "INVALID"
@@ -20,6 +21,42 @@ export interface FtReaderFeedbackConfiguration {
20
21
  subjectMetadataIds: Array<string>;
21
22
  }
22
23
  export declare const isFtReaderFeedbackConfiguration: (o: any) => o is FtReaderFeedbackConfiguration;
24
+ export declare enum FtChatbotAdminRatingTag {
25
+ INACCURATE = "INACCURATE",
26
+ INCOMPLETE = "INCOMPLETE",
27
+ OFF_TOPIC = "OFF_TOPIC",
28
+ IRRELEVANT_SOURCES = "IRRELEVANT_SOURCES",
29
+ SUMMARY = "SUMMARY",
30
+ SEMANTIC_SEARCH = "SEMANTIC_SEARCH",
31
+ CHATBOT_INSTRUCTIONS = "CHATBOT_INSTRUCTIONS",
32
+ OTHER = "OTHER"
33
+ }
34
+ export type FtChatbotAdminRatingTagKeys = keyof typeof FtChatbotAdminRatingTag;
35
+ export declare const isFtChatbotAdminRatingTag: (o: any) => o is FtChatbotAdminRatingTag;
36
+ export declare enum FtChatbotUserRatingTag {
37
+ INACCURATE = "INACCURATE",
38
+ INCOMPLETE = "INCOMPLETE",
39
+ OFF_TOPIC = "OFF_TOPIC",
40
+ IRRELEVANT_SOURCES = "IRRELEVANT_SOURCES",
41
+ SLOW = "SLOW",
42
+ OTHER = "OTHER"
43
+ }
44
+ export type FtChatbotUserRatingTagKeys = keyof typeof FtChatbotUserRatingTag;
45
+ export declare const isFtChatbotUserRatingTag: (o: any) => o is FtChatbotUserRatingTag;
46
+ export interface FtGenAIChatbotAdminRating {
47
+ profileId: string;
48
+ comment?: string;
49
+ value: number;
50
+ tags?: Array<FtChatbotAdminRatingTagKeys>;
51
+ }
52
+ export declare const isFtGenAIChatbotAdminRating: (o: any) => o is FtGenAIChatbotAdminRating;
53
+ export interface FtGenAIChatbotUserRating {
54
+ profileId: string;
55
+ comment?: string;
56
+ value: number;
57
+ tags?: Array<FtChatbotUserRatingTagKeys>;
58
+ }
59
+ export declare const isFtGenAIChatbotUserRating: (o: any) => o is FtGenAIChatbotUserRating;
23
60
  export interface FtGenAIRating {
24
61
  rating: number;
25
62
  comment: string;
@@ -31,6 +68,22 @@ export interface FtGenAIGenerateInput {
31
68
  parameters?: Record<string, string>;
32
69
  }
33
70
  export declare const isFtGenAIGenerateInput: (o: any) => o is FtGenAIGenerateInput;
71
+ export interface FtAgenticSearchRequest {
72
+ cluster?: FtClusteredSemanticSearchCluster;
73
+ promoteRules?: Array<any>;
74
+ query: string;
75
+ toc?: FtAgenticSearchRequestTocOptions;
76
+ nbResultsAfterRerank: number;
77
+ rerankModel: string;
78
+ filters?: Array<FtSemanticSearchFilter>;
79
+ nbResults: number;
80
+ }
81
+ export declare const isFtAgenticSearchRequest: (o: any) => o is FtAgenticSearchRequest;
82
+ export interface FtAgenticSearchRequestTocOptions {
83
+ addWordCounts: boolean;
84
+ collapse: boolean;
85
+ }
86
+ export declare const isFtAgenticSearchRequestTocOptions: (o: any) => o is FtAgenticSearchRequestTocOptions;
34
87
  export declare enum FtRagResponseFormat {
35
88
  JSON = "JSON",
36
89
  TEXT = "TEXT"
@@ -44,7 +97,7 @@ export interface FtRagHistory {
44
97
  export declare const isFtRagHistory: (o: any) => o is FtRagHistory;
45
98
  export interface FtRagInput {
46
99
  profileId: string;
47
- conversationId?: string;
100
+ conversationId: string;
48
101
  query: string;
49
102
  messages?: Array<FtRagHistory>;
50
103
  responseFormat?: FtRagResponseFormatKeys;
@@ -130,7 +183,7 @@ export declare enum RagTraceMessageType {
130
183
  }
131
184
  export type RagTraceMessageTypeKeys = keyof typeof RagTraceMessageType;
132
185
  export declare const isRagTraceMessageType: (o: any) => o is RagTraceMessageType;
133
- export interface FtGenAIRagTraceAssistantMessage extends FtGenAIRagTraceDetailHistoryItem {
186
+ export interface FtGenAIRagTraceAssistantMessage/* WsGenAIRagTraceAssistantMessage */ extends FtGenAIRagTraceDetailHistoryItem {
134
187
  chatbotInstructions: string;
135
188
  role: RagTraceMessageTypeKeys;
136
189
  semsearch: FtGenAIRagTraceSemsearch;
@@ -157,7 +210,7 @@ export interface FtGenAIRagTraceSemsearch {
157
210
  results: Array<FtSemanticSearchResponseItem>;
158
211
  }
159
212
  export declare const isFtGenAIRagTraceSemsearch: (o: any) => o is FtGenAIRagTraceSemsearch;
160
- export interface FtGenAIRagTraceUserMessage extends FtGenAIRagTraceDetailHistoryItem {
213
+ export interface FtGenAIRagTraceUserMessage/* WsGenAIRagTraceUserMessage */ extends FtGenAIRagTraceDetailHistoryItem {
161
214
  role: RagTraceMessageTypeKeys;
162
215
  content: string;
163
216
  timestamp: string;
@@ -196,11 +249,22 @@ export interface FtMapAttachment {
196
249
  externalLink: boolean;
197
250
  name: string;
198
251
  id: string;
199
- mimeType?: string;
200
- viewerUrl?: string;
252
+ mimeType: string;
253
+ viewerUrl: string;
254
+ target: any;
255
+ }
256
+ export interface FtDocumentAttachment {
257
+ file: string;
258
+ size?: number;
259
+ externalLink: boolean;
260
+ name: string;
261
+ id: string;
262
+ mimeType: string;
263
+ viewerUrl: string;
201
264
  target: any;
202
265
  }
203
266
  export declare const isFtMapAttachment: (o: any) => o is FtMapAttachment;
267
+ export declare const isFtDocumentAttachment: (o: any) => o is FtDocumentAttachment;
204
268
  export interface FtPageConfiguration {
205
269
  parentsVisibility?: Array<boolean>;
206
270
  isVisible: boolean;
@@ -215,11 +279,11 @@ export declare const isFtPaginatedToc: (o: any) => o is FtPaginatedToc;
215
279
  export interface FtPaginatedTocNode {
216
280
  prettyUrl?: string;
217
281
  hasRating?: boolean;
218
- pageToc?: Array<any>;
282
+ pageToc?: Array<FtTocNode>;
219
283
  tocId?: string;
220
284
  children: Array<FtPaginatedTocNode>;
221
285
  pageConfiguration?: FtPageConfiguration;
222
- origin?: any;
286
+ origin?: FtTopicOrigin;
223
287
  contentId?: string;
224
288
  untranslatedTitle?: string;
225
289
  title?: string;
@@ -263,24 +327,24 @@ export interface FtSemanticSearchResponseItem {
263
327
  relevance: number;
264
328
  }
265
329
  export declare const isFtSemanticSearchResponseItem: (o: any) => o is FtSemanticSearchResponseItem;
266
- export interface FtSemanticSearchAndFilter extends FtSemanticSearchFilter {
330
+ export interface FtSemanticSearchAndFilter/* WsSemanticSearchAndFilter */ extends FtSemanticSearchFilter {
267
331
  and: Array<FtSemanticSearchFilter>;
268
332
  }
269
333
  export declare const isFtSemanticSearchAndFilter: (o: any) => o is FtSemanticSearchAndFilter;
270
334
  export interface FtSemanticSearchFilter {
271
335
  }
272
336
  export declare const isFtSemanticSearchFilter: (o: any) => o is FtSemanticSearchFilter;
273
- export interface FtSemanticSearchKeyValueFilter extends FtSemanticSearchFilter {
337
+ export interface FtSemanticSearchKeyValueFilter/* WsSemanticSearchKeyValueFilter */ extends FtSemanticSearchFilter {
274
338
  values: Array<string>;
275
339
  hierarchicalValues: Array<Array<string>>;
276
340
  key: string;
277
341
  }
278
342
  export declare const isFtSemanticSearchKeyValueFilter: (o: any) => o is FtSemanticSearchKeyValueFilter;
279
- export interface FtSemanticSearchNotFilter extends FtSemanticSearchFilter {
343
+ export interface FtSemanticSearchNotFilter/* WsSemanticSearchNotFilter */ extends FtSemanticSearchFilter {
280
344
  not: FtSemanticSearchFilter;
281
345
  }
282
346
  export declare const isFtSemanticSearchNotFilter: (o: any) => o is FtSemanticSearchNotFilter;
283
- export interface FtSemanticSearchOrFilter extends FtSemanticSearchFilter {
347
+ export interface FtSemanticSearchOrFilter/* WsSemanticSearchOrFilter */ extends FtSemanticSearchFilter {
284
348
  or: Array<FtSemanticSearchFilter>;
285
349
  }
286
350
  export declare const isFtSemanticSearchOrFilter: (o: any) => o is FtSemanticSearchOrFilter;
@@ -291,3 +355,46 @@ export interface FtSemanticSearchRequest {
291
355
  nbResults?: number;
292
356
  }
293
357
  export declare const isFtSemanticSearchRequest: (o: any) => o is FtSemanticSearchRequest;
358
+ export interface FtAssetDescriptor {
359
+ contentUrl: string;
360
+ filename: string;
361
+ watermark?: FtWatermark;
362
+ size: number;
363
+ displayName: string;
364
+ portalUrl: string;
365
+ fingerprint: string;
366
+ viewableInCurrentBrowser: boolean;
367
+ holder: FtAssetHolder;
368
+ id: string;
369
+ mimeType: string;
370
+ }
371
+ export interface FtMapResource {
372
+ contentUrl: string;
373
+ filename: string;
374
+ watermark?: FtWatermark;
375
+ size: number;
376
+ displayName: string;
377
+ portalUrl: string;
378
+ fingerprint: string;
379
+ viewableInCurrentBrowser: boolean;
380
+ holder: FtAssetHolder;
381
+ id: string;
382
+ mimeType: string;
383
+ }
384
+ export declare const isFtAssetDescriptor: (o: any) => o is FtAssetDescriptor;
385
+ export declare const isFtMapResource: (o: any) => o is FtMapResource;
386
+ export interface FtAssetHolder {
387
+ metadata: Array<FtMetadata>;
388
+ portalUrl: string;
389
+ id: string;
390
+ type: FtAssetHolderTypeKeys;
391
+ lang: string;
392
+ title: string;
393
+ }
394
+ export declare const isFtAssetHolder: (o: any) => o is FtAssetHolder;
395
+ export declare enum FtAssetHolderType {
396
+ MAP = "MAP",
397
+ UNSTRUCTURED_DOCUMENT = "UNSTRUCTURED_DOCUMENT"
398
+ }
399
+ export type FtAssetHolderTypeKeys = keyof typeof FtAssetHolderType;
400
+ export declare const isFtAssetHolderType: (o: any) => o is FtAssetHolderType;