Skip to content

Commit 966ae8a

Browse files
author
David Motsonashvili
committed
AI: Update documentation for feedback from M173
1 parent e4369ab commit 966ae8a

File tree

5 files changed

+10
-7
lines changed

5 files changed

+10
-7
lines changed

firebase-ai/src/main/kotlin/com/google/firebase/ai/java/LiveSessionFutures.kt

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -197,9 +197,12 @@ public abstract class LiveSessionFutures internal constructor() {
197197
public abstract fun sendVideoRealtime(video: InlineData): ListenableFuture<Unit>
198198

199199
/**
200-
* Sends text data to the server in realtime. Check
201-
* https://ai.google.dev/api/live#bidigeneratecontentrealtimeinput for details about the realtime
202-
* input usage.
200+
* For details about the realtime input usage, see the `BidiGenerateContentRealtimeInput`
201+
* documentation (
202+
* [Gemini Developer API](https://ai.google.dev/api/live#bidigeneratecontentrealtimeinput) or
203+
* [Vertex AI Gemini API](https://docs.cloud.google.com/vertex-ai/generative-ai/docs/model-reference/multimodal-live#bidigeneratecontentrealtimeinput)
204+
* ).
205+
*
203206
* @param text The text data to send.
204207
*/
205208
public abstract fun sendTextRealtime(text: String): ListenableFuture<Unit>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ internal constructor(
8484
*
8585
* The rating will be restricted to a particular [category].
8686
*
87-
* @property category The category of harm being assessed (e.g., Hate speech).
87+
* @property category The category of harm being assessed (for example, Hate speech).
8888
* @property probability The likelihood of the content causing harm.
8989
* @property probabilityScore A numerical score representing the probability of harm, between `0`
9090
* and `1`.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ public class ContentModality private constructor(public val ordinal: Int) {
7171
/** Audio. */
7272
@JvmField public val AUDIO: ContentModality = ContentModality(4)
7373

74-
/** Document, e.g. PDF. */
74+
/** Document, for example, PDF. */
7575
@JvmField public val DOCUMENT: ContentModality = ContentModality(5)
7676
}
7777
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ internal constructor(
342342
*
343343
* @param video Encoded image data extracted from a frame of the video, used to update the model
344344
* on the client's conversation, with the corresponding IANA standard MIME type of the video frame
345-
* data (e.g., `image/png`, `image/jpeg`, etc.).
345+
* data (for example, `image/png`, `image/jpeg`, etc.).
346346
*/
347347
public suspend fun sendVideoRealtime(video: InlineData) {
348348
FirebaseAIException.catchAsync {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import com.google.firebase.ai.common.util.FirstOrdinalSerializer
2020
import kotlinx.serialization.KSerializer
2121
import kotlinx.serialization.Serializable
2222

23-
/** Represents the type of content present in a response (e.g., text, image, audio). */
23+
/** Represents the type of content present in a response (for example, text, image, audio). */
2424
public class ResponseModality private constructor(public val ordinal: Int) {
2525

2626
@Serializable(Internal.Serializer::class)

0 commit comments

Comments
 (0)