Skip to content

Commit 58d9da5

Browse files
feat: add enable_dashboard_access in aiplatform v1 and v1beta1 (#460)
* feat: add NVIDIA_A100_80GB to AcceleratorType in aiplatform v1beta1 accelerator_type.proto feat: add annotation_labels to ImportDataConfig in aiplatform v1beta1 dataset.proto feat: add total_deployed_model_count and total_endpoint_count to QueryDeployedModelsResponse in aiplatform v1beta1 deployment_resource_pool_service.proto feat: add start_time to BatchReadFeatureValuesRequest in aiplatform v1beta1 featurestore_service.proto feat: add metadata_artifact to Model in aiplatform v1beta1 model.proto feat: add failed_main_jobs and failed_pre_caching_check_jobs to ContainerDetail in aiplatform v1beta1 pipeline_job.proto feat: add persist_ml_use_assignment to InputDataConfig in aiplatform v1beta1 training_pipeline.proto PiperOrigin-RevId: 485963130 Source-Link: googleapis/googleapis@af14709 Source-Link: googleapis/googleapis-gen@3d9d484 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiM2Q5ZDQ4NGEwMTA0ZTBjY2M0MzY3NzY5Yjc5MzA1YzJjYjZmYzNkOCJ9 * feat: add annotation_labels to ImportDataConfig in aiplatform v1 dataset.proto feat: add start_time to BatchReadFeatureValuesRequest in aiplatform v1 featurestore_service.proto feat: add metadata_artifact to Model in aiplatform v1 model.proto feat: add failed_main_jobs and failed_pre_caching_check_jobs to ContainerDetail in aiplatform v1 pipeline_job.proto feat: add persist_ml_use_assignment to InputDataConfig in aiplatform v1 training_pipeline.proto PiperOrigin-RevId: 485963171 Source-Link: googleapis/googleapis@9691f51 Source-Link: googleapis/googleapis-gen@8571031 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiODU3MTAzMTZmMzI5ZGZjNzNmMjQ0NjEwZWIwMTk5MjRlNDU4MGE1NiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add instance_config to batch_prediction_job in aiplatform v1beta1 batch_prediction_job.proto PiperOrigin-RevId: 487284583 Source-Link: googleapis/googleapis@17fb30e Source-Link: googleapis/googleapis-gen@464638f Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNDY0NjM4ZmIxNDNmZGI2NzI0MjdkZjNiOTkyZmZkNjBjODBmMzJmMiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add service_account to batch_prediction_job in aiplatform v1 batch_prediction_job.proto PiperOrigin-RevId: 488416174 Source-Link: googleapis/googleapis@b4dea4a Source-Link: googleapis/googleapis-gen@6a98691 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNmE5ODY5MTA4NTM1OTU2ZjRjMTY2Njc1MDUzMmNjNTc4ZDM4NDRkYiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add metadata_artifact to Dataset in aiplatform v1 dataset.proto feat: add WriteFeatureValues rpc to FeaturestoreOnlineServingService in aiplatform v1 featurestore_online_service.proto PiperOrigin-RevId: 491933995 Source-Link: googleapis/googleapis@693430f Source-Link: googleapis/googleapis-gen@0bf52e5 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMGJmNTJlNTE3MmQ4ODFkNWY3MTM5MjE4YTM3M2EzOGVjN2RkNTFhMCJ9 * feat: add metadata_artifact to Dataset in aiplatform v1beta1 dataset.proto feat: add offline_storage_ttl_days to EntityType in aiplatform v1beta1 entity_type.proto feat: add online_storage_ttl_days to Featurestore in aiplatform v1beta1 featurestore.proto feat: add source_uris to ImportFeatureValuesOperationMetadata in aiplatform v1beta1 featurestore_service.proto PiperOrigin-RevId: 491934619 Source-Link: googleapis/googleapis@572774c Source-Link: googleapis/googleapis-gen@129d372 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMTI5ZDM3MjQ0YWRlZTE1ZWYxMzYwOWE0MmE2NGUzN2ZjODAwNWNjZCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add SearchDataItems RPC in aiplatform version v1 and v1beta1 dataset_service.proto PiperOrigin-RevId: 493139921 Source-Link: googleapis/googleapis@268ee4d Source-Link: googleapis/googleapis-gen@f4b4248 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZjRiNDI0ODMxMzU0YzViNTZhMmE0YjFmZWZkMGY2YjRkNmM2NDYwZSJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add service_account to UploadModelRequest in aiplatform v1 model_service.proto PiperOrigin-RevId: 493943349 Source-Link: googleapis/googleapis@9df3838 Source-Link: googleapis/googleapis-gen@7345a78 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNzM0NWE3OGFkMzNiNDQ5ZjQ1ZDdkNjc2ZmYwYWY5MzQxMWNlYWU5NCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add service_account to UploadModelRequest in aiplatform v1beta1 model_service.proto PiperOrigin-RevId: 493951002 Source-Link: googleapis/googleapis@aee01fa Source-Link: googleapis/googleapis-gen@d731f74 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZDczMWY3NDM0MDliYTIxMjYxNDQyMjI0ZWVjODE3YjIyYzBlYzkyMiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add saved_queries to Dataset in aiplatform v1beta1 dataset.proto feat: add order_by to ListModelVersionRequest in aiplatform v1beta1 model_service.proto feat: add update_all_stopped_trials to ConvexAutomatedStoppingSpec in aiplatform v1beta1 study.proto feat: add ReadTensorboardUsage rpc in aiplatform v1beta1 tensorboard_service.proto PiperOrigin-RevId: 500741013 Source-Link: googleapis/googleapis@e8675f0 Source-Link: googleapis/googleapis-gen@0c99ee7 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMGM5OWVlNzNiZTM3NzExOGQwZGU1ZmYxNjIxNjM2ZDlmMmVhNDZhMSJ9 * feat: add saved_queries to Dataset in aiplatform v1 dataset.proto feat: add order_by to ListModelVersionRequest in aiplatform v1 model_service.proto feat: add update_all_stopped_trials to ConvexAutomatedStoppingSpec in aiplatform v1 study.proto feat: add ReadTensorboardUsage rpc in aiplatform v1 tensorboard_service.proto PiperOrigin-RevId: 500741387 Source-Link: googleapis/googleapis@2293b99 Source-Link: googleapis/googleapis-gen@21abc86 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMjFhYmM4NmEyZmE0ZmZiYzJkOTY5ZjQ4ZWE3ZmMwN2Y2ZDhkMDNkMCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add instance_config to BatchPredictionJob in aiplatform v1 batch_prediction_job.proto PiperOrigin-RevId: 500777760 Source-Link: googleapis/googleapis@517c248 Source-Link: googleapis/googleapis-gen@b722d01 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYjcyMmQwMTU4MWE3ZGM0Yzc4MDUwNjI2OWYxMTMzNGVjNDUwYjFlZCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add enable_dashboard_access in aiplatform v1 and v1beta1 custom_job.proto PiperOrigin-RevId: 502722710 Source-Link: googleapis/googleapis@6d9a0f3 Source-Link: googleapis/googleapis-gen@845ecc6 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiODQ1ZWNjNjA0N2FkZmQxNmRlZTk1NmI4NWNhYjdkYmQ1NjlmODM1MiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * add quickstart * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Sofia Leon <[email protected]>
1 parent 617822a commit 58d9da5

File tree

614 files changed

+71715
-6294
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

614 files changed

+71715
-6294
lines changed

packages/google-cloud-aiplatform/.jsdoc.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2022 Google LLC
1+
// Copyright 2023 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -40,7 +40,7 @@ module.exports = {
4040
includePattern: '\\.js$'
4141
},
4242
templates: {
43-
copyright: 'Copyright 2022 Google LLC',
43+
copyright: 'Copyright 2023 Google LLC',
4444
includeDate: false,
4545
sourceFiles: false,
4646
systemName: '@google-cloud/aiplatform',

packages/google-cloud-aiplatform/README.md

+51-2
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
3434
* [Quickstart](#quickstart)
3535
* [Before you begin](#before-you-begin)
3636
* [Installing the client library](#installing-the-client-library)
37-
38-
37+
* [Using the client library](#using-the-client-library)
38+
* [Samples](#samples)
3939
* [Versioning](#versioning)
4040
* [Contributing](#contributing)
4141
* [License](#license)
@@ -57,6 +57,55 @@ npm install @google-cloud/aiplatform
5757
```
5858

5959

60+
### Using the client library
61+
62+
```javascript
63+
/**
64+
* TODO(developer): Uncomment these variables before running the sample.
65+
*/
66+
// const projectId = 'YOUR_PROJECT_ID';
67+
// const location = 'YOUR_PROJECT_LOCATION';
68+
69+
const {EndpointServiceClient} = require('@google-cloud/aiplatform');
70+
71+
// Specifies the location of the api endpoint
72+
const clientOptions = {
73+
apiEndpoint: 'us-central1-aiplatform.googleapis.com',
74+
};
75+
const client = new EndpointServiceClient(clientOptions);
76+
77+
async function listEndpoints() {
78+
// Configure the parent resource
79+
const parent = `projects/${projectId}/locations/${location}`;
80+
const request = {
81+
parent,
82+
};
83+
84+
// Get and print out a list of all the endpoints for this resource
85+
const [result] = await client.listEndpoints(request);
86+
for (const endpoint of result) {
87+
console.log(`\nEndpoint name: ${endpoint.name}`);
88+
console.log(`Display name: ${endpoint.displayName}`);
89+
if (endpoint.deployedModels[0]) {
90+
console.log(
91+
`First deployed model: ${endpoint.deployedModels[0].model}`
92+
);
93+
}
94+
}
95+
}
96+
listEndpoints();
97+
98+
```
99+
100+
101+
102+
## Samples
103+
104+
Samples are in the [`samples/`](https://github.com/googleapis/nodejs-ai-platform/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample.
105+
106+
| Sample | Source Code | Try it |
107+
| --------------------------- | --------------------------------- | ------ |
108+
| Quickstart | [source code](https://github.com/googleapis/nodejs-ai-platform/blob/main/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-ai-platform&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) |
60109

61110

62111

packages/google-cloud-aiplatform/package.json

+1
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@
4343
"prelint": "cd samples; npm link ../; npm i",
4444
"prepare": "npm run compile-protos && npm run compile",
4545
"system-test": "c8 mocha build/system-test",
46+
"samples-test": "cd samples/ && npm link ../ && npm test",
4647
"test": "c8 node build/test/run.js"
4748
},
4849
"dependencies": {

packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation.proto

+15-9
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,9 @@ message Annotation {
4141
// Output only. Resource name of the Annotation.
4242
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
4343

44-
// Required. Google Cloud Storage URI points to a YAML file describing [payload][google.cloud.aiplatform.v1.Annotation.payload]. The
45-
// schema is defined as an [OpenAPI 3.0.2 Schema
44+
// Required. Google Cloud Storage URI points to a YAML file describing
45+
// [payload][google.cloud.aiplatform.v1.Annotation.payload]. The schema is
46+
// defined as an [OpenAPI 3.0.2 Schema
4647
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
4748
// The schema files that can be used here are found in
4849
// gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the
@@ -55,19 +56,23 @@ message Annotation {
5556
google.protobuf.Value payload = 3 [(google.api.field_behavior) = REQUIRED];
5657

5758
// Output only. Timestamp when this Annotation was created.
58-
google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
59+
google.protobuf.Timestamp create_time = 4
60+
[(google.api.field_behavior) = OUTPUT_ONLY];
5961

6062
// Output only. Timestamp when this Annotation was last updated.
61-
google.protobuf.Timestamp update_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
63+
google.protobuf.Timestamp update_time = 7
64+
[(google.api.field_behavior) = OUTPUT_ONLY];
6265

63-
// Optional. Used to perform consistent read-modify-write updates. If not set, a blind
64-
// "overwrite" update happens.
66+
// Optional. Used to perform consistent read-modify-write updates. If not set,
67+
// a blind "overwrite" update happens.
6568
string etag = 8 [(google.api.field_behavior) = OPTIONAL];
6669

6770
// Output only. The source of the Annotation.
68-
UserActionReference annotation_source = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
71+
UserActionReference annotation_source = 5
72+
[(google.api.field_behavior) = OUTPUT_ONLY];
6973

70-
// Optional. The labels with user-defined metadata to organize your Annotations.
74+
// Optional. The labels with user-defined metadata to organize your
75+
// Annotations.
7176
//
7277
// Label keys and values can be no longer than 64 characters
7378
// (Unicode codepoints), can only contain lowercase letters, numeric
@@ -84,7 +89,8 @@ message Annotation {
8489
// If not set, the Annotation is not visible in the UI.
8590
//
8691
// * "aiplatform.googleapis.com/payload_schema":
87-
// output only, its value is the [payload_schema's][google.cloud.aiplatform.v1.Annotation.payload_schema_uri]
92+
// output only, its value is the
93+
// [payload_schema's][google.cloud.aiplatform.v1.Annotation.payload_schema_uri]
8894
// title.
8995
map<string, string> labels = 6 [(google.api.field_behavior) = OPTIONAL];
9096
}

packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation_spec.proto

+7-5
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,19 @@ message AnnotationSpec {
3939
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
4040

4141
// Required. The user-defined name of the AnnotationSpec.
42-
// The name can be up to 128 characters long and can be consist of any UTF-8
42+
// The name can be up to 128 characters long and can consist of any UTF-8
4343
// characters.
4444
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
4545

4646
// Output only. Timestamp when this AnnotationSpec was created.
47-
google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
47+
google.protobuf.Timestamp create_time = 3
48+
[(google.api.field_behavior) = OUTPUT_ONLY];
4849

4950
// Output only. Timestamp when AnnotationSpec was last updated.
50-
google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
51+
google.protobuf.Timestamp update_time = 4
52+
[(google.api.field_behavior) = OUTPUT_ONLY];
5153

52-
// Optional. Used to perform consistent read-modify-write updates. If not set, a blind
53-
// "overwrite" update happens.
54+
// Optional. Used to perform consistent read-modify-write updates. If not set,
55+
// a blind "overwrite" update happens.
5456
string etag = 5 [(google.api.field_behavior) = OPTIONAL];
5557
}

packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/artifact.proto

+5-2
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,12 @@ message Artifact {
7575
map<string, string> labels = 10;
7676

7777
// Output only. Timestamp when this Artifact was created.
78-
google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
78+
google.protobuf.Timestamp create_time = 11
79+
[(google.api.field_behavior) = OUTPUT_ONLY];
7980

8081
// Output only. Timestamp when this Artifact was last updated.
81-
google.protobuf.Timestamp update_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
82+
google.protobuf.Timestamp update_time = 12
83+
[(google.api.field_behavior) = OUTPUT_ONLY];
8284

8385
// The state of this Artifact. This is a property of the Artifact, and does
8486
// not imply or capture any ongoing process. This property is managed by
@@ -101,6 +103,7 @@ message Artifact {
101103
string schema_version = 15;
102104

103105
// Properties of the Artifact.
106+
// Top level metadata keys' heading and trailing spaces will be trimmed.
104107
// The size of this field should not exceed 200KB.
105108
google.protobuf.Struct metadata = 16;
106109

0 commit comments

Comments
 (0)