aidp-typescript-client
v5.1.1
Published
TypeScript SDK for the AI Data Platform Data Plane APIs.
Readme
Oracle AI Data Platform
Oracle AI Data Platform simplifies cataloging, ingesting, and analyzing data for data professionals in an organization. The Oracle AI Data Platform service provides the platform and the framework to create data analytics pipelines.
Documentation
Oracle AI Data Platform documentation
Using SDK
The aidp-typescript-client SDK is the TypeScript and Node.js artifact for calling Oracle AI Data Platform public APIs from Node.js applications and automation.
Configure Auth
AIDP clients use OCI authentication. Configure an OCI profile before invoking the SDK.
Do not commit OCI configuration or private-key files. Store credentials in an approved secret-management solution. For CI/CD, prefer short-lived or federated authentication when available and grant only the permissions required for the operation.
oci setup configFor session-token authentication, authenticate with OCI CLI:
oci session authenticate \
--profile-name DEFAULT \
--region us-ashburn-1 \
--tenancy-name <tenancy_name>For API-key authentication, create an OCI config profile once if you do not already have one. OCI CLI can create the file for you if it is installed. Existing OCI config profiles can be reused.
Use the SDK
const client = new WorkspaceClient({ authenticationDetailsProvider: authProvider });
const response = await client.listWorkspaces({ aiDataPlatformId, limit: 10 });For more details, see Oracle AI Data Platform TypeScript SDK documentation.
