watsonx.governance v2 API

Introduction IBM watsonx.governance is an enterprise-grade environment for AI infused applications that provides enterprises with visibility into how AI is being built, used, and delivering ROI – at the scale of their business. For details about using IBM watsonx.governance, see the docshttps://dataplatform.cloud.ibm.com/docs/content/wsj/model/getting-started.html. Authentication You authenticate to the API by using IAM. You can pass either a bearer token in an Authorization header or an apikey. Tokens support authenticated requests without embedding service credentials in every call. API keys use basic authentication. Learn more about IAMhttps://console.bluemix.net/docs/services/watson/getting-started-iam.html. IAM authentication. Replace {token} with the bearer token returned by the IAM authentication service. bash curl -X GET --header "Authorization: Bearer {Token}" "https://api.aiopenscale.cloud.ibm.com/

MethodPathSummary
POST/v2/data_martsCreate a new data mart
GET/v2/data_martsList all data marts
GET/v2/data_marts/{data_mart_id}Get data mart with the given id
PATCH/v2/data_marts/{data_mart_id}Update a data mart
DELETE/v2/data_marts/{data_mart_id}Delete a data mart
GET/v2/service_providersList service providers
POST/v2/service_providersAdd service provider
GET/v2/service_providers/{service_provider_id}Get a specific service provider
DELETE/v2/service_providers/{service_provider_id}Delete a service provider
PATCH/v2/service_providers/{service_provider_id}Update a service provider
GET/v2/subscriptionsList subscriptions
POST/v2/subscriptionsAdd a new subscription
GET/v2/subscriptions/{subscription_id}Get a specific subscription
PATCH/v2/subscriptions/{subscription_id}Update a subscription
DELETE/v2/subscriptions/{subscription_id}Delete a subscription
POST/v2/subscriptions/{subscription_id}/schemasDerive model schemas from the training data.
POST/v2/subscriptions/{subscription_id}/tables/{dataset_type}Create a table for specified data set type
GET/v2/subscriptions/{subscription_id}/configuration_synchronizationgetConfigurationSynchrozation
PUT/v2/subscriptions/{subscription_id}/configuration_synchronizationTrigger configuration synchronization from pre-production to production model
POST/v2/subscriptions/{subscription_id}/predictionsComputes the bias mitigation/remediation for the specified model
GET/v2/data_setsList all data sets specified by the parameters
POST/v2/data_setsCreate a new data set
GET/v2/data_sets/{data_set_id}Get data set with the given id
DELETE/v2/data_sets/{data_set_id}Delete a data set
PATCH/v2/data_sets/{data_set_id}Update a data set
POST/v2/data_sets/{data_set_id}/recordsAdd new data set records
GET/v2/data_sets/{data_set_id}/recordsList data set records
PATCH/v2/data_sets/{data_set_id}/recordsUpdate data set records
GET/v2/data_sets/{data_set_id}/records/{record_id}Get a specific data set record with the given id
PATCH/v2/data_sets/{data_set_id}/records/{record_id}Update a specific record in a data set
GET/v2/data_sets/{data_set_id}/records/{record_id}/{field_name}Get value of a field in a given record
GET/v2/data_set_recordsGet data set records using record_id or transaction_id
GET/v2/data_sets/{data_set_id}/requests/{request_id}Get status of a specific request
POST/v2/data_sets/{data_set_id}/distributionsadd new data distributions
DELETE/v2/data_sets/{data_set_id}/distributionsDelete data distributions
GET/v2/data_sets/{data_set_id}/distributions/{data_distribution_id}Get a specific data distribution
GET/v2/monitor_definitionsList available monitors
POST/v2/monitor_definitionsAdd custom monitor
GET/v2/monitor_definitions/{monitor_definition_id}Get a specific monitor definition
PUT/v2/monitor_definitions/{monitor_definition_id}Update the monitor definition
PATCH/v2/monitor_definitions/{monitor_definition_id}Update a monitor definition
DELETE/v2/monitor_definitions/{monitor_definition_id}Delete a monitor definition
GET/v2/monitor_instancesList monitor instances
POST/v2/monitor_instancesCreate a new monitor instance
GET/v2/monitor_instances/{monitor_instance_id}Get monitor instance details
PATCH/v2/monitor_instances/{monitor_instance_id}Update a monitor instance
DELETE/v2/monitor_instances/{monitor_instance_id}Delete a monitor instance
POST/v2/monitor_instances/{monitor_instance_id}/runsTrigger monitoring run
GET/v2/monitor_instances/{monitor_instance_id}/runsList monitoring runs
GET/v2/monitor_instances/{monitor_instance_id}/runs/{monitoring_run_id}Get monitoring run details
PATCH/v2/monitor_instances/{monitor_instance_id}/runs/{monitoring_run_id}Update existing monitoring run details
POST/v2/monitor_instances/{monitor_instance_id}/measurementsPublish measurement data to OpenScale
GET/v2/monitor_instances/{monitor_instance_id}/measurementsQuery measurements from OpenScale DataMart.
GET/v2/monitor_instances/{monitor_instance_id}/measurements/{measurement_id}Get measurement data from OpenScale DataMart.
GET/v2/measurementsQuery for the recent measurement
GET/v2/monitor_instances/{monitor_instance_id}/metricsQuery monitor instance metrics from OpenScale DataMart.
GET/v2/integrated_systemsList integrated systems
POST/v2/integrated_systemsCreate a new integrated system
GET/v2/integrated_systems/{integrated_system_id}Get a specific integrated system
PATCH/v2/integrated_systems/{integrated_system_id}Update an integrated system
DELETE/v2/integrated_systems/{integrated_system_id}Delete an integrated system
GET/v2/operational_spacesList Operational Spaces
POST/v2/operational_spacesCreate an operational space
GET/v2/operational_spaces/{operational_space_id}Get an operational space
PATCH/v2/operational_spaces/{operational_space_id}Update an operational space
DELETE/v2/operational_spaces/{operational_space_id}Delete an operational space
GET/v2/user_preferencesGet User Preferences
PATCH/v2/user_preferencesUpdate User Preferences
GET/v2/user_preferences/{user_preference_key}Get a specific user preference
PUT/v2/user_preferences/{user_preference_key}Update the user preference
DELETE/v2/user_preferences/{user_preference_key}Delete the user preference
POST/v2/explanation_tasksCompute explanations
GET/v2/explanation_tasksList all explanations
GET/v2/explanation_tasks/{explanation_task_id}Get explanation
PUT/v2/monitoring_services/drift_v2/archivesUpload drift_v2 archive for a given subscription
GET/v2/monitoring_services/drift_v2/archivesGet drift v2 archive for a given subscription
HEAD/v2/monitoring_services/drift_v2/archivesGet drift archive metadata for a given subscription
POST/v2/monitoring_services/drift/data_marts/{data_mart_id}/subscriptions/{subscription_id}/archivesUpload Drift archives.
GET/v2/monitoring_services/drift/monitor_instances/{monitor_instance_id}/archivesRetrieves the Drift archives.
HEAD/v2/monitoring_services/drift/monitor_instances/{monitor_instance_id}/archivesRetrieves the Drift archive metadata.
PUT/v2/monitoring_services/explainability/archivesUpload explainability configuration archive.
POST/v2/monitoring_services/explainability/archivesUpload explainability configuration archive.
GET/v2/monitoring_services/explainability/archivesDownload the Explainability configuration archive.
POST/v2/spark_schemasParse a given file and extract the schema in Spark StructType format.
POST/v2/monitoring_services/mrm/monitor_instances/{monitor_instance_id}/risk_evaluationsUploads the test data and triggers a monitor run for risk evaluation.
PUT/v2/monitoring_services/mrm/monitor_instances/{monitor_instance_id}/risk_evaluationsCancels the risk evaluations run.
GET/v2/monitoring_services/mrm/monitor_instances/{monitor_instance_id}/risk_evaluationsReturns the status of the risk evaluation.
PUT/v2/monitoring_services/mrm/monitor_instances/{monitor_instance_id}/runs/{monitoring_run_id}/integrated_system_metricsPublishes the chosen metrics to the integrated system reference.
GET/v2/monitoring_services/mrm/monitor_instances/{monitor_instance_id}/runs/{monitoring_run_id}/risk_evaluation_reportReturns the risk evaluation report in a PDF format.
GET/v2/subscriptions/risk_evaluation_statusReturns the risk evaluation status of all subscriptions in a given service instance.
PUT/v2/subscriptions/{subscription_id}/risk_evaluation_statusUpdates the risk evaluation status for the given subscription.
GET/v2/subscriptions/{subscription_id}/risk_evaluation_statusGets risk evaluation status for the given subscription.
POST/v2/prompt_setupPerforms the setup activities in Openscale for a given prompt template asset.
GET/v2/prompt_setupGets the status of the prompt setup for the given prompt template asset.
PUT/v2/monitoring_services/mrm/monitor_instances/{monitor_instance_id}/risk_notificationsSets the users email notification preference in the MRM monitor instance of a given model subscription.
GET/v2/monitoring_services/mrm/monitor_instances/{monitor_instance_id}/risk_notificationsGets the users email notification preferences for a given model subscription.
POST/ml/v1/text/detectionRuns detections on a given input text.
POST/ml/v1/text/detection/contextDetection task on input content based on context documents.
POST/ml/v1/text/detection/generatedDetection task performing detection on prompt and generated text.
POST/ml/v1/text/detection/chatDetection task performing function calling hallucination detection.
GET/guardrails_manager/v2/detectorsGet all detectors
POST/guardrails_manager/v2/detectorsCreate a detector
GET/guardrails_manager/v2/detectors/{id}Get a detector by ID
DELETE/guardrails_manager/v2/detectors/{id}Delete a detector
POST/guardrails_manager/v2/enforce/{id}Enforce a policy
GET/guardrails_manager/v2/policiesGet all policies
POST/guardrails_manager/v2/policiesCreate a policy
GET/guardrails_manager/v2/policies/{id}Get a policy by ID
PUT/guardrails_manager/v2/policies/{id}Update a policy
DELETE/guardrails_manager/v2/policies/{id}Delete a policy
GET/guardrails_manager/v2/policies/{id}/historyGet policy history