Skip to content

Commit e5a993b

Browse files
committed
Rename Modality to ContentModality
There are other possible classes that will use the same Modality name
1 parent 9d91925 commit e5a993b

File tree

3 files changed

+22
-19
lines changed

3 files changed

+22
-19
lines changed

firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/Modality.kt renamed to firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ContentModality.kt

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import kotlinx.serialization.KSerializer
2121
import kotlinx.serialization.SerialName
2222
import kotlinx.serialization.Serializable
2323

24-
public class Modality private constructor(public val ordinal: Int) {
24+
public class ContentModality private constructor(public val ordinal: Int) {
2525

2626
@Serializable(Internal.Serializer::class)
2727
internal enum class Internal {
@@ -36,31 +36,31 @@ public class Modality private constructor(public val ordinal: Int) {
3636

3737
internal fun toPublic() =
3838
when (this) {
39-
TEXT -> Modality.TEXT
40-
IMAGE -> Modality.IMAGE
41-
VIDEO -> Modality.VIDEO
42-
AUDIO -> Modality.AUDIO
43-
DOCUMENT -> Modality.DOCUMENT
44-
else -> Modality.UNSPECIFIED
39+
TEXT -> ContentModality.TEXT
40+
IMAGE -> ContentModality.IMAGE
41+
VIDEO -> ContentModality.VIDEO
42+
AUDIO -> ContentModality.AUDIO
43+
DOCUMENT -> ContentModality.DOCUMENT
44+
else -> ContentModality.UNSPECIFIED
4545
}
4646
}
4747

4848
public companion object {
49-
@JvmField public val UNSPECIFIED: Modality = Modality(0)
49+
@JvmField public val UNSPECIFIED: ContentModality = ContentModality(0)
5050

5151
/** Plain text. */
52-
@JvmField public val TEXT: Modality = Modality(1)
52+
@JvmField public val TEXT: ContentModality = ContentModality(1)
5353

5454
/** Image. */
55-
@JvmField public val IMAGE: Modality = Modality(2)
55+
@JvmField public val IMAGE: ContentModality = ContentModality(2)
5656

5757
/** Video. */
58-
@JvmField public val VIDEO: Modality = Modality(3)
58+
@JvmField public val VIDEO: ContentModality = ContentModality(3)
5959

6060
/** Audio. */
61-
@JvmField public val AUDIO: Modality = Modality(4)
61+
@JvmField public val AUDIO: ContentModality = ContentModality(4)
6262

6363
/** Document, e.g. PDF. */
64-
@JvmField public val DOCUMENT: Modality = Modality(5)
64+
@JvmField public val DOCUMENT: ContentModality = ContentModality(5)
6565
}
6666
}

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,13 @@ package com.google.firebase.vertexai.type
1919
import kotlinx.serialization.Serializable
2020

2121
public class ModalityTokenCount
22-
private constructor(public val modality: Modality, public val tokenCount: Int) {
22+
private constructor(public val modality: ContentModality, public val tokenCount: Int) {
2323

2424
@Serializable
25-
internal data class Internal(val modality: Modality.Internal, val tokenCount: Int? = null) {
25+
internal data class Internal(
26+
val modality: ContentModality.Internal,
27+
val tokenCount: Int? = null
28+
) {
2629
internal fun toPublic() = ModalityTokenCount(modality.toPublic(), tokenCount ?: 0)
2730
}
2831
}

firebase-vertexai/src/test/java/com/google/firebase/vertexai/UnarySnapshotTests.kt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@
1717
package com.google.firebase.vertexai
1818

1919
import com.google.firebase.vertexai.type.BlockReason
20+
import com.google.firebase.vertexai.type.ContentModality
2021
import com.google.firebase.vertexai.type.FinishReason
2122
import com.google.firebase.vertexai.type.FunctionCallPart
2223
import com.google.firebase.vertexai.type.HarmCategory
2324
import com.google.firebase.vertexai.type.HarmProbability
2425
import com.google.firebase.vertexai.type.HarmSeverity
2526
import com.google.firebase.vertexai.type.InvalidAPIKeyException
26-
import com.google.firebase.vertexai.type.Modality
2727
import com.google.firebase.vertexai.type.PromptBlockedException
2828
import com.google.firebase.vertexai.type.ResponseStoppedException
2929
import com.google.firebase.vertexai.type.SerializationException
@@ -83,11 +83,11 @@ internal class UnarySnapshotTests {
8383
totalTokenCount shouldBe 1913
8484
candidatesTokenCount shouldBe 76
8585
promptTokensDetails?.forAtLeastOne {
86-
it.modality shouldBe Modality.IMAGE
86+
it.modality shouldBe ContentModality.IMAGE
8787
it.tokenCount shouldBe 1806
8888
}
8989
candidatesTokensDetails?.forAtLeastOne {
90-
it.modality shouldBe Modality.TEXT
90+
it.modality shouldBe ContentModality.TEXT
9191
it.tokenCount shouldBe 76
9292
}
9393
}
@@ -491,7 +491,7 @@ internal class UnarySnapshotTests {
491491
response.totalBillableCharacters shouldBe 117
492492
response.promptTokensDetails shouldNotBe null
493493
response.promptTokensDetails?.forAtLeastOne {
494-
it.modality shouldBe Modality.IMAGE
494+
it.modality shouldBe ContentModality.IMAGE
495495
it.tokenCount shouldBe 1806
496496
}
497497
}

0 commit comments

Comments
 (0)