Running and deploying apps

The Hub displays all apps available to you, including prebuilt apps, apps you created, apps shared within your organization, and advanced apps customized for your enterprise. Open any app to run it or see results from previous runs.

From any app, use the left sidebar to review version history, app info, and other details.

Running apps

You can run any app from the Hub on demand.

  1. From the Hub, open the app you want to run.

  2. (Optional) If the app has sample files and you want to preview app functionality, click Run with sample files, then click Run.

    When the run completes, click Sample run to view results.

    Sample runs incur usage charges at the same rate as regular app runs.

  3. When you’re ready to run the app, click Run app.

  4. If you’re an organization member, verify the workspace you want to run the app in.

    Run results are available only in the selected workspace, and are viewable by all members of that workspace.

  5. Select files to process and click Run.

    When the run completes, click the run ID to view results.

Sharing apps

You can share apps you create with other AI Hub users.

Sharing settings impact all production versions of an app. Pre-production versions of apps are never shared. When you share an app with a link, users are directed to the latest version of the app.

Other users with access to your app can run the app and view their results. Additionally, organization members can view run results in any workspace they have access to, regardless of whether they initiated the app run. The account that initiates an app run is responsible for any consumption units used.

Access sharing settings from the homepage of apps you created by clicking Share.

Sharing functionality differs based on your AI Hub subscription.

  • Community App sharing is enabled with a link. Any AI Hub user with the link can use your shared app. Shared apps aren’t listed in the Hub.

  • Commercial & Enterprise App sharing is enabled through organization membership. Any member of your organization can use your shared app. Shared apps are listed in the Hub.

Creating deployments

Deployments let you configure an app to run at scale with automation, integration, and human review.

  1. In Workspaces, select the Deploy tab, then click Add deployment.

  2. Specify options for your deployment, then click Save.

    • Name — Specify a unique name to help users differentiate the deployment across all workspaces they have access to.

    • Description — Specify an optional description for the deployment.

    • App — Select the app that you want to run at scale for this deployment. Available apps include all apps that are accessible to you, whether prebuilt, shared within your organization, or created by you.

    • Workspace — Select the workspace where you want to run the deployment and store run results. If you enable reviews, only members of this workspace can review results.

    • Integrations — Configure pre- and post-processing options, either pulling files from upstream systems or sending results to downstream systems. For details, see Configuring integrations.

    • Review — To send runs with validation errors to the review queue, enable Require review on runs with validation errors. All documents in a run are queued for review and aren’t sent to downstream integrations until the review is closed.

      • Service-level agreement Enterprise — Specify efficiency targets for human review in minutes, hours, or days. Timing begins when a deployment run begins, and the SLA is satisfied on a given document when it’s marked as reviewed. The Review tab indicates time remaining against the SLA to help reviewers prioritize.

Configuring integrations

Use integrations to pull files from upstream systems for processing or send results to downstream systems. Results are sent only after required reviews are closed.

Supported integrations include:

  • Email — Send results to an email address in CSV, XLSX, or JSON format. In projects with classes, separate CSV files are generated for each class.

  • Connected drive — Pull files from a workspace or organization drive for processing, or send results in CSV, XLSX, or JSON format. In projects with classes, separate CSV files are generated for each class. For upstream integrations, you can specify whether to run the deployment on a set schedule or any time a new file is detected.

  • Custom function — Send results in JSON format using a custom Python function.

During configuration, you can test the connection by sending the results from a previous app run to your downstream integration.

Integration function

For advanced integrations, you can write a custom integration function in Python.

For example, you might use an integration function to send results to a webhook:

1import requests
2
3# Construct a list of records information
4concise_records = []
5for record in results['records']:
6    concise_record = {
7        "fields": record.get("results"),  # Note: This might be intended to be "fields" or a similar key
8        "classification_label": record.get("classification_label"),
9        "record_index": record.get("record_index")
10    }
11    concise_records.append(concise_record)
12
13# Post endpoint call template
14url = "https://example.com/my_own_webhook"
15response = requests.post(url, json=concise_records)
16if response.status_code == 200:
17    print("POST request successful")
18else:
19    print(f"POST request failed with status code {response.status_code}")
20    return None

Integration functions accept these parameters:

ParameterRequired?Description
resultsRequiredResults of the app run in JSON format. Individual documents within the app run are exported as records[0].results.

For additional guidance about custom functions, see Writing custom functions.

Running deployments

While deployments are most beneficial when automated with upstream integrations, you can run them on demand if necessary.

  1. In Workspaces, select the Deploy tab, then click the name of the deployment you want to run.

  2. Click Run deployment.

  3. Select files to process.

    When the run completes, click the run ID to view results.

Using advanced apps

Advanced apps are custom apps created by Instabase to address complex enterprise use cases.

Advanced apps are available from the Hub and tagged with Advanced. You can run advanced apps or use them to create deployments just like any other app, but you can’t edit them or access an underlying Build project.

If required for your use case, advanced apps might be designed with multiple review checkpoints. In this case, each review must be closed before the run can proceed or complete.

Was this page helpful?