1// Copyright 2023 Google LLC 2// 3// Licensed under the Apache License, Version 2.0 (the "License"); 4// you may not use this file except in compliance with the License. 5// You may obtain a copy of the License at 6// 7// http://www.apache.org/licenses/LICENSE-2.0 8// 9// Unless required by applicable law or agreed to in writing, software 10// distributed under the License is distributed on an "AS IS" BASIS, 11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12// See the License for the specific language governing permissions and 13// limitations under the License. 14 15syntax = "proto3"; 16 17package google.cloud.aiplatform.v1; 18 19import "google/api/annotations.proto"; 20import "google/api/client.proto"; 21import "google/api/field_behavior.proto"; 22import "google/api/resource.proto"; 23import "google/cloud/aiplatform/v1/publisher_model.proto"; 24 25option csharp_namespace = "Google.Cloud.AIPlatform.V1"; 26option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb"; 27option java_multiple_files = true; 28option java_outer_classname = "ModelGardenServiceProto"; 29option java_package = "com.google.cloud.aiplatform.v1"; 30option php_namespace = "Google\\Cloud\\AIPlatform\\V1"; 31option ruby_package = "Google::Cloud::AIPlatform::V1"; 32 33// The interface of Model Garden Service. 34service ModelGardenService { 35 option (google.api.default_host) = "aiplatform.googleapis.com"; 36 option (google.api.oauth_scopes) = 37 "https://www.googleapis.com/auth/cloud-platform"; 38 39 // Gets a Model Garden publisher model. 40 rpc GetPublisherModel(GetPublisherModelRequest) returns (PublisherModel) { 41 option (google.api.http) = { 42 get: "/v1/{name=publishers/*/models/*}" 43 }; 44 option (google.api.method_signature) = "name"; 45 } 46} 47 48// View enumeration of PublisherModel. 49enum PublisherModelView { 50 // The default / unset value. The API will default to the BASIC view. 51 PUBLISHER_MODEL_VIEW_UNSPECIFIED = 0; 52 53 // Include basic metadata about the publisher model, but not the full 54 // contents. 55 PUBLISHER_MODEL_VIEW_BASIC = 1; 56 57 // Include everything. 58 PUBLISHER_MODEL_VIEW_FULL = 2; 59 60 // Include: VersionId, ModelVersionExternalName, and SupportedActions. 61 PUBLISHER_MODEL_VERSION_VIEW_BASIC = 3; 62} 63 64// Request message for 65// [ModelGardenService.GetPublisherModel][google.cloud.aiplatform.v1.ModelGardenService.GetPublisherModel] 66message GetPublisherModelRequest { 67 // Required. The name of the PublisherModel resource. 68 // Format: 69 // `publishers/{publisher}/models/{publisher_model}` 70 string name = 1 [ 71 (google.api.field_behavior) = REQUIRED, 72 (google.api.resource_reference) = { 73 type: "aiplatform.googleapis.com/PublisherModel" 74 } 75 ]; 76 77 // Optional. The IETF BCP-47 language code representing the language in which 78 // the publisher model's text information should be written in (see go/bcp47). 79 string language_code = 2 [(google.api.field_behavior) = OPTIONAL]; 80 81 // Optional. PublisherModel view specifying which fields to read. 82 PublisherModelView view = 3 [(google.api.field_behavior) = OPTIONAL]; 83} 84