Skip to content

Commit bd157db

Browse files
authored
Several small changes to enums API (#6294)
The changes restricted to enum values and names are: - Remove `UNSPECIFIED` from `FinishReason` - Renamed `BlockThreshold` to `HarmBlockThreshold` - Rename `UNSPECIFIED` to `UNKNOWN` in `HarmBlockThreshold` - Remove `UNSPECIFIED` from `HarmProbability` - Remove `UNSPECIFIED` from `HarmSeverity` - Remove `UNSPECIFIED` from `BlockReason` Additionally, additional changes to non-enum values include - Make `totalBillableCharacters` nullable and optional b/367308641
1 parent d3e75a9 commit bd157db

File tree

8 files changed

+22
-38
lines changed

8 files changed

+22
-38
lines changed

firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/internal/util/conversions.kt

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,8 @@ import com.google.firebase.vertexai.common.shared.FunctionCall
2626
import com.google.firebase.vertexai.common.shared.FunctionCallPart
2727
import com.google.firebase.vertexai.common.shared.FunctionResponse
2828
import com.google.firebase.vertexai.common.shared.FunctionResponsePart
29-
import com.google.firebase.vertexai.common.shared.HarmBlockThreshold
3029
import com.google.firebase.vertexai.type.BlobPart
3130
import com.google.firebase.vertexai.type.BlockReason
32-
import com.google.firebase.vertexai.type.BlockThreshold
3331
import com.google.firebase.vertexai.type.Candidate
3432
import com.google.firebase.vertexai.type.Citation
3533
import com.google.firebase.vertexai.type.CitationMetadata
@@ -41,6 +39,7 @@ import com.google.firebase.vertexai.type.FunctionCallingConfig
4139
import com.google.firebase.vertexai.type.FunctionDeclaration
4240
import com.google.firebase.vertexai.type.GenerateContentResponse
4341
import com.google.firebase.vertexai.type.GenerationConfig
42+
import com.google.firebase.vertexai.type.HarmBlockThreshold
4443
import com.google.firebase.vertexai.type.HarmCategory
4544
import com.google.firebase.vertexai.type.HarmProbability
4645
import com.google.firebase.vertexai.type.HarmSeverity
@@ -138,13 +137,16 @@ internal fun ToolConfig.toInternal() =
138137
)
139138
)
140139

141-
internal fun BlockThreshold.toInternal() =
140+
internal fun HarmBlockThreshold.toInternal() =
142141
when (this) {
143-
BlockThreshold.NONE -> HarmBlockThreshold.BLOCK_NONE
144-
BlockThreshold.ONLY_HIGH -> HarmBlockThreshold.BLOCK_ONLY_HIGH
145-
BlockThreshold.MEDIUM_AND_ABOVE -> HarmBlockThreshold.BLOCK_MEDIUM_AND_ABOVE
146-
BlockThreshold.LOW_AND_ABOVE -> HarmBlockThreshold.BLOCK_LOW_AND_ABOVE
147-
BlockThreshold.UNSPECIFIED -> HarmBlockThreshold.UNSPECIFIED
142+
HarmBlockThreshold.NONE ->
143+
com.google.firebase.vertexai.common.shared.HarmBlockThreshold.BLOCK_NONE
144+
HarmBlockThreshold.ONLY_HIGH ->
145+
com.google.firebase.vertexai.common.shared.HarmBlockThreshold.BLOCK_ONLY_HIGH
146+
HarmBlockThreshold.MEDIUM_AND_ABOVE ->
147+
com.google.firebase.vertexai.common.shared.HarmBlockThreshold.BLOCK_MEDIUM_AND_ABOVE
148+
HarmBlockThreshold.LOW_AND_ABOVE ->
149+
com.google.firebase.vertexai.common.shared.HarmBlockThreshold.BLOCK_LOW_AND_ABOVE
148150
}
149151

150152
internal fun Tool.toInternal() =
@@ -258,8 +260,7 @@ internal fun com.google.firebase.vertexai.common.server.FinishReason?.toPublic()
258260
com.google.firebase.vertexai.common.server.FinishReason.SAFETY -> FinishReason.SAFETY
259261
com.google.firebase.vertexai.common.server.FinishReason.STOP -> FinishReason.STOP
260262
com.google.firebase.vertexai.common.server.FinishReason.OTHER -> FinishReason.OTHER
261-
com.google.firebase.vertexai.common.server.FinishReason.UNSPECIFIED -> FinishReason.UNSPECIFIED
262-
com.google.firebase.vertexai.common.server.FinishReason.UNKNOWN -> FinishReason.UNKNOWN
263+
else -> FinishReason.UNKNOWN
263264
}
264265

265266
internal fun com.google.firebase.vertexai.common.shared.HarmCategory.toPublic() =
@@ -270,7 +271,7 @@ internal fun com.google.firebase.vertexai.common.shared.HarmCategory.toPublic()
270271
HarmCategory.SEXUALLY_EXPLICIT
271272
com.google.firebase.vertexai.common.shared.HarmCategory.DANGEROUS_CONTENT ->
272273
HarmCategory.DANGEROUS_CONTENT
273-
com.google.firebase.vertexai.common.shared.HarmCategory.UNKNOWN -> HarmCategory.UNKNOWN
274+
else -> HarmCategory.UNKNOWN
274275
}
275276

276277
internal fun com.google.firebase.vertexai.common.server.HarmProbability.toPublic() =
@@ -280,9 +281,7 @@ internal fun com.google.firebase.vertexai.common.server.HarmProbability.toPublic
280281
com.google.firebase.vertexai.common.server.HarmProbability.LOW -> HarmProbability.LOW
281282
com.google.firebase.vertexai.common.server.HarmProbability.NEGLIGIBLE ->
282283
HarmProbability.NEGLIGIBLE
283-
com.google.firebase.vertexai.common.server.HarmProbability.UNSPECIFIED ->
284-
HarmProbability.UNSPECIFIED
285-
com.google.firebase.vertexai.common.server.HarmProbability.UNKNOWN -> HarmProbability.UNKNOWN
284+
else -> HarmProbability.UNKNOWN
286285
}
287286

288287
internal fun com.google.firebase.vertexai.common.server.HarmSeverity.toPublic() =
@@ -291,16 +290,14 @@ internal fun com.google.firebase.vertexai.common.server.HarmSeverity.toPublic()
291290
com.google.firebase.vertexai.common.server.HarmSeverity.MEDIUM -> HarmSeverity.MEDIUM
292291
com.google.firebase.vertexai.common.server.HarmSeverity.LOW -> HarmSeverity.LOW
293292
com.google.firebase.vertexai.common.server.HarmSeverity.NEGLIGIBLE -> HarmSeverity.NEGLIGIBLE
294-
com.google.firebase.vertexai.common.server.HarmSeverity.UNSPECIFIED -> HarmSeverity.UNSPECIFIED
295-
com.google.firebase.vertexai.common.server.HarmSeverity.UNKNOWN -> HarmSeverity.UNKNOWN
293+
else -> HarmSeverity.UNKNOWN
296294
}
297295

298296
internal fun com.google.firebase.vertexai.common.server.BlockReason.toPublic() =
299297
when (this) {
300-
com.google.firebase.vertexai.common.server.BlockReason.UNSPECIFIED -> BlockReason.UNSPECIFIED
301298
com.google.firebase.vertexai.common.server.BlockReason.SAFETY -> BlockReason.SAFETY
302299
com.google.firebase.vertexai.common.server.BlockReason.OTHER -> BlockReason.OTHER
303-
com.google.firebase.vertexai.common.server.BlockReason.UNKNOWN -> BlockReason.UNKNOWN
300+
else -> BlockReason.UNKNOWN
304301
}
305302

306303
internal fun com.google.firebase.vertexai.common.GenerateContentResponse.toPublic():

firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/Candidate.kt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,6 @@ enum class FinishReason {
6868
/** A new and not yet supported value. */
6969
UNKNOWN,
7070

71-
/** Reason is unspecified. */
72-
UNSPECIFIED,
73-
7471
/** Model finished successfully and stopped. */
7572
STOP,
7673

firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/CountTokensResponse.kt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,10 @@ package com.google.firebase.vertexai.type
2020
* Represents a response measuring model input.
2121
*
2222
* @property totalTokens A count of the tokens in the input
23-
* @property totalBillableCharacters A count of the characters that are billable in the input
23+
* @property totalBillableCharacters A count of the characters that are billable in the input, if
24+
* available.
2425
*/
25-
class CountTokensResponse(val totalTokens: Int, val totalBillableCharacters: Int) {
26+
class CountTokensResponse(val totalTokens: Int, val totalBillableCharacters: Int? = null) {
2627
operator fun component1() = totalTokens
2728

2829
operator fun component2() = totalBillableCharacters

firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/BlockThreshold.kt renamed to firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.kt

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,7 @@ package com.google.firebase.vertexai.type
1919
/**
2020
* Represents the threshold for some [HarmCategory] that is allowed and blocked by [SafetySetting].
2121
*/
22-
enum class BlockThreshold {
23-
/** The threshold was not specified. */
24-
UNSPECIFIED,
25-
22+
enum class HarmBlockThreshold {
2623
/** Content with negligible harm is allowed. */
2724
LOW_AND_ABOVE,
2825

firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/HarmProbability.kt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,6 @@ enum class HarmProbability {
2121
/** A new and not yet supported value. */
2222
UNKNOWN,
2323

24-
/** Probability for harm is unspecified. */
25-
UNSPECIFIED,
26-
2724
/** Probability for harm is negligible. */
2825
NEGLIGIBLE,
2926

firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/HarmSeverity.kt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,6 @@ enum class HarmSeverity {
2121
/** A new and not yet supported value. */
2222
UNKNOWN,
2323

24-
/** Severity for harm is unspecified. */
25-
UNSPECIFIED,
26-
2724
/** Severity for harm is negligible. */
2825
NEGLIGIBLE,
2926

firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/PromptFeedback.kt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,6 @@ enum class BlockReason {
3434
/** A new and not yet supported value. */
3535
UNKNOWN,
3636

37-
/** Content was blocked for an unspecified reason. */
38-
UNSPECIFIED,
39-
4037
/** Content was blocked for violating provided [SafetySetting]. */
4138
SAFETY,
4239

firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/SafetySetting.kt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,10 @@
1717
package com.google.firebase.vertexai.type
1818

1919
/**
20-
* A configuration for a [BlockThreshold] of some [HarmCategory] allowed and blocked in responses.
20+
* A configuration for a [HarmBlockThreshold] of some [HarmCategory] allowed and blocked in
21+
* responses.
2122
*
2223
* @param harmCategory The relevant [HarmCategory].
2324
* @param threshold The threshold form harm allowable.
2425
*/
25-
class SafetySetting(val harmCategory: HarmCategory, val threshold: BlockThreshold) {}
26+
class SafetySetting(val harmCategory: HarmCategory, val threshold: HarmBlockThreshold) {}

0 commit comments

Comments
 (0)