Skip to content

Commit 4f338f1

Browse files
authored
m169 doc changes (#7304)
We changed public constructors to internal constructors without moving the relevant docs, this fixes that.
1 parent 87148c9 commit 4f338f1

File tree

4 files changed

+23
-27
lines changed

4 files changed

+23
-27
lines changed

firebase-ai/src/main/kotlin/com/google/firebase/ai/common/Exceptions.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ internal class UnsupportedUserLocationException(cause: Throwable? = null) :
9090
FirebaseCommonAIException("User location is not supported for the API use.", cause)
9191

9292
/**
93-
* The user's project has not been configured and enabled for the selected API.
93+
* The Firebase project has not been configured and enabled for the selected API.
9494
*
9595
* For the Gemini Developer API, see
9696
* [steps](https://firebase.google.com/docs/ai-logic/faq-and-troubleshooting?api=dev#error-genai-config-not-found)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ public class UnsupportedUserLocationException internal constructor(cause: Throwa
152152
FirebaseAIException("User location is not supported for the API use.", cause)
153153

154154
/**
155-
* The user's project has not been configured and enabled for the selected API.
155+
* The Firebase project has not been configured and enabled for the selected API.
156156
*
157157
* For the Gemini Developer API, see
158158
* [steps](https://firebase.google.com/docs/ai-logic/faq-and-troubleshooting?api=dev#error-genai-config-not-found)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ public class GenerateContentResponse(
5959

6060
/**
6161
* Convenience field representing all the text parts in the response that are marked as thoughts
62-
* as a single string, if they exists.
62+
* as a single string, if they exist.
6363
*
6464
* Learn more about [thinking](https://firebase.google.com/docs/ai-logic/thinking?api=dev).
6565
*/

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

Lines changed: 20 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,6 @@ internal constructor(
106106
/**
107107
* Represents image data sent to and received from requests. The image is converted client-side to
108108
* JPEG encoding at 80% quality before being sent to the server.
109-
*
110-
* @param image [Bitmap] to convert into a [Part]
111109
*/
112110
public class ImagePart
113111
internal constructor(
@@ -116,6 +114,7 @@ internal constructor(
116114
internal val thoughtSignature: String?
117115
) : Part {
118116

117+
/** @param image [Bitmap] to convert into a [Part] */
119118
public constructor(image: Bitmap) : this(image, false, null)
120119

121120
internal fun toInlineDataPart() =
@@ -127,13 +126,7 @@ internal constructor(
127126
)
128127
}
129128

130-
/**
131-
* Represents binary data with an associated MIME type sent to and received from requests.
132-
*
133-
* @param inlineData the binary data as a [ByteArray]
134-
* @param mimeType an IANA standard MIME type. For supported values, see the
135-
* [Firebase documentation](https://firebase.google.com/docs/vertex-ai/input-file-requirements).
136-
*/
129+
/** Represents binary data with an associated MIME type sent to and received from requests. */
137130
public class InlineDataPart
138131
internal constructor(
139132
public val inlineData: ByteArray,
@@ -142,6 +135,11 @@ internal constructor(
142135
internal val thoughtSignature: String?
143136
) : Part {
144137

138+
/**
139+
* @param inlineData the binary data as a [ByteArray]
140+
* @param mimeType an IANA standard MIME type. For supported values, see the
141+
* [Firebase documentation](https://firebase.google.com/docs/vertex-ai/input-file-requirements).
142+
*/
145143
public constructor(
146144
inlineData: ByteArray,
147145
mimeType: String
@@ -199,13 +197,7 @@ internal constructor(
199197
}
200198
}
201199

202-
/**
203-
* Represents function call output to be returned to the model when it requests a function call.
204-
*
205-
* @param name The name of the called function.
206-
* @param response The response produced by the function as a [JSONObject].
207-
* @param id Matching `id` for a [FunctionCallPart], if one was provided.
208-
*/
200+
/** Represents function call output to be returned to the model when it requests a function call. */
209201
public class FunctionResponsePart
210202
internal constructor(
211203
public val name: String,
@@ -215,6 +207,11 @@ internal constructor(
215207
internal val thoughtSignature: String?
216208
) : Part {
217209

210+
/**
211+
* @param name The name of the called function.
212+
* @param response The response produced by the function as a [JSONObject].
213+
* @param id Matching `id` for a [FunctionCallPart], if one was provided.
214+
*/
218215
@JvmOverloads
219216
public constructor(
220217
name: String,
@@ -242,14 +239,7 @@ internal constructor(
242239
}
243240
}
244241

245-
/**
246-
* Represents file data stored in Cloud Storage for Firebase, referenced by URI.
247-
*
248-
* @param uri The `"gs://"`-prefixed URI of the file in Cloud Storage for Firebase, for example,
249-
* `"gs://bucket-name/path/image.jpg"`
250-
* @param mimeType an IANA standard MIME type. For supported MIME type values see the
251-
* [Firebase documentation](https://firebase.google.com/docs/vertex-ai/input-file-requirements).
252-
*/
242+
/** Represents file data stored in Cloud Storage for Firebase, referenced by URI. */
253243
public class FileDataPart
254244
internal constructor(
255245
public val uri: String,
@@ -258,6 +248,12 @@ internal constructor(
258248
internal val thoughtSignature: String?
259249
) : Part {
260250

251+
/**
252+
* @param uri The `"gs://"`-prefixed URI of the file in Cloud Storage for Firebase, for example,
253+
* `"gs://bucket-name/path/image.jpg"`
254+
* @param mimeType an IANA standard MIME type. For supported MIME type values see the
255+
* [Firebase documentation](https://firebase.google.com/docs/vertex-ai/input-file-requirements).
256+
*/
261257
public constructor(uri: String, mimeType: String) : this(uri, mimeType, false, null)
262258

263259
@Serializable

0 commit comments

Comments
 (0)