egain-api-python 0.1.5__tar.gz → 0.1.6__tar.gz

{egain_api_python-0.1.5/src/egain_api_python.egg-info → egain_api_python-0.1.6}/PKG-INFO

@@ -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 → egain_api_python-0.1.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "egain-api-python"
-version = "0.1.5"
+version = "0.1.6"
 description = "Python Client SDK Generated by Speakeasy."
 authors = [{ name = "Speakeasy" },]
 readme = "README.md"

{egain_api_python-0.1.5 → egain_api_python-0.1.6}/src/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-0.1.5 → egain_api_python-0.1.6}/src/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-0.1.5 → egain_api_python-0.1.6}/src/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-0.1.5 → egain_api_python-0.1.6}/src/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-0.1.5 → egain_api_python-0.1.6}/src/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 → egain_api_python-0.1.6/src/egain_api_python.egg-info}/PKG-INFO

@@ -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