structifyai 1.176.1__py3-none-any.whl → 1.178.0__py3-none-any.whl

structify/types/code_generate_code_params.py

@@ -5,6 +5,7 @@ from __future__ import annotations
 from typing import Optional
 from typing_extensions import Literal, Required, Annotated, TypedDict
 
+from .._types import SequenceNotStr
 from .._utils import PropertyInfo
 
 __all__ = ["CodeGenerateCodeParams", "Config"]
@@ -20,6 +21,10 @@ class CodeGenerateCodeParams(TypedDict, total=False):
     config: Optional[Config]
     """Configuration for chat session with system prompt and LLM key"""
 
+    connector_ids: Annotated[SequenceNotStr[str], PropertyInfo(alias="connectorIds")]
+
+    file_paths: Annotated[SequenceNotStr[str], PropertyInfo(alias="filePaths")]
+
     trigger_workflow_execution: Annotated[bool, PropertyInfo(alias="triggerWorkflowExecution")]
 
     user_message_id: Annotated[Optional[str], PropertyInfo(alias="userMessageId")]
@@ -57,6 +62,8 @@ class Config(TypedDict, total=False):
     ]
     """LLM model keys available in the system. Format: <provider>.<model-name>"""
 
+    max_steps: Optional[int]
+
     reminder_message: Optional[str]
 
     system_prompt: Optional[str]

structify/types/connector_catalog_list_params.py

@@ -9,6 +9,9 @@ __all__ = ["ConnectorCatalogListParams"]
 
 
 class ConnectorCatalogListParams(TypedDict, total=False):
+    include_inactive: bool
+    """Include inactive auth methods (admin only)"""
+
     limit: int
 
     offset: int

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

structify/types/dashboard_component.py

@@ -1,17 +1,61 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Optional
+from typing import Dict, List, Union, Optional
+from typing_extensions import TypeAlias
+
+from pydantic import Field as FieldInfo
 
 from .._models import BaseModel
 
-__all__ = ["DashboardComponent"]
+__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)"""

structify/types/dashboard_component_param.py

@@ -2,17 +2,67 @@
 
 from __future__ import annotations
 
-from typing import Optional
-from typing_extensions import Required, TypedDict
+from typing import Dict, Union, Optional
+from typing_extensions import Required, Annotated, TypeAlias, TypedDict
 
-__all__ = ["DashboardComponentParam"]
+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)"""

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

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

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

structify/types/dataset_view_tables_with_relationships_response.py

@@ -118,6 +118,8 @@ class ConnectedEntity(BaseModel):
 
     dataset_id: str
 
+    job_ids: List[str]
+
     label: str
 
     properties: Dict[str, ConnectedEntityProperties]
@@ -210,6 +212,8 @@ class Entity(BaseModel):
 
     dataset_id: str
 
+    job_ids: List[str]
+
     label: str
 
     properties: Dict[str, EntityProperties]

structify/types/job_get_scrapers_response.py

@@ -5,6 +5,7 @@ from datetime import datetime
 from typing_extensions import TypeAlias
 
 from .._models import BaseModel
+from .chat_event import ChatEvent
 from .chat_prompt import ChatPrompt
 
 __all__ = ["JobGetScrapersResponse", "JobGetScrapersResponseItem"]
@@ -25,6 +26,8 @@ class JobGetScrapersResponseItem(BaseModel):
 
     code: Optional[str] = None
 
+    events: Optional[List[ChatEvent]] = None
+
     next_page_code: Optional[str] = None
 
 

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
+    """

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
+    """

structify/types/tool_result.py

@@ -11,7 +11,6 @@ __all__ = [
     "ToolResult",
     "Error",
     "Text",
-    "Image",
     "CodeExecution",
     "CodeExecutionCodeExecution",
     "WebMarkdown",
@@ -21,6 +20,8 @@ __all__ = [
     "ConnectorSearchConnectorSearch",
     "ConnectorSearchConnectorSearchColumn",
     "NodeLogs",
+    "Image",
+    "ImageImage",
 ]
 
 
@@ -32,10 +33,6 @@ class Text(BaseModel):
     text: str = FieldInfo(alias="Text")
 
 
-class Image(BaseModel):
-    image: object = FieldInfo(alias="Image")
-
-
 class CodeExecutionCodeExecution(BaseModel):
     return_code: int
 
@@ -94,6 +91,24 @@ class NodeLogs(BaseModel):
     node_logs: List[str] = FieldInfo(alias="NodeLogs")
 
 
+class ImageImage(BaseModel):
+    image_bytes: object
+
+    ocr_text: Optional[str] = None
+
+
+class Image(BaseModel):
+    image: ImageImage = FieldInfo(alias="Image")
+
+
 ToolResult: TypeAlias = Union[
-    Literal["Pending", "NoResult"], Error, Text, Image, CodeExecution, WebMarkdown, WebSearch, ConnectorSearch, NodeLogs
+    Literal["Pending", "NoResult", "Completed"],
+    Error,
+    Text,
+    CodeExecution,
+    WebMarkdown,
+    WebSearch,
+    ConnectorSearch,
+    NodeLogs,
+    Image,
 ]

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
 

{structifyai-1.176.1.dist-info → structifyai-1.178.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: structifyai
-Version: 1.176.1
+Version: 1.178.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