feat: add support for additional reasons to stop image generation

Google APIs · copybara-github · commit f495b4597a94 · 2025-10-15T10:47:24.000-07:00
feat: add support for finish_message that contain details the reason why the model stopped generating tokens
feat: add URL_RETRIEVAL_STATUS_UNSAFE and URL_RETRIEVAL_STATUS_PAYWALL statuses for url retrieval
feat: add log_probability_sum
docs: deprecation notice for HarmCategory.HARM_CATEGORY_CIVIC_INTEGRITY

PiperOrigin-RevId: 819823490
diff --git a/google/ai/generativelanguage/v1/BUILD.bazel b/google/ai/generativelanguage/v1/BUILD.bazel
@@ -40,6 +40,7 @@ proto_library(
         "//google/type:interval_proto",
         "//google/type:latlng_proto",
         "@com_google_protobuf//:duration_proto",
+        "@com_google_protobuf//:struct_proto",
     ],
 )
 
diff --git a/google/ai/generativelanguage/v1/generative_service.proto b/google/ai/generativelanguage/v1/generative_service.proto
@@ -23,6 +23,7 @@ import "google/api/annotations.proto";
 import "google/api/client.proto";
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
+import "google/protobuf/struct.proto";
 
 option go_package = "cloud.google.com/go/ai/generativelanguage/apiv1/generativelanguagepb;generativelanguagepb";
 option java_multiple_files = true;
@@ -144,6 +145,7 @@ enum TaskType {
 }
 
 // Request to generate a completion from the model.
+// NEXT ID: 18
 message GenerateContentRequest {
   // Required. The name of the `Model` to use for generating the completion.
   //
@@ -190,6 +192,7 @@ message GenerateContentRequest {
 
 // Configuration options for model generation and outputs. Not all parameters
 // are configurable for every model.
+// Next ID: 29
 message GenerationConfig {
   // Optional. Number of generated responses to return. If unset, this will
   // default to 1. Please note that this doesn't work for previous generation
@@ -248,6 +251,11 @@ message GenerationConfig {
   // generated seed.
   optional int32 seed = 8 [(google.api.field_behavior) = OPTIONAL];
 
+  // Optional. An internal detail. Use `responseJsonSchema` rather than this
+  // field.
+  google.protobuf.Value response_json_schema_ordered = 28
+      [(google.api.field_behavior) = OPTIONAL];
+
   // Optional. Presence penalty applied to the next token's logprobs if the
   // token has already been seen in the response.
   //
@@ -289,6 +297,7 @@ message GenerationConfig {
   // [response_logprobs=True][google.ai.generativelanguage.v1.GenerationConfig.response_logprobs].
   // This sets the number of top logprobs to return at each decoding step in the
   // [Candidate.logprobs_result][google.ai.generativelanguage.v1.Candidate.logprobs_result].
+  // The number must be in the range of [0, 20].
   optional int32 logprobs = 18 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. Enables enhanced civic answers. It may not be available for all
@@ -442,8 +451,22 @@ message Candidate {
     // violations.
     IMAGE_SAFETY = 11;
 
+    // Image generation stopped because generated images has other prohibited
+    // content.
+    IMAGE_PROHIBITED_CONTENT = 14;
+
+    // Image generation stopped because of other miscellaneous issue.
+    IMAGE_OTHER = 15;
+
+    // The model was expected to generate an image, but none was generated.
+    NO_IMAGE = 16;
+
     // Model generated a tool call but no tools were enabled in the request.
     UNEXPECTED_TOOL_CALL = 12;
+
+    // Model called too many tools consecutively, thus the system exited
+    // execution.
+    TOO_MANY_TOOL_CALLS = 13;
   }
 
   // Output only. Index of the candidate in the list of response candidates.
@@ -460,6 +483,13 @@ message Candidate {
     (google.api.field_behavior) = OUTPUT_ONLY
   ];
 
+  // Optional. Output only. Details the reason why the model stopped generating
+  // tokens. This is populated only when `finish_reason` is set.
+  optional string finish_message = 4 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.field_behavior) = OUTPUT_ONLY
+  ];
+
   // List of ratings for the safety of a response candidate.
   //
   // There is at most one rating per category.
@@ -512,6 +542,12 @@ message UrlMetadata {
 
     // Url retrieval is failed due to error.
     URL_RETRIEVAL_STATUS_ERROR = 2;
+
+    // Url retrieval is failed because the content is behind paywall.
+    URL_RETRIEVAL_STATUS_PAYWALL = 3;
+
+    // Url retrieval is failed because the content is unsafe.
+    URL_RETRIEVAL_STATUS_UNSAFE = 4;
   }
 
   // Retrieved url by the tool.
@@ -541,6 +577,9 @@ message LogprobsResult {
     repeated Candidate candidates = 1;
   }
 
+  // Sum of log probabilities for all tokens.
+  optional float log_probability_sum = 3;
+
   // Length = total number of decoding steps.
   repeated TopCandidates top_candidates = 1;
 
diff --git a/google/ai/generativelanguage/v1/generativelanguage_v1.yaml b/google/ai/generativelanguage/v1/generativelanguage_v1.yaml
@@ -36,6 +36,8 @@ http:
     - get: '/v1/{name=batches/*}'
     - get: '/v1/{name=models/*/operations/*}'
     - get: '/v1/{name=corpora/*/operations/*}'
+    - get: '/v1/{name=ragStores/*/operations/*}'
+    - get: '/v1/{name=ragStores/*/upload/operations/*}'
   - selector: google.longrunning.Operations.ListOperations
     get: '/v1/{name=operations}'
     additional_bindings:
diff --git a/google/ai/generativelanguage/v1/safety.proto b/google/ai/generativelanguage/v1/safety.proto
@@ -65,7 +65,8 @@ enum HarmCategory {
   HARM_CATEGORY_DANGEROUS_CONTENT = 10;
 
   // **Gemini** - Content that may be used to harm civic integrity.
-  HARM_CATEGORY_CIVIC_INTEGRITY = 11;
+  // DEPRECATED: use enable_enhanced_civic_answers instead.
+  HARM_CATEGORY_CIVIC_INTEGRITY = 11 [deprecated = true];
 }
 
 // Safety rating for a piece of content.

Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,7 @@ proto_library(`
`40`	`40`	`"//google/type:interval_proto",`
`41`	`41`	`"//google/type:latlng_proto",`
`42`	`42`	`"@com_google_protobuf//:duration_proto",`
	`43`	`+ "@com_google_protobuf//:struct_proto",`
`43`	`44`	`],`
`44`	`45`	`)`
`45`	`46`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,8 @@ enum HarmCategory {`
`65`	`65`	`HARM_CATEGORY_DANGEROUS_CONTENT = 10;`
`66`	`66`
`67`	`67`	`// Gemini - Content that may be used to harm civic integrity.`
`68`		`- HARM_CATEGORY_CIVIC_INTEGRITY = 11;`
	`68`	`+ // DEPRECATED: use enable_enhanced_civic_answers instead.`
	`69`	`+ HARM_CATEGORY_CIVIC_INTEGRITY = 11 [deprecated = true];`
`69`	`70`	`}`
`70`	`71`
`71`	`72`	`// Safety rating for a piece of content.`