kodexa 7.0.11219398096__tar.gz → 7.0.11233302476__tar.gz

{kodexa-7.0.11219398096 → kodexa-7.0.11233302476}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kodexa
-Version: 7.0.11219398096
+Version: 7.0.11233302476
 Summary: Python SDK for the Kodexa Platform
 Author: Austin Redenbaugh
 Author-email: austin@kodexa.com

{kodexa-7.0.11219398096 → kodexa-7.0.11233302476}/kodexa/model/objects.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
-from typing import Union, Set
 from enum import Enum
 from typing import Optional, List, Dict, Any
+from typing import Union
+
 from pydantic import AnyUrl, Field, RootModel, BaseModel, ConfigDict
 
 from kodexa.model.base import StandardDateTime
@@ -2550,6 +2551,7 @@ class TaxonCardinality(Enum):
     ONCE_PER_SEGMENT = "ONCE_PER_SEGMENT"
     MULTIPLE_PER_SEGMENT = "MULTIPLE_PER_SEGMENT"
 
+
 class TaxonAdditionContextType(str, Enum):
     RECORD_DEFINITION = "RECORD_DEFINITION"
     RECORD_SECTION_STARTER_MARKER = "RECORD_SECTION_STARTER_MARKER"
@@ -2557,6 +2559,7 @@ class TaxonAdditionContextType(str, Enum):
     RECORD_START_MARKER = "RECORD_START_MARKER"
     RECORD_END_MARKER = "RECORD_END_MARKER"
 
+
 class TaxonAdditionContext(BaseModel):
     type: TaxonAdditionContextType
     context: str
@@ -2881,7 +2884,6 @@ class TaskStatus(str, Enum):
 
 
 class TaskCheckItem(BaseModel):
-
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2896,7 +2898,6 @@ class TaskCheckItem(BaseModel):
 
 
 class TaskMetadata(BaseModel):
-
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -2911,7 +2912,6 @@ class TaskMetadata(BaseModel):
 
 
 class Task(BaseModel):
-
     model_config = ConfigDict(
         populate_by_name=True,
         use_enum_values=True,
@@ -3426,6 +3426,28 @@ class PageProject(BaseModel):
     empty: Optional[bool] = None
 
 
+class PageRetainedGuidance(BaseModel):
+    """
+
+    """
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    total_pages: Optional[int] = Field(None, alias="totalPages")
+    total_elements: Optional[int] = Field(None, alias="totalElements")
+    size: Optional[int] = None
+    content: Optional[List[RetainedGuidance]] = None
+    number: Optional[int] = None
+
+    number_of_elements: Optional[int] = Field(None, alias="numberOfElements")
+    first: Optional[bool] = None
+    last: Optional[bool] = None
+    empty: Optional[bool] = None
+
+
 class PageAssistant(BaseModel):
     """
 
@@ -3952,6 +3974,42 @@ class DocumentExternalData(BaseModel):
     external_data: Optional[Dict[str, Any]] = Field(None, alias="externalData")
     document_family: Optional[DocumentFamily] = Field(None, alias="documentFamily")
 
+
+class RetainedGuidance(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+
+    guidance_embeddings: List["GuidanceEmbedding"] = Field(default_factory=list, alias="guidanceEmbeddings")
+    guidance_set_ref: str = Field(..., alias="guidanceSetRef")
+    guidance_type: Optional[str] = Field(None, alias="guidanceType")
+    guidance_key: Optional[str] = Field(None, alias="guidanceKey")
+    taxonomy_ref: Optional[str] = Field(None, alias="taxonomyRef")
+    taxon_path: Optional[str] = Field(None, alias="taxonPath")
+    document_family_id: Optional[str] = Field(None, alias="documentFamilyId")
+    guidance_text: Optional[str] = Field(None, alias="guidanceText")
+    summary: Optional[str] = None
+    guidance_response: Dict[str, Any] = Field(default_factory=dict, alias="guidanceResponse")
+    legacy_guidance: Optional[Guidance] = Field(None, alias="legacyGuidance")
+    active: bool = True
+    taxon_snapshots: List[Taxon] = Field(default_factory=list, alias="taxonSnapshots")
+
+
+class GuidanceEmbedding(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+
+    retained_guidance: Optional[RetainedGuidance] = Field(None, alias="retainedGuidance")
+    # Add other fields as needed
+
+
 class DocumentFamily(BaseModel):
     """
 
@@ -4039,6 +4097,7 @@ class DocumentFamily(BaseModel):
         description="Indicates whether guidance is available for this document family",
     )
 
+
 class DocumentFamilyStatistics(BaseModel):
     """
 
@@ -4454,6 +4513,7 @@ class GuidanceEmbeddingType(Enum):
     CONTENT = "CONTENT"
     TFIDF = "TFIDF"
 
+
 class GuidanceSetStorage(BaseModel):
     model_config = ConfigDict(
         populate_by_name=True,
@@ -4467,6 +4527,7 @@ class GuidanceSetStorage(BaseModel):
     embedding_model_id: Optional[str] = Field(None, alias="embeddingModelId")
     embedding_types: List[GuidanceEmbeddingType] = Field(default_factory=list, alias="embeddingTypes")
 
+
 class GuidanceSet(ExtensionPackProvided):
     """
     A guidance set is a list of guidance objects that can be applied to a taxonomy
@@ -4478,7 +4539,8 @@ class GuidanceSet(ExtensionPackProvided):
         protected_namespaces=("model_config",),
     )
 
-    active_store: bool = Field(False, alias="activeStore", description="If true, allows guidance to be stored through the API")
+    active_store: bool = Field(False, alias="activeStore",
+                               description="If true, allows guidance to be stored through the API")
     storage: GuidanceSetStorage = Field(default_factory=GuidanceSetStorage)
     guidance: List[Guidance] = Field(default_factory=list, description="The guidance in the set")
 

{kodexa-7.0.11219398096 → kodexa-7.0.11233302476}/kodexa/platform/client.py

@@ -86,7 +86,7 @@ from kodexa.model.objects import (
     PageExtensionPack,
     PageOrganization,
     DocumentFamilyStatistics, MessageContext, PagePrompt, Prompt, GuidanceSet, PageGuidanceSet, DocumentEmbedding,
-    DocumentExternalData, Task, PageTask,
+    DocumentExternalData, Task, PageTask, RetainedGuidance, PageRetainedGuidance,
 )
 
 logger = logging.getLogger()
@@ -1178,6 +1178,30 @@ class PageTaskEndpoint(PageTask, PageEndpoint):
         return "task"
 
 
+class PageRetainedGuidanceEndpoint(PageRetainedGuidance, PageEndpoint):
+    """Represents a page retained guidance endpoint.
+
+    This class is used to represent a page retained guidance endpoint which is a
+    combination of a page retained guidance and a page endpoint.
+
+    Attributes:
+        None
+    """
+
+    """Represents a page retained guidance endpoint"""
+
+    def get_type(self) -> Optional[str]:
+        """Get the type of the endpoint.
+
+        This method is used to get the type of the endpoint. In this case,
+        it will always return "retainedGuidance".
+
+        Returns:
+            str: The type of the endpoint, which is "retainedGuidance".
+        """
+        return "retainedGuidance"
+
+
 class PageProjectEndpoint(PageProject, PageEndpoint):
     """Represents a page project endpoint.
 
@@ -2521,11 +2545,13 @@ class WorkspaceEndpoint(EntityEndpoint, Workspace):
         else:
             raise ValueError("Workspace has no channel")
 
+
 class TaskEndpoint(EntityEndpoint, Task):
     """Represents a task endpoint.
 
     This class is used to interact with the task endpoint of the API.
     """
+
     def get_type(self) -> str:
         """Get the type of the endpoint.
 
@@ -2535,11 +2561,27 @@ class TaskEndpoint(EntityEndpoint, Task):
         return "tasks"
 
 
+class RetainedGuidanceEndpoint(EntityEndpoint, RetainedGuidance):
+    """Represents a retained guidance endpoint.
+
+    This class is used to interact with the retained guidance endpoint of the API.
+    """
+
+    def get_type(self) -> str:
+        """Get the type of the endpoint.
+
+        Returns:
+            str: The type of the endpoint, in this case "retainedGuidance".
+        """
+        return "retainedGuidance"
+
+
 class ProjectEndpoint(EntityEndpoint, Project):
     """Represents a project endpoint.
 
     This class is used to interact with the project endpoint of the API.
     """
+
     def get_type(self) -> str:
         """Get the type of the endpoint.
 
@@ -2897,6 +2939,39 @@ class TasksEndpoint(EntitiesEndpoint):
         return PageTaskEndpoint
 
 
+class RetainedGuidancesEndpoint(EntitiesEndpoint):
+    """Represents a projects endpoint"""
+
+    """Represents a projects endpoint"""
+
+    def get_type(self) -> str:
+        """
+        Get the type of the endpoint.
+
+        Returns:
+            str: The type of the endpoint.
+        """
+        return "retainedGuidance"
+
+    def get_instance_class(self, object_dict=None):
+        """
+        Get the instance class of the endpoint.
+
+        Returns:
+            ProjectEndpoint: The instance class of the endpoint.
+        """
+        return RetainedGuidanceEndpoint
+
+    def get_page_class(self, object_dict=None):
+        """
+        Get the page class of the endpoint.
+
+        Returns:
+            PageProjectEndpoint: The page class of the endpoint.
+        """
+        return PageRetainedGuidanceEndpoint
+
+
 class ProjectsEndpoint(EntitiesEndpoint):
     """Represents a projects endpoint"""
 
@@ -6400,6 +6475,10 @@ class KodexaClient:
         executions (ExecutionsEndpoint): An endpoint for executions.
         channels (ChannelsEndpoint): An endpoint for channels.
         messages (MessagesEndpoint): An endpoint for messages.
+        assistants (AssistantsEndpoint): An endpoint for assistants.
+        products (ProductsEndpoint): An endpoint for products.
+        tasks (TasksEndpoint): An endpoint for tasks.
+        retained_guidances (RetainedGuidancesEndpoint): An endpoint for retained guidances.
     """
 
     def __init__(self, url=None, access_token=None, profile=None):
@@ -6423,6 +6502,7 @@ class KodexaClient:
         from kodexa.model.entities.product import ProductsEndpoint
         self.products = ProductsEndpoint(self)
         self.tasks = TasksEndpoint(self)
+        self.retained_guidances = RetainedGuidancesEndpoint(self)
 
     @staticmethod
     def login(url, token):
@@ -6439,7 +6519,6 @@ class KodexaClient:
         Raises:
             Exception: If the status code is not 200.
         """
-        from requests.auth import HTTPBasicAuth
 
         obj_response = requests.get(
             f"{url}/api/account/me",
@@ -6820,7 +6899,6 @@ class KodexaClient:
                     )
                 )
 
-
     def import_project(self, organization: OrganizationEndpoint, import_path: str):
         """
         A method to import a project.

{kodexa-7.0.11219398096 → kodexa-7.0.11233302476}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "kodexa"
-version = "7.0.011219398096"
+version = "7.0.011233302476"
 description = "Python SDK for the Kodexa Platform"
 authors = ["Austin Redenbaugh <austin@kodexa.com>", "Philip Dodds <philip@kodexa.com>", "Romar Cablao <rcablao@kodexa.com>", "Amadea Paula Dodds <amadeapaula@kodexa.com>"]
 readme = "README.md"