egain-api-python 0.1.2__tar.gz → 0.1.4__tar.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.
- {egain_api_python-0.1.2/src/egain_api_python.egg-info → egain_api_python-0.1.4}/PKG-INFO +44 -78
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/README.md +43 -77
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/pyproject.toml +1 -1
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/_version.py +3 -3
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/answers.py +26 -38
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/articlelists.py +10 -10
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/connectorssearchevents.py +4 -4
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/errors/gethealthop.py +33 -19
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/escalation.py +8 -8
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/export.py +6 -6
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/federatedsearchevent.py +2 -2
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/general.py +8 -8
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/guidedhelp.py +26 -26
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/health.py +2 -8
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/import_.py +56 -74
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/__init__.py +106 -95
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/aisearchop.py +6 -34
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/aisearchresponse.py +0 -4
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/answersrequest.py +0 -31
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/answersresponse.py +9 -11
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/articleaisearchresult.py +16 -45
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/articletype.py +3 -5
- egain_api_python-0.1.2/src/egain_api_python/models/getimportcontentop.py → egain_api_python-0.1.4/src/egain_api_python/models/cancelimportop.py +3 -3
- egain_api_python-0.1.2/src/egain_api_python/models/createimportop.py → egain_api_python-0.1.4/src/egain_api_python/models/createimportjobop.py +3 -3
- egain_api_python-0.1.2/src/egain_api_python/models/createimportvalidationop.py → egain_api_python-0.1.4/src/egain_api_python/models/createimportvalidationjobop.py +3 -3
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/exportstatus.py +15 -8
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getannouncementarticlesop.py +2 -2
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getarticlelistdetailsop.py +2 -2
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getarticlesintopicop.py +4 -4
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getbestanswerop.py +6 -6
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/gethealthop.py +134 -7
- egain_api_python-0.1.2/src/egain_api_python/models/patchimportcontentvalidationop.py → egain_api_python-0.1.4/src/egain_api_python/models/getimportstatusop.py +3 -3
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getpopulararticlesop.py +4 -4
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getrelatedarticlesop.py +2 -2
- egain_api_python-0.1.4/src/egain_api_python/models/importstatus.py +145 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/knowledgeexport.py +3 -5
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/referenceresponse.py +7 -23
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/retrievechunksop.py +6 -6
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/retrieveresponse.py +10 -12
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/searchresult.py +7 -23
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/populararticles.py +14 -14
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/portal_article.py +64 -64
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/portal_attachment.py +4 -4
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/portal_bookmark.py +6 -6
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/portal_suggestion.py +18 -18
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/portal_topic.py +8 -8
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/portal_userdetails.py +2 -2
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/portal_userprofile.py +4 -4
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/retrieve.py +22 -28
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/sdk.py +25 -24
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/sdkconfiguration.py +3 -4
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/search.py +24 -40
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/usermilestones.py +2 -2
- {egain_api_python-0.1.2 → egain_api_python-0.1.4/src/egain_api_python.egg-info}/PKG-INFO +44 -78
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python.egg-info/SOURCES.txt +4 -6
- egain_api_python-0.1.2/src/egain_api_python/models/importstatus.py +0 -29
- egain_api_python-0.1.2/src/egain_api_python/models/resourcetype_parameter.py +0 -10
- egain_api_python-0.1.2/src/egain_api_python/models/topicaisearchresult.py +0 -67
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/LICENSE +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/setup.cfg +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/__init__.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/_hooks/__init__.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/_hooks/registration.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/_hooks/sdkhooks.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/_hooks/types.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/aiservices.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/basesdk.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/content.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/errors/__init__.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/errors/egaindefaulterror.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/errors/egainerror.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/errors/no_response_error.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/errors/responsevalidationerror.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/errors/schemas_wserrorcommon.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/errors/wserrorcommon.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/httpclient.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/acceptghsolutionop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/acceptlanguage.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/accessibleportal.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/action.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/actionsearch.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/addasreferenceop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/addbookmarkop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/additionalsnippets.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/addtoreplyop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/allaccessibleportals.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/answer.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/answeredquestion.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/answerrange.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/article.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/articleactivitylink.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/articleadditionalattributes.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/articleattachment.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/articlelist.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/articlelistresult.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/articlelistsresult.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/articlepermissions.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/articlepermissionsresult.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/articlerating.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/articleratingsresponse.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/articleresult.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/articleresultadditionalattributes.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/articleresults.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/articlesearchresult.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/articlesearchresults.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/articlesort.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/articlesortorder.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/articlewitheditions.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/attachment.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/attachmentadditionalattributes.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/attachmentcontent.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/attachmentcontentresult.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/attachmentforcreatesuggestion.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/attachments.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/attachmentsummary.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/attachmentupload.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/avertcustomerescalationop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/bookmark.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/bookmarkresult.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/bookmarkstatus.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/case.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/caseadditionalattributes.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/caseanswer.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/casebase.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/casebaseresult.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/casebasesearchsettings.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/caselistresult.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/caselistresults.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/casequestion.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/casequestiondetail.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/casesearch.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/clusterid.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/clusterresult.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/clusterresults.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/comment.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/comments.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/completecustomerescalationop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/compliancearticleresult.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/compliancearticleresultadditionalattributes.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/compliancearticleresults.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/complianceforarticle.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/complyarticleop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/components_schemas_tag.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/components_schemas_tagcategory.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/components_schemas_taggroup.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/configurableattribute.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/configurableattributes.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/contactperson.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/contacts.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/createbookmark.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/createdby.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/createfederatedsearchevent.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/createfederatedsearchresulteventop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/createquickpick.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/createquickpickop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/createsearchresulteventforconnectors.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/createsearchresulteventforconnectorsop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/createsignedurlop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/createsuggestion.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/createviewedsearchresulteventforconnectors.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/createviewedsearchresultseventforconnectorsop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/customattribute.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/deletebookmarkop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/deletesuggestionop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/department.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/detailfield.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/displayfield.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/dynamiccluster.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/dynamicsearch.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/edition.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/editionwithcontent.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/email.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/exportcontentop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/exportstatusop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/feedbackarticleforsuggestion.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/folderbreadcrumb.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/foldersummary.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getacknowledgedcompliancearticlesop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getallarticlelistsop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getallcasebasesreleasesop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getallcasesop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getallportalsop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getallprofilesinportalop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getallquickpicksop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getalltopicsop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getalluserprofilesop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getancestortopicsop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getarticleattachmentbyidop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getarticlebyidop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getarticlebyidwitheditionsop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getarticleeditiondetailsop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getarticlepermissionsbyidop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getarticlepersonalizationop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getarticleratingsop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getattachmentbyidinportalop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getbookmarkop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getcasebasereleasebyidop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getcasebyidop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getchildtopicsop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getclusterbycasebasereleaseidop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getmyportalsop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getmysubscriptionop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getpendingcompliancearticlesop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getportaldetailsbyidop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getrelatedarticlesforsuggestionop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getsuggestionattachmentbyidop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getsuggestionattachmentsop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getsuggestioncommentsop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getsuggestionop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/gettagcategoriesforinterestforportalop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/gettopicbreadcrumbforarticleop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getuserdetailsop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/getusermilestonesop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/ghsearchrequest.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/ghsearchresult.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/ghstepsearchrequest.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/image.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/importcontent.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/kblanguage.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/kblanguagecode.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/kblanguages.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/l10nstring.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/languagecode.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/languagecode_parameter.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/languagequeryparameter.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/link.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/makesuggestionop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/mandatorylanguagequeryparameter.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/metadata.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/milestone.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/milestonename.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/milestones.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/modifiedby.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/modifysuggestion.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/modifysuggestionsop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/optionalarticleattributes.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/order.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/ownedby.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/paginationinfo.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/personalization.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/phone.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/portal.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/portalresult.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/portalsettings.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/profile.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/profileresult.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/publishprofile.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/publishview.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/question.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/questionandanswer.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/quickpickrating.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/quickpickresult.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/quickpickresults.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/ratearticleop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/rejectghsolutionop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/relatedquestions.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/restorequickpickop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/retrieverequest.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/role.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/roletemplate.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/schemas_answer.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/schemas_customattribute.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/schemas_link.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/schemas_tag.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/schemas_tagcategory.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/schemas_taggroup.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/schemas_tags.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/schemas_wserrorcommon.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/searchfilterattribute.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/searchpriortoescalationop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/searchsuggestionop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/security.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/selectuserprofileop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/sessioncontextvariable.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/shorturl.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/sortidname.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/sortidnamedepartment.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/stage.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/startcustomerescalationop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/startescalationrequest.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/startghsearchop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/startquestionandanswer.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/stepghsearchop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/stringattributevalue.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/structuredauthoringfields.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/subscribearticleop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/suggestion.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/suggestionadditionalattributes.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/suggestionattachment.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/suggestions.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/tag.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/tagcategoriesforinterest.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/tagcategory.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/taggroup.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/taggroups.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/tags.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/topic.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/topicadditionalattributes.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/topicbreadcrumb.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/topicresult.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/topicsummary.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/topictreenode.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/topictreeresult.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/unsubscribearticleop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/uploadattachmentop.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/userdetails.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/userprofile.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/userprofiles.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/userview.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/validateimportcontent.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/virtualcase.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/workflow.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/workflowmilestone.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/models/wserrorcommon.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/portal_sdk.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/py.typed +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/types/__init__.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/types/basemodel.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/utils/__init__.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/utils/annotations.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/utils/datetimes.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/utils/enums.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/utils/eventstreaming.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/utils/forms.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/utils/headers.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/utils/logger.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/utils/metadata.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/utils/queryparams.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/utils/requestbodies.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/utils/retries.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/utils/security.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/utils/serializers.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/utils/unmarshal_json_response.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/utils/url.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python/utils/values.py +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python.egg-info/dependency_links.txt +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python.egg-info/requires.txt +0 -0
- {egain_api_python-0.1.2 → egain_api_python-0.1.4}/src/egain_api_python.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
|
|
1
1
|
Metadata-Version: 2.4
|
2
2
|
Name: egain-api-python
|
3
|
-
Version: 0.1.
|
3
|
+
Version: 0.1.4
|
4
4
|
Summary: Python Client SDK Generated by Speakeasy.
|
5
5
|
Author: Speakeasy
|
6
6
|
Requires-Python: >=3.9.2
|
@@ -29,23 +29,36 @@ Knowledge Portal Manager APIs: ### License
|
|
29
29
|
The following licenses are required to use the Knowledge Access APIs:
|
30
30
|
* If the user is an agent, then the *Knowledge + AI* license is required.
|
31
31
|
* If the user is a customer, the *Self-Service* and *Advanced Self-Service* licenses must be available.
|
32
|
+
|
33
|
+
### Tiers
|
34
|
+
|
35
|
+
| Tier |Tier Name| Named Users | Description
|
36
|
+
| ---------- | ---------- | ---------- | ----------------------------
|
37
|
+
| Tier 1 | Starter | Up to 10| Designed for small-scale implementations or pilot environments
|
38
|
+
| Tier 2 | Growth | Up to 1000| Suitable for mid-scale deployments requiring moderate scalability
|
39
|
+
| Tier 3 | Enterprise | Greater than 1000| Supports large-scale environments with extended configuration options
|
40
|
+
|
32
41
|
### API Resource Limits
|
33
|
-
The following Resources have predefined limits for specific access attributes for Enterprise use.
|
34
|
-
|
35
|
-
| Resource |
|
36
|
-
| ---------------- | ---------------------------- | ----------
|
37
|
-
| Article Reference
|
38
|
-
| |Number of custom attributes in an article |
|
39
|
-
| |Number of publish views used in an article version | 20
|
40
|
-
| Topic Reference
|
41
|
-
| |Depth of topics | 20
|
42
|
-
| |Topics at any level | 2500
|
43
|
-
| |Number of custom attributes in a topic |
|
44
|
-
| Portal Reference
|
45
|
-
| |Topics to be included in a portal |
|
46
|
-
| |Number of articles to display in announcements | 25
|
47
|
-
| |
|
48
|
-
|
42
|
+
The following Resources have predefined limits for specific access attributes for Starter, Growth and Enterprise use.
|
43
|
+
|
44
|
+
| Resource | Limits | Starter | Growth | Enterprise
|
45
|
+
| ---------------- | ---------------------------- | ---------- | ---------- | ----------
|
46
|
+
| Article Reference |Number of attachments used in any article | 25 | 50 |50
|
47
|
+
| |Number of custom attributes in an article | 10 | 25| 50
|
48
|
+
| |Number of publish views used in an article version | 20 | 20 | 20
|
49
|
+
| Topic Reference |User-defined topics in a department| 1000| 5000 | 50000
|
50
|
+
| |Depth of topics | 5 | 20 | 20
|
51
|
+
| |Topics at any level | 500 | 2500 | 2500
|
52
|
+
| |Number of custom attributes in a topic | 10 | 10 | 10
|
53
|
+
| Portal Reference | Tag categories in a portal | 15 | 15 | 15
|
54
|
+
| |Topics to be included in a portal | 100 | 500 | 5000
|
55
|
+
| |Number of articles to display in announcements | 10 | 25 | 25
|
56
|
+
| |Usage links and link groups setup for a portal | 5 | 10 | 25
|
57
|
+
|
58
|
+
|
59
|
+
|
60
|
+
|
61
|
+
For more information about the API: [Full SDK Documentation](https://github.com/eGain/egain-api-python)
|
49
62
|
<!-- End Summary [summary] -->
|
50
63
|
|
51
64
|
<!-- Start Table of Contents [toc] -->
|
@@ -161,7 +174,7 @@ with Egain(
|
|
161
174
|
access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
|
162
175
|
) as egain:
|
163
176
|
|
164
|
-
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000",
|
177
|
+
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
|
165
178
|
"PROD-1234": [
|
166
179
|
"PROD-2000",
|
167
180
|
"PROD-2003",
|
@@ -193,7 +206,7 @@ async def main():
|
|
193
206
|
access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
|
194
207
|
) as egain:
|
195
208
|
|
196
|
-
res = await egain.aiservices.retrieve.retrieve_chunks_async(q="fair lending", portal_id="PROD-1000",
|
209
|
+
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={
|
197
210
|
"PROD-1234": [
|
198
211
|
"PROD-2000",
|
199
212
|
"PROD-2003",
|
@@ -233,7 +246,7 @@ with Egain(
|
|
233
246
|
access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
|
234
247
|
) as egain:
|
235
248
|
|
236
|
-
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000",
|
249
|
+
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
|
237
250
|
"PROD-1234": [
|
238
251
|
"PROD-2000",
|
239
252
|
"PROD-2003",
|
@@ -257,9 +270,6 @@ with Egain(
|
|
257
270
|
<details open>
|
258
271
|
<summary>Available methods</summary>
|
259
272
|
|
260
|
-
### [aiservices](docs/sdks/aiservices/README.md)
|
261
|
-
|
262
|
-
|
263
273
|
#### [aiservices.answers](docs/sdks/answers/README.md)
|
264
274
|
|
265
275
|
* [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(
|
|
268
278
|
|
269
279
|
* [retrieve_chunks](docs/sdks/retrieve/README.md#retrieve_chunks) - Retrieve Chunks
|
270
280
|
|
271
|
-
### [content](docs/sdks/content/README.md)
|
272
|
-
|
273
|
-
|
274
281
|
#### [content.health](docs/sdks/health/README.md)
|
275
282
|
|
276
283
|
* [get_health](docs/sdks/health/README.md#get_health) - Check service health status
|
277
284
|
|
278
285
|
#### [content.import_](docs/sdks/import/README.md)
|
279
286
|
|
280
|
-
* [
|
281
|
-
* [
|
282
|
-
* [
|
283
|
-
* [
|
284
|
-
|
285
|
-
|
286
|
-
### [portal](docs/sdks/portalsdk/README.md)
|
287
|
-
|
287
|
+
* [create_import_job](docs/sdks/import/README.md#create_import_job) - Import content from external sources by creating an import job
|
288
|
+
* [get_import_status](docs/sdks/import/README.md#get_import_status) - Get the current status of an import or validation job
|
289
|
+
* [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
|
290
|
+
* [cancel_import](docs/sdks/import/README.md#cancel_import) - Cancel an import or validation job
|
288
291
|
|
289
292
|
#### [portal.article](docs/sdks/portalarticle/README.md)
|
290
293
|
|
@@ -454,7 +457,7 @@ with Egain(
|
|
454
457
|
access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
|
455
458
|
) as egain:
|
456
459
|
|
457
|
-
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000",
|
460
|
+
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
|
458
461
|
"PROD-1234": [
|
459
462
|
"PROD-2000",
|
460
463
|
"PROD-2003",
|
@@ -484,7 +487,7 @@ with Egain(
|
|
484
487
|
access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
|
485
488
|
) as egain:
|
486
489
|
|
487
|
-
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000",
|
490
|
+
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
|
488
491
|
"PROD-1234": [
|
489
492
|
"PROD-2000",
|
490
493
|
"PROD-2003",
|
@@ -529,7 +532,7 @@ with Egain(
|
|
529
532
|
res = None
|
530
533
|
try:
|
531
534
|
|
532
|
-
res = egain.content.import_.
|
535
|
+
res = egain.content.import_.create_import_job(data_source={
|
533
536
|
"type": "AWS S3 bucket",
|
534
537
|
"path": "s3://mybucket/myfolder/",
|
535
538
|
"region": "us-east-1",
|
@@ -586,43 +589,6 @@ with Egain(
|
|
586
589
|
<!-- Start Server Selection [server] -->
|
587
590
|
## Server Selection
|
588
591
|
|
589
|
-
### Server Variables
|
590
|
-
|
591
|
-
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:
|
592
|
-
|
593
|
-
| Variable | Parameter | Default | Description |
|
594
|
-
| ------------ | ----------------- | ------------------- | ----------- |
|
595
|
-
| `API_DOMAIN` | `api_domain: str` | `"api.egain.cloud"` | |
|
596
|
-
|
597
|
-
#### Example
|
598
|
-
|
599
|
-
```python
|
600
|
-
from egain_api_python import Egain
|
601
|
-
import os
|
602
|
-
|
603
|
-
|
604
|
-
with Egain(
|
605
|
-
api_domain="<value>"
|
606
|
-
access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
|
607
|
-
) as egain:
|
608
|
-
|
609
|
-
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={
|
610
|
-
"PROD-1234": [
|
611
|
-
"PROD-2000",
|
612
|
-
"PROD-2003",
|
613
|
-
],
|
614
|
-
"PROD-2005": [
|
615
|
-
"PROD-2007",
|
616
|
-
],
|
617
|
-
}, channel={
|
618
|
-
"name": "Eight Bank Website",
|
619
|
-
})
|
620
|
-
|
621
|
-
# Handle response
|
622
|
-
print(res)
|
623
|
-
|
624
|
-
```
|
625
|
-
|
626
592
|
### Override Server URL Per-Client
|
627
593
|
|
628
594
|
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
|
|
632
598
|
|
633
599
|
|
634
600
|
with Egain(
|
635
|
-
server_url="https://$
|
601
|
+
server_url="https://${API_DOMAIN}/knowledge/portalmgr/v4",
|
636
602
|
access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
|
637
603
|
) as egain:
|
638
604
|
|
639
|
-
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000",
|
605
|
+
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
|
640
606
|
"PROD-1234": [
|
641
607
|
"PROD-2000",
|
642
608
|
"PROD-2003",
|
@@ -665,7 +631,7 @@ with Egain(
|
|
665
631
|
access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
|
666
632
|
) as egain:
|
667
633
|
|
668
|
-
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000",
|
634
|
+
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
|
669
635
|
"PROD-1234": [
|
670
636
|
"PROD-2000",
|
671
637
|
"PROD-2003",
|
@@ -675,7 +641,7 @@ with Egain(
|
|
675
641
|
],
|
676
642
|
}, channel={
|
677
643
|
"name": "Eight Bank Website",
|
678
|
-
}, server_url="https://$
|
644
|
+
}, server_url="https://${API_DOMAIN}/core/aiservices/v4")
|
679
645
|
|
680
646
|
# Handle response
|
681
647
|
print(res)
|
@@ -16,23 +16,36 @@ Knowledge Portal Manager APIs: ### License
|
|
16
16
|
The following licenses are required to use the Knowledge Access APIs:
|
17
17
|
* If the user is an agent, then the *Knowledge + AI* license is required.
|
18
18
|
* If the user is a customer, the *Self-Service* and *Advanced Self-Service* licenses must be available.
|
19
|
+
|
20
|
+
### Tiers
|
21
|
+
|
22
|
+
| Tier |Tier Name| Named Users | Description
|
23
|
+
| ---------- | ---------- | ---------- | ----------------------------
|
24
|
+
| Tier 1 | Starter | Up to 10| Designed for small-scale implementations or pilot environments
|
25
|
+
| Tier 2 | Growth | Up to 1000| Suitable for mid-scale deployments requiring moderate scalability
|
26
|
+
| Tier 3 | Enterprise | Greater than 1000| Supports large-scale environments with extended configuration options
|
27
|
+
|
19
28
|
### API Resource Limits
|
20
|
-
The following Resources have predefined limits for specific access attributes for Enterprise use.
|
21
|
-
|
22
|
-
| Resource |
|
23
|
-
| ---------------- | ---------------------------- | ----------
|
24
|
-
| Article Reference
|
25
|
-
| |Number of custom attributes in an article |
|
26
|
-
| |Number of publish views used in an article version | 20
|
27
|
-
| Topic Reference
|
28
|
-
| |Depth of topics | 20
|
29
|
-
| |Topics at any level | 2500
|
30
|
-
| |Number of custom attributes in a topic |
|
31
|
-
| Portal Reference
|
32
|
-
| |Topics to be included in a portal |
|
33
|
-
| |Number of articles to display in announcements | 25
|
34
|
-
| |
|
35
|
-
|
29
|
+
The following Resources have predefined limits for specific access attributes for Starter, Growth and Enterprise use.
|
30
|
+
|
31
|
+
| Resource | Limits | Starter | Growth | Enterprise
|
32
|
+
| ---------------- | ---------------------------- | ---------- | ---------- | ----------
|
33
|
+
| Article Reference |Number of attachments used in any article | 25 | 50 |50
|
34
|
+
| |Number of custom attributes in an article | 10 | 25| 50
|
35
|
+
| |Number of publish views used in an article version | 20 | 20 | 20
|
36
|
+
| Topic Reference |User-defined topics in a department| 1000| 5000 | 50000
|
37
|
+
| |Depth of topics | 5 | 20 | 20
|
38
|
+
| |Topics at any level | 500 | 2500 | 2500
|
39
|
+
| |Number of custom attributes in a topic | 10 | 10 | 10
|
40
|
+
| Portal Reference | Tag categories in a portal | 15 | 15 | 15
|
41
|
+
| |Topics to be included in a portal | 100 | 500 | 5000
|
42
|
+
| |Number of articles to display in announcements | 10 | 25 | 25
|
43
|
+
| |Usage links and link groups setup for a portal | 5 | 10 | 25
|
44
|
+
|
45
|
+
|
46
|
+
|
47
|
+
|
48
|
+
For more information about the API: [Full SDK Documentation](https://github.com/eGain/egain-api-python)
|
36
49
|
<!-- End Summary [summary] -->
|
37
50
|
|
38
51
|
<!-- Start Table of Contents [toc] -->
|
@@ -148,7 +161,7 @@ with Egain(
|
|
148
161
|
access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
|
149
162
|
) as egain:
|
150
163
|
|
151
|
-
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000",
|
164
|
+
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
|
152
165
|
"PROD-1234": [
|
153
166
|
"PROD-2000",
|
154
167
|
"PROD-2003",
|
@@ -180,7 +193,7 @@ async def main():
|
|
180
193
|
access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
|
181
194
|
) as egain:
|
182
195
|
|
183
|
-
res = await egain.aiservices.retrieve.retrieve_chunks_async(q="fair lending", portal_id="PROD-1000",
|
196
|
+
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={
|
184
197
|
"PROD-1234": [
|
185
198
|
"PROD-2000",
|
186
199
|
"PROD-2003",
|
@@ -220,7 +233,7 @@ with Egain(
|
|
220
233
|
access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
|
221
234
|
) as egain:
|
222
235
|
|
223
|
-
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000",
|
236
|
+
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
|
224
237
|
"PROD-1234": [
|
225
238
|
"PROD-2000",
|
226
239
|
"PROD-2003",
|
@@ -244,9 +257,6 @@ with Egain(
|
|
244
257
|
<details open>
|
245
258
|
<summary>Available methods</summary>
|
246
259
|
|
247
|
-
### [aiservices](docs/sdks/aiservices/README.md)
|
248
|
-
|
249
|
-
|
250
260
|
#### [aiservices.answers](docs/sdks/answers/README.md)
|
251
261
|
|
252
262
|
* [get_best_answer](docs/sdks/answers/README.md#get_best_answer) - Get the best answer for a user query
|
@@ -255,23 +265,16 @@ with Egain(
|
|
255
265
|
|
256
266
|
* [retrieve_chunks](docs/sdks/retrieve/README.md#retrieve_chunks) - Retrieve Chunks
|
257
267
|
|
258
|
-
### [content](docs/sdks/content/README.md)
|
259
|
-
|
260
|
-
|
261
268
|
#### [content.health](docs/sdks/health/README.md)
|
262
269
|
|
263
270
|
* [get_health](docs/sdks/health/README.md#get_health) - Check service health status
|
264
271
|
|
265
272
|
#### [content.import_](docs/sdks/import/README.md)
|
266
273
|
|
267
|
-
* [
|
268
|
-
* [
|
269
|
-
* [
|
270
|
-
* [
|
271
|
-
|
272
|
-
|
273
|
-
### [portal](docs/sdks/portalsdk/README.md)
|
274
|
-
|
274
|
+
* [create_import_job](docs/sdks/import/README.md#create_import_job) - Import content from external sources by creating an import job
|
275
|
+
* [get_import_status](docs/sdks/import/README.md#get_import_status) - Get the current status of an import or validation job
|
276
|
+
* [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
|
277
|
+
* [cancel_import](docs/sdks/import/README.md#cancel_import) - Cancel an import or validation job
|
275
278
|
|
276
279
|
#### [portal.article](docs/sdks/portalarticle/README.md)
|
277
280
|
|
@@ -441,7 +444,7 @@ with Egain(
|
|
441
444
|
access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
|
442
445
|
) as egain:
|
443
446
|
|
444
|
-
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000",
|
447
|
+
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
|
445
448
|
"PROD-1234": [
|
446
449
|
"PROD-2000",
|
447
450
|
"PROD-2003",
|
@@ -471,7 +474,7 @@ with Egain(
|
|
471
474
|
access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
|
472
475
|
) as egain:
|
473
476
|
|
474
|
-
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000",
|
477
|
+
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
|
475
478
|
"PROD-1234": [
|
476
479
|
"PROD-2000",
|
477
480
|
"PROD-2003",
|
@@ -516,7 +519,7 @@ with Egain(
|
|
516
519
|
res = None
|
517
520
|
try:
|
518
521
|
|
519
|
-
res = egain.content.import_.
|
522
|
+
res = egain.content.import_.create_import_job(data_source={
|
520
523
|
"type": "AWS S3 bucket",
|
521
524
|
"path": "s3://mybucket/myfolder/",
|
522
525
|
"region": "us-east-1",
|
@@ -573,43 +576,6 @@ with Egain(
|
|
573
576
|
<!-- Start Server Selection [server] -->
|
574
577
|
## Server Selection
|
575
578
|
|
576
|
-
### Server Variables
|
577
|
-
|
578
|
-
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:
|
579
|
-
|
580
|
-
| Variable | Parameter | Default | Description |
|
581
|
-
| ------------ | ----------------- | ------------------- | ----------- |
|
582
|
-
| `API_DOMAIN` | `api_domain: str` | `"api.egain.cloud"` | |
|
583
|
-
|
584
|
-
#### Example
|
585
|
-
|
586
|
-
```python
|
587
|
-
from egain_api_python import Egain
|
588
|
-
import os
|
589
|
-
|
590
|
-
|
591
|
-
with Egain(
|
592
|
-
api_domain="<value>"
|
593
|
-
access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
|
594
|
-
) as egain:
|
595
|
-
|
596
|
-
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={
|
597
|
-
"PROD-1234": [
|
598
|
-
"PROD-2000",
|
599
|
-
"PROD-2003",
|
600
|
-
],
|
601
|
-
"PROD-2005": [
|
602
|
-
"PROD-2007",
|
603
|
-
],
|
604
|
-
}, channel={
|
605
|
-
"name": "Eight Bank Website",
|
606
|
-
})
|
607
|
-
|
608
|
-
# Handle response
|
609
|
-
print(res)
|
610
|
-
|
611
|
-
```
|
612
|
-
|
613
579
|
### Override Server URL Per-Client
|
614
580
|
|
615
581
|
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:
|
@@ -619,11 +585,11 @@ import os
|
|
619
585
|
|
620
586
|
|
621
587
|
with Egain(
|
622
|
-
server_url="https://$
|
588
|
+
server_url="https://${API_DOMAIN}/knowledge/portalmgr/v4",
|
623
589
|
access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
|
624
590
|
) as egain:
|
625
591
|
|
626
|
-
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000",
|
592
|
+
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
|
627
593
|
"PROD-1234": [
|
628
594
|
"PROD-2000",
|
629
595
|
"PROD-2003",
|
@@ -652,7 +618,7 @@ with Egain(
|
|
652
618
|
access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
|
653
619
|
) as egain:
|
654
620
|
|
655
|
-
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000",
|
621
|
+
res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
|
656
622
|
"PROD-1234": [
|
657
623
|
"PROD-2000",
|
658
624
|
"PROD-2003",
|
@@ -662,7 +628,7 @@ with Egain(
|
|
662
628
|
],
|
663
629
|
}, channel={
|
664
630
|
"name": "Eight Bank Website",
|
665
|
-
}, server_url="https://$
|
631
|
+
}, server_url="https://${API_DOMAIN}/core/aiservices/v4")
|
666
632
|
|
667
633
|
# Handle response
|
668
634
|
print(res)
|
@@ -3,10 +3,10 @@
|
|
3
3
|
import importlib.metadata
|
4
4
|
|
5
5
|
__title__: str = "egain-api-python"
|
6
|
-
__version__: str = "0.1.
|
6
|
+
__version__: str = "0.1.4"
|
7
7
|
__openapi_doc_version__: str = "4.0.0"
|
8
|
-
__gen_version__: str = "2.
|
9
|
-
__user_agent__: str = "speakeasy-sdk/python 0.1.
|
8
|
+
__gen_version__: str = "2.723.2"
|
9
|
+
__user_agent__: str = "speakeasy-sdk/python 0.1.4 2.723.2 4.0.0 egain-api-python"
|
10
10
|
|
11
11
|
try:
|
12
12
|
if __package__ is not None:
|
@@ -15,14 +15,13 @@ class Answers(BaseSDK):
|
|
15
15
|
*,
|
16
16
|
q: str,
|
17
17
|
portal_id: str,
|
18
|
-
|
18
|
+
filter_user_profile_id: Optional[str] = None,
|
19
19
|
language: Optional[models.LanguageCodeParameter] = None,
|
20
|
-
|
21
|
-
|
20
|
+
filter_tags: Optional[Dict[str, List[str]]] = None,
|
21
|
+
filter_topic_ids: Optional[List[str]] = None,
|
22
22
|
channel: Optional[
|
23
23
|
Union[models.AnswersRequestChannel, models.AnswersRequestChannelTypedDict]
|
24
24
|
] = None,
|
25
|
-
context: Optional[Union[models.Context, models.ContextTypedDict]] = None,
|
26
25
|
event_id: Optional[str] = None,
|
27
26
|
session_id: Optional[str] = None,
|
28
27
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
@@ -33,20 +32,19 @@ class Answers(BaseSDK):
|
|
33
32
|
r"""Get the best answer for a user query
|
34
33
|
|
35
34
|
The **Answers API** allows enterprises to deliver fast, accurate, and contextual responses powered by their organizational knowledge. It supports two complementary approaches:
|
36
|
-
|
37
|
-
|
35
|
+
- **Certified Answers**: Direct snippets retrieved from enterprise-authored content.
|
36
|
+
- **Generative Answers**: Natural language responses synthesized by a large language model (LLM).
|
38
37
|
|
39
|
-
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.
|
38
|
+
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.**
|
40
39
|
|
41
40
|
|
42
41
|
:param q: The search query string. The string must be escaped as required by the URL syntax rules.
|
43
42
|
: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.
|
44
|
-
:param
|
43
|
+
:param filter_user_profile_id:
|
45
44
|
: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.
|
46
|
-
:param
|
47
|
-
:param
|
45
|
+
: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.
|
46
|
+
:param filter_topic_ids: An array of topic IDs. It is used to restrict search results to specific topics.
|
48
47
|
:param channel:
|
49
|
-
:param context: Additional contextual metadata that enriches the query, providing the LLM with relevant details for tailoring the response.
|
50
48
|
:param event_id: Unique ID for this specific API call or event.
|
51
49
|
: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.
|
52
50
|
:param retries: Override the default retry configuration for this method
|
@@ -63,22 +61,18 @@ class Answers(BaseSDK):
|
|
63
61
|
base_url = server_url
|
64
62
|
else:
|
65
63
|
base_url = models.GET_BEST_ANSWER_OP_SERVERS[0]
|
66
|
-
url_variables = {
|
67
|
-
"API_DOMAIN": "api.egain.cloud",
|
68
|
-
}
|
69
64
|
|
70
65
|
request = models.GetBestAnswerRequest(
|
71
66
|
q=q,
|
72
67
|
portal_id=portal_id,
|
73
|
-
|
68
|
+
filter_user_profile_id=filter_user_profile_id,
|
74
69
|
language=language,
|
75
|
-
|
76
|
-
|
70
|
+
filter_tags=filter_tags,
|
71
|
+
filter_topic_ids=filter_topic_ids,
|
77
72
|
answers_request=models.AnswersRequest(
|
78
73
|
channel=utils.get_pydantic_model(
|
79
74
|
channel, Optional[models.AnswersRequestChannel]
|
80
75
|
),
|
81
|
-
context=utils.get_pydantic_model(context, Optional[models.Context]),
|
82
76
|
event_id=event_id,
|
83
77
|
session_id=session_id,
|
84
78
|
),
|
@@ -120,7 +114,7 @@ class Answers(BaseSDK):
|
|
120
114
|
config=self.sdk_configuration,
|
121
115
|
base_url=base_url or "",
|
122
116
|
operation_id="getBestAnswer",
|
123
|
-
oauth2_scopes=
|
117
|
+
oauth2_scopes=None,
|
124
118
|
security_source=get_security_from_env(
|
125
119
|
self.sdk_configuration.security, models.Security
|
126
120
|
),
|
@@ -150,14 +144,13 @@ class Answers(BaseSDK):
|
|
150
144
|
*,
|
151
145
|
q: str,
|
152
146
|
portal_id: str,
|
153
|
-
|
147
|
+
filter_user_profile_id: Optional[str] = None,
|
154
148
|
language: Optional[models.LanguageCodeParameter] = None,
|
155
|
-
|
156
|
-
|
149
|
+
filter_tags: Optional[Dict[str, List[str]]] = None,
|
150
|
+
filter_topic_ids: Optional[List[str]] = None,
|
157
151
|
channel: Optional[
|
158
152
|
Union[models.AnswersRequestChannel, models.AnswersRequestChannelTypedDict]
|
159
153
|
] = None,
|
160
|
-
context: Optional[Union[models.Context, models.ContextTypedDict]] = None,
|
161
154
|
event_id: Optional[str] = None,
|
162
155
|
session_id: Optional[str] = None,
|
163
156
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
@@ -168,20 +161,19 @@ class Answers(BaseSDK):
|
|
168
161
|
r"""Get the best answer for a user query
|
169
162
|
|
170
163
|
The **Answers API** allows enterprises to deliver fast, accurate, and contextual responses powered by their organizational knowledge. It supports two complementary approaches:
|
171
|
-
|
172
|
-
|
164
|
+
- **Certified Answers**: Direct snippets retrieved from enterprise-authored content.
|
165
|
+
- **Generative Answers**: Natural language responses synthesized by a large language model (LLM).
|
173
166
|
|
174
|
-
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.
|
167
|
+
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.**
|
175
168
|
|
176
169
|
|
177
170
|
:param q: The search query string. The string must be escaped as required by the URL syntax rules.
|
178
171
|
: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.
|
179
|
-
:param
|
172
|
+
:param filter_user_profile_id:
|
180
173
|
: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.
|
181
|
-
:param
|
182
|
-
:param
|
174
|
+
: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.
|
175
|
+
:param filter_topic_ids: An array of topic IDs. It is used to restrict search results to specific topics.
|
183
176
|
:param channel:
|
184
|
-
:param context: Additional contextual metadata that enriches the query, providing the LLM with relevant details for tailoring the response.
|
185
177
|
:param event_id: Unique ID for this specific API call or event.
|
186
178
|
: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.
|
187
179
|
:param retries: Override the default retry configuration for this method
|
@@ -198,22 +190,18 @@ class Answers(BaseSDK):
|
|
198
190
|
base_url = server_url
|
199
191
|
else:
|
200
192
|
base_url = models.GET_BEST_ANSWER_OP_SERVERS[0]
|
201
|
-
url_variables = {
|
202
|
-
"API_DOMAIN": "api.egain.cloud",
|
203
|
-
}
|
204
193
|
|
205
194
|
request = models.GetBestAnswerRequest(
|
206
195
|
q=q,
|
207
196
|
portal_id=portal_id,
|
208
|
-
|
197
|
+
filter_user_profile_id=filter_user_profile_id,
|
209
198
|
language=language,
|
210
|
-
|
211
|
-
|
199
|
+
filter_tags=filter_tags,
|
200
|
+
filter_topic_ids=filter_topic_ids,
|
212
201
|
answers_request=models.AnswersRequest(
|
213
202
|
channel=utils.get_pydantic_model(
|
214
203
|
channel, Optional[models.AnswersRequestChannel]
|
215
204
|
),
|
216
|
-
context=utils.get_pydantic_model(context, Optional[models.Context]),
|
217
205
|
event_id=event_id,
|
218
206
|
session_id=session_id,
|
219
207
|
),
|
@@ -255,7 +243,7 @@ class Answers(BaseSDK):
|
|
255
243
|
config=self.sdk_configuration,
|
256
244
|
base_url=base_url or "",
|
257
245
|
operation_id="getBestAnswer",
|
258
|
-
oauth2_scopes=
|
246
|
+
oauth2_scopes=None,
|
259
247
|
security_source=get_security_from_env(
|
260
248
|
self.sdk_configuration.security, models.Security
|
261
249
|
),
|