Skip to content

Documentation fixes from cl/782062615 #7168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 18, 2025
Merged

Documentation fixes from cl/782062615 #7168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions firebase-ai/src/main/kotlin/com/google/firebase/ai/type/Candidate.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions firebase-ai/src/main/kotlin/com/google/firebase/ai/type/GoogleSearch.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
*/
Expand Down
2 changes: 1 addition & 1 deletion firebase-ai/src/main/kotlin/com/google/firebase/ai/type/ThinkingConfig.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
9 changes: 3 additions & 6 deletions firebase-ai/src/main/kotlin/com/google/firebase/ai/type/Tool.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down Expand Up @@ -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).
*
Expand Down