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

import typing

import typing_extensions
from .classification_next_entry import ClassificationNextEntryParams
from .classify_step_definition_config import ClassifyStepDefinitionConfigParams


class ClassifyStepDefinitionParams(typing_extensions.TypedDict):
    """
    Classifies documents using a classifier. Routes to different next steps based on classification result.

    The classifier reference must include a pinned `version` — `"latest"` is not supported for `CLASSIFY` 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 [Classify step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#classify-step).
    """

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

    next: typing_extensions.NotRequired[typing.Sequence[ClassificationNextEntryParams]]
    """
    Can only be set when `config` is present. Each entry must include a `classificationId` matching a classification `id` from the referenced classifier's configuration. Use the classification's stable `id` (e.g. `"cls_invoice"`), not the `type` string.
    
    See the [Classify step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#classify-step).
    """
