Skip to content

update vertex javadocs to match what's live #6149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 1, 2024
Merged

update vertex javadocs to match what's live #6149

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
43b1d97
update vertex javadocs to match what's live
Aug 1, 2024
99d9eb5
format
Aug 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/GenerationConfig.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,12 @@ package com.google.firebase.vertexai.type
* @property candidateCount The max *unique* responses to return
* @property maxOutputTokens The max tokens to generate per response
* @property stopSequences A list of strings to stop generation on occurrence of
* @property responseMimeType Response type for generated candidate text. See the
* [vertex docs](https://cloud.google.com/vertex-ai/docs/reference/rest/v1beta1/GenerationConfig)
* @property responseMimeType Response MIME type for the generated candidate text. For a list of
* supported response MIME types, see the
* [Vertex AI documentation](https://cloud.google.com/vertex-ai/docs/reference/rest/v1beta1/GenerationConfig#FIELDS.response_mime_type)
* for a list of supported types.
* @property responseSchema A schema that the response must adhere to, used with the
* `application/json` mimeType.
* `application/json` MINE type.
*/
class GenerationConfig
private constructor(
Expand All @@ -55,7 +56,6 @@ private constructor(
* @property candidateCount The max *unique* responses to return
* @property maxOutputTokens The max tokens to generate per response
* @property stopSequences A list of strings to stop generation on occurrence of
*
* @see [generationConfig]
*/
class Builder {
Expand All @@ -78,15 +78,14 @@ private constructor(
maxOutputTokens = maxOutputTokens,
stopSequences = stopSequences,
responseMimeType = responseMimeType,
responseSchema = responseSchema
responseSchema = responseSchema,
)
}

companion object {

/**
* Alternative casing for [GenerationConfig.Builder]:
*
* ```
* val config = GenerationConfig.builder()
* ```
Expand Down
Loading