egain-api-python 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl
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.
- egain_api_python/_version.py +3 -3
- egain_api_python/answers.py +26 -38
- egain_api_python/articlelists.py +10 -10
- egain_api_python/connectorssearchevents.py +4 -4
- egain_api_python/errors/gethealthop.py +33 -19
- egain_api_python/escalation.py +8 -8
- egain_api_python/export.py +6 -6
- egain_api_python/federatedsearchevent.py +2 -2
- egain_api_python/general.py +8 -8
- egain_api_python/guidedhelp.py +26 -26
- egain_api_python/health.py +2 -8
- egain_api_python/import_.py +56 -74
- egain_api_python/models/__init__.py +106 -95
- egain_api_python/models/aisearchop.py +6 -34
- egain_api_python/models/aisearchresponse.py +0 -4
- egain_api_python/models/answersrequest.py +0 -31
- egain_api_python/models/answersresponse.py +9 -11
- egain_api_python/models/articleaisearchresult.py +16 -45
- egain_api_python/models/articletype.py +3 -5
- egain_api_python/models/{getimportcontentop.py → cancelimportop.py} +3 -3
- egain_api_python/models/{createimportop.py → createimportjobop.py} +3 -3
- egain_api_python/models/{createimportvalidationop.py → createimportvalidationjobop.py} +3 -3
- egain_api_python/models/exportstatus.py +15 -8
- egain_api_python/models/getannouncementarticlesop.py +2 -2
- egain_api_python/models/getarticlelistdetailsop.py +2 -2
- egain_api_python/models/getarticlesintopicop.py +4 -4
- egain_api_python/models/getbestanswerop.py +6 -6
- egain_api_python/models/gethealthop.py +134 -7
- egain_api_python/models/{patchimportcontentvalidationop.py → getimportstatusop.py} +3 -3
- egain_api_python/models/getpopulararticlesop.py +4 -4
- egain_api_python/models/getrelatedarticlesop.py +2 -2
- egain_api_python/models/importstatus.py +116 -0
- egain_api_python/models/knowledgeexport.py +3 -5
- egain_api_python/models/referenceresponse.py +7 -23
- egain_api_python/models/retrievechunksop.py +6 -6
- egain_api_python/models/retrieveresponse.py +10 -12
- egain_api_python/models/searchresult.py +7 -23
- egain_api_python/populararticles.py +14 -14
- egain_api_python/portal_article.py +64 -64
- egain_api_python/portal_attachment.py +4 -4
- egain_api_python/portal_bookmark.py +6 -6
- egain_api_python/portal_suggestion.py +18 -18
- egain_api_python/portal_topic.py +8 -8
- egain_api_python/portal_userdetails.py +2 -2
- egain_api_python/portal_userprofile.py +4 -4
- egain_api_python/retrieve.py +22 -28
- egain_api_python/sdk.py +25 -24
- egain_api_python/sdkconfiguration.py +3 -4
- egain_api_python/search.py +24 -40
- egain_api_python/usermilestones.py +2 -2
- {egain_api_python-0.1.2.dist-info → egain_api_python-0.1.4.dist-info}/METADATA +44 -78
- {egain_api_python-0.1.2.dist-info → egain_api_python-0.1.4.dist-info}/RECORD +55 -57
- egain_api_python/models/resourcetype_parameter.py +0 -10
- egain_api_python/models/topicaisearchresult.py +0 -67
- {egain_api_python-0.1.2.dist-info → egain_api_python-0.1.4.dist-info}/WHEEL +0 -0
- {egain_api_python-0.1.2.dist-info → egain_api_python-0.1.4.dist-info}/licenses/LICENSE +0 -0
- {egain_api_python-0.1.2.dist-info → egain_api_python-0.1.4.dist-info}/top_level.txt +0 -0
@@ -51,8 +51,6 @@ if TYPE_CHECKING:
|
|
51
51
|
AnswersRequestChannelTypedDict,
|
52
52
|
AnswersRequestType,
|
53
53
|
AnswersRequestTypedDict,
|
54
|
-
Context,
|
55
|
-
ContextTypedDict,
|
56
54
|
)
|
57
55
|
from .answersresponse import (
|
58
56
|
AnswersResponse,
|
@@ -82,12 +80,9 @@ if TYPE_CHECKING:
|
|
82
80
|
ArticleAISearchResultLinkTypedDict,
|
83
81
|
ArticleAISearchResultSource,
|
84
82
|
ArticleAISearchResultType,
|
85
|
-
ArticleAISearchResultTypeName,
|
86
83
|
ArticleAISearchResultTypedDict,
|
87
84
|
ArticleTypeAttributes,
|
88
85
|
ArticleTypeAttributesTypedDict,
|
89
|
-
OpensearchHighlightingRaw,
|
90
|
-
OpensearchHighlightingRawTypedDict,
|
91
86
|
)
|
92
87
|
from .articleattachment import (
|
93
88
|
ArticleAttachment,
|
@@ -122,7 +117,7 @@ if TYPE_CHECKING:
|
|
122
117
|
)
|
123
118
|
from .articlesort import ArticleSort
|
124
119
|
from .articlesortorder import ArticleSortOrder
|
125
|
-
from .articletype import ArticleType,
|
120
|
+
from .articletype import ArticleType, ArticleTypeTypedDict, TypeName
|
126
121
|
from .articlewitheditions import ArticleWithEditions, ArticleWithEditionsTypedDict
|
127
122
|
from .attachment import Attachment, AttachmentTypedDict
|
128
123
|
from .attachmentadditionalattributes import AttachmentAdditionalAttributes
|
@@ -149,6 +144,11 @@ if TYPE_CHECKING:
|
|
149
144
|
from .bookmark import Bookmark, BookmarkTypedDict
|
150
145
|
from .bookmarkresult import BookmarkResult, BookmarkResultTypedDict
|
151
146
|
from .bookmarkstatus import BookmarkStatus, BookmarkStatusTypedDict
|
147
|
+
from .cancelimportop import (
|
148
|
+
CANCEL_IMPORT_OP_SERVERS,
|
149
|
+
CancelImportRequest,
|
150
|
+
CancelImportRequestTypedDict,
|
151
|
+
)
|
152
152
|
from .case import Case, CaseType, CaseTypedDict, ThresholdType
|
153
153
|
from .caseadditionalattributes import CaseAdditionalAttributes
|
154
154
|
from .caseanswer import CaseAnswer, CaseAnswerTypedDict
|
@@ -225,15 +225,15 @@ if TYPE_CHECKING:
|
|
225
225
|
CreateFederatedSearchResultEventRequest,
|
226
226
|
CreateFederatedSearchResultEventRequestTypedDict,
|
227
227
|
)
|
228
|
-
from .
|
229
|
-
|
230
|
-
|
231
|
-
|
228
|
+
from .createimportjobop import (
|
229
|
+
CREATE_IMPORT_JOB_OP_SERVERS,
|
230
|
+
CreateImportJobResponse,
|
231
|
+
CreateImportJobResponseTypedDict,
|
232
232
|
)
|
233
|
-
from .
|
234
|
-
|
235
|
-
|
236
|
-
|
233
|
+
from .createimportvalidationjobop import (
|
234
|
+
CREATE_IMPORT_VALIDATION_JOB_OP_SERVERS,
|
235
|
+
CreateImportValidationJobResponse,
|
236
|
+
CreateImportValidationJobResponseTypedDict,
|
237
237
|
)
|
238
238
|
from .createquickpick import CreateQuickpick, CreateQuickpickTypedDict
|
239
239
|
from .createquickpickop import (
|
@@ -302,12 +302,12 @@ if TYPE_CHECKING:
|
|
302
302
|
from .exportcontentop import ExportContentResponse, ExportContentResponseTypedDict
|
303
303
|
from .exportstatus import (
|
304
304
|
ExportStatus,
|
305
|
+
ExportStatusProgress,
|
306
|
+
ExportStatusProgressTypedDict,
|
307
|
+
ExportStatusResults,
|
308
|
+
ExportStatusResultsTypedDict,
|
305
309
|
ExportStatusStatus,
|
306
310
|
ExportStatusTypedDict,
|
307
|
-
Progress,
|
308
|
-
ProgressTypedDict,
|
309
|
-
Results,
|
310
|
-
ResultsTypedDict,
|
311
311
|
)
|
312
312
|
from .exportstatusop import ExportStatusRequest, ExportStatusRequestTypedDict
|
313
313
|
from .feedbackarticleforsuggestion import (
|
@@ -410,14 +410,23 @@ if TYPE_CHECKING:
|
|
410
410
|
GetClusterByCasebaseReleaseIDRequestTypedDict,
|
411
411
|
)
|
412
412
|
from .gethealthop import (
|
413
|
+
Components,
|
414
|
+
ComponentsTypedDict,
|
415
|
+
Database,
|
416
|
+
ExternalServices,
|
417
|
+
FileSystem,
|
413
418
|
GET_HEALTH_OP_SERVERS,
|
414
419
|
GetHealthResponse,
|
415
420
|
GetHealthResponseTypedDict,
|
421
|
+
GetHealthStatus,
|
422
|
+
ProcessingEngine,
|
423
|
+
ServiceUnavailableStatus,
|
424
|
+
Storage,
|
416
425
|
)
|
417
|
-
from .
|
418
|
-
|
419
|
-
|
420
|
-
|
426
|
+
from .getimportstatusop import (
|
427
|
+
GET_IMPORT_STATUS_OP_SERVERS,
|
428
|
+
GetImportStatusRequest,
|
429
|
+
GetImportStatusRequestTypedDict,
|
421
430
|
)
|
422
431
|
from .getmyportalsop import GetMyPortalsRequest, GetMyPortalsRequestTypedDict
|
423
432
|
from .getmysubscriptionop import (
|
@@ -486,7 +495,16 @@ if TYPE_CHECKING:
|
|
486
495
|
ScheduleTime,
|
487
496
|
ScheduleTimeTypedDict,
|
488
497
|
)
|
489
|
-
from .importstatus import
|
498
|
+
from .importstatus import (
|
499
|
+
ImportStatus,
|
500
|
+
ImportStatusProgress,
|
501
|
+
ImportStatusProgressTypedDict,
|
502
|
+
ImportStatusResults,
|
503
|
+
ImportStatusResultsTypedDict,
|
504
|
+
ImportStatusStatus,
|
505
|
+
ImportStatusTypedDict,
|
506
|
+
JobType,
|
507
|
+
)
|
490
508
|
from .kblanguage import KbLanguage, KbLanguageCode1, KbLanguageTypedDict, Name
|
491
509
|
from .kblanguagecode import KbLanguageCode
|
492
510
|
from .kblanguages import KbLanguages, KbLanguagesTypedDict
|
@@ -501,8 +519,8 @@ if TYPE_CHECKING:
|
|
501
519
|
KnowledgeExportCredentialsTypedDict,
|
502
520
|
KnowledgeExportLanguage,
|
503
521
|
KnowledgeExportLanguageTypedDict,
|
504
|
-
KnowledgeExportResourceType,
|
505
522
|
KnowledgeExportTypedDict,
|
523
|
+
ResourceType,
|
506
524
|
)
|
507
525
|
from .l10nstring import L10NString, L10NStringTypedDict
|
508
526
|
from .languagecode import LanguageCode
|
@@ -530,11 +548,6 @@ if TYPE_CHECKING:
|
|
530
548
|
from .order import Order
|
531
549
|
from .ownedby import OwnedBy, OwnedByTypedDict
|
532
550
|
from .paginationinfo import PaginationInfo, PaginationInfoTypedDict
|
533
|
-
from .patchimportcontentvalidationop import (
|
534
|
-
PATCH_IMPORT_CONTENT_VALIDATION_OP_SERVERS,
|
535
|
-
PatchImportContentValidationRequest,
|
536
|
-
PatchImportContentValidationRequestTypedDict,
|
537
|
-
)
|
538
551
|
from .personalization import (
|
539
552
|
Filters,
|
540
553
|
FiltersTypedDict,
|
@@ -571,8 +584,6 @@ if TYPE_CHECKING:
|
|
571
584
|
from .referenceresponse import (
|
572
585
|
ReferenceResponse,
|
573
586
|
ReferenceResponseDocType,
|
574
|
-
ReferenceResponseLink,
|
575
|
-
ReferenceResponseLinkTypedDict,
|
576
587
|
ReferenceResponseSource,
|
577
588
|
ReferenceResponseTypedDict,
|
578
589
|
)
|
@@ -581,7 +592,6 @@ if TYPE_CHECKING:
|
|
581
592
|
RejectGHSolutionRequestTypedDict,
|
582
593
|
)
|
583
594
|
from .relatedquestions import RelatedQuestions, RelatedQuestionsTypedDict
|
584
|
-
from .resourcetype_parameter import ResourceTypeParameter
|
585
595
|
from .restorequickpickop import (
|
586
596
|
RestoreQuickpickRequest,
|
587
597
|
RestoreQuickpickRequestTypedDict,
|
@@ -644,8 +654,6 @@ if TYPE_CHECKING:
|
|
644
654
|
from .searchresult import (
|
645
655
|
SearchResult,
|
646
656
|
SearchResultDocType,
|
647
|
-
SearchResultLink,
|
648
|
-
SearchResultLinkTypedDict,
|
649
657
|
SearchResultSource,
|
650
658
|
SearchResultTypedDict,
|
651
659
|
SnippetType,
|
@@ -733,7 +741,6 @@ if TYPE_CHECKING:
|
|
733
741
|
from .tags import Tags, TagsTypedDict
|
734
742
|
from .topic import Topic, TopicTypedDict
|
735
743
|
from .topicadditionalattributes import TopicAdditionalAttributes
|
736
|
-
from .topicaisearchresult import TopicAISearchResult, TopicAISearchResultTypedDict
|
737
744
|
from .topicbreadcrumb import TopicBreadcrumb, TopicBreadcrumbTypedDict
|
738
745
|
from .topicresult import TopicResult, TopicResultTypedDict
|
739
746
|
from .topicsummary import TopicSummary, TopicSummaryTypedDict
|
@@ -826,7 +833,6 @@ __all__ = [
|
|
826
833
|
"ArticleAISearchResultLinkTypedDict",
|
827
834
|
"ArticleAISearchResultSource",
|
828
835
|
"ArticleAISearchResultType",
|
829
|
-
"ArticleAISearchResultTypeName",
|
830
836
|
"ArticleAISearchResultTypedDict",
|
831
837
|
"ArticleActivityLink",
|
832
838
|
"ArticleActivityLinkCode",
|
@@ -866,7 +872,6 @@ __all__ = [
|
|
866
872
|
"ArticleType",
|
867
873
|
"ArticleTypeAttributes",
|
868
874
|
"ArticleTypeAttributesTypedDict",
|
869
|
-
"ArticleTypeTypeName",
|
870
875
|
"ArticleTypeTypedDict",
|
871
876
|
"ArticleTypedDict",
|
872
877
|
"ArticleWithEditions",
|
@@ -895,8 +900,11 @@ __all__ = [
|
|
895
900
|
"BookmarkStatus",
|
896
901
|
"BookmarkStatusTypedDict",
|
897
902
|
"BookmarkTypedDict",
|
898
|
-
"
|
899
|
-
"
|
903
|
+
"CANCEL_IMPORT_OP_SERVERS",
|
904
|
+
"CREATE_IMPORT_JOB_OP_SERVERS",
|
905
|
+
"CREATE_IMPORT_VALIDATION_JOB_OP_SERVERS",
|
906
|
+
"CancelImportRequest",
|
907
|
+
"CancelImportRequestTypedDict",
|
900
908
|
"Captcha",
|
901
909
|
"CaptchaTypedDict",
|
902
910
|
"Case",
|
@@ -945,12 +953,14 @@ __all__ = [
|
|
945
953
|
"ComplianceForArticleTypedDict",
|
946
954
|
"ComplyArticleRequest",
|
947
955
|
"ComplyArticleRequestTypedDict",
|
956
|
+
"Components",
|
948
957
|
"ComponentsSchemasTag",
|
949
958
|
"ComponentsSchemasTagCategory",
|
950
959
|
"ComponentsSchemasTagCategoryTypedDict",
|
951
960
|
"ComponentsSchemasTagGroup",
|
952
961
|
"ComponentsSchemasTagGroupTypedDict",
|
953
962
|
"ComponentsSchemasTagTypedDict",
|
963
|
+
"ComponentsTypedDict",
|
954
964
|
"ConfigurableAttribute",
|
955
965
|
"ConfigurableAttributeTypedDict",
|
956
966
|
"ConfigurableAttributes",
|
@@ -959,18 +969,16 @@ __all__ = [
|
|
959
969
|
"ContactPersonTypedDict",
|
960
970
|
"Contacts",
|
961
971
|
"ContactsTypedDict",
|
962
|
-
"Context",
|
963
|
-
"ContextTypedDict",
|
964
972
|
"CreateBookmark",
|
965
973
|
"CreateBookmarkTypedDict",
|
966
974
|
"CreateFederatedSearchEvent",
|
967
975
|
"CreateFederatedSearchEventTypedDict",
|
968
976
|
"CreateFederatedSearchResultEventRequest",
|
969
977
|
"CreateFederatedSearchResultEventRequestTypedDict",
|
970
|
-
"
|
971
|
-
"
|
972
|
-
"
|
973
|
-
"
|
978
|
+
"CreateImportJobResponse",
|
979
|
+
"CreateImportJobResponseTypedDict",
|
980
|
+
"CreateImportValidationJobResponse",
|
981
|
+
"CreateImportValidationJobResponseTypedDict",
|
974
982
|
"CreateQuickpick",
|
975
983
|
"CreateQuickpickRequest",
|
976
984
|
"CreateQuickpickRequestTypedDict",
|
@@ -1003,6 +1011,7 @@ __all__ = [
|
|
1003
1011
|
"CustomerTypedDict",
|
1004
1012
|
"DataDestination",
|
1005
1013
|
"DataDestinationTypedDict",
|
1014
|
+
"Database",
|
1006
1015
|
"DeleteSuggestionRequest",
|
1007
1016
|
"DeleteSuggestionRequestTypedDict",
|
1008
1017
|
"DeletebookmarkRequest",
|
@@ -1033,12 +1042,18 @@ __all__ = [
|
|
1033
1042
|
"ExportContentResponse",
|
1034
1043
|
"ExportContentResponseTypedDict",
|
1035
1044
|
"ExportStatus",
|
1045
|
+
"ExportStatusProgress",
|
1046
|
+
"ExportStatusProgressTypedDict",
|
1036
1047
|
"ExportStatusRequest",
|
1037
1048
|
"ExportStatusRequestTypedDict",
|
1049
|
+
"ExportStatusResults",
|
1050
|
+
"ExportStatusResultsTypedDict",
|
1038
1051
|
"ExportStatusStatus",
|
1039
1052
|
"ExportStatusTypedDict",
|
1053
|
+
"ExternalServices",
|
1040
1054
|
"FeedbackArticleForSuggestion",
|
1041
1055
|
"FeedbackArticleForSuggestionTypedDict",
|
1056
|
+
"FileSystem",
|
1042
1057
|
"FilterStatus",
|
1043
1058
|
"Filters",
|
1044
1059
|
"FiltersTypedDict",
|
@@ -1048,7 +1063,7 @@ __all__ = [
|
|
1048
1063
|
"FolderSummaryTypedDict",
|
1049
1064
|
"GET_BEST_ANSWER_OP_SERVERS",
|
1050
1065
|
"GET_HEALTH_OP_SERVERS",
|
1051
|
-
"
|
1066
|
+
"GET_IMPORT_STATUS_OP_SERVERS",
|
1052
1067
|
"GHSearchRequest",
|
1053
1068
|
"GHSearchRequestTypedDict",
|
1054
1069
|
"GHSearchResult",
|
@@ -1104,8 +1119,9 @@ __all__ = [
|
|
1104
1119
|
"GetClusterByCasebaseReleaseIDRequestTypedDict",
|
1105
1120
|
"GetHealthResponse",
|
1106
1121
|
"GetHealthResponseTypedDict",
|
1107
|
-
"
|
1108
|
-
"
|
1122
|
+
"GetHealthStatus",
|
1123
|
+
"GetImportStatusRequest",
|
1124
|
+
"GetImportStatusRequestTypedDict",
|
1109
1125
|
"GetMyPortalsRequest",
|
1110
1126
|
"GetMyPortalsRequestTypedDict",
|
1111
1127
|
"GetMySubscriptionRequest",
|
@@ -1154,8 +1170,13 @@ __all__ = [
|
|
1154
1170
|
"ImportContentType",
|
1155
1171
|
"ImportContentTypedDict",
|
1156
1172
|
"ImportStatus",
|
1173
|
+
"ImportStatusProgress",
|
1174
|
+
"ImportStatusProgressTypedDict",
|
1175
|
+
"ImportStatusResults",
|
1176
|
+
"ImportStatusResultsTypedDict",
|
1157
1177
|
"ImportStatusStatus",
|
1158
1178
|
"ImportStatusTypedDict",
|
1179
|
+
"JobType",
|
1159
1180
|
"KbLanguage",
|
1160
1181
|
"KbLanguageCode",
|
1161
1182
|
"KbLanguageCode1",
|
@@ -1168,7 +1189,6 @@ __all__ = [
|
|
1168
1189
|
"KnowledgeExportCredentialsTypedDict",
|
1169
1190
|
"KnowledgeExportLanguage",
|
1170
1191
|
"KnowledgeExportLanguageTypedDict",
|
1171
|
-
"KnowledgeExportResourceType",
|
1172
1192
|
"KnowledgeExportTypedDict",
|
1173
1193
|
"L10NString",
|
1174
1194
|
"L10NStringTypedDict",
|
@@ -1200,18 +1220,13 @@ __all__ = [
|
|
1200
1220
|
"ModifySuggestionsRequest",
|
1201
1221
|
"ModifySuggestionsRequestTypedDict",
|
1202
1222
|
"Name",
|
1203
|
-
"OpensearchHighlightingRaw",
|
1204
|
-
"OpensearchHighlightingRawTypedDict",
|
1205
1223
|
"Operation",
|
1206
1224
|
"OptionalArticleAttributes",
|
1207
1225
|
"Order",
|
1208
1226
|
"OwnedBy",
|
1209
1227
|
"OwnedByTypedDict",
|
1210
|
-
"PATCH_IMPORT_CONTENT_VALIDATION_OP_SERVERS",
|
1211
1228
|
"PaginationInfo",
|
1212
1229
|
"PaginationInfoTypedDict",
|
1213
|
-
"PatchImportContentValidationRequest",
|
1214
|
-
"PatchImportContentValidationRequestTypedDict",
|
1215
1230
|
"Personalization",
|
1216
1231
|
"PersonalizationAccessTags",
|
1217
1232
|
"PersonalizationAccessTagsTypedDict",
|
@@ -1224,12 +1239,11 @@ __all__ = [
|
|
1224
1239
|
"PortalSettings",
|
1225
1240
|
"PortalSettingsTypedDict",
|
1226
1241
|
"PortalTypedDict",
|
1242
|
+
"ProcessingEngine",
|
1227
1243
|
"Profile",
|
1228
1244
|
"ProfileResult",
|
1229
1245
|
"ProfileResultTypedDict",
|
1230
1246
|
"ProfileTypedDict",
|
1231
|
-
"Progress",
|
1232
|
-
"ProgressTypedDict",
|
1233
1247
|
"PublishProfile",
|
1234
1248
|
"PublishProfileTypedDict",
|
1235
1249
|
"PublishView",
|
@@ -1255,8 +1269,6 @@ __all__ = [
|
|
1255
1269
|
"RateArticleRequestTypedDict",
|
1256
1270
|
"ReferenceResponse",
|
1257
1271
|
"ReferenceResponseDocType",
|
1258
|
-
"ReferenceResponseLink",
|
1259
|
-
"ReferenceResponseLinkTypedDict",
|
1260
1272
|
"ReferenceResponseSource",
|
1261
1273
|
"ReferenceResponseTypedDict",
|
1262
1274
|
"RejectGHSolutionRequest",
|
@@ -1265,12 +1277,10 @@ __all__ = [
|
|
1265
1277
|
"RelatedArticleForCreateUpdateDeleteSuggestionTypedDict",
|
1266
1278
|
"RelatedQuestions",
|
1267
1279
|
"RelatedQuestionsTypedDict",
|
1268
|
-
"
|
1280
|
+
"ResourceType",
|
1269
1281
|
"RestoreQuickpickRequest",
|
1270
1282
|
"RestoreQuickpickRequestTypedDict",
|
1271
1283
|
"ResultType",
|
1272
|
-
"Results",
|
1273
|
-
"ResultsTypedDict",
|
1274
1284
|
"RetrieveChunksRequest",
|
1275
1285
|
"RetrieveChunksRequestTypedDict",
|
1276
1286
|
"RetrieveRequest",
|
@@ -1316,8 +1326,6 @@ __all__ = [
|
|
1316
1326
|
"SearchPriorToEscalationRequestTypedDict",
|
1317
1327
|
"SearchResult",
|
1318
1328
|
"SearchResultDocType",
|
1319
|
-
"SearchResultLink",
|
1320
|
-
"SearchResultLinkTypedDict",
|
1321
1329
|
"SearchResultSource",
|
1322
1330
|
"SearchResultTypedDict",
|
1323
1331
|
"SearchResults",
|
@@ -1328,6 +1336,7 @@ __all__ = [
|
|
1328
1336
|
"SecurityTypedDict",
|
1329
1337
|
"SelectUserProfileRequest",
|
1330
1338
|
"SelectUserProfileRequestTypedDict",
|
1339
|
+
"ServiceUnavailableStatus",
|
1331
1340
|
"SessionContextVariable",
|
1332
1341
|
"SessionContextVariableTypedDict",
|
1333
1342
|
"ShortURL",
|
@@ -1355,6 +1364,7 @@ __all__ = [
|
|
1355
1364
|
"StartQuestionAndAnswerTypedDict",
|
1356
1365
|
"StepGHSearchRequest",
|
1357
1366
|
"StepGHSearchRequestTypedDict",
|
1367
|
+
"Storage",
|
1358
1368
|
"StringAttributeValue",
|
1359
1369
|
"StringAttributeValueTypedDict",
|
1360
1370
|
"StructuredAuthoringFields",
|
@@ -1387,8 +1397,6 @@ __all__ = [
|
|
1387
1397
|
"TagsTypedDict",
|
1388
1398
|
"ThresholdType",
|
1389
1399
|
"Topic",
|
1390
|
-
"TopicAISearchResult",
|
1391
|
-
"TopicAISearchResultTypedDict",
|
1392
1400
|
"TopicAdditionalAttributes",
|
1393
1401
|
"TopicBreadcrumb",
|
1394
1402
|
"TopicBreadcrumbTypedDict",
|
@@ -1401,6 +1409,7 @@ __all__ = [
|
|
1401
1409
|
"TopicTreeResult",
|
1402
1410
|
"TopicTreeResultTypedDict",
|
1403
1411
|
"TopicTypedDict",
|
1412
|
+
"TypeName",
|
1404
1413
|
"UnsubscribeArticleRequest",
|
1405
1414
|
"UnsubscribeArticleRequestTypedDict",
|
1406
1415
|
"UploadAttachmentRequest",
|
@@ -1476,8 +1485,6 @@ _dynamic_imports: dict[str, str] = {
|
|
1476
1485
|
"AnswersRequestChannelTypedDict": ".answersrequest",
|
1477
1486
|
"AnswersRequestType": ".answersrequest",
|
1478
1487
|
"AnswersRequestTypedDict": ".answersrequest",
|
1479
|
-
"Context": ".answersrequest",
|
1480
|
-
"ContextTypedDict": ".answersrequest",
|
1481
1488
|
"AnswersResponse": ".answersresponse",
|
1482
1489
|
"AnswersResponseAnswer": ".answersresponse",
|
1483
1490
|
"AnswersResponseAnswerType": ".answersresponse",
|
@@ -1502,12 +1509,9 @@ _dynamic_imports: dict[str, str] = {
|
|
1502
1509
|
"ArticleAISearchResultLinkTypedDict": ".articleaisearchresult",
|
1503
1510
|
"ArticleAISearchResultSource": ".articleaisearchresult",
|
1504
1511
|
"ArticleAISearchResultType": ".articleaisearchresult",
|
1505
|
-
"ArticleAISearchResultTypeName": ".articleaisearchresult",
|
1506
1512
|
"ArticleAISearchResultTypedDict": ".articleaisearchresult",
|
1507
1513
|
"ArticleTypeAttributes": ".articleaisearchresult",
|
1508
1514
|
"ArticleTypeAttributesTypedDict": ".articleaisearchresult",
|
1509
|
-
"OpensearchHighlightingRaw": ".articleaisearchresult",
|
1510
|
-
"OpensearchHighlightingRawTypedDict": ".articleaisearchresult",
|
1511
1515
|
"ArticleAttachment": ".articleattachment",
|
1512
1516
|
"ArticleAttachmentType": ".articleattachment",
|
1513
1517
|
"ArticleAttachmentTypedDict": ".articleattachment",
|
@@ -1539,8 +1543,8 @@ _dynamic_imports: dict[str, str] = {
|
|
1539
1543
|
"ArticleSort": ".articlesort",
|
1540
1544
|
"ArticleSortOrder": ".articlesortorder",
|
1541
1545
|
"ArticleType": ".articletype",
|
1542
|
-
"ArticleTypeTypeName": ".articletype",
|
1543
1546
|
"ArticleTypeTypedDict": ".articletype",
|
1547
|
+
"TypeName": ".articletype",
|
1544
1548
|
"ArticleWithEditions": ".articlewitheditions",
|
1545
1549
|
"ArticleWithEditionsTypedDict": ".articlewitheditions",
|
1546
1550
|
"Attachment": ".attachment",
|
@@ -1567,6 +1571,9 @@ _dynamic_imports: dict[str, str] = {
|
|
1567
1571
|
"BookmarkResultTypedDict": ".bookmarkresult",
|
1568
1572
|
"BookmarkStatus": ".bookmarkstatus",
|
1569
1573
|
"BookmarkStatusTypedDict": ".bookmarkstatus",
|
1574
|
+
"CANCEL_IMPORT_OP_SERVERS": ".cancelimportop",
|
1575
|
+
"CancelImportRequest": ".cancelimportop",
|
1576
|
+
"CancelImportRequestTypedDict": ".cancelimportop",
|
1570
1577
|
"Case": ".case",
|
1571
1578
|
"CaseType": ".case",
|
1572
1579
|
"CaseTypedDict": ".case",
|
@@ -1641,12 +1648,12 @@ _dynamic_imports: dict[str, str] = {
|
|
1641
1648
|
"ResultType": ".createfederatedsearchevent",
|
1642
1649
|
"CreateFederatedSearchResultEventRequest": ".createfederatedsearchresulteventop",
|
1643
1650
|
"CreateFederatedSearchResultEventRequestTypedDict": ".createfederatedsearchresulteventop",
|
1644
|
-
"
|
1645
|
-
"
|
1646
|
-
"
|
1647
|
-
"
|
1648
|
-
"
|
1649
|
-
"
|
1651
|
+
"CREATE_IMPORT_JOB_OP_SERVERS": ".createimportjobop",
|
1652
|
+
"CreateImportJobResponse": ".createimportjobop",
|
1653
|
+
"CreateImportJobResponseTypedDict": ".createimportjobop",
|
1654
|
+
"CREATE_IMPORT_VALIDATION_JOB_OP_SERVERS": ".createimportvalidationjobop",
|
1655
|
+
"CreateImportValidationJobResponse": ".createimportvalidationjobop",
|
1656
|
+
"CreateImportValidationJobResponseTypedDict": ".createimportvalidationjobop",
|
1650
1657
|
"CreateQuickpick": ".createquickpick",
|
1651
1658
|
"CreateQuickpickTypedDict": ".createquickpick",
|
1652
1659
|
"CreateQuickpickRequest": ".createquickpickop",
|
@@ -1700,12 +1707,12 @@ _dynamic_imports: dict[str, str] = {
|
|
1700
1707
|
"ExportContentResponse": ".exportcontentop",
|
1701
1708
|
"ExportContentResponseTypedDict": ".exportcontentop",
|
1702
1709
|
"ExportStatus": ".exportstatus",
|
1710
|
+
"ExportStatusProgress": ".exportstatus",
|
1711
|
+
"ExportStatusProgressTypedDict": ".exportstatus",
|
1712
|
+
"ExportStatusResults": ".exportstatus",
|
1713
|
+
"ExportStatusResultsTypedDict": ".exportstatus",
|
1703
1714
|
"ExportStatusStatus": ".exportstatus",
|
1704
1715
|
"ExportStatusTypedDict": ".exportstatus",
|
1705
|
-
"Progress": ".exportstatus",
|
1706
|
-
"ProgressTypedDict": ".exportstatus",
|
1707
|
-
"Results": ".exportstatus",
|
1708
|
-
"ResultsTypedDict": ".exportstatus",
|
1709
1716
|
"ExportStatusRequest": ".exportstatusop",
|
1710
1717
|
"ExportStatusRequestTypedDict": ".exportstatusop",
|
1711
1718
|
"FeedbackArticleForSuggestion": ".feedbackarticleforsuggestion",
|
@@ -1771,12 +1778,21 @@ _dynamic_imports: dict[str, str] = {
|
|
1771
1778
|
"GetchildtopicsRequestTypedDict": ".getchildtopicsop",
|
1772
1779
|
"GetClusterByCasebaseReleaseIDRequest": ".getclusterbycasebasereleaseidop",
|
1773
1780
|
"GetClusterByCasebaseReleaseIDRequestTypedDict": ".getclusterbycasebasereleaseidop",
|
1781
|
+
"Components": ".gethealthop",
|
1782
|
+
"ComponentsTypedDict": ".gethealthop",
|
1783
|
+
"Database": ".gethealthop",
|
1784
|
+
"ExternalServices": ".gethealthop",
|
1785
|
+
"FileSystem": ".gethealthop",
|
1774
1786
|
"GET_HEALTH_OP_SERVERS": ".gethealthop",
|
1775
1787
|
"GetHealthResponse": ".gethealthop",
|
1776
1788
|
"GetHealthResponseTypedDict": ".gethealthop",
|
1777
|
-
"
|
1778
|
-
"
|
1779
|
-
"
|
1789
|
+
"GetHealthStatus": ".gethealthop",
|
1790
|
+
"ProcessingEngine": ".gethealthop",
|
1791
|
+
"ServiceUnavailableStatus": ".gethealthop",
|
1792
|
+
"Storage": ".gethealthop",
|
1793
|
+
"GET_IMPORT_STATUS_OP_SERVERS": ".getimportstatusop",
|
1794
|
+
"GetImportStatusRequest": ".getimportstatusop",
|
1795
|
+
"GetImportStatusRequestTypedDict": ".getimportstatusop",
|
1780
1796
|
"GetMyPortalsRequest": ".getmyportalsop",
|
1781
1797
|
"GetMyPortalsRequestTypedDict": ".getmyportalsop",
|
1782
1798
|
"GetMySubscriptionRequest": ".getmysubscriptionop",
|
@@ -1826,8 +1842,13 @@ _dynamic_imports: dict[str, str] = {
|
|
1826
1842
|
"ScheduleTime": ".importcontent",
|
1827
1843
|
"ScheduleTimeTypedDict": ".importcontent",
|
1828
1844
|
"ImportStatus": ".importstatus",
|
1845
|
+
"ImportStatusProgress": ".importstatus",
|
1846
|
+
"ImportStatusProgressTypedDict": ".importstatus",
|
1847
|
+
"ImportStatusResults": ".importstatus",
|
1848
|
+
"ImportStatusResultsTypedDict": ".importstatus",
|
1829
1849
|
"ImportStatusStatus": ".importstatus",
|
1830
1850
|
"ImportStatusTypedDict": ".importstatus",
|
1851
|
+
"JobType": ".importstatus",
|
1831
1852
|
"KbLanguage": ".kblanguage",
|
1832
1853
|
"KbLanguageCode1": ".kblanguage",
|
1833
1854
|
"KbLanguageTypedDict": ".kblanguage",
|
@@ -1845,8 +1866,8 @@ _dynamic_imports: dict[str, str] = {
|
|
1845
1866
|
"KnowledgeExportCredentialsTypedDict": ".knowledgeexport",
|
1846
1867
|
"KnowledgeExportLanguage": ".knowledgeexport",
|
1847
1868
|
"KnowledgeExportLanguageTypedDict": ".knowledgeexport",
|
1848
|
-
"KnowledgeExportResourceType": ".knowledgeexport",
|
1849
1869
|
"KnowledgeExportTypedDict": ".knowledgeexport",
|
1870
|
+
"ResourceType": ".knowledgeexport",
|
1850
1871
|
"L10NString": ".l10nstring",
|
1851
1872
|
"L10NStringTypedDict": ".l10nstring",
|
1852
1873
|
"LanguageCode": ".languagecode",
|
@@ -1879,9 +1900,6 @@ _dynamic_imports: dict[str, str] = {
|
|
1879
1900
|
"OwnedByTypedDict": ".ownedby",
|
1880
1901
|
"PaginationInfo": ".paginationinfo",
|
1881
1902
|
"PaginationInfoTypedDict": ".paginationinfo",
|
1882
|
-
"PATCH_IMPORT_CONTENT_VALIDATION_OP_SERVERS": ".patchimportcontentvalidationop",
|
1883
|
-
"PatchImportContentValidationRequest": ".patchimportcontentvalidationop",
|
1884
|
-
"PatchImportContentValidationRequestTypedDict": ".patchimportcontentvalidationop",
|
1885
1903
|
"Filters": ".personalization",
|
1886
1904
|
"FiltersTypedDict": ".personalization",
|
1887
1905
|
"Personalization": ".personalization",
|
@@ -1925,15 +1943,12 @@ _dynamic_imports: dict[str, str] = {
|
|
1925
1943
|
"RateArticleRequestTypedDict": ".ratearticleop",
|
1926
1944
|
"ReferenceResponse": ".referenceresponse",
|
1927
1945
|
"ReferenceResponseDocType": ".referenceresponse",
|
1928
|
-
"ReferenceResponseLink": ".referenceresponse",
|
1929
|
-
"ReferenceResponseLinkTypedDict": ".referenceresponse",
|
1930
1946
|
"ReferenceResponseSource": ".referenceresponse",
|
1931
1947
|
"ReferenceResponseTypedDict": ".referenceresponse",
|
1932
1948
|
"RejectGHSolutionRequest": ".rejectghsolutionop",
|
1933
1949
|
"RejectGHSolutionRequestTypedDict": ".rejectghsolutionop",
|
1934
1950
|
"RelatedQuestions": ".relatedquestions",
|
1935
1951
|
"RelatedQuestionsTypedDict": ".relatedquestions",
|
1936
|
-
"ResourceTypeParameter": ".resourcetype_parameter",
|
1937
1952
|
"RestoreQuickpickRequest": ".restorequickpickop",
|
1938
1953
|
"RestoreQuickpickRequestTypedDict": ".restorequickpickop",
|
1939
1954
|
"RETRIEVE_CHUNKS_OP_SERVERS": ".retrievechunksop",
|
@@ -1984,8 +1999,6 @@ _dynamic_imports: dict[str, str] = {
|
|
1984
1999
|
"SearchPriorToEscalationRequestTypedDict": ".searchpriortoescalationop",
|
1985
2000
|
"SearchResult": ".searchresult",
|
1986
2001
|
"SearchResultDocType": ".searchresult",
|
1987
|
-
"SearchResultLink": ".searchresult",
|
1988
|
-
"SearchResultLinkTypedDict": ".searchresult",
|
1989
2002
|
"SearchResultSource": ".searchresult",
|
1990
2003
|
"SearchResultTypedDict": ".searchresult",
|
1991
2004
|
"SnippetType": ".searchresult",
|
@@ -2057,8 +2070,6 @@ _dynamic_imports: dict[str, str] = {
|
|
2057
2070
|
"Topic": ".topic",
|
2058
2071
|
"TopicTypedDict": ".topic",
|
2059
2072
|
"TopicAdditionalAttributes": ".topicadditionalattributes",
|
2060
|
-
"TopicAISearchResult": ".topicaisearchresult",
|
2061
|
-
"TopicAISearchResultTypedDict": ".topicaisearchresult",
|
2062
2073
|
"TopicBreadcrumb": ".topicbreadcrumb",
|
2063
2074
|
"TopicBreadcrumbTypedDict": ".topicbreadcrumb",
|
2064
2075
|
"TopicResult": ".topicresult",
|
@@ -2,7 +2,6 @@
|
|
2
2
|
|
3
3
|
from __future__ import annotations
|
4
4
|
from .languagecode_parameter import LanguageCodeParameter
|
5
|
-
from .resourcetype_parameter import ResourceTypeParameter
|
6
5
|
from egain_api_python.types import BaseModel
|
7
6
|
from egain_api_python.utils import FieldMetadata, PathParamMetadata, QueryParamMetadata
|
8
7
|
import pydantic
|
@@ -15,27 +14,21 @@ class AiSearchRequestTypedDict(TypedDict):
|
|
15
14
|
r"""The search query string. The string must be escaped as required by the URL syntax rules."""
|
16
15
|
portal_id: str
|
17
16
|
r"""The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
|
18
|
-
|
17
|
+
filter_user_profile_id: NotRequired[str]
|
19
18
|
r"""The ID of the user profile.
|
20
19
|
|
21
20
|
"""
|
22
21
|
language: NotRequired[LanguageCodeParameter]
|
23
22
|
r"""The language that describes the details of a resource. Resources available in different languages may differ from each other. <br><br> If lang is not passed, then the portal's default language is used."""
|
24
|
-
|
23
|
+
filter_tags: NotRequired[Dict[str, List[str]]]
|
25
24
|
r"""An object where each key is a **Category Tag ID** (numeric string),
|
26
25
|
and each value is an array of **Tag IDs** for that category.
|
27
26
|
|
28
27
|
"""
|
29
|
-
|
28
|
+
filter_topic_ids: NotRequired[List[str]]
|
30
29
|
r"""An array of topic IDs. It is used to restrict search results to specific topics."""
|
31
|
-
dollar_filter_exclude_topic_ids: NotRequired[List[str]]
|
32
|
-
r"""An array of topic IDs that will be excluded from the search. It includes articles that belong to the topic."""
|
33
|
-
resource_type: NotRequired[ResourceTypeParameter]
|
34
|
-
r"""Type of resource to be fetched."""
|
35
30
|
article_custom_additional_attributes: NotRequired[str]
|
36
31
|
r"""One or more comma-separated names for article custom attributes defined by the user to be returned."""
|
37
|
-
topic_custom_additional_attributes: NotRequired[str]
|
38
|
-
r"""One or more comma-separated names for topic custom attributes defined by the user to be returned."""
|
39
32
|
pagenum: NotRequired[int]
|
40
33
|
r"""Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize."""
|
41
34
|
pagesize: NotRequired[int]
|
@@ -55,7 +48,7 @@ class AiSearchRequest(BaseModel):
|
|
55
48
|
]
|
56
49
|
r"""The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
|
57
50
|
|
58
|
-
|
51
|
+
filter_user_profile_id: Annotated[
|
59
52
|
Optional[str],
|
60
53
|
pydantic.Field(alias="$filter[userProfileID]"),
|
61
54
|
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
@@ -71,7 +64,7 @@ class AiSearchRequest(BaseModel):
|
|
71
64
|
] = None
|
72
65
|
r"""The language that describes the details of a resource. Resources available in different languages may differ from each other. <br><br> If lang is not passed, then the portal's default language is used."""
|
73
66
|
|
74
|
-
|
67
|
+
filter_tags: Annotated[
|
75
68
|
Optional[Dict[str, List[str]]],
|
76
69
|
pydantic.Field(alias="$filter[tags]"),
|
77
70
|
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
@@ -81,27 +74,13 @@ class AiSearchRequest(BaseModel):
|
|
81
74
|
|
82
75
|
"""
|
83
76
|
|
84
|
-
|
77
|
+
filter_topic_ids: Annotated[
|
85
78
|
Optional[List[str]],
|
86
79
|
pydantic.Field(alias="$filter[topicIds]"),
|
87
80
|
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
88
81
|
] = None
|
89
82
|
r"""An array of topic IDs. It is used to restrict search results to specific topics."""
|
90
83
|
|
91
|
-
dollar_filter_exclude_topic_ids: Annotated[
|
92
|
-
Optional[List[str]],
|
93
|
-
pydantic.Field(alias="$filter[excludeTopicIds]"),
|
94
|
-
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
95
|
-
] = None
|
96
|
-
r"""An array of topic IDs that will be excluded from the search. It includes articles that belong to the topic."""
|
97
|
-
|
98
|
-
resource_type: Annotated[
|
99
|
-
Optional[ResourceTypeParameter],
|
100
|
-
pydantic.Field(alias="resourceType"),
|
101
|
-
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
102
|
-
] = None
|
103
|
-
r"""Type of resource to be fetched."""
|
104
|
-
|
105
84
|
article_custom_additional_attributes: Annotated[
|
106
85
|
Optional[str],
|
107
86
|
pydantic.Field(alias="articleCustomAdditionalAttributes"),
|
@@ -109,13 +88,6 @@ class AiSearchRequest(BaseModel):
|
|
109
88
|
] = None
|
110
89
|
r"""One or more comma-separated names for article custom attributes defined by the user to be returned."""
|
111
90
|
|
112
|
-
topic_custom_additional_attributes: Annotated[
|
113
|
-
Optional[str],
|
114
|
-
pydantic.Field(alias="topicCustomAdditionalAttributes"),
|
115
|
-
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
|
116
|
-
] = None
|
117
|
-
r"""One or more comma-separated names for topic custom attributes defined by the user to be returned."""
|
118
|
-
|
119
91
|
pagenum: Annotated[
|
120
92
|
Optional[int],
|
121
93
|
pydantic.Field(alias="$pagenum"),
|