Skip to content

Commit

Permalink
feat: A new field presence_penalty is added to message `.google.clo…
Browse files Browse the repository at this point in the history
…ud.aiplatform.v1.GenerationConfig`

feat: A new field `frequency_penalty` is added to message `.google.cloud.aiplatform.v1.GenerationConfig`
feat: A new field `response_mime_type` is added to message `.google.cloud.aiplatform.v1.GenerationConfig`
feat: A new enum `HarmBlockMethod` is added
feat: A new field `method` is added to message `.google.cloud.aiplatform.v1.SafetySetting`
feat: A new field `persistent_resource_id` is added to message `.google.cloud.aiplatform.v1.CustomJobSpec`
feat: A new field `disable_explanations` is added to message `.google.cloud.aiplatform.v1.DeployedModel`
feat: A new field `title` is added to message `.google.cloud.aiplatform.v1.Schema`
feat: A new field `default` is added to message `.google.cloud.aiplatform.v1.Schema`
feat: A new field `min_items` is added to message `.google.cloud.aiplatform.v1.Schema`
feat: A new field `max_items` is added to message `.google.cloud.aiplatform.v1.Schema`
feat: A new field `min_properties` is added to message `.google.cloud.aiplatform.v1.Schema`
feat: A new field `max_properties` is added to message `.google.cloud.aiplatform.v1.Schema`
feat: A new field `minimum` is added to message `.google.cloud.aiplatform.v1.Schema`
feat: A new field `maximum` is added to message `.google.cloud.aiplatform.v1.Schema`
feat: A new field `min_length` is added to message `.google.cloud.aiplatform.v1.Schema`
feat: A new field `max_length` is added to message `.google.cloud.aiplatform.v1.Schema`
feat: A new field `pattern` is added to message `.google.cloud.aiplatform.v1.Schema`
feat: A new message `PersistentResource` is added
feat: A new resource_definition `aiplatform.googleapis.com/PersistentResource` is added
feat: A new message `ResourcePool` is added
feat: A new message `ResourceRuntimeSpec` is added
feat: A new message `RaySpec` is added
feat: A new message `ResourceRuntime` is added
feat: A new message `ServiceAccountSpec` is added
feat: A new service `PersistentResourceService` is added
feat: A new message `CreatePersistentResourceRequest` is added
feat: A new message `CreatePersistentResourceOperationMetadata` is added
feat: A new message `UpdatePersistentResourceOperationMetadata` is added
feat: A new message `RebootPersistentResourceOperationMetadata` is added
feat: A new message `GetPersistentResourceRequest` is added
feat: A new message `ListPersistentResourcesRequest` is added
feat: A new message `ListPersistentResourcesResponse` is added
feat: A new message `DeletePersistentResourceRequest` is added
feat: A new message `UpdatePersistentResourceRequest` is added
feat: A new message `RebootPersistentResourceRequest` is added
feat: A new field `system_instruction` is added to message `.google.cloud.aiplatform.v1.GenerateContentRequest`
feat: A new value `BLOCKLIST` is added to enum `BlockedReason`
feat: A new value `PROHIBITED_CONTENT` is added to enum `BlockedReason`
docs: documentation updates

PiperOrigin-RevId: 620417078
  • Loading branch information
Google APIs authored and Copybara-Service committed Mar 30, 2024
1 parent fc3853b commit 7efb929
Show file tree
Hide file tree
Showing 11 changed files with 643 additions and 16 deletions.
2 changes: 2 additions & 0 deletions google/cloud/aiplatform/v1/BUILD.bazel
Expand Up @@ -104,6 +104,8 @@ proto_library(
"notebook_service.proto",
"openapi.proto",
"operation.proto",
"persistent_resource.proto",
"persistent_resource_service.proto",
"pipeline_failure_policy.proto",
"pipeline_job.proto",
"pipeline_service.proto",
Expand Down
17 changes: 16 additions & 1 deletion google/cloud/aiplatform/v1/aiplatform_v1.yaml
Expand Up @@ -22,6 +22,7 @@ apis:
- name: google.cloud.aiplatform.v1.ModelGardenService
- name: google.cloud.aiplatform.v1.ModelService
- name: google.cloud.aiplatform.v1.NotebookService
- name: google.cloud.aiplatform.v1.PersistentResourceService
- name: google.cloud.aiplatform.v1.PipelineService
- name: google.cloud.aiplatform.v1.PredictionService
- name: google.cloud.aiplatform.v1.ScheduleService
Expand Down Expand Up @@ -58,6 +59,7 @@ types:
- name: google.cloud.aiplatform.v1.CreateIndexOperationMetadata
- name: google.cloud.aiplatform.v1.CreateMetadataStoreOperationMetadata
- name: google.cloud.aiplatform.v1.CreateNotebookRuntimeTemplateOperationMetadata
- name: google.cloud.aiplatform.v1.CreatePersistentResourceOperationMetadata
- name: google.cloud.aiplatform.v1.CreateRegistryFeatureOperationMetadata
- name: google.cloud.aiplatform.v1.CreateSpecialistPoolOperationMetadata
- name: google.cloud.aiplatform.v1.CreateTensorboardOperationMetadata
Expand Down Expand Up @@ -89,6 +91,7 @@ types:
- name: google.cloud.aiplatform.v1.PurgeContextsResponse
- name: google.cloud.aiplatform.v1.PurgeExecutionsMetadata
- name: google.cloud.aiplatform.v1.PurgeExecutionsResponse
- name: google.cloud.aiplatform.v1.RebootPersistentResourceOperationMetadata
- name: google.cloud.aiplatform.v1.RestoreDatasetVersionOperationMetadata
- name: google.cloud.aiplatform.v1.SpecialistPool
- name: google.cloud.aiplatform.v1.StartNotebookRuntimeOperationMetadata
Expand All @@ -108,6 +111,7 @@ types:
- name: google.cloud.aiplatform.v1.UpdateFeaturestoreOperationMetadata
- name: google.cloud.aiplatform.v1.UpdateIndexOperationMetadata
- name: google.cloud.aiplatform.v1.UpdateModelDeploymentMonitoringJobOperationMetadata
- name: google.cloud.aiplatform.v1.UpdatePersistentResourceOperationMetadata
- name: google.cloud.aiplatform.v1.UpdateSpecialistPoolOperationMetadata
- name: google.cloud.aiplatform.v1.UpdateTensorboardOperationMetadata
- name: google.cloud.aiplatform.v1.UpgradeNotebookRuntimeOperationMetadata
Expand Down Expand Up @@ -252,6 +256,7 @@ http:
- post: '/ui/{name=projects/*/locations/*/migratableResources/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/models/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/persistentResources/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/studies/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/studies/*/trials/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/trainingPipelines/*/operations/*}:cancel'
Expand Down Expand Up @@ -287,6 +292,7 @@ http:
- post: '/v1/{name=projects/*/locations/*/migratableResources/*/operations/*}:cancel'
- post: '/v1/{name=projects/*/locations/*/models/*/operations/*}:cancel'
- post: '/v1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:cancel'
- post: '/v1/{name=projects/*/locations/*/persistentResources/*/operations/*}:cancel'
- post: '/v1/{name=projects/*/locations/*/studies/*/operations/*}:cancel'
- post: '/v1/{name=projects/*/locations/*/studies/*/trials/*/operations/*}:cancel'
- post: '/v1/{name=projects/*/locations/*/trainingPipelines/*/operations/*}:cancel'
Expand Down Expand Up @@ -327,6 +333,7 @@ http:
- delete: '/ui/{name=projects/*/locations/*/migratableResources/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/models/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/persistentResources/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/studies/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/studies/*/trials/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/trainingPipelines/*/operations/*}'
Expand Down Expand Up @@ -368,6 +375,7 @@ http:
- delete: '/v1/{name=projects/*/locations/*/studies/*/operations/*}'
- delete: '/v1/{name=projects/*/locations/*/studies/*/trials/*/operations/*}'
- delete: '/v1/{name=projects/*/locations/*/trainingPipelines/*/operations/*}'
- delete: '/v1/{name=projects/*/locations/*/persistentResources/*/operations/*}'
- delete: '/v1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}'
- delete: '/v1/{name=projects/*/locations/*/schedules/*/operations/*}'
- delete: '/v1/{name=projects/*/locations/*/specialistPools/*/operations/*}'
Expand Down Expand Up @@ -411,6 +419,7 @@ http:
- get: '/ui/{name=projects/*/locations/*/migratableResources/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/models/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/persistentResources/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/studies/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/studies/*/trials/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/trainingPipelines/*/operations/*}'
Expand Down Expand Up @@ -453,6 +462,7 @@ http:
- get: '/v1/{name=projects/*/locations/*/studies/*/operations/*}'
- get: '/v1/{name=projects/*/locations/*/studies/*/trials/*/operations/*}'
- get: '/v1/{name=projects/*/locations/*/trainingPipelines/*/operations/*}'
- get: '/v1/{name=projects/*/locations/*/persistentResources/*/operations/*}'
- get: '/v1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}'
- get: '/v1/{name=projects/*/locations/*/schedules/*/operations/*}'
- get: '/v1/{name=projects/*/locations/*/specialistPools/*/operations/*}'
Expand Down Expand Up @@ -498,6 +508,7 @@ http:
- get: '/ui/{name=projects/*/locations/*/studies/*}/operations'
- get: '/ui/{name=projects/*/locations/*/studies/*/trials/*}/operations'
- get: '/ui/{name=projects/*/locations/*/trainingPipelines/*}/operations'
- get: '/ui/{name=projects/*/locations/*/persistentResources/*}/operations'
- get: '/ui/{name=projects/*/locations/*/pipelineJobs/*}/operations'
- get: '/ui/{name=projects/*/locations/*/schedules/*}/operations'
- get: '/ui/{name=projects/*/locations/*/specialistPools/*}/operations'
Expand All @@ -523,7 +534,7 @@ http:
- get: '/v1/{name=projects/*/locations/*/customJobs/*}/operations'
- get: '/v1/{name=projects/*/locations/*/dataLabelingJobs/*}/operations'
- get: '/v1/{name=projects/*/locations/*/hyperparameterTuningJobs/*}/operations'
- get: '/ui/{name=projects/*/locations/*/tuningJobs/*}/operations'
- get: '/v1/{name=projects/*/locations/*/tuningJobs/*}/operations'
- get: '/v1/{name=projects/*/locations/*/indexes/*}/operations'
- get: '/v1/{name=projects/*/locations/*/indexEndpoints/*}/operations'
- get: '/v1/{name=projects/*/locations/*/metadataStores/*}/operations'
Expand All @@ -537,6 +548,7 @@ http:
- get: '/v1/{name=projects/*/locations/*/studies/*}/operations'
- get: '/v1/{name=projects/*/locations/*/studies/*/trials/*}/operations'
- get: '/v1/{name=projects/*/locations/*/trainingPipelines/*}/operations'
- get: '/v1/{name=projects/*/locations/*/persistentResources/*}/operations'
- get: '/v1/{name=projects/*/locations/*/pipelineJobs/*}/operations'
- get: '/v1/{name=projects/*/locations/*/schedules/*}/operations'
- get: '/v1/{name=projects/*/locations/*/specialistPools/*}/operations'
Expand Down Expand Up @@ -582,6 +594,7 @@ http:
- post: '/ui/{name=projects/*/locations/*/studies/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/studies/*/trials/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/trainingPipelines/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/persistentResources/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/schedules/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/specialistPools/*/operations/*}:wait'
Expand Down Expand Up @@ -620,6 +633,7 @@ http:
- post: '/v1/{name=projects/*/locations/*/studies/*/operations/*}:wait'
- post: '/v1/{name=projects/*/locations/*/studies/*/trials/*/operations/*}:wait'
- post: '/v1/{name=projects/*/locations/*/trainingPipelines/*/operations/*}:wait'
- post: '/v1/{name=projects/*/locations/*/persistentResources/*/operations/*}:wait'
- post: '/v1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:wait'
- post: '/v1/{name=projects/*/locations/*/schedules/*/operations/*}:wait'
- post: '/v1/{name=projects/*/locations/*/specialistPools/*/operations/*}:wait'
Expand Down Expand Up @@ -724,6 +738,7 @@ authentication:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
- selector: 'google.cloud.aiplatform.v1.NotebookService.*'
- selector: 'google.cloud.aiplatform.v1.PersistentResourceService.*'
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
Expand Down
38 changes: 35 additions & 3 deletions google/cloud/aiplatform/v1/content.proto
Expand Up @@ -102,14 +102,15 @@ message Part {
}
}

// Raw media bytes.
// Content blob.
//
// Text should not be sent as raw bytes, use the 'text' field.
// It's preferred to send as [text][google.cloud.aiplatform.v1.Part.text]
// directly rather than raw bytes.
message Blob {
// Required. The IANA standard MIME type of the source data.
string mime_type = 1 [(google.api.field_behavior) = REQUIRED];

// Required. Raw bytes for media formats.
// Required. Raw bytes.
bytes data = 2 [(google.api.field_behavior) = REQUIRED];
}

Expand Down Expand Up @@ -152,6 +153,21 @@ message GenerationConfig {

// Optional. Stop sequences.
repeated string stop_sequences = 6 [(google.api.field_behavior) = OPTIONAL];

// Optional. Positive penalties.
optional float presence_penalty = 8 [(google.api.field_behavior) = OPTIONAL];

// Optional. Frequency penalties.
optional float frequency_penalty = 9 [(google.api.field_behavior) = OPTIONAL];

// Optional. Output response mimetype of the generated candidate text.
// Supported mimetype:
// - `text/plain`: (default) Text output.
// - `application/json`: JSON response in the candidates.
// The model needs to be prompted to output the appropriate response type,
// otherwise the behavior is undefined.
// This is a preview feature.
string response_mime_type = 13 [(google.api.field_behavior) = OPTIONAL];
}

// Safety settings.
Expand All @@ -174,11 +190,27 @@ message SafetySetting {
BLOCK_NONE = 4;
}

// Probability vs severity.
enum HarmBlockMethod {
// The harm block method is unspecified.
HARM_BLOCK_METHOD_UNSPECIFIED = 0;

// The harm block method uses both probability and severity scores.
SEVERITY = 1;

// The harm block method uses the probability score.
PROBABILITY = 2;
}

// Required. Harm category.
HarmCategory category = 1 [(google.api.field_behavior) = REQUIRED];

// Required. The harm block threshold.
HarmBlockThreshold threshold = 2 [(google.api.field_behavior) = REQUIRED];

// Optional. Specify if the threshold is used for probability or severity
// score. If not specified, the threshold is used for probability score.
HarmBlockMethod method = 4 [(google.api.field_behavior) = OPTIONAL];
}

// Safety rating corresponding to the generated content.
Expand Down
14 changes: 14 additions & 0 deletions google/cloud/aiplatform/v1/custom_job.proto
Expand Up @@ -113,6 +113,20 @@ message CustomJob {

// Represents the spec of a CustomJob.
message CustomJobSpec {
// Optional. The ID of the PersistentResource in the same Project and Location
// which to run
//
// If this is specified, the job will be run on existing machines held by the
// PersistentResource instead of on-demand short-live machines.
// The network and CMEK configs on the job should be consistent with those on
// the PersistentResource, otherwise, the job will be rejected.
string persistent_resource_id = 14 [
(google.api.field_behavior) = OPTIONAL,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/PersistentResource"
}
];

// Required. The spec of the worker pools including machine type and Docker
// image. All worker pools except the first one are optional and can be
// skipped by providing an empty value.
Expand Down
7 changes: 7 additions & 0 deletions google/cloud/aiplatform/v1/endpoint.proto
Expand Up @@ -221,6 +221,13 @@ message DeployedModel {
// will be used for the explanation configuration.
ExplanationSpec explanation_spec = 9;

// If true, deploy the model without explainable feature, regardless the
// existence of
// [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
// or
// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec].
bool disable_explanations = 19;

// The service account that the DeployedModel's container runs as. Specify the
// email address of the service account. If this service account is not
// specified, the container runs as a service account that doesn't have access
Expand Down
5 changes: 2 additions & 3 deletions google/cloud/aiplatform/v1/endpoint_service.proto
Expand Up @@ -211,9 +211,8 @@ message ListEndpointsRequest {
// names both snake_case and camelCase are supported.
//
// * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint
// ID,
// i.e. the last segment of the Endpoint's [resource
// name][google.cloud.aiplatform.v1.Endpoint.name].
// ID, i.e. the last segment of the Endpoint's
// [resource name][google.cloud.aiplatform.v1.Endpoint.name].
// * `display_name` supports `=` and `!=`.
// * `labels` supports general map functions that is:
// * `labels.key=value` - key:value equality
Expand Down
47 changes: 43 additions & 4 deletions google/cloud/aiplatform/v1/openapi.proto
Expand Up @@ -62,30 +62,69 @@ message Schema {

// Optional. The format of the data.
// Supported formats:
// for NUMBER type: float, double
// for INTEGER type: int32, int64
// for NUMBER type: "float", "double"
// for INTEGER type: "int32", "int64"
// for STRING type: "email", "byte", etc
string format = 7 [(google.api.field_behavior) = OPTIONAL];

// Optional. The title of the Schema.
string title = 24 [(google.api.field_behavior) = OPTIONAL];

// Optional. The description of the data.
string description = 8 [(google.api.field_behavior) = OPTIONAL];

// Optional. Indicates if the value may be null.
bool nullable = 6 [(google.api.field_behavior) = OPTIONAL];

// Optional. Schema of the elements of Type.ARRAY.
// Optional. Default value of the data.
google.protobuf.Value default = 23 [(google.api.field_behavior) = OPTIONAL];

// Optional. SCHEMA FIELDS FOR TYPE ARRAY
// Schema of the elements of Type.ARRAY.
Schema items = 2 [(google.api.field_behavior) = OPTIONAL];

// Optional. Minimum number of the elements for Type.ARRAY.
int64 min_items = 21 [(google.api.field_behavior) = OPTIONAL];

// Optional. Maximum number of the elements for Type.ARRAY.
int64 max_items = 22 [(google.api.field_behavior) = OPTIONAL];

// Optional. Possible values of the element of Type.STRING with enum format.
// For example we can define an Enum Direction as :
// {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
repeated string enum = 9 [(google.api.field_behavior) = OPTIONAL];

// Optional. Properties of Type.OBJECT.
// Optional. SCHEMA FIELDS FOR TYPE OBJECT
// Properties of Type.OBJECT.
map<string, Schema> properties = 3 [(google.api.field_behavior) = OPTIONAL];

// Optional. Required properties of Type.OBJECT.
repeated string required = 5 [(google.api.field_behavior) = OPTIONAL];

// Optional. Minimum number of the properties for Type.OBJECT.
int64 min_properties = 14 [(google.api.field_behavior) = OPTIONAL];

// Optional. Maximum number of the properties for Type.OBJECT.
int64 max_properties = 15 [(google.api.field_behavior) = OPTIONAL];

// Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER
// Minimum value of the Type.INTEGER and Type.NUMBER
double minimum = 16 [(google.api.field_behavior) = OPTIONAL];

// Optional. Maximum value of the Type.INTEGER and Type.NUMBER
double maximum = 17 [(google.api.field_behavior) = OPTIONAL];

// Optional. SCHEMA FIELDS FOR TYPE STRING
// Minimum length of the Type.STRING
int64 min_length = 18 [(google.api.field_behavior) = OPTIONAL];

// Optional. Maximum length of the Type.STRING
int64 max_length = 19 [(google.api.field_behavior) = OPTIONAL];

// Optional. Pattern of the Type.STRING to restrict a string to a regular
// expression.
string pattern = 20 [(google.api.field_behavior) = OPTIONAL];

// Optional. Example of the object. Will only populated when the object is the
// root.
google.protobuf.Value example = 4 [(google.api.field_behavior) = OPTIONAL];
Expand Down

0 comments on commit 7efb929

Please sign in to comment.