// Code generated by sidekick. DO NOT EDIT.
//
// 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
//
//     https://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.

#if EvaluationService || GenAiTuningService
  import Foundation
  import GoogleCloudWkt

  /// Spec for pairwise metric.
  public struct PairwiseMetricSpec: Codable, Equatable, GoogleCloudWkt._AnyPackable,
    Sendable
  {
    /// Required. Metric prompt template for pairwise metric.
    public var metricPromptTemplate: Swift.String? = nil

    /// Optional. The field name of the candidate response.
    public var candidateResponseFieldName: Swift.String = Swift.String()

    /// Optional. The field name of the baseline response.
    public var baselineResponseFieldName: Swift.String = Swift.String()

    /// Optional. System instructions for pairwise metric.
    public var systemInstruction: Swift.String? = nil

    /// Optional. CustomOutputFormatConfig allows customization of metric output.
    /// When this config is set, the default output is replaced with
    /// the raw output string.
    /// If a custom format is chosen, the `pairwise_choice` and `explanation`
    /// fields in the corresponding metric result will be empty.
    public var customOutputFormatConfig: CustomOutputFormatConfig? = nil

    /// Initialize a new instance of `PairwiseMetricSpec`.
    public init() {}

    /// Use `config` to return a new instance of this object, with some fields updated.
    ///
    /// Commonly used to initialize the value, for example:
    ///
    /// ```
    /// let value = PairwiseMetricSpec().with { $0.metricPromptTemplate = ... }
    /// ```
    public func with(_ config: (inout Self) throws -> Swift.Void) rethrows -> Self {
      var copy = self
      try config(&copy)
      return copy
    }

    public static var _anyTypeUrl: Swift.String {
      return "type.googleapis.com/google.cloud.aiplatform.v1.PairwiseMetricSpec"
    }
    public init(fromAny any: GoogleCloudWkt.`Any`) throws {
      self = try GoogleCloudWkt._slowAnyDeserialize(Self.self, from: any)
    }
    public func _pack() throws -> GoogleCloudWkt.Struct {
      return try GoogleCloudWkt._slowAnySerialize(message: self)
    }
  }
#endif
