firebase-ios-sdk/FirebaseVertexAI/Tests/Unit/GenerationConfigTests.swift

// Copyright 2024 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 FirebaseVertexAI
import Foundation
import XCTest

@available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
final class GenerationConfigTests: XCTestCase {
  let encoder = JSONEncoder()

  override func setUp() {
    encoder.outputFormatting = .init(
      arrayLiteral: .prettyPrinted, .sortedKeys, .withoutEscapingSlashes
    )
  }

  // MARK: GenerationConfig Encoding

  func testEncodeGenerationConfig_default() throws {
    let generationConfig = GenerationConfig()

    let jsonData = try encoder.encode(generationConfig)

    let json = try XCTUnwrap(String(data: jsonData, encoding: .utf8))
    XCTAssertEqual(json, """
    {

    }
    """)
  }

    func testEncodeGenerationConfig_allOptions() throws {
        let temperature: Float = 0.5
        let topP: Float = 0.75
        let topK = 40
        let candidateCount = 2
        let maxOutputTokens = 256
        let presencePenalty: Float = 0.5
        let frequencyPenalty: Float = 0.75
        let stopSequences = ["END", "DONE"]
        let responseMIMEType = "application/json"
        let responseModalities: [ContentModality] = [.text, .image, .audio]
        let generationConfig = GenerationConfig(
          temperature: temperature,
          topP: topP,
          topK: topK,
          candidateCount: candidateCount,
          maxOutputTokens: maxOutputTokens,
          presencePenalty: presencePenalty,
          frequencyPenalty: frequencyPenalty,
          stopSequences: stopSequences,
          responseMIMEType: responseMIMEType,
          responseSchema: .array(items: .string()),
            responseModalities: responseModalities
        )

        let jsonData = try encoder.encode(generationConfig)

        let json = try XCTUnwrap(String(data: jsonData, encoding: .utf8))
        XCTAssertEqual(json, """
        {
          "candidateCount" : \(candidateCount),
          "frequencyPenalty" : \(frequencyPenalty),
          "maxOutputTokens" : \(maxOutputTokens),
          "presencePenalty" : \(presencePenalty),
          "responseMimeType" : "\(responseMIMEType)",
          "responseModalities" : [
            "TEXT",
            "IMAGE",
            "AUDIO"
          ],
          "responseSchema" : {
            "items" : {
              "nullable" : false,
              "type" : "STRING"
            },
            "nullable" : false,
            "type" : "ARRAY"
          },
          "stopSequences" : [
            "END",
            "DONE"
          ],
          "temperature" : \(temperature),
          "topK" : \(topK),
          "topP" : \(topP)
        }
        """)
    }

  func testEncodeGenerationConfig_jsonResponse() throws {
    let mimeType = "application/json"
    let generationConfig = GenerationConfig(
      responseMIMEType: mimeType,
      responseSchema: .object(properties: [
        "firstName": .string(),
        "lastName": .string(),
        "age": .integer(),
      ])
    )

    let jsonData = try encoder.encode(generationConfig)

    let json = try XCTUnwrap(String(data: jsonData, encoding: .utf8))
    XCTAssertEqual(json, """
    {
      "responseMimeType" : "\(mimeType)",
      "responseSchema" : {
        "nullable" : false,
        "properties" : {
          "age" : {
            "nullable" : false,
            "type" : "INTEGER"
          },
          "firstName" : {
            "nullable" : false,
            "type" : "STRING"
          },
          "lastName" : {
            "nullable" : false,
            "type" : "STRING"
          }
        },
        "required" : [
          "age",
          "firstName",
          "lastName"
        ],
        "type" : "OBJECT"
      }
    }
    """)
  }
    
    func testEncodeGenerationConfig_with_responseModalities() throws {
      let responseModalities: [ContentModality] = [.text, .image, .audio]
      let generationConfig = GenerationConfig(responseModalities: responseModalities)

      let jsonData = try encoder.encode(generationConfig)

      let json = try XCTUnwrap(String(data: jsonData, encoding: .utf8))
      XCTAssertEqual(json, """
      {
        "responseModalities" : [
          "TEXT",
          "IMAGE",
          "AUDIO"
        ]
      }
      """)
    }
}

  func testEncodeGenerationConfig_jsonResponse() throws {
    let mimeType = "application/json"
    let generationConfig = GenerationConfig(
      responseMIMEType: mimeType,
      responseSchema: .object(properties: [
        "firstName": .string(),
        "lastName": .string(),
        "age": .integer(),
      ])
    )

    let jsonData = try encoder.encode(generationConfig)

    let json = try XCTUnwrap(String(data: jsonData, encoding: .utf8))
    XCTAssertEqual(json, """
    {
      "responseMimeType" : "\(mimeType)",
      "responseSchema" : {
        "nullable" : false,
        "properties" : {
          "age" : {
            "nullable" : false,
            "type" : "INTEGER"
          },
          "firstName" : {
            "nullable" : false,
            "type" : "STRING"
          },
          "lastName" : {
            "nullable" : false,
            "type" : "STRING"
          }
        },
        "required" : [
          "age",
          "firstName",
          "lastName"
        ],
        "type" : "OBJECT"
      }
    }
    """)
  }
}