Package ai.extend.types

Interface WorkflowRun._FinalStage

    • Method Detail

      • metadata

        WorkflowRun._FinalStage metadata​(java.util.Map<java.lang.String,​java.lang.Object> metadata)

        The metadata that was passed in when running the Workflow.

      • putAllMetadata

        WorkflowRun._FinalStage putAllMetadata​(java.util.Map<java.lang.String,​java.lang.Object> metadata)

      • batchId

        WorkflowRun._FinalStage batchId​(java.util.Optional<java.lang.String> batchId)

        The batch ID of the WorkflowRun. If this WorkflowRun was created as part of a batch of files, all runs in that batch will have the same batch ID.

        Example: "batch_7Ws31-F5"

      • failureReason

        WorkflowRun._FinalStage failureReason​(java.util.Optional<java.lang.String> failureReason)

        The reason why the workflow run failed. Will only be included if the workflow run status is "FAILED".

      • failureMessage

        WorkflowRun._FinalStage failureMessage​(java.util.Optional<java.lang.String> failureMessage)

        A more detailed message about the failure. Will only be included if the workflow run status is "FAILED".

      • reviewedBy

        WorkflowRun._FinalStage reviewedBy​(java.util.Optional<java.lang.String> reviewedBy)

        The email address of the person who reviewed the workflow run. Will not be included if the workflow run has not been reviewed.

        Example: "jane.doe@example.com"

      • rejectionNote

        WorkflowRun._FinalStage rejectionNote​(java.util.Optional<java.lang.String> rejectionNote)

        A note that is added if a workflow run is rejected.

        Example: "Invalid invoice format"

      • reviewedAt

        WorkflowRun._FinalStage reviewedAt​(java.util.Optional<java.time.OffsetDateTime> reviewedAt)

        The time (in UTC) at which the workflow run was reviewed. Will follow the RFC 3339 format. Will not be included if the workflow run has not been reviewed.

        Example: "2024-03-21T16:45:00Z"

      • startTime

        WorkflowRun._FinalStage startTime​(java.util.Optional<java.time.OffsetDateTime> startTime)

        The time (in UTC) at which the workflow run started executing. This will always be after the initialRunAt time. Will follow the RFC 3339 format. Will not be included if the workflow run has not started executing.

        Example: "2024-03-21T15:30:00Z"

      • endTime

        WorkflowRun._FinalStage endTime​(java.util.Optional<java.time.OffsetDateTime> endTime)

        The time (in UTC) that the workflow finished executing. Will follow the RFC 3339 format. Will not be included if the workflow run has not finished executing.

        Example: "2024-03-21T15:35:00Z"

      • stepRuns

        WorkflowRun._FinalStage stepRuns​(java.util.List<StepRun> stepRuns)

        An array of WorkflowStepRun objects. Each WorkflowStepRun represents a single run of a WorkflowStep and contains details about the step and the run's output.

        Note: This field currently supports External Data Validation and Rule Validation step types. Document processor run outputs are included in the outputs field.