// 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 RankService
  import Foundation
  import GoogleCloudWkt

  /// Record message for
  /// [RankService.Rank][google.cloud.discoveryengine.v1.RankService.Rank] method.
  ///
  /// [google.cloud.discoveryengine.v1.RankService.Rank]: <doc:RankService/rank(request:)>
  public struct RankingRecord: Codable, Equatable, GoogleCloudWkt._AnyPackable,
    Sendable
  {
    /// The unique ID to represent the record.
    public var id: Swift.String = Swift.String()

    /// The title of the record. Empty by default.
    /// At least one of
    /// [title][google.cloud.discoveryengine.v1.RankingRecord.title] or
    /// [content][google.cloud.discoveryengine.v1.RankingRecord.content] should be
    /// set otherwise an INVALID_ARGUMENT error is thrown.
    ///
    /// [google.cloud.discoveryengine.v1.RankingRecord.content]: <doc:RankingRecord/content>
    /// [google.cloud.discoveryengine.v1.RankingRecord.title]: <doc:RankingRecord/title>
    public var title: Swift.String = Swift.String()

    /// The content of the record. Empty by default.
    /// At least one of
    /// [title][google.cloud.discoveryengine.v1.RankingRecord.title] or
    /// [content][google.cloud.discoveryengine.v1.RankingRecord.content] should be
    /// set otherwise an INVALID_ARGUMENT error is thrown.
    ///
    /// [google.cloud.discoveryengine.v1.RankingRecord.content]: <doc:RankingRecord/content>
    /// [google.cloud.discoveryengine.v1.RankingRecord.title]: <doc:RankingRecord/title>
    public var content: Swift.String = Swift.String()

    /// The score of this record based on the given query and selected model.
    /// The score will be rounded to 2 decimal places. If the score is close to 0,
    /// it will be rounded to 0.0001 to avoid returning unset.
    public var score: Swift.Float = Swift.Float()

    /// Initialize a new instance of `RankingRecord`.
    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 = RankingRecord().with { $0.id = ... }
    /// ```
    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.discoveryengine.v1.RankingRecord"
    }
    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
