google-cloud-ai_platform-v1 0.1.0

data/proto_docs/google/cloud/aiplatform/v1/schema/predict/params/image_classification.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        module Schema
+          module Predict
+            module Params
+              # Prediction model parameters for Image Classification.
+              # @!attribute [rw] confidence_threshold
+              #   @return [::Float]
+              #     The Model only returns predictions with at least this confidence score.
+              #     Default value is 0.0
+              # @!attribute [rw] max_predictions
+              #   @return [::Integer]
+              #     The Model only returns up to that many top, by confidence score,
+              #     predictions per instance. If this number is very high, the Model may return
+              #     fewer predictions. Default value is 10.
+              class ImageClassificationPredictionParams
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/schema/predict/params/image_object_detection.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        module Schema
+          module Predict
+            module Params
+              # Prediction model parameters for Image Object Detection.
+              # @!attribute [rw] confidence_threshold
+              #   @return [::Float]
+              #     The Model only returns predictions with at least this confidence score.
+              #     Default value is 0.0
+              # @!attribute [rw] max_predictions
+              #   @return [::Integer]
+              #     The Model only returns up to that many top, by confidence score,
+              #     predictions per instance. Note that number of returned predictions is also
+              #     limited by metadata's predictionsLimit. Default value is 10.
+              class ImageObjectDetectionPredictionParams
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/schema/predict/params/image_segmentation.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        module Schema
+          module Predict
+            module Params
+              # Prediction model parameters for Image Segmentation.
+              # @!attribute [rw] confidence_threshold
+              #   @return [::Float]
+              #     When the model predicts category of pixels of the image, it will only
+              #     provide predictions for pixels that it is at least this much confident
+              #     about. All other pixels will be classified as background. Default value is
+              #     0.5.
+              class ImageSegmentationPredictionParams
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/schema/predict/params/video_action_recognition.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        module Schema
+          module Predict
+            module Params
+              # Prediction model parameters for Video Action Recognition.
+              # @!attribute [rw] confidence_threshold
+              #   @return [::Float]
+              #     The Model only returns predictions with at least this confidence score.
+              #     Default value is 0.0
+              # @!attribute [rw] max_predictions
+              #   @return [::Integer]
+              #     The model only returns up to that many top, by confidence score,
+              #     predictions per frame of the video. If this number is very high, the
+              #     Model may return fewer predictions per frame. Default value is 50.
+              class VideoActionRecognitionPredictionParams
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/schema/predict/params/video_classification.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        module Schema
+          module Predict
+            module Params
+              # Prediction model parameters for Video Classification.
+              # @!attribute [rw] confidence_threshold
+              #   @return [::Float]
+              #     The Model only returns predictions with at least this confidence score.
+              #     Default value is 0.0
+              # @!attribute [rw] max_predictions
+              #   @return [::Integer]
+              #     The Model only returns up to that many top, by confidence score,
+              #     predictions per instance. If this number is very high, the Model may return
+              #     fewer predictions. Default value is 10,000.
+              # @!attribute [rw] segment_classification
+              #   @return [::Boolean]
+              #     Set to true to request segment-level classification. Vertex AI returns
+              #     labels and their confidence scores for the entire time segment of the
+              #     video that user specified in the input instance.
+              #     Default value is true
+              # @!attribute [rw] shot_classification
+              #   @return [::Boolean]
+              #     Set to true to request shot-level classification. Vertex AI determines
+              #     the boundaries for each camera shot in the entire time segment of the
+              #     video that user specified in the input instance. Vertex AI then
+              #     returns labels and their confidence scores for each detected shot, along
+              #     with the start and end time of the shot.
+              #     WARNING: Model evaluation is not done for this classification type,
+              #     the quality of it depends on the training data, but there are no metrics
+              #     provided to describe that quality.
+              #     Default value is false
+              # @!attribute [rw] one_sec_interval_classification
+              #   @return [::Boolean]
+              #     Set to true to request classification for a video at one-second intervals.
+              #     Vertex AI returns labels and their confidence scores for each second of
+              #     the entire time segment of the video that user specified in the input
+              #     WARNING: Model evaluation is not done for this classification type, the
+              #     quality of it depends on the training data, but there are no metrics
+              #     provided to describe that quality. Default value is false
+              class VideoClassificationPredictionParams
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/schema/predict/params/video_object_tracking.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        module Schema
+          module Predict
+            module Params
+              # Prediction model parameters for Video Object Tracking.
+              # @!attribute [rw] confidence_threshold
+              #   @return [::Float]
+              #     The Model only returns predictions with at least this confidence score.
+              #     Default value is 0.0
+              # @!attribute [rw] max_predictions
+              #   @return [::Integer]
+              #     The model only returns up to that many top, by confidence score,
+              #     predictions per frame of the video. If this number is very high, the
+              #     Model may return fewer predictions per frame. Default value is 50.
+              # @!attribute [rw] min_bounding_box_size
+              #   @return [::Float]
+              #     Only bounding boxes with shortest edge at least that long as a relative
+              #     value of video frame size are returned. Default value is 0.0.
+              class VideoObjectTrackingPredictionParams
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/classification.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        module Schema
+          module Predict
+            module Prediction
+              # Prediction output format for Image and Text Classification.
+              # @!attribute [rw] ids
+              #   @return [::Array<::Integer>]
+              #     The resource IDs of the AnnotationSpecs that had been identified.
+              # @!attribute [rw] display_names
+              #   @return [::Array<::String>]
+              #     The display names of the AnnotationSpecs that had been identified, order
+              #     matches the IDs.
+              # @!attribute [rw] confidences
+              #   @return [::Array<::Float>]
+              #     The Model's confidences in correctness of the predicted IDs, higher value
+              #     means higher confidence. Order matches the Ids.
+              class ClassificationPredictionResult
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/image_object_detection.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        module Schema
+          module Predict
+            module Prediction
+              # Prediction output format for Image Object Detection.
+              # @!attribute [rw] ids
+              #   @return [::Array<::Integer>]
+              #     The resource IDs of the AnnotationSpecs that had been identified, ordered
+              #     by the confidence score descendingly.
+              # @!attribute [rw] display_names
+              #   @return [::Array<::String>]
+              #     The display names of the AnnotationSpecs that had been identified, order
+              #     matches the IDs.
+              # @!attribute [rw] confidences
+              #   @return [::Array<::Float>]
+              #     The Model's confidences in correctness of the predicted IDs, higher value
+              #     means higher confidence. Order matches the Ids.
+              # @!attribute [rw] bboxes
+              #   @return [::Array<::Google::Protobuf::ListValue>]
+              #     Bounding boxes, i.e. the rectangles over the image, that pinpoint
+              #     the found AnnotationSpecs. Given in order that matches the IDs. Each
+              #     bounding box is an array of 4 numbers `xMin`, `xMax`, `yMin`, and
+              #     `yMax`, which represent the extremal coordinates of the box. They are
+              #     relative to the image size, and the point 0,0 is in the top left
+              #     of the image.
+              class ImageObjectDetectionPredictionResult
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/image_segmentation.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        module Schema
+          module Predict
+            module Prediction
+              # Prediction output format for Image Segmentation.
+              # @!attribute [rw] category_mask
+              #   @return [::String]
+              #     A PNG image where each pixel in the mask represents the category in which
+              #     the pixel in the original image was predicted to belong to. The size of
+              #     this image will be the same as the original image. The mapping between the
+              #     AnntoationSpec and the color can be found in model's metadata. The model
+              #     will choose the most likely category and if none of the categories reach
+              #     the confidence threshold, the pixel will be marked as background.
+              # @!attribute [rw] confidence_mask
+              #   @return [::String]
+              #     A one channel image which is encoded as an 8bit lossless PNG. The size of
+              #     the image will be the same as the original image. For a specific pixel,
+              #     darker color means less confidence in correctness of the cateogry in the
+              #     categoryMask for the corresponding pixel. Black means no confidence and
+              #     white means complete confidence.
+              class ImageSegmentationPredictionResult
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/tabular_classification.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        module Schema
+          module Predict
+            module Prediction
+              # Prediction output format for Tabular Classification.
+              # @!attribute [rw] classes
+              #   @return [::Array<::String>]
+              #     The name of the classes being classified, contains all possible values of
+              #     the target column.
+              # @!attribute [rw] scores
+              #   @return [::Array<::Float>]
+              #     The model's confidence in each class being correct, higher
+              #     value means higher confidence. The N-th score corresponds to
+              #     the N-th class in classes.
+              class TabularClassificationPredictionResult
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/tabular_regression.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        module Schema
+          module Predict
+            module Prediction
+              # Prediction output format for Tabular Regression.
+              # @!attribute [rw] value
+              #   @return [::Float]
+              #     The regression value.
+              # @!attribute [rw] lower_bound
+              #   @return [::Float]
+              #     The lower bound of the prediction interval.
+              # @!attribute [rw] upper_bound
+              #   @return [::Float]
+              #     The upper bound of the prediction interval.
+              class TabularRegressionPredictionResult
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/text_extraction.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        module Schema
+          module Predict
+            module Prediction
+              # Prediction output format for Text Extraction.
+              # @!attribute [rw] ids
+              #   @return [::Array<::Integer>]
+              #     The resource IDs of the AnnotationSpecs that had been identified,
+              #     ordered by the confidence score descendingly.
+              # @!attribute [rw] display_names
+              #   @return [::Array<::String>]
+              #     The display names of the AnnotationSpecs that had been identified,
+              #     order matches the IDs.
+              # @!attribute [rw] text_segment_start_offsets
+              #   @return [::Array<::Integer>]
+              #     The start offsets, inclusive, of the text segment in which the
+              #     AnnotationSpec has been identified. Expressed as a zero-based number
+              #     of characters as measured from the start of the text snippet.
+              # @!attribute [rw] text_segment_end_offsets
+              #   @return [::Array<::Integer>]
+              #     The end offsets, inclusive, of the text segment in which the
+              #     AnnotationSpec has been identified. Expressed as a zero-based number
+              #     of characters as measured from the start of the text snippet.
+              # @!attribute [rw] confidences
+              #   @return [::Array<::Float>]
+              #     The Model's confidences in correctness of the predicted IDs, higher
+              #     value means higher confidence. Order matches the Ids.
+              class TextExtractionPredictionResult
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/text_sentiment.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        module Schema
+          module Predict
+            module Prediction
+              # Prediction output format for Text Sentiment
+              # @!attribute [rw] sentiment
+              #   @return [::Integer]
+              #     The integer sentiment labels between 0 (inclusive) and sentimentMax label
+              #     (inclusive), while 0 maps to the least positive sentiment and
+              #     sentimentMax maps to the most positive one. The higher the score is, the
+              #     more positive the sentiment in the text snippet is. Note: sentimentMax is
+              #     an integer value between 1 (inclusive) and 10 (inclusive).
+              class TextSentimentPredictionResult
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end