// Copyright 2026 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

syntax = "proto3";

package google.cloud.aiplatform.v1;

import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/aiplatform/v1/encryption_spec.proto";
import "google/cloud/aiplatform/v1/env_var.proto";
import "google/cloud/aiplatform/v1/service_networking.proto";
import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1";
option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ReasoningEngineProto";
option java_package = "com.google.cloud.aiplatform.v1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1";
option ruby_package = "Google::Cloud::AIPlatform::V1";
option (google.api.resource_definition) = {
  type: "developerconnect.googleapis.com/GitRepositoryLink"
  pattern: "projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{git_repository_link}"
};

// ReasoningEngine configurations
message ReasoningEngineSpec {
  // User-provided package specification, containing pickled object and package
  // requirements.
  message PackageSpec {
    // Optional. The Cloud Storage URI of the pickled python object.
    string pickle_object_gcs_uri = 1 [(google.api.field_behavior) = OPTIONAL];

    // Optional. The Cloud Storage URI of the dependency files in tar.gz format.
    string dependency_files_gcs_uri = 2
        [(google.api.field_behavior) = OPTIONAL];

    // Optional. The Cloud Storage URI of the `requirements.txt` file
    string requirements_gcs_uri = 3 [(google.api.field_behavior) = OPTIONAL];

    // Optional. The Python version. Supported values
    // are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value
    // is 3.10.
    string python_version = 4 [(google.api.field_behavior) = OPTIONAL];
  }

  // The specification of a Reasoning Engine deployment.
  message DeploymentSpec {
    // Optional. Environment variables to be set with the Reasoning Engine
    // deployment. The environment variables can be updated through the
    // UpdateReasoningEngine API.
    repeated EnvVar env = 1 [(google.api.field_behavior) = OPTIONAL];

    // Optional. Environment variables where the value is a secret in Cloud
    // Secret Manager.
    // To use this feature, add 'Secret Manager Secret Accessor' role
    // (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine
    // Service Agent.
    repeated SecretEnvVar secret_env = 2
        [(google.api.field_behavior) = OPTIONAL];

    // Optional. Configuration for PSC-I.
    PscInterfaceConfig psc_interface_config = 4
        [(google.api.field_behavior) = OPTIONAL];

    // Optional. The minimum number of application instances that will be kept
    // running at all times. Defaults to 1. Range: [0, 10].
    optional int32 min_instances = 5 [(google.api.field_behavior) = OPTIONAL];

    // Optional. The maximum number of application instances that can be
    // launched to handle increased traffic. Defaults to 100. Range: [1, 1000].
    //
    // If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100].
    optional int32 max_instances = 6 [(google.api.field_behavior) = OPTIONAL];

    // Optional. Resource limits for each container. Only 'cpu' and 'memory'
    // keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}.
    //
    //   * The only supported values for CPU are '1', '2', '4', '6' and '8'. For
    //   more information, go to
    //   https://cloud.google.com/run/docs/configuring/cpu.
    //   * The only supported values for memory are '1Gi', '2Gi', ... '32 Gi'.
    //   * For required cpu on different memory values, go to
    //   https://cloud.google.com/run/docs/configuring/memory-limits
    map<string, string> resource_limits = 7
        [(google.api.field_behavior) = OPTIONAL];

    // Optional. Concurrency for each container and agent server. Recommended
    // value: 2 * cpu + 1. Defaults to 9.
    optional int32 container_concurrency = 8
        [(google.api.field_behavior) = OPTIONAL];
  }

  // Specification for deploying from source code.
  message SourceCodeSpec {
    // Specifies source code provided as a byte stream.
    message InlineSource {
      // Required. Input only. The application source code archive, provided as
      // a compressed tarball (.tar.gz) file.
      bytes source_archive = 1 [
        (google.api.field_behavior) = REQUIRED,
        (google.api.field_behavior) = INPUT_ONLY
      ];
    }

    // The image spec for building an image (within a single build step), based
    // on the config file (i.e. Dockerfile) in the source directory.
    message ImageSpec {
      // Optional. Build arguments to be used. They will be passed through
      // --build-arg flags.
      map<string, string> build_args = 1
          [(google.api.field_behavior) = OPTIONAL];
    }

    // Specifies the configuration for fetching source code from a Git
    // repository that is managed by Developer Connect. This includes the
    // repository, revision, and directory to use.
    message DeveloperConnectConfig {
      // Required. The Developer Connect Git repository link, formatted as
      // `projects/*/locations/*/connections/*/gitRepositoryLink/*`.
      string git_repository_link = 1 [
        (google.api.field_behavior) = REQUIRED,
        (google.api.resource_reference) = {
          type: "developerconnect.googleapis.com/GitRepositoryLink"
        }
      ];

      // Required. Directory, relative to the source root, in which to run the
      // build.
      string dir = 2 [(google.api.field_behavior) = REQUIRED];

      // Required. The revision to fetch from the Git repository such as a
      // branch, a tag, a commit SHA, or any Git ref.
      string revision = 3 [(google.api.field_behavior) = REQUIRED];
    }

    // Specifies source code to be fetched from a Git repository managed through
    // the Developer Connect service.
    message DeveloperConnectSource {
      // Required. The Developer Connect configuration that defines the
      // specific repository, revision, and directory to use as the source code
      // root.
      DeveloperConnectConfig config = 1
          [(google.api.field_behavior) = REQUIRED];
    }

    // Specification for running a Python application from source.
    message PythonSpec {
      // Optional. The version of Python to use. Support version
      // includes 3.9, 3.10, 3.11, 3.12, 3.13.
      // If not specified, default value is 3.10.
      string version = 1 [(google.api.field_behavior) = OPTIONAL];

      // Optional. The Python module to load as the entrypoint, specified as a
      // fully qualified module name. For example: path.to.agent.
      // If not specified, defaults to "agent".
      //
      // The project root will be added to Python sys.path, allowing imports
      // to be specified relative to the root.
      string entrypoint_module = 2 [(google.api.field_behavior) = OPTIONAL];

      // Optional. The name of the callable object within the
      // `entrypoint_module` to use as the application If not specified,
      // defaults to "root_agent".
      string entrypoint_object = 3 [(google.api.field_behavior) = OPTIONAL];

      // Optional. The path to the requirements file, relative to the source
      // root. If not specified, defaults to "requirements.txt".
      string requirements_file = 4 [(google.api.field_behavior) = OPTIONAL];
    }

    // Specifies where the source code is located.
    oneof source {
      // Source code is provided directly in the request.
      InlineSource inline_source = 1;

      // Source code is in a Git repository managed by Developer Connect.
      DeveloperConnectSource developer_connect_source = 3;
    }

    // Specifies the language-specific configuration for building and running
    // the code.
    oneof language_spec {
      // Configuration for a Python application.
      PythonSpec python_spec = 2;

      // Optional. Configuration for building an image with custom config file.
      ImageSpec image_spec = 5 [(google.api.field_behavior) = OPTIONAL];
    }
  }

  // Specification for deploying from a container image.
  message ContainerSpec {
    // Required. The Artifact Registry Docker image URI (e.g.,
    // us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the
    // container image that is to be run on each worker replica.
    string image_uri = 1 [(google.api.field_behavior) = REQUIRED];
  }

  // Defines the source for the deployment.
  // The `package_spec` field should not be set if `deployment_source` is
  // specified.
  oneof deployment_source {
    // Deploy from source code files with a defined entrypoint.
    SourceCodeSpec source_code_spec = 11;

    // Deploy from a container image with a defined entrypoint and commands.
    ContainerSpec container_spec = 15;
  }

  // Optional. The service account that the Reasoning Engine artifact runs as.
  // It should have "roles/storage.objectViewer" for reading the user project's
  // Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If
  // not specified, the Vertex AI Reasoning Engine Service Agent in the project
  // will be used.
  optional string service_account = 1 [(google.api.field_behavior) = OPTIONAL];

  // Optional. User provided package spec of the ReasoningEngine.
  // Ignored when users directly specify a deployment image through
  // `deployment_spec.first_party_image_override`, but keeping the
  // field_behavior to avoid introducing breaking changes.
  // The `deployment_source` field should not be set if `package_spec` is
  // specified.
  PackageSpec package_spec = 2 [(google.api.field_behavior) = OPTIONAL];

  // Optional. The specification of a Reasoning Engine deployment.
  DeploymentSpec deployment_spec = 4 [(google.api.field_behavior) = OPTIONAL];

  // Optional. Declarations for object class methods in OpenAPI specification
  // format.
  repeated google.protobuf.Struct class_methods = 3
      [(google.api.field_behavior) = OPTIONAL];

  // Optional. The OSS agent framework used to develop the agent.
  // Currently supported values: "google-adk", "langchain", "langgraph", "ag2",
  // "llama-index", "custom".
  string agent_framework = 5 [(google.api.field_behavior) = OPTIONAL];
}

// ReasoningEngine provides a customizable runtime for models to determine
// which actions to take and in which order.
message ReasoningEngine {
  option (google.api.resource) = {
    type: "aiplatform.googleapis.com/ReasoningEngine"
    pattern: "projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}"
    plural: "reasoningEngines"
    singular: "reasoningEngine"
  };

  // Identifier. The resource name of the ReasoningEngine.
  // Format:
  // `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
  string name = 1 [(google.api.field_behavior) = IDENTIFIER];

  // Required. The display name of the ReasoningEngine.
  string display_name = 2 [(google.api.field_behavior) = REQUIRED];

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

  // Optional. Configurations of the ReasoningEngine
  ReasoningEngineSpec spec = 3 [(google.api.field_behavior) = OPTIONAL];

  // Output only. Timestamp when this ReasoningEngine was created.
  google.protobuf.Timestamp create_time = 4
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. Timestamp when this ReasoningEngine was most recently updated.
  google.protobuf.Timestamp update_time = 5
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Optional. Used to perform consistent read-modify-write updates. If not set,
  // a blind "overwrite" update happens.
  string etag = 6 [(google.api.field_behavior) = OPTIONAL];

  // Customer-managed encryption key spec for a ReasoningEngine. If set, this
  // ReasoningEngine and all sub-resources of this ReasoningEngine will be
  // secured by this key.
  EncryptionSpec encryption_spec = 11;

  // Labels for the ReasoningEngine.
  map<string, string> labels = 17;
}