# This file was auto-generated by Fern from our API Definition.

import typing

import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2
from ..core.unchecked_base_model import UncheckedBaseModel
from .classification_next_entry import ClassificationNextEntry
from .split_step_definition_config import SplitStepDefinitionConfig


class SplitStepDefinition(UncheckedBaseModel):
    """
    Splits a multi-document file into individual documents using a splitter. Routes to different next steps based on split type.

    The splitter reference must include a pinned `version` — `"latest"` is not supported for `SPLIT` steps. Use a specific semver string (e.g. `"0.1"`) or `"draft"`. This is because classification IDs used for routing are tied to a specific processor version's config.

    See the [Split step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#split-step).
    """

    name: str
    config: typing.Optional[SplitStepDefinitionConfig] = pydantic.Field(default=None)
    """
    Optional on create/update. Required before the workflow can be deployed. Omitted in responses when the step is not yet configured.
    
    Reference to the splitter used by this step. The `next[].classificationId` values must match split classification `id` values (not `type` strings) from the referenced splitter's configuration. For example, if the splitter defines `{ "id": "cls_receipt", "type": "receipt" }`, use `"cls_receipt"` as the `classificationId`.
    
    The splitter `version` is required and must be a pinned version (semver like `"0.1"` or `"draft"`). `"latest"` is not allowed.
    
    See the [Split step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#split-step).
    """

    next: typing.Optional[typing.List[ClassificationNextEntry]] = pydantic.Field(default=None)
    """
    Can only be set when `config` is present. Each entry must include a `classificationId` matching a split classification `id` from the referenced splitter's configuration. Use the classification's stable `id` (e.g. `"cls_receipt"`), not the `type` string.
    
    See the [Split step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#split-step).
    """

    if IS_PYDANTIC_V2:
        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
    else:

        class Config:
            frozen = True
            smart_union = True
            extra = pydantic.Extra.allow
