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

  /// Relevant contexts for one query.
  public struct RagContexts: Codable, Equatable, GoogleCloudWkt._AnyPackable,
    Sendable
  {
    /// All its contexts.
    public var contexts: [RagContexts.Context] = []

    /// Initialize a new instance of `RagContexts`.
    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 = RagContexts().with { $0.contexts = ... }
    /// ```
    public func with(_ config: (inout Self) throws -> Swift.Void) rethrows -> Self {
      var copy = self
      try config(&copy)
      return copy
    }

    /// A context of the query.
    public struct Context: Codable, Equatable, GoogleCloudWkt._AnyPackable,
      Sendable
    {
      /// If the file is imported from Cloud Storage or Google Drive, source_uri
      /// will be original file URI in Cloud Storage or Google Drive; if file is
      /// uploaded, source_uri will be file display name.
      public var sourceUri: Swift.String = Swift.String()

      /// The file display name.
      public var sourceDisplayName: Swift.String = Swift.String()

      /// The text chunk.
      public var text: Swift.String = Swift.String()

      /// According to the underlying Vector DB and the selected metric type, the
      /// score can be either the distance or the similarity between the query and
      /// the context and its range depends on the metric type.
      ///
      /// For example, if the metric type is COSINE_DISTANCE, it represents the
      /// distance between the query and the context. The larger the distance, the
      /// less relevant the context is to the query. The range is [0, 2], while 0
      /// means the most relevant and 2 means the least relevant.
      public var score: Swift.Double? = nil

      /// Context of the retrieved chunk.
      public var chunk: RagChunk? = nil

      /// Initialize a new instance of `Context`.
      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 = Context().with { $0.sourceUri = ... }
      /// ```
      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.RagContexts.Context"
      }
      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)
      }
    }

    public static var _anyTypeUrl: Swift.String {
      return "type.googleapis.com/google.cloud.aiplatform.v1.RagContexts"
    }
    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
