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

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/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."""

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
 
 
@@ -54,47 +54,26 @@ class ArticleAISearchResultCustomAttribute(BaseModel):
     r"""The custom attribute's type."""
 
 
-class OpensearchHighlightingRawTypedDict(TypedDict):
-    r"""Article content used for highlighting a keyword search result"""
-
-    article_content: NotRequired[List[str]]
-
-
-class OpensearchHighlightingRaw(BaseModel):
-    r"""Article content used for highlighting a keyword search result"""
-
-    article_content: Annotated[
-        Optional[List[str]], pydantic.Field(alias="articleContent")
-    ] = 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."""
@@ -127,7 +106,7 @@ class ArticleAISearchResultTypedDict(TypedDict):
     source: ArticleAISearchResultSource
     r"""The source type."""
     snippet: str
-    r"""A snippet of the article content."""
+    r"""A semantic snippet of the article content."""
     topic_breadcrumb: List[TopicBreadcrumbTypedDict]
     r"""A list of topics from the root topic to this Article. There may be multiple paths."""
     relevance_score: float
@@ -142,8 +121,6 @@ class ArticleAISearchResultTypedDict(TypedDict):
     r"""An array of snippets belonging to the same article."""
     additional_snippet_count: NotRequired[int]
     r"""Number of additional snippets."""
-    opensearch_highlighting_raw: NotRequired[OpensearchHighlightingRawTypedDict]
-    r"""Article content used for highlighting a keyword search result"""
     contextual_summary: NotRequired[str]
     r"""Contextual Summary generated as part of metadata for embedding."""
     description: NotRequired[str]
@@ -158,7 +135,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."""
 
@@ -179,7 +156,7 @@ class ArticleAISearchResult(BaseModel):
     r"""The source type."""
 
     snippet: str
-    r"""A snippet of the article content."""
+    r"""A semantic snippet of the article content."""
 
     topic_breadcrumb: Annotated[
         List[TopicBreadcrumb], pydantic.Field(alias="topicBreadcrumb")
@@ -213,12 +190,6 @@ class ArticleAISearchResult(BaseModel):
     ] = None
     r"""Number of additional snippets."""
 
-    opensearch_highlighting_raw: Annotated[
-        Optional[OpensearchHighlightingRaw],
-        pydantic.Field(alias="opensearchHighlightingRaw"),
-    ] = None
-    r"""Article content used for highlighting a keyword search result"""
-
     contextual_summary: Annotated[
         Optional[str], pydantic.Field(alias="contextualSummary")
     ] = None
@@ -248,7 +219,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."""

egain_api_python/models/articletype.py

@@ -7,7 +7,7 @@ from typing import Literal, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-ArticleTypeTypeName = Literal[
+TypeName = Literal[
     "General",
     "Guided Help",
     "Data Link",
@@ -24,7 +24,7 @@ class ArticleTypeTypedDict(TypedDict):
 
     article_category_id: NotRequired[int]
     r"""Specifies the article category ID."""
-    type_name: NotRequired[ArticleTypeTypeName]
+    type_name: NotRequired[TypeName]
     r"""Indicates the article category name."""
     use_structured_authoring: NotRequired[bool]
     r"""Indicates whether to use Structured Authoring for the Article Type."""
@@ -40,9 +40,7 @@ class ArticleType(BaseModel):
     ] = None
     r"""Specifies the article category ID."""
 
-    type_name: Annotated[
-        Optional[ArticleTypeTypeName], pydantic.Field(alias="typeName")
-    ] = None
+    type_name: Annotated[Optional[TypeName], pydantic.Field(alias="typeName")] = None
     r"""Indicates the article category name."""
 
     use_structured_authoring: Annotated[

egain_api_python/models/{getimportcontentop.py → cancelimportop.py}

@@ -6,13 +6,13 @@ from egain_api_python.utils import FieldMetadata, PathParamMetadata
 from typing_extensions import Annotated, TypedDict
 
 
-GET_IMPORT_CONTENT_OP_SERVERS = [
+CANCEL_IMPORT_OP_SERVERS = [
     # Production Server
     "https://${API_DOMAIN}/knowledge/contentmgr/v4",
 ]
 
 
-class GetImportContentRequestTypedDict(TypedDict):
+class CancelImportRequestTypedDict(TypedDict):
     job_id: str
     r"""**Job ID Parameter**
 
@@ -28,7 +28,7 @@ class GetImportContentRequestTypedDict(TypedDict):
     """
 
 
-class GetImportContentRequest(BaseModel):
+class CancelImportRequest(BaseModel):
     job_id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]

egain_api_python/models/{createimportop.py → createimportjobop.py}

@@ -6,15 +6,15 @@ from typing import Dict, List
 from typing_extensions import TypedDict
 
 
-CREATE_IMPORT_OP_SERVERS = [
+CREATE_IMPORT_JOB_OP_SERVERS = [
     # Production Server
     "https://${API_DOMAIN}/knowledge/contentmgr/v4",
 ]
 
 
-class CreateImportResponseTypedDict(TypedDict):
+class CreateImportJobResponseTypedDict(TypedDict):
     headers: Dict[str, List[str]]
 
 
-class CreateImportResponse(BaseModel):
+class CreateImportJobResponse(BaseModel):
     headers: Dict[str, List[str]]

egain_api_python/models/{createimportvalidationop.py → createimportvalidationjobop.py}

@@ -6,15 +6,15 @@ from typing import Dict, List
 from typing_extensions import TypedDict
 
 
-CREATE_IMPORT_VALIDATION_OP_SERVERS = [
+CREATE_IMPORT_VALIDATION_JOB_OP_SERVERS = [
     # Production Server
     "https://${API_DOMAIN}/knowledge/contentmgr/v4",
 ]
 
 
-class CreateImportValidationResponseTypedDict(TypedDict):
+class CreateImportValidationJobResponseTypedDict(TypedDict):
     headers: Dict[str, List[str]]
 
 
-class CreateImportValidationResponse(BaseModel):
+class CreateImportValidationJobResponse(BaseModel):
     headers: Dict[str, List[str]]

egain_api_python/models/exportstatus.py

@@ -16,7 +16,7 @@ ExportStatusStatus = Literal[
 ]
 
 
-class ProgressTypedDict(TypedDict):
+class ExportStatusProgressTypedDict(TypedDict):
     r"""Details about the job's progress."""
 
     processed: NotRequired[int]
@@ -27,7 +27,7 @@ class ProgressTypedDict(TypedDict):
     r"""The percentage of the job that is complete."""
 
 
-class Progress(BaseModel):
+class ExportStatusProgress(BaseModel):
     r"""Details about the job's progress."""
 
     processed: Optional[int] = None
@@ -40,7 +40,7 @@ class Progress(BaseModel):
     r"""The percentage of the job that is complete."""
 
 
-class ResultsTypedDict(TypedDict):
+class ExportStatusResultsTypedDict(TypedDict):
     r"""Breakdown of completed job results."""
 
     successful: NotRequired[int]
@@ -51,7 +51,7 @@ class ResultsTypedDict(TypedDict):
     r"""The count of items with errors."""
 
 
-class Results(BaseModel):
+class ExportStatusResults(BaseModel):
     r"""Breakdown of completed job results."""
 
     successful: Optional[int] = None
@@ -66,15 +66,17 @@ class Results(BaseModel):
 
 class ExportStatusTypedDict(TypedDict):
     status: ExportStatusStatus
-    progress: NotRequired[ProgressTypedDict]
+    progress: NotRequired[ExportStatusProgressTypedDict]
     r"""Details about the job's progress."""
     start_time: NotRequired[datetime]
     r"""The timestamp when the job started."""
     estimated_completion: NotRequired[datetime]
     r"""The estimated timestamp when the job is expected to finish."""
+    completion_time: NotRequired[datetime]
+    r"""The timestamp when the job completed."""
     failure_time: NotRequired[datetime]
     r"""The timestamp when the job failed."""
-    results: NotRequired[ResultsTypedDict]
+    results: NotRequired[ExportStatusResultsTypedDict]
     r"""Breakdown of completed job results."""
     error: NotRequired[str]
     r"""A description of the job failure reason."""
@@ -83,7 +85,7 @@ class ExportStatusTypedDict(TypedDict):
 class ExportStatus(BaseModel):
     status: ExportStatusStatus
 
-    progress: Optional[Progress] = None
+    progress: Optional[ExportStatusProgress] = None
     r"""Details about the job's progress."""
 
     start_time: Annotated[Optional[datetime], pydantic.Field(alias="startTime")] = None
@@ -94,12 +96,17 @@ class ExportStatus(BaseModel):
     ] = None
     r"""The estimated timestamp when the job is expected to finish."""
 
+    completion_time: Annotated[
+        Optional[datetime], pydantic.Field(alias="completionTime")
+    ] = None
+    r"""The timestamp when the job completed."""
+
     failure_time: Annotated[Optional[datetime], pydantic.Field(alias="failureTime")] = (
         None
     )
     r"""The timestamp when the job failed."""
 
-    results: Optional[Results] = None
+    results: Optional[ExportStatusResults] = None
     r"""Breakdown of completed job results."""
 
     error: Optional[str] = None

egain_api_python/models/getannouncementarticlesop.py

@@ -22,7 +22,7 @@ class GetAnnouncementArticlesRequestTypedDict(TypedDict):
     r"""The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses)."""
     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_tags: NotRequired[str]
+    filter_tags: NotRequired[str]
     r"""A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together."""
     article_result_additional_attributes: NotRequired[
         List[ArticleResultAdditionalAttributes]
@@ -72,7 +72,7 @@ class GetAnnouncementArticlesRequest(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_tags: Annotated[
+    filter_tags: Annotated[
         Optional[str],
         pydantic.Field(alias="$filter[tags]"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),

egain_api_python/models/getarticlelistdetailsop.py

@@ -23,7 +23,7 @@ class GetArticleListDetailsRequestTypedDict(TypedDict):
     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."""
     list_id: str
     r"""The ID of the list to be returned."""
-    dollar_filter_topic_id: NotRequired[str]
+    filter_topic_id: NotRequired[str]
     r"""The ID of the topic. It is used to restrict to a specific topic."""
     article_result_additional_attributes: NotRequired[
         List[ArticleResultAdditionalAttributes]
@@ -74,7 +74,7 @@ class GetArticleListDetailsRequest(BaseModel):
     ]
     r"""The ID of the list to be returned."""
 
-    dollar_filter_topic_id: Annotated[
+    filter_topic_id: Annotated[
         Optional[str],
         pydantic.Field(alias="$filter[topicId]"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),

egain_api_python/models/getarticlesintopicop.py

@@ -24,7 +24,7 @@ class GetArticlesInTopicRequestTypedDict(TypedDict):
     r"""The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses)."""
     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_topic_id: str
+    filter_topic_id: str
     r"""The ID of the topic. It is used to restrict to a specific topic."""
     search_profile_id: NotRequired[str]
     r"""Search Profile ID"""
@@ -51,7 +51,7 @@ class GetArticlesInTopicRequestTypedDict(TypedDict):
     | versionId | The ID of the Article version that is returned.
 
     """
-    dollar_filter_tags: NotRequired[str]
+    filter_tags: NotRequired[str]
     r"""A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together."""
     workflow_milestone: NotRequired[WorkflowMilestone]
     r"""For agents with the View Author Portal or View Staging Portal actions, this determines which version of the Article is returned.<li>'Authoring' returns the most recent version of an Article checked-in by an author.</li><li>'Staging' returns the updated version currently being processed in a workflow.</li><li>'Publish' returns the most recently published version.</li>"""
@@ -82,7 +82,7 @@ class GetArticlesInTopicRequest(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_topic_id: Annotated[
+    filter_topic_id: Annotated[
         str,
         pydantic.Field(alias="$filter[topicId]"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -122,7 +122,7 @@ class GetArticlesInTopicRequest(BaseModel):
 
     """
 
-    dollar_filter_tags: Annotated[
+    filter_tags: Annotated[
         Optional[str],
         pydantic.Field(alias="$filter[tags]"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),

egain_api_python/models/getbestanswerop.py

@@ -26,15 +26,15 @@ class GetBestAnswerRequestTypedDict(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]
     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."""
     answers_request: NotRequired[AnswersRequestTypedDict]
 
@@ -52,7 +52,7 @@ class GetBestAnswerRequest(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)),
@@ -65,7 +65,7 @@ class GetBestAnswerRequest(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)),
@@ -75,7 +75,7 @@ class GetBestAnswerRequest(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)),