Skip to content

Commit 5977fe1

Browse files
committed
Add docs for audio response modality.
1 parent fe885aa commit 5977fe1

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

FirebaseAI/Sources/Types/Public/ResponseModality.swift

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,16 @@ public struct ResponseModality: EncodableProtoEnum, Sendable {
4949
/// > backwards-incompatible ways.
5050
public static let image = ResponseModality(kind: .image)
5151

52+
/// **Public Preview**: Specifies that the model should generate audio content.
53+
///
54+
/// Use this modality when you need the model to produce (spoken) audio responses based on the
55+
/// provided input or prompts.
56+
///
57+
/// > Warning: This is **only** supported via the [live api](``LiveGenerativeModel``) currently.
58+
/// >
59+
/// > Furthermore, bidirectional streaming using Live models is in Public Preview, which means
60+
/// > that the feature is not subject to any SLA or deprecation policy and could change in
61+
/// > backwards-incompatible ways.
5262
public static let audio = ResponseModality(kind: .audio)
5363

5464
let rawValue: String

0 commit comments

Comments
 (0)