Package ai.extend.types

Class BatchProcessorRun

  • public final class BatchProcessorRun
extends java.lang.Object

    • Method Detail

      • getObject

        public java.lang.String getObject()
        Returns:
        The type of response. In this case, it will always be "batch_processor_run".

      • getId

        public java.lang.String getId()
        Returns:
        The unique identifier for this batch processor run.

        Example: "batch_processor_run_Xj8mK2pL9nR4vT7qY5wZ"

      • getProcessorId

        public java.lang.String getProcessorId()
        Returns:
        The ID of the processor used for this run.

        Example: "dp_Xj8mK2pL9nR4vT7qY5wZ"

      • getProcessorVersionId

        public java.lang.String getProcessorVersionId()
        Returns:
        The ID of the specific processor version used.

        Example: "dpv_xK9mLPqRtN3vS8wF5hB2cQ"

      • getProcessorName

        public java.lang.String getProcessorName()
        Returns:
        The name of the processor.

        Example: "Invoice Processor"

      • getStatus

        public BatchProcessorRunStatus getStatus()
        Returns:
        The current status of the batch processor run:
        • "PENDING" - The batch processor run is waiting to start
        • "PROCESSING" - The batch processor run is in progress
        • "PROCESSED" - The batch processor run completed successfully
        • "FAILED" - The batch processor run encountered an error

      • getSource

        public BatchProcessorRunSource getSource()
        Returns:
        The source of the batch processor run:
        • "EVAL_SET" - The batch processor run was made from an evaluation set. The sourceId will be the ID of the evaluation set (e.g., "ev_1234")
        • "PLAYGROUND" - The batch processor run was made from the playground. The sourceId will not be set
        • "STUDIO" - The batch processor run was made for a processor in Studio. The sourceId will be the ID of the processor (e.g., "dp_1234")

      • getSourceId

        public java.util.Optional<java.lang.String> getSourceId()
        Returns:
        The ID of the source of the batch processor run. See the source field for more details. Example: "ev_1234" for EVAL_SET source, "dp_1234" for STUDIO source

      • getRunCount

        public int getRunCount()
        Returns:
        The number of runs that were made.

      • getCreatedAt

        public java.time.OffsetDateTime getCreatedAt()
        Returns:
        The time (in UTC) at which the batch processor run was created. Will follow the RFC 3339 format.

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

      • getUpdatedAt

        public java.time.OffsetDateTime getUpdatedAt()
        Returns:
        The time (in UTC) at which the batch processor run was last updated. Will follow the RFC 3339 format.

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

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object