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

egain_api_python/import_.py

@@ -10,7 +10,7 @@ from typing import Any, Mapping, Optional, Union
 
 
 class Import(BaseSDK):
-    def create_import(
+    def create_import_job(
         self,
         *,
         data_source: Union[
@@ -24,13 +24,16 @@ class Import(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CreateImportResponse:
-        r"""Import content from external sources
+    ) -> models.CreateImportJobResponse:
+        r"""Import content from external sources by creating an import job
 
         # Import Content
 
         ## Overview
-        This API initiates a bulk content import operation from Amazon S3 buckets. It creates an asynchronous import job that processes content in the background, allowing you to import large volumes of content without blocking your application.
+        This API initiates a bulk content import operation from Data Sources. It creates an asynchronous import job that processes content in the background, allowing you to import large volumes of content without blocking your application.
+
+        ## Pre-requisties
+        1. Content in Data Source needs to be in this format: [Guide to Data Import Format](../../../../../developer-portal/guides/ingestion/data-import-format-guide.md)
 
         ## How It Works
         1. **Job Creation**: The API creates an import job and returns a unique job ID
@@ -73,10 +76,7 @@ class Import(BaseSDK):
         if server_url is not None:
             base_url = server_url
         else:
-            base_url = models.CREATE_IMPORT_OP_SERVERS[0]
-            url_variables = {
-                "API_DOMAIN": "api.egain.cloud",
-            }
+            base_url = models.CREATE_IMPORT_JOB_OP_SERVERS[0]
 
         request = models.ImportContent(
             data_source=utils.get_pydantic_model(
@@ -119,8 +119,8 @@ class Import(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="createImport",
-                oauth2_scopes=[],
+                operation_id="createImportJob",
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -132,7 +132,7 @@ class Import(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "202", "*"):
-            return models.CreateImportResponse(
+            return models.CreateImportJobResponse(
                 headers=utils.get_response_headers(http_res.headers)
             )
         if utils.match_response(
@@ -161,7 +161,7 @@ class Import(BaseSDK):
 
         raise errors.EgainDefaultError("Unexpected response received", http_res)
 
-    async def create_import_async(
+    async def create_import_job_async(
         self,
         *,
         data_source: Union[
@@ -175,13 +175,16 @@ class Import(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CreateImportResponse:
-        r"""Import content from external sources
+    ) -> models.CreateImportJobResponse:
+        r"""Import content from external sources by creating an import job
 
         # Import Content
 
         ## Overview
-        This API initiates a bulk content import operation from Amazon S3 buckets. It creates an asynchronous import job that processes content in the background, allowing you to import large volumes of content without blocking your application.
+        This API initiates a bulk content import operation from Data Sources. It creates an asynchronous import job that processes content in the background, allowing you to import large volumes of content without blocking your application.
+
+        ## Pre-requisties
+        1. Content in Data Source needs to be in this format: [Guide to Data Import Format](../../../../../developer-portal/guides/ingestion/data-import-format-guide.md)
 
         ## How It Works
         1. **Job Creation**: The API creates an import job and returns a unique job ID
@@ -224,10 +227,7 @@ class Import(BaseSDK):
         if server_url is not None:
             base_url = server_url
         else:
-            base_url = models.CREATE_IMPORT_OP_SERVERS[0]
-            url_variables = {
-                "API_DOMAIN": "api.egain.cloud",
-            }
+            base_url = models.CREATE_IMPORT_JOB_OP_SERVERS[0]
 
         request = models.ImportContent(
             data_source=utils.get_pydantic_model(
@@ -270,8 +270,8 @@ class Import(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="createImport",
-                oauth2_scopes=[],
+                operation_id="createImportJob",
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -283,7 +283,7 @@ class Import(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "202", "*"):
-            return models.CreateImportResponse(
+            return models.CreateImportJobResponse(
                 headers=utils.get_response_headers(http_res.headers)
             )
         if utils.match_response(
@@ -312,7 +312,7 @@ class Import(BaseSDK):
 
         raise errors.EgainDefaultError("Unexpected response received", http_res)
 
-    def get_import_content(
+    def get_import_status(
         self,
         *,
         job_id: str,
@@ -369,12 +369,9 @@ class Import(BaseSDK):
         if server_url is not None:
             base_url = server_url
         else:
-            base_url = models.GET_IMPORT_CONTENT_OP_SERVERS[0]
-            url_variables = {
-                "API_DOMAIN": "api.egain.cloud",
-            }
+            base_url = models.GET_IMPORT_STATUS_OP_SERVERS[0]
 
-        request = models.GetImportContentRequest(
+        request = models.GetImportStatusRequest(
             job_id=job_id,
         )
 
@@ -406,8 +403,8 @@ class Import(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="getImportContent",
-                oauth2_scopes=[],
+                operation_id="getImportStatus",
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -441,7 +438,7 @@ class Import(BaseSDK):
 
         raise errors.EgainDefaultError("Unexpected response received", http_res)
 
-    async def get_import_content_async(
+    async def get_import_status_async(
         self,
         *,
         job_id: str,
@@ -498,12 +495,9 @@ class Import(BaseSDK):
         if server_url is not None:
             base_url = server_url
         else:
-            base_url = models.GET_IMPORT_CONTENT_OP_SERVERS[0]
-            url_variables = {
-                "API_DOMAIN": "api.egain.cloud",
-            }
+            base_url = models.GET_IMPORT_STATUS_OP_SERVERS[0]
 
-        request = models.GetImportContentRequest(
+        request = models.GetImportStatusRequest(
             job_id=job_id,
         )
 
@@ -535,8 +529,8 @@ class Import(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="getImportContent",
-                oauth2_scopes=[],
+                operation_id="getImportStatus",
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -570,7 +564,7 @@ class Import(BaseSDK):
 
         raise errors.EgainDefaultError("Unexpected response received", http_res)
 
-    def create_import_validation(
+    def create_import_validation_job(
         self,
         *,
         data_source: Union[
@@ -581,8 +575,8 @@ class Import(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CreateImportValidationResponse:
-        r"""Validate content structure and format before import
+    ) -> models.CreateImportValidationJobResponse:
+        r"""Validate content structure and format before import by creating an import validation job
 
         # Validate Import Content
 
@@ -641,10 +635,7 @@ class Import(BaseSDK):
         if server_url is not None:
             base_url = server_url
         else:
-            base_url = models.CREATE_IMPORT_VALIDATION_OP_SERVERS[0]
-            url_variables = {
-                "API_DOMAIN": "api.egain.cloud",
-            }
+            base_url = models.CREATE_IMPORT_VALIDATION_JOB_OP_SERVERS[0]
 
         request = models.ValidateImportContent(
             data_source=utils.get_pydantic_model(
@@ -683,8 +674,8 @@ class Import(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="createImportValidation",
-                oauth2_scopes=[],
+                operation_id="createImportValidationJob",
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -696,7 +687,7 @@ class Import(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "202", "*"):
-            return models.CreateImportValidationResponse(
+            return models.CreateImportValidationJobResponse(
                 headers=utils.get_response_headers(http_res.headers)
             )
         if utils.match_response(
@@ -725,7 +716,7 @@ class Import(BaseSDK):
 
         raise errors.EgainDefaultError("Unexpected response received", http_res)
 
-    async def create_import_validation_async(
+    async def create_import_validation_job_async(
         self,
         *,
         data_source: Union[
@@ -736,8 +727,8 @@ class Import(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CreateImportValidationResponse:
-        r"""Validate content structure and format before import
+    ) -> models.CreateImportValidationJobResponse:
+        r"""Validate content structure and format before import by creating an import validation job
 
         # Validate Import Content
 
@@ -796,10 +787,7 @@ class Import(BaseSDK):
         if server_url is not None:
             base_url = server_url
         else:
-            base_url = models.CREATE_IMPORT_VALIDATION_OP_SERVERS[0]
-            url_variables = {
-                "API_DOMAIN": "api.egain.cloud",
-            }
+            base_url = models.CREATE_IMPORT_VALIDATION_JOB_OP_SERVERS[0]
 
         request = models.ValidateImportContent(
             data_source=utils.get_pydantic_model(
@@ -838,8 +826,8 @@ class Import(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="createImportValidation",
-                oauth2_scopes=[],
+                operation_id="createImportValidationJob",
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -851,7 +839,7 @@ class Import(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "202", "*"):
-            return models.CreateImportValidationResponse(
+            return models.CreateImportValidationJobResponse(
                 headers=utils.get_response_headers(http_res.headers)
             )
         if utils.match_response(
@@ -880,7 +868,7 @@ class Import(BaseSDK):
 
         raise errors.EgainDefaultError("Unexpected response received", http_res)
 
-    def patch_import_content_validation(
+    def cancel_import(
         self,
         *,
         job_id: str,
@@ -948,12 +936,9 @@ class Import(BaseSDK):
         if server_url is not None:
             base_url = server_url
         else:
-            base_url = models.PATCH_IMPORT_CONTENT_VALIDATION_OP_SERVERS[0]
-            url_variables = {
-                "API_DOMAIN": "api.egain.cloud",
-            }
+            base_url = models.CANCEL_IMPORT_OP_SERVERS[0]
 
-        request = models.PatchImportContentValidationRequest(
+        request = models.CancelImportRequest(
             job_id=job_id,
         )
 
@@ -985,8 +970,8 @@ class Import(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="patchImportContentValidation",
-                oauth2_scopes=[],
+                operation_id="cancelImport",
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -1020,7 +1005,7 @@ class Import(BaseSDK):
 
         raise errors.EgainDefaultError("Unexpected response received", http_res)
 
-    async def patch_import_content_validation_async(
+    async def cancel_import_async(
         self,
         *,
         job_id: str,
@@ -1088,12 +1073,9 @@ class Import(BaseSDK):
         if server_url is not None:
             base_url = server_url
         else:
-            base_url = models.PATCH_IMPORT_CONTENT_VALIDATION_OP_SERVERS[0]
-            url_variables = {
-                "API_DOMAIN": "api.egain.cloud",
-            }
+            base_url = models.CANCEL_IMPORT_OP_SERVERS[0]
 
-        request = models.PatchImportContentValidationRequest(
+        request = models.CancelImportRequest(
             job_id=job_id,
         )
 
@@ -1125,8 +1107,8 @@ class Import(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="patchImportContentValidation",
-                oauth2_scopes=[],
+                operation_id="cancelImport",
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),

egain_api_python/models/__init__.py

@@ -51,8 +51,6 @@ if TYPE_CHECKING:
         AnswersRequestChannelTypedDict,
         AnswersRequestType,
         AnswersRequestTypedDict,
-        Context,
-        ContextTypedDict,
     )
     from .answersresponse import (
         AnswersResponse,
@@ -85,8 +83,6 @@ if TYPE_CHECKING:
         ArticleAISearchResultTypedDict,
         ArticleTypeAttributes,
         ArticleTypeAttributesTypedDict,
-        OpensearchHighlightingRaw,
-        OpensearchHighlightingRawTypedDict,
     )
     from .articleattachment import (
         ArticleAttachment,
@@ -148,6 +144,11 @@ if TYPE_CHECKING:
     from .bookmark import Bookmark, BookmarkTypedDict
     from .bookmarkresult import BookmarkResult, BookmarkResultTypedDict
     from .bookmarkstatus import BookmarkStatus, BookmarkStatusTypedDict
+    from .cancelimportop import (
+        CANCEL_IMPORT_OP_SERVERS,
+        CancelImportRequest,
+        CancelImportRequestTypedDict,
+    )
     from .case import Case, CaseType, CaseTypedDict, ThresholdType
     from .caseadditionalattributes import CaseAdditionalAttributes
     from .caseanswer import CaseAnswer, CaseAnswerTypedDict
@@ -224,15 +225,15 @@ if TYPE_CHECKING:
         CreateFederatedSearchResultEventRequest,
         CreateFederatedSearchResultEventRequestTypedDict,
     )
-    from .createimportop import (
-        CREATE_IMPORT_OP_SERVERS,
-        CreateImportResponse,
-        CreateImportResponseTypedDict,
+    from .createimportjobop import (
+        CREATE_IMPORT_JOB_OP_SERVERS,
+        CreateImportJobResponse,
+        CreateImportJobResponseTypedDict,
     )
-    from .createimportvalidationop import (
-        CREATE_IMPORT_VALIDATION_OP_SERVERS,
-        CreateImportValidationResponse,
-        CreateImportValidationResponseTypedDict,
+    from .createimportvalidationjobop import (
+        CREATE_IMPORT_VALIDATION_JOB_OP_SERVERS,
+        CreateImportValidationJobResponse,
+        CreateImportValidationJobResponseTypedDict,
     )
     from .createquickpick import CreateQuickpick, CreateQuickpickTypedDict
     from .createquickpickop import (
@@ -422,10 +423,10 @@ if TYPE_CHECKING:
         ServiceUnavailableStatus,
         Storage,
     )
-    from .getimportcontentop import (
-        GET_IMPORT_CONTENT_OP_SERVERS,
-        GetImportContentRequest,
-        GetImportContentRequestTypedDict,
+    from .getimportstatusop import (
+        GET_IMPORT_STATUS_OP_SERVERS,
+        GetImportStatusRequest,
+        GetImportStatusRequestTypedDict,
     )
     from .getmyportalsop import GetMyPortalsRequest, GetMyPortalsRequestTypedDict
     from .getmysubscriptionop import (
@@ -547,11 +548,6 @@ if TYPE_CHECKING:
     from .order import Order
     from .ownedby import OwnedBy, OwnedByTypedDict
     from .paginationinfo import PaginationInfo, PaginationInfoTypedDict
-    from .patchimportcontentvalidationop import (
-        PATCH_IMPORT_CONTENT_VALIDATION_OP_SERVERS,
-        PatchImportContentValidationRequest,
-        PatchImportContentValidationRequestTypedDict,
-    )
     from .personalization import (
         Filters,
         FiltersTypedDict,
@@ -904,8 +900,11 @@ __all__ = [
     "BookmarkStatus",
     "BookmarkStatusTypedDict",
     "BookmarkTypedDict",
-    "CREATE_IMPORT_OP_SERVERS",
-    "CREATE_IMPORT_VALIDATION_OP_SERVERS",
+    "CANCEL_IMPORT_OP_SERVERS",
+    "CREATE_IMPORT_JOB_OP_SERVERS",
+    "CREATE_IMPORT_VALIDATION_JOB_OP_SERVERS",
+    "CancelImportRequest",
+    "CancelImportRequestTypedDict",
     "Captcha",
     "CaptchaTypedDict",
     "Case",
@@ -970,18 +969,16 @@ __all__ = [
     "ContactPersonTypedDict",
     "Contacts",
     "ContactsTypedDict",
-    "Context",
-    "ContextTypedDict",
     "CreateBookmark",
     "CreateBookmarkTypedDict",
     "CreateFederatedSearchEvent",
     "CreateFederatedSearchEventTypedDict",
     "CreateFederatedSearchResultEventRequest",
     "CreateFederatedSearchResultEventRequestTypedDict",
-    "CreateImportResponse",
-    "CreateImportResponseTypedDict",
-    "CreateImportValidationResponse",
-    "CreateImportValidationResponseTypedDict",
+    "CreateImportJobResponse",
+    "CreateImportJobResponseTypedDict",
+    "CreateImportValidationJobResponse",
+    "CreateImportValidationJobResponseTypedDict",
     "CreateQuickpick",
     "CreateQuickpickRequest",
     "CreateQuickpickRequestTypedDict",
@@ -1066,7 +1063,7 @@ __all__ = [
     "FolderSummaryTypedDict",
     "GET_BEST_ANSWER_OP_SERVERS",
     "GET_HEALTH_OP_SERVERS",
-    "GET_IMPORT_CONTENT_OP_SERVERS",
+    "GET_IMPORT_STATUS_OP_SERVERS",
     "GHSearchRequest",
     "GHSearchRequestTypedDict",
     "GHSearchResult",
@@ -1123,8 +1120,8 @@ __all__ = [
     "GetHealthResponse",
     "GetHealthResponseTypedDict",
     "GetHealthStatus",
-    "GetImportContentRequest",
-    "GetImportContentRequestTypedDict",
+    "GetImportStatusRequest",
+    "GetImportStatusRequestTypedDict",
     "GetMyPortalsRequest",
     "GetMyPortalsRequestTypedDict",
     "GetMySubscriptionRequest",
@@ -1223,18 +1220,13 @@ __all__ = [
     "ModifySuggestionsRequest",
     "ModifySuggestionsRequestTypedDict",
     "Name",
-    "OpensearchHighlightingRaw",
-    "OpensearchHighlightingRawTypedDict",
     "Operation",
     "OptionalArticleAttributes",
     "Order",
     "OwnedBy",
     "OwnedByTypedDict",
-    "PATCH_IMPORT_CONTENT_VALIDATION_OP_SERVERS",
     "PaginationInfo",
     "PaginationInfoTypedDict",
-    "PatchImportContentValidationRequest",
-    "PatchImportContentValidationRequestTypedDict",
     "Personalization",
     "PersonalizationAccessTags",
     "PersonalizationAccessTagsTypedDict",
@@ -1493,8 +1485,6 @@ _dynamic_imports: dict[str, str] = {
     "AnswersRequestChannelTypedDict": ".answersrequest",
     "AnswersRequestType": ".answersrequest",
     "AnswersRequestTypedDict": ".answersrequest",
-    "Context": ".answersrequest",
-    "ContextTypedDict": ".answersrequest",
     "AnswersResponse": ".answersresponse",
     "AnswersResponseAnswer": ".answersresponse",
     "AnswersResponseAnswerType": ".answersresponse",
@@ -1522,8 +1512,6 @@ _dynamic_imports: dict[str, str] = {
     "ArticleAISearchResultTypedDict": ".articleaisearchresult",
     "ArticleTypeAttributes": ".articleaisearchresult",
     "ArticleTypeAttributesTypedDict": ".articleaisearchresult",
-    "OpensearchHighlightingRaw": ".articleaisearchresult",
-    "OpensearchHighlightingRawTypedDict": ".articleaisearchresult",
     "ArticleAttachment": ".articleattachment",
     "ArticleAttachmentType": ".articleattachment",
     "ArticleAttachmentTypedDict": ".articleattachment",
@@ -1583,6 +1571,9 @@ _dynamic_imports: dict[str, str] = {
     "BookmarkResultTypedDict": ".bookmarkresult",
     "BookmarkStatus": ".bookmarkstatus",
     "BookmarkStatusTypedDict": ".bookmarkstatus",
+    "CANCEL_IMPORT_OP_SERVERS": ".cancelimportop",
+    "CancelImportRequest": ".cancelimportop",
+    "CancelImportRequestTypedDict": ".cancelimportop",
     "Case": ".case",
     "CaseType": ".case",
     "CaseTypedDict": ".case",
@@ -1657,12 +1648,12 @@ _dynamic_imports: dict[str, str] = {
     "ResultType": ".createfederatedsearchevent",
     "CreateFederatedSearchResultEventRequest": ".createfederatedsearchresulteventop",
     "CreateFederatedSearchResultEventRequestTypedDict": ".createfederatedsearchresulteventop",
-    "CREATE_IMPORT_OP_SERVERS": ".createimportop",
-    "CreateImportResponse": ".createimportop",
-    "CreateImportResponseTypedDict": ".createimportop",
-    "CREATE_IMPORT_VALIDATION_OP_SERVERS": ".createimportvalidationop",
-    "CreateImportValidationResponse": ".createimportvalidationop",
-    "CreateImportValidationResponseTypedDict": ".createimportvalidationop",
+    "CREATE_IMPORT_JOB_OP_SERVERS": ".createimportjobop",
+    "CreateImportJobResponse": ".createimportjobop",
+    "CreateImportJobResponseTypedDict": ".createimportjobop",
+    "CREATE_IMPORT_VALIDATION_JOB_OP_SERVERS": ".createimportvalidationjobop",
+    "CreateImportValidationJobResponse": ".createimportvalidationjobop",
+    "CreateImportValidationJobResponseTypedDict": ".createimportvalidationjobop",
     "CreateQuickpick": ".createquickpick",
     "CreateQuickpickTypedDict": ".createquickpick",
     "CreateQuickpickRequest": ".createquickpickop",
@@ -1799,9 +1790,9 @@ _dynamic_imports: dict[str, str] = {
     "ProcessingEngine": ".gethealthop",
     "ServiceUnavailableStatus": ".gethealthop",
     "Storage": ".gethealthop",
-    "GET_IMPORT_CONTENT_OP_SERVERS": ".getimportcontentop",
-    "GetImportContentRequest": ".getimportcontentop",
-    "GetImportContentRequestTypedDict": ".getimportcontentop",
+    "GET_IMPORT_STATUS_OP_SERVERS": ".getimportstatusop",
+    "GetImportStatusRequest": ".getimportstatusop",
+    "GetImportStatusRequestTypedDict": ".getimportstatusop",
     "GetMyPortalsRequest": ".getmyportalsop",
     "GetMyPortalsRequestTypedDict": ".getmyportalsop",
     "GetMySubscriptionRequest": ".getmysubscriptionop",
@@ -1909,9 +1900,6 @@ _dynamic_imports: dict[str, str] = {
     "OwnedByTypedDict": ".ownedby",
     "PaginationInfo": ".paginationinfo",
     "PaginationInfoTypedDict": ".paginationinfo",
-    "PATCH_IMPORT_CONTENT_VALIDATION_OP_SERVERS": ".patchimportcontentvalidationop",
-    "PatchImportContentValidationRequest": ".patchimportcontentvalidationop",
-    "PatchImportContentValidationRequestTypedDict": ".patchimportcontentvalidationop",
     "Filters": ".personalization",
     "FiltersTypedDict": ".personalization",
     "Personalization": ".personalization",

egain_api_python/models/answersrequest.py

@@ -29,36 +29,8 @@ class AnswersRequestChannel(BaseModel):
     r"""A descriptive name for the channel (e.g., \"web\", \"mobile app\", \"agent console\")."""
 
 
-class ContextTypedDict(TypedDict):
-    r"""Additional contextual metadata that enriches the query, providing the LLM with relevant details for tailoring the response."""
-
-    user_context: NotRequired[str]
-    r"""Information about the end user (e.g., preferences, profile data, or behavioral signals)."""
-    page_context: NotRequired[str]
-    r"""Details about the UI or page where the query was initiated (e.g., page URL, section, or component)."""
-    company_context: NotRequired[str]
-    r"""Information about the organization associated with the user, used for tailoring responses in enterprise environments."""
-
-
-class Context(BaseModel):
-    r"""Additional contextual metadata that enriches the query, providing the LLM with relevant details for tailoring the response."""
-
-    user_context: Annotated[Optional[str], pydantic.Field(alias="userContext")] = None
-    r"""Information about the end user (e.g., preferences, profile data, or behavioral signals)."""
-
-    page_context: Annotated[Optional[str], pydantic.Field(alias="pageContext")] = None
-    r"""Details about the UI or page where the query was initiated (e.g., page URL, section, or component)."""
-
-    company_context: Annotated[
-        Optional[str], pydantic.Field(alias="companyContext")
-    ] = None
-    r"""Information about the organization associated with the user, used for tailoring responses in enterprise environments."""
-
-
 class AnswersRequestTypedDict(TypedDict):
     channel: NotRequired[AnswersRequestChannelTypedDict]
-    context: NotRequired[ContextTypedDict]
-    r"""Additional contextual metadata that enriches the query, providing the LLM with relevant details for tailoring the response."""
     event_id: NotRequired[str]
     r"""Unique ID for this specific API call or event."""
     session_id: NotRequired[str]
@@ -68,9 +40,6 @@ class AnswersRequestTypedDict(TypedDict):
 class AnswersRequest(BaseModel):
     channel: Optional[AnswersRequestChannel] = None
 
-    context: Optional[Context] = None
-    r"""Additional contextual metadata that enriches the query, providing the LLM with relevant details for tailoring the response."""
-
     event_id: Annotated[Optional[str], pydantic.Field(alias="eventId")] = None
     r"""Unique ID for this specific API call or event."""
 

egain_api_python/models/answersresponse.py

@@ -66,28 +66,26 @@ class AnswersResponseChannel(BaseModel):
 
 
 class AnswersResponseTypedDict(TypedDict):
-    answer: NotRequired[AnswersResponseAnswerTypedDict]
-    search_results: NotRequired[List[SearchResultTypedDict]]
+    answer: AnswersResponseAnswerTypedDict
+    search_results: List[SearchResultTypedDict]
     r"""List of top search results used to support the answer. Includes snippets, metadata, and relevance scores."""
-    channel: NotRequired[AnswersResponseChannelTypedDict]
-    session_id: NotRequired[str]
+    session_id: str
     r"""ID that ties multiple API calls to the same user session. Will be used as part of to tie events back to a session."""
+    channel: NotRequired[AnswersResponseChannelTypedDict]
     event_id: NotRequired[str]
     r"""Unique ID for this specific API call or event."""
 
 
 class AnswersResponse(BaseModel):
-    answer: Optional[AnswersResponseAnswer] = None
+    answer: AnswersResponseAnswer
 
-    search_results: Annotated[
-        Optional[List[SearchResult]], pydantic.Field(alias="searchResults")
-    ] = None
+    search_results: Annotated[List[SearchResult], pydantic.Field(alias="searchResults")]
     r"""List of top search results used to support the answer. Includes snippets, metadata, and relevance scores."""
 
-    channel: Optional[AnswersResponseChannel] = None
-
-    session_id: Annotated[Optional[str], pydantic.Field(alias="sessionId")] = None
+    session_id: Annotated[str, pydantic.Field(alias="sessionId")]
     r"""ID that ties multiple API calls to the same user session. Will be used as part of to tie events back to a session."""
 
+    channel: Optional[AnswersResponseChannel] = None
+
     event_id: Annotated[Optional[str], pydantic.Field(alias="eventId")] = None
     r"""Unique ID for this specific API call or event."""