feat: add streaming function call argument API changes

Google APIs · copybara-github · commit effe5c4fa816 · 2025-12-09T22:43:37.000-08:00
docs: A comment for field `name` in message `.google.cloud.aiplatform.v1.FunctionCall` is changed
docs: A comment for field `args` in message `.google.cloud.aiplatform.v1.FunctionCall` is changed

PiperOrigin-RevId: 842549490
diff --git a/google/cloud/aiplatform/v1/tool.proto b/google/cloud/aiplatform/v1/tool.proto
@@ -234,13 +234,51 @@ message FunctionDeclaration {
 // representing the [FunctionDeclaration.name] and a structured JSON object
 // containing the parameters and their values.
 message FunctionCall {
-  // Required. The name of the function to call.
+  // Optional. The name of the function to call.
   // Matches [FunctionDeclaration.name].
-  string name = 1 [(google.api.field_behavior) = REQUIRED];
+  string name = 1 [(google.api.field_behavior) = OPTIONAL];
 
-  // Optional. Required. The function parameters and values in JSON object
-  // format. See [FunctionDeclaration.parameters] for parameter details.
+  // Optional. The function parameters and values in JSON object format.
+  // See [FunctionDeclaration.parameters] for parameter details.
   google.protobuf.Struct args = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The partial argument value of the function call.
+  // If provided, represents the arguments/fields that are streamed
+  // incrementally.
+  repeated PartialArg partial_args = 4 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Whether this is the last part of the FunctionCall.
+  // If true, another partial message for the current FunctionCall is expected
+  // to follow.
+  bool will_continue = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Partial argument value of the function call.
+message PartialArg {
+  // The delta of field value being streamed.
+  oneof delta {
+    // Optional. Represents a null value.
+    google.protobuf.NullValue null_value = 2
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Represents a double value.
+    double number_value = 3 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Represents a string value.
+    string string_value = 4 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Represents a boolean value.
+    bool bool_value = 5 [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Required. A JSON Path (RFC 9535) to the argument being streamed.
+  // https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".
+  string json_path = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Optional. Whether this is not the last part of the same json_path.
+  // If true, another PartialArg message for the current json_path is expected
+  // to follow.
+  bool will_continue = 6 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // A datatype containing media that is part of a `FunctionResponse` message.
@@ -558,6 +596,12 @@ message FunctionCallingConfig {
   // will predict a function call from the set of function names provided.
   repeated string allowed_function_names = 2
       [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. When set to true, arguments of a single function call will be
+  // streamed out in multiple parts/contents/responses. Partial parameter
+  // results will be returned in the [FunctionCall.partial_args] field.
+  bool stream_function_call_arguments = 4
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Retrieval config.
