From b20e39dde02b6b7af16ffc8653939676cde89ea3 Mon Sep 17 00:00:00 2001 From: David Motsonashvili Date: Fri, 18 Jul 2025 14:31:37 -0700 Subject: [PATCH] Documentation fixes from cl/782062615 --- .../main/kotlin/com/google/firebase/ai/type/Candidate.kt | 5 ++--- .../kotlin/com/google/firebase/ai/type/GoogleSearch.kt | 3 +-- .../kotlin/com/google/firebase/ai/type/ThinkingConfig.kt | 2 +- .../src/main/kotlin/com/google/firebase/ai/type/Tool.kt | 9 +++------ 4 files changed, 7 insertions(+), 12 deletions(-) diff --git a/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/Candidate.kt b/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/Candidate.kt index ec71e342474..0c6819defd8 100644 --- a/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/Candidate.kt +++ b/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/Candidate.kt @@ -299,14 +299,13 @@ public class FinishReason private constructor(public val name: String, public va * * If using Grounding with Google Search, you are required to comply with the "Grounding with Google * Search" usage requirements for your chosen API provider: - * [Gemini Developer - * API](https://ai.google.dev/gemini-api/terms#grounding-with-google-search) or + * [Gemini Developer API](https://ai.google.dev/gemini-api/terms#grounding-with-google-search) or * Vertex AI Gemini API (see [Service Terms](https://cloud.google.com/terms/service-terms) section * within the Service Specific Terms). * * @property webSearchQueries The list of web search queries that the model performed to gather the * grounding information. These can be used to allow users to explore the search results themselves. - * @property searchEntryPoint Google search entry point for web searches. This contains an HTML/CSS + * @property searchEntryPoint Google Search entry point for web searches. This contains an HTML/CSS * snippet that **must** be embedded in an app to display a Google Search Entry point for follow-up * web searches related to the model's "Grounded Response". * @property groundingChunks The list of [GroundingChunk] classes. Each chunk represents a piece of diff --git a/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/GoogleSearch.kt b/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/GoogleSearch.kt index cb937ca7219..82d7967c1ce 100644 --- a/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/GoogleSearch.kt +++ b/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/GoogleSearch.kt @@ -24,8 +24,7 @@ import kotlinx.serialization.Serializable * * When using this feature, you are required to comply with the "Grounding with Google Search" usage * requirements for your chosen API provider: - * [Gemini Developer - * API](https://ai.google.dev/gemini-api/terms#grounding-with-google-search) or + * [Gemini Developer API](https://ai.google.dev/gemini-api/terms#grounding-with-google-search) or * Vertex AI Gemini API (see [Service Terms](https://cloud.google.com/terms/service-terms) section * within the Service Specific Terms). */ diff --git a/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/ThinkingConfig.kt b/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/ThinkingConfig.kt index bbdfed32640..d7de699e9e2 100644 --- a/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/ThinkingConfig.kt +++ b/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/ThinkingConfig.kt @@ -31,7 +31,7 @@ private constructor( public var thinkingBudget: Int? = null /** - * Indicates the thinking budget in tokens. 0 is DISABLED. -1 is AUTOMATIC. The default values + * Indicates the thinking budget in tokens. `0` is disabled. `-1` is dynamic. The default values * and allowed ranges are model dependent. */ public fun setThinkingBudget(thinkingBudget: Int): Builder = apply { diff --git a/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/Tool.kt b/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/Tool.kt index eddec53c9cc..3b00115ebd8 100644 --- a/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/Tool.kt +++ b/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/Tool.kt @@ -20,10 +20,8 @@ import kotlinx.serialization.Serializable import kotlinx.serialization.json.JsonObject /** - * Contains a set of function declarations that the model has access to. These can be used to gather - * information, or complete tasks - * - * @param functionDeclarations The set of functions that this tool allows the model access to + * Contains a set of tools (like function declarations) that the model has access to. These tools + * can be used to gather information or complete tasks. */ public class Tool internal constructor( @@ -62,8 +60,7 @@ internal constructor( * * When using this feature, you are required to comply with the "Grounding with Google Search" * usage requirements for your chosen API provider: - * [Gemini Developer - * API](https://ai.google.dev/gemini-api/terms#grounding-with-google-search) + * [Gemini Developer API](https://ai.google.dev/gemini-api/terms#grounding-with-google-search) * or Vertex AI Gemini API (see [Service Terms](https://cloud.google.com/terms/service-terms) * section within the Service Specific Terms). *