API

ibm-watsonx-ai client contains different APIs available for AutoAI and assets management.

Prerequisites

Initialize the client using the watsonx.ai instance details provided in Setup.

Modules

• Base
  • APIClient
    • APIClient
      • APIClient.set_headers()
      • APIClient.set_token()
  • Credentials
    • Credentials
      • Credentials.from_dict()
      • Credentials.to_dict()
• Core
  • Connections
    • Connections
      • Connections.ConfigurationMetaNames
      • Connections.create()
      • Connections.delete()
      • Connections.get_datasource_type_details_by_id()
      • Connections.get_datasource_type_id_by_name()
      • Connections.get_datasource_type_uid_by_name()
      • Connections.get_details()
      • Connections.get_id()
      • Connections.get_uid()
      • Connections.get_uploaded_db_drivers()
      • Connections.list()
      • Connections.list_datasource_types()
      • Connections.list_uploaded_db_drivers()
      • Connections.sign_db_driver_url()
      • Connections.upload_db_driver()
    • ConnectionMetaNames
  • Data assets
    • Assets
      • Assets.ConfigurationMetaNames
      • Assets.create()
      • Assets.delete()
      • Assets.download()
      • Assets.get_content()
      • Assets.get_details()
      • Assets.get_href()
      • Assets.get_id()
      • Assets.list()
      • Assets.store()
    • AssetsMetaNames
  • Deployments
    • Deployments
      • Deployments.HardwareRequestSizes
        • Deployments.HardwareRequestSizes.capitalize()
        • Deployments.HardwareRequestSizes.casefold()
        • Deployments.HardwareRequestSizes.center()
        • Deployments.HardwareRequestSizes.count()
        • Deployments.HardwareRequestSizes.encode()
        • Deployments.HardwareRequestSizes.endswith()
        • Deployments.HardwareRequestSizes.expandtabs()
        • Deployments.HardwareRequestSizes.find()
        • Deployments.HardwareRequestSizes.format()
        • Deployments.HardwareRequestSizes.format_map()
        • Deployments.HardwareRequestSizes.index()
        • Deployments.HardwareRequestSizes.isalnum()
        • Deployments.HardwareRequestSizes.isalpha()
        • Deployments.HardwareRequestSizes.isascii()
        • Deployments.HardwareRequestSizes.isdecimal()
        • Deployments.HardwareRequestSizes.isdigit()
        • Deployments.HardwareRequestSizes.isidentifier()
        • Deployments.HardwareRequestSizes.islower()
        • Deployments.HardwareRequestSizes.isnumeric()
        • Deployments.HardwareRequestSizes.isprintable()
        • Deployments.HardwareRequestSizes.isspace()
        • Deployments.HardwareRequestSizes.istitle()
        • Deployments.HardwareRequestSizes.isupper()
        • Deployments.HardwareRequestSizes.join()
        • Deployments.HardwareRequestSizes.ljust()
        • Deployments.HardwareRequestSizes.lower()
        • Deployments.HardwareRequestSizes.lstrip()
        • Deployments.HardwareRequestSizes.maketrans()
        • Deployments.HardwareRequestSizes.partition()
        • Deployments.HardwareRequestSizes.removeprefix()
        • Deployments.HardwareRequestSizes.removesuffix()
        • Deployments.HardwareRequestSizes.replace()
        • Deployments.HardwareRequestSizes.rfind()
        • Deployments.HardwareRequestSizes.rindex()
        • Deployments.HardwareRequestSizes.rjust()
        • Deployments.HardwareRequestSizes.rpartition()
        • Deployments.HardwareRequestSizes.rsplit()
        • Deployments.HardwareRequestSizes.rstrip()
        • Deployments.HardwareRequestSizes.split()
        • Deployments.HardwareRequestSizes.splitlines()
        • Deployments.HardwareRequestSizes.startswith()
        • Deployments.HardwareRequestSizes.strip()
        • Deployments.HardwareRequestSizes.swapcase()
        • Deployments.HardwareRequestSizes.title()
        • Deployments.HardwareRequestSizes.translate()
        • Deployments.HardwareRequestSizes.upper()
        • Deployments.HardwareRequestSizes.zfill()
      • Deployments.create()
      • Deployments.create_job()
      • Deployments.delete()
      • Deployments.delete_job()
      • Deployments.generate()
      • Deployments.generate_text()
      • Deployments.generate_text_stream()
      • Deployments.get_details()
      • Deployments.get_download_url()
      • Deployments.get_href()
      • Deployments.get_id()
      • Deployments.get_job_details()
      • Deployments.get_job_href()
      • Deployments.get_job_id()
      • Deployments.get_job_status()
      • Deployments.get_job_uid()
      • Deployments.get_scoring_href()
      • Deployments.get_serving_href()
      • Deployments.get_uid()
      • Deployments.is_serving_name_available()
      • Deployments.list()
      • Deployments.list_jobs()
      • Deployments.run_ai_service()
      • Deployments.run_ai_service_stream()
      • Deployments.score()
      • Deployments.update()
    • DeploymentMetaNames
    • RShinyAuthenticationValues
      • RShinyAuthenticationValues.ANYONE_WITH_URL
      • RShinyAuthenticationValues.ANY_VALID_USER
      • RShinyAuthenticationValues.MEMBERS_OF_DEPLOYMENT_SPACE
    • ScoringMetaNames
    • DecisionOptimizationMetaNames
    • RuntimeContext
      • RuntimeContext.generate_token()
      • RuntimeContext.get_headers()
      • RuntimeContext.get_json()
      • RuntimeContext.get_token()
  • Export/Import
    • Export
      • Export.cancel()
      • Export.delete()
      • Export.get_details()
      • Export.get_exported_content()
      • Export.get_id()
      • Export.list()
      • Export.start()
    • Import
      • Import.cancel()
      • Import.delete()
      • Import.get_details()
      • Import.get_id()
      • Import.list()
      • Import.start()
  • Factsheets (IBM Cloud only)
    • Factsheets
      • Factsheets.list_model_entries()
      • Factsheets.register_model_entry()
      • Factsheets.unregister_model_entry()
    • FactsheetsMetaNames
  • Hardware specifications
    • HwSpec
      • HwSpec.ConfigurationMetaNames
      • HwSpec.delete()
      • HwSpec.get_details()
      • HwSpec.get_href()
      • HwSpec.get_id()
      • HwSpec.get_id_by_name()
      • HwSpec.get_uid()
      • HwSpec.get_uid_by_name()
      • HwSpec.list()
      • HwSpec.store()
    • HwSpecMetaNames
  • Helpers
    • get_credentials_from_config
  • Model definitions
    • ModelDefinition
      • ModelDefinition.ConfigurationMetaNames
      • ModelDefinition.create_revision()
      • ModelDefinition.delete()
      • ModelDefinition.download()
      • ModelDefinition.get_details()
      • ModelDefinition.get_href()
      • ModelDefinition.get_id()
      • ModelDefinition.get_revision_details()
      • ModelDefinition.get_uid()
      • ModelDefinition.list()
      • ModelDefinition.list_revisions()
      • ModelDefinition.store()
      • ModelDefinition.update()
    • ModelDefinitionMetaNames
  • Package extensions
    • PkgExtn
      • PkgExtn.ConfigurationMetaNames
      • PkgExtn.delete()
      • PkgExtn.download()
      • PkgExtn.get_details()
      • PkgExtn.get_href()
      • PkgExtn.get_id()
      • PkgExtn.get_id_by_name()
      • PkgExtn.list()
      • PkgExtn.store()
    • PkgExtnMetaNames
  • Parameter Sets
    • ParameterSets
      • ParameterSets.ConfigurationMetaNames
      • ParameterSets.create()
      • ParameterSets.delete()
      • ParameterSets.get_details()
      • ParameterSets.get_id_by_name()
      • ParameterSets.list()
      • ParameterSets.update()
    • ParameterSetsMetaNames
  • Repository
    • Repository
      • Repository.ModelAssetTypes
      • Repository.create_ai_service_revision()
      • Repository.create_experiment_revision()
      • Repository.create_function_revision()
      • Repository.create_model_revision()
      • Repository.create_pipeline_revision()
      • Repository.create_revision()
      • Repository.delete()
      • Repository.download()
      • Repository.get_ai_service_details()
      • Repository.get_ai_service_id()
      • Repository.get_ai_service_revision_details()
      • Repository.get_details()
      • Repository.get_experiment_details()
      • Repository.get_experiment_href()
      • Repository.get_experiment_id()
      • Repository.get_experiment_revision_details()
      • Repository.get_function_details()
      • Repository.get_function_href()
      • Repository.get_function_id()
      • Repository.get_function_revision_details()
      • Repository.get_id_by_name()
      • Repository.get_model_details()
      • Repository.get_model_href()
      • Repository.get_model_id()
      • Repository.get_model_revision_details()
      • Repository.get_pipeline_details()
      • Repository.get_pipeline_href()
      • Repository.get_pipeline_id()
      • Repository.get_pipeline_revision_details()
      • Repository.list()
      • Repository.list_ai_service_revisions()
      • Repository.list_ai_services()
      • Repository.list_experiments()
      • Repository.list_experiments_revisions()
      • Repository.list_functions()
      • Repository.list_functions_revisions()
      • Repository.list_models()
      • Repository.list_models_revisions()
      • Repository.list_pipelines()
      • Repository.list_pipelines_revisions()
      • Repository.load()
      • Repository.promote_model()
      • Repository.store_ai_service()
      • Repository.store_experiment()
      • Repository.store_function()
      • Repository.store_model()
      • Repository.store_pipeline()
      • Repository.update_ai_service()
      • Repository.update_experiment()
      • Repository.update_function()
      • Repository.update_model()
      • Repository.update_pipeline()
    • ModelMetaNames
    • ExperimentMetaNames
    • FunctionMetaNames
    • PipelineMetanames
    • AIServiceMetaNames
  • Script
    • Script
      • Script.ConfigurationMetaNames
      • Script.create_revision()
      • Script.delete()
      • Script.download()
      • Script.get_details()
      • Script.get_href()
      • Script.get_id()
      • Script.get_revision_details()
      • Script.list()
      • Script.list_revisions()
      • Script.store()
      • Script.update()
    • ScriptMetaNames
  • Service instance
    • ServiceInstance
      • ServiceInstance.get_api_key()
      • ServiceInstance.get_details()
      • ServiceInstance.get_instance_id()
      • ServiceInstance.get_password()
      • ServiceInstance.get_url()
      • ServiceInstance.get_username()
  • Set
    • Set
      • Set.default_project()
      • Set.default_space()
  • Shiny (IBM Cloud Pak® for Data only)
    • Shiny
      • Shiny.ConfigurationMetaNames
      • Shiny.create_revision()
      • Shiny.delete()
      • Shiny.download()
      • Shiny.get_details()
      • Shiny.get_href()
      • Shiny.get_id()
      • Shiny.get_revision_details()
      • Shiny.get_uid()
      • Shiny.list()
      • Shiny.list_revisions()
      • Shiny.store()
      • Shiny.update()
  • Software specifications
    • SwSpec
      • SwSpec.ConfigurationMetaNames
      • SwSpec.add_package_extension()
      • SwSpec.delete()
      • SwSpec.delete_package_extension()
      • SwSpec.get_details()
      • SwSpec.get_href()
      • SwSpec.get_id()
      • SwSpec.get_id_by_name()
      • SwSpec.get_uid()
      • SwSpec.get_uid_by_name()
      • SwSpec.list()
      • SwSpec.store()
    • SwSpecMetaNames
  • Spaces
    • Spaces
      • Spaces.ConfigurationMetaNames
      • Spaces.MemberMetaNames
      • Spaces.create_member()
      • Spaces.delete()
      • Spaces.delete_member()
      • Spaces.get_details()
      • Spaces.get_id()
      • Spaces.get_id_by_name()
      • Spaces.get_member_details()
      • Spaces.get_uid()
      • Spaces.list()
      • Spaces.list_members()
      • Spaces.promote()
      • Spaces.store()
      • Spaces.update()
      • Spaces.update_member()
    • SpacesMetaNames
    • SpacesMemberMetaNames
  • Training
    • Training
      • Training.cancel()
      • Training.get_details()
      • Training.get_href()
      • Training.get_id()
      • Training.get_metrics()
      • Training.get_status()
      • Training.list()
      • Training.list_intermediate_models()
      • Training.monitor_logs()
      • Training.monitor_metrics()
      • Training.run()
    • TrainingConfigurationMetaNames
  • Enums
    • ClassificationAlgorithms
      • ClassificationAlgorithms.DT
      • ClassificationAlgorithms.EX_TREES
      • ClassificationAlgorithms.GB
      • ClassificationAlgorithms.LGBM
      • ClassificationAlgorithms.LR
      • ClassificationAlgorithms.RF
      • ClassificationAlgorithms.SnapBM
      • ClassificationAlgorithms.SnapDT
      • ClassificationAlgorithms.SnapLR
      • ClassificationAlgorithms.SnapRF
      • ClassificationAlgorithms.SnapSVM
      • ClassificationAlgorithms.XGB
    • ClassificationAlgorithmsCP4D
      • ClassificationAlgorithmsCP4D.DT
      • ClassificationAlgorithmsCP4D.EX_TREES
      • ClassificationAlgorithmsCP4D.GB
      • ClassificationAlgorithmsCP4D.LGBM
      • ClassificationAlgorithmsCP4D.LR
      • ClassificationAlgorithmsCP4D.RF
      • ClassificationAlgorithmsCP4D.SnapBM
      • ClassificationAlgorithmsCP4D.SnapDT
      • ClassificationAlgorithmsCP4D.SnapLR
      • ClassificationAlgorithmsCP4D.SnapRF
      • ClassificationAlgorithmsCP4D.SnapSVM
      • ClassificationAlgorithmsCP4D.XGB
    • DataConnectionTypes
      • DataConnectionTypes.CA
      • DataConnectionTypes.CN
      • DataConnectionTypes.DS
      • DataConnectionTypes.FS
      • DataConnectionTypes.S3
    • Directions
      • Directions.ASCENDING
      • Directions.DESCENDING
    • DocumentsSamplingTypes
      • DocumentsSamplingTypes.BENCHMARK_DRIVEN
      • DocumentsSamplingTypes.RANDOM
    • ForecastingAlgorithms
      • ForecastingAlgorithms.ARIMA
      • ForecastingAlgorithms.BATS
      • ForecastingAlgorithms.ENSEMBLER
      • ForecastingAlgorithms.HW
      • ForecastingAlgorithms.LR
      • ForecastingAlgorithms.RF
      • ForecastingAlgorithms.SVM
    • ForecastingAlgorithmsCP4D
      • ForecastingAlgorithmsCP4D.ARIMA
      • ForecastingAlgorithmsCP4D.BATS
      • ForecastingAlgorithmsCP4D.ENSEMBLER
      • ForecastingAlgorithmsCP4D.HW
      • ForecastingAlgorithmsCP4D.LR
      • ForecastingAlgorithmsCP4D.RF
      • ForecastingAlgorithmsCP4D.SVM
    • ForecastingPipelineTypes
      • ForecastingPipelineTypes.ARIMA
      • ForecastingPipelineTypes.ARIMAX
      • ForecastingPipelineTypes.ARIMAX_DMLR
      • ForecastingPipelineTypes.ARIMAX_PALR
      • ForecastingPipelineTypes.ARIMAX_RAR
      • ForecastingPipelineTypes.ARIMAX_RSAR
      • ForecastingPipelineTypes.Bats
      • ForecastingPipelineTypes.DifferenceFlattenEnsembler
      • ForecastingPipelineTypes.ExogenousDifferenceFlattenEnsembler
      • ForecastingPipelineTypes.ExogenousFlattenEnsembler
      • ForecastingPipelineTypes.ExogenousLocalizedFlattenEnsembler
      • ForecastingPipelineTypes.ExogenousMT2RForecaster
      • ForecastingPipelineTypes.ExogenousRandomForestRegressor
      • ForecastingPipelineTypes.ExogenousSVM
      • ForecastingPipelineTypes.FlattenEnsembler
      • ForecastingPipelineTypes.HoltWinterAdditive
      • ForecastingPipelineTypes.HoltWinterMultiplicative
      • ForecastingPipelineTypes.LocalizedFlattenEnsembler
      • ForecastingPipelineTypes.MT2RForecaster
      • ForecastingPipelineTypes.RandomForestRegressor
      • ForecastingPipelineTypes.SVM
      • ForecastingPipelineTypes.get_exogenous()
      • ForecastingPipelineTypes.get_non_exogenous()
    • ImputationStrategy
      • ImputationStrategy.BEST_OF_DEFAULT_IMPUTERS
      • ImputationStrategy.CUBIC
      • ImputationStrategy.FLATTEN_ITERATIVE
      • ImputationStrategy.LINEAR
      • ImputationStrategy.MEAN
      • ImputationStrategy.MEDIAN
      • ImputationStrategy.MOST_FREQUENT
      • ImputationStrategy.NEXT
      • ImputationStrategy.NO_IMPUTATION
      • ImputationStrategy.PREVIOUS
      • ImputationStrategy.VALUE
    • Metrics
      • Metrics.ACCURACY_AND_DISPARATE_IMPACT_SCORE
      • Metrics.ACCURACY_SCORE
      • Metrics.AVERAGE_PRECISION_SCORE
      • Metrics.EXPLAINED_VARIANCE_SCORE
      • Metrics.F1_SCORE
      • Metrics.F1_SCORE_MACRO
      • Metrics.F1_SCORE_MICRO
      • Metrics.F1_SCORE_WEIGHTED
      • Metrics.LOG_LOSS
      • Metrics.MEAN_ABSOLUTE_ERROR
      • Metrics.MEAN_SQUARED_ERROR
      • Metrics.MEAN_SQUARED_LOG_ERROR
      • Metrics.MEDIAN_ABSOLUTE_ERROR
      • Metrics.PRECISION_SCORE
      • Metrics.PRECISION_SCORE_MACRO
      • Metrics.PRECISION_SCORE_MICRO
      • Metrics.PRECISION_SCORE_WEIGHTED
      • Metrics.R2_AND_DISPARATE_IMPACT_SCORE
      • Metrics.R2_SCORE
      • Metrics.RECALL_SCORE
      • Metrics.RECALL_SCORE_MACRO
      • Metrics.RECALL_SCORE_MICRO
      • Metrics.RECALL_SCORE_WEIGHTED
      • Metrics.ROC_AUC_SCORE
      • Metrics.ROOT_MEAN_SQUARED_ERROR
      • Metrics.ROOT_MEAN_SQUARED_LOG_ERROR
    • MetricsToDirections
      • MetricsToDirections.ACCURACY
      • MetricsToDirections.AVERAGE_PRECISION
      • MetricsToDirections.EXPLAINED_VARIANCE
      • MetricsToDirections.F1
      • MetricsToDirections.F1_MACRO
      • MetricsToDirections.F1_MICRO
      • MetricsToDirections.F1_WEIGHTED
      • MetricsToDirections.NEG_LOG_LOSS
      • MetricsToDirections.NEG_MEAN_ABSOLUTE_ERROR
      • MetricsToDirections.NEG_MEAN_SQUARED_ERROR
      • MetricsToDirections.NEG_MEAN_SQUARED_LOG_ERROR
      • MetricsToDirections.NEG_MEDIAN_ABSOLUTE_ERROR
      • MetricsToDirections.NEG_ROOT_MEAN_SQUARED_ERROR
      • MetricsToDirections.NEG_ROOT_MEAN_SQUARED_LOG_ERROR
      • MetricsToDirections.NORMALIZED_GINI_COEFFICIENT
      • MetricsToDirections.PRECISION
      • MetricsToDirections.PRECISION_MACRO
      • MetricsToDirections.PRECISION_MICRO
      • MetricsToDirections.PRECISION_WEIGHTED
      • MetricsToDirections.R2
      • MetricsToDirections.RECALL
      • MetricsToDirections.RECALL_MACRO
      • MetricsToDirections.RECALL_MICRO
      • MetricsToDirections.RECALL_WEIGHTED
      • MetricsToDirections.ROC_AUC
    • PipelineTypes
      • PipelineTypes.LALE
      • PipelineTypes.SKLEARN
    • PositiveLabelClass
      • PositiveLabelClass.AVERAGE_PRECISION_SCORE
      • PositiveLabelClass.F1_SCORE
      • PositiveLabelClass.F1_SCORE_MACRO
      • PositiveLabelClass.F1_SCORE_MICRO
      • PositiveLabelClass.F1_SCORE_WEIGHTED
      • PositiveLabelClass.PRECISION_SCORE
      • PositiveLabelClass.PRECISION_SCORE_MACRO
      • PositiveLabelClass.PRECISION_SCORE_MICRO
      • PositiveLabelClass.PRECISION_SCORE_WEIGHTED
      • PositiveLabelClass.RECALL_SCORE
      • PositiveLabelClass.RECALL_SCORE_MACRO
      • PositiveLabelClass.RECALL_SCORE_MICRO
      • PositiveLabelClass.RECALL_SCORE_WEIGHTED
    • PredictionType
      • PredictionType.BINARY
      • PredictionType.CLASSIFICATION
      • PredictionType.FORECASTING
      • PredictionType.MULTICLASS
      • PredictionType.REGRESSION
      • PredictionType.TIMESERIES_ANOMALY_PREDICTION
    • RAGMetrics
      • RAGMetrics.ANSWER_CORRECTNESS
      • RAGMetrics.CONTEXT_CORRECTNESS
      • RAGMetrics.FAITHFULNESS
    • RegressionAlgorithms
      • RegressionAlgorithms.DT
      • RegressionAlgorithms.EX_TREES
      • RegressionAlgorithms.GB
      • RegressionAlgorithms.LGBM
      • RegressionAlgorithms.LR
      • RegressionAlgorithms.RF
      • RegressionAlgorithms.RIDGE
      • RegressionAlgorithms.SnapBM
      • RegressionAlgorithms.SnapDT
      • RegressionAlgorithms.SnapRF
      • RegressionAlgorithms.XGB
    • RegressionAlgorithmsCP4D
      • RegressionAlgorithmsCP4D.DT
      • RegressionAlgorithmsCP4D.EX_TREES
      • RegressionAlgorithmsCP4D.GB
      • RegressionAlgorithmsCP4D.LGBM
      • RegressionAlgorithmsCP4D.LR
      • RegressionAlgorithmsCP4D.RF
      • RegressionAlgorithmsCP4D.RIDGE
      • RegressionAlgorithmsCP4D.SnapBM
      • RegressionAlgorithmsCP4D.SnapDT
      • RegressionAlgorithmsCP4D.SnapRF
      • RegressionAlgorithmsCP4D.XGB
    • RunStateTypes
      • RunStateTypes.COMPLETED
      • RunStateTypes.FAILED
    • SamplingTypes
      • SamplingTypes.FIRST_VALUES
      • SamplingTypes.LAST_VALUES
      • SamplingTypes.RANDOM
      • SamplingTypes.STRATIFIED
    • TShirtSize
      • TShirtSize.L
      • TShirtSize.M
      • TShirtSize.S
      • TShirtSize.XL
    • TimeseriesAnomalyPredictionAlgorithms
      • TimeseriesAnomalyPredictionAlgorithms.Forecasting
      • TimeseriesAnomalyPredictionAlgorithms.Relationship
      • TimeseriesAnomalyPredictionAlgorithms.Window
    • TimeseriesAnomalyPredictionPipelineTypes
      • TimeseriesAnomalyPredictionPipelineTypes.PointwiseBoundedBATS
      • TimeseriesAnomalyPredictionPipelineTypes.PointwiseBoundedBATSForceUpdate
      • TimeseriesAnomalyPredictionPipelineTypes.PointwiseBoundedHoltWintersAdditive
      • TimeseriesAnomalyPredictionPipelineTypes.WindowLOF
      • TimeseriesAnomalyPredictionPipelineTypes.WindowNN
      • TimeseriesAnomalyPredictionPipelineTypes.WindowPCA
    • Transformers
      • Transformers.ABS
      • Transformers.CBRT
      • Transformers.COS
      • Transformers.CUBE
      • Transformers.DIFF
      • Transformers.DIVIDE
      • Transformers.FEATUREAGGLOMERATION
      • Transformers.ISOFORESTANOMALY
      • Transformers.LOG
      • Transformers.MAX
      • Transformers.MINMAXSCALER
      • Transformers.NXOR
      • Transformers.PCA
      • Transformers.PRODUCT
      • Transformers.ROUND
      • Transformers.SIGMOID
      • Transformers.SIN
      • Transformers.SQRT
      • Transformers.SQUARE
      • Transformers.STDSCALER
      • Transformers.SUM
      • Transformers.TAN
    • VisualizationTypes
      • VisualizationTypes.INPLACE
      • VisualizationTypes.PDF
• Federated Learning
  • Aggregation
    • Configure and start aggregation
  • Local training
    • Configure and start local training
      • RemoteTrainingSystem
        • RemoteTrainingSystem.create_party()
        • RemoteTrainingSystem.create_revision()
        • RemoteTrainingSystem.delete()
        • RemoteTrainingSystem.get_details()
        • RemoteTrainingSystem.get_id()
        • RemoteTrainingSystem.get_revision_details()
        • RemoteTrainingSystem.list()
        • RemoteTrainingSystem.list_revisions()
        • RemoteTrainingSystem.store()
        • RemoteTrainingSystem.update()
      • Party
        • Party.cancel()
        • Party.get_round()
        • Party.is_running()
        • Party.monitor_logs()
        • Party.monitor_metrics()
        • Party.run()
• Data Connections
  • Working with DataConnection
    • IBM Cloud - DataConnection Initialization
      • Connection Asset
      • Data Asset
      • Container
    • IBM watsonx.ai software - DataConnection Initialization
      • Connection Asset - DatabaseLocation
      • Connection Asset - S3Location
      • Connection Asset - NFSLocation
      • Data Asset
      • FSLocation
    • Batch DataConnection
    • Upload your training dataset
    • Download your training dataset
  • DataConnection Modules
    • DataConnection
      • DataConnection
        • DataConnection.download()
        • DataConnection.from_dict()
        • DataConnection.from_studio()
        • DataConnection.read()
        • DataConnection.set_client()
        • DataConnection.to_dict()
        • DataConnection.write()
    • S3Location
      • S3Location
        • S3Location.get_location()
    • CloudAssetLocation
      • CloudAssetLocation
    • DeploymentOutputAssetLocation
      • DeploymentOutputAssetLocation
  • IterableDatasets Modules
    • TabularIterableDataset
      • TabularIterableDataset
        • TabularIterableDataset.write()
    • DocumentsIterableDataset
      • DocumentsIterableDataset
• AutoAI
  • Working with AutoAI class and optimizer
    • Configure optimizer with one data source
    • Configure optimizer for time series forecasting
    • Configure optimizer for time series forecasting with supporting features
    • Get configuration parameters
    • Fit optimizer
    • Get the run status and run details
    • Get data connections
    • Pipeline summary
    • Get pipeline details
    • Get pipeline
    • Working with deployments
    • Web Service
    • Batch
  • Working with AutoAI RAG class and rag_optimizer
    • Configure rag_optimizer with one data source
    • Get configuration parameters
    • Run rag_optimizer
    • Get the run status and run details
    • RAG Optimizer summary
    • Get pattern details
    • Get pattern
    • Get inference and indexing notebooks
    • Get logs
    • Get evaluation results
  • AutoAI experiment
    • AutoAI
      • AutoAI
        • AutoAI.ClassificationAlgorithms
          • AutoAI.ClassificationAlgorithms.DT
          • AutoAI.ClassificationAlgorithms.EX_TREES
          • AutoAI.ClassificationAlgorithms.GB
          • AutoAI.ClassificationAlgorithms.LGBM
          • AutoAI.ClassificationAlgorithms.LR
          • AutoAI.ClassificationAlgorithms.RF
          • AutoAI.ClassificationAlgorithms.SnapBM
          • AutoAI.ClassificationAlgorithms.SnapDT
          • AutoAI.ClassificationAlgorithms.SnapLR
          • AutoAI.ClassificationAlgorithms.SnapRF
          • AutoAI.ClassificationAlgorithms.SnapSVM
          • AutoAI.ClassificationAlgorithms.XGB
        • AutoAI.DataConnectionTypes
          • AutoAI.DataConnectionTypes.CA
          • AutoAI.DataConnectionTypes.CN
          • AutoAI.DataConnectionTypes.DS
          • AutoAI.DataConnectionTypes.FS
          • AutoAI.DataConnectionTypes.S3
        • AutoAI.ForecastingAlgorithms
          • AutoAI.ForecastingAlgorithms.ARIMA
          • AutoAI.ForecastingAlgorithms.BATS
          • AutoAI.ForecastingAlgorithms.ENSEMBLER
          • AutoAI.ForecastingAlgorithms.HW
          • AutoAI.ForecastingAlgorithms.LR
          • AutoAI.ForecastingAlgorithms.RF
          • AutoAI.ForecastingAlgorithms.SVM
        • AutoAI.Metrics
          • AutoAI.Metrics.ACCURACY_AND_DISPARATE_IMPACT_SCORE
          • AutoAI.Metrics.ACCURACY_SCORE
          • AutoAI.Metrics.AVERAGE_PRECISION_SCORE
          • AutoAI.Metrics.EXPLAINED_VARIANCE_SCORE
          • AutoAI.Metrics.F1_SCORE
          • AutoAI.Metrics.F1_SCORE_MACRO
          • AutoAI.Metrics.F1_SCORE_MICRO
          • AutoAI.Metrics.F1_SCORE_WEIGHTED
          • AutoAI.Metrics.LOG_LOSS
          • AutoAI.Metrics.MEAN_ABSOLUTE_ERROR
          • AutoAI.Metrics.MEAN_SQUARED_ERROR
          • AutoAI.Metrics.MEAN_SQUARED_LOG_ERROR
          • AutoAI.Metrics.MEDIAN_ABSOLUTE_ERROR
          • AutoAI.Metrics.PRECISION_SCORE
          • AutoAI.Metrics.PRECISION_SCORE_MACRO
          • AutoAI.Metrics.PRECISION_SCORE_MICRO
          • AutoAI.Metrics.PRECISION_SCORE_WEIGHTED
          • AutoAI.Metrics.R2_AND_DISPARATE_IMPACT_SCORE
          • AutoAI.Metrics.R2_SCORE
          • AutoAI.Metrics.RECALL_SCORE
          • AutoAI.Metrics.RECALL_SCORE_MACRO
          • AutoAI.Metrics.RECALL_SCORE_MICRO
          • AutoAI.Metrics.RECALL_SCORE_WEIGHTED
          • AutoAI.Metrics.ROC_AUC_SCORE
          • AutoAI.Metrics.ROOT_MEAN_SQUARED_ERROR
          • AutoAI.Metrics.ROOT_MEAN_SQUARED_LOG_ERROR
        • AutoAI.PipelineTypes
          • AutoAI.PipelineTypes.LALE
          • AutoAI.PipelineTypes.SKLEARN
        • AutoAI.PredictionType
          • AutoAI.PredictionType.BINARY
          • AutoAI.PredictionType.CLASSIFICATION
          • AutoAI.PredictionType.FORECASTING
          • AutoAI.PredictionType.MULTICLASS
          • AutoAI.PredictionType.REGRESSION
          • AutoAI.PredictionType.TIMESERIES_ANOMALY_PREDICTION
        • AutoAI.RAGMetrics
          • AutoAI.RAGMetrics.ANSWER_CORRECTNESS
          • AutoAI.RAGMetrics.CONTEXT_CORRECTNESS
          • AutoAI.RAGMetrics.FAITHFULNESS
        • AutoAI.RegressionAlgorithms
          • AutoAI.RegressionAlgorithms.DT
          • AutoAI.RegressionAlgorithms.EX_TREES
          • AutoAI.RegressionAlgorithms.GB
          • AutoAI.RegressionAlgorithms.LGBM
          • AutoAI.RegressionAlgorithms.LR
          • AutoAI.RegressionAlgorithms.RF
          • AutoAI.RegressionAlgorithms.RIDGE
          • AutoAI.RegressionAlgorithms.SnapBM
          • AutoAI.RegressionAlgorithms.SnapDT
          • AutoAI.RegressionAlgorithms.SnapRF
          • AutoAI.RegressionAlgorithms.XGB
        • AutoAI.SamplingTypes
          • AutoAI.SamplingTypes.FIRST_VALUES
          • AutoAI.SamplingTypes.LAST_VALUES
          • AutoAI.SamplingTypes.RANDOM
          • AutoAI.SamplingTypes.STRATIFIED
        • AutoAI.TShirtSize
          • AutoAI.TShirtSize.L
          • AutoAI.TShirtSize.M
          • AutoAI.TShirtSize.S
          • AutoAI.TShirtSize.XL
        • AutoAI.Transformers
          • AutoAI.Transformers.ABS
          • AutoAI.Transformers.CBRT
          • AutoAI.Transformers.COS
          • AutoAI.Transformers.CUBE
          • AutoAI.Transformers.DIFF
          • AutoAI.Transformers.DIVIDE
          • AutoAI.Transformers.FEATUREAGGLOMERATION
          • AutoAI.Transformers.ISOFORESTANOMALY
          • AutoAI.Transformers.LOG
          • AutoAI.Transformers.MAX
          • AutoAI.Transformers.MINMAXSCALER
          • AutoAI.Transformers.NXOR
          • AutoAI.Transformers.PCA
          • AutoAI.Transformers.PRODUCT
          • AutoAI.Transformers.ROUND
          • AutoAI.Transformers.SIGMOID
          • AutoAI.Transformers.SIN
          • AutoAI.Transformers.SQRT
          • AutoAI.Transformers.SQUARE
          • AutoAI.Transformers.STDSCALER
          • AutoAI.Transformers.SUM
          • AutoAI.Transformers.TAN
        • AutoAI.optimizer()
        • AutoAI.rag_optimizer()
        • AutoAI.runs()
  • Deployment Modules for AutoAI models
    • Web Service
      • WebService
        • WebService.create()
        • WebService.delete()
        • WebService.get()
        • WebService.get_params()
        • WebService.list()
        • WebService.score()
    • Batch
      • Batch
        • Batch.create()
        • Batch.delete()
        • Batch.get()
        • Batch.get_job_id()
        • Batch.get_job_params()
        • Batch.get_job_result()
        • Batch.get_job_status()
        • Batch.get_params()
        • Batch.list()
        • Batch.list_jobs()
        • Batch.rerun_job()
        • Batch.run_job()
        • Batch.score()
• Foundation Models
  • Modules
    • Embeddings
      • Embeddings
        • Embeddings
          • Embeddings.close_persistent_connection()
          • Embeddings.embed_documents()
          • Embeddings.embed_query()
          • Embeddings.generate()
          • Embeddings.to_dict()
      • BaseEmbeddings
        • BaseEmbeddings
          • BaseEmbeddings.embed_documents()
          • BaseEmbeddings.embed_query()
          • BaseEmbeddings.from_dict()
          • BaseEmbeddings.to_dict()
      • Enums
        • EmbedTextParamsMetaNames
        • EmbeddingModels
        • EmbeddingTypes
    • Models
      • Modules
        • ModelInference
          • ModelInference
            • ModelInference.achat()
            • ModelInference.aclose_persistent_connection()
            • ModelInference.agenerate()
            • ModelInference.chat()
            • ModelInference.chat_stream()
            • ModelInference.close_persistent_connection()
            • ModelInference.generate()
            • ModelInference.generate_text()
            • ModelInference.generate_text_stream()
            • ModelInference.get_details()
            • ModelInference.get_identifying_params()
            • ModelInference.set_api_client()
            • ModelInference.to_langchain()
            • ModelInference.tokenize()
          • Enums
            • TextModels
        • TSModelInference
          • TSModelInference
            • TSModelInference.forecast()
          • Enums
            • TimeSeriesModels
        • Model
          • Model
            • Model.chat()
            • Model.chat_stream()
            • Model.generate()
            • Model.generate_text()
            • Model.generate_text_stream()
            • Model.get_details()
            • Model.to_langchain()
            • Model.tokenize()
          • Enums
            • GenTextParamsMetaNames
            • GenTextReturnOptMetaNames
            • DecodingMethods
              • DecodingMethods.GREEDY
              • DecodingMethods.SAMPLE
            • ModelTypes
        • ModelInference for Deployments
          • Infer text with deployments
          • Creating ModelInference instance
          • Generate methods
    • Tuning
      • Working with TuneExperiment and PromptTuner
        • Configure PromptTuner
        • Get configuration parameters
        • Run prompt tuning
        • Get run status, get run details
        • Get data connections
        • Summary
        • Plot learning curves
        • Get the model identifier
      • Working with TuneExperiment and FineTuner
        • Configure FineTuner
        • Get configuration parameters
        • Run fine tuning
        • Get run status, get run details
        • Get data connections
        • Summary
        • Plot learning curves
        • Get the model identifier
      • Tuned Model Inference
        • Working with deployments
        • Creating ModelInference instance
        • Importing data
        • Analyzing satisfaction
        • Generate methods
      • Tune Experiment
        • TuneExperiment
          • TuneExperiment
            • TuneExperiment.fine_tuner()
            • TuneExperiment.prompt_tuner()
            • TuneExperiment.runs()
        • Tune Runs
          • TuneRuns
            • TuneRuns.get_run_details()
            • TuneRuns.get_tuner()
            • TuneRuns.list()
        • Prompt Tuner
          • PromptTuner
            • PromptTuner.cancel_run()
            • PromptTuner.get_data_connections()
            • PromptTuner.get_model_id()
            • PromptTuner.get_params()
            • PromptTuner.get_run_details()
            • PromptTuner.get_run_status()
            • PromptTuner.plot_learning_curve()
            • PromptTuner.run()
            • PromptTuner.summary()
        • Enums
          • PromptTuningTypes
            • PromptTuningTypes.PT
          • PromptTuningInitMethods
            • PromptTuningInitMethods.RANDOM
            • PromptTuningInitMethods.TEXT
          • TuneExperimentTasks
            • TuneExperimentTasks.CLASSIFICATION
            • TuneExperimentTasks.CODE_GENERATION_AND_CONVERSION
            • TuneExperimentTasks.EXTRACTION
            • TuneExperimentTasks.GENERATION
            • TuneExperimentTasks.QUESTION_ANSWERING
            • TuneExperimentTasks.RETRIEVAL_AUGMENTED_GENERATION
            • TuneExperimentTasks.SUMMARIZATION
          • PromptTunableModels
    • Prompt Template Manager
      • PromptTemplateManager
        • PromptTemplateManager.delete_prompt()
        • PromptTemplateManager.get_lock()
        • PromptTemplateManager.list()
        • PromptTemplateManager.load_prompt()
        • PromptTemplateManager.lock()
        • PromptTemplateManager.store_prompt()
        • PromptTemplateManager.unlock()
        • PromptTemplateManager.update_prompt()
      • PromptTemplate
      • FreeformPromptTemplate
      • DetachedPromptTemplate
      • Enums
        • PromptTemplateFormats
          • PromptTemplateFormats.LANGCHAIN
          • PromptTemplateFormats.PROMPTTEMPLATE
          • PromptTemplateFormats.STRING
    • Extensions
      • LangChain
        • Installation and Setup
        • Chat Model
        • LLMs
        • Embedding Models
        • API reference
      • LlamaIndex
        • Installation and Setup
        • LLMs
        • Embedding Models
        • API reference
      • RAG
        • Chunkers
          • LangChainChunker
            • LangChainChunker
              • LangChainChunker.from_dict()
              • LangChainChunker.split_documents()
              • LangChainChunker.supported_methods
              • LangChainChunker.to_dict()
          • BaseChunker
            • BaseChunker
              • BaseChunker.from_dict()
              • BaseChunker.split_documents()
              • BaseChunker.to_dict()
        • Retrievers
          • Retriever
            • Retriever.from_vector_store()
            • Retriever.retrieve()
            • Retriever.to_dict()
          • RetrievalMethod
            • RetrievalMethod.SIMPLE
            • RetrievalMethod.WINDOW
          • BaseRetriever
            • BaseRetriever.from_vector_store()
            • BaseRetriever.retrieve()
            • BaseRetriever.to_dict()
        • Vector Stores
          • VectorStore
            • VectorStore
              • VectorStore.add_documents()
              • VectorStore.add_documents_async()
              • VectorStore.as_langchain_retriever()
              • VectorStore.clear()
              • VectorStore.count()
              • VectorStore.delete()
              • VectorStore.from_dict()
              • VectorStore.get_client()
              • VectorStore.search()
              • VectorStore.set_embeddings()
              • VectorStore.to_dict()
              • VectorStore.window_search()
          • BaseVectorStore
            • BaseVectorStore
              • BaseVectorStore.add_documents()
              • BaseVectorStore.add_documents_async()
              • BaseVectorStore.as_langchain_retriever()
              • BaseVectorStore.clear()
              • BaseVectorStore.count()
              • BaseVectorStore.delete()
              • BaseVectorStore.get_client()
              • BaseVectorStore.search()
              • BaseVectorStore.set_embeddings()
              • BaseVectorStore.window_search()
          • VectorStoreConnector
            • VectorStoreConnector
              • VectorStoreConnector.get_chroma()
              • VectorStoreConnector.get_elasticsearch()
              • VectorStoreConnector.get_from_type()
              • VectorStoreConnector.get_langchain_adapter()
              • VectorStoreConnector.get_milvus()
              • VectorStoreConnector.get_type_from_langchain_vector_store()
          • VectorStoreDataSourceType
            • VectorStoreDataSourceType
              • VectorStoreDataSourceType.CHROMA
              • VectorStoreDataSourceType.ELASTICSEARCH
              • VectorStoreDataSourceType.MILVUS
              • VectorStoreDataSourceType.MILVUS_WXD
              • VectorStoreDataSourceType.UNDEFINED
          • LangChainVectorStoreAdapter
            • LangChainVectorStoreAdapter
              • LangChainVectorStoreAdapter.add_documents()
              • LangChainVectorStoreAdapter.add_documents_async()
              • LangChainVectorStoreAdapter.as_langchain_retriever()
              • LangChainVectorStoreAdapter.clear()
              • LangChainVectorStoreAdapter.count()
              • LangChainVectorStoreAdapter.delete()
              • LangChainVectorStoreAdapter.get_client()
              • LangChainVectorStoreAdapter.search()
              • LangChainVectorStoreAdapter.set_embeddings()
              • LangChainVectorStoreAdapter.window_search()
    • Helpers
      • FoundationModelsManager
        • FoundationModelsManager.get_chat_function_calling_model_specs()
        • FoundationModelsManager.get_chat_model_specs()
        • FoundationModelsManager.get_custom_model_specs()
        • FoundationModelsManager.get_embeddings_model_specs()
        • FoundationModelsManager.get_model_lifecycle()
        • FoundationModelsManager.get_model_specs()
        • FoundationModelsManager.get_model_specs_with_fine_tuning_support()
        • FoundationModelsManager.get_model_specs_with_prompt_tuning_support()
        • FoundationModelsManager.get_rerank_model_specs()
        • FoundationModelsManager.get_time_series_model_specs()
      • get_model_specs()
      • get_model_lifecycle()
      • get_model_specs_with_prompt_tuning_support()
      • get_supported_tasks()
    • Custom models
      • IBM watsonx.ai for IBM Cloud
        • Initialize an APIClient object
        • Add Task Credentials
        • Store the model in the service repository
        • Store the model
        • Deploy the custom foundation model
        • Work with deployments
      • IBM watsonx.ai software with IBM Cloud Pak® for Data
        • Initialize the APIClient object
        • List model specifications
        • Store the model in the service repository
        • Store the model
        • Define the hardware specification
        • Deploy the custom foundation model
        • Work with deployments
    • Text Extractions
      • TextExtractions
        • TextExtractions.cancel_job()
        • TextExtractions.delete_job()
        • TextExtractions.get_id()
        • TextExtractions.get_job_details()
        • TextExtractions.get_results_reference()
        • TextExtractions.list_jobs()
        • TextExtractions.run_job()
      • Enums
        • TextExtractionsMetaNames
    • Parameter Scheme
      • BaseSchema
        • BaseSchema.get_sample_params()
        • BaseSchema.show()
      • Chat Parameters
        • TextChatParameters
          • TextChatParameters.frequency_penalty
          • TextChatParameters.logprobs
          • TextChatParameters.max_tokens
          • TextChatParameters.n
          • TextChatParameters.presence_penalty
          • TextChatParameters.response_format
          • TextChatParameters.temperature
          • TextChatParameters.time_limit
          • TextChatParameters.top_logprobs
          • TextChatParameters.top_p
        • TextChatResponseFormat
          • TextChatResponseFormat.type
        • TextChatResponseFormatType
          • TextChatResponseFormatType.JSON_OBJECT
      • Generate Parameters
        • TextGenParameters
          • TextGenParameters.decoding_method
          • TextGenParameters.include_stop_sequence
          • TextGenParameters.length_penalty
          • TextGenParameters.max_new_tokens
          • TextGenParameters.min_new_tokens
          • TextGenParameters.prompt_variables
          • TextGenParameters.random_seed
          • TextGenParameters.repetition_penalty
          • TextGenParameters.return_options
          • TextGenParameters.stop_sequences
          • TextGenParameters.temperature
          • TextGenParameters.time_limit
          • TextGenParameters.top_k
          • TextGenParameters.top_p
          • TextGenParameters.truncate_input_tokens
        • ReturnOptionProperties
          • ReturnOptionProperties.generated_tokens
          • ReturnOptionProperties.input_text
          • ReturnOptionProperties.input_tokens
          • ReturnOptionProperties.token_logprobs
          • ReturnOptionProperties.token_ranks
          • ReturnOptionProperties.top_n_tokens
        • TextGenLengthPenalty
          • TextGenLengthPenalty.decay_factor
          • TextGenLengthPenalty.start_index
        • TextGenDecodingMethod
          • TextGenDecodingMethod.GREEDY
          • TextGenDecodingMethod.SAMPLE
      • Rerank Parameters
        • RerankParameters
          • RerankParameters.return_options
          • RerankParameters.truncate_input_tokens
        • RerankReturnOptions
          • RerankReturnOptions.inputs
          • RerankReturnOptions.query
          • RerankReturnOptions.top_n
      • TSModelInference Parameters
        • TSForecastParameters
          • TSForecastParameters.conditional_columns
          • TSForecastParameters.control_columns
          • TSForecastParameters.freq
          • TSForecastParameters.id_columns
          • TSForecastParameters.observable_columns
          • TSForecastParameters.prediction_length
          • TSForecastParameters.static_categorical_columns
          • TSForecastParameters.target_columns
          • TSForecastParameters.timestamp_column
    • Rerank
      • Rerank
        • Rerank.generate()
    • Deploy on Demand
      • IBM watsonx.ai for IBM Cloud
        • Initialize an APIClient object
        • Add Task Credentials
        • Store the model in the service repository
        • Store the model
        • Deploy the curated foundation model
        • Work with deployments
• Saving external models
  • Tensorflow / Keras
  • PMML
  • Scikit-learn
  • SPSS
  • Spark
  • XGBoost