All Scaffoldings

Load IBM WatsonX AI data in Python using dltHub

Build a IBM WatsonX AI-to-database or-dataframe pipeline in Python using dlt with automatic Cursor support.

Last updated:

In this guide, we'll set up a complete ML Service data pipeline from API credentials to your first data load in just 10 minutes. You'll end up with a fully declarative Python pipeline based on dlt's REST API connector, like in the partial example code below:

Example code
@dlt.source
def ibm_watsonx_ai_source(access_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "/ml/v1/",
            "auth": {
                "type": "bearer",
                "token": ML_SERVICE_API_KEY,
            },
        },
        "resources": [
            "prompts", "notebooks", "models"
            ],
    }
    [...]
    yield from rest_api_resources(config)


def get_data() -> None:
    # Connect to destination
    pipeline = dlt.pipeline(
        pipeline_name='ibm_watsonx_ai_pipeline',
        destination='duckdb',
        dataset_name='ibm_watsonx_ai_data', 
    )
    # Load the data
    load_info = pipeline.run(ibm_watsonx_ai_source())
    print(load_info)

Why use dltHub Workspace with LLM Context to generate Python pipelines?

  • Accelerate pipeline development with AI-native context
  • Debug pipelines, validate schemas and data with the integrated Pipeline Dashboard
  • Build Python notebooks for end users of your data
  • Low maintenance thanks to Schema evolution with type inference, resilience and self documenting REST API connectors. A shallow learning curve makes the pipeline easy to extend by any team member
  • dlt is the tool of choice for Pythonic Iceberg Lakehouses, bringing mature data loading to pythonic Iceberg with or without catalogs

What you’ll do

We’ll show you how to generate a readable and easily maintainable Python script that fetches data from ibm_watsonx_ai’s API and loads it into Iceberg, DataFrames, files, or a database of your choice. Here are some of the endpoints you can load:

  • Prompts: Endpoints for managing prompts.
  • Notebooks: Endpoints related to Jupyter notebooks.
  • Models: Endpoints for managing machine learning models.
  • Trainings: Endpoints for initiating and managing training processes.
  • Text: Endpoints for various text processing tasks.

You will then debug the ML Service pipeline using our Pipeline Dashboard tool to ensure it is copying the data correctly, before building a Notebook to explore your data and build reports.

Setup & steps to follow

💡
Before getting started, let's make sure Cursor is set up correctly:

Now you're ready to get started!

  1. ⚙️ Set up dlt Workspace

    Install dlt with duckdb support:

    pip install "dlt[workspace]"

    Initialize a dlt pipeline with ML Service support.

    dlt init dlthub:ibm_watsonx_ai duckdb

    The init command will setup the necessary files and folders for the next step.

  2. 🤠 Start LLM-assisted coding

    Here’s a prompt to get you started:

    Prompt
    Please generate a REST API Source for ML Service API, as specified in @ibm_watsonx_ai-docs.yaml 
Start with endpoints prompts and  and skip incremental loading for now. 
Place the code in ibm_watsonx_ai_pipeline.py and name the pipeline ibm_watsonx_ai_pipeline. 
If the file exists, use it as a starting point. 
Do not add or modify any other files. 
Use @dlt rest api as a tutorial. 
After adding the endpoints, allow the user to run the pipeline with python ibm_watsonx_ai_pipeline.py and await further instructions.

  3. 🔒 Set up credentials

    Authentication is done via an API key, which should be treated as a password and kept secure. IAM tokens are valid for 60 minutes and are necessary for accessing specific features.

    To get the appropriate API keys, please visit the original source at https://www.ibm.com/cloud/machine-learning. If you want to protect your environment secrets in a production environment, look into setting up credentials with dlt.

  4. 🏃‍♀️ Run the pipeline in the Python terminal in Cursor

    python ibm_watsonx_ai_pipeline.py

    If your pipeline runs correctly, you’ll see something like the following:

    Pipeline ibm_watsonx_ai load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset ibm_watsonx_ai_data
The duckdb destination used duckdb:/ibm_watsonx_ai.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

  5. 📈 Debug your pipeline and data with the Pipeline Dashboard

    Now that you have a running pipeline, you need to make sure it’s correct, so you do not introduce silent failures like misconfigured pagination or incremental loading errors. By launching the dlt Workspace Pipeline Dashboard, you can see various information about the pipeline to enable you to test it. Here you can see:

    • Pipeline overview: State, load metrics
    • Data’s schema: tables, columns, types, hints
    • You can query the data itself
    dlt pipeline ibm_watsonx_ai_pipeline show

  6. 🐍 Build a Notebook with data explorations and reports

    With the pipeline and data partially validated, you can continue with custom data explorations and reports. To get started, paste the snippet below into a new marimo Notebook and ask your LLM to go from there. Jupyter Notebooks and regular Python scripts are supported as well.

    import dlt

data = dlt.pipeline("ibm_watsonx_ai_pipeline").dataset()
# get rompt table as Pandas frame
data.rompt.df().head()

Running into errors?

Some features are in preview and may only be available in specific regions. A default space ID or project ID is mandatory for proper functionality, and care must be taken to handle API keys securely.

Extra resources:

Next steps

Was this page helpful?

Community Hub

Need more dlt context for IBM WatsonX AI?

Request dlt skills, commands, AGENT.md files, and AI-native context.

Request more contextSubmit context