egain-api-python 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

egain_api_python/models/__init__.py

@@ -82,7 +82,6 @@ if TYPE_CHECKING:
         ArticleAISearchResultLinkTypedDict,
         ArticleAISearchResultSource,
         ArticleAISearchResultType,
-        ArticleAISearchResultTypeName,
         ArticleAISearchResultTypedDict,
         ArticleTypeAttributes,
         ArticleTypeAttributesTypedDict,
@@ -122,7 +121,7 @@ if TYPE_CHECKING:
     )
     from .articlesort import ArticleSort
     from .articlesortorder import ArticleSortOrder
-    from .articletype import ArticleType, ArticleTypeTypeName, ArticleTypeTypedDict
+    from .articletype import ArticleType, ArticleTypeTypedDict, TypeName
     from .articlewitheditions import ArticleWithEditions, ArticleWithEditionsTypedDict
     from .attachment import Attachment, AttachmentTypedDict
     from .attachmentadditionalattributes import AttachmentAdditionalAttributes
@@ -302,12 +301,12 @@ if TYPE_CHECKING:
     from .exportcontentop import ExportContentResponse, ExportContentResponseTypedDict
     from .exportstatus import (
         ExportStatus,
+        ExportStatusProgress,
+        ExportStatusProgressTypedDict,
+        ExportStatusResults,
+        ExportStatusResultsTypedDict,
         ExportStatusStatus,
         ExportStatusTypedDict,
-        Progress,
-        ProgressTypedDict,
-        Results,
-        ResultsTypedDict,
     )
     from .exportstatusop import ExportStatusRequest, ExportStatusRequestTypedDict
     from .feedbackarticleforsuggestion import (
@@ -393,6 +392,11 @@ if TYPE_CHECKING:
         GetAttachmentByIDInPortalRequest,
         GetAttachmentByIDInPortalRequestTypedDict,
     )
+    from .getbestanswerop import (
+        GET_BEST_ANSWER_OP_SERVERS,
+        GetBestAnswerRequest,
+        GetBestAnswerRequestTypedDict,
+    )
     from .getbookmarkop import GetbookmarkRequest, GetbookmarkRequestTypedDict
     from .getcasebasereleasebyidop import (
         GetCasebaseReleaseByIDRequest,
@@ -405,9 +409,18 @@ if TYPE_CHECKING:
         GetClusterByCasebaseReleaseIDRequestTypedDict,
     )
     from .gethealthop import (
+        Components,
+        ComponentsTypedDict,
+        Database,
+        ExternalServices,
+        FileSystem,
         GET_HEALTH_OP_SERVERS,
         GetHealthResponse,
         GetHealthResponseTypedDict,
+        GetHealthStatus,
+        ProcessingEngine,
+        ServiceUnavailableStatus,
+        Storage,
     )
     from .getimportcontentop import (
         GET_IMPORT_CONTENT_OP_SERVERS,
@@ -481,7 +494,16 @@ if TYPE_CHECKING:
         ScheduleTime,
         ScheduleTimeTypedDict,
     )
-    from .importstatus import ImportStatus, ImportStatusStatus, ImportStatusTypedDict
+    from .importstatus import (
+        ImportStatus,
+        ImportStatusProgress,
+        ImportStatusProgressTypedDict,
+        ImportStatusResults,
+        ImportStatusResultsTypedDict,
+        ImportStatusStatus,
+        ImportStatusTypedDict,
+        JobType,
+    )
     from .kblanguage import KbLanguage, KbLanguageCode1, KbLanguageTypedDict, Name
     from .kblanguagecode import KbLanguageCode
     from .kblanguages import KbLanguages, KbLanguagesTypedDict
@@ -496,8 +518,8 @@ if TYPE_CHECKING:
         KnowledgeExportCredentialsTypedDict,
         KnowledgeExportLanguage,
         KnowledgeExportLanguageTypedDict,
-        KnowledgeExportResourceType,
         KnowledgeExportTypedDict,
+        ResourceType,
     )
     from .l10nstring import L10NString, L10NStringTypedDict
     from .languagecode import LanguageCode
@@ -548,16 +570,6 @@ if TYPE_CHECKING:
         PortalSettingsTypedDict,
         SearchLearningLevel,
     )
-    from .post_portalid_answersop import (
-        POST_PORTAL_ID_ANSWERS_OP_SERVERS,
-        PostPortalIDAnswersRequest,
-        PostPortalIDAnswersRequestTypedDict,
-    )
-    from .post_portalid_retrieveop import (
-        POST_PORTAL_ID_RETRIEVE_OP_SERVERS,
-        PostPortalIDRetrieveRequest,
-        PostPortalIDRetrieveRequestTypedDict,
-    )
     from .profile import Profile, ProfileTypedDict
     from .profileresult import ProfileResult, ProfileResultTypedDict
     from .publishprofile import PublishProfile, PublishProfileTypedDict
@@ -576,8 +588,6 @@ if TYPE_CHECKING:
     from .referenceresponse import (
         ReferenceResponse,
         ReferenceResponseDocType,
-        ReferenceResponseLink,
-        ReferenceResponseLinkTypedDict,
         ReferenceResponseSource,
         ReferenceResponseTypedDict,
     )
@@ -586,11 +596,15 @@ if TYPE_CHECKING:
         RejectGHSolutionRequestTypedDict,
     )
     from .relatedquestions import RelatedQuestions, RelatedQuestionsTypedDict
-    from .resourcetype_parameter import ResourceTypeParameter
     from .restorequickpickop import (
         RestoreQuickpickRequest,
         RestoreQuickpickRequestTypedDict,
     )
+    from .retrievechunksop import (
+        RETRIEVE_CHUNKS_OP_SERVERS,
+        RetrieveChunksRequest,
+        RetrieveChunksRequestTypedDict,
+    )
     from .retrieverequest import (
         RetrieveRequest,
         RetrieveRequestChannel,
@@ -644,8 +658,6 @@ if TYPE_CHECKING:
     from .searchresult import (
         SearchResult,
         SearchResultDocType,
-        SearchResultLink,
-        SearchResultLinkTypedDict,
         SearchResultSource,
         SearchResultTypedDict,
         SnippetType,
@@ -733,7 +745,6 @@ if TYPE_CHECKING:
     from .tags import Tags, TagsTypedDict
     from .topic import Topic, TopicTypedDict
     from .topicadditionalattributes import TopicAdditionalAttributes
-    from .topicaisearchresult import TopicAISearchResult, TopicAISearchResultTypedDict
     from .topicbreadcrumb import TopicBreadcrumb, TopicBreadcrumbTypedDict
     from .topicresult import TopicResult, TopicResultTypedDict
     from .topicsummary import TopicSummary, TopicSummaryTypedDict
@@ -826,7 +837,6 @@ __all__ = [
     "ArticleAISearchResultLinkTypedDict",
     "ArticleAISearchResultSource",
     "ArticleAISearchResultType",
-    "ArticleAISearchResultTypeName",
     "ArticleAISearchResultTypedDict",
     "ArticleActivityLink",
     "ArticleActivityLinkCode",
@@ -866,7 +876,6 @@ __all__ = [
     "ArticleType",
     "ArticleTypeAttributes",
     "ArticleTypeAttributesTypedDict",
-    "ArticleTypeTypeName",
     "ArticleTypeTypedDict",
     "ArticleTypedDict",
     "ArticleWithEditions",
@@ -945,12 +954,14 @@ __all__ = [
     "ComplianceForArticleTypedDict",
     "ComplyArticleRequest",
     "ComplyArticleRequestTypedDict",
+    "Components",
     "ComponentsSchemasTag",
     "ComponentsSchemasTagCategory",
     "ComponentsSchemasTagCategoryTypedDict",
     "ComponentsSchemasTagGroup",
     "ComponentsSchemasTagGroupTypedDict",
     "ComponentsSchemasTagTypedDict",
+    "ComponentsTypedDict",
     "ConfigurableAttribute",
     "ConfigurableAttributeTypedDict",
     "ConfigurableAttributes",
@@ -1003,6 +1014,7 @@ __all__ = [
     "CustomerTypedDict",
     "DataDestination",
     "DataDestinationTypedDict",
+    "Database",
     "DeleteSuggestionRequest",
     "DeleteSuggestionRequestTypedDict",
     "DeletebookmarkRequest",
@@ -1033,12 +1045,18 @@ __all__ = [
     "ExportContentResponse",
     "ExportContentResponseTypedDict",
     "ExportStatus",
+    "ExportStatusProgress",
+    "ExportStatusProgressTypedDict",
     "ExportStatusRequest",
     "ExportStatusRequestTypedDict",
+    "ExportStatusResults",
+    "ExportStatusResultsTypedDict",
     "ExportStatusStatus",
     "ExportStatusTypedDict",
+    "ExternalServices",
     "FeedbackArticleForSuggestion",
     "FeedbackArticleForSuggestionTypedDict",
+    "FileSystem",
     "FilterStatus",
     "Filters",
     "FiltersTypedDict",
@@ -1046,6 +1064,7 @@ __all__ = [
     "FolderBreadcrumbTypedDict",
     "FolderSummary",
     "FolderSummaryTypedDict",
+    "GET_BEST_ANSWER_OP_SERVERS",
     "GET_HEALTH_OP_SERVERS",
     "GET_IMPORT_CONTENT_OP_SERVERS",
     "GHSearchRequest",
@@ -1093,6 +1112,8 @@ __all__ = [
     "GetArticlesInTopicRequestTypedDict",
     "GetAttachmentByIDInPortalRequest",
     "GetAttachmentByIDInPortalRequestTypedDict",
+    "GetBestAnswerRequest",
+    "GetBestAnswerRequestTypedDict",
     "GetCaseByIDRequest",
     "GetCaseByIDRequestTypedDict",
     "GetCasebaseReleaseByIDRequest",
@@ -1101,6 +1122,7 @@ __all__ = [
     "GetClusterByCasebaseReleaseIDRequestTypedDict",
     "GetHealthResponse",
     "GetHealthResponseTypedDict",
+    "GetHealthStatus",
     "GetImportContentRequest",
     "GetImportContentRequestTypedDict",
     "GetMyPortalsRequest",
@@ -1151,8 +1173,13 @@ __all__ = [
     "ImportContentType",
     "ImportContentTypedDict",
     "ImportStatus",
+    "ImportStatusProgress",
+    "ImportStatusProgressTypedDict",
+    "ImportStatusResults",
+    "ImportStatusResultsTypedDict",
     "ImportStatusStatus",
     "ImportStatusTypedDict",
+    "JobType",
     "KbLanguage",
     "KbLanguageCode",
     "KbLanguageCode1",
@@ -1165,7 +1192,6 @@ __all__ = [
     "KnowledgeExportCredentialsTypedDict",
     "KnowledgeExportLanguage",
     "KnowledgeExportLanguageTypedDict",
-    "KnowledgeExportResourceType",
     "KnowledgeExportTypedDict",
     "L10NString",
     "L10NStringTypedDict",
@@ -1205,8 +1231,6 @@ __all__ = [
     "OwnedBy",
     "OwnedByTypedDict",
     "PATCH_IMPORT_CONTENT_VALIDATION_OP_SERVERS",
-    "POST_PORTAL_ID_ANSWERS_OP_SERVERS",
-    "POST_PORTAL_ID_RETRIEVE_OP_SERVERS",
     "PaginationInfo",
     "PaginationInfoTypedDict",
     "PatchImportContentValidationRequest",
@@ -1223,16 +1247,11 @@ __all__ = [
     "PortalSettings",
     "PortalSettingsTypedDict",
     "PortalTypedDict",
-    "PostPortalIDAnswersRequest",
-    "PostPortalIDAnswersRequestTypedDict",
-    "PostPortalIDRetrieveRequest",
-    "PostPortalIDRetrieveRequestTypedDict",
+    "ProcessingEngine",
     "Profile",
     "ProfileResult",
     "ProfileResultTypedDict",
     "ProfileTypedDict",
-    "Progress",
-    "ProgressTypedDict",
     "PublishProfile",
     "PublishProfileTypedDict",
     "PublishView",
@@ -1253,12 +1272,11 @@ __all__ = [
     "QuickpickResultTypedDict",
     "QuickpickResults",
     "QuickpickResultsTypedDict",
+    "RETRIEVE_CHUNKS_OP_SERVERS",
     "RateArticleRequest",
     "RateArticleRequestTypedDict",
     "ReferenceResponse",
     "ReferenceResponseDocType",
-    "ReferenceResponseLink",
-    "ReferenceResponseLinkTypedDict",
     "ReferenceResponseSource",
     "ReferenceResponseTypedDict",
     "RejectGHSolutionRequest",
@@ -1267,12 +1285,12 @@ __all__ = [
     "RelatedArticleForCreateUpdateDeleteSuggestionTypedDict",
     "RelatedQuestions",
     "RelatedQuestionsTypedDict",
-    "ResourceTypeParameter",
+    "ResourceType",
     "RestoreQuickpickRequest",
     "RestoreQuickpickRequestTypedDict",
     "ResultType",
-    "Results",
-    "ResultsTypedDict",
+    "RetrieveChunksRequest",
+    "RetrieveChunksRequestTypedDict",
     "RetrieveRequest",
     "RetrieveRequestChannel",
     "RetrieveRequestChannelTypedDict",
@@ -1316,8 +1334,6 @@ __all__ = [
     "SearchPriorToEscalationRequestTypedDict",
     "SearchResult",
     "SearchResultDocType",
-    "SearchResultLink",
-    "SearchResultLinkTypedDict",
     "SearchResultSource",
     "SearchResultTypedDict",
     "SearchResults",
@@ -1328,6 +1344,7 @@ __all__ = [
     "SecurityTypedDict",
     "SelectUserProfileRequest",
     "SelectUserProfileRequestTypedDict",
+    "ServiceUnavailableStatus",
     "SessionContextVariable",
     "SessionContextVariableTypedDict",
     "ShortURL",
@@ -1355,6 +1372,7 @@ __all__ = [
     "StartQuestionAndAnswerTypedDict",
     "StepGHSearchRequest",
     "StepGHSearchRequestTypedDict",
+    "Storage",
     "StringAttributeValue",
     "StringAttributeValueTypedDict",
     "StructuredAuthoringFields",
@@ -1387,8 +1405,6 @@ __all__ = [
     "TagsTypedDict",
     "ThresholdType",
     "Topic",
-    "TopicAISearchResult",
-    "TopicAISearchResultTypedDict",
     "TopicAdditionalAttributes",
     "TopicBreadcrumb",
     "TopicBreadcrumbTypedDict",
@@ -1401,6 +1417,7 @@ __all__ = [
     "TopicTreeResult",
     "TopicTreeResultTypedDict",
     "TopicTypedDict",
+    "TypeName",
     "UnsubscribeArticleRequest",
     "UnsubscribeArticleRequestTypedDict",
     "UploadAttachmentRequest",
@@ -1502,7 +1519,6 @@ _dynamic_imports: dict[str, str] = {
     "ArticleAISearchResultLinkTypedDict": ".articleaisearchresult",
     "ArticleAISearchResultSource": ".articleaisearchresult",
     "ArticleAISearchResultType": ".articleaisearchresult",
-    "ArticleAISearchResultTypeName": ".articleaisearchresult",
     "ArticleAISearchResultTypedDict": ".articleaisearchresult",
     "ArticleTypeAttributes": ".articleaisearchresult",
     "ArticleTypeAttributesTypedDict": ".articleaisearchresult",
@@ -1539,8 +1555,8 @@ _dynamic_imports: dict[str, str] = {
     "ArticleSort": ".articlesort",
     "ArticleSortOrder": ".articlesortorder",
     "ArticleType": ".articletype",
-    "ArticleTypeTypeName": ".articletype",
     "ArticleTypeTypedDict": ".articletype",
+    "TypeName": ".articletype",
     "ArticleWithEditions": ".articlewitheditions",
     "ArticleWithEditionsTypedDict": ".articlewitheditions",
     "Attachment": ".attachment",
@@ -1700,12 +1716,12 @@ _dynamic_imports: dict[str, str] = {
     "ExportContentResponse": ".exportcontentop",
     "ExportContentResponseTypedDict": ".exportcontentop",
     "ExportStatus": ".exportstatus",
+    "ExportStatusProgress": ".exportstatus",
+    "ExportStatusProgressTypedDict": ".exportstatus",
+    "ExportStatusResults": ".exportstatus",
+    "ExportStatusResultsTypedDict": ".exportstatus",
     "ExportStatusStatus": ".exportstatus",
     "ExportStatusTypedDict": ".exportstatus",
-    "Progress": ".exportstatus",
-    "ProgressTypedDict": ".exportstatus",
-    "Results": ".exportstatus",
-    "ResultsTypedDict": ".exportstatus",
     "ExportStatusRequest": ".exportstatusop",
     "ExportStatusRequestTypedDict": ".exportstatusop",
     "FeedbackArticleForSuggestion": ".feedbackarticleforsuggestion",
@@ -1758,6 +1774,9 @@ _dynamic_imports: dict[str, str] = {
     "GetArticlesInTopicRequestTypedDict": ".getarticlesintopicop",
     "GetAttachmentByIDInPortalRequest": ".getattachmentbyidinportalop",
     "GetAttachmentByIDInPortalRequestTypedDict": ".getattachmentbyidinportalop",
+    "GET_BEST_ANSWER_OP_SERVERS": ".getbestanswerop",
+    "GetBestAnswerRequest": ".getbestanswerop",
+    "GetBestAnswerRequestTypedDict": ".getbestanswerop",
     "GetbookmarkRequest": ".getbookmarkop",
     "GetbookmarkRequestTypedDict": ".getbookmarkop",
     "GetCasebaseReleaseByIDRequest": ".getcasebasereleasebyidop",
@@ -1768,9 +1787,18 @@ _dynamic_imports: dict[str, str] = {
     "GetchildtopicsRequestTypedDict": ".getchildtopicsop",
     "GetClusterByCasebaseReleaseIDRequest": ".getclusterbycasebasereleaseidop",
     "GetClusterByCasebaseReleaseIDRequestTypedDict": ".getclusterbycasebasereleaseidop",
+    "Components": ".gethealthop",
+    "ComponentsTypedDict": ".gethealthop",
+    "Database": ".gethealthop",
+    "ExternalServices": ".gethealthop",
+    "FileSystem": ".gethealthop",
     "GET_HEALTH_OP_SERVERS": ".gethealthop",
     "GetHealthResponse": ".gethealthop",
     "GetHealthResponseTypedDict": ".gethealthop",
+    "GetHealthStatus": ".gethealthop",
+    "ProcessingEngine": ".gethealthop",
+    "ServiceUnavailableStatus": ".gethealthop",
+    "Storage": ".gethealthop",
     "GET_IMPORT_CONTENT_OP_SERVERS": ".getimportcontentop",
     "GetImportContentRequest": ".getimportcontentop",
     "GetImportContentRequestTypedDict": ".getimportcontentop",
@@ -1823,8 +1851,13 @@ _dynamic_imports: dict[str, str] = {
     "ScheduleTime": ".importcontent",
     "ScheduleTimeTypedDict": ".importcontent",
     "ImportStatus": ".importstatus",
+    "ImportStatusProgress": ".importstatus",
+    "ImportStatusProgressTypedDict": ".importstatus",
+    "ImportStatusResults": ".importstatus",
+    "ImportStatusResultsTypedDict": ".importstatus",
     "ImportStatusStatus": ".importstatus",
     "ImportStatusTypedDict": ".importstatus",
+    "JobType": ".importstatus",
     "KbLanguage": ".kblanguage",
     "KbLanguageCode1": ".kblanguage",
     "KbLanguageTypedDict": ".kblanguage",
@@ -1842,8 +1875,8 @@ _dynamic_imports: dict[str, str] = {
     "KnowledgeExportCredentialsTypedDict": ".knowledgeexport",
     "KnowledgeExportLanguage": ".knowledgeexport",
     "KnowledgeExportLanguageTypedDict": ".knowledgeexport",
-    "KnowledgeExportResourceType": ".knowledgeexport",
     "KnowledgeExportTypedDict": ".knowledgeexport",
+    "ResourceType": ".knowledgeexport",
     "L10NString": ".l10nstring",
     "L10NStringTypedDict": ".l10nstring",
     "LanguageCode": ".languagecode",
@@ -1896,12 +1929,6 @@ _dynamic_imports: dict[str, str] = {
     "PortalSettings": ".portalsettings",
     "PortalSettingsTypedDict": ".portalsettings",
     "SearchLearningLevel": ".portalsettings",
-    "POST_PORTAL_ID_ANSWERS_OP_SERVERS": ".post_portalid_answersop",
-    "PostPortalIDAnswersRequest": ".post_portalid_answersop",
-    "PostPortalIDAnswersRequestTypedDict": ".post_portalid_answersop",
-    "POST_PORTAL_ID_RETRIEVE_OP_SERVERS": ".post_portalid_retrieveop",
-    "PostPortalIDRetrieveRequest": ".post_portalid_retrieveop",
-    "PostPortalIDRetrieveRequestTypedDict": ".post_portalid_retrieveop",
     "Profile": ".profile",
     "ProfileTypedDict": ".profile",
     "ProfileResult": ".profileresult",
@@ -1928,17 +1955,17 @@ _dynamic_imports: dict[str, str] = {
     "RateArticleRequestTypedDict": ".ratearticleop",
     "ReferenceResponse": ".referenceresponse",
     "ReferenceResponseDocType": ".referenceresponse",
-    "ReferenceResponseLink": ".referenceresponse",
-    "ReferenceResponseLinkTypedDict": ".referenceresponse",
     "ReferenceResponseSource": ".referenceresponse",
     "ReferenceResponseTypedDict": ".referenceresponse",
     "RejectGHSolutionRequest": ".rejectghsolutionop",
     "RejectGHSolutionRequestTypedDict": ".rejectghsolutionop",
     "RelatedQuestions": ".relatedquestions",
     "RelatedQuestionsTypedDict": ".relatedquestions",
-    "ResourceTypeParameter": ".resourcetype_parameter",
     "RestoreQuickpickRequest": ".restorequickpickop",
     "RestoreQuickpickRequestTypedDict": ".restorequickpickop",
+    "RETRIEVE_CHUNKS_OP_SERVERS": ".retrievechunksop",
+    "RetrieveChunksRequest": ".retrievechunksop",
+    "RetrieveChunksRequestTypedDict": ".retrievechunksop",
     "RetrieveRequest": ".retrieverequest",
     "RetrieveRequestChannel": ".retrieverequest",
     "RetrieveRequestChannelTypedDict": ".retrieverequest",
@@ -1984,8 +2011,6 @@ _dynamic_imports: dict[str, str] = {
     "SearchPriorToEscalationRequestTypedDict": ".searchpriortoescalationop",
     "SearchResult": ".searchresult",
     "SearchResultDocType": ".searchresult",
-    "SearchResultLink": ".searchresult",
-    "SearchResultLinkTypedDict": ".searchresult",
     "SearchResultSource": ".searchresult",
     "SearchResultTypedDict": ".searchresult",
     "SnippetType": ".searchresult",
@@ -2057,8 +2082,6 @@ _dynamic_imports: dict[str, str] = {
     "Topic": ".topic",
     "TopicTypedDict": ".topic",
     "TopicAdditionalAttributes": ".topicadditionalattributes",
-    "TopicAISearchResult": ".topicaisearchresult",
-    "TopicAISearchResultTypedDict": ".topicaisearchresult",
     "TopicBreadcrumb": ".topicbreadcrumb",
     "TopicBreadcrumbTypedDict": ".topicbreadcrumb",
     "TopicResult": ".topicresult",

egain_api_python/models/aisearchop.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 from .languagecode_parameter import LanguageCodeParameter
-from .resourcetype_parameter import ResourceTypeParameter
 from egain_api_python.types import BaseModel
 from egain_api_python.utils import FieldMetadata, PathParamMetadata, QueryParamMetadata
 import pydantic
@@ -15,27 +14,21 @@ class AiSearchRequestTypedDict(TypedDict):
     r"""The search query string. The string must be escaped as required by the URL syntax rules."""
     portal_id: str
     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."""
-    dollar_filter_user_profile_id: NotRequired[str]
+    filter_user_profile_id: NotRequired[str]
     r"""The ID of the user profile.
 
     """
     language: NotRequired[LanguageCodeParameter]
     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."""
-    dollar_filter_tags: NotRequired[Dict[str, List[str]]]
+    filter_tags: NotRequired[Dict[str, List[str]]]
     r"""An object where each key is a **Category Tag ID** (numeric string),
     and each value is an array of **Tag IDs** for that category.
 
     """
-    dollar_filter_topic_ids: NotRequired[List[str]]
+    filter_topic_ids: NotRequired[List[str]]
     r"""An array of topic IDs. It is used to restrict search results to specific topics."""
-    dollar_filter_exclude_topic_ids: NotRequired[List[str]]
-    r"""An array of topic IDs that will be excluded from the search. It includes articles that belong to the topic."""
-    resource_type: NotRequired[ResourceTypeParameter]
-    r"""Type of resource to be fetched."""
     article_custom_additional_attributes: NotRequired[str]
     r"""One or more comma-separated names for article custom attributes defined by the user to be returned."""
-    topic_custom_additional_attributes: NotRequired[str]
-    r"""One or more comma-separated names for topic custom attributes defined by the user to be returned."""
     pagenum: NotRequired[int]
     r"""Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize."""
     pagesize: NotRequired[int]
@@ -55,7 +48,7 @@ class AiSearchRequest(BaseModel):
     ]
     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."""
 
-    dollar_filter_user_profile_id: Annotated[
+    filter_user_profile_id: Annotated[
         Optional[str],
         pydantic.Field(alias="$filter[userProfileID]"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -71,7 +64,7 @@ class AiSearchRequest(BaseModel):
     ] = None
     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."""
 
-    dollar_filter_tags: Annotated[
+    filter_tags: Annotated[
         Optional[Dict[str, List[str]]],
         pydantic.Field(alias="$filter[tags]"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -81,27 +74,13 @@ class AiSearchRequest(BaseModel):
 
     """
 
-    dollar_filter_topic_ids: Annotated[
+    filter_topic_ids: Annotated[
         Optional[List[str]],
         pydantic.Field(alias="$filter[topicIds]"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
     r"""An array of topic IDs. It is used to restrict search results to specific topics."""
 
-    dollar_filter_exclude_topic_ids: Annotated[
-        Optional[List[str]],
-        pydantic.Field(alias="$filter[excludeTopicIds]"),
-        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
-    ] = None
-    r"""An array of topic IDs that will be excluded from the search. It includes articles that belong to the topic."""
-
-    resource_type: Annotated[
-        Optional[ResourceTypeParameter],
-        pydantic.Field(alias="resourceType"),
-        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
-    ] = None
-    r"""Type of resource to be fetched."""
-
     article_custom_additional_attributes: Annotated[
         Optional[str],
         pydantic.Field(alias="articleCustomAdditionalAttributes"),
@@ -109,13 +88,6 @@ class AiSearchRequest(BaseModel):
     ] = None
     r"""One or more comma-separated names for article custom attributes defined by the user to be returned."""
 
-    topic_custom_additional_attributes: Annotated[
-        Optional[str],
-        pydantic.Field(alias="topicCustomAdditionalAttributes"),
-        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
-    ] = None
-    r"""One or more comma-separated names for topic custom attributes defined by the user to be returned."""
-
     pagenum: Annotated[
         Optional[int],
         pydantic.Field(alias="$pagenum"),

egain_api_python/models/aisearchresponse.py

@@ -3,7 +3,6 @@
 from __future__ import annotations
 from .articleaisearchresult import ArticleAISearchResult, ArticleAISearchResultTypedDict
 from .paginationinfo import PaginationInfo, PaginationInfoTypedDict
-from .topicaisearchresult import TopicAISearchResult, TopicAISearchResultTypedDict
 from egain_api_python.types import BaseModel
 import pydantic
 from typing import List, Literal, Optional
@@ -36,7 +35,6 @@ class SearchResultsTypedDict(TypedDict):
     r"""Top search results with relevance scores"""
 
     article: NotRequired[List[ArticleAISearchResultTypedDict]]
-    topic: NotRequired[List[TopicAISearchResultTypedDict]]
 
 
 class SearchResults(BaseModel):
@@ -44,8 +42,6 @@ class SearchResults(BaseModel):
 
     article: Optional[List[ArticleAISearchResult]] = None
 
-    topic: Optional[List[TopicAISearchResult]] = None
-
 
 class AISearchResponseTypedDict(TypedDict):
     channel: NotRequired[AISearchResponseChannelTypedDict]

egain_api_python/models/articleaisearchresult.py

@@ -6,7 +6,7 @@ from .schemas_tags import SchemasTags, SchemasTagsTypedDict
 from .topicbreadcrumb import TopicBreadcrumb, TopicBreadcrumbTypedDict
 from egain_api_python.types import BaseModel
 import pydantic
-from typing import List, Literal, Optional
+from typing import Any, List, Literal, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
@@ -68,33 +68,26 @@ class OpensearchHighlightingRaw(BaseModel):
     ] = None
 
 
-ArticleAISearchResultTypeName = Literal[
-    "General",
-    "Guided Help",
-    "Data Link",
-    "Topic Home",
-    "Suggestion",
-    "Virtaul Assistant Action",
-    "Rich Message",
-]
-r"""Indicates the article category name."""
-
-
 class ArticleTypeAttributesTypedDict(TypedDict):
-    r"""The type of the Article."""
+    r"""The type of the Article and its attributes."""
 
-    type_name: NotRequired[ArticleAISearchResultTypeName]
+    type_name: NotRequired[str]
     r"""Indicates the article category name."""
+    article_type_id: NotRequired[Any]
+    r"""The ID of the Article Type."""
 
 
 class ArticleTypeAttributes(BaseModel):
-    r"""The type of the Article."""
+    r"""The type of the Article and its attributes."""
 
-    type_name: Annotated[
-        Optional[ArticleAISearchResultTypeName], pydantic.Field(alias="typeName")
-    ] = None
+    type_name: Annotated[Optional[str], pydantic.Field(alias="typeName")] = None
     r"""Indicates the article category name."""
 
+    article_type_id: Annotated[Optional[Any], pydantic.Field(alias="articleTypeId")] = (
+        None
+    )
+    r"""The ID of the Article Type."""
+
 
 class ArticleAISearchResultLinkTypedDict(TypedDict):
     r"""Defines the relationship between this resource and another object."""
@@ -158,7 +151,7 @@ class ArticleAISearchResultTypedDict(TypedDict):
     r"""An array of tag categories. Note that the total number of tag categories cannot exceed 20."""
     keywords: NotRequired[str]
     article_type_attributes: NotRequired[ArticleTypeAttributesTypedDict]
-    r"""The type of the Article."""
+    r"""The type of the Article and its attributes."""
     link: NotRequired[ArticleAISearchResultLinkTypedDict]
     r"""Defines the relationship between this resource and another object."""
 
@@ -248,7 +241,7 @@ class ArticleAISearchResult(BaseModel):
     article_type_attributes: Annotated[
         Optional[ArticleTypeAttributes], pydantic.Field(alias="articleTypeAttributes")
     ] = None
-    r"""The type of the Article."""
+    r"""The type of the Article and its attributes."""
 
     link: Optional[ArticleAISearchResultLink] = None
     r"""Defines the relationship between this resource and another object."""