sdk/lib/model/ai_ranked_doc.dart

//
// AUTO-GENERATED FILE, DO NOT MODIFY!
//
// @dart=2.18

// ignore_for_file: unused_element, unused_import
// ignore_for_file: always_put_required_named_parameters_first
// ignore_for_file: constant_identifier_names
// ignore_for_file: lines_longer_than_80_chars

part of hanzoai.cloud;

class AiRankedDoc {
  /// Returns a new [AiRankedDoc] instance.
  AiRankedDoc({
    this.document,
    this.index,
    this.relevanceScore,
  });
  ///
  /// Please note: This property should have been non-nullable! Since the specification file
  /// does not include a default value (using the "default:" property), however, the generated
  /// source code must fall back to having a nullable type.
  /// Consider adding a "default:" property in the specification file to hide this note.
  ///
  AiRankedText? document;

  ///
  /// Please note: This property should have been non-nullable! Since the specification file
  /// does not include a default value (using the "default:" property), however, the generated
  /// source code must fall back to having a nullable type.
  /// Consider adding a "default:" property in the specification file to hide this note.
  ///
  int? index;

  ///
  /// Please note: This property should have been non-nullable! Since the specification file
  /// does not include a default value (using the "default:" property), however, the generated
  /// source code must fall back to having a nullable type.
  /// Consider adding a "default:" property in the specification file to hide this note.
  ///
  num? relevanceScore;

  @override
  bool operator ==(Object other) => identical(this, other) || other is AiRankedDoc &&
    other.document == document &&
    other.index == index &&
    other.relevanceScore == relevanceScore;

  @override
  int get hashCode =>
    // ignore: unnecessary_parenthesis
    (document == null ? 0 : document!.hashCode) +
    (index == null ? 0 : index!.hashCode) +
    (relevanceScore == null ? 0 : relevanceScore!.hashCode);

  @override
  String toString() => 'AiRankedDoc[document=$document, index=$index, relevanceScore=$relevanceScore]';

  Map<String, dynamic> toJson() {
    final json = <String, dynamic>{};
    if (this.document != null) {
      json[r'document'] = this.document;
    } else {
      json[r'document'] = null;
    }
    if (this.index != null) {
      json[r'index'] = this.index;
    } else {
      json[r'index'] = null;
    }
    if (this.relevanceScore != null) {
      json[r'relevance_score'] = this.relevanceScore;
    } else {
      json[r'relevance_score'] = null;
    }
    return json;
  }

  /// Returns a new [AiRankedDoc] instance and imports its values from
  /// [value] if it's a [Map], null otherwise.
  // ignore: prefer_constructors_over_static_methods
  static AiRankedDoc? fromJson(dynamic value) {
    if (value is Map) {
      final json = value.cast<String, dynamic>();

      // Ensure that the map contains the required keys.
      // Note 1: the values aren't checked for validity beyond being non-null.
      // Note 2: this code is stripped in release mode!
      assert(() {
        requiredKeys.forEach((key) {
          assert(json.containsKey(key), 'Required key "AiRankedDoc[$key]" is missing from JSON.');
          assert(json[key] != null, 'Required key "AiRankedDoc[$key]" has a null value in JSON.');
        });
        return true;
      }());

      return AiRankedDoc(
        document: AiRankedText.fromJson(json[r'document']),
        index: mapValueOfType<int>(json, r'index'),
        relevanceScore: num.parse('${json[r'relevance_score']}'),
      );
    }
    return null;
  }

  static List<AiRankedDoc> listFromJson(dynamic json, {bool growable = false,}) {
    final result = <AiRankedDoc>[];
    if (json is List && json.isNotEmpty) {
      for (final row in json) {
        final value = AiRankedDoc.fromJson(row);
        if (value != null) {
          result.add(value);
        }
      }
    }
    return result.toList(growable: growable);
  }

  static Map<String, AiRankedDoc> mapFromJson(dynamic json) {
    final map = <String, AiRankedDoc>{};
    if (json is Map && json.isNotEmpty) {
      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
      for (final entry in json.entries) {
        final value = AiRankedDoc.fromJson(entry.value);
        if (value != null) {
          map[entry.key] = value;
        }
      }
    }
    return map;
  }

  // maps a json object with a list of AiRankedDoc-objects as value to a dart map
  static Map<String, List<AiRankedDoc>> mapListFromJson(dynamic json, {bool growable = false,}) {
    final map = <String, List<AiRankedDoc>>{};
    if (json is Map && json.isNotEmpty) {
      // ignore: parameter_assignments
      json = json.cast<String, dynamic>();
      for (final entry in json.entries) {
        map[entry.key] = AiRankedDoc.listFromJson(entry.value, growable: growable,);
      }
    }
    return map;
  }

  /// The list of required keys that must be present in a JSON.
  static const requiredKeys = <String>{
  };
}