egain-api-python 0.1.5__py3-none-any.whl → 0.1.6__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.5"
+__version__: str = "0.1.6"
 __openapi_doc_version__: str = "4.0.0"
 __gen_version__: str = "2.723.8"
-__user_agent__: str = "speakeasy-sdk/python 0.1.5 2.723.8 4.0.0 egain-api-python"
+__user_agent__: str = "speakeasy-sdk/python 0.1.6 2.723.8 4.0.0 egain-api-python"
 
 try:
     if __package__ is not None:

egain_api_python/models/additionalsnippets.py

@@ -22,12 +22,12 @@ class AdditionalSnippetsTypedDict(TypedDict):
     r"""The name of the Article or source content."""
     doc_type: AdditionalSnippetsDocType
     r"""Format of the source document (HTML, Doc, or PDF)."""
-    doc_name: str
-    r"""Name of the attachment, if an attachment was used as the source content."""
     snippet: str
     r"""A snippet of the article content."""
     relevance_score: float
     r"""Generated confidence score (0.0-1.0) for the snippet's relevance to the query."""
+    doc_name: NotRequired[str]
+    r"""Name of the attachment, if an attachment was used as the source content."""
     keyword_snippet: NotRequired[str]
     r"""A keyword snippet of the article content."""
 
@@ -42,15 +42,15 @@ class AdditionalSnippets(BaseModel):
     doc_type: Annotated[AdditionalSnippetsDocType, pydantic.Field(alias="docType")]
     r"""Format of the source document (HTML, Doc, or PDF)."""
 
-    doc_name: Annotated[str, pydantic.Field(alias="docName")]
-    r"""Name of the attachment, if an attachment was used as the source content."""
-
     snippet: str
     r"""A snippet of the article content."""
 
     relevance_score: Annotated[float, pydantic.Field(alias="relevanceScore")]
     r"""Generated confidence score (0.0-1.0) for the snippet's relevance to the query."""
 
+    doc_name: Annotated[Optional[str], pydantic.Field(alias="docName")] = None
+    r"""Name of the attachment, if an attachment was used as the source content."""
+
     keyword_snippet: Annotated[
         Optional[str], pydantic.Field(alias="keywordSnippet")
     ] = None

egain_api_python/models/referenceresponse.py

@@ -36,7 +36,7 @@ class ReferenceResponseTypedDict(TypedDict):
     r"""Source Type"""
     doc_name: NotRequired[str]
     r"""Name of the attachment, if an attachment was used as the source content."""
-    topic_bread_crumb: NotRequired[TopicBreadcrumbTypedDict]
+    topic_breadcrumb: NotRequired[TopicBreadcrumbTypedDict]
     r"""This schema contains one or more TopicSummary instances."""
 
 
@@ -58,7 +58,7 @@ class ReferenceResponse(BaseModel):
     doc_name: Annotated[Optional[str], pydantic.Field(alias="docName")] = None
     r"""Name of the attachment, if an attachment was used as the source content."""
 
-    topic_bread_crumb: Annotated[
-        Optional[TopicBreadcrumb], pydantic.Field(alias="topicBreadCrumb")
+    topic_breadcrumb: Annotated[
+        Optional[TopicBreadcrumb], pydantic.Field(alias="topicBreadcrumb")
     ] = None
     r"""This schema contains one or more TopicSummary instances."""

egain_api_python/models/searchresult.py

@@ -47,7 +47,7 @@ class SearchResultTypedDict(TypedDict):
     doc_name: NotRequired[str]
     r"""Name of the attachment, if an attachment was used as the source content."""
     snippet_type: NotRequired[SnippetType]
-    topic_bread_crumb: NotRequired[TopicBreadcrumbTypedDict]
+    topic_breadcrumb: NotRequired[TopicBreadcrumbTypedDict]
     r"""This schema contains one or more TopicSummary instances."""
 
 
@@ -79,7 +79,7 @@ class SearchResult(BaseModel):
         Optional[SnippetType], pydantic.Field(alias="snippetType")
     ] = None
 
-    topic_bread_crumb: Annotated[
-        Optional[TopicBreadcrumb], pydantic.Field(alias="topicBreadCrumb")
+    topic_breadcrumb: Annotated[
+        Optional[TopicBreadcrumb], pydantic.Field(alias="topicBreadcrumb")
     ] = None
     r"""This schema contains one or more TopicSummary instances."""

egain_api_python/retrieve.py

@@ -31,7 +31,14 @@ class Retrieve(BaseSDK):
     ) -> models.RetrieveResponse:
         r"""Retrieve Chunks
 
-        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. <br><br> In addition to raw chunk retrieval, the API can return **Certified Answers** if it meets the 'Certified Answer' threshold score. Responses include relevance scores, metadata, and references to maintain transparency and flexibility. By leveraging the Retrieve API, organizations can build tailored experiences while retaining confidence in the source material. <br>**This endpoint is only available for Self Service environments.**
+        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.
+
+        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.
+
 
         :param q: The search query string. The string must be escaped as required by the URL syntax rules.
         :param portal_id: The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
@@ -155,7 +162,14 @@ class Retrieve(BaseSDK):
     ) -> models.RetrieveResponse:
         r"""Retrieve Chunks
 
-        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. <br><br> In addition to raw chunk retrieval, the API can return **Certified Answers** if it meets the 'Certified Answer' threshold score. Responses include relevance scores, metadata, and references to maintain transparency and flexibility. By leveraging the Retrieve API, organizations can build tailored experiences while retaining confidence in the source material. <br>**This endpoint is only available for Self Service environments.**
+        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.
+
+        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.
+
 
         :param q: The search query string. The string must be escaped as required by the URL syntax rules.
         :param portal_id: The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.

{egain_api_python-0.1.5.dist-info → egain_api_python-0.1.6.dist-info}/METADATA

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

{egain_api_python-0.1.5.dist-info → egain_api_python-0.1.6.dist-info}/RECORD

@@ -1,5 +1,5 @@
 egain_api_python/__init__.py,sha256=w2u919V3Tzv4zEPQ-OYJ79gQ_4_SyW7GOFFoHtqXDFA,401
-egain_api_python/_version.py,sha256=QqhIeNPHWRR9wc_yncnTczCZSzP3lrTJgimzN7CFnLo,474
+egain_api_python/_version.py,sha256=zAkqg0Tfih-_65oF12ZHWFRktseWO-9nNyoYfTUkzF8,474
 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=Z9YN7G-H0-i6JKHVyz1jH0_GRWo62-8rmlCHRucHJqM,12916
+egain_api_python/retrieve.py,sha256=LSGK3MUl3Mrm4EM5DRy-vBqFMC_Q3D7yAu59sxJbEyg,12954
 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
@@ -49,7 +49,7 @@ egain_api_python/models/action.py,sha256=hauC8RWqyEO2S93V6znUBWBufstlX0LCzPRdWwr
 egain_api_python/models/actionsearch.py,sha256=xqidx2iPiD70RgcKPWQtaQHZnDM7ZuC4D-1uk8i0dXo,3267
 egain_api_python/models/addasreferenceop.py,sha256=wI6rSFt4a2HZeHiuhk2B4L2it07b_fT9WR_LThte7R4,2175
 egain_api_python/models/addbookmarkop.py,sha256=LKKQcTe_qJh2Y0PRJhqMLgvt6z_xV7V-6bp4aQE8FQ4,1692
-egain_api_python/models/additionalsnippets.py,sha256=Vd98HJCxGPKlYMwp5n3oPoouZaLrUD7FSOxowwONClg,2070
+egain_api_python/models/additionalsnippets.py,sha256=npkbv_ra0_BMqKTFvXp0LANLq69vGSc5BOcNOHk8pk8,2100
 egain_api_python/models/addtoreplyop.py,sha256=WLak-A5Q7_y9uLQmdqvmdfj6HZFDuqbWXC-E8kOIngo,2167
 egain_api_python/models/aisearchop.py,sha256=FZ8RGf-igHBNJ8s7GLu4s_S7CD4XW-0NdxLkalvrfzQ,4697
 egain_api_python/models/aisearchresponse.py,sha256=a_HVDEbWjiiXGz5wqAtJJ77Y5bWaxzhFUx5XtrIuApE,2069
@@ -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=I2x3FZtu6uLDJgpdT9HlFppsq5lG1UF1hPnSLpr_UIo,2149
+egain_api_python/models/referenceresponse.py,sha256=G06WC9VVURzgw9QVS15E7r0B7ykjtB4ZMiPu_U-TGt8,2147
 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=dzzwpooqj2MvAmxpdx8oguIs4DsEU-BhtP2YyXkQ_ng,3333
+egain_api_python/models/searchresult.py,sha256=y-sysMGzKwzC3TR0wMeFqtJ5nryc15ebtzYvxqc1yRs,3331
 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.5.dist-info/licenses/LICENSE,sha256=ICtvDBOvFUvPgUEGtnyxAarCTU0IASpQZdnv8QMnHlI,1062
-egain_api_python-0.1.5.dist-info/METADATA,sha256=9ME-oOMYDZ2uDtyNPaRArY-h_kkuoGzS4ONLc2c5m-s,33248
-egain_api_python-0.1.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-egain_api_python-0.1.5.dist-info/top_level.txt,sha256=SjFjGp6Ocutn5yM4tqZHMJwpuZxFzT6qiIcELk251PA,17
-egain_api_python-0.1.5.dist-info/RECORD,,
+egain_api_python-0.1.6.dist-info/licenses/LICENSE,sha256=ICtvDBOvFUvPgUEGtnyxAarCTU0IASpQZdnv8QMnHlI,1062
+egain_api_python-0.1.6.dist-info/METADATA,sha256=JAFp9FjXt9myVNpLimY4bKkr0uBbJI3nU1NumQSSYVM,33248
+egain_api_python-0.1.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+egain_api_python-0.1.6.dist-info/top_level.txt,sha256=SjFjGp6Ocutn5yM4tqZHMJwpuZxFzT6qiIcELk251PA,17
+egain_api_python-0.1.6.dist-info/RECORD,,