Skip to content

Commit

Permalink
chore: [vertexai] Write in third person for javadoc
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 613653421
  • Loading branch information
jaycee-li authored and copybara-github committed Mar 7, 2024
1 parent 1f9e632 commit 9adcca5
Show file tree
Hide file tree
Showing 7 changed files with 65 additions and 64 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public class ContentMaker {
private static String role = "user";

/**
* Create a ContentMakerForRole for a given role.
* Creates a ContentMakerForRole for a given role.
*
* @param role Currently accepted role values are: "user", "model". No need to call forRole for
* the "user" role since it's the default role.
Expand Down Expand Up @@ -53,7 +53,7 @@ private static Content fromMultiModalDataWithRole(String role, Object... multiMo
}

/**
* Create a content from a string, assuming the role is "user".
* Creates a content from a string, assuming the role is "user".
*
* <p>The resulting content will contain one single {@link com.google.cloud.vertexai.api.Part}
* with its text field set.
Expand All @@ -65,7 +65,7 @@ public static Content fromString(String text) {
}

/**
* Create a content from an array of Objects, assuming the role is "user".
* Creates a content from an array of Objects, assuming the role is "user".
*
* <p>The resulting content can contain multiple {@link com.google.cloud.vertexai.api.Part}s. Each
* element in the array becomes one part.
Expand All @@ -91,7 +91,7 @@ private ContentMakerForRole(String role) {
}

/**
* Create a content from a string.
* Creates a content from a string.
*
* @param text a string which will be converted to a {@link com.google.cloud.vertexai.api.Part}
* with its text field set.
Expand All @@ -101,7 +101,7 @@ public Content fromString(String text) {
}

/**
* Create a content from an array of Objects.
* Creates a content from an array of Objects.
*
* @param multiModalData an array which contains the actual payload of each part. The element
* could be either a single String or a Part. When it's a single string, it's converted to a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public GenerateContentConfig build() {
}

/**
* Set {@link com.google.cloud.vertexai.api.GenerationConfig} that will be used in the generate
* Sets {@link com.google.cloud.vertexai.api.GenerationConfig} that will be used in the generate
* content API call.
*
* @return builder for the GenerateContentConfig
Expand All @@ -78,7 +78,7 @@ public Builder setGenerationConfig(GenerationConfig generationConfig) {
}

/**
* Set a list of {@link com.google.cloud.vertexai.api.SafetySetting} that will be used in the
* Sets a list of {@link com.google.cloud.vertexai.api.SafetySetting} that will be used in the
* generate content API call.
*
* @return builder for the GenerateContentConfig
Expand All @@ -90,7 +90,7 @@ public Builder setSafetySettings(List<SafetySetting> safetySettings) {
}

/**
* Set a list of {@link com.google.cloud.vertexai.api.Tool} that will be used in the generate
* Sets a list of {@link com.google.cloud.vertexai.api.Tool} that will be used in the generate
* content API call.
*
* @return builder for the GenerateContentConfig
Expand Down
Loading

0 comments on commit 9adcca5

Please sign in to comment.