Working with Python Data Studio API for Autonomous Database

Python Data Studio API package works both in OML notebook and as a standalone application.

You can view the REST API endpoints hosted on Oracle Autonomous Database. These endpoints allow you to store Machine Learning models along with their metadata, and create scoring endpoints for the model.

Installing the Python Data Studio API

Install the base package from PyPI:

pip install oracle-data-studio

The base install includes the Autonomous Database (adp), Essbase (essbase), and Data Transforms (datatransforms) clients. Optional features are installed as extras:

pip install "oracle-data-studio[mcp]"               # MCP server
pip install "oracle-data-studio[agents]"            # A2A agent runtime
pip install "oracle-data-studio[agents,openai]"     # agents + OpenAI model adapter
pip install "oracle-data-studio[agents,anthropic]"  # agents + Anthropic model adapter
pip install "oracle-data-studio[oracle]"            # Oracle-DB-backed durable agent store
pip install "oracle-data-studio[redis]"             # Redis-backed durable agent store

Connecting to Autonomous Database

To connect to the Autonomous Database via your username and password, run the following command:
import adp 
adp_instance = adp.login('<url>', '<username>', '<password>')
Here are the parameters and their descriptions:

url: This specifies the Database Actions host. For example, https://abcdefg.oraclecloudapps.com.

username:This specifies the schema name.

password:This specifies the password to the schema.

Connecting inside OML Notebooks

Login inside OML notebooks by entering the following command:
import adp
adp_instance = adp.connect()

The return value of the login method is an instance of class that contains all Autonomous Data Platform (ADP) functions.

The Adp class instance consists of the following inner classes:
  • Ingest
  • Analytics
  • Insight
  • Miscellaneous
  • Data Share

Refer to the following functions in the subsequent chapter.

Topics:

  • Ingest Functions
    The Adp.Ingest class is used for loading data from different sources into tables and views.
  • Analytic View Functions
    The class Adp.Analytics provides the syntax and descriptions of the classes, methods, attributes, and parameters of the application programming interface to Analytic Views tool of Data Studio Suite of tools. If the requested analytic view does not exists (except create), all functions return message Analytic view does not exist.
  • Insight Functions
    Insight functions provide the syntax and descriptions of the classes, methods, attributes, and parameters of the application programming interface to the Insight tool in Data Studio suite of tools. Generation of insight is performed in background and requires checking for the completion.
  • Miscellaneous functions
    Miscellaneous functions provide the syntax and descriptions of the classes, methods, attributes, and parameters of the application programming interface.
  • Data Share Functions
    The Python Data Studio Application Programming Interface (API) for Data Share functions provides the syntax and descriptions of the classes, methods, attributes, and parameters of the application programming interface to the Data Share tool of Data Studio suite of tools.
  • Catalog Functions
    The Oracle Data Studio Catalog or Catalog is a multi-catalog tool that provides a way to search for data and other objects in your currently connected Autonomous Database, and also in a wide range of other connected systems.

Parent topic: Python Data Studio API for Oracle Autonomous Database