docs: [vertexai] Add deprecation notice for generativeai package (#11637)

copybara-service[bot] · jaycee-li · web-flow · commit 033b5f4eef7e · 2025-06-23T17:02:43.000-07:00
docs: [vertexai] Add deprecation notice for generativeai package

Co-authored-by: Jaycee Li &lt;jayceeli@google.com&gt;
diff --git a/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/AutomaticFunctionCallingResponder.java b/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/AutomaticFunctionCallingResponder.java
@@ -32,7 +32,14 @@
 import java.util.Map;
 import java.util.logging.Logger;
 
-/** A responder that automatically calls functions when requested by the GenAI model. */
+/**
+ * A responder that automatically calls functions when requested by the GenAI model.
+ *
+ * @deprecated This class and its package are deprecated. See the <a
+ *     href="https://cloud.google.com/vertex-ai/generative-ai/docs/deprecations/genai-vertexai-sdk#java">
+ *     migration guide</a> for more details.
+ */
+@Deprecated
 public final class AutomaticFunctionCallingResponder {
   private int maxFunctionCalls = 1;
   private int remainingFunctionCalls;
diff --git a/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/ChatSession.java b/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/ChatSession.java
@@ -40,7 +40,12 @@
  * Represents a conversation between the user and the model.
  *
  * <p>Note: this class is NOT thread-safe.
+ *
+ * @deprecated This class and its package are deprecated. See the <a
+ *     href="https://cloud.google.com/vertex-ai/generative-ai/docs/deprecations/genai-vertexai-sdk#java">
+ *     migration guide</a> for more details.
  */
+@Deprecated
 public final class ChatSession {
   private final GenerativeModel model;
   private final Optional<ChatSession> rootChatSession;
diff --git a/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/Constants.java b/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/Constants.java
@@ -18,7 +18,14 @@
 
 import com.google.common.collect.ImmutableSet;
 
-/** A class that holds all constants for vertexai/generativeai. */
+/**
+ * A class that holds all constants for vertexai/generativeai.
+ *
+ * @deprecated This class and its package are deprecated. See the <a
+ *     href="https://cloud.google.com/vertex-ai/generative-ai/docs/deprecations/genai-vertexai-sdk#java">
+ *     migration guide</a> for more details.
+ */
+@Deprecated
 public final class Constants {
   public static final String MODEL_NAME_PREFIX_PROJECTS = "projects/";
   public static final String MODEL_NAME_PREFIX_PUBLISHERS = "publishers/";
diff --git a/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/ContentMaker.java b/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/ContentMaker.java
@@ -22,7 +22,14 @@
 import com.google.cloud.vertexai.api.Part;
 import com.google.common.base.Strings;
 
-/** Helper class to create content. */
+/**
+ * Helper class to create content.
+ *
+ * @deprecated This class and its package are deprecated. See the <a
+ *     href="https://cloud.google.com/vertex-ai/generative-ai/docs/deprecations/genai-vertexai-sdk#java">
+ *     migration guide</a> for more details.
+ */
+@Deprecated
 public class ContentMaker {
   private static final String DEFAULT_ROLE = "user";
 
diff --git a/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/FunctionDeclarationMaker.java b/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/FunctionDeclarationMaker.java
@@ -29,7 +29,14 @@
 import java.lang.reflect.Modifier;
 import java.lang.reflect.Parameter;
 
-/** Helper class to create {@link com.google.cloud.vertexai.api.FunctionDeclaration} */
+/**
+ * Helper class to create {@link com.google.cloud.vertexai.api.FunctionDeclaration}
+ *
+ * @deprecated This class and its package are deprecated. See the <a
+ *     href="https://cloud.google.com/vertex-ai/generative-ai/docs/deprecations/genai-vertexai-sdk#java">
+ *     migration guide</a> for more details.
+ */
+@Deprecated
 public final class FunctionDeclarationMaker {
 
   /**
diff --git a/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/GenerativeModel.java b/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/GenerativeModel.java
@@ -45,7 +45,12 @@
  *
  * <p>Note: The instances of {@link ChatSession} returned by {@link GenerativeModel#startChat()} are
  * NOT thread-safe.
+ *
+ * @deprecated This class and its package are deprecated. See the <a
+ *     href="https://cloud.google.com/vertex-ai/generative-ai/docs/deprecations/genai-vertexai-sdk#java">
+ *     migration guide</a> for more details.
  */
+@Deprecated
 public final class GenerativeModel {
   private final String modelName;
   private final String resourceName;
diff --git a/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/PartMaker.java b/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/PartMaker.java
@@ -27,7 +27,14 @@
 import java.net.URI;
 import java.util.Map;
 
-/** Helper class to create {@link com.google.cloud.vertexai.api.Part} */
+/**
+ * Helper class to create {@link com.google.cloud.vertexai.api.Part}
+ *
+ * @deprecated This class and its package are deprecated. See the <a
+ *     href="https://cloud.google.com/vertex-ai/generative-ai/docs/deprecations/genai-vertexai-sdk#java">
+ *     migration guide</a> for more details.
+ */
+@Deprecated
 public class PartMaker {
 
   private PartMaker() {}
diff --git a/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/ResponseHandler.java b/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/ResponseHandler.java
@@ -30,7 +30,14 @@
 import java.util.List;
 import java.util.Map;
 
-/** Helper class to post-process GenerateContentResponse. */
+/**
+ * Helper class to post-process GenerateContentResponse.
+ *
+ * @deprecated This class and its package are deprecated. See the <a
+ *     href="https://cloud.google.com/vertex-ai/generative-ai/docs/deprecations/genai-vertexai-sdk#java">
+ *     migration guide</a> for more details.
+ */
+@Deprecated
 public class ResponseHandler {
 
   /**
diff --git a/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/ResponseStream.java b/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/ResponseStream.java
@@ -21,7 +21,14 @@
 import java.util.stream.Stream;
 import java.util.stream.StreamSupport;
 
-/** An iterable of GenerateContentResponse. */
+/**
+ * An iterable of GenerateContentResponse.
+ *
+ * @deprecated This class and its package are deprecated. See the <a
+ *     href="https://cloud.google.com/vertex-ai/generative-ai/docs/deprecations/genai-vertexai-sdk#java">
+ *     migration guide</a> for more details.
+ */
+@Deprecated
 public class ResponseStream<GenerateContentResponse> implements Iterable<GenerateContentResponse> {
 
   private ResponseStreamIteratorWithHistory<GenerateContentResponse> iteratorWithHistory;
diff --git a/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/ResponseStreamIteratorWithHistory.java b/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/ResponseStreamIteratorWithHistory.java
@@ -21,7 +21,14 @@
 import java.util.Iterator;
 import java.util.List;
 
-/** Iterator of the ResponseStream that holds the response chunks. */
+/**
+ * Iterator of the ResponseStream that holds the response chunks.
+ *
+ * @deprecated This class and its package are deprecated. See the <a
+ *     href="https://cloud.google.com/vertex-ai/generative-ai/docs/deprecations/genai-vertexai-sdk#java">
+ *     migration guide</a> for more details.
+ */
+@Deprecated
 public class ResponseStreamIteratorWithHistory<GenerateContentResponse>
     implements Iterator<GenerateContentResponse> {
   Iterator serverStreamIterator = null;
diff --git a/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/SchemaMaker.java b/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/generativeai/SchemaMaker.java
@@ -24,7 +24,14 @@
 import com.google.protobuf.InvalidProtocolBufferException;
 import com.google.protobuf.util.JsonFormat;
 
-/** Helper class to create {@link com.google.cloud.vertexai.api.Schema} */
+/**
+ * Helper class to create {@link com.google.cloud.vertexai.api.Schema}
+ *
+ * @deprecated This class and its package are deprecated. See the <a
+ *     href="https://cloud.google.com/vertex-ai/generative-ai/docs/deprecations/genai-vertexai-sdk#java">
+ *     migration guide</a> for more details.
+ */
+@Deprecated
 public final class SchemaMaker {
 
   private SchemaMaker() {}
