aidp-typescript-client 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +36 -0
- package/npm-shrinkwrap.json +3 -3
- package/package.json +14 -2
package/README.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Oracle AI Data Platform
|
|
2
|
+
Oracle AI Data Platform Workbench simplifies cataloging, ingesting, and analyzing data for data professionals in an organization.
|
|
3
|
+
The Oracle AI Data Platform Workbench service provides the platform and the framework to create data analytics pipelines.
|
|
4
|
+
|
|
5
|
+
## Documentation
|
|
6
|
+
[Oracle AI Data Platform Workbench documentation](https://docs.oracle.com/en/cloud/paas/ai-data-platform/)
|
|
7
|
+
|
|
8
|
+
## Using SDK
|
|
9
|
+
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.
|
|
10
|
+
|
|
11
|
+
### Configure Auth
|
|
12
|
+
AIDP clients use OCI authentication. Configure an OCI profile before invoking the SDK.
|
|
13
|
+
|
|
14
|
+
~~~
|
|
15
|
+
oci setup config
|
|
16
|
+
~~~
|
|
17
|
+
|
|
18
|
+
For session-token authentication, authenticate with OCI CLI:
|
|
19
|
+
|
|
20
|
+
~~~
|
|
21
|
+
oci session authenticate \
|
|
22
|
+
--profile-name DEFAULT \
|
|
23
|
+
--region us-ashburn-1 \
|
|
24
|
+
--tenancy-name <tenancy_name>
|
|
25
|
+
~~~
|
|
26
|
+
|
|
27
|
+
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.
|
|
28
|
+
|
|
29
|
+
### Use the SDK
|
|
30
|
+
|
|
31
|
+
```ts
|
|
32
|
+
const client = new WorkspaceClient({ authenticationDetailsProvider: authProvider });
|
|
33
|
+
const response = await client.listWorkspaces({ aiDataPlatformId, limit: 10 });
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
For more details, see [Oracle AI Data Platform TypeScript SDK documentation](https://github.com/oracle-samples/aidataplatform-sdk/blob/main/docs/typescript-sdk/README.md).
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "aidp-typescript-client",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "aidp-typescript-client",
|
|
9
|
-
"version": "1.0.
|
|
10
|
-
"license": "
|
|
9
|
+
"version": "1.0.2",
|
|
10
|
+
"license": "UPL-1.0",
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"oci-common": "2.126.3"
|
|
13
13
|
},
|
package/package.json
CHANGED
|
@@ -1,7 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "aidp-typescript-client",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "TypeScript SDK for the AI Data Platform Data Plane APIs.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"oracle",
|
|
7
|
+
"aidp",
|
|
8
|
+
"ai-data-platform",
|
|
9
|
+
"typescript-sdk"
|
|
10
|
+
],
|
|
5
11
|
"main": "./dist/index.js",
|
|
6
12
|
"types": "./dist/index.d.ts",
|
|
7
13
|
"typings": "./dist/index.d.ts",
|
|
@@ -15,6 +21,7 @@
|
|
|
15
21
|
"./package.json": "./package.json"
|
|
16
22
|
},
|
|
17
23
|
"files": [
|
|
24
|
+
"README.md",
|
|
18
25
|
"index.ts",
|
|
19
26
|
"npm-shrinkwrap.json",
|
|
20
27
|
"lib/**/*",
|
|
@@ -25,11 +32,16 @@
|
|
|
25
32
|
"scripts": {
|
|
26
33
|
"build": "./node_modules/typescript/bin/tsc -p tsconfig.json"
|
|
27
34
|
},
|
|
35
|
+
"repository": {
|
|
36
|
+
"type": "git",
|
|
37
|
+
"url": "git+https://github.com/oracle-samples/aidataplatform-sdk.git",
|
|
38
|
+
"directory": "aidp-typescript-client"
|
|
39
|
+
},
|
|
28
40
|
"author": {
|
|
29
41
|
"name": "Oracle Cloud Infrastructure",
|
|
30
42
|
"email": ""
|
|
31
43
|
},
|
|
32
|
-
"license": "
|
|
44
|
+
"license": "UPL-1.0",
|
|
33
45
|
"dependencies": {
|
|
34
46
|
"oci-common": "2.126.3"
|
|
35
47
|
},
|