PyPI - egain-api-python - Versions diffs - 0.1.10__tar.gz → 0.3.0__tar.gz - Mend

egain-api-python 0.1.10tar.gz → 0.3.0tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (369) hide show

{egain_api_python-0.1.10/src/egain_api_python.egg-info → egain_api_python-0.3.0}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: egain-api-python
-Version: 0.1.10
+Version: 0.3.0
 Summary: Python Client SDK Generated by Speakeasy.
 Author: Speakeasy
 Requires-Python: >=3.9.2
@@ -71,7 +71,6 @@ For more information about the API: [Full SDK Documentation](https://github.com/
   * [SDK Example Usage](#sdk-example-usage)
   * [Authentication](#authentication)
   * [Available Resources and Operations](#available-resources-and-operations)
-  * [File uploads](#file-uploads)
   * [Retries](#retries)
   * [Error Handling](#error-handling)
   * [Server Selection](#server-selection)
@@ -175,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", language="en-US", filter_user_profile_id="PROD-3210", filter_tags={
+    res = egain.aiservices.retrieve.retrieve_chunks(q="What is a loan?", portal_id="PROD-1000", language="en-US", filter_user_profile_id="PROD-1030", filter_tags={
         "PROD-1234": [
             "PROD-2000",
             "PROD-2003",
@@ -185,7 +184,7 @@ with Egain(
         ],
     }, channel={
         "name": "Eight Bank Website",
-    })
+    }, event_id="6154589f-b43f-4471-b2c7-92c6c888a664", client_session_id="6154589f-b43f-4471-b2c7-92c6c888a643", session_id="6154589f-b43f-4471-b2c7-92c6c888a689")
     # Handle response
     print(res)
@@ -207,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", language="en-US", filter_user_profile_id="PROD-3210", filter_tags={
+        res = await egain.aiservices.retrieve.retrieve_chunks_async(q="What is a loan?", portal_id="PROD-1000", language="en-US", filter_user_profile_id="PROD-1030", filter_tags={
             "PROD-1234": [
                 "PROD-2000",
                 "PROD-2003",
@@ -217,7 +216,7 @@ async def main():
             ],
         }, channel={
             "name": "Eight Bank Website",
-        })
+        }, event_id="6154589f-b43f-4471-b2c7-92c6c888a664", client_session_id="6154589f-b43f-4471-b2c7-92c6c888a643", session_id="6154589f-b43f-4471-b2c7-92c6c888a689")
         # Handle response
         print(res)
@@ -247,17 +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", language="en-US", filter_user_profile_id="PROD-3210", filter_tags={
-        "PROD-1234": [
-            "PROD-2000",
-            "PROD-2003",
-        ],
-        "PROD-2005": [
-            "PROD-2007",
-        ],
-    }, channel={
-        "name": "Eight Bank Website",
-    })
+    res = egain.aiservices.prompt.execute_prompt(prompt_id="<id>", department="Service", language_code="en-US", event_type="generate", client_session_id="123e4567-e89b-12d3-a456-426614174000", streaming=False)
     # Handle response
     print(res)
@@ -271,172 +260,154 @@ with Egain(
 <details open>
 <summary>Available methods</summary>
-#### [aiservices.answers](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/answers/README.md)
+#### [aiservices.answers](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/answers/README.md)
-* [get_best_answer](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/answers/README.md#get_best_answer) - Get the best answer for a user query
+* [get_best_answer](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/answers/README.md#get_best_answer) - Generate an Answer
-#### [aiservices.retrieve](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/retrieve/README.md)
+#### [aiservices.prompt](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/aiservicesprompt/README.md)
-* [retrieve_chunks](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/retrieve/README.md#retrieve_chunks) - Retrieve Chunks
+* [execute_prompt](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/aiservicesprompt/README.md#execute_prompt) - Execute a predefined prompt
-#### [content.import_](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/import/README.md)
+#### [aiservices.retrieve](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/retrieve/README.md)
-* [create_import_job](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/import/README.md#create_import_job) - Import content from external sources by creating an import job
-* [get_import_status](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/import/README.md#get_import_status) - Get the current status of an import or validation job
-* [create_import_validation_job](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/import/README.md#create_import_validation_job) - Validate content structure and format before import by creating an import validation job
-* [cancel_import](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/import/README.md#cancel_import) - Cancel an import or validation job
+* [retrieve_chunks](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/retrieve/README.md#retrieve_chunks) - Retrieve Chunks
-#### [portal.article](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalarticle/README.md)
+#### [content.import_](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/import/README.md)
-* [get_article_by_id](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalarticle/README.md#get_article_by_id) - Get Article by ID
-* [get_article_by_id_with_editions](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalarticle/README.md#get_article_by_id_with_editions) - Get Article By ID with Editions
-* [get_article_edition_details](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalarticle/README.md#get_article_edition_details) - Get Article Edition Details
-* [add_to_reply](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalarticle/README.md#add_to_reply) - Add Article to Reply
-* [add_as_reference](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalarticle/README.md#add_as_reference) - Add as Reference
-* [get_articles_in_topic](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalarticle/README.md#get_articles_in_topic) - Get Articles in Topic
-* [get_article_attachment_by_id](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalarticle/README.md#get_article_attachment_by_id) - Get Article Attachment By ID
-* [get_attachment_by_id_in_portal](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalarticle/README.md#get_attachment_by_id_in_portal) - Get Article Attachment in Portal
-* [get_related_articles](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalarticle/README.md#get_related_articles) - Get Related Articles
-* [get_announcement_articles](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalarticle/README.md#get_announcement_articles) - Get Announcement Articles
-* [get_article_ratings](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalarticle/README.md#get_article_ratings) - Get Article Ratings
-* [rate_article](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalarticle/README.md#rate_article) - Rate an Article
-* [get_pending_compliance_articles](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalarticle/README.md#get_pending_compliance_articles) - Get Pending Article Compliances
-* [get_acknowledged_compliance_articles](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalarticle/README.md#get_acknowledged_compliance_articles) - Get Acknowledged Article Compliances
-* [comply_article](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalarticle/README.md#comply_article) - Comply With an Article
-* [get_my_subscription](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalarticle/README.md#get_my_subscription) - My Subscription
-* [subscribe_article](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalarticle/README.md#subscribe_article) - Subscribe to an Article
-* [unsubscribe_article](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalarticle/README.md#unsubscribe_article) - Unsubscribe to an Article
-* [get_article_permissions_by_id](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalarticle/README.md#get_article_permissions_by_id) - Get Article Permissions By ID
-* [get_article_personalization](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalarticle/README.md#get_article_personalization) - Get Article Personalization Details
+* [create_import_job](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/import/README.md#create_import_job) - Create Import Job
+* [get_validation_hooks](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/import/README.md#get_validation_hooks) - Get validation hooks
+* [create_validation_hook](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/import/README.md#create_validation_hook) - Create validation hook
+* [get_validation_hook_versions](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/import/README.md#get_validation_hook_versions) - Get all versions for a validation hook
+* [create_validation_hook_version](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/import/README.md#create_validation_hook_version) - Update validation hook version
+* [get_validation_hook_version](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/import/README.md#get_validation_hook_version) - Get validation hook version details
+* [get_import_status](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/import/README.md#get_import_status) - Get Job Status
+* [create_import_validation_job](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/import/README.md#create_import_validation_job) - Create Validation Job
+* [cancel_import](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/import/README.md#cancel_import) - Cancel Job
-#### [portal.articlelists](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/articlelists/README.md)
+#### [portal.article](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md)
-* [get_all_article_lists](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/articlelists/README.md#get_all_article_lists) - Get All Article Lists
-* [get_article_list_details](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/articlelists/README.md#get_article_list_details) - Get Article List by ID
+* [get_article_by_id](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md#get_article_by_id) - Get Article by ID
+* [get_article_by_id_with_editions](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md#get_article_by_id_with_editions) - Get Article By ID with Editions
+* [get_article_edition_details](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md#get_article_edition_details) - Get Article Edition Details
+* [get_all_article_types](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md#get_all_article_types) - Get All Article Types in a Department
+* [add_to_reply](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md#add_to_reply) - Add Article to Reply
+* [add_as_reference](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md#add_as_reference) - Add as Reference
+* [get_articles_in_topic](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md#get_articles_in_topic) - Get Articles in Topic
+* [get_article_attachment_by_id](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md#get_article_attachment_by_id) - Get Article Attachment By ID
+* [get_attachment_by_id_in_portal](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md#get_attachment_by_id_in_portal) - Get Article Attachment in Portal
+* [get_related_articles](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md#get_related_articles) - Get Related Articles
+* [get_announcement_articles](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md#get_announcement_articles) - Get Announcement Articles
+* [get_article_ratings](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md#get_article_ratings) - Get Article Ratings
+* [rate_article](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md#rate_article) - Rate an Article
+* [get_pending_compliance_articles](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md#get_pending_compliance_articles) - Get Pending Article Compliances
+* [get_acknowledged_compliance_articles](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md#get_acknowledged_compliance_articles) - Get Acknowledged Article Compliances
+* [comply_article](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md#comply_article) - Comply With an Article
+* [get_my_subscription](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md#get_my_subscription) - My Subscription
+* [subscribe_article](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md#subscribe_article) - Subscribe to an Article
+* [unsubscribe_article](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md#unsubscribe_article) - Unsubscribe to an Article
+* [get_article_permissions_by_id](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md#get_article_permissions_by_id) - Get Article Permissions By ID
+* [get_article_personalization](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalarticle/README.md#get_article_personalization) - Get Article Personalization Details
-#### [portal.attachment](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalattachment/README.md)
+#### [portal.articlelists](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/articlelists/README.md)
-* [create_signed_url](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalattachment/README.md#create_signed_url) - Generate Signed URL to Upload API
-* [upload_attachment](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalattachment/README.md#upload_attachment) - Upload Attachment
+* [get_all_article_lists](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/articlelists/README.md#get_all_article_lists) - Get All Article Lists
+* [get_article_list_details](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/articlelists/README.md#get_article_list_details) - Get Article List by ID
-#### [portal.bookmark](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalbookmark/README.md)
+#### [portal.attachment](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalattachment/README.md)
-* [addbookmark](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalbookmark/README.md#addbookmark) - Add a Bookmark
-* [getbookmark](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalbookmark/README.md#getbookmark) - Get All Bookmarks for a Portal
-* [deletebookmark](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalbookmark/README.md#deletebookmark) - Delete a Bookmark
+* [create_signed_url](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalattachment/README.md#create_signed_url) - Generate Signed URL to Upload API
-#### [portal.connectorssearchevents](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/connectorssearchevents/README.md)
+#### [portal.bookmark](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalbookmark/README.md)
-* [create_search_result_event_for_connectors](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/connectorssearchevents/README.md#create_search_result_event_for_connectors) - Event for Search Using Connectors
-* [create_viewed_search_results_event_for_connectors](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/connectorssearchevents/README.md#create_viewed_search_results_event_for_connectors) - Event for Viewed Search Results Using Connectors
+* [addbookmark](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalbookmark/README.md#addbookmark) - Add a Bookmark
+* [getbookmark](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalbookmark/README.md#getbookmark) - Get All Bookmarks for a Portal
+* [deletebookmark](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalbookmark/README.md#deletebookmark) - Delete a Bookmark
-#### [portal.escalation](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/escalation/README.md)
+#### [portal.connectorssearchevents](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/connectorssearchevents/README.md)
-* [start_customer_escalation](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/escalation/README.md#start_customer_escalation) - Start Customer Escalation
-* [search_prior_to_escalation](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/escalation/README.md#search_prior_to_escalation) - Search Prior To Customer Escalation
-* [complete_customer_escalation](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/escalation/README.md#complete_customer_escalation) - Complete Customer Escalation
-* [avert_customer_escalation](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/escalation/README.md#avert_customer_escalation) - Avert Customer Escalation
+* [create_search_result_event_for_connectors](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/connectorssearchevents/README.md#create_search_result_event_for_connectors) - Event for Search Using Connectors
+* [create_viewed_search_results_event_for_connectors](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/connectorssearchevents/README.md#create_viewed_search_results_event_for_connectors) - Event for Viewed Search Results Using Connectors
-#### [portal.export](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/export/README.md)
+#### [portal.export](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/export/README.md)
-* [export_content](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/export/README.md#export_content) - Export Knowledge
-* [export_status](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/export/README.md#export_status) - Get Export Job Status
+* [export_content](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/export/README.md#export_content) - Export Knowledge
+* [export_status](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/export/README.md#export_status) - Get Export Job Status
-#### [portal.federatedsearchevent](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/federatedsearchevent/README.md)
+#### [portal.federatedsearchevent](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/federatedsearchevent/README.md)
-* [create_federated_search_result_event](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/federatedsearchevent/README.md#create_federated_search_result_event) - Event For Viewed Federated Search Result
+* [create_federated_search_result_event](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/federatedsearchevent/README.md#create_federated_search_result_event) - Event For Viewed Federated Search Result
-#### [portal.general](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/general/README.md)
+#### [portal.general](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/general/README.md)
-* [get_all_portals](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/general/README.md#get_all_portals) - Get All Portals
-* [get_my_portals](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/general/README.md#get_my_portals) - Get All Portals Accessible To User
-* [get_portal_details_by_id](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/general/README.md#get_portal_details_by_id) - Get Portal Details By ID
-* [get_tag_categories_for_interest_for_portal](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/general/README.md#get_tag_categories_for_interest_for_portal) - Get Tag Categories for Interest for a Portal
+* [get_all_portals](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/general/README.md#get_all_portals) - Get All Portals
+* [get_my_portals](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/general/README.md#get_my_portals) - Get All Portals Accessible To User
+* [get_portal_details_by_id](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/general/README.md#get_portal_details_by_id) - Get Portal Details By ID
+* [get_tag_categories_for_interest_for_portal](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/general/README.md#get_tag_categories_for_interest_for_portal) - Get Tag Categories for Interest for a Portal
-#### [portal.guidedhelp](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/guidedhelp/README.md)
+#### [portal.guidedhelp](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/guidedhelp/README.md)
-* [get_all_casebases_releases](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/guidedhelp/README.md#get_all_casebases_releases) - Get Available Casebases Releases
-* [get_casebase_release_by_id](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/guidedhelp/README.md#get_casebase_release_by_id) - Get Details of a Casebase Release
-* [get_cluster_by_casebase_release_id](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/guidedhelp/README.md#get_cluster_by_casebase_release_id) - Get Cluster Details of a Casebase Release
-* [get_all_profiles_in_portal](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/guidedhelp/README.md#get_all_profiles_in_portal) - Get All Profiles Available in Portal
-* [start_gh_search](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/guidedhelp/README.md#start_gh_search) - Start a Guided Help Search
-* [step_gh_search](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/guidedhelp/README.md#step_gh_search) - Perform a Step in a Guided Help Search
-* [get_all_cases](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/guidedhelp/README.md#get_all_cases) - Get All Cases of a Cluster in Release
-* [get_case_by_id](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/guidedhelp/README.md#get_case_by_id) - Get Details of a Case
-* [accept_gh_solution](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/guidedhelp/README.md#accept_gh_solution) - Accept Solution
-* [reject_gh_solution](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/guidedhelp/README.md#reject_gh_solution) - Reject Solution
-* [create_quickpick](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/guidedhelp/README.md#create_quickpick) - Create Quickpick
-* [get_all_quick_picks](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/guidedhelp/README.md#get_all_quick_picks) - Get All Quickpicks for a Portal
-* [restore_quickpick](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/guidedhelp/README.md#restore_quickpick) - Resume a Quickpick
+* [get_all_casebases_releases](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/guidedhelp/README.md#get_all_casebases_releases) - Get Available Casebases Releases
+* [get_casebase_release_by_id](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/guidedhelp/README.md#get_casebase_release_by_id) - Get Details of a Casebase Release
+* [get_cluster_by_casebase_release_id](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/guidedhelp/README.md#get_cluster_by_casebase_release_id) - Get Cluster Details of a Casebase Release
+* [get_all_profiles_in_portal](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/guidedhelp/README.md#get_all_profiles_in_portal) - Get All Profiles Available in Portal
+* [start_gh_search](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/guidedhelp/README.md#start_gh_search) - Start a Guided Help Search
+* [step_gh_search](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/guidedhelp/README.md#step_gh_search) - Perform a Step in a Guided Help Search
+* [get_all_cases](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/guidedhelp/README.md#get_all_cases) - Get All Cases of a Cluster in Release
+* [get_case_by_id](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/guidedhelp/README.md#get_case_by_id) - Get Details of a Case
+* [accept_gh_solution](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/guidedhelp/README.md#accept_gh_solution) - Accept Solution
+* [reject_gh_solution](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/guidedhelp/README.md#reject_gh_solution) - Reject Solution
+* [create_quickpick](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/guidedhelp/README.md#create_quickpick) - Create Quickpick
+* [get_all_quick_picks](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/guidedhelp/README.md#get_all_quick_picks) - Get All Quickpicks for a Portal
+* [restore_quickpick](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/guidedhelp/README.md#restore_quickpick) - Resume a Quickpick
-#### [portal.populararticles](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/populararticles/README.md)
+#### [portal.populararticles](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/populararticles/README.md)
-* [getpopulararticles](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/populararticles/README.md#getpopulararticles) - Get Popular Articles
+* [getpopulararticles](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/populararticles/README.md#getpopulararticles) - Get Popular Articles
-#### [portal.search](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/search/README.md)
+#### [portal.search](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/search/README.md)
-* [ai_search](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/search/README.md#ai_search) - Get the best search results for a user query
+* [ai_search](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/search/README.md#ai_search) - Hybrid Search
-#### [portal.suggestion](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalsuggestion/README.md)
+#### [portal.suggestion](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalsuggestion/README.md)
-* [make_suggestion](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalsuggestion/README.md#make_suggestion) - Make a Suggestion
-* [modify_suggestions](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalsuggestion/README.md#modify_suggestions) - Modify Suggestion
-* [search_suggestion](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalsuggestion/README.md#search_suggestion) - Get Suggestion by Status
-* [get_suggestion](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalsuggestion/README.md#get_suggestion) - Get Suggestion by ID
-* [delete_suggestion](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalsuggestion/README.md#delete_suggestion) - Delete a Suggestion
-* [get_related_articles_for_suggestion](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalsuggestion/README.md#get_related_articles_for_suggestion) - Get Related Articles for Suggestion
-* [get_suggestion_comments](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalsuggestion/README.md#get_suggestion_comments) - Get Suggestion Comments
-* [get_suggestion_attachments](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalsuggestion/README.md#get_suggestion_attachments) - Get Suggestion Attachments
-* [get_suggestion_attachment_by_id](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portalsuggestion/README.md#get_suggestion_attachment_by_id) - Get Suggestion Attachment by ID
+* [make_suggestion](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalsuggestion/README.md#make_suggestion) - Make a Suggestion
+* [modify_suggestions](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalsuggestion/README.md#modify_suggestions) - Modify Suggestion
+* [search_suggestion](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalsuggestion/README.md#search_suggestion) - Get Suggestion by Status
+* [get_suggestion](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalsuggestion/README.md#get_suggestion) - Get Suggestion by ID
+* [delete_suggestion](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalsuggestion/README.md#delete_suggestion) - Delete a Suggestion
+* [get_related_articles_for_suggestion](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalsuggestion/README.md#get_related_articles_for_suggestion) - Get Related Articles for Suggestion
+* [get_suggestion_comments](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalsuggestion/README.md#get_suggestion_comments) - Get Suggestion Comments
+* [add_suggestion_comment](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalsuggestion/README.md#add_suggestion_comment) - Add a Suggestion Comment
+* [get_suggestion_attachments](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalsuggestion/README.md#get_suggestion_attachments) - Get Suggestion Attachments
+* [get_suggestion_attachment_by_id](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portalsuggestion/README.md#get_suggestion_attachment_by_id) - Get Suggestion Attachment by ID
-#### [portal.topic](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portaltopic/README.md)
+#### [portal.topic](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portaltopic/README.md)
-* [get_topic_breadcrumb_for_article](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portaltopic/README.md#get_topic_breadcrumb_for_article) - Get Topic Breadcrumb for Article
-* [getchildtopics](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portaltopic/README.md#getchildtopics) - Get Immediate Child Topics
-* [getancestortopics](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portaltopic/README.md#getancestortopics) - Get All Ancestor Topics
-* [getalltopics](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portaltopic/README.md#getalltopics) - Get All Topics
+* [get_topic_breadcrumb_for_article](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portaltopic/README.md#get_topic_breadcrumb_for_article) - Get Topic Breadcrumb for Article
+* [getchildtopics](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portaltopic/README.md#getchildtopics) - Get Immediate Child Topics
+* [getancestortopics](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portaltopic/README.md#getancestortopics) - Get All Ancestor Topics
+* [getalltopics](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portaltopic/README.md#getalltopics) - Get All Topics
-#### [portal.userdetails](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portaluserdetails/README.md)
+#### [portal.userdetails](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portaluserdetails/README.md)
-* [get_user_details](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portaluserdetails/README.md#get_user_details) - Get User Details
+* [get_user_details](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portaluserdetails/README.md#get_user_details) - Get User Details
-#### [portal.usermilestones](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/usermilestones/README.md)
+#### [portal.usermilestones](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/usermilestones/README.md)
-* [get_user_milestones](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/usermilestones/README.md#get_user_milestones) - Get User Milestones
+* [get_user_milestones](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/usermilestones/README.md#get_user_milestones) - Get User Milestones
-#### [portal.userprofile](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portaluserprofile/README.md)
+#### [portal.userprofile](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portaluserprofile/README.md)
-* [get_all_user_profiles](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portaluserprofile/README.md#get_all_user_profiles) - Get All User Profiles Assigned to User
-* [select_user_profile](https://github.com/eGain/egain-api-typescript/blob/main/docs/sdks/portaluserprofile/README.md#select_user_profile) - Select User Profile
+* [get_all_user_profiles](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portaluserprofile/README.md#get_all_user_profiles) - Get All User Profiles Assigned to User
+* [select_user_profile](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/portaluserprofile/README.md#select_user_profile) - Select User Profile
-</details>
-<!-- End Available Resources and Operations [operations] -->
-<!-- Start File uploads [file-upload] -->
-## File uploads
-Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
+### [prompt](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/prompt/README.md)
-> [!TIP]
->
-> For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.
->
+* [get_prompt_templates](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/prompt/README.md#get_prompt_templates) - Get Prompt Templates
+* [get_prompt_template_by_id](https://github.com/eGain/egain-api-python/blob/main/docs/sdks/prompt/README.md#get_prompt_template_by_id) - Get Prompt Template By ID
-```python
-from egain_api_python import Egain
-import os
-with Egain(
-    access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
-) as egain:
-    egain.portal.attachment.upload_attachment(accept_language="en-US", signature="<value>", request_body=open("example.file", "rb"))
-    # Use the SDK ...
-```
-<!-- End File uploads [file-upload] -->
+</details>
+<!-- End Available Resources and Operations [operations] -->
 <!-- Start Retries [retries] -->
 ## Retries
@@ -454,17 +425,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", language="en-US", filter_user_profile_id="PROD-3210", filter_tags={
-        "PROD-1234": [
-            "PROD-2000",
-            "PROD-2003",
-        ],
-        "PROD-2005": [
-            "PROD-2007",
-        ],
-    }, channel={
-        "name": "Eight Bank Website",
-    },
+    res = egain.aiservices.prompt.execute_prompt(prompt_id="<id>", department="Service", language_code="en-US", event_type="generate", client_session_id="123e4567-e89b-12d3-a456-426614174000", streaming=False,
         RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
     # Handle response
@@ -484,17 +445,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", language="en-US", filter_user_profile_id="PROD-3210", filter_tags={
-        "PROD-1234": [
-            "PROD-2000",
-            "PROD-2003",
-        ],
-        "PROD-2005": [
-            "PROD-2007",
-        ],
-    }, channel={
-        "name": "Eight Bank Website",
-    })
+    res = egain.aiservices.prompt.execute_prompt(prompt_id="<id>", department="Service", language_code="en-US", event_type="generate", client_session_id="123e4567-e89b-12d3-a456-426614174000", streaming=False)
     # Handle response
     print(res)
@@ -505,7 +456,7 @@ with Egain(
 <!-- Start Error Handling [errors] -->
 ## Error Handling
-[`EgainError`](./src/egain_api_python/errors/egainerror.py) is the base class for all HTTP error responses. It has the following properties:
+[`EgainError`](https://github.com/eGain/egain-api-python/blob/main/src/egain_api_python/errors/egainerror.py) is the base class for all HTTP error responses. It has the following properties:
 | Property           | Type             | Description                                                                             |
 | ------------------ | ---------------- | --------------------------------------------------------------------------------------- |
@@ -519,7 +470,6 @@ with Egain(
 ### Example
 ```python
 from egain_api_python import Egain, errors
-from egain_api_python.utils import parse_datetime
 import os
@@ -529,14 +479,7 @@ with Egain(
     res = None
     try:
-        res = egain.content.import_.create_import_job(data_source={
-            "type": "AWS S3 bucket",
-            "path": "s3://mybucket/myfolder/",
-            "region": "us-east-1",
-            "credentials": {},
-        }, operation="import", schedule_time={
-            "date_": parse_datetime("2024-03-01T10:00:00.000Z"),
-        })
+        res = egain.aiservices.prompt.execute_prompt(prompt_id="<id>", department="Service", language_code="en-US", event_type="generate", client_session_id="123e4567-e89b-12d3-a456-426614174000", streaming=False)
         # Handle response
         print(res)
@@ -551,19 +494,17 @@ with Egain(
         print(e.raw_response)
         # Depending on the method different errors may be thrown
-        if isinstance(e, errors.WSErrorCommon):
-            print(e.data.code)  # str
-            print(e.data.developer_message)  # str
-            print(e.data.details)  # Optional[List[models.WSErrorCommonDetail]]
-            print(e.data.user_message)  # Optional[str]
+        if isinstance(e, errors.BadRequestError):
+            print(e.data.code)  # Optional[int]
+            print(e.data.developer_message)  # Optional[str]
 ```
 ### Error Classes
 **Primary errors:**
-* [`EgainError`](./src/egain_api_python/errors/egainerror.py): The base class for HTTP error responses.
-  * [`WSErrorCommon`](./src/egain_api_python/errors/wserrorcommon.py): Bad Request. *
+* [`EgainError`](https://github.com/eGain/egain-api-python/blob/main/src/egain_api_python/errors/egainerror.py): The base class for HTTP error responses.
+  * [`WSErrorCommon`](https://github.com/eGain/egain-api-python/blob/main/src/egain_api_python/errors/wserrorcommon.py): Bad Request. *
-<details><summary>Less common errors (6)</summary>
+<details><summary>Less common errors (7)</summary>
 <br />
@@ -573,9 +514,10 @@ with Egain(
     * [`httpx.TimeoutException`](https://www.python-httpx.org/exceptions/#httpx.TimeoutException): HTTP request timed out.
-**Inherit from [`EgainError`](./src/egain_api_python/errors/egainerror.py)**:
-* [`SchemasWSErrorCommon`](./src/egain_api_python/errors/schemaswserrorcommon.py): Preconditions failed. Status code `412`. Applicable to 2 of 78 methods.*
-* [`ResponseValidationError`](./src/egain_api_python/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.
+**Inherit from [`EgainError`](https://github.com/eGain/egain-api-python/blob/main/src/egain_api_python/errors/egainerror.py)**:
+* [`SchemasWSErrorCommon`](https://github.com/eGain/egain-api-python/blob/main/src/egain_api_python/errors/schemaswserrorcommon.py): Not acceptable. Status code `406`. Applicable to 4 of 83 methods.*
+* [`BadRequestError`](https://github.com/eGain/egain-api-python/blob/main/src/egain_api_python/errors/badrequesterror.py): Bad Request. Status code `400`. Applicable to 1 of 83 methods.*
+* [`ResponseValidationError`](https://github.com/eGain/egain-api-python/blob/main/src/egain_api_python/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.
 </details>
@@ -598,17 +540,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", language="en-US", filter_user_profile_id="PROD-3210", filter_tags={
-        "PROD-1234": [
-            "PROD-2000",
-            "PROD-2003",
-        ],
-        "PROD-2005": [
-            "PROD-2007",
-        ],
-    }, channel={
-        "name": "Eight Bank Website",
-    })
+    res = egain.aiservices.prompt.execute_prompt(prompt_id="<id>", department="Service", language_code="en-US", event_type="generate", client_session_id="123e4567-e89b-12d3-a456-426614174000", streaming=False)
     # Handle response
     print(res)
@@ -627,17 +559,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", language="en-US", filter_user_profile_id="PROD-3210", filter_tags={
-        "PROD-1234": [
-            "PROD-2000",
-            "PROD-2003",
-        ],
-        "PROD-2005": [
-            "PROD-2007",
-        ],
-    }, channel={
-        "name": "Eight Bank Website",
-    }, server_url="https://api.aidev.egain.cloud/core/aiservices/v4")
+    res = egain.aiservices.prompt.execute_prompt(prompt_id="<id>", department="Service", language_code="en-US", event_type="generate", client_session_id="123e4567-e89b-12d3-a456-426614174000", streaming=False, server_url="https://api.aidev.egain.cloud/core/aiservices/v4")
     # Handle response
     print(res)

egain-api-python 0.1.10__tar.gz → 0.3.0__tar.gz

egain-api-python 0.1.10tar.gz → 0.3.0tar.gz