xref: /aosp_15_r20/external/googleapis/google/cloud/aiplatform/v1beta1/reasoning_engine.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
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.v1beta1;
18
19import "google/api/field_behavior.proto";
20import "google/api/resource.proto";
21import "google/protobuf/struct.proto";
22import "google/protobuf/timestamp.proto";
23
24option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
25option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
26option java_multiple_files = true;
27option java_outer_classname = "ReasoningEngineProto";
28option java_package = "com.google.cloud.aiplatform.v1beta1";
29option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
30option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
31
32// ReasoningEngine configurations
33message ReasoningEngineSpec {
34  // User provided package spec like pickled object and package requirements.
35  message PackageSpec {
36    // Optional. The Cloud Storage URI of the pickled python object.
37    string pickle_object_gcs_uri = 1 [(google.api.field_behavior) = OPTIONAL];
38
39    // Optional. The Cloud Storage URI of the dependency files in tar.gz format.
40    string dependency_files_gcs_uri = 2
41        [(google.api.field_behavior) = OPTIONAL];
42
43    // Optional. The Cloud Storage URI of the `requirements.txt` file
44    string requirements_gcs_uri = 3 [(google.api.field_behavior) = OPTIONAL];
45
46    // Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11.
47    // If not specified, default value is 3.10.
48    string python_version = 4 [(google.api.field_behavior) = OPTIONAL];
49  }
50
51  // Required. User provided package spec of the ReasoningEngine.
52  PackageSpec package_spec = 2 [(google.api.field_behavior) = REQUIRED];
53
54  // Optional. Declarations for object class methods.
55  repeated google.protobuf.Struct class_methods = 3
56      [(google.api.field_behavior) = OPTIONAL];
57}
58
59// ReasoningEngine provides a customizable runtime for models to determine
60// which actions to take and in which order.
61message ReasoningEngine {
62  option (google.api.resource) = {
63    type: "aiplatform.googleapis.com/ReasoningEngine"
64    pattern: "projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}"
65    plural: "reasoningEngines"
66    singular: "reasoningEngine"
67  };
68
69  // Identifier. The resource name of the ReasoningEngine.
70  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
71
72  // Required. The display name of the ReasoningEngine.
73  string display_name = 2 [(google.api.field_behavior) = REQUIRED];
74
75  // Optional. The description of the ReasoningEngine.
76  string description = 7 [(google.api.field_behavior) = OPTIONAL];
77
78  // Required. Configurations of the ReasoningEngine
79  ReasoningEngineSpec spec = 3 [(google.api.field_behavior) = REQUIRED];
80
81  // Output only. Timestamp when this ReasoningEngine was created.
82  google.protobuf.Timestamp create_time = 4
83      [(google.api.field_behavior) = OUTPUT_ONLY];
84
85  // Output only. Timestamp when this ReasoningEngine was most recently updated.
86  google.protobuf.Timestamp update_time = 5
87      [(google.api.field_behavior) = OUTPUT_ONLY];
88
89  // Optional. Used to perform consistent read-modify-write updates. If not set,
90  // a blind "overwrite" update happens.
91  string etag = 6 [(google.api.field_behavior) = OPTIONAL];
92}
93