egain-api-python 0.1.9__py3-none-any.whl → 0.2.1__py3-none-any.whl

egain_api_python/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "egain-api-python"
-__version__: str = "0.1.9"
+__version__: str = "0.2.1"
 __openapi_doc_version__: str = "4.0.0"
 __gen_version__: str = "2.723.11"
-__user_agent__: str = "speakeasy-sdk/python 0.1.9 2.723.11 4.0.0 egain-api-python"
+__user_agent__: str = "speakeasy-sdk/python 0.2.1 2.723.11 4.0.0 egain-api-python"
 
 try:
     if __package__ is not None:

egain_api_python/aiservices.py

@@ -2,12 +2,14 @@
 
 from .basesdk import BaseSDK
 from .sdkconfiguration import SDKConfiguration
+from egain_api_python.aiservices_prompt import AiservicesPrompt
 from egain_api_python.answers import Answers
 from egain_api_python.retrieve import Retrieve
 from typing import Optional
 
 
 class Aiservices(BaseSDK):
+    prompt: AiservicesPrompt
     retrieve: Retrieve
     answers: Answers
 
@@ -19,5 +21,8 @@ class Aiservices(BaseSDK):
         self._init_sdks()
 
     def _init_sdks(self):
+        self.prompt = AiservicesPrompt(
+            self.sdk_configuration, parent_ref=self.parent_ref
+        )
         self.retrieve = Retrieve(self.sdk_configuration, parent_ref=self.parent_ref)
         self.answers = Answers(self.sdk_configuration, parent_ref=self.parent_ref)

egain_api_python/aiservices_prompt.py

@@ -0,0 +1,279 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from .basesdk import BaseSDK
+from egain_api_python import errors, models, utils
+from egain_api_python._hooks import HookContext
+from egain_api_python.types import OptionalNullable, UNSET
+from egain_api_python.utils import get_security_from_env
+from egain_api_python.utils.unmarshal_json_response import unmarshal_json_response
+from typing import Any, List, Mapping, Optional, Union
+
+
+class AiservicesPrompt(BaseSDK):
+    def execute_prompt(
+        self,
+        *,
+        prompt_id: str,
+        department: str,
+        language_code: models.LanguageCodeRequestBody,
+        replacements: Optional[
+            Union[List[models.Replacement], List[models.ReplacementTypedDict]]
+        ] = None,
+        event_type: Optional[models.EventTypeRequestBody] = "generate",
+        client_session_id: Optional[str] = None,
+        streaming: Optional[bool] = False,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.ExecutePromptResponse:
+        r"""Execute a predefined prompt
+
+        Execute a published and active prompt template from the AI console.
+
+        :param prompt_id: ID of the prompt template from the AI console. Only published and active prompt IDs are allowed.
+        :param department: Name of the department. Must be a valid department name.
+        :param language_code: The language used for the prompt template.
+        :param replacements: List of variable replacements (either static or search).
+        :param event_type: Event type logged when the API executes successfully.
+        :param client_session_id: Client provided sessionID to store events against.
+        :param streaming: Whether to stream the response instead of returning inline.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = models.EXECUTE_PROMPT_OP_SERVERS[0]
+
+        request = models.ExecutePromptRequest(
+            prompt_id=prompt_id,
+            execute_prompt=models.ExecutePrompt(
+                department=department,
+                language_code=language_code,
+                replacements=utils.get_pydantic_model(
+                    replacements, Optional[List[models.Replacement]]
+                ),
+                event_type=event_type,
+                client_session_id=client_session_id,
+                streaming=streaming,
+            ),
+        )
+
+        req = self._build_request(
+            method="POST",
+            path="/promptmanager/execute/prompt/{promptId}",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request.execute_prompt,
+                False,
+                True,
+                "json",
+                Optional[models.ExecutePrompt],
+            ),
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="executePrompt",
+                oauth2_scopes=None,
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=[
+                "400",
+                "401",
+                "403",
+                "404",
+                "429",
+                "4XX",
+                "500",
+                "503",
+                "5XX",
+            ],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.ExecutePromptResponse, http_res)
+        if utils.match_response(http_res, "400", "application/json"):
+            response_data = unmarshal_json_response(
+                errors.BadRequestErrorData, http_res
+            )
+            raise errors.BadRequestError(response_data, http_res)
+        if utils.match_response(http_res, ["401", "403", "404", "429", "4XX"], "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+        if utils.match_response(http_res, ["500", "503", "5XX"], "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+
+        raise errors.EgainDefaultError("Unexpected response received", http_res)
+
+    async def execute_prompt_async(
+        self,
+        *,
+        prompt_id: str,
+        department: str,
+        language_code: models.LanguageCodeRequestBody,
+        replacements: Optional[
+            Union[List[models.Replacement], List[models.ReplacementTypedDict]]
+        ] = None,
+        event_type: Optional[models.EventTypeRequestBody] = "generate",
+        client_session_id: Optional[str] = None,
+        streaming: Optional[bool] = False,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.ExecutePromptResponse:
+        r"""Execute a predefined prompt
+
+        Execute a published and active prompt template from the AI console.
+
+        :param prompt_id: ID of the prompt template from the AI console. Only published and active prompt IDs are allowed.
+        :param department: Name of the department. Must be a valid department name.
+        :param language_code: The language used for the prompt template.
+        :param replacements: List of variable replacements (either static or search).
+        :param event_type: Event type logged when the API executes successfully.
+        :param client_session_id: Client provided sessionID to store events against.
+        :param streaming: Whether to stream the response instead of returning inline.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = models.EXECUTE_PROMPT_OP_SERVERS[0]
+
+        request = models.ExecutePromptRequest(
+            prompt_id=prompt_id,
+            execute_prompt=models.ExecutePrompt(
+                department=department,
+                language_code=language_code,
+                replacements=utils.get_pydantic_model(
+                    replacements, Optional[List[models.Replacement]]
+                ),
+                event_type=event_type,
+                client_session_id=client_session_id,
+                streaming=streaming,
+            ),
+        )
+
+        req = self._build_request_async(
+            method="POST",
+            path="/promptmanager/execute/prompt/{promptId}",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request.execute_prompt,
+                False,
+                True,
+                "json",
+                Optional[models.ExecutePrompt],
+            ),
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="executePrompt",
+                oauth2_scopes=None,
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=[
+                "400",
+                "401",
+                "403",
+                "404",
+                "429",
+                "4XX",
+                "500",
+                "503",
+                "5XX",
+            ],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.ExecutePromptResponse, http_res)
+        if utils.match_response(http_res, "400", "application/json"):
+            response_data = unmarshal_json_response(
+                errors.BadRequestErrorData, http_res
+            )
+            raise errors.BadRequestError(response_data, http_res)
+        if utils.match_response(http_res, ["401", "403", "404", "429", "4XX"], "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+        if utils.match_response(http_res, ["500", "503", "5XX"], "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+
+        raise errors.EgainDefaultError("Unexpected response received", http_res)

egain_api_python/answers.py

@@ -15,38 +15,40 @@ class Answers(BaseSDK):
         *,
         q: str,
         portal_id: str,
+        language: models.RequiredLanguageCode,
         filter_user_profile_id: Optional[str] = None,
-        language: Optional[models.LanguageCodeParameter] = None,
         filter_tags: Optional[Dict[str, List[str]]] = None,
         filter_topic_ids: Optional[List[str]] = None,
         channel: Optional[
             Union[models.AnswersRequestChannel, models.AnswersRequestChannelTypedDict]
         ] = None,
         event_id: Optional[str] = None,
+        client_session_id: Optional[str] = None,
         session_id: Optional[str] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.AnswersResponse:
-        r"""Get the best answer for a user query
+        r"""Generate an Answer
 
         The **Answers API** allows enterprises to deliver fast, accurate, and contextual responses powered by their organizational knowledge. It supports two complementary approaches:
         - **Certified Answers**: Direct snippets retrieved from enterprise-authored content.
         - **Generative Answers**: Natural language responses synthesized by a large language model (LLM).
 
-        Every response includes supporting search results, references, and confidence scores—ensuring transparency, trust, and traceability. The API is built for secure, scalable integration across enterprise environments. <br>**This endpoint is only available for Self Service environments.**
+        Every response includes supporting search results, references, and confidence scores—ensuring transparency, trust, and traceability. The API is built for secure, scalable integration across enterprise environments.
 
 
-        :param q: The search query string. The string must be escaped as required by the URL syntax rules.
+        :param q: The search query string.
         :param portal_id: 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.
+        :param language: The language that describes the details of a resource. Resources available in different languages may differ from each other.
         :param filter_user_profile_id:
-        :param language: 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.
-        :param filter_tags: An object where each key is a **Category Tag ID** (numeric string),   and each value is an array of **Tag IDs** for that category.
+        :param filter_tags: An object where each key is a **Category Tag ID** (numeric string),   and each value is an array of **Tag IDs** for that category.  **Note**:   - The '$filter[tags]' query parameter JSON value should be url encoded.   - Some developer tools for invoking APIs may not url encode the '$filter[tags]' query parameter JSON value by default. Ensure that only url encoded values are used.   - Example of JSON value: {\"BASE-40845\":[\"BASE-40849\",\"BASE-40853\"]}   - Example of URL encoded value: %7B%22BASE-40845%22%3A%5B%22BASE-40849%22%2C%22BASE-40853%22%5D%7D
         :param filter_topic_ids: An array of topic IDs. It is used to restrict search results to specific topics.
         :param channel:
         :param event_id: Unique ID for this specific API call or event.
-        :param session_id: ID that ties multiple API calls to the same user session. Will be used as part of to tie events back to a session.
+        :param client_session_id: Session ID passed by the client for this specific API call or event.
+        :param session_id: eGain Session ID that ties multiple API calls to the same user session. Will be used as part of to tie events back to a session.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -74,6 +76,7 @@ class Answers(BaseSDK):
                     channel, Optional[models.AnswersRequestChannel]
                 ),
                 event_id=event_id,
+                client_session_id=client_session_id,
                 session_id=session_id,
             ),
         )
@@ -144,38 +147,40 @@ class Answers(BaseSDK):
         *,
         q: str,
         portal_id: str,
+        language: models.RequiredLanguageCode,
         filter_user_profile_id: Optional[str] = None,
-        language: Optional[models.LanguageCodeParameter] = None,
         filter_tags: Optional[Dict[str, List[str]]] = None,
         filter_topic_ids: Optional[List[str]] = None,
         channel: Optional[
             Union[models.AnswersRequestChannel, models.AnswersRequestChannelTypedDict]
         ] = None,
         event_id: Optional[str] = None,
+        client_session_id: Optional[str] = None,
         session_id: Optional[str] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.AnswersResponse:
-        r"""Get the best answer for a user query
+        r"""Generate an Answer
 
         The **Answers API** allows enterprises to deliver fast, accurate, and contextual responses powered by their organizational knowledge. It supports two complementary approaches:
         - **Certified Answers**: Direct snippets retrieved from enterprise-authored content.
         - **Generative Answers**: Natural language responses synthesized by a large language model (LLM).
 
-        Every response includes supporting search results, references, and confidence scores—ensuring transparency, trust, and traceability. The API is built for secure, scalable integration across enterprise environments. <br>**This endpoint is only available for Self Service environments.**
+        Every response includes supporting search results, references, and confidence scores—ensuring transparency, trust, and traceability. The API is built for secure, scalable integration across enterprise environments.
 
 
-        :param q: The search query string. The string must be escaped as required by the URL syntax rules.
+        :param q: The search query string.
         :param portal_id: 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.
+        :param language: The language that describes the details of a resource. Resources available in different languages may differ from each other.
         :param filter_user_profile_id:
-        :param language: 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.
-        :param filter_tags: An object where each key is a **Category Tag ID** (numeric string),   and each value is an array of **Tag IDs** for that category.
+        :param filter_tags: An object where each key is a **Category Tag ID** (numeric string),   and each value is an array of **Tag IDs** for that category.  **Note**:   - The '$filter[tags]' query parameter JSON value should be url encoded.   - Some developer tools for invoking APIs may not url encode the '$filter[tags]' query parameter JSON value by default. Ensure that only url encoded values are used.   - Example of JSON value: {\"BASE-40845\":[\"BASE-40849\",\"BASE-40853\"]}   - Example of URL encoded value: %7B%22BASE-40845%22%3A%5B%22BASE-40849%22%2C%22BASE-40853%22%5D%7D
         :param filter_topic_ids: An array of topic IDs. It is used to restrict search results to specific topics.
         :param channel:
         :param event_id: Unique ID for this specific API call or event.
-        :param session_id: ID that ties multiple API calls to the same user session. Will be used as part of to tie events back to a session.
+        :param client_session_id: Session ID passed by the client for this specific API call or event.
+        :param session_id: eGain Session ID that ties multiple API calls to the same user session. Will be used as part of to tie events back to a session.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -203,6 +208,7 @@ class Answers(BaseSDK):
                     channel, Optional[models.AnswersRequestChannel]
                 ),
                 event_id=event_id,
+                client_session_id=client_session_id,
                 session_id=session_id,
             ),
         )

egain_api_python/content.py

@@ -2,14 +2,12 @@
 
 from .basesdk import BaseSDK
 from .sdkconfiguration import SDKConfiguration
-from egain_api_python.health import Health
 from egain_api_python.import_ import Import
 from typing import Optional
 
 
 class Content(BaseSDK):
     import_: Import
-    health: Health
 
     def __init__(
         self, sdk_config: SDKConfiguration, parent_ref: Optional[object] = None
@@ -20,4 +18,3 @@ class Content(BaseSDK):
 
     def _init_sdks(self):
         self.import_ = Import(self.sdk_configuration, parent_ref=self.parent_ref)
-        self.health = Health(self.sdk_configuration, parent_ref=self.parent_ref)

egain_api_python/errors/__init__.py

@@ -8,29 +8,29 @@ import sys
 
 if TYPE_CHECKING:
     from .egaindefaulterror import EgainDefaultError
-    from .gethealthop import ServiceUnavailableError, ServiceUnavailableErrorData
+    from .executepromptop import BadRequestError, BadRequestErrorData
     from .no_response_error import NoResponseError
     from .responsevalidationerror import ResponseValidationError
     from .schemas_wserrorcommon import SchemasWSErrorCommon, SchemasWSErrorCommonData
     from .wserrorcommon import WSErrorCommon, WSErrorCommonData
 
 __all__ = [
+    "BadRequestError",
+    "BadRequestErrorData",
     "EgainDefaultError",
     "EgainError",
     "NoResponseError",
     "ResponseValidationError",
     "SchemasWSErrorCommon",
     "SchemasWSErrorCommonData",
-    "ServiceUnavailableError",
-    "ServiceUnavailableErrorData",
     "WSErrorCommon",
     "WSErrorCommonData",
 ]
 
 _dynamic_imports: dict[str, str] = {
     "EgainDefaultError": ".egaindefaulterror",
-    "ServiceUnavailableError": ".gethealthop",
-    "ServiceUnavailableErrorData": ".gethealthop",
+    "BadRequestError": ".executepromptop",
+    "BadRequestErrorData": ".executepromptop",
     "NoResponseError": ".no_response_error",
     "ResponseValidationError": ".responsevalidationerror",
     "SchemasWSErrorCommon": ".schemas_wserrorcommon",

egain_api_python/errors/executepromptop.py

@@ -0,0 +1,35 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from dataclasses import dataclass, field
+from egain_api_python.errors import EgainError
+from egain_api_python.types import BaseModel
+import httpx
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated
+
+
+class BadRequestErrorData(BaseModel):
+    code: Optional[int] = None
+
+    developer_message: Annotated[
+        Optional[str], pydantic.Field(alias="developerMessage")
+    ] = None
+
+
+@dataclass(unsafe_hash=True)
+class BadRequestError(EgainError):
+    r"""Bad Request"""
+
+    data: BadRequestErrorData = field(hash=False)
+
+    def __init__(
+        self,
+        data: BadRequestErrorData,
+        raw_response: httpx.Response,
+        body: Optional[str] = None,
+    ):
+        message = body or raw_response.text
+        super().__init__(message, raw_response, body)
+        object.__setattr__(self, "data", data)

egain_api_python/errors/schemas_wserrorcommon.py

@@ -36,7 +36,7 @@ class SchemasWSErrorCommonData(BaseModel):
 
 @dataclass(unsafe_hash=True)
 class SchemasWSErrorCommon(EgainError):
-    r"""Preconditions failed"""
+    r"""Not acceptable"""
 
     data: SchemasWSErrorCommonData = field(hash=False)