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

egain_api_python/search.py

@@ -15,14 +15,11 @@ class Search(BaseSDK):
         *,
         q: str,
         portal_id: str,
-        dollar_filter_user_profile_id: Optional[str] = None,
+        filter_user_profile_id: Optional[str] = None,
         language: Optional[models.LanguageCodeParameter] = None,
-        dollar_filter_tags: Optional[Dict[str, List[str]]] = None,
-        dollar_filter_topic_ids: Optional[List[str]] = None,
-        dollar_filter_exclude_topic_ids: Optional[List[str]] = None,
-        resource_type: Optional[models.ResourceTypeParameter] = None,
+        filter_tags: Optional[Dict[str, List[str]]] = None,
+        filter_topic_ids: Optional[List[str]] = None,
         article_custom_additional_attributes: Optional[str] = None,
-        topic_custom_additional_attributes: Optional[str] = None,
         pagenum: Optional[int] = 1,
         pagesize: Optional[int] = 10,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -32,18 +29,16 @@ class Search(BaseSDK):
     ) -> models.AISearchResponse:
         r"""Get the best search results for a user query
 
-        Submit a user query and receive a list of search results.
+        The Search API is a hybrid search service that combines semantic understanding with keyword precision to deliver fast, contextual, and relevant results from your enterprise knowledge base. It enables secure, role-aware access to articles, FAQs, and documentation across customer, agent, and employee interfaces. Each query returns a ranked list of results with snippets, metadata, and relevance scores. <br>**This endpoint is only available for Self Service environments.**
+
 
         :param q: The search query string. The string must be escaped as required by the URL syntax rules.
         :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 dollar_filter_user_profile_id: The ID of the user profile.
+        :param filter_user_profile_id: The ID of the user profile.
         :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 dollar_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 dollar_filter_topic_ids: An array of topic IDs. It is used to restrict search results to specific topics.
-        :param dollar_filter_exclude_topic_ids: An array of topic IDs that will be excluded from the search. It includes articles that belong to the topic.
-        :param resource_type: Type of resource to be fetched.
+        :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_topic_ids: An array of topic IDs. It is used to restrict search results to specific topics.
         :param article_custom_additional_attributes: One or more comma-separated names for article custom attributes defined by the user to be returned.
-        :param topic_custom_additional_attributes: One or more comma-separated names for topic custom attributes defined by the user to be returned.
         :param pagenum: Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
         :param pagesize: Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.
         :param retries: Override the default retry configuration for this method
@@ -64,14 +59,11 @@ class Search(BaseSDK):
         request = models.AiSearchRequest(
             q=q,
             portal_id=portal_id,
-            dollar_filter_user_profile_id=dollar_filter_user_profile_id,
+            filter_user_profile_id=filter_user_profile_id,
             language=language,
-            dollar_filter_tags=dollar_filter_tags,
-            dollar_filter_topic_ids=dollar_filter_topic_ids,
-            dollar_filter_exclude_topic_ids=dollar_filter_exclude_topic_ids,
-            resource_type=resource_type,
+            filter_tags=filter_tags,
+            filter_topic_ids=filter_topic_ids,
             article_custom_additional_attributes=article_custom_additional_attributes,
-            topic_custom_additional_attributes=topic_custom_additional_attributes,
             pagenum=pagenum,
             pagesize=pagesize,
         )
@@ -105,7 +97,7 @@ class Search(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="aiSearch",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -135,14 +127,11 @@ class Search(BaseSDK):
         *,
         q: str,
         portal_id: str,
-        dollar_filter_user_profile_id: Optional[str] = None,
+        filter_user_profile_id: Optional[str] = None,
         language: Optional[models.LanguageCodeParameter] = None,
-        dollar_filter_tags: Optional[Dict[str, List[str]]] = None,
-        dollar_filter_topic_ids: Optional[List[str]] = None,
-        dollar_filter_exclude_topic_ids: Optional[List[str]] = None,
-        resource_type: Optional[models.ResourceTypeParameter] = None,
+        filter_tags: Optional[Dict[str, List[str]]] = None,
+        filter_topic_ids: Optional[List[str]] = None,
         article_custom_additional_attributes: Optional[str] = None,
-        topic_custom_additional_attributes: Optional[str] = None,
         pagenum: Optional[int] = 1,
         pagesize: Optional[int] = 10,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -152,18 +141,16 @@ class Search(BaseSDK):
     ) -> models.AISearchResponse:
         r"""Get the best search results for a user query
 
-        Submit a user query and receive a list of search results.
+        The Search API is a hybrid search service that combines semantic understanding with keyword precision to deliver fast, contextual, and relevant results from your enterprise knowledge base. It enables secure, role-aware access to articles, FAQs, and documentation across customer, agent, and employee interfaces. Each query returns a ranked list of results with snippets, metadata, and relevance scores. <br>**This endpoint is only available for Self Service environments.**
+
 
         :param q: The search query string. The string must be escaped as required by the URL syntax rules.
         :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 dollar_filter_user_profile_id: The ID of the user profile.
+        :param filter_user_profile_id: The ID of the user profile.
         :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 dollar_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 dollar_filter_topic_ids: An array of topic IDs. It is used to restrict search results to specific topics.
-        :param dollar_filter_exclude_topic_ids: An array of topic IDs that will be excluded from the search. It includes articles that belong to the topic.
-        :param resource_type: Type of resource to be fetched.
+        :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_topic_ids: An array of topic IDs. It is used to restrict search results to specific topics.
         :param article_custom_additional_attributes: One or more comma-separated names for article custom attributes defined by the user to be returned.
-        :param topic_custom_additional_attributes: One or more comma-separated names for topic custom attributes defined by the user to be returned.
         :param pagenum: Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
         :param pagesize: Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.
         :param retries: Override the default retry configuration for this method
@@ -184,14 +171,11 @@ class Search(BaseSDK):
         request = models.AiSearchRequest(
             q=q,
             portal_id=portal_id,
-            dollar_filter_user_profile_id=dollar_filter_user_profile_id,
+            filter_user_profile_id=filter_user_profile_id,
             language=language,
-            dollar_filter_tags=dollar_filter_tags,
-            dollar_filter_topic_ids=dollar_filter_topic_ids,
-            dollar_filter_exclude_topic_ids=dollar_filter_exclude_topic_ids,
-            resource_type=resource_type,
+            filter_tags=filter_tags,
+            filter_topic_ids=filter_topic_ids,
             article_custom_additional_attributes=article_custom_additional_attributes,
-            topic_custom_additional_attributes=topic_custom_additional_attributes,
             pagenum=pagenum,
             pagesize=pagesize,
         )
@@ -225,7 +209,7 @@ class Search(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="aiSearch",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),

egain_api_python/usermilestones.py

@@ -78,7 +78,7 @@ class Usermilestones(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getUserMilestones",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -182,7 +182,7 @@ class Usermilestones(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getUserMilestones",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),

{egain_api_python-0.1.2.dist-info → egain_api_python-0.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: egain-api-python
-Version: 0.1.2
+Version: 0.1.4
 Summary: Python Client SDK Generated by Speakeasy.
 Author: Speakeasy
 Requires-Python: >=3.9.2
@@ -29,23 +29,36 @@ Knowledge Portal Manager APIs: ### License
   The following licenses are required to use the Knowledge Access APIs:
   * If the user is an agent, then the *Knowledge + AI* license is required.
   * If the user is a customer, the *Self-Service* and *Advanced Self-Service* licenses must be available.
+
+### Tiers
+
+| Tier	|Tier Name|	Named Users |	Description
+| ---------- | ---------- | ---------- | ----------------------------
+| Tier 1 |  Starter |	Up to 10|	Designed for small-scale implementations or pilot environments
+| Tier 2 |	Growth	| Up to 1000|	Suitable for mid-scale deployments requiring moderate scalability
+| Tier 3 |	Enterprise	| Greater than 1000|	Supports large-scale environments with extended configuration options
+
 ### API Resource Limits
-The following Resources have predefined limits for specific access attributes for Enterprise use.
-
-| Resource | Attribute | Enterprise
-| ---------------- | ---------------------------- | ----------
-| Article Reference Limits |Number of attachments used in any article | 50
-|  |Number of custom attributes in an article | 15
-|  |Number of publish views used in an article version | 20
-| Topic Reference Limits |User-defined topics in a department| 50000
-|  |Depth of topics  | 20
-|  |Topics at any level | 2500
-|  |Number of custom attributes in a topic | 15
-| Portal Reference Limits | Tag categories in a portal | 15
-|  |Topics to be included in a portal | 2500
-|  |Number of articles to display in announcements | 25
-|  |Maximum related articles in portal setting | 100
-|  |Usage links and link groups setup for a portal | 25
+The following Resources have predefined limits for specific access attributes for Starter, Growth and Enterprise use.
+
+| Resource | Limits | Starter | Growth | Enterprise
+| ---------------- | ---------------------------- | ---------- | ---------- | ----------
+| Article Reference |Number of attachments used in any article | 25 | 50 |50
+|  |Number of custom attributes in an article | 10 | 25| 50 
+|  |Number of publish views used in an article version | 20 | 20 | 20
+| Topic Reference |User-defined topics in a department| 1000| 5000 | 50000
+|  |Depth of topics  | 5 | 20 | 20
+|  |Topics at any level | 500 | 2500 | 2500
+|  |Number of custom attributes in a topic | 10 | 10 | 10
+| Portal Reference | Tag categories in a portal | 15 | 15 | 15
+|  |Topics to be included in a portal | 100 | 500 | 5000 
+|  |Number of articles to display in announcements | 10 | 25 | 25
+|  |Usage links and link groups setup for a portal | 5 | 10 | 25
+    
+      
+
+
+For more information about the API: [Full SDK Documentation](https://github.com/eGain/egain-api-python)
 <!-- End Summary [summary] -->
 
 <!-- Start Table of Contents [toc] -->
@@ -161,7 +174,7 @@ with Egain(
     access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
 ) as egain:
 
-    res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", dollar_filter_user_profile_id="PROD-3210", language="en-US", dollar_filter_tags={
+    res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
         "PROD-1234": [
             "PROD-2000",
             "PROD-2003",
@@ -193,7 +206,7 @@ async def main():
         access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
     ) as egain:
 
-        res = await egain.aiservices.retrieve.retrieve_chunks_async(q="fair lending", portal_id="PROD-1000", dollar_filter_user_profile_id="PROD-3210", language="en-US", dollar_filter_tags={
+        res = await egain.aiservices.retrieve.retrieve_chunks_async(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
             "PROD-1234": [
                 "PROD-2000",
                 "PROD-2003",
@@ -233,7 +246,7 @@ with Egain(
     access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
 ) as egain:
 
-    res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", dollar_filter_user_profile_id="PROD-3210", language="en-US", dollar_filter_tags={
+    res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
         "PROD-1234": [
             "PROD-2000",
             "PROD-2003",
@@ -257,9 +270,6 @@ with Egain(
 <details open>
 <summary>Available methods</summary>
 
-### [aiservices](docs/sdks/aiservices/README.md)
-
-
 #### [aiservices.answers](docs/sdks/answers/README.md)
 
 * [get_best_answer](docs/sdks/answers/README.md#get_best_answer) - Get the best answer for a user query
@@ -268,23 +278,16 @@ with Egain(
 
 * [retrieve_chunks](docs/sdks/retrieve/README.md#retrieve_chunks) - Retrieve Chunks
 
-### [content](docs/sdks/content/README.md)
-
-
 #### [content.health](docs/sdks/health/README.md)
 
 * [get_health](docs/sdks/health/README.md#get_health) - Check service health status
 
 #### [content.import_](docs/sdks/import/README.md)
 
-* [create_import](docs/sdks/import/README.md#create_import) - Import content from external sources
-* [get_import_content](docs/sdks/import/README.md#get_import_content) - Get the current status of an import or validation job
-* [create_import_validation](docs/sdks/import/README.md#create_import_validation) - Validate content structure and format before import
-* [patch_import_content_validation](docs/sdks/import/README.md#patch_import_content_validation) - Cancel an import or validation job
-
-
-### [portal](docs/sdks/portalsdk/README.md)
-
+* [create_import_job](docs/sdks/import/README.md#create_import_job) - Import content from external sources by creating an import job
+* [get_import_status](docs/sdks/import/README.md#get_import_status) - Get the current status of an import or validation job
+* [create_import_validation_job](docs/sdks/import/README.md#create_import_validation_job) - Validate content structure and format before import by creating an import validation job
+* [cancel_import](docs/sdks/import/README.md#cancel_import) - Cancel an import or validation job
 
 #### [portal.article](docs/sdks/portalarticle/README.md)
 
@@ -454,7 +457,7 @@ with Egain(
     access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
 ) as egain:
 
-    res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", dollar_filter_user_profile_id="PROD-3210", language="en-US", dollar_filter_tags={
+    res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
         "PROD-1234": [
             "PROD-2000",
             "PROD-2003",
@@ -484,7 +487,7 @@ with Egain(
     access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
 ) as egain:
 
-    res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", dollar_filter_user_profile_id="PROD-3210", language="en-US", dollar_filter_tags={
+    res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
         "PROD-1234": [
             "PROD-2000",
             "PROD-2003",
@@ -529,7 +532,7 @@ with Egain(
     res = None
     try:
 
-        res = egain.content.import_.create_import(data_source={
+        res = egain.content.import_.create_import_job(data_source={
             "type": "AWS S3 bucket",
             "path": "s3://mybucket/myfolder/",
             "region": "us-east-1",
@@ -586,43 +589,6 @@ with Egain(
 <!-- Start Server Selection [server] -->
 ## Server Selection
 
-### Server Variables
-
-The default server `https://${API_DOMAIN}/knowledge/portalmgr/v4` contains variables and is set to `https://$api.egain.cloud/knowledge/portalmgr/v4` by default. To override default values, the following parameters are available when initializing the SDK client instance:
-
-| Variable     | Parameter         | Default             | Description |
-| ------------ | ----------------- | ------------------- | ----------- |
-| `API_DOMAIN` | `api_domain: str` | `"api.egain.cloud"` |             |
-
-#### Example
-
-```python
-from egain_api_python import Egain
-import os
-
-
-with Egain(
-    api_domain="<value>"
-    access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
-) as egain:
-
-    res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", dollar_filter_user_profile_id="PROD-3210", language="en-US", dollar_filter_tags={
-        "PROD-1234": [
-            "PROD-2000",
-            "PROD-2003",
-        ],
-        "PROD-2005": [
-            "PROD-2007",
-        ],
-    }, channel={
-        "name": "Eight Bank Website",
-    })
-
-    # Handle response
-    print(res)
-
-```
-
 ### Override Server URL Per-Client
 
 The default server can be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
@@ -632,11 +598,11 @@ import os
 
 
 with Egain(
-    server_url="https://$api.egain.cloud/knowledge/portalmgr/v4",
+    server_url="https://${API_DOMAIN}/knowledge/portalmgr/v4",
     access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
 ) as egain:
 
-    res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", dollar_filter_user_profile_id="PROD-3210", language="en-US", dollar_filter_tags={
+    res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
         "PROD-1234": [
             "PROD-2000",
             "PROD-2003",
@@ -665,7 +631,7 @@ with Egain(
     access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
 ) as egain:
 
-    res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", dollar_filter_user_profile_id="PROD-3210", language="en-US", dollar_filter_tags={
+    res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
         "PROD-1234": [
             "PROD-2000",
             "PROD-2003",
@@ -675,7 +641,7 @@ with Egain(
         ],
     }, channel={
         "name": "Eight Bank Website",
-    }, server_url="https://$api.egain.cloud/core/aiservices/v4")
+    }, server_url="https://${API_DOMAIN}/core/aiservices/v4")
 
     # Handle response
     print(res)