Skip to content

Commit 1144cff

Browse files
committed
Add documentation to convenience accessor
1 parent 5a209d1 commit 1144cff

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

FirebaseAI/Sources/GenerateContentResponse.swift

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,17 @@ public struct GenerateContentResponse: Sendable {
5757
public let usageMetadata: UsageMetadata?
5858

5959
/// The response's content as text, if it exists.
60+
///
61+
/// - Note: This does not include thought summaries; see ``thoughtSummary`` for more details.
6062
public var text: String? {
6163
return text(isThought: false)
6264
}
6365

66+
/// A summary of the model's thinking process, if available.
67+
///
68+
/// - Important: Thought summaries are only available when `includeThoughts` is enabled in the
69+
/// ``ThinkingConfig``. For more information, see the
70+
/// [Thinking](https://firebase.google.com/docs/ai-logic/thinking) documentation.
6471
public var thoughtSummary: String? {
6572
return text(isThought: true)
6673
}

0 commit comments

Comments
 (0)