firebase-ios-sdk/FirebaseAI/Sources/GenerateContentRequest.swift

// Copyright 2023 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

@available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
struct GenerateContentRequest: Sendable {
  /// Model name.
  let model: String

  let contents: [ModelContent]
  let generationConfig: GenerationConfig?
  let safetySettings: [SafetySetting]?
  let tools: [Tool]?
  let toolConfig: ToolConfig?
  let systemInstruction: ModelContent?

  let apiConfig: APIConfig
  let apiMethod: APIMethod
  let options: RequestOptions
}

@available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
extension GenerateContentRequest: Encodable {
  enum CodingKeys: String, CodingKey {
    case model
    case contents
    case generationConfig
    case safetySettings
    case tools
    case toolConfig
    case systemInstruction
  }

  func encode(to encoder: any Encoder) throws {
    var container = encoder.container(keyedBy: CodingKeys.self)
    // The model name only needs to be encoded when this `GenerateContentRequest` instance is used
    // in a `CountTokensRequest` (calling `countTokens`). When calling `generateContent` or
    // `generateContentStream`, the `model` field is populated in the backend from the `url`.
    if apiMethod == .countTokens {
      try container.encode(model, forKey: .model)
    }
    try container.encode(contents, forKey: .contents)
    try container.encodeIfPresent(generationConfig, forKey: .generationConfig)
    try container.encodeIfPresent(safetySettings, forKey: .safetySettings)
    try container.encodeIfPresent(tools, forKey: .tools)
    try container.encodeIfPresent(toolConfig, forKey: .toolConfig)
    try container.encodeIfPresent(systemInstruction, forKey: .systemInstruction)
  }
}

@available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
extension GenerateContentRequest {
  enum APIMethod: String {
    case generateContent
    case streamGenerateContent
    case countTokens
  }
}

@available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
extension GenerateContentRequest: GenerativeAIRequest {
  typealias Response = GenerateContentResponse

  func getURL() throws -> URL {
    let modelURL = "\(apiConfig.service.endpoint.rawValue)/\(apiConfig.version.rawValue)/\(model)"
    let urlString: String
    switch apiMethod {
    case .generateContent:
      urlString = "\(modelURL):\(apiMethod.rawValue)"
    case .streamGenerateContent:
      urlString = "\(modelURL):\(apiMethod.rawValue)?alt=sse"
    case .countTokens:
      throw AILog.makeInternalError(
        message: "\(Self.self) should be a property of \(CountTokensRequest.self).",
        code: .malformedURL
      )
    }
    guard let url = URL(string: urlString) else {
      throw AILog.makeInternalError(message: "Malformed URL: \(urlString)", code: .malformedURL)
    }
    return url
  }
}