Add public preview annotations and update changelog entry

Author: dlarocque

firebase-ai/CHANGELOG.md

@@ -1,7 +1,7 @@
 # Unreleased
 
 - [changed] **Breaking Change**: Removed the `candidateCount` option from `LiveGenerationConfig`
-- [changed] Added support for URL context.
+- [changed] Added support for the URL context tool, which allows the model to access content from provided public web URLs to inform and enhance its responses.
 
 # 17.3.0
 

firebase-ai/api.txt

@@ -1203,15 +1203,15 @@ package com.google.firebase.ai.type {
     method public static com.google.firebase.ai.type.Tool codeExecution();
     method public static com.google.firebase.ai.type.Tool functionDeclarations(java.util.List<com.google.firebase.ai.type.FunctionDeclaration> functionDeclarations);
     method public static com.google.firebase.ai.type.Tool googleSearch(com.google.firebase.ai.type.GoogleSearch googleSearch = com.google.firebase.ai.type.GoogleSearch());
-    method public static com.google.firebase.ai.type.Tool urlContext(com.google.firebase.ai.type.UrlContext urlContext = com.google.firebase.ai.type.UrlContext());
+    method @com.google.firebase.ai.type.PublicPreviewAPI public static com.google.firebase.ai.type.Tool urlContext(com.google.firebase.ai.type.UrlContext urlContext = com.google.firebase.ai.type.UrlContext());
     field public static final com.google.firebase.ai.type.Tool.Companion Companion;
   }
 
   public static final class Tool.Companion {
     method public com.google.firebase.ai.type.Tool codeExecution();
     method public com.google.firebase.ai.type.Tool functionDeclarations(java.util.List<com.google.firebase.ai.type.FunctionDeclaration> functionDeclarations);
     method public com.google.firebase.ai.type.Tool googleSearch(com.google.firebase.ai.type.GoogleSearch googleSearch = com.google.firebase.ai.type.GoogleSearch());
-    method public com.google.firebase.ai.type.Tool urlContext(com.google.firebase.ai.type.UrlContext urlContext = com.google.firebase.ai.type.UrlContext());
+    method @com.google.firebase.ai.type.PublicPreviewAPI public com.google.firebase.ai.type.Tool urlContext(com.google.firebase.ai.type.UrlContext urlContext = com.google.firebase.ai.type.UrlContext());
   }
 
   public final class ToolConfig {
@@ -1224,25 +1224,23 @@ package com.google.firebase.ai.type {
   public final class UnsupportedUserLocationException extends com.google.firebase.ai.type.FirebaseAIException {
   }
 
-  public final class UrlContext {
+  @com.google.firebase.ai.type.PublicPreviewAPI public final class UrlContext {
     ctor public UrlContext();
   }
 
-  public final class UrlContextMetadata {
-    ctor public UrlContextMetadata(java.util.List<com.google.firebase.ai.type.UrlMetadata> urlMetadata);
+  @com.google.firebase.ai.type.PublicPreviewAPI public final class UrlContextMetadata {
     method public java.util.List<com.google.firebase.ai.type.UrlMetadata> getUrlMetadata();
     property public final java.util.List<com.google.firebase.ai.type.UrlMetadata> urlMetadata;
   }
 
-  public final class UrlMetadata {
-    ctor public UrlMetadata(String? retrievedUrl, com.google.firebase.ai.type.UrlRetrievalStatus urlRetrievalStatus);
+  @com.google.firebase.ai.type.PublicPreviewAPI public final class UrlMetadata {
     method public String? getRetrievedUrl();
     method public com.google.firebase.ai.type.UrlRetrievalStatus getUrlRetrievalStatus();
     property public final String? retrievedUrl;
     property public final com.google.firebase.ai.type.UrlRetrievalStatus urlRetrievalStatus;
   }
 
-  public final class UrlRetrievalStatus {
+  @com.google.firebase.ai.type.PublicPreviewAPI public final class UrlRetrievalStatus {
     method public String getName();
     method public int getOrdinal();
     property public final String name;

firebase-ai/src/main/kotlin/com/google/firebase/ai/type/Candidate.kt

@@ -503,6 +503,7 @@ public class Segment(
  *
  * @property urlMetadata List of [UrlMetadata] used to provide context to the Gemini model.
  */
+@PublicPreviewAPI
 public class UrlContextMetadata internal constructor(public val urlMetadata: List<UrlMetadata>) {
   @Serializable
   internal data class Internal(val urlMetadata: List<UrlMetadata.Internal>?) {
@@ -516,6 +517,7 @@ public class UrlContextMetadata internal constructor(public val urlMetadata: Lis
  * @property retrievedUrl The retrieved URL.
  * @property urlRetrievalStatus The status of the URL retrieval.
  */
+@PublicPreviewAPI
 public class UrlMetadata
 internal constructor(
   public val retrievedUrl: String?,
@@ -536,6 +538,7 @@ internal constructor(
  * @property name The name of the retrieval status.
  * @property ordinal The ordinal value of the retrieval status.
  */
+@PublicPreviewAPI
 public class UrlRetrievalStatus
 private constructor(public val name: String, public val ordinal: Int) {
 

firebase-ai/src/main/kotlin/com/google/firebase/ai/type/Tool.kt

@@ -73,6 +73,7 @@ internal constructor(
      * @param urlContext Specifies the URL context configuration.
      * @return A [Tool] configured for URL context.
      */
+    @PublicPreviewAPI
     @JvmStatic
     public fun urlContext(urlContext: UrlContext = UrlContext()): Tool {
       return Tool(null, null, null, urlContext)

firebase-ai/src/main/kotlin/com/google/firebase/ai/type/UrlContext.kt

@@ -19,6 +19,7 @@ package com.google.firebase.ai.type
 import kotlinx.serialization.Serializable
 
 /** Specifies the URL context configuration. */
+@PublicPreviewAPI
 public class UrlContext {
   @Serializable internal class Internal()