API Reference

The IBM watsonx.data intelligence SDK for Python provides comprehensive APIs organized by module.

This API reference documentation is auto-generated from the source code docstrings and provides detailed information about all classes, methods, and functions.

• Common Modules API
  • Authentication API
  • Overview
• DQ Validator Module API
  • Core Classes API
  • Metadata API
  • Validation Checks API
  • DataFrame Integration API
  • REST API Providers
  • Results API
  • Overview
  • Module Organization
• DPH Services API
  • Core Classes
  • Main Service Class
• ODCS Generator Reference
  • Collibra Integration
  • Informatica Integration
• Data Product Recommender Reference
  • Core Classes
  • Platform Parsers
  • Base Classes

Module Organization

Common Modules

Shared functionality used across all SDK modules:

• Authentication - Multi-environment authentication

DQ Validator Module

In-memory data quality validation:

• Core Classes - Validator, ValidationRule, ValidationResult

• Metadata - AssetMetadata, ColumnMetadata, DataType

• Validation Checks - All 9 validation check types

• DataFrame Integration - Pandas and PySpark validators

• REST API Providers - IBM Cloud Pak for Data integration

• Result Consolidation - Result aggregation and analysis

DPH Services Module

Data Product Hub API client:

• DphV1 Service - Main service class for Data Product Hub operations

• Container, data product, draft, release, and domain management

• Contract terms and template operations

• Asset visualization

ODCS Generator Module

Generate Open Data Contract Standard files:

• Collibra Integration - CollibraClient and ODCSGenerator classes

• Informatica Integration - InformaticaClient and ODCSGenerator classes

• ODCS v3.1.0 compliant YAML generation

• Command-line and Python interfaces

Data Product Recommender Module

Query log analysis tool for data product recommendations:

• DataProductRecommender - Core recommendation engine

• Platform-specific query log parsers (Snowflake, Databricks, BigQuery, watsonx.data)

• Scoring and ranking algorithms

• CLI and Python interfaces

Navigation Tips

• Use the search function to find specific classes or methods

• Click on class names to see detailed documentation

• Method signatures include type hints for parameters and return values

• Examples are provided where applicable

Conventions

Type Hints

All APIs include comprehensive type hints:

def validate(self, record: List[Any], record_index: int = 0) -> ValidationResult:
    """Validate a single record."""
    pass

Optional Parameters

Optional parameters are indicated with Optional[Type]:

def __init__(self, url: Optional[str] = None):
    """Initialize with optional URL."""
    pass

Return Types

Return types are clearly documented:

def get_token(self) -> str:
    """
    Returns:
        str: The authentication token
    """
    pass