Skip to content

Commit ba868a2

Browse files
committed
Update doc comments per rachel's input
1 parent 850914e commit ba868a2

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

FirebaseAI/Sources/FirebaseAI.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -139,17 +139,17 @@ public final class FirebaseAI: Sendable {
139139

140140
/// **[Public Preview]** Initializes a ``LiveGenerativeModel`` with the given parameters.
141141
///
142-
/// > Warning: For Firebase AI SDK, bidirectional streaming using Live API models is in Public
142+
/// > Warning: Using the Firebase AI Logic SDKs with the Gemini Live API is in Public
143143
/// Preview, which means that the feature is not subject to any SLA or deprecation policy and
144144
/// could change in backwards-incompatible ways.
145145
///
146-
/// > Important: Only Live API models (typically containing `live-*` in the name) are supported.
146+
/// > Important: Only models that support the Gemini Live API (typically containing `live-*` in the name) are supported.
147147
///
148148
/// - Parameters:
149-
/// - modelName: The name of the Live API model to use, for example
149+
/// - modelName: The name of the model to use, for example
150150
/// `"gemini-live-2.5-flash-preview"`;
151151
/// see [model versions](https://firebase.google.com/docs/ai-logic/live-api?api=dev#models-that-support-capability)
152-
/// for a list of supported Live API models.
152+
/// for a list of supported models.
153153
/// - generationConfig: The content generation parameters your model should use.
154154
/// - tools: A list of ``Tool`` objects that the model may use to generate the next response.
155155
/// - toolConfig: Tool configuration for any ``Tool`` specified in the request.

FirebaseAI/Sources/Types/Public/Live/AudioTranscriptionConfig.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
/// Configuration options for audio transcriptions when communicating with a Live API model.
15+
/// Configuration options for audio transcriptions when communicating with a model that supports the Gemini Live API.
1616
///
1717
/// While there are not currently any options, this will likely change in the future. For now, just
1818
/// providing an instance of this struct will enable audio transcriptions for the corresponding

FirebaseAI/Sources/Types/Public/Live/LiveSessionErrors.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
import Foundation
1616

17-
/// The Live API model sent a message that the SDK failed to parse.
17+
/// The model sent a message that the SDK failed to parse.
1818
///
1919
/// This may indicate that the SDK version needs updating, a model is too old for the current SDK
2020
/// version, or that the model is just
@@ -78,7 +78,7 @@ public struct LiveSessionUnexpectedClosureError: Error, Sendable, CustomNSError
7878
}
7979
}
8080

81-
/// The Live API model refused our request to setup a live session.
81+
/// The model refused our request to setup a live session.
8282
///
8383
/// This can occur due to the model not supporting the requested response modalities, the project
8484
/// not having access to the model, the model being invalid, or some internal error.

FirebaseAI/Sources/Types/Public/ResponseModality.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public struct ResponseModality: EncodableProtoEnum, Sendable {
5757
/// > Warning: This is currently **only** supported via the
5858
/// > [live api](https://firebase.google.com/docs/ai-logic/live-api)\.
5959
/// >
60-
/// > Furthermore, bidirectional streaming using Live API models is in Public Preview, which means
60+
/// > Furthermore, using the Firebase AI Logic SDKs with the Gemini Live API is in Public Preview, which means
6161
/// > that the feature is not subject to any SLA or deprecation policy and could change in
6262
/// > backwards-incompatible ways.
6363
public static let audio = ResponseModality(kind: .audio)

0 commit comments

Comments
 (0)