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/annotations.proto"; 20import "google/api/client.proto"; 21import "google/api/field_behavior.proto"; 22import "google/api/resource.proto"; 23import "google/protobuf/struct.proto"; 24 25option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1"; 26option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb"; 27option java_multiple_files = true; 28option java_outer_classname = "ReasoningEngineExecutionServiceProto"; 29option java_package = "com.google.cloud.aiplatform.v1beta1"; 30option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1"; 31option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; 32 33// A service for executing queries on Reasoning Engine. 34service ReasoningEngineExecutionService { 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 // Queries using a reasoning engine. 40 rpc QueryReasoningEngine(QueryReasoningEngineRequest) 41 returns (QueryReasoningEngineResponse) { 42 option (google.api.http) = { 43 post: "/v1beta1/{name=projects/*/locations/*/reasoningEngines/*}:query" 44 body: "*" 45 }; 46 } 47} 48 49// Request message for [ReasoningEngineExecutionService.Query][]. 50message QueryReasoningEngineRequest { 51 // Required. The name of the ReasoningEngine resource to use. 52 // Format: 53 // `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` 54 string name = 1 [ 55 (google.api.field_behavior) = REQUIRED, 56 (google.api.resource_reference) = { 57 type: "aiplatform.googleapis.com/ReasoningEngine" 58 } 59 ]; 60 61 // Optional. Input content provided by users in JSON object format. Examples 62 // include text query, function calling parameters, media bytes, etc. 63 google.protobuf.Struct input = 2 [(google.api.field_behavior) = OPTIONAL]; 64} 65 66// Response message for [ReasoningEngineExecutionService.Query][] 67message QueryReasoningEngineResponse { 68 // Response provided by users in JSON object format. 69 google.protobuf.Value output = 1; 70} 71