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

egain_api_python/_version.py

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

egain_api_python/models/referenceresponse.py

@@ -10,10 +10,11 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 ReferenceResponseDocType = Literal[
     "HTML",
-    "Doc",
+    "DOCX",
     "PDF",
+    "PPTX",
 ]
-r"""Format of the source document (HTML, Doc, or PDF)."""
+r"""Format of the source document (HTML, DOCX, PPTX, or PDF)."""
 
 
 ReferenceResponseSource = Literal[
@@ -31,7 +32,7 @@ class ReferenceResponseTypedDict(TypedDict):
     name: str
     r"""The name of the Article or source content."""
     doc_type: ReferenceResponseDocType
-    r"""Format of the source document (HTML, Doc, or PDF)."""
+    r"""Format of the source document (HTML, DOCX, PPTX, or PDF)."""
     source: ReferenceResponseSource
     r"""Source Type"""
     doc_name: NotRequired[str]
@@ -49,7 +50,7 @@ class ReferenceResponse(BaseModel):
     r"""The name of the Article or source content."""
 
     doc_type: Annotated[ReferenceResponseDocType, pydantic.Field(alias="docType")]
-    r"""Format of the source document (HTML, Doc, or PDF)."""
+    r"""Format of the source document (HTML, DOCX, PPTX, or PDF)."""
 
     source: ReferenceResponseSource
     r"""Source Type"""

egain_api_python/models/searchresult.py

@@ -10,10 +10,11 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 SearchResultDocType = Literal[
     "HTML",
-    "Doc",
-    "Pdf",
+    "DOCX",
+    "PDF",
+    "PPTX",
 ]
-r"""Format of the source document (HTML, Doc, or PDF)."""
+r"""Format of the source document (HTML, DOCX, PPTX, or PDF)."""
 
 
 SearchResultSource = Literal[
@@ -37,7 +38,7 @@ class SearchResultTypedDict(TypedDict):
     name: str
     r"""The name of the Article or source content."""
     doc_type: SearchResultDocType
-    r"""Format of the source document (HTML, Doc, or PDF)."""
+    r"""Format of the source document (HTML, DOCX, PPTX, or PDF)."""
     source: SearchResultSource
     r"""The repository or system where the content originated (e.g., eGain Article, eGain Attachment)."""
     snippet: str
@@ -60,7 +61,7 @@ class SearchResult(BaseModel):
     r"""The name of the Article or source content."""
 
     doc_type: Annotated[SearchResultDocType, pydantic.Field(alias="docType")]
-    r"""Format of the source document (HTML, Doc, or PDF)."""
+    r"""Format of the source document (HTML, DOCX, PPTX, or PDF)."""
 
     source: SearchResultSource
     r"""The repository or system where the content originated (e.g., eGain Article, eGain Attachment)."""

egain_api_python/retrieve.py

@@ -33,9 +33,9 @@ class Retrieve(BaseSDK):
 
         The Retrieve API enables enterprises to directly access relevant content chunks from their organizational knowledge sources. It is designed for scenarios where developers want granular control over retrieved information, such as powering custom search, analytics, or retrieval-augmented generation (RAG) pipelines.
 
-        The Retrieve API operates through two main pipelines:
-        - **Certified Answers**: provide verified, high-confidence answers.
-        - **Chunk Retrieval**: retrieves fine-grained, contextually relevant content snippets.
+        The Retrieve API's response will either be a Certified Answer or a list of chunks.
+        - **Certified Answers Response**: This response is observed when there's a matching certified answer to the user's query.
+        - **Chunk List Response**: This response is observed, if there is no matched Certified Answer.
 
         Responses for both chunks and certified answers include relevance scores and metadata. By leveraging the Retrieve API, organizations can build tailored experiences while retaining confidence in the source material.
 
@@ -164,9 +164,9 @@ class Retrieve(BaseSDK):
 
         The Retrieve API enables enterprises to directly access relevant content chunks from their organizational knowledge sources. It is designed for scenarios where developers want granular control over retrieved information, such as powering custom search, analytics, or retrieval-augmented generation (RAG) pipelines.
 
-        The Retrieve API operates through two main pipelines:
-        - **Certified Answers**: provide verified, high-confidence answers.
-        - **Chunk Retrieval**: retrieves fine-grained, contextually relevant content snippets.
+        The Retrieve API's response will either be a Certified Answer or a list of chunks.
+        - **Certified Answers Response**: This response is observed when there's a matching certified answer to the user's query.
+        - **Chunk List Response**: This response is observed, if there is no matched Certified Answer.
 
         Responses for both chunks and certified answers include relevance scores and metadata. By leveraging the Retrieve API, organizations can build tailored experiences while retaining confidence in the source material.
 

{egain_api_python-0.1.8.dist-info → egain_api_python-0.1.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: egain-api-python
-Version: 0.1.8
+Version: 0.1.9
 Summary: Python Client SDK Generated by Speakeasy.
 Author: Speakeasy
 Requires-Python: >=3.9.2

{egain_api_python-0.1.8.dist-info → egain_api_python-0.1.9.dist-info}/RECORD

@@ -1,5 +1,5 @@
 egain_api_python/__init__.py,sha256=w2u919V3Tzv4zEPQ-OYJ79gQ_4_SyW7GOFFoHtqXDFA,401
-egain_api_python/_version.py,sha256=ho3uJdCY_lqZBpN7gLrg0DvkfpMZMfOWh-6-OrHStGM,476
+egain_api_python/_version.py,sha256=60bLXNxR3Ae5Qmv-uojlwkMpOIJsBkQpHgGbMNWZ9FA,476
 egain_api_python/aiservices.py,sha256=vFG7gOYnOknIMJvxgzD2dUFFqtlsD2WZoLrrb-YpbKM,787
 egain_api_python/answers.py,sha256=SjgG4GQNR3cZLXae0CXEp23FgKun0XrLFO-ZYl0wtAc,12769
 egain_api_python/articlelists.py,sha256=j29Fvkfjuq9OZbmMnlZm1WPkdz2eu2zkdvxd8JULzz8,23630
@@ -24,7 +24,7 @@ egain_api_python/portal_topic.py,sha256=qAWWdS-8QIjk0eZz8H41NrhLDh2zBqRaktCGSWRF
 egain_api_python/portal_userdetails.py,sha256=2GX9Rcx3lsLCnKzJhcnLTblXucmpnDXsN1hQRBg9MBA,8727
 egain_api_python/portal_userprofile.py,sha256=Besu9eXLochrHKQDIvecDKPCkZzKK6Ks-4J2Kl8disM,18895
 egain_api_python/py.typed,sha256=zrp19r0G21lr2yRiMC0f8MFkQFGj9wMpSbboePMg8KM,59
-egain_api_python/retrieve.py,sha256=LSGK3MUl3Mrm4EM5DRy-vBqFMC_Q3D7yAu59sxJbEyg,12954
+egain_api_python/retrieve.py,sha256=eJuMm-2za7QAHY7Qsj9KV5MQexvvLQBYPZubNUxRdi4,13136
 egain_api_python/sdk.py,sha256=UdGlQRaLy66ujS2hKtLxwFs4j9chPvkv5dBzjNf4Eg0,8747
 egain_api_python/sdkconfiguration.py,sha256=nFhpX1-i5QKAweb124Yd1YYRXh9dU671gDMm0ra6iUo,1635
 egain_api_python/search.py,sha256=rwdpqvim6S5Z0HNGxe3ln4LHk1KqomTm8qNEWGFBnGE,11881
@@ -240,7 +240,7 @@ egain_api_python/models/quickpickrating.py,sha256=OwZU3xsJzPYLAtcJJuvHMkZCO8NQF0
 egain_api_python/models/quickpickresult.py,sha256=YH0Ml5gq3yJvWOoDBFAW1XNPEomyHJXTuPLkv40tb-I,1037
 egain_api_python/models/quickpickresults.py,sha256=kUHHWZjFgmwsNEox9ehGsgU5wcapm3qD4uz0kAlWeio,865
 egain_api_python/models/ratearticleop.py,sha256=QQiRo2K35ctT4kjBS3ri6ImepxhIVagCanaREYP1zWg,3224
-egain_api_python/models/referenceresponse.py,sha256=uVtbCd_pLliWd8NNw3Qsa0C4Zezfk6b6LHQIIjen5Bw,2029
+egain_api_python/models/referenceresponse.py,sha256=K-vzwy4X2ZoGYSj0LmVbxxtAebrBO7wJ4Qx1G4Nfdno,2063
 egain_api_python/models/rejectghsolutionop.py,sha256=e24KKMYYRRKUeXmfQmuaVL0VqLEW0k6ntjdGoV5ZTXE,2040
 egain_api_python/models/relatedquestions.py,sha256=-mrpY6GvMaywlW5xejN3L7CT36hGLsxfy6jqIsxtNH0,879
 egain_api_python/models/restorequickpickop.py,sha256=N9fl3zebetUpOa3JEbzLnRcArqjXtTx_QPANUYXsgSU,2791
@@ -259,7 +259,7 @@ egain_api_python/models/schemas_tags.py,sha256=Z1ZAiHqxbDpbxh_p7Jh-6mYPEir9riBpT
 egain_api_python/models/schemas_wserrorcommon.py,sha256=R9OG3XOhiyet3uibAoDNGZPeq2rnPcHL0Nl0Y4OA8R0,424
 egain_api_python/models/searchfilterattribute.py,sha256=Ih4EgldWKl-QPE9VRPspiDoaMcGuuzgqMgTC44ekp4Y,2512
 egain_api_python/models/searchpriortoescalationop.py,sha256=sAiAszG3ywEqQ23Xm5US4OKSlSDraisRlUWNSS_vOyA,4807
-egain_api_python/models/searchresult.py,sha256=Ohws-gaFWb_Lk8TlF3n2DYIIKk3NGRLnubNbww3j48Y,3213
+egain_api_python/models/searchresult.py,sha256=GnU-3wtMVAZaywuuYwVBY6gvEAwuxSou7ixwl_j_umM,3247
 egain_api_python/models/searchsuggestionop.py,sha256=4tluMg5_fDxMXyNH1Oi4UKo5p3u4kcv2LpP-SA4iK-w,3792
 egain_api_python/models/security.py,sha256=UqCkttTO29yuwhatMKhQEeEjjbD1FtXL_SAQTrDGsao,710
 egain_api_python/models/selectuserprofileop.py,sha256=iQjtJlat8byVpk7YsE4fTfgLShwbNYaVov4p4JtV2wE,1703
@@ -323,8 +323,8 @@ egain_api_python/utils/serializers.py,sha256=Hndks5M_rJXVub_N5lu0gKZQUoEmWrn6PN7
 egain_api_python/utils/unmarshal_json_response.py,sha256=nZEaLmlsWi3z3q8Qp7ZM2jgxizRcfOBA7l8GPJuv1SY,592
 egain_api_python/utils/url.py,sha256=BgGPgcTA6MRK4bF8fjP2dUopN3NzEzxWMXPBVg8NQUA,5254
 egain_api_python/utils/values.py,sha256=CcaCXEa3xHhkUDROyXZocN8f0bdITftv9Y0P9lTf0YM,3517
-egain_api_python-0.1.8.dist-info/licenses/LICENSE,sha256=ICtvDBOvFUvPgUEGtnyxAarCTU0IASpQZdnv8QMnHlI,1062
-egain_api_python-0.1.8.dist-info/METADATA,sha256=-cQOWrjZaxU3o3qYfHHcGorEheuA6yOcTExID8GGQ6Y,33248
-egain_api_python-0.1.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-egain_api_python-0.1.8.dist-info/top_level.txt,sha256=SjFjGp6Ocutn5yM4tqZHMJwpuZxFzT6qiIcELk251PA,17
-egain_api_python-0.1.8.dist-info/RECORD,,
+egain_api_python-0.1.9.dist-info/licenses/LICENSE,sha256=ICtvDBOvFUvPgUEGtnyxAarCTU0IASpQZdnv8QMnHlI,1062
+egain_api_python-0.1.9.dist-info/METADATA,sha256=LkWy1UJUd5Fe49TazmEx2tDhTh1rW-lYj21ECSIrJCo,33248
+egain_api_python-0.1.9.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+egain_api_python-0.1.9.dist-info/top_level.txt,sha256=SjFjGp6Ocutn5yM4tqZHMJwpuZxFzT6qiIcELk251PA,17
+egain_api_python-0.1.9.dist-info/RECORD,,