Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@ internal constructor(
/**
* Instantiates a new [GenerativeModel] given the provided parameters.
*
* @param modelName The name of the model to use, for example `"gemini-2.0-flash-exp"`.
* @param modelName The name of the model to use. See the documentation for a list of
* [supported models](https://firebase.google.com/docs/ai-logic/models).
* @param generationConfig The configuration parameters to use for content generation.
* @param safetySettings The safety bounds the model will abide to during content generation.
* @param tools A list of [Tool]s the model may use to generate content.
Expand Down Expand Up @@ -106,7 +107,8 @@ internal constructor(
/**
* Instantiates a new [LiveGenerationConfig] given the provided parameters.
*
* @param modelName The name of the model to use, for example `"gemini-2.0-flash-exp"`.
* @param modelName The name of the model to use. See the documentation for a list of
* [supported models](https://firebase.google.com/docs/ai-logic/models).
* @param generationConfig The configuration parameters to use for content generation.
* @param tools A list of [Tool]s the model may use to generate content.
* @param systemInstruction [Content] instructions that direct the model to behave a certain way.
Expand Down Expand Up @@ -157,7 +159,8 @@ internal constructor(
/**
* Instantiates a new [ImagenModel] given the provided parameters.
*
* @param modelName The name of the model to use, for example `"imagen-3.0-generate-001"`.
* @param modelName The name of the model to use. See the documentation for a list of
* [supported models](https://firebase.google.com/docs/ai-logic/models).
* @param generationConfig The configuration parameters to use for image generation.
* @param safetySettings The safety bounds the model will abide by during image generation.
* @param requestOptions Configuration options for sending requests to the backend.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ import com.google.firebase.auth.internal.InternalAuthProvider
/**
* Represents a generative model (like Imagen), capable of generating images based on various input
* types.
*
* See the documentation for a list of
* [supported models](https://firebase.google.com/docs/ai-logic/models).
*/
@PublicPreviewAPI
public class ImagenModel
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ internal constructor(
*
* @property category The category of harm being assessed (e.g., Hate speech).
* @property probability The likelihood of the content causing harm.
* @property probabilityScore A numerical score representing the probability of harm, between 0 and
* 1.
* @property probabilityScore A numerical score representing the probability of harm, between `0`
* and `1`.
* @property blocked Indicates whether the content was blocked due to safety concerns.
* @property severity The severity of the potential harm.
* @property severityScore A numerical score representing the severity of harm.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,13 @@ import kotlinx.serialization.Serializable
* The model's response to a count tokens request.
*
* **Important:** The counters in this class do not include billable image, video or other non-text
* input. See [Vertex AI pricing](https://cloud.google.com/vertex-ai/generative-ai/pricing) for
* details.
* input. See [Pricing](https://firebase.google.com/docs/ai-logic/pricing) for details.
*
* @property totalTokens The total number of tokens in the input given to the model as a prompt.
* @property totalBillableCharacters The total number of billable characters in the text input given
* to the model as a prompt. **Important:** this property does not include billable image, video or
* other non-text input. See
* [Vertex AI pricing](https://cloud.google.com/vertex-ai/generative-ai/pricing) for details.
* other non-text input. See [Pricing](https://firebase.google.com/docs/ai-logic/pricing) for
* details.
* @property promptTokensDetails The breakdown, by modality, of how many tokens are consumed by the
* prompt.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ internal constructor(
*
* @param inlineData the binary data as a [ByteArray]
* @param mimeType an IANA standard MIME type. For supported values, see the
* [Vertex AI documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/send-multimodal-prompts#media_requirements)
* [Firebase documentation](https://firebase.google.com/docs/vertex-ai/input-file-requirements).
*/
public class InlineDataPart
internal constructor(
Expand Down
Loading