mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-09 22:36:01 +05:45
65 lines
2.7 KiB
Swift
65 lines
2.7 KiB
Swift
// Copyright 2026 Google LLC
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
import Foundation
|
|
|
|
/// An internal data model for `RetrievalMetadata`.
|
|
///
|
|
/// ### Gemini Developer API
|
|
///
|
|
/// Type: `GoogleAiGenerativelanguageV1betaRetrievalMetadata`
|
|
///
|
|
/// Metadata related to retrieval in the grounding flow.
|
|
///
|
|
/// ### Gemini Enterprise API
|
|
///
|
|
/// Type: `GoogleCloudAiplatformV1beta1RetrievalMetadata`
|
|
///
|
|
/// Metadata related to the retrieval grounding source. This is part
|
|
/// of the `GroundingMetadata` returned when grounding is enabled.
|
|
package struct RetrievalMetadata: Codable, Sendable, Equatable, Hashable {
|
|
/// Optional. Score indicating how likely information from google search could help
|
|
///
|
|
/// ### Gemini Developer API
|
|
///
|
|
/// Optional. Score indicating how likely information from google search could help
|
|
/// answer the prompt. The score is in the range [0, 1], where 0 is the least
|
|
/// likely and 1 is the most likely. This score is only populated when
|
|
/// google search grounding and dynamic retrieval is enabled. It will be
|
|
/// compared to the threshold to determine whether to trigger google search.
|
|
///
|
|
/// ### Gemini Enterprise API
|
|
///
|
|
/// Optional. A score indicating how likely it is that a Google
|
|
/// Search query could help answer the prompt. The score is in the range of
|
|
/// `[0, 1]`. A score of 1 means the model is confident that a search will be
|
|
/// helpful, and 0 means it is not. This score is populated only when Google
|
|
/// Search grounding and dynamic retrieval are enabled. The score is used to
|
|
/// determine whether to trigger a search.
|
|
package let googleSearchDynamicRetrievalScore: Double?
|
|
|
|
/// Creates a new `RetrievalMetadata`.
|
|
///
|
|
/// - Parameters:
|
|
/// - googleSearchDynamicRetrievalScore: Optional. Score indicating how likely information from google search could help (behavior varies by backend). For more details, see ``googleSearchDynamicRetrievalScore``.
|
|
package init(
|
|
googleSearchDynamicRetrievalScore: Double? = nil
|
|
) {
|
|
self.googleSearchDynamicRetrievalScore = googleSearchDynamicRetrievalScore
|
|
}
|
|
enum CodingKeys: String, CodingKey {
|
|
case googleSearchDynamicRetrievalScore = "googleSearchDynamicRetrievalScore"
|
|
}
|
|
}
|