Files
firebase-ios-sdk/GeminiLanguageModel/Sources/GeminiAPIDataModels/GenerateContent/FunctionCallingConfig+Mode.swift
T

81 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
extension FunctionCallingConfig {
/// Optional. Specifies the mode in which function calling should execute. If
///
/// ### Gemini Developer API
///
/// Optional. Specifies the mode in which function calling should execute. If
/// unspecified, the default value will be set to AUTO.
///
/// ### Gemini Enterprise API
///
/// Optional. Function calling mode.
package enum Mode: Codable, Sendable, Equatable, Hashable {
/// Default model behavior, model decides to predict either a function call
/// or a natural language response.
case auto
/// Model is constrained to always predicting a function call only.
/// If "allowed_function_names" are set, the predicted function call will be
/// limited to any one of "allowed_function_names", else the predicted
/// function call will be any one of the provided "function_declarations".
case `any`
/// Model will not predict any function call. Model behavior is same as when
/// not passing any function declarations.
case none
/// Model decides to predict either a function call
/// or a natural language response, but will validate function calls with
/// constrained decoding.
/// If "allowed_function_names" are set, the predicted function call will be
/// limited to any one of "allowed_function_names", else the predicted
/// function call will be any one of the provided "function_declarations".
case validated
/// Unrecognized case.
///
/// - Parameter value: The raw string value of the unrecognized enum case.
case unrecognized(_ value: String)
}
}
// MARK: - RawRepresentable Conformance
extension FunctionCallingConfig.Mode: RawRepresentable {
package var rawValue: String {
switch self {
case .auto: "AUTO"
case .`any`: "ANY"
case .none: "NONE"
case .validated: "VALIDATED"
case .unrecognized(let value): value
}
}
package init(rawValue: String) {
switch rawValue {
case "AUTO": self = .auto
case "ANY": self = .`any`
case "NONE": self = .none
case "VALIDATED": self = .validated
default: self = .unrecognized(rawValue)
}
}
}