structifyai 1.176.1__tar.gz → 1.177.0__tar.gz

structifyai-1.177.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "1.177.0"
+}

{structifyai-1.176.1 → structifyai-1.177.0}/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.177.0 (2026-01-21)
+
+Full Changelog: [v1.176.1...v1.177.0](https://github.com/StructifyAI/structify-python/compare/v1.176.1...v1.177.0)
+
+### Features
+
+* Update from Structify backend changes ([8c3c30d](https://github.com/StructifyAI/structify-python/commit/8c3c30dee92130f413ccf51217cba47673c5964a))
+
 ## 1.176.1 (2026-01-21)
 
 Full Changelog: [v1.176.0...v1.176.1](https://github.com/StructifyAI/structify-python/compare/v1.176.0...v1.176.1)

{structifyai-1.176.1 → structifyai-1.177.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: structifyai
-Version: 1.176.1
+Version: 1.177.0
 Summary: The official Python library for the structify API
 Project-URL: Homepage, https://github.com/StructifyAI/structify-python
 Project-URL: Repository, https://github.com/StructifyAI/structify-python

{structifyai-1.176.1 → structifyai-1.177.0}/api.md

@@ -529,8 +529,9 @@ from structify.types import (
     AutofixContext,
     ConfirmNodeRequest,
     CreateWorkflowSessionRequest,
+    Dashboard,
     DashboardComponent,
-    DashboardLayout,
+    DashboardPage,
     EdgeSpec,
     FinalizeDagRequest,
     FinalizeDagResponse,

{structifyai-1.176.1 → structifyai-1.177.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "structifyai"
-version = "1.176.1"
+version = "1.177.0"
 description = "The official Python library for the structify API"
 dynamic = ["readme"]
 license = "Apache-2.0"

{structifyai-1.176.1 → structifyai-1.177.0}/src/structify/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "structify"
-__version__ = "1.176.1"  # x-release-please-version
+__version__ = "1.177.0"  # x-release-please-version

{structifyai-1.176.1 → structifyai-1.177.0}/src/structify/resources/sessions.py

@@ -44,13 +44,13 @@ from .._response import (
 from .._base_client import make_request_options
 from ..types.workflow_dag import WorkflowDag
 from ..types.autofix_context import AutofixContext
+from ..types.dashboard_param import DashboardParam
 from ..types.edge_spec_param import EdgeSpecParam
 from ..types.node_spec_param import NodeSpecParam
 from ..types.workflow_session import WorkflowSession
 from ..types.get_node_response import GetNodeResponse
 from ..types.finalize_dag_response import FinalizeDagResponse
 from ..types.workflow_session_node import WorkflowSessionNode
-from ..types.dashboard_layout_param import DashboardLayoutParam
 from ..types.get_node_logs_response import GetNodeLogsResponse
 from ..types.session_kill_jobs_response import SessionKillJobsResponse
 from ..types.session_get_events_response import SessionGetEventsResponse
@@ -156,7 +156,7 @@ class SessionsResource(SyncAPIResource):
         *,
         edges: Iterable[EdgeSpecParam],
         nodes: Iterable[NodeSpecParam],
-        dashboard_layout: Optional[DashboardLayoutParam] | Omit = omit,
+        dashboard_layout: Optional[DashboardParam] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -169,6 +169,9 @@ class SessionsResource(SyncAPIResource):
         ready
 
         Args:
+          dashboard_layout: A page is the top-level container with title/description Can contain multiple
+              dashboards with different datasets
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -611,7 +614,7 @@ class SessionsResource(SyncAPIResource):
         self,
         session_id: str,
         *,
-        layout: DashboardLayoutParam,
+        layout: DashboardParam,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -621,6 +624,9 @@ class SessionsResource(SyncAPIResource):
     ) -> WorkflowSession:
         """
         Args:
+          layout: A page is the top-level container with title/description Can contain multiple
+              dashboards with different datasets
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -823,7 +829,7 @@ class AsyncSessionsResource(AsyncAPIResource):
         *,
         edges: Iterable[EdgeSpecParam],
         nodes: Iterable[NodeSpecParam],
-        dashboard_layout: Optional[DashboardLayoutParam] | Omit = omit,
+        dashboard_layout: Optional[DashboardParam] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -836,6 +842,9 @@ class AsyncSessionsResource(AsyncAPIResource):
         ready
 
         Args:
+          dashboard_layout: A page is the top-level container with title/description Can contain multiple
+              dashboards with different datasets
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -1278,7 +1287,7 @@ class AsyncSessionsResource(AsyncAPIResource):
         self,
         session_id: str,
         *,
-        layout: DashboardLayoutParam,
+        layout: DashboardParam,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -1288,6 +1297,9 @@ class AsyncSessionsResource(AsyncAPIResource):
     ) -> WorkflowSession:
         """
         Args:
+          layout: A page is the top-level container with title/description Can contain multiple
+              dashboards with different datasets
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request

{structifyai-1.176.1 → structifyai-1.177.0}/src/structify/types/__init__.py

@@ -12,6 +12,7 @@ from .project import Project as Project
 from .sandbox import Sandbox as Sandbox
 from .strategy import Strategy as Strategy
 from .connector import Connector as Connector
+from .dashboard import Dashboard as Dashboard
 from .team_role import TeamRole as TeamRole
 from .user_info import UserInfo as UserInfo
 from .chat_event import ChatEvent as ChatEvent
@@ -29,6 +30,7 @@ from .workflow_dag import WorkflowDag as WorkflowDag
 from .chat_template import ChatTemplate as ChatTemplate
 from .property_type import PropertyType as PropertyType
 from .tool_metadata import ToolMetadata as ToolMetadata
+from .dashboard_page import DashboardPage as DashboardPage
 from .job_event_body import JobEventBody as JobEventBody
 from .project_member import ProjectMember as ProjectMember
 from .strategy_param import StrategyParam as StrategyParam
@@ -38,6 +40,7 @@ from .token_response import TokenResponse as TokenResponse
 from .autofix_context import AutofixContext as AutofixContext
 from .chat_dependency import ChatDependency as ChatDependency
 from .chat_visibility import ChatVisibility as ChatVisibility
+from .dashboard_param import DashboardParam as DashboardParam
 from .edge_spec_param import EdgeSpecParam as EdgeSpecParam
 from .exploration_run import ExplorationRun as ExplorationRun
 from .job_list_params import JobListParams as JobListParams
@@ -46,7 +49,6 @@ from .node_spec_param import NodeSpecParam as NodeSpecParam
 from .tool_invocation import ToolInvocation as ToolInvocation
 from .usage_group_key import UsageGroupKey as UsageGroupKey
 from .chat_copy_params import ChatCopyParams as ChatCopyParams
-from .dashboard_layout import DashboardLayout as DashboardLayout
 from .save_requirement import SaveRequirement as SaveRequirement
 from .workflow_session import WorkflowSession as WorkflowSession
 from .chat_session_role import ChatSessionRole as ChatSessionRole
@@ -95,6 +97,7 @@ from .user_usage_response import UserUsageResponse as UserUsageResponse
 from .workflow_run_params import WorkflowRunParams as WorkflowRunParams
 from .connector_table_info import ConnectorTableInfo as ConnectorTableInfo
 from .create_team_response import CreateTeamResponse as CreateTeamResponse
+from .dashboard_page_param import DashboardPageParam as DashboardPageParam
 from .dataset_get_response import DatasetGetResponse as DatasetGetResponse
 from .dataset_match_params import DatasetMatchParams as DatasetMatchParams
 from .delete_team_response import DeleteTeamResponse as DeleteTeamResponse
@@ -133,7 +136,6 @@ from .chat_load_files_params import ChatLoadFilesParams as ChatLoadFilesParams
 from .connector_get_response import ConnectorGetResponse as ConnectorGetResponse
 from .connector_with_secrets import ConnectorWithSecrets as ConnectorWithSecrets
 from .credits_usage_response import CreditsUsageResponse as CreditsUsageResponse
-from .dashboard_layout_param import DashboardLayoutParam as DashboardLayoutParam
 from .dataset_match_response import DatasetMatchResponse as DatasetMatchResponse
 from .document_delete_params import DocumentDeleteParams as DocumentDeleteParams
 from .document_list_response import DocumentListResponse as DocumentListResponse

structifyai-1.177.0/src/structify/types/dashboard.py

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+from .dashboard_page import DashboardPage
+
+__all__ = ["Dashboard"]
+
+
+class Dashboard(BaseModel):
+    """
+    A page is the top-level container with title/description
+    Can contain multiple dashboards with different datasets
+    """
+
+    dashboards: List[DashboardPage]
+    """One or more dashboards on this page"""
+
+    title: str
+    """Page title"""
+
+    description: Optional[str] = None
+    """Optional page description"""

structifyai-1.177.0/src/structify/types/dashboard_component.py

@@ -0,0 +1,61 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Union, Optional
+from typing_extensions import TypeAlias
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["DashboardComponent", "Mosaic", "MosaicFields", "MosaicFieldsUnionMember2", "MosaicBin"]
+
+
+class MosaicFieldsUnionMember2(BaseModel):
+    expr: str
+
+    target: Optional[str] = None
+    """Optional Plotly property path (e.g., marker.color) to assign this column to"""
+
+
+MosaicFields: TypeAlias = Union[str, bool, MosaicFieldsUnionMember2]
+
+
+class MosaicBin(BaseModel):
+    as_: str = FieldInfo(alias="as")
+
+    field: str
+
+    step: float
+
+
+class Mosaic(BaseModel):
+    fields: Dict[str, MosaicFields]
+
+    bin: Optional[MosaicBin] = None
+
+    group_by: Optional[List[str]] = FieldInfo(alias="groupBy", default=None)
+
+    limit: Optional[int] = None
+
+    order_by: Optional[str] = FieldInfo(alias="orderBy", default=None)
+
+    table: Optional[str] = None
+    """Table name - optional, derived from datasetNodeName in dashboard config"""
+
+
+class DashboardComponent(BaseModel):
+    """A component references a viz node and optionally includes mosaic metadata"""
+
+    node_name: str
+    """Function name of the viz node that outputs the chart spec"""
+
+    title: str
+    """Display title (overrides viz node title)"""
+
+    description: Optional[str] = None
+    """Description (optional, can override viz node's description)"""
+
+    mosaic: Optional[Mosaic] = None
+
+    span: Optional[int] = None
+    """Grid span: 1 (quarter), 2 (half), 3 (three-quarters), 4 (full width)"""

structifyai-1.177.0/src/structify/types/dashboard_component_param.py

@@ -0,0 +1,68 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Union, Optional
+from typing_extensions import Required, Annotated, TypeAlias, TypedDict
+
+from .._types import SequenceNotStr
+from .._utils import PropertyInfo
+
+__all__ = ["DashboardComponentParam", "Mosaic", "MosaicFields", "MosaicFieldsUnionMember2", "MosaicBin"]
+
+
+class MosaicFieldsUnionMember2(TypedDict, total=False):
+    expr: Required[str]
+
+    target: Optional[str]
+    """Optional Plotly property path (e.g., marker.color) to assign this column to"""
+
+
+MosaicFields: TypeAlias = Union[str, bool, MosaicFieldsUnionMember2]
+
+_MosaicBinReservedKeywords = TypedDict(
+    "_MosaicBinReservedKeywords",
+    {
+        "as": str,
+    },
+    total=False,
+)
+
+
+class MosaicBin(_MosaicBinReservedKeywords, total=False):
+    field: Required[str]
+
+    step: Required[float]
+
+
+class Mosaic(TypedDict, total=False):
+    fields: Required[Dict[str, MosaicFields]]
+
+    bin: Optional[MosaicBin]
+
+    group_by: Annotated[Optional[SequenceNotStr[str]], PropertyInfo(alias="groupBy")]
+
+    limit: Optional[int]
+
+    order_by: Annotated[Optional[str], PropertyInfo(alias="orderBy")]
+
+    table: Optional[str]
+    """Table name - optional, derived from datasetNodeName in dashboard config"""
+
+
+class DashboardComponentParam(TypedDict, total=False):
+    """A component references a viz node and optionally includes mosaic metadata"""
+
+    node_name: Required[str]
+    """Function name of the viz node that outputs the chart spec"""
+
+    title: Required[str]
+    """Display title (overrides viz node title)"""
+
+    description: Optional[str]
+    """Description (optional, can override viz node's description)"""
+
+    mosaic: Optional[Mosaic]
+
+    span: Optional[int]
+    """Grid span: 1 (quarter), 2 (half), 3 (three-quarters), 4 (full width)"""

structifyai-1.177.0/src/structify/types/dashboard_page.py

@@ -0,0 +1,108 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Union, Optional
+from typing_extensions import Literal, Annotated, TypeAlias
+
+from pydantic import Field as FieldInfo
+
+from .._utils import PropertyInfo
+from .._models import BaseModel
+from .dashboard_component import DashboardComponent
+
+__all__ = [
+    "DashboardPage",
+    "Control",
+    "ControlDropdown",
+    "ControlDropdownOption",
+    "ControlRange",
+    "ControlCheckbox",
+    "ControlCheckboxOption",
+]
+
+
+class ControlDropdownOption(BaseModel):
+    label: str
+
+    value: str
+
+
+class ControlDropdown(BaseModel):
+    id: str
+
+    field: str
+
+    label: str
+
+    options: List[ControlDropdownOption]
+
+    type: Literal["dropdown"]
+
+    default_value: Optional[str] = None
+
+
+class ControlRange(BaseModel):
+    id: str
+
+    field: str
+
+    label: str
+
+    max: float
+
+    min: float
+
+    type: Literal["range"]
+
+    default_value: Optional[List[float]] = None
+
+    step: Optional[float] = None
+
+
+class ControlCheckboxOption(BaseModel):
+    label: str
+
+    value: str
+
+
+class ControlCheckbox(BaseModel):
+    id: str
+
+    field: str
+
+    label: str
+
+    options: List[ControlCheckboxOption]
+
+    type: Literal["checkbox"]
+
+    default_value: Optional[List[str]] = None
+
+
+Control: TypeAlias = Annotated[
+    Union[ControlDropdown, ControlRange, ControlCheckbox], PropertyInfo(discriminator="type")
+]
+
+
+class DashboardPage(BaseModel):
+    """
+    A dashboard groups components that share a common dataset.
+    If dataset_node_name is None, components render static viz without Mosaic cross-filtering.
+    """
+
+    components: List[DashboardComponent]
+    """Components (charts) in this dashboard"""
+
+    title: str
+    """Title for this dashboard section"""
+
+    controls: Optional[List[Control]] = None
+    """Control filters (dropdowns, checkboxes, ranges) for this dashboard"""
+
+    dataset_node_name: Optional[str] = FieldInfo(alias="datasetNodeName", default=None)
+    """
+    Function name of the node that returns the dataset (DataFrame/Parquet). If None,
+    no cross-filtering is available.
+    """
+
+    description: Optional[str] = None
+    """Optional description"""

structifyai-1.177.0/src/structify/types/dashboard_page_param.py

@@ -0,0 +1,106 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable, Optional
+from typing_extensions import Literal, Required, Annotated, TypeAlias, TypedDict
+
+from .._types import SequenceNotStr
+from .._utils import PropertyInfo
+from .dashboard_component_param import DashboardComponentParam
+
+__all__ = [
+    "DashboardPageParam",
+    "Control",
+    "ControlDropdown",
+    "ControlDropdownOption",
+    "ControlRange",
+    "ControlCheckbox",
+    "ControlCheckboxOption",
+]
+
+
+class ControlDropdownOption(TypedDict, total=False):
+    label: Required[str]
+
+    value: Required[str]
+
+
+class ControlDropdown(TypedDict, total=False):
+    id: Required[str]
+
+    field: Required[str]
+
+    label: Required[str]
+
+    options: Required[Iterable[ControlDropdownOption]]
+
+    type: Required[Literal["dropdown"]]
+
+    default_value: Optional[str]
+
+
+class ControlRange(TypedDict, total=False):
+    id: Required[str]
+
+    field: Required[str]
+
+    label: Required[str]
+
+    max: Required[float]
+
+    min: Required[float]
+
+    type: Required[Literal["range"]]
+
+    default_value: Optional[Iterable[float]]
+
+    step: Optional[float]
+
+
+class ControlCheckboxOption(TypedDict, total=False):
+    label: Required[str]
+
+    value: Required[str]
+
+
+class ControlCheckbox(TypedDict, total=False):
+    id: Required[str]
+
+    field: Required[str]
+
+    label: Required[str]
+
+    options: Required[Iterable[ControlCheckboxOption]]
+
+    type: Required[Literal["checkbox"]]
+
+    default_value: Optional[SequenceNotStr[str]]
+
+
+Control: TypeAlias = Union[ControlDropdown, ControlRange, ControlCheckbox]
+
+
+class DashboardPageParam(TypedDict, total=False):
+    """
+    A dashboard groups components that share a common dataset.
+    If dataset_node_name is None, components render static viz without Mosaic cross-filtering.
+    """
+
+    components: Required[Iterable[DashboardComponentParam]]
+    """Components (charts) in this dashboard"""
+
+    title: Required[str]
+    """Title for this dashboard section"""
+
+    controls: Optional[Iterable[Control]]
+    """Control filters (dropdowns, checkboxes, ranges) for this dashboard"""
+
+    dataset_node_name: Annotated[Optional[str], PropertyInfo(alias="datasetNodeName")]
+    """
+    Function name of the node that returns the dataset (DataFrame/Parquet). If None,
+    no cross-filtering is available.
+    """
+
+    description: Optional[str]
+    """Optional description"""

structifyai-1.177.0/src/structify/types/dashboard_param.py

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable, Optional
+from typing_extensions import Required, TypedDict
+
+from .dashboard_page_param import DashboardPageParam
+
+__all__ = ["DashboardParam"]
+
+
+class DashboardParam(TypedDict, total=False):
+    """
+    A page is the top-level container with title/description
+    Can contain multiple dashboards with different datasets
+    """
+
+    dashboards: Required[Iterable[DashboardPageParam]]
+    """One or more dashboards on this page"""
+
+    title: Required[str]
+    """Page title"""
+
+    description: Optional[str]
+    """Optional page description"""

{structifyai-1.176.1 → structifyai-1.177.0}/src/structify/types/session_finalize_dag_params.py

@@ -5,9 +5,9 @@ from __future__ import annotations
 from typing import Iterable, Optional
 from typing_extensions import Required, TypedDict
 
+from .dashboard_param import DashboardParam
 from .edge_spec_param import EdgeSpecParam
 from .node_spec_param import NodeSpecParam
-from .dashboard_layout_param import DashboardLayoutParam
 
 __all__ = ["SessionFinalizeDagParams"]
 
@@ -17,4 +17,8 @@ class SessionFinalizeDagParams(TypedDict, total=False):
 
     nodes: Required[Iterable[NodeSpecParam]]
 
-    dashboard_layout: Optional[DashboardLayoutParam]
+    dashboard_layout: Optional[DashboardParam]
+    """
+    A page is the top-level container with title/description Can contain multiple
+    dashboards with different datasets
+    """

{structifyai-1.176.1 → structifyai-1.177.0}/src/structify/types/session_upload_dashboard_layout_params.py

@@ -4,10 +4,14 @@ from __future__ import annotations
 
 from typing_extensions import Required, TypedDict
 
-from .dashboard_layout_param import DashboardLayoutParam
+from .dashboard_param import DashboardParam
 
 __all__ = ["SessionUploadDashboardLayoutParams"]
 
 
 class SessionUploadDashboardLayoutParams(TypedDict, total=False):
-    layout: Required[DashboardLayoutParam]
+    layout: Required[DashboardParam]
+    """
+    A page is the top-level container with title/description Can contain multiple
+    dashboards with different datasets
+    """

{structifyai-1.176.1 → structifyai-1.177.0}/src/structify/types/workflow_dag.py

@@ -4,7 +4,7 @@ from typing import List, Optional
 from datetime import datetime
 
 from .._models import BaseModel
-from .dashboard_layout import DashboardLayout
+from .dashboard import Dashboard
 from .workflow_session_edge import WorkflowSessionEdge
 from .workflow_session_node import WorkflowSessionNode
 
@@ -24,7 +24,11 @@ class WorkflowDag(BaseModel):
 
     dag_ready_at: Optional[datetime] = None
 
-    dashboard_layout: Optional[DashboardLayout] = None
+    dashboard_layout: Optional[Dashboard] = None
+    """
+    A page is the top-level container with title/description Can contain multiple
+    dashboards with different datasets
+    """
 
     error: Optional[str] = None