firebase-ios-sdk/FirebaseVertexAI/Sources/GenerativeAIRequest.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, *)
protocol GenerativeAIRequest: Sendable, Encodable {
  associatedtype Response: Decodable

  var url: URL { get }

  var options: RequestOptions { get }
}

/// Configuration parameters for sending requests to the backend.
@available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
// TODO(#14405): Make the `apiVersion` constructor public in Firebase 12 with a default of `.v1`.
public struct RequestOptions: Sendable {
  /// The request’s timeout interval in seconds; if not specified uses the default value for a
  /// `URLRequest`.
  let timeout: TimeInterval

  /// The API version to use in requests to the backend.
  let apiVersion: String

  /// Initializes a request options object.
  ///
  /// - Parameters:
  ///   - timeout: The request’s timeout interval in seconds; defaults to 180 seconds.
  ///   - apiVersion: The API version to use in requests to the backend.
  init(timeout: TimeInterval = 180.0, apiVersion: APIVersion) {
    self.timeout = timeout
    self.apiVersion = apiVersion.versionIdentifier
  }

  /// Initializes a request options object.
  ///
  /// - Parameters:
  ///   - timeout: The request’s timeout interval in seconds; defaults to 180 seconds.
  public init(timeout: TimeInterval = 180.0) {
    self.init(timeout: timeout, apiVersion: .v1beta)
  }
}

@available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
extension RequestOptions: Equatable {}