feat: add json schema support to structured output and function declaration

Google APIs · copybara-github · commit 50febc78945b · 2025-05-30T17:21:21.000-07:00
PiperOrigin-RevId: 765394859
diff --git a/google/cloud/aiplatform/v1/content.proto b/google/cloud/aiplatform/v1/content.proto
@@ -21,6 +21,7 @@ import "google/cloud/aiplatform/v1/openapi.proto";
 import "google/cloud/aiplatform/v1/tool.proto";
 import "google/cloud/aiplatform/v1/vertex_rag_data.proto";
 import "google/protobuf/duration.proto";
+import "google/protobuf/struct.proto";
 import "google/type/date.proto";
 
 option csharp_namespace = "Google.Cloud.AIPlatform.V1";
@@ -281,6 +282,45 @@ message GenerationConfig {
   // `application/json`: Schema for JSON response.
   optional Schema response_schema = 16 [(google.api.field_behavior) = OPTIONAL];
 
+  // Optional. Output schema of the generated response. This is an alternative
+  // to `response_schema` that accepts [JSON Schema](https://json-schema.org/).
+  //
+  // If set, `response_schema` must be omitted, but `response_mime_type` is
+  // required.
+  //
+  // While the full JSON Schema may be sent, not all features are supported.
+  // Specifically, only the following properties are supported:
+  //
+  // - `$id`
+  // - `$defs`
+  // - `$ref`
+  // - `$anchor`
+  // - `type`
+  // - `format`
+  // - `title`
+  // - `description`
+  // - `enum` (for strings and numbers)
+  // - `items`
+  // - `prefixItems`
+  // - `minItems`
+  // - `maxItems`
+  // - `minimum`
+  // - `maximum`
+  // - `anyOf`
+  // - `oneOf` (interpreted the same as `anyOf`)
+  // - `properties`
+  // - `additionalProperties`
+  // - `required`
+  //
+  // The non-standard `propertyOrdering` property may also be set.
+  //
+  // Cyclic references are unrolled to a limited degree and, as such, may only
+  // be used within non-required properties. (Nullable properties are not
+  // sufficient.) If `$ref` is set on a sub-schema, no other properties, except
+  // for than those starting as a `$`, may be set.
+  optional google.protobuf.Value response_json_schema = 28
+      [(google.api.field_behavior) = OPTIONAL];
+
   // Optional. Routing configuration.
   optional RoutingConfig routing_config = 17
       [(google.api.field_behavior) = OPTIONAL];
diff --git a/google/cloud/aiplatform/v1/tool.proto b/google/cloud/aiplatform/v1/tool.proto
@@ -124,10 +124,38 @@ message FunctionDeclaration {
   //  - param1
   Schema parameters = 3 [(google.api.field_behavior) = OPTIONAL];
 
+  // Optional. Describes the parameters to the function in JSON Schema format.
+  // The schema must describe an object where the properties are the parameters
+  // to the function. For example:
+  //
+  // ```
+  // {
+  //   "type": "object",
+  //   "properties": {
+  //     "name": { "type": "string" },
+  //     "age": { "type": "integer" }
+  //   },
+  //   "additionalProperties": false,
+  //   "required": ["name", "age"],
+  //   "propertyOrdering": ["name", "age"]
+  // }
+  // ```
+  //
+  // This field is mutually exclusive with `parameters`.
+  google.protobuf.Value parameters_json_schema = 5
+      [(google.api.field_behavior) = OPTIONAL];
+
   // Optional. Describes the output from this function in JSON Schema format.
   // Reflects the Open API 3.03 Response Object. The Schema defines the type
   // used for the response value of the function.
   Schema response = 4 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Describes the output from this function in JSON Schema format.
+  // The value specified by the schema is the response value of the function.
+  //
+  // This field is mutually exclusive with `response`.
+  google.protobuf.Value response_json_schema = 6
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // A predicted [FunctionCall] returned from the model that contains a string
