openlayer 0.9.1 → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -27,11 +27,33 @@ module Openlayer
27
27
  # @return [String, nil]
28
28
  required :status_message, String, api_name: :statusMessage, nil?: true
29
29
 
30
+ # @!attribute expected_values
31
+ #
32
+ # @return [Array<Openlayer::Models::InferencePipelines::TestResultListResponse::Item::ExpectedValue>, nil]
33
+ optional :expected_values,
34
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::InferencePipelines::TestResultListResponse::Item::ExpectedValue] },
35
+ api_name: :expectedValues
36
+
30
37
  # @!attribute goal
31
38
  #
32
39
  # @return [Openlayer::Models::InferencePipelines::TestResultListResponse::Item::Goal, nil]
33
40
  optional :goal, -> { Openlayer::Models::InferencePipelines::TestResultListResponse::Item::Goal }
34
41
 
42
+ # @!attribute rows
43
+ # The URL to the rows of the test result.
44
+ #
45
+ # @return [String, nil]
46
+ optional :rows, String
47
+
48
+ # @!attribute rows_body
49
+ # The body of the rows request.
50
+ #
51
+ # @return [Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody, nil]
52
+ optional :rows_body,
53
+ -> { Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody },
54
+ api_name: :rowsBody,
55
+ nil?: true
56
+
35
57
  response_only do
36
58
  # @!attribute id
37
59
  # Project version (commit) id.
@@ -82,7 +104,7 @@ module Openlayer
82
104
  optional :goal_id, String, api_name: :goalId, nil?: true
83
105
  end
84
106
 
85
- # @!method initialize(id:, date_created:, date_data_ends:, date_data_starts:, date_updated:, inference_pipeline_id:, project_version_id:, status:, status_message:, goal: nil, goal_id: nil)
107
+ # @!method initialize(id:, date_created:, date_data_ends:, date_data_starts:, date_updated:, inference_pipeline_id:, project_version_id:, status:, status_message:, expected_values: nil, goal: nil, goal_id: nil, rows: nil, rows_body: nil)
86
108
  # @param id [String] Project version (commit) id.
87
109
  #
88
110
  # @param date_created [Time] The creation date.
@@ -101,9 +123,15 @@ module Openlayer
101
123
  #
102
124
  # @param status_message [String, nil] The status message.
103
125
  #
126
+ # @param expected_values [Array<Openlayer::Models::InferencePipelines::TestResultListResponse::Item::ExpectedValue>]
127
+ #
104
128
  # @param goal [Openlayer::Models::InferencePipelines::TestResultListResponse::Item::Goal]
105
129
  #
106
130
  # @param goal_id [String, nil] The test id.
131
+ #
132
+ # @param rows [String] The URL to the rows of the test result.
133
+ #
134
+ # @param rows_body [Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody, nil] The body of the rows request.
107
135
 
108
136
  # The status of the test.
109
137
  #
@@ -121,6 +149,33 @@ module Openlayer
121
149
  # @return [Array<Symbol>]
122
150
  end
123
151
 
152
+ class ExpectedValue < Openlayer::Internal::Type::BaseModel
153
+ # @!attribute lower_threshold
154
+ # the lower threshold for the expected value
155
+ #
156
+ # @return [Float, nil]
157
+ optional :lower_threshold, Float, api_name: :lowerThreshold, nil?: true
158
+
159
+ # @!attribute measurement
160
+ # One of the `measurement` values in the test's thresholds
161
+ #
162
+ # @return [String, nil]
163
+ optional :measurement, String
164
+
165
+ # @!attribute upper_threshold
166
+ # The upper threshold for the expected value
167
+ #
168
+ # @return [Float, nil]
169
+ optional :upper_threshold, Float, api_name: :upperThreshold, nil?: true
170
+
171
+ # @!method initialize(lower_threshold: nil, measurement: nil, upper_threshold: nil)
172
+ # @param lower_threshold [Float, nil] the lower threshold for the expected value
173
+ #
174
+ # @param measurement [String] One of the `measurement` values in the test's thresholds
175
+ #
176
+ # @param upper_threshold [Float, nil] The upper threshold for the expected value
177
+ end
178
+
124
179
  # @see Openlayer::Models::InferencePipelines::TestResultListResponse::Item#goal
125
180
  class Goal < Openlayer::Internal::Type::BaseModel
126
181
  # @!attribute description
@@ -561,6 +616,236 @@ module Openlayer
561
616
  # @return [Array<Symbol>]
562
617
  end
563
618
  end
619
+
620
+ # @see Openlayer::Models::InferencePipelines::TestResultListResponse::Item#rows_body
621
+ class RowsBody < Openlayer::Internal::Type::BaseModel
622
+ # @!attribute column_filters
623
+ #
624
+ # @return [Array<Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::SetColumnFilter, Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::NumericColumnFilter, Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::StringColumnFilter>, nil]
625
+ optional :column_filters,
626
+ -> { Openlayer::Internal::Type::ArrayOf[union: Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter] },
627
+ api_name: :columnFilters,
628
+ nil?: true
629
+
630
+ # @!attribute exclude_row_id_list
631
+ #
632
+ # @return [Array<Integer>, nil]
633
+ optional :exclude_row_id_list,
634
+ Openlayer::Internal::Type::ArrayOf[Integer],
635
+ api_name: :excludeRowIdList,
636
+ nil?: true
637
+
638
+ # @!attribute not_search_query_and
639
+ #
640
+ # @return [Array<String>, nil]
641
+ optional :not_search_query_and,
642
+ Openlayer::Internal::Type::ArrayOf[String],
643
+ api_name: :notSearchQueryAnd,
644
+ nil?: true
645
+
646
+ # @!attribute not_search_query_or
647
+ #
648
+ # @return [Array<String>, nil]
649
+ optional :not_search_query_or,
650
+ Openlayer::Internal::Type::ArrayOf[String],
651
+ api_name: :notSearchQueryOr,
652
+ nil?: true
653
+
654
+ # @!attribute row_id_list
655
+ #
656
+ # @return [Array<Integer>, nil]
657
+ optional :row_id_list,
658
+ Openlayer::Internal::Type::ArrayOf[Integer],
659
+ api_name: :rowIdList,
660
+ nil?: true
661
+
662
+ # @!attribute search_query_and
663
+ #
664
+ # @return [Array<String>, nil]
665
+ optional :search_query_and,
666
+ Openlayer::Internal::Type::ArrayOf[String],
667
+ api_name: :searchQueryAnd,
668
+ nil?: true
669
+
670
+ # @!attribute search_query_or
671
+ #
672
+ # @return [Array<String>, nil]
673
+ optional :search_query_or,
674
+ Openlayer::Internal::Type::ArrayOf[String],
675
+ api_name: :searchQueryOr,
676
+ nil?: true
677
+
678
+ # @!method initialize(column_filters: nil, exclude_row_id_list: nil, not_search_query_and: nil, not_search_query_or: nil, row_id_list: nil, search_query_and: nil, search_query_or: nil)
679
+ # The body of the rows request.
680
+ #
681
+ # @param column_filters [Array<Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::SetColumnFilter, Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::NumericColumnFilter, Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::StringColumnFilter>, nil]
682
+ # @param exclude_row_id_list [Array<Integer>, nil]
683
+ # @param not_search_query_and [Array<String>, nil]
684
+ # @param not_search_query_or [Array<String>, nil]
685
+ # @param row_id_list [Array<Integer>, nil]
686
+ # @param search_query_and [Array<String>, nil]
687
+ # @param search_query_or [Array<String>, nil]
688
+
689
+ module ColumnFilter
690
+ extend Openlayer::Internal::Type::Union
691
+
692
+ variant -> { Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::SetColumnFilter }
693
+
694
+ variant -> { Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::NumericColumnFilter }
695
+
696
+ variant -> { Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::StringColumnFilter }
697
+
698
+ class SetColumnFilter < Openlayer::Internal::Type::BaseModel
699
+ # @!attribute measurement
700
+ # The name of the column.
701
+ #
702
+ # @return [String]
703
+ required :measurement, String
704
+
705
+ # @!attribute operator
706
+ #
707
+ # @return [Symbol, Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::SetColumnFilter::Operator]
708
+ required :operator,
709
+ enum: -> { Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::SetColumnFilter::Operator }
710
+
711
+ # @!attribute value
712
+ #
713
+ # @return [Array<String, Float>]
714
+ required :value,
715
+ -> do
716
+ Openlayer::Internal::Type::ArrayOf[
717
+ union: Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::SetColumnFilter::Value
718
+ ]
719
+ end
720
+
721
+ # @!method initialize(measurement:, operator:, value:)
722
+ # @param measurement [String] The name of the column.
723
+ #
724
+ # @param operator [Symbol, Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::SetColumnFilter::Operator]
725
+ #
726
+ # @param value [Array<String, Float>]
727
+
728
+ # @see Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::SetColumnFilter#operator
729
+ module Operator
730
+ extend Openlayer::Internal::Type::Enum
731
+
732
+ CONTAINS_NONE = :contains_none
733
+ CONTAINS_ANY = :contains_any
734
+ CONTAINS_ALL = :contains_all
735
+ ONE_OF = :one_of
736
+ NONE_OF = :none_of
737
+
738
+ # @!method self.values
739
+ # @return [Array<Symbol>]
740
+ end
741
+
742
+ module Value
743
+ extend Openlayer::Internal::Type::Union
744
+
745
+ variant String
746
+
747
+ variant Float
748
+
749
+ # @!method self.variants
750
+ # @return [Array(String, Float)]
751
+ end
752
+ end
753
+
754
+ class NumericColumnFilter < Openlayer::Internal::Type::BaseModel
755
+ # @!attribute measurement
756
+ # The name of the column.
757
+ #
758
+ # @return [String]
759
+ required :measurement, String
760
+
761
+ # @!attribute operator
762
+ #
763
+ # @return [Symbol, Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::NumericColumnFilter::Operator]
764
+ required :operator,
765
+ enum: -> { Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::NumericColumnFilter::Operator }
766
+
767
+ # @!attribute value
768
+ #
769
+ # @return [Float, nil]
770
+ required :value, Float, nil?: true
771
+
772
+ # @!method initialize(measurement:, operator:, value:)
773
+ # @param measurement [String] The name of the column.
774
+ #
775
+ # @param operator [Symbol, Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::NumericColumnFilter::Operator]
776
+ #
777
+ # @param value [Float, nil]
778
+
779
+ # @see Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::NumericColumnFilter#operator
780
+ module Operator
781
+ extend Openlayer::Internal::Type::Enum
782
+
783
+ GREATER = :>
784
+ GREATER_OR_EQUALS = :">="
785
+ IS = :is
786
+ LESS = :<
787
+ LESS_OR_EQUALS = :"<="
788
+ NOT_EQUALS = :"!="
789
+
790
+ # @!method self.values
791
+ # @return [Array<Symbol>]
792
+ end
793
+ end
794
+
795
+ class StringColumnFilter < Openlayer::Internal::Type::BaseModel
796
+ # @!attribute measurement
797
+ # The name of the column.
798
+ #
799
+ # @return [String]
800
+ required :measurement, String
801
+
802
+ # @!attribute operator
803
+ #
804
+ # @return [Symbol, Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::StringColumnFilter::Operator]
805
+ required :operator,
806
+ enum: -> { Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::StringColumnFilter::Operator }
807
+
808
+ # @!attribute value
809
+ #
810
+ # @return [String, Boolean]
811
+ required :value,
812
+ union: -> { Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::StringColumnFilter::Value }
813
+
814
+ # @!method initialize(measurement:, operator:, value:)
815
+ # @param measurement [String] The name of the column.
816
+ #
817
+ # @param operator [Symbol, Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::StringColumnFilter::Operator]
818
+ #
819
+ # @param value [String, Boolean]
820
+
821
+ # @see Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::StringColumnFilter#operator
822
+ module Operator
823
+ extend Openlayer::Internal::Type::Enum
824
+
825
+ IS = :is
826
+ NOT_EQUALS = :"!="
827
+
828
+ # @!method self.values
829
+ # @return [Array<Symbol>]
830
+ end
831
+
832
+ # @see Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::StringColumnFilter#value
833
+ module Value
834
+ extend Openlayer::Internal::Type::Union
835
+
836
+ variant String
837
+
838
+ variant Openlayer::Internal::Type::Boolean
839
+
840
+ # @!method self.variants
841
+ # @return [Array(String, Boolean)]
842
+ end
843
+ end
844
+
845
+ # @!method self.variants
846
+ # @return [Array(Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::SetColumnFilter, Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::NumericColumnFilter, Openlayer::Models::InferencePipelines::TestResultListResponse::Item::RowsBody::ColumnFilter::StringColumnFilter)]
847
+ end
848
+ end
564
849
  end
565
850
  end
566
851
  end
@@ -0,0 +1,78 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Openlayer
4
+ module Models
5
+ # @see Openlayer::Resources::Tests#list_results
6
+ class TestListResultsParams < Openlayer::Internal::Type::BaseModel
7
+ extend Openlayer::Internal::Type::RequestParameters::Converter
8
+ include Openlayer::Internal::Type::RequestParameters
9
+
10
+ # @!attribute end_timestamp
11
+ # Filter for results that use data starting before the end timestamp.
12
+ #
13
+ # @return [Float, nil]
14
+ optional :end_timestamp, Float
15
+
16
+ # @!attribute include_insights
17
+ # Include the insights linked to each test result
18
+ #
19
+ # @return [Boolean, nil]
20
+ optional :include_insights, Openlayer::Internal::Type::Boolean
21
+
22
+ # @!attribute inference_pipeline_id
23
+ # Retrive test results for a specific inference pipeline.
24
+ #
25
+ # @return [String, nil]
26
+ optional :inference_pipeline_id, String, nil?: true
27
+
28
+ # @!attribute page
29
+ # The page to return in a paginated query.
30
+ #
31
+ # @return [Integer, nil]
32
+ optional :page, Integer
33
+
34
+ # @!attribute per_page
35
+ # Maximum number of items to return per page.
36
+ #
37
+ # @return [Integer, nil]
38
+ optional :per_page, Integer
39
+
40
+ # @!attribute project_version_id
41
+ # Retrive test results for a specific project version.
42
+ #
43
+ # @return [String, nil]
44
+ optional :project_version_id, String, nil?: true
45
+
46
+ # @!attribute start_timestamp
47
+ # Filter for results that use data ending after the start timestamp.
48
+ #
49
+ # @return [Float, nil]
50
+ optional :start_timestamp, Float
51
+
52
+ # @!attribute status
53
+ # Filter by status(es).
54
+ #
55
+ # @return [Array<String>, nil]
56
+ optional :status, Openlayer::Internal::Type::ArrayOf[String]
57
+
58
+ # @!method initialize(end_timestamp: nil, include_insights: nil, inference_pipeline_id: nil, page: nil, per_page: nil, project_version_id: nil, start_timestamp: nil, status: nil, request_options: {})
59
+ # @param end_timestamp [Float] Filter for results that use data starting before the end timestamp.
60
+ #
61
+ # @param include_insights [Boolean] Include the insights linked to each test result
62
+ #
63
+ # @param inference_pipeline_id [String, nil] Retrive test results for a specific inference pipeline.
64
+ #
65
+ # @param page [Integer] The page to return in a paginated query.
66
+ #
67
+ # @param per_page [Integer] Maximum number of items to return per page.
68
+ #
69
+ # @param project_version_id [String, nil] Retrive test results for a specific project version.
70
+ #
71
+ # @param start_timestamp [Float] Filter for results that use data ending after the start timestamp.
72
+ #
73
+ # @param status [Array<String>] Filter by status(es).
74
+ #
75
+ # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
76
+ end
77
+ end
78
+ end