Package ai.extend.types

Class WorkflowRunFileInput

  • public final class WorkflowRunFileInput
extends java.lang.Object

    • Method Detail

      • getFileName

        public java.util.Optional<java.lang.String> getFileName()
        Returns:
        The name of the file to be processed. If not provided, the file name will be inferred from the URL. It is highly recommended to include this parameter for legibility.

      • getFileUrl

        public java.util.Optional<java.lang.String> getFileUrl()
        Returns:
        A URL where the file can be downloaded from. If you use presigned URLs, we recommend an expiration time of 5-15 minutes. One of a fileUrl or fileId must be provided.

      • getFileId

        public java.util.Optional<java.lang.String> getFileId()
        Returns:
        Extend's internal ID for the file. It will always start with "file_". One of a fileUrl or fileId must be provided. You can view a file ID from the Extend UI, for instance from running a parser or from a previous file creation. If you provide a fileId, any parsed data will be reused.

        Example: "file_Zk9mNP12Qw4yTv8BdR3H"

      • getOutputs

        public java.util.Optional<java.util.List<WorkflowRunFileInputOutputsItem>> getOutputs()
        Returns:
        Predetermined outputs that can be used to override the outputs that are generated. Generally not recommended for most use cases, however, can be useful in cases of overriding a classification in a workflow, or a subset of extraction fields when data is known.

      • 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