Skip to content

Commit

Permalink
fix!: Fix rpc tensorboard_service.proto definitions for BatchCreateTe…
Browse files Browse the repository at this point in the history
…nsorboardTimeSeries and BatchReadTensorboardTimeSeriesData

feat: add models to CustomJobSpec
feat: add max_wait_duration to Scheduling
feat: add CountTokens method to llm_utility_service
docs: minor changes to comments

PiperOrigin-RevId: 597667108
  • Loading branch information
Google APIs authored and Copybara-Service committed Jan 11, 2024
1 parent a8c7be4 commit 714ab03
Show file tree
Hide file tree
Showing 10 changed files with 107 additions and 14 deletions.
52 changes: 51 additions & 1 deletion google/cloud/aiplatform/v1beta1/aiplatform_v1beta1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,10 @@ apis:
- name: google.longrunning.Operations

types:
- name: google.cloud.aiplatform.v1beta1.BatchCancelPipelineJobsResponse
- name: google.cloud.aiplatform.v1beta1.BatchCreateFeaturesOperationMetadata
- name: google.cloud.aiplatform.v1beta1.BatchCreateFeaturesResponse
- name: google.cloud.aiplatform.v1beta1.BatchDeletePipelineJobsResponse
- name: google.cloud.aiplatform.v1beta1.BatchMigrateResourcesOperationMetadata
- name: google.cloud.aiplatform.v1beta1.BatchMigrateResourcesResponse
- name: google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesOperationMetadata
Expand Down Expand Up @@ -94,7 +96,6 @@ types:
- name: google.cloud.aiplatform.v1beta1.PurgeContextsResponse
- name: google.cloud.aiplatform.v1beta1.PurgeExecutionsMetadata
- name: google.cloud.aiplatform.v1beta1.PurgeExecutionsResponse
- name: google.cloud.aiplatform.v1beta1.RebootPersistentResourceOperationMetadata
- name: google.cloud.aiplatform.v1beta1.RestoreDatasetVersionOperationMetadata
- name: google.cloud.aiplatform.v1beta1.SpecialistPool
- name: google.cloud.aiplatform.v1beta1.SuggestTrialsMetadata
Expand Down Expand Up @@ -237,6 +238,10 @@ http:
- post: '/ui/{name=projects/*/locations/*/hyperparameterTuningJobs/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/indexes/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/indexEndpoints/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/metadataStores/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/metadataStores/*/artifacts/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/metadataStores/*/contexts/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/metadataStores/*/executions/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/modelMonitors/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/migratableResources/*/operations/*}:cancel'
Expand Down Expand Up @@ -273,6 +278,10 @@ http:
- post: '/v1beta1/{name=projects/*/locations/*/hyperparameterTuningJobs/*/operations/*}:cancel'
- post: '/v1beta1/{name=projects/*/locations/*/indexes/*/operations/*}:cancel'
- post: '/v1beta1/{name=projects/*/locations/*/indexEndpoints/*/operations/*}:cancel'
- post: '/v1beta1/{name=projects/*/locations/*/metadataStores/*/operations/*}:cancel'
- post: '/v1beta1/{name=projects/*/locations/*/metadataStores/*/artifacts/*/operations/*}:cancel'
- post: '/v1beta1/{name=projects/*/locations/*/metadataStores/*/contexts/*/operations/*}:cancel'
- post: '/v1beta1/{name=projects/*/locations/*/metadataStores/*/executions/*/operations/*}:cancel'
- post: '/v1beta1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*/operations/*}:cancel'
- post: '/v1beta1/{name=projects/*/locations/*/modelMonitors/*/operations/*}:cancel'
- post: '/v1beta1/{name=projects/*/locations/*/migratableResources/*/operations/*}:cancel'
Expand All @@ -283,6 +292,7 @@ http:
- post: '/v1beta1/{name=projects/*/locations/*/studies/*/trials/*/operations/*}:cancel'
- post: '/v1beta1/{name=projects/*/locations/*/trainingPipelines/*/operations/*}:cancel'
- post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:cancel'
- post: '/v1beta1/{name=projects/*/locations/*/reasoningEngines/*/operations/*}:cancel'
- post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:cancel'
- post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:cancel'
- post: '/v1beta1/{name=projects/*/locations/*/tensorboards/*/operations/*}:cancel'
Expand Down Expand Up @@ -310,6 +320,10 @@ http:
- delete: '/ui/{name=projects/*/locations/*/hyperparameterTuningJobs/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/indexes/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/indexEndpoints/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/metadataStores/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/metadataStores/*/artifacts/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/metadataStores/*/contexts/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/metadataStores/*/executions/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/modelMonitors/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/migratableResources/*/operations/*}'
Expand Down Expand Up @@ -350,12 +364,17 @@ http:
- delete: '/v1beta1/{name=projects/*/locations/*/hyperparameterTuningJobs/*/operations/*}'
- delete: '/v1beta1/{name=projects/*/locations/*/indexes/*/operations/*}'
- delete: '/v1beta1/{name=projects/*/locations/*/indexEndpoints/*/operations/*}'
- delete: '/v1beta1/{name=projects/*/locations/*/metadataStores/*/operations/*}'
- delete: '/v1beta1/{name=projects/*/locations/*/metadataStores/*/artifacts/*/operations/*}'
- delete: '/v1beta1/{name=projects/*/locations/*/metadataStores/*/contexts/*/operations/*}'
- delete: '/v1beta1/{name=projects/*/locations/*/metadataStores/*/executions/*/operations/*}'
- delete: '/v1beta1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*/operations/*}'
- delete: '/v1beta1/{name=projects/*/locations/*/modelMonitors/*/operations/*}'
- delete: '/v1beta1/{name=projects/*/locations/*/migratableResources/*/operations/*}'
- delete: '/v1beta1/{name=projects/*/locations/*/models/*/operations/*}'
- delete: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}'
- delete: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}'
- delete: '/v1beta1/{name=projects/*/locations/*/reasoningEngines/*/operations/*}'
- delete: '/v1beta1/{name=projects/*/locations/*/solvers/*/operations/*}'
- delete: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}'
- delete: '/v1beta1/{name=projects/*/locations/*/studies/*/trials/*/operations/*}'
Expand Down Expand Up @@ -393,6 +412,10 @@ http:
- get: '/ui/{name=projects/*/locations/*/hyperparameterTuningJobs/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/indexes/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/indexEndpoints/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/metadataStores/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/metadataStores/*/artifacts/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/metadataStores/*/contexts/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/metadataStores/*/executions/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/modelMonitors/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/migratableResources/*/operations/*}'
Expand Down Expand Up @@ -433,12 +456,17 @@ http:
- get: '/v1beta1/{name=projects/*/locations/*/hyperparameterTuningJobs/*/operations/*}'
- get: '/v1beta1/{name=projects/*/locations/*/indexes/*/operations/*}'
- get: '/v1beta1/{name=projects/*/locations/*/indexEndpoints/*/operations/*}'
- get: '/v1beta1/{name=projects/*/locations/*/metadataStores/*/operations/*}'
- get: '/v1beta1/{name=projects/*/locations/*/metadataStores/*/artifacts/*/operations/*}'
- get: '/v1beta1/{name=projects/*/locations/*/metadataStores/*/contexts/*/operations/*}'
- get: '/v1beta1/{name=projects/*/locations/*/metadataStores/*/executions/*/operations/*}'
- get: '/v1beta1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*/operations/*}'
- get: '/v1beta1/{name=projects/*/locations/*/modelMonitors/*/operations/*}'
- get: '/v1beta1/{name=projects/*/locations/*/migratableResources/*/operations/*}'
- get: '/v1beta1/{name=projects/*/locations/*/models/*/operations/*}'
- get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}'
- get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}'
- get: '/v1beta1/{name=projects/*/locations/*/reasoningEngines/*/operations/*}'
- get: '/v1beta1/{name=projects/*/locations/*/solvers/*/operations/*}'
- get: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}'
- get: '/v1beta1/{name=projects/*/locations/*/studies/*/trials/*/operations/*}'
Expand Down Expand Up @@ -475,6 +503,10 @@ http:
- get: '/ui/{name=projects/*/locations/*/hyperparameterTuningJobs/*}/operations'
- get: '/ui/{name=projects/*/locations/*/indexes/*}/operations'
- get: '/ui/{name=projects/*/locations/*/indexEndpoints/*}/operations'
- get: '/ui/{name=projects/*/locations/*/metadataStores/*}/operations'
- get: '/ui/{name=projects/*/locations/*/metadataStores/*/artifacts/*}/operations'
- get: '/ui/{name=projects/*/locations/*/metadataStores/*/contexts/*}/operations'
- get: '/ui/{name=projects/*/locations/*/metadataStores/*/executions/*}/operations'
- get: '/ui/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}/operations'
- get: '/ui/{name=projects/*/locations/*/modelMonitors/*}/operations'
- get: '/ui/{name=projects/*/locations/*/migratableResources/*}/operations'
Expand Down Expand Up @@ -515,12 +547,17 @@ http:
- get: '/v1beta1/{name=projects/*/locations/*/hyperparameterTuningJobs/*}/operations'
- get: '/v1beta1/{name=projects/*/locations/*/indexes/*}/operations'
- get: '/v1beta1/{name=projects/*/locations/*/indexEndpoints/*}/operations'
- get: '/v1beta1/{name=projects/*/locations/*/metadataStores/*}/operations'
- get: '/v1beta1/{name=projects/*/locations/*/metadataStores/*/artifacts/*}/operations'
- get: '/v1beta1/{name=projects/*/locations/*/metadataStores/*/contexts/*}/operations'
- get: '/v1beta1/{name=projects/*/locations/*/metadataStores/*/executions/*}/operations'
- get: '/v1beta1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}/operations'
- get: '/v1beta1/{name=projects/*/locations/*/modelMonitors/*}/operations'
- get: '/v1beta1/{name=projects/*/locations/*/migratableResources/*}/operations'
- get: '/v1beta1/{name=projects/*/locations/*/models/*}/operations'
- get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*}/operations'
- get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*}/operations'
- get: '/v1beta1/{name=projects/*/locations/*/reasoningEngines/*}/operations'
- get: '/v1beta1/{name=projects/*/locations/*/solvers/*}/operations'
- get: '/v1beta1/{name=projects/*/locations/*/studies/*}/operations'
- get: '/v1beta1/{name=projects/*/locations/*/studies/*/trials/*}/operations'
Expand Down Expand Up @@ -557,6 +594,10 @@ http:
- post: '/ui/{name=projects/*/locations/*/hyperparameterTuningJobs/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/indexes/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/indexEndpoints/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/metadataStores/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/metadataStores/*/artifacts/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/metadataStores/*/contexts/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/metadataStores/*/executions/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/modelMonitors/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/migratableResources/*/operations/*}:wait'
Expand Down Expand Up @@ -597,12 +638,17 @@ http:
- post: '/v1beta1/{name=projects/*/locations/*/hyperparameterTuningJobs/*/operations/*}:wait'
- post: '/v1beta1/{name=projects/*/locations/*/indexes/*/operations/*}:wait'
- post: '/v1beta1/{name=projects/*/locations/*/indexEndpoints/*/operations/*}:wait'
- post: '/v1beta1/{name=projects/*/locations/*/metadataStores/*/operations/*}:wait'
- post: '/v1beta1/{name=projects/*/locations/*/metadataStores/*/artifacts/*/operations/*}:wait'
- post: '/v1beta1/{name=projects/*/locations/*/metadataStores/*/contexts/*/operations/*}:wait'
- post: '/v1beta1/{name=projects/*/locations/*/metadataStores/*/executions/*/operations/*}:wait'
- post: '/v1beta1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*/operations/*}:wait'
- post: '/v1beta1/{name=projects/*/locations/*/modelMonitors/*/operations/*}:wait'
- post: '/v1beta1/{name=projects/*/locations/*/migratableResources/*/operations/*}:wait'
- post: '/v1beta1/{name=projects/*/locations/*/models/*/operations/*}:wait'
- post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:wait'
- post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:wait'
- post: '/v1beta1/{name=projects/*/locations/*/reasoningEngines/*/operations/*}:wait'
- post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:wait'
- post: '/v1beta1/{name=projects/*/locations/*/studies/*/trials/*/operations/*}:wait'
- post: '/v1beta1/{name=projects/*/locations/*/trainingPipelines/*/operations/*}:wait'
Expand Down Expand Up @@ -677,6 +723,10 @@ authentication:
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
- selector: google.cloud.aiplatform.v1beta1.LlmUtilityService.CountTokens
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
- selector: google.cloud.aiplatform.v1beta1.MatchService.FindNeighbors
oauth:
canonical_scopes: |-
Expand Down
25 changes: 25 additions & 0 deletions google/cloud/aiplatform/v1beta1/custom_job.proto
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,26 @@ message CustomJobSpec {
type: "aiplatform.googleapis.com/Context"
}
];

// Optional. The name of the Model resources for which to generate a mapping
// to artifact URIs. Applicable only to some of the Google-provided custom
// jobs. Format: `projects/{project}/locations/{location}/models/{model}`
//
// In order to retrieve a specific version of the model, also provide
// the version ID or version alias.
// Example: `projects/{project}/locations/{location}/models/{model}@2`
// or
// `projects/{project}/locations/{location}/models/{model}@golden`
// If no version ID or alias is specified, the "default" version will be
// returned. The "default" version alias is created for the first version of
// the model, and can be moved to other versions later on. There will be
// exactly one default version.
repeated string models = 20 [
(google.api.field_behavior) = OPTIONAL,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/Model"
}
];
}

// Represents the spec of a worker pool in a job.
Expand Down Expand Up @@ -343,4 +363,9 @@ message Scheduling {
// job starts running. If true, overrides
// `Scheduling.restart_job_on_worker_restart` to false.
bool disable_retries = 5 [(google.api.field_behavior) = OPTIONAL];

// Optional. This is the maximum time a user will wait in the QRM queue for
// resources. Default is 1 day
google.protobuf.Duration max_wait_duration = 6
[(google.api.field_behavior) = OPTIONAL];
}
5 changes: 3 additions & 2 deletions google/cloud/aiplatform/v1beta1/dataset_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -413,8 +413,9 @@ message ExportDataRequest {
// [DatasetService.ExportData][google.cloud.aiplatform.v1beta1.DatasetService.ExportData].
message ExportDataResponse {
// All of the files that are exported in this export operation. For custom
// code training export, only three (training, validation and test) GCS paths
// in wildcard format are populated (e.g., gs://.../training-*).
// code training export, only three (training, validation and test)
// Cloud Storage paths in wildcard format are populated
// (for example, gs://.../training-*).
repeated string exported_files = 1;
}

Expand Down
2 changes: 1 addition & 1 deletion google/cloud/aiplatform/v1beta1/feature.proto
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ message Feature {
[(google.api.field_behavior) = OUTPUT_ONLY];

// Only applicable for Vertex AI Feature Store.
// The name of the BigQuery Table/View columnn hosting data for this version.
// The name of the BigQuery Table/View column hosting data for this version.
// If no value is provided, will use feature_id.
string version_column_name = 106;
}
9 changes: 6 additions & 3 deletions google/cloud/aiplatform/v1beta1/feature_online_store.proto
Original file line number Diff line number Diff line change
Expand Up @@ -66,15 +66,18 @@ message FeatureOnlineStore {

// The dedicated serving endpoint for this FeatureOnlineStore. Only need to
// set when you choose Optimized storage type or enable EmbeddingManagement.
// Will use public endpoint by default.
// Will use public endpoint by default. Note, for EmbeddingManagement use
// case, only [DedicatedServingEndpoint.public_endpoint_domain_name] is
// available now.
message DedicatedServingEndpoint {
// Output only. This field will be populated with the domain name to use for
// this FeatureOnlineStore
string public_endpoint_domain_name = 2
[(google.api.field_behavior) = OUTPUT_ONLY];

// Optional. Private service connect config.
// If
// Optional. Private service connect config. The private service connection
// is available only for Optimized storage type, not for embedding
// management now. If
// [PrivateServiceConnectConfig.enable_private_service_connect][google.cloud.aiplatform.v1beta1.PrivateServiceConnectConfig.enable_private_service_connect]
// set to true, customers will use private service connection to send
// request. Otherwise, the connection will set to public endpoint.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ service FeatureOnlineStoreAdminService {
message CreateFeatureOnlineStoreRequest {
// Required. The resource name of the Location to create FeatureOnlineStores.
// Format:
// `projects/{project}/locations/{location}'`
// `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand Down
14 changes: 14 additions & 0 deletions google/cloud/aiplatform/v1beta1/llm_utility_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/aiplatform/v1beta1/prediction_service.proto";
import "google/protobuf/struct.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
Expand All @@ -36,6 +37,19 @@ service LlmUtilityService {
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform";

// Perform a token counting.
rpc CountTokens(CountTokensRequest) returns (CountTokensResponse) {
option (google.api.http) = {
post: "/v1beta1/{endpoint=projects/*/locations/*/endpoints/*}:countTokens"
body: "*"
additional_bindings {
post: "/v1beta1/{endpoint=projects/*/locations/*/publishers/*/models/*}:countTokens"
body: "*"
}
};
option (google.api.method_signature) = "endpoint,instances";
}

// Return a list of tokens based on the input text.
rpc ComputeTokens(ComputeTokensRequest) returns (ComputeTokensResponse) {
option (google.api.http) = {
Expand Down
2 changes: 1 addition & 1 deletion google/cloud/aiplatform/v1beta1/model_evaluation.proto
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ message ModelEvaluation {
// The metadata of the ModelEvaluation.
// For the ModelEvaluation uploaded from Managed Pipeline, metadata contains a
// structured value with keys of "pipeline_job_id", "evaluation_dataset_type",
// "evaluation_dataset_path".
// "evaluation_dataset_path", "row_based_metrics_path".
google.protobuf.Value metadata = 11;

// Specify the configuration for bias detection.
Expand Down
6 changes: 3 additions & 3 deletions google/cloud/aiplatform/v1beta1/persistent_resource.proto
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,14 @@ message PersistentResource {
// created.
PROVISIONING = 1;

// The RUNNING state indicates the persistent resources is healthy and fully
// The RUNNING state indicates the persistent resource is healthy and fully
// usable.
RUNNING = 3;

// The STOPPING state indicates the persistent resources is being deleted.
// The STOPPING state indicates the persistent resource is being deleted.
STOPPING = 4;

// The ERROR state indicates the persistent resources may be unusable.
// The ERROR state indicates the persistent resource may be unusable.
// Details can be found in the `error` field.
ERROR = 5;
}
Expand Down

0 comments on commit 714ab03

Please sign in to comment.