feat: voice consent signature types across all SDK languages.

MarkDaoust · copybara-github · commit 5de221468bba · 2026-03-25T07:13:08.000-07:00
Most languages capture the "setup complete" message as a property on the session object. Golang returns the setup complete to the user as the first message. So there's no need to capture it, and that would be a breaking change.

PiperOrigin-RevId: 885814555
diff --git a/src/main/java/com/google/genai/AsyncLive.java b/src/main/java/com/google/genai/AsyncLive.java
@@ -25,6 +25,7 @@
 import com.google.genai.types.LiveConnectConfig;
 import com.google.genai.types.LiveConnectParameters;
 import com.google.genai.types.LiveServerMessage;
+import com.google.genai.types.LiveServerSetupComplete;
 import java.io.IOException;
 import java.net.URI;
 import java.net.URISyntaxException;
@@ -283,11 +284,13 @@ private void handleIncomingMessage(String message) {
         try {
           LiveServerMessage initialResponse = LiveServerMessage.fromJson(message);
           if (initialResponse.setupComplete().isPresent()) {
+            LiveServerSetupComplete setupComplete = initialResponse.setupComplete().get();
             sessionFuture.complete(
                 new AsyncSession(
                     apiClient,
                     this,
-                    initialResponse.setupComplete().get().sessionId().orElse(null)));
+                    setupComplete.sessionId().orElse(null),
+                    setupComplete));
           } else {
             sessionFuture.completeExceptionally(
                 new GenAiIOException(
diff --git a/src/main/java/com/google/genai/AsyncSession.java b/src/main/java/com/google/genai/AsyncSession.java
@@ -21,6 +21,7 @@
 import com.google.genai.types.LiveClientContent;
 import com.google.genai.types.LiveClientMessage;
 import com.google.genai.types.LiveClientToolResponse;
+import com.google.genai.types.LiveServerSetupComplete;
 import com.google.genai.types.LiveSendClientContentParameters;
 import com.google.genai.types.LiveSendRealtimeInputParameters;
 import com.google.genai.types.LiveSendToolResponseParameters;
@@ -40,11 +41,17 @@ public final class AsyncSession {
 
   private final AsyncLive.GenAiWebSocketClient websocket;
   final String sessionId;
+  private final LiveServerSetupComplete setupComplete;
 
-  AsyncSession(ApiClient apiClient, AsyncLive.GenAiWebSocketClient websocket, String sessionId) {
+  AsyncSession(
+      ApiClient apiClient,
+      AsyncLive.GenAiWebSocketClient websocket,
+      String sessionId,
+      LiveServerSetupComplete setupComplete) {
     this.apiClient = apiClient;
     this.websocket = websocket;
     this.sessionId = sessionId;
+    this.setupComplete = setupComplete;
   }
 
   /**
@@ -145,4 +152,8 @@ public CompletableFuture<Void> close() {
   public String sessionId() {
     return sessionId;
   }
+
+  public LiveServerSetupComplete setupComplete() {
+    return setupComplete;
+  }
 }
diff --git a/src/main/java/com/google/genai/LiveConverters.java b/src/main/java/com/google/genai/LiveConverters.java
@@ -1828,6 +1828,15 @@ ObjectNode replicatedVoiceConfigToVertex(JsonNode fromObject, ObjectNode parentO
           Common.getValueByPath(fromObject, new String[] {"voiceSampleAudio"}));
     }
 
+    if (!Common.isZero(Common.getValueByPath(fromObject, new String[] {"consentAudio"}))) {
+      throw new IllegalArgumentException("consentAudio parameter is not supported in Vertex AI.");
+    }
+
+    if (!Common.isZero(Common.getValueByPath(fromObject, new String[] {"voiceConsentSignature"}))) {
+      throw new IllegalArgumentException(
+          "voiceConsentSignature parameter is not supported in Vertex AI.");
+    }
+
     return toObject;
   }
 
diff --git a/src/main/java/com/google/genai/Models.java b/src/main/java/com/google/genai/Models.java
@@ -4539,6 +4539,15 @@ ObjectNode replicatedVoiceConfigToVertex(
           Common.getValueByPath(fromObject, new String[] {"voiceSampleAudio"}));
     }
 
+    if (!Common.isZero(Common.getValueByPath(fromObject, new String[] {"consentAudio"}))) {
+      throw new IllegalArgumentException("consentAudio parameter is not supported in Vertex AI.");
+    }
+
+    if (!Common.isZero(Common.getValueByPath(fromObject, new String[] {"voiceConsentSignature"}))) {
+      throw new IllegalArgumentException(
+          "voiceConsentSignature parameter is not supported in Vertex AI.");
+    }
+
     return toObject;
   }
 
diff --git a/src/main/java/com/google/genai/Tunings.java b/src/main/java/com/google/genai/Tunings.java
@@ -1257,6 +1257,15 @@ ObjectNode replicatedVoiceConfigToVertex(
           Common.getValueByPath(fromObject, new String[] {"voiceSampleAudio"}));
     }
 
+    if (!Common.isZero(Common.getValueByPath(fromObject, new String[] {"consentAudio"}))) {
+      throw new IllegalArgumentException("consentAudio parameter is not supported in Vertex AI.");
+    }
+
+    if (!Common.isZero(Common.getValueByPath(fromObject, new String[] {"voiceConsentSignature"}))) {
+      throw new IllegalArgumentException(
+          "voiceConsentSignature parameter is not supported in Vertex AI.");
+    }
+
     return toObject;
   }
 
diff --git a/src/main/java/com/google/genai/types/LiveServerSetupComplete.java b/src/main/java/com/google/genai/types/LiveServerSetupComplete.java
@@ -34,6 +34,14 @@ public abstract class LiveServerSetupComplete extends JsonSerializable {
   @JsonProperty("sessionId")
   public abstract Optional<String> sessionId();
 
+  /**
+   * Signature of the verified consent audio. This is populated when the request has a
+   * ReplicatedVoiceConfig with consent_audio set, if the consent verification was successful. This
+   * may be used in a subsequent request instead of the consent_audio to verify the same consent.
+   */
+  @JsonProperty("voiceConsentSignature")
+  public abstract Optional<VoiceConsentSignature> voiceConsentSignature();
+
   /** Instantiates a builder for LiveServerSetupComplete. */
   @ExcludeFromGeneratedCoverageReport
   public static Builder builder() {
@@ -70,6 +78,41 @@ public Builder clearSessionId() {
       return sessionId(Optional.empty());
     }
 
+    /**
+     * Setter for voiceConsentSignature.
+     *
+     * <p>voiceConsentSignature: Signature of the verified consent audio. This is populated when the
+     * request has a ReplicatedVoiceConfig with consent_audio set, if the consent verification was
+     * successful. This may be used in a subsequent request instead of the consent_audio to verify
+     * the same consent.
+     */
+    @JsonProperty("voiceConsentSignature")
+    public abstract Builder voiceConsentSignature(VoiceConsentSignature voiceConsentSignature);
+
+    /**
+     * Setter for voiceConsentSignature builder.
+     *
+     * <p>voiceConsentSignature: Signature of the verified consent audio. This is populated when the
+     * request has a ReplicatedVoiceConfig with consent_audio set, if the consent verification was
+     * successful. This may be used in a subsequent request instead of the consent_audio to verify
+     * the same consent.
+     */
+    @CanIgnoreReturnValue
+    public Builder voiceConsentSignature(
+        VoiceConsentSignature.Builder voiceConsentSignatureBuilder) {
+      return voiceConsentSignature(voiceConsentSignatureBuilder.build());
+    }
+
+    @ExcludeFromGeneratedCoverageReport
+    abstract Builder voiceConsentSignature(Optional<VoiceConsentSignature> voiceConsentSignature);
+
+    /** Clears the value of voiceConsentSignature field. */
+    @ExcludeFromGeneratedCoverageReport
+    @CanIgnoreReturnValue
+    public Builder clearVoiceConsentSignature() {
+      return voiceConsentSignature(Optional.empty());
+    }
+
     public abstract LiveServerSetupComplete build();
   }
 
diff --git a/src/main/java/com/google/genai/types/ReplicatedVoiceConfig.java b/src/main/java/com/google/genai/types/ReplicatedVoiceConfig.java
@@ -41,6 +41,22 @@ public abstract class ReplicatedVoiceConfig extends JsonSerializable {
   @JsonProperty("voiceSampleAudio")
   public abstract Optional<byte[]> voiceSampleAudio();
 
+  /**
+   * Recorded consent verifying ownership of the voice. This represents 16-bit signed little-endian
+   * wav data, with a 24kHz sampling rate.
+   */
+  @JsonProperty("consentAudio")
+  public abstract Optional<byte[]> consentAudio();
+
+  /**
+   * Signature of a previously verified consent audio. This should be populated with a signature
+   * generated by the server for a previous request containing the consent_audio field. When
+   * provided, the signature is verified instead of the consent_audio field to reduce latency.
+   * Requests will fail if the signature is invalid or expired.
+   */
+  @JsonProperty("voiceConsentSignature")
+  public abstract Optional<VoiceConsentSignature> voiceConsentSignature();
+
   /** Instantiates a builder for ReplicatedVoiceConfig. */
   @ExcludeFromGeneratedCoverageReport
   public static Builder builder() {
@@ -97,6 +113,60 @@ public Builder clearVoiceSampleAudio() {
       return voiceSampleAudio(Optional.empty());
     }
 
+    /**
+     * Setter for consentAudio.
+     *
+     * <p>consentAudio: Recorded consent verifying ownership of the voice. This represents 16-bit
+     * signed little-endian wav data, with a 24kHz sampling rate.
+     */
+    @JsonProperty("consentAudio")
+    public abstract Builder consentAudio(byte[] consentAudio);
+
+    @ExcludeFromGeneratedCoverageReport
+    abstract Builder consentAudio(Optional<byte[]> consentAudio);
+
+    /** Clears the value of consentAudio field. */
+    @ExcludeFromGeneratedCoverageReport
+    @CanIgnoreReturnValue
+    public Builder clearConsentAudio() {
+      return consentAudio(Optional.empty());
+    }
+
+    /**
+     * Setter for voiceConsentSignature.
+     *
+     * <p>voiceConsentSignature: Signature of a previously verified consent audio. This should be
+     * populated with a signature generated by the server for a previous request containing the
+     * consent_audio field. When provided, the signature is verified instead of the consent_audio
+     * field to reduce latency. Requests will fail if the signature is invalid or expired.
+     */
+    @JsonProperty("voiceConsentSignature")
+    public abstract Builder voiceConsentSignature(VoiceConsentSignature voiceConsentSignature);
+
+    /**
+     * Setter for voiceConsentSignature builder.
+     *
+     * <p>voiceConsentSignature: Signature of a previously verified consent audio. This should be
+     * populated with a signature generated by the server for a previous request containing the
+     * consent_audio field. When provided, the signature is verified instead of the consent_audio
+     * field to reduce latency. Requests will fail if the signature is invalid or expired.
+     */
+    @CanIgnoreReturnValue
+    public Builder voiceConsentSignature(
+        VoiceConsentSignature.Builder voiceConsentSignatureBuilder) {
+      return voiceConsentSignature(voiceConsentSignatureBuilder.build());
+    }
+
+    @ExcludeFromGeneratedCoverageReport
+    abstract Builder voiceConsentSignature(Optional<VoiceConsentSignature> voiceConsentSignature);
+
+    /** Clears the value of voiceConsentSignature field. */
+    @ExcludeFromGeneratedCoverageReport
+    @CanIgnoreReturnValue
+    public Builder clearVoiceConsentSignature() {
+      return voiceConsentSignature(Optional.empty());
+    }
+
     public abstract ReplicatedVoiceConfig build();
   }
 
diff --git a/src/main/java/com/google/genai/types/VoiceConsentSignature.java b/src/main/java/com/google/genai/types/VoiceConsentSignature.java
@@ -0,0 +1,81 @@
+/*
+ * Copyright 2025 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
+ *
+ *      https://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.
+ */
+
+// Auto-generated code. Do not edit.
+
+package com.google.genai.types;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.google.auto.value.AutoValue;
+import com.google.errorprone.annotations.CanIgnoreReturnValue;
+import com.google.genai.JsonSerializable;
+import java.util.Optional;
+
+/** The signature of the voice consent check. */
+@AutoValue
+@JsonDeserialize(builder = VoiceConsentSignature.Builder.class)
+public abstract class VoiceConsentSignature extends JsonSerializable {
+  /** The signature string. */
+  @JsonProperty("signature")
+  public abstract Optional<String> signature();
+
+  /** Instantiates a builder for VoiceConsentSignature. */
+  @ExcludeFromGeneratedCoverageReport
+  public static Builder builder() {
+    return new AutoValue_VoiceConsentSignature.Builder();
+  }
+
+  /** Creates a builder with the same values as this instance. */
+  public abstract Builder toBuilder();
+
+  /** Builder for VoiceConsentSignature. */
+  @AutoValue.Builder
+  public abstract static class Builder {
+    /** For internal usage. Please use `VoiceConsentSignature.builder()` for instantiation. */
+    @JsonCreator
+    private static Builder create() {
+      return new AutoValue_VoiceConsentSignature.Builder();
+    }
+
+    /**
+     * Setter for signature.
+     *
+     * <p>signature: The signature string.
+     */
+    @JsonProperty("signature")
+    public abstract Builder signature(String signature);
+
+    @ExcludeFromGeneratedCoverageReport
+    abstract Builder signature(Optional<String> signature);
+
+    /** Clears the value of signature field. */
+    @ExcludeFromGeneratedCoverageReport
+    @CanIgnoreReturnValue
+    public Builder clearSignature() {
+      return signature(Optional.empty());
+    }
+
+    public abstract VoiceConsentSignature build();
+  }
+
+  /** Deserializes a JSON string to a VoiceConsentSignature object. */
+  @ExcludeFromGeneratedCoverageReport
+  public static VoiceConsentSignature fromJson(String jsonString) {
+    return JsonSerializable.fromJsonString(jsonString, VoiceConsentSignature.class);
+  }
+}
diff --git a/src/test/java/com/google/genai/AsyncLiveTest.java b/src/test/java/com/google/genai/AsyncLiveTest.java
@@ -26,8 +26,10 @@
 import com.google.genai.types.HttpOptions;
 import java.lang.reflect.Method;
 import java.net.URI;
+import java.util.HashMap;
 import java.util.Map;
 import java.util.Optional;
+import java.util.concurrent.CompletableFuture;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
@@ -118,4 +120,25 @@ public void testGetWebSocketHeaders_GoogleAiEphemeralToken() throws Exception {
 
     assertEquals("Token auth_tokens/ephemeral-token", headers.get("Authorization"));
   }
+  @Test
+  public void testOnMessage_PopulatesSetupCompleteWithVoiceConsent() throws Exception {
+    CompletableFuture<AsyncSession> future = new CompletableFuture<>();
+    URI uri = new URI("wss://test");
+    Map<String, String> headers = new HashMap<>();
+    String setupRequest = "{}";
+
+    AsyncLive.GenAiWebSocketClient client =
+        new AsyncLive.GenAiWebSocketClient(uri, headers, setupRequest, future, apiClient);
+
+    String message =
+        "{\"setupComplete\":{\"voiceConsentSignature\":{\"signature\":\"test_sig\"}}}";
+
+    client.onMessage(message);
+
+    AsyncSession session = future.get();
+    assertTrue(session != null);
+    assertTrue(session.setupComplete() != null);
+    assertTrue(session.setupComplete().voiceConsentSignature().isPresent());
+    assertEquals("test_sig", session.setupComplete().voiceConsentSignature().get().signature().get());
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -1828,6 +1828,15 @@ ObjectNode replicatedVoiceConfigToVertex(JsonNode fromObject, ObjectNode parentO`
`1828`	`1828`	`Common.getValueByPath(fromObject, new String[] {"voiceSampleAudio"}));`
`1829`	`1829`	`}`
`1830`	`1830`
	`1831`	`+ if (!Common.isZero(Common.getValueByPath(fromObject, new String[] {"consentAudio"}))) {`
	`1832`	`+ throw new IllegalArgumentException("consentAudio parameter is not supported in Vertex AI.");`
	`1833`	`+ }`
	`1834`	`+`
	`1835`	`+ if (!Common.isZero(Common.getValueByPath(fromObject, new String[] {"voiceConsentSignature"}))) {`
	`1836`	`+ throw new IllegalArgumentException(`
	`1837`	`+ "voiceConsentSignature parameter is not supported in Vertex AI.");`
	`1838`	`+ }`
	`1839`	`+`
`1831`	`1840`	`return toObject;`
`1832`	`1841`	`}`
`1833`	`1842`
Original file line number	Diff line number	Diff line change
`@@ -4539,6 +4539,15 @@ ObjectNode replicatedVoiceConfigToVertex(`
`4539`	`4539`	`Common.getValueByPath(fromObject, new String[] {"voiceSampleAudio"}));`
`4540`	`4540`	`}`
`4541`	`4541`
	`4542`	`+ if (!Common.isZero(Common.getValueByPath(fromObject, new String[] {"consentAudio"}))) {`
	`4543`	`+ throw new IllegalArgumentException("consentAudio parameter is not supported in Vertex AI.");`
	`4544`	`+ }`
	`4545`	`+`
	`4546`	`+ if (!Common.isZero(Common.getValueByPath(fromObject, new String[] {"voiceConsentSignature"}))) {`
	`4547`	`+ throw new IllegalArgumentException(`
	`4548`	`+ "voiceConsentSignature parameter is not supported in Vertex AI.");`
	`4549`	`+ }`
	`4550`	`+`
`4542`	`4551`	`return toObject;`
`4543`	`4552`	`}`
`4544`	`4553`
Original file line number	Diff line number	Diff line change
`@@ -1257,6 +1257,15 @@ ObjectNode replicatedVoiceConfigToVertex(`
`1257`	`1257`	`Common.getValueByPath(fromObject, new String[] {"voiceSampleAudio"}));`
`1258`	`1258`	`}`
`1259`	`1259`
	`1260`	`+ if (!Common.isZero(Common.getValueByPath(fromObject, new String[] {"consentAudio"}))) {`
	`1261`	`+ throw new IllegalArgumentException("consentAudio parameter is not supported in Vertex AI.");`
	`1262`	`+ }`
	`1263`	`+`
	`1264`	`+ if (!Common.isZero(Common.getValueByPath(fromObject, new String[] {"voiceConsentSignature"}))) {`
	`1265`	`+ throw new IllegalArgumentException(`
	`1266`	`+ "voiceConsentSignature parameter is not supported in Vertex AI.");`
	`1267`	`+ }`
	`1268`	`+`
`1260`	`1269`	`return toObject;`
`1261`	`1270`	`}`
`1262`	`1271`