Skip to content

Commit 228b311

Browse files
committed
Doc changes for m169
1 parent 64b488f commit 228b311

File tree

4 files changed

+21
-16
lines changed

4 files changed

+21
-16
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: 18 additions & 13 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,9 @@ internal constructor(
116114
internal val thoughtSignature: String?
117115
) : Part {
118116

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

121122
internal fun toInlineDataPart() =
@@ -130,8 +131,6 @@ internal constructor(
130131
/**
131132
* Represents binary data with an associated MIME type sent to and received from requests.
132133
*
133-
* @param inlineData the binary data as a [ByteArray]
134-
* @param mimeType an IANA standard MIME type. For supported values, see the
135134
* [Firebase documentation](https://firebase.google.com/docs/vertex-ai/input-file-requirements).
136135
*/
137136
public class InlineDataPart
@@ -142,6 +141,10 @@ internal constructor(
142141
internal val thoughtSignature: String?
143142
) : Part {
144143

144+
/**
145+
* @param inlineData the binary data as a [ByteArray]
146+
* @param mimeType an IANA standard MIME type. For supported values, see the
147+
*/
145148
public constructor(
146149
inlineData: ByteArray,
147150
mimeType: String
@@ -201,10 +204,6 @@ internal constructor(
201204

202205
/**
203206
* 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.
208207
*/
209208
public class FunctionResponsePart
210209
internal constructor(
@@ -215,6 +214,11 @@ internal constructor(
215214
internal val thoughtSignature: String?
216215
) : Part {
217216

217+
/**
218+
* @param name The name of the called function.
219+
* @param response The response produced by the function as a [JSONObject].
220+
* @param id Matching `id` for a [FunctionCallPart], if one was provided.
221+
*/
218222
@JvmOverloads
219223
public constructor(
220224
name: String,
@@ -244,11 +248,6 @@ internal constructor(
244248

245249
/**
246250
* 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).
252251
*/
253252
public class FileDataPart
254253
internal constructor(
@@ -258,6 +257,12 @@ internal constructor(
258257
internal val thoughtSignature: String?
259258
) : Part {
260259

260+
/**
261+
* @param uri The `"gs://"`-prefixed URI of the file in Cloud Storage for Firebase, for example,
262+
* `"gs://bucket-name/path/image.jpg"`
263+
* @param mimeType an IANA standard MIME type. For supported MIME type values see the
264+
* [Firebase documentation](https://firebase.google.com/docs/vertex-ai/input-file-requirements).
265+
*/
261266
public constructor(uri: String, mimeType: String) : this(uri, mimeType, false, null)
262267

263268
@Serializable

0 commit comments

Comments
 (0)