https://platform.instabase.com/docs/26.04/udfs/index.html Recent content in Develop custom functions on Instabase Platform Documentation Hugo -- gohugo.io en-us https://platform.instabase.com/docs/26.04/udfs/udfs-general/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/udfs/udfs-general/index.html Table of Contents Providing access Script folders and registration functions Registering UDFs Subfolders in a scripts folder Importing files in a scripts folder Invoking a UDF Runtime input variables Importing other files in scripts directory Package payload Absolute module paths Relative module paths Custom Python modules ib.market modules Using a specific version of a package ib.custom modules Accessing resource files in UDFs Resource folder name Resource folder location Using the resource reader client UDFs let you add custom functionality in Flow and Refiner. https://platform.instabase.com/docs/26.04/udfs/udf-clients/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/udfs/udf-clients/index.html Table of Contents Flow client Run flow binary Get flow status List pipeline Job client List job Job status Pause job Resume job Retry job Cancel job Update pipeline Ibfile is_file is_dir exists mkdir copy rm open read_file write_file list_dir Conversion client Converting documents to PDFs in a flow Example UDF script for PDF conversion in the map UDF step All UDFs in Flow, such as the Map UDF and Reduce UDF, are provided a clients Python object as input. https://platform.instabase.com/docs/26.04/udfs/udfs-in-flow-v2/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/udfs/udfs-in-flow-v2/index.html Table of Contents Adding the Apply UDF step Pre- and post-run hooks Scripts location Special input variables Logging in UDF Pre-Flow UDF example UDFs provide custom functionality to your Flow. Adding the Apply UDF step You can add the Apply UDF step to a Flow. Open an .ibflow file and click Tools > Add Step > Select Step > Apply UDF. Set the input and output extensions. Set the input and output folders. https://platform.instabase.com/docs/26.04/udfs/udfs-in-flow-v3/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/udfs/udfs-in-flow-v3/index.html Table of Contents Map UDF Input variables Output variables Example Reduce UDF Input variables Example Pre-flow UDF Input variables Example Post-flow UDF Input variables Example Flow allows users to create their own custom functions, called User-Defined Functions (UDFs) to implement custom functionality. There are four main types of UDFs in Flow: Map UDFs, Reduce UDFs, Pre-Flow UDFs, and Post-Flow UDFs. Map UDF Use a Map UDF to process each input file or record in a flow in parallel only when your processing logic operates on a single document. https://platform.instabase.com/docs/26.04/udfs/udfs-in-refiner/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/udfs/udfs-in-refiner/index.html User Defined Functions (UDFs) allow the user to provide custom functionality in Refiner. Using UDFs in a Refiner Program See Script folders and registration functions for how to set up your Python scripts folder and register your UDFs. To use your UDFs within a Refiner program, link your Refiner program to your scripts folder by going to File > Settings > Scripts Folder and selecting the folder using the file selector dialog. https://platform.instabase.com/docs/26.04/udfs/libraries-for-udfs/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/udfs/libraries-for-udfs/index.html Table of Contents Reading the Flow output Write and modify ibocr_records ParsedIBOCRBuilder IBOCRRecord IBOCRPageMetadata IBOCRRecordLayout IBOCRRecordBuilder WordPolyDict RefinedPhrases ParsedIBOCR object IBOCRRecord Runtime Config IBFile Sample UDF REFINER_FNS object TokenFrameworkRegistry object Logger object FnContext object Use Instabase libraries and objects to read files and manipulate data in UDFs. Reading the Flow output Use the load_from_str function from the ParsedIBOCRBuilder class to read the intermediary Flow output: from instabase.ocr.client.libs import ibocr def custom_function_fn(content, input_filepath, clients, root_output_folder, *args, **kwargs): builder, err = ibocr. https://platform.instabase.com/docs/26.04/udfs/third-party-libraries-for-udfs/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/udfs/third-party-libraries-for-udfs/index.html Table of Contents Default third-party libraries Enabling additional third-party libraries Extending celery-app-tasks Instabase supports several third-party libraries that you can reference in custom, user-defined functions (UDFs). If you have an on-premises environment, you can add additional third-party libraries by extending Instabase images. Default third-party libraries Instabase includes commonly used libraries with your deployment. These libraries can be imported like any other Python library. The following third-party libraries are included by default with your Instabase deployment: https://platform.instabase.com/docs/26.04/udfs/dev-packages/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/udfs/dev-packages/index.html Developer packages enable distribution and sharing of custom Python files used in Instabase, such as functions and libraries. You can publish a developer package to the Marketplace by creating a developer package directory anywhere in the Instabase Explorer. Then, right-click the content directory and select Package. An .ibsolution file is generated at the same level as the solution directory with the name and version specified in the solution’s JSON metadata. After manually packaging a custom app, use Marketplace Admin to publish the app to the Marketplace.