Skip to content

Commit 0318b78

Browse files
jaycee-licopybara-github
authored andcommitted
docs: Add docstring for classes and fields that are not supported in Gemini or Vertex API
PiperOrigin-RevId: 822252117
1 parent 5f94569 commit 0318b78

File tree

66 files changed

+195
-107
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+195
-107
lines changed

src/main/java/com/google/genai/types/ApiAuth.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@
2727

2828
/**
2929
* The generic reusable api auth config. Deprecated. Please use AuthConfig
30-
* (google/cloud/aiplatform/master/auth.proto) instead.
30+
* (google/cloud/aiplatform/master/auth.proto) instead. This data type is not supported in Gemini
31+
* API.
3132
*/
3233
@AutoValue
3334
@JsonDeserialize(builder = ApiAuth.Builder.class)

src/main/java/com/google/genai/types/ApiAuthApiKeyConfig.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import com.google.genai.JsonSerializable;
2626
import java.util.Optional;
2727

28-
/** The API secret. */
28+
/** The API secret. This data type is not supported in Gemini API. */
2929
@AutoValue
3030
@JsonDeserialize(builder = ApiAuthApiKeyConfig.Builder.class)
3131
public abstract class ApiAuthApiKeyConfig extends JsonSerializable {

src/main/java/com/google/genai/types/AuthConfigGoogleServiceAccountConfig.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@
2525
import com.google.genai.JsonSerializable;
2626
import java.util.Optional;
2727

28-
/** Config for Google Service Account Authentication. */
28+
/**
29+
* Config for Google Service Account Authentication. This data type is not supported in Gemini API.
30+
*/
2931
@AutoValue
3032
@JsonDeserialize(builder = AuthConfigGoogleServiceAccountConfig.Builder.class)
3133
public abstract class AuthConfigGoogleServiceAccountConfig extends JsonSerializable {

src/main/java/com/google/genai/types/AuthConfigHttpBasicAuthConfig.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import com.google.genai.JsonSerializable;
2626
import java.util.Optional;
2727

28-
/** Config for HTTP Basic Authentication. */
28+
/** Config for HTTP Basic Authentication. This data type is not supported in Gemini API. */
2929
@AutoValue
3030
@JsonDeserialize(builder = AuthConfigHttpBasicAuthConfig.Builder.class)
3131
public abstract class AuthConfigHttpBasicAuthConfig extends JsonSerializable {

src/main/java/com/google/genai/types/AuthConfigOauthConfig.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import com.google.genai.JsonSerializable;
2626
import java.util.Optional;
2727

28-
/** Config for user oauth. */
28+
/** Config for user oauth. This data type is not supported in Gemini API. */
2929
@AutoValue
3030
@JsonDeserialize(builder = AuthConfigOauthConfig.Builder.class)
3131
public abstract class AuthConfigOauthConfig extends JsonSerializable {

src/main/java/com/google/genai/types/AuthConfigOidcConfig.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import com.google.genai.JsonSerializable;
2626
import java.util.Optional;
2727

28-
/** Config for user OIDC auth. */
28+
/** Config for user OIDC auth. This data type is not supported in Gemini API. */
2929
@AutoValue
3030
@JsonDeserialize(builder = AuthConfigOidcConfig.Builder.class)
3131
public abstract class AuthConfigOidcConfig extends JsonSerializable {

src/main/java/com/google/genai/types/BlockedReason.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,13 @@ public enum Known {
4949
/** The prompt was blocked because it contains content that is unsafe for image generation. */
5050
IMAGE_SAFETY,
5151

52-
/** The prompt was blocked by Model Armor. */
52+
/** The prompt was blocked by Model Armor. This enum value is not supported in Gemini API. */
5353
MODEL_ARMOR,
5454

55-
/** The prompt was blocked as a jailbreak attempt. */
55+
/**
56+
* The prompt was blocked as a jailbreak attempt. This enum value is not supported in Gemini
57+
* API.
58+
*/
5659
JAILBREAK
5760
}
5861

src/main/java/com/google/genai/types/CachedContentUsageMetadata.java

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,23 +29,23 @@
2929
@AutoValue
3030
@JsonDeserialize(builder = CachedContentUsageMetadata.Builder.class)
3131
public abstract class CachedContentUsageMetadata extends JsonSerializable {
32-
/** Duration of audio in seconds. */
32+
/** Duration of audio in seconds. This field is not supported in Gemini API. */
3333
@JsonProperty("audioDurationSeconds")
3434
public abstract Optional<Integer> audioDurationSeconds();
3535

36-
/** Number of images. */
36+
/** Number of images. This field is not supported in Gemini API. */
3737
@JsonProperty("imageCount")
3838
public abstract Optional<Integer> imageCount();
3939

40-
/** Number of text characters. */
40+
/** Number of text characters. This field is not supported in Gemini API. */
4141
@JsonProperty("textCount")
4242
public abstract Optional<Integer> textCount();
4343

4444
/** Total number of tokens that the cached content consumes. */
4545
@JsonProperty("totalTokenCount")
4646
public abstract Optional<Integer> totalTokenCount();
4747

48-
/** Duration of video in seconds. */
48+
/** Duration of video in seconds. This field is not supported in Gemini API. */
4949
@JsonProperty("videoDurationSeconds")
5050
public abstract Optional<Integer> videoDurationSeconds();
5151

@@ -70,23 +70,24 @@ private static Builder create() {
7070
/**
7171
* Setter for audioDurationSeconds.
7272
*
73-
* <p>audioDurationSeconds: Duration of audio in seconds.
73+
* <p>audioDurationSeconds: Duration of audio in seconds. This field is not supported in Gemini
74+
* API.
7475
*/
7576
@JsonProperty("audioDurationSeconds")
7677
public abstract Builder audioDurationSeconds(Integer audioDurationSeconds);
7778

7879
/**
7980
* Setter for imageCount.
8081
*
81-
* <p>imageCount: Number of images.
82+
* <p>imageCount: Number of images. This field is not supported in Gemini API.
8283
*/
8384
@JsonProperty("imageCount")
8485
public abstract Builder imageCount(Integer imageCount);
8586

8687
/**
8788
* Setter for textCount.
8889
*
89-
* <p>textCount: Number of text characters.
90+
* <p>textCount: Number of text characters. This field is not supported in Gemini API.
9091
*/
9192
@JsonProperty("textCount")
9293
public abstract Builder textCount(Integer textCount);
@@ -102,7 +103,8 @@ private static Builder create() {
102103
/**
103104
* Setter for videoDurationSeconds.
104105
*
105-
* <p>videoDurationSeconds: Duration of video in seconds.
106+
* <p>videoDurationSeconds: Duration of video in seconds. This field is not supported in Gemini
107+
* API.
106108
*/
107109
@JsonProperty("videoDurationSeconds")
108110
public abstract Builder videoDurationSeconds(Integer videoDurationSeconds);

src/main/java/com/google/genai/types/Citation.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import com.google.genai.JsonSerializable;
2626
import java.util.Optional;
2727

28-
/** Source attributions for content. */
28+
/** Source attributions for content. This data type is not supported in Gemini API. */
2929
@AutoValue
3030
@JsonDeserialize(builder = Citation.Builder.class)
3131
public abstract class Citation extends JsonSerializable {

src/main/java/com/google/genai/types/DatasetDistribution.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
import java.util.List;
3030
import java.util.Optional;
3131

32-
/** Distribution computed over a tuning dataset. */
32+
/** Distribution computed over a tuning dataset. This data type is not supported in Gemini API. */
3333
@AutoValue
3434
@JsonDeserialize(builder = DatasetDistribution.Builder.class)
3535
public abstract class DatasetDistribution extends JsonSerializable {

0 commit comments

Comments
 (0)