Files
firebase-ios-sdk/GeminiLanguageModel/Sources/GeminiAPIDataModels/GenerateContent/Modality.swift
T

73 lines
1.8 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 `Modality`.
///
/// ### Gemini Developer API
///
/// Type: `GoogleAiGenerativelanguageV1betaModality`
///
/// ### Gemini Enterprise API
///
/// > Important: This type is not supported in the Gemini Enterprise API.
package enum Modality: Codable, Sendable, Equatable, Hashable {
/// Plain text.
case text
/// Image.
case image
/// Video.
case video
/// Audio.
case audio
/// Document, e.g. PDF.
case document
/// Unrecognized case.
///
/// - Parameter value: The raw string value of the unrecognized enum case.
case unrecognized(_ value: String)
}
// MARK: - RawRepresentable Conformance
extension Modality: RawRepresentable {
package var rawValue: String {
switch self {
case .text: "TEXT"
case .image: "IMAGE"
case .video: "VIDEO"
case .audio: "AUDIO"
case .document: "DOCUMENT"
case .unrecognized(let value): value
}
}
package init(rawValue: String) {
switch rawValue {
case "TEXT": self = .text
case "IMAGE": self = .image
case "VIDEO": self = .video
case "AUDIO": self = .audio
case "DOCUMENT": self = .document
default: self = .unrecognized(rawValue)
}
}
}