Instill SDK for Python Devs

The Instill SDK provides a Python-based interface for interacting with Instill Core features, including data, pipeline and model operations.

Please note: Our Python SDK supports up to and including Python 3.11.

Perform key data operations such as:

  • List, create, update, and delete catalogs
  • Upload, process, and manage files within a catalog
  • View and search file chunks
  • Ask catalog to retrieve relevant information based on files

Pipeline - Instill VDP

Handle pipeline tasks:

  • Create and run pipelines

Work with AI models:

  • Create and serve models
  • Run model for inference

Check out Instill AI Cookbooks to learn how to use the Python SDK:

The Python SDK is undergoing continuous improvements. We'd love to hear your feedback! Please share your thoughts in the #feedback channel on ourDiscord community.


Improvements

Artifact

  • Renamed all APIs to follow a consistent new structure.

Pipeline

  • Clicking a preview component now centers its code in the left editor panel.
  • Made the left sidebar in the Low-Code Editor resizable.
  • Enhanced the "Add Component" dropdown by removing null entries.
  • Rounded component borders and increased text size for improved readability.
  • Added description hints for each input key in components.
  • Removed the deprecated “test version” button from the interface.

Bug Fixes

Pipeline

  • Fixed issue preventing Asana from being correctly added as a component.
  • Fixed spinning loader persisting after a successful pipeline run.
  • Corrected indentation display when adding components.
  • Added missing Public/Private labels in certain scenarios.
  • Fixed issues when converting JPG images to text.
  • Eliminated white padding issue in the image preview widget.

Python SDK

  • Fixed error when triggering organization pipelines via InstillClient.trigger_org_pipeline_release().

To file an issue please usethis template or raise them in our Discord community.