Skip to content

Commit db883a3

Browse files
VinayGuthaldaymxn
andauthored
Apply suggestions from code review
Co-authored-by: Daymon <[email protected]>
1 parent 7f0aa89 commit db883a3

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

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

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public abstract class LiveSessionFutures internal constructor() {
4040

4141
/**
4242
* Starts an audio conversation with the Gemini server, which can only be stopped using
43-
* stopAudioConversation.
43+
* [stopAudioConversation].
4444
*
4545
* @param functionCallHandler A callback function to map function calls from the server to their
4646
* response parts.
@@ -49,7 +49,12 @@ public abstract class LiveSessionFutures internal constructor() {
4949
functionCallHandler: ((FunctionCallPart) -> FunctionResponsePart)?
5050
): ListenableFuture<Unit>
5151

52-
/** Stops the audio conversation with the Gemini Server. */
52+
/**
53+
* Stops the audio conversation with the Gemini Server.
54+
*
55+
* @see [startAudioConversation]
56+
* @see [stopReceiving]
57+
*/
5358
public abstract fun stopAudioConversation(): ListenableFuture<Unit>
5459

5560
/** Stop receiving from the server. */
@@ -94,7 +99,7 @@ public abstract class LiveSessionFutures internal constructor() {
9499
*
95100
* @return A [Publisher] which will emit [LiveContentResponse] as and when it receives it.
96101
*
97-
* @throws [SessionAlreadyReceivingException] when the session is already receiving.
102+
* @throws [SessionAlreadyReceivingException] When the session is already receiving.
98103
*/
99104
public abstract fun receive(): Publisher<LiveContentResponse>
100105

@@ -128,7 +133,7 @@ public abstract class LiveSessionFutures internal constructor() {
128133

129134
public companion object {
130135

131-
/** @return a [GenerativeModelFutures] created around the provided [GenerativeModel] */
136+
/** @return a [LiveSessionFutures] created around the provided [LiveSession] */
132137
@JvmStatic public fun from(session: LiveSession): LiveSessionFutures = FuturesImpl(session)
133138
}
134139
}

0 commit comments

Comments
 (0)