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
- Core
- Connections
ConnectionsConnections.ConfigurationMetaNamesConnections.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
- Deployments
DeploymentsDeployments.HardwareRequestSizesDeployments.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()
DeploymentMetaNamesRShinyAuthenticationValuesScoringMetaNamesDecisionOptimizationMetaNamesRuntimeContext
- Export/Import
- Factsheets (IBM Cloud only)
- Hardware specifications
- Helpers
- Model definitions
ModelDefinitionModelDefinition.ConfigurationMetaNamesModelDefinition.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
- Parameter Sets
- Repository
RepositoryRepository.ModelAssetTypesRepository.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()
ModelMetaNamesExperimentMetaNamesFunctionMetaNamesPipelineMetanamesAIServiceMetaNames
- Script
- Service instance
- Set
- Shiny (IBM Cloud Pak® for Data only)
- Software specifications
- Spaces
SpacesSpaces.ConfigurationMetaNamesSpaces.MemberMetaNamesSpaces.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()
SpacesMetaNamesSpacesMemberMetaNames
- Training
- Enums
ClassificationAlgorithmsClassificationAlgorithms.DTClassificationAlgorithms.EX_TREESClassificationAlgorithms.GBClassificationAlgorithms.LGBMClassificationAlgorithms.LRClassificationAlgorithms.RFClassificationAlgorithms.SnapBMClassificationAlgorithms.SnapDTClassificationAlgorithms.SnapLRClassificationAlgorithms.SnapRFClassificationAlgorithms.SnapSVMClassificationAlgorithms.XGB
ClassificationAlgorithmsCP4DClassificationAlgorithmsCP4D.DTClassificationAlgorithmsCP4D.EX_TREESClassificationAlgorithmsCP4D.GBClassificationAlgorithmsCP4D.LGBMClassificationAlgorithmsCP4D.LRClassificationAlgorithmsCP4D.RFClassificationAlgorithmsCP4D.SnapBMClassificationAlgorithmsCP4D.SnapDTClassificationAlgorithmsCP4D.SnapLRClassificationAlgorithmsCP4D.SnapRFClassificationAlgorithmsCP4D.SnapSVMClassificationAlgorithmsCP4D.XGB
DataConnectionTypesDirectionsDocumentsSamplingTypesForecastingAlgorithmsForecastingAlgorithmsCP4DForecastingPipelineTypesForecastingPipelineTypes.ARIMAForecastingPipelineTypes.ARIMAXForecastingPipelineTypes.ARIMAX_DMLRForecastingPipelineTypes.ARIMAX_PALRForecastingPipelineTypes.ARIMAX_RARForecastingPipelineTypes.ARIMAX_RSARForecastingPipelineTypes.BatsForecastingPipelineTypes.DifferenceFlattenEnsemblerForecastingPipelineTypes.ExogenousDifferenceFlattenEnsemblerForecastingPipelineTypes.ExogenousFlattenEnsemblerForecastingPipelineTypes.ExogenousLocalizedFlattenEnsemblerForecastingPipelineTypes.ExogenousMT2RForecasterForecastingPipelineTypes.ExogenousRandomForestRegressorForecastingPipelineTypes.ExogenousSVMForecastingPipelineTypes.FlattenEnsemblerForecastingPipelineTypes.HoltWinterAdditiveForecastingPipelineTypes.HoltWinterMultiplicativeForecastingPipelineTypes.LocalizedFlattenEnsemblerForecastingPipelineTypes.MT2RForecasterForecastingPipelineTypes.RandomForestRegressorForecastingPipelineTypes.SVMForecastingPipelineTypes.get_exogenous()ForecastingPipelineTypes.get_non_exogenous()
ImputationStrategyImputationStrategy.BEST_OF_DEFAULT_IMPUTERSImputationStrategy.CUBICImputationStrategy.FLATTEN_ITERATIVEImputationStrategy.LINEARImputationStrategy.MEANImputationStrategy.MEDIANImputationStrategy.MOST_FREQUENTImputationStrategy.NEXTImputationStrategy.NO_IMPUTATIONImputationStrategy.PREVIOUSImputationStrategy.VALUE
MetricsMetrics.ACCURACY_AND_DISPARATE_IMPACT_SCOREMetrics.ACCURACY_SCOREMetrics.AVERAGE_PRECISION_SCOREMetrics.EXPLAINED_VARIANCE_SCOREMetrics.F1_SCOREMetrics.F1_SCORE_MACROMetrics.F1_SCORE_MICROMetrics.F1_SCORE_WEIGHTEDMetrics.LOG_LOSSMetrics.MEAN_ABSOLUTE_ERRORMetrics.MEAN_SQUARED_ERRORMetrics.MEAN_SQUARED_LOG_ERRORMetrics.MEDIAN_ABSOLUTE_ERRORMetrics.PRECISION_SCOREMetrics.PRECISION_SCORE_MACROMetrics.PRECISION_SCORE_MICROMetrics.PRECISION_SCORE_WEIGHTEDMetrics.R2_AND_DISPARATE_IMPACT_SCOREMetrics.R2_SCOREMetrics.RECALL_SCOREMetrics.RECALL_SCORE_MACROMetrics.RECALL_SCORE_MICROMetrics.RECALL_SCORE_WEIGHTEDMetrics.ROC_AUC_SCOREMetrics.ROOT_MEAN_SQUARED_ERRORMetrics.ROOT_MEAN_SQUARED_LOG_ERROR
MetricsToDirectionsMetricsToDirections.ACCURACYMetricsToDirections.AVERAGE_PRECISIONMetricsToDirections.EXPLAINED_VARIANCEMetricsToDirections.F1MetricsToDirections.F1_MACROMetricsToDirections.F1_MICROMetricsToDirections.F1_WEIGHTEDMetricsToDirections.NEG_LOG_LOSSMetricsToDirections.NEG_MEAN_ABSOLUTE_ERRORMetricsToDirections.NEG_MEAN_SQUARED_ERRORMetricsToDirections.NEG_MEAN_SQUARED_LOG_ERRORMetricsToDirections.NEG_MEDIAN_ABSOLUTE_ERRORMetricsToDirections.NEG_ROOT_MEAN_SQUARED_ERRORMetricsToDirections.NEG_ROOT_MEAN_SQUARED_LOG_ERRORMetricsToDirections.NORMALIZED_GINI_COEFFICIENTMetricsToDirections.PRECISIONMetricsToDirections.PRECISION_MACROMetricsToDirections.PRECISION_MICROMetricsToDirections.PRECISION_WEIGHTEDMetricsToDirections.R2MetricsToDirections.RECALLMetricsToDirections.RECALL_MACROMetricsToDirections.RECALL_MICROMetricsToDirections.RECALL_WEIGHTEDMetricsToDirections.ROC_AUC
PipelineTypesPositiveLabelClassPositiveLabelClass.AVERAGE_PRECISION_SCOREPositiveLabelClass.F1_SCOREPositiveLabelClass.F1_SCORE_MACROPositiveLabelClass.F1_SCORE_MICROPositiveLabelClass.F1_SCORE_WEIGHTEDPositiveLabelClass.PRECISION_SCOREPositiveLabelClass.PRECISION_SCORE_MACROPositiveLabelClass.PRECISION_SCORE_MICROPositiveLabelClass.PRECISION_SCORE_WEIGHTEDPositiveLabelClass.RECALL_SCOREPositiveLabelClass.RECALL_SCORE_MACROPositiveLabelClass.RECALL_SCORE_MICROPositiveLabelClass.RECALL_SCORE_WEIGHTED
PredictionTypeRAGMetricsRegressionAlgorithmsRegressionAlgorithmsCP4DRegressionAlgorithmsCP4D.DTRegressionAlgorithmsCP4D.EX_TREESRegressionAlgorithmsCP4D.GBRegressionAlgorithmsCP4D.LGBMRegressionAlgorithmsCP4D.LRRegressionAlgorithmsCP4D.RFRegressionAlgorithmsCP4D.RIDGERegressionAlgorithmsCP4D.SnapBMRegressionAlgorithmsCP4D.SnapDTRegressionAlgorithmsCP4D.SnapRFRegressionAlgorithmsCP4D.XGB
RunStateTypesSamplingTypesTShirtSizeTimeseriesAnomalyPredictionAlgorithmsTimeseriesAnomalyPredictionPipelineTypesTimeseriesAnomalyPredictionPipelineTypes.PointwiseBoundedBATSTimeseriesAnomalyPredictionPipelineTypes.PointwiseBoundedBATSForceUpdateTimeseriesAnomalyPredictionPipelineTypes.PointwiseBoundedHoltWintersAdditiveTimeseriesAnomalyPredictionPipelineTypes.WindowLOFTimeseriesAnomalyPredictionPipelineTypes.WindowNNTimeseriesAnomalyPredictionPipelineTypes.WindowPCA
TransformersTransformers.ABSTransformers.CBRTTransformers.COSTransformers.CUBETransformers.DIFFTransformers.DIVIDETransformers.FEATUREAGGLOMERATIONTransformers.ISOFORESTANOMALYTransformers.LOGTransformers.MAXTransformers.MINMAXSCALERTransformers.NXORTransformers.PCATransformers.PRODUCTTransformers.ROUNDTransformers.SIGMOIDTransformers.SINTransformers.SQRTTransformers.SQUARETransformers.STDSCALERTransformers.SUMTransformers.TAN
VisualizationTypes
- Connections
- Federated Learning
- Aggregation
- Local training
- Configure and start local training
RemoteTrainingSystemRemoteTrainingSystem.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
- Configure and start local training
- Data Connections
- Working with DataConnection
- DataConnection Modules
- IterableDatasets Modules
- 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
- AutoAI experiment
- AutoAI
AutoAIAutoAI.ClassificationAlgorithmsAutoAI.ClassificationAlgorithms.DTAutoAI.ClassificationAlgorithms.EX_TREESAutoAI.ClassificationAlgorithms.GBAutoAI.ClassificationAlgorithms.LGBMAutoAI.ClassificationAlgorithms.LRAutoAI.ClassificationAlgorithms.RFAutoAI.ClassificationAlgorithms.SnapBMAutoAI.ClassificationAlgorithms.SnapDTAutoAI.ClassificationAlgorithms.SnapLRAutoAI.ClassificationAlgorithms.SnapRFAutoAI.ClassificationAlgorithms.SnapSVMAutoAI.ClassificationAlgorithms.XGB
AutoAI.DataConnectionTypesAutoAI.ForecastingAlgorithmsAutoAI.MetricsAutoAI.Metrics.ACCURACY_AND_DISPARATE_IMPACT_SCOREAutoAI.Metrics.ACCURACY_SCOREAutoAI.Metrics.AVERAGE_PRECISION_SCOREAutoAI.Metrics.EXPLAINED_VARIANCE_SCOREAutoAI.Metrics.F1_SCOREAutoAI.Metrics.F1_SCORE_MACROAutoAI.Metrics.F1_SCORE_MICROAutoAI.Metrics.F1_SCORE_WEIGHTEDAutoAI.Metrics.LOG_LOSSAutoAI.Metrics.MEAN_ABSOLUTE_ERRORAutoAI.Metrics.MEAN_SQUARED_ERRORAutoAI.Metrics.MEAN_SQUARED_LOG_ERRORAutoAI.Metrics.MEDIAN_ABSOLUTE_ERRORAutoAI.Metrics.PRECISION_SCOREAutoAI.Metrics.PRECISION_SCORE_MACROAutoAI.Metrics.PRECISION_SCORE_MICROAutoAI.Metrics.PRECISION_SCORE_WEIGHTEDAutoAI.Metrics.R2_AND_DISPARATE_IMPACT_SCOREAutoAI.Metrics.R2_SCOREAutoAI.Metrics.RECALL_SCOREAutoAI.Metrics.RECALL_SCORE_MACROAutoAI.Metrics.RECALL_SCORE_MICROAutoAI.Metrics.RECALL_SCORE_WEIGHTEDAutoAI.Metrics.ROC_AUC_SCOREAutoAI.Metrics.ROOT_MEAN_SQUARED_ERRORAutoAI.Metrics.ROOT_MEAN_SQUARED_LOG_ERROR
AutoAI.PipelineTypesAutoAI.PredictionTypeAutoAI.RAGMetricsAutoAI.RegressionAlgorithmsAutoAI.RegressionAlgorithms.DTAutoAI.RegressionAlgorithms.EX_TREESAutoAI.RegressionAlgorithms.GBAutoAI.RegressionAlgorithms.LGBMAutoAI.RegressionAlgorithms.LRAutoAI.RegressionAlgorithms.RFAutoAI.RegressionAlgorithms.RIDGEAutoAI.RegressionAlgorithms.SnapBMAutoAI.RegressionAlgorithms.SnapDTAutoAI.RegressionAlgorithms.SnapRFAutoAI.RegressionAlgorithms.XGB
AutoAI.SamplingTypesAutoAI.TShirtSizeAutoAI.TransformersAutoAI.Transformers.ABSAutoAI.Transformers.CBRTAutoAI.Transformers.COSAutoAI.Transformers.CUBEAutoAI.Transformers.DIFFAutoAI.Transformers.DIVIDEAutoAI.Transformers.FEATUREAGGLOMERATIONAutoAI.Transformers.ISOFORESTANOMALYAutoAI.Transformers.LOGAutoAI.Transformers.MAXAutoAI.Transformers.MINMAXSCALERAutoAI.Transformers.NXORAutoAI.Transformers.PCAAutoAI.Transformers.PRODUCTAutoAI.Transformers.ROUNDAutoAI.Transformers.SIGMOIDAutoAI.Transformers.SINAutoAI.Transformers.SQRTAutoAI.Transformers.SQUAREAutoAI.Transformers.STDSCALERAutoAI.Transformers.SUMAutoAI.Transformers.TAN
AutoAI.optimizer()AutoAI.rag_optimizer()AutoAI.runs()
- AutoAI
- Deployment Modules for AutoAI models
- Working with AutoAI class and optimizer
- Foundation Models
- Modules
- Embeddings
- Models
- Modules
- ModelInference
ModelInferenceModelInference.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
- Model
ModelInferencefor Deployments
- ModelInference
- Modules
- Tuning
- Prompt Template Manager
- Extensions
- LangChain
- LlamaIndex
- RAG
- Chunkers
- Retrievers
- Vector Stores
- VectorStore
VectorStoreVectorStore.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
BaseVectorStoreBaseVectorStore.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
- VectorStoreDataSourceType
- LangChainVectorStoreAdapter
LangChainVectorStoreAdapterLangChainVectorStoreAdapter.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()
- VectorStore
- Helpers
FoundationModelsManagerFoundationModelsManager.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()
get_model_specs()get_model_lifecycle()get_model_specs_with_prompt_tuning_support()get_supported_tasks()
- Custom models
- Text Extractions
- Parameter Scheme
BaseSchema- Chat Parameters
TextChatParametersTextChatParameters.frequency_penaltyTextChatParameters.logprobsTextChatParameters.max_tokensTextChatParameters.nTextChatParameters.presence_penaltyTextChatParameters.response_formatTextChatParameters.temperatureTextChatParameters.time_limitTextChatParameters.top_logprobsTextChatParameters.top_p
TextChatResponseFormatTextChatResponseFormatType
- Generate Parameters
TextGenParametersTextGenParameters.decoding_methodTextGenParameters.include_stop_sequenceTextGenParameters.length_penaltyTextGenParameters.max_new_tokensTextGenParameters.min_new_tokensTextGenParameters.prompt_variablesTextGenParameters.random_seedTextGenParameters.repetition_penaltyTextGenParameters.return_optionsTextGenParameters.stop_sequencesTextGenParameters.temperatureTextGenParameters.time_limitTextGenParameters.top_kTextGenParameters.top_pTextGenParameters.truncate_input_tokens
ReturnOptionPropertiesTextGenLengthPenaltyTextGenDecodingMethod
- Rerank Parameters
- Rerank
- Modules
- Saving external models