Skip to content

Commit 42baeb3

Browse files
authored
[Vertex AI] Update DocC links to Firebase docsite where available (#14555)
1 parent bec50f9 commit 42baeb3

9 files changed

+28
-19
lines changed

FirebaseVertexAI/CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@
143143
instead of the `Any` type. (#13575)
144144
- [added] Added support for specifying a JSON `responseSchema` in
145145
`GenerationConfig`; see
146-
[control generated output](https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/control-generated-output)
146+
[control generated output](https://firebase.google.com/docs/vertex-ai/structured-output?platform=ios)
147147
for more details. (#13576)
148148

149149
# 10.29.0

FirebaseVertexAI/Sources/CountTokensRequest.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public struct CountTokensResponse {
4646
/// The total number of billable characters in the text input given to the model as a prompt.
4747
///
4848
/// > Important: This does not include billable image, video or other non-text input. See
49-
/// [Vertex AI pricing](https://cloud.google.com/vertex-ai/generative-ai/pricing) for details.
49+
/// [Vertex AI pricing](https://firebase.google.com/docs/vertex-ai/pricing) for details.
5050
public let totalBillableCharacters: Int?
5151

5252
/// The breakdown, by modality, of how many tokens are consumed by the prompt.

FirebaseVertexAI/Sources/FunctionCalling.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ public struct Tool: Sendable {
6868
/// Function calling can be used to provide data to the model that was not known at the time it
6969
/// was trained (for example, the current date or weather conditions) or to allow it to interact
7070
/// with external systems (for example, making an API request or querying/updating a database).
71-
/// For more details and use cases, see [Introduction to function
72-
/// calling](https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/function-calling).
71+
/// For more details and use cases, see [Function calling using the Gemini
72+
/// API](http://firebase.google.com/docs/vertex-ai/function-calling?platform=ios).
7373
///
7474
/// - Parameters:
7575
/// - functionDeclarations: A list of `FunctionDeclarations` available to the model that can be

FirebaseVertexAI/Sources/GenerationConfig.swift

+7-6
Original file line numberDiff line numberDiff line change
@@ -66,16 +66,16 @@ public struct GenerationConfig: Sendable {
6666
/// > of variation is still possible.
6767
///
6868
/// > Important: The range of supported temperature values depends on the model; see the
69-
/// > [Cloud documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#generationconfig)
69+
/// > [documentation](https://firebase.google.com/docs/vertex-ai/model-parameters?platform=ios#temperature)
7070
/// > for more details.
7171
/// - topP: Controls diversity of generated text. Higher values (e.g., 0.9) produce more diverse
7272
/// text, while lower values (e.g., 0.5) make the output more focused.
7373
///
7474
/// The supported range is 0.0 to 1.0.
7575
///
7676
/// > Important: The default `topP` value depends on the model; see the
77-
/// [Cloud documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#generationconfig)
78-
/// for more details.
77+
/// > [documentation](https://firebase.google.com/docs/vertex-ai/model-parameters?platform=ios#top-p)
78+
/// > for more details.
7979
/// - topK: Limits the number of highest probability words the model considers when generating
8080
/// text. For example, a topK of 40 means only the 40 most likely words are considered for the
8181
/// next token. A higher value increases diversity, while a lower value makes the output more
@@ -84,7 +84,7 @@ public struct GenerationConfig: Sendable {
8484
/// The supported range is 1 to 40.
8585
///
8686
/// > Important: Support for `topK` and the default value depends on the model; see the
87-
/// [Cloud documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#generationconfig)
87+
/// [documentation](https://firebase.google.com/docs/vertex-ai/model-parameters?platform=ios#top-k)
8888
/// for more details.
8989
/// - candidateCount: The number of response variations to return; defaults to 1 if not set.
9090
/// Support for multiple candidates depends on the model; see the
@@ -137,8 +137,9 @@ public struct GenerationConfig: Sendable {
137137
/// - `application/json`: Schema for JSON response.
138138
///
139139
/// Refer to the
140-
/// [Control generated output](https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/control-generated-output)
141-
/// guide for more details.
140+
/// [Generate structured
141+
/// output](https://firebase.google.com/docs/vertex-ai/structured-output?platform=ios) guide
142+
/// for more details.
142143
public init(temperature: Float? = nil, topP: Float? = nil, topK: Int? = nil,
143144
candidateCount: Int? = nil, maxOutputTokens: Int? = nil,
144145
presencePenalty: Float? = nil, frequencyPenalty: Float? = nil,

FirebaseVertexAI/Sources/Safety.swift

+4
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,10 @@ public struct SafetyRating: Equatable, Hashable, Sendable {
145145

146146
/// A type used to specify a threshold for harmful content, beyond which the model will return a
147147
/// fallback response instead of generated content.
148+
///
149+
/// See [safety settings for Gemini
150+
/// models](https://firebase.google.com/docs/vertex-ai/safety-settings?platform=ios#gemini) for
151+
/// more details.
148152
@available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
149153
public struct SafetySetting: Sendable {
150154
/// Block at and beyond a specified ``SafetyRating/HarmProbability``.

FirebaseVertexAI/Sources/Types/Public/Imagen/ImagenGenerationConfig.swift

+4
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@
1313
// limitations under the License.
1414

1515
/// Configuration options for generating images with Imagen.
16+
///
17+
/// See [Parameters for Imagen
18+
/// models](https://firebase.google.com/docs/vertex-ai/model-parameters?platform=ios#imagen) to
19+
/// learn about parameters available for use with Imagen models, including how to configure them.
1620
@available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
1721
public struct ImagenGenerationConfig {
1822
/// Specifies elements to exclude from the generated image.

FirebaseVertexAI/Sources/Types/Public/Imagen/ImagenModel.swift

+4-3
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,10 @@ import Foundation
1818

1919
/// Represents a remote Imagen model with the ability to generate images using text prompts.
2020
///
21-
/// See the [Cloud
22-
/// documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/image/generate-images) for
23-
/// more details about the image generation capabilities offered by the Imagen model.
21+
/// See the [generate images
22+
/// documentation](https://firebase.google.com/docs/vertex-ai/generate-images-imagen?platform=ios)
23+
/// for more details about the image generation capabilities offered by the Imagen model in the
24+
/// Vertex AI in Firebase SDK.
2425
///
2526
/// > Warning: For Vertex AI in Firebase, image generation using Imagen 3 models is in Public
2627
/// Preview, which means that the feature is not subject to any SLA or deprecation policy and

FirebaseVertexAI/Sources/Types/Public/Part.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,9 @@ public struct FileDataPart: Part {
8989
/// - uri: The `"gs://"`-prefixed URI of the file in Cloud Storage for Firebase, for example,
9090
/// `"gs://bucket-name/path/image.jpg"`.
9191
/// - mimeType: The IANA standard MIME type of the uploaded file, for example, `"image/jpeg"`
92-
/// or `"video/mp4"`; see [media requirements
93-
/// ](https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/send-multimodal-prompts#media_requirements)
94-
/// for supported values.
92+
/// or `"video/mp4"`; see [supported input files and
93+
/// requirements](https://firebase.google.com/docs/vertex-ai/input-file-requirements) for
94+
/// supported values.
9595
public init(uri: String, mimeType: String) {
9696
self.init(FileData(fileURI: uri, mimeType: mimeType))
9797
}

FirebaseVertexAI/Sources/VertexAI.swift

+2-3
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,8 @@ public class VertexAI {
9393
///
9494
/// - Parameters:
9595
/// - modelName: The name of the Imagen 3 model to use, for example `"imagen-3.0-generate-002"`;
96-
/// see [model
97-
/// versions](https://cloud.google.com/vertex-ai/generative-ai/docs/image/model-versioning)
98-
/// for a list of supported Imagen 3 models.
96+
/// see [model versions](https://firebase.google.com/docs/vertex-ai/models) for a list of
97+
/// supported Imagen 3 models.
9998
/// - generationConfig: Configuration options for generating images with Imagen.
10099
/// - safetySettings: Settings describing what types of potentially harmful content your model
101100
/// should allow.

0 commit comments

Comments
 (0)