google-cloud-automl-v1 0.1.0

data/proto_docs/google/cloud/automl/v1/annotation_payload.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 AutoML
+      module V1
+        # Contains annotation information that is relevant to AutoML.
+        # @!attribute [rw] translation
+        #   @return [Google::Cloud::AutoML::V1::TranslationAnnotation]
+        #     Annotation details for translation.
+        # @!attribute [rw] classification
+        #   @return [Google::Cloud::AutoML::V1::ClassificationAnnotation]
+        #     Annotation details for content or image classification.
+        # @!attribute [rw] image_object_detection
+        #   @return [Google::Cloud::AutoML::V1::ImageObjectDetectionAnnotation]
+        #     Annotation details for image object detection.
+        # @!attribute [rw] text_extraction
+        #   @return [Google::Cloud::AutoML::V1::TextExtractionAnnotation]
+        #     Annotation details for text extraction.
+        # @!attribute [rw] text_sentiment
+        #   @return [Google::Cloud::AutoML::V1::TextSentimentAnnotation]
+        #     Annotation details for text sentiment.
+        # @!attribute [rw] annotation_spec_id
+        #   @return [String]
+        #     Output only . The resource ID of the annotation spec that
+        #     this annotation pertains to. The annotation spec comes from either an
+        #     ancestor dataset, or the dataset that was used to train the model in use.
+        # @!attribute [rw] display_name
+        #   @return [String]
+        #     Output only. The value of
+        #     {Google::Cloud::AutoML::V1::AnnotationSpec#display_name display_name}
+        #     when the model was trained. Because this field returns a value at model
+        #     training time, for different models trained using the same dataset, the
+        #     returned value could be different as model owner could update the
+        #     `display_name` between any two model training.
+        class AnnotationPayload
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/automl/v1/annotation_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 AutoML
+      module V1
+        # A definition of an annotation spec.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Output only. Resource name of the annotation spec.
+        #     Form:
+        #
+        #     'projects/\\{project_id}/locations/\\{location_id}/datasets/\\{dataset_id}/annotationSpecs/\\{annotation_spec_id}'
+        # @!attribute [rw] display_name
+        #   @return [String]
+        #     Required. The name of the annotation spec to show in the interface. The name can be
+        #     up to 32 characters long and must match the regexp `[a-zA-Z0-9_]+`.
+        # @!attribute [rw] example_count
+        #   @return [Integer]
+        #     Output only. The number of examples in the parent dataset
+        #     labeled by the annotation spec.
+        class AnnotationSpec
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/automl/v1/classification.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 AutoML
+      module V1
+        # Contains annotation details specific to classification.
+        # @!attribute [rw] score
+        #   @return [Float]
+        #     Output only. A confidence estimate between 0.0 and 1.0. A higher value
+        #     means greater confidence that the annotation is positive. If a user
+        #     approves an annotation as negative or positive, the score value remains
+        #     unchanged. If a user creates an annotation, the score is 0 for negative or
+        #     1 for positive.
+        class ClassificationAnnotation
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Model evaluation metrics for classification problems.
+        # Note: For Video Classification this metrics only describe quality of the
+        # Video Classification predictions of "segment_classification" type.
+        # @!attribute [rw] au_prc
+        #   @return [Float]
+        #     Output only. The Area Under Precision-Recall Curve metric. Micro-averaged
+        #     for the overall evaluation.
+        # @!attribute [rw] au_roc
+        #   @return [Float]
+        #     Output only. The Area Under Receiver Operating Characteristic curve metric.
+        #     Micro-averaged for the overall evaluation.
+        # @!attribute [rw] log_loss
+        #   @return [Float]
+        #     Output only. The Log Loss metric.
+        # @!attribute [rw] confidence_metrics_entry
+        #   @return [Array<Google::Cloud::AutoML::V1::ClassificationEvaluationMetrics::ConfidenceMetricsEntry>]
+        #     Output only. Metrics for each confidence_threshold in
+        #     0.00,0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and
+        #     position_threshold = INT32_MAX_VALUE.
+        #     ROC and precision-recall curves, and other aggregated metrics are derived
+        #     from them. The confidence metrics entries may also be supplied for
+        #     additional values of position_threshold, but from these no aggregated
+        #     metrics are computed.
+        # @!attribute [rw] confusion_matrix
+        #   @return [Google::Cloud::AutoML::V1::ClassificationEvaluationMetrics::ConfusionMatrix]
+        #     Output only. Confusion matrix of the evaluation.
+        #     Only set for MULTICLASS classification problems where number
+        #     of labels is no more than 10.
+        #     Only set for model level evaluation, not for evaluation per label.
+        # @!attribute [rw] annotation_spec_id
+        #   @return [Array<String>]
+        #     Output only. The annotation spec ids used for this evaluation.
+        class ClassificationEvaluationMetrics
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+
+          # Metrics for a single confidence threshold.
+          # @!attribute [rw] confidence_threshold
+          #   @return [Float]
+          #     Output only. Metrics are computed with an assumption that the model
+          #     never returns predictions with score lower than this value.
+          # @!attribute [rw] position_threshold
+          #   @return [Integer]
+          #     Output only. Metrics are computed with an assumption that the model
+          #     always returns at most this many predictions (ordered by their score,
+          #     descendingly), but they all still need to meet the confidence_threshold.
+          # @!attribute [rw] recall
+          #   @return [Float]
+          #     Output only. Recall (True Positive Rate) for the given confidence
+          #     threshold.
+          # @!attribute [rw] precision
+          #   @return [Float]
+          #     Output only. Precision for the given confidence threshold.
+          # @!attribute [rw] false_positive_rate
+          #   @return [Float]
+          #     Output only. False Positive Rate for the given confidence threshold.
+          # @!attribute [rw] f1_score
+          #   @return [Float]
+          #     Output only. The harmonic mean of recall and precision.
+          # @!attribute [rw] recall_at1
+          #   @return [Float]
+          #     Output only. The Recall (True Positive Rate) when only considering the
+          #     label that has the highest prediction score and not below the confidence
+          #     threshold for each example.
+          # @!attribute [rw] precision_at1
+          #   @return [Float]
+          #     Output only. The precision when only considering the label that has the
+          #     highest prediction score and not below the confidence threshold for each
+          #     example.
+          # @!attribute [rw] false_positive_rate_at1
+          #   @return [Float]
+          #     Output only. The False Positive Rate when only considering the label that
+          #     has the highest prediction score and not below the confidence threshold
+          #     for each example.
+          # @!attribute [rw] f1_score_at1
+          #   @return [Float]
+          #     Output only. The harmonic mean of {Google::Cloud::AutoML::V1::ClassificationEvaluationMetrics::ConfidenceMetricsEntry#recall_at1 recall_at1} and {Google::Cloud::AutoML::V1::ClassificationEvaluationMetrics::ConfidenceMetricsEntry#precision_at1 precision_at1}.
+          # @!attribute [rw] true_positive_count
+          #   @return [Integer]
+          #     Output only. The number of model created labels that match a ground truth
+          #     label.
+          # @!attribute [rw] false_positive_count
+          #   @return [Integer]
+          #     Output only. The number of model created labels that do not match a
+          #     ground truth label.
+          # @!attribute [rw] false_negative_count
+          #   @return [Integer]
+          #     Output only. The number of ground truth labels that are not matched
+          #     by a model created label.
+          # @!attribute [rw] true_negative_count
+          #   @return [Integer]
+          #     Output only. The number of labels that were not created by the model,
+          #     but if they would, they would not match a ground truth label.
+          class ConfidenceMetricsEntry
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Confusion matrix of the model running the classification.
+          # @!attribute [rw] annotation_spec_id
+          #   @return [Array<String>]
+          #     Output only. IDs of the annotation specs used in the confusion matrix.
+          #     For Tables CLASSIFICATION
+          #
+          #     [prediction_type][google.cloud.automl.v1p1beta.TablesModelMetadata.prediction_type]
+          #     only list of [annotation_spec_display_name-s][] is populated.
+          # @!attribute [rw] display_name
+          #   @return [Array<String>]
+          #     Output only. Display name of the annotation specs used in the confusion
+          #     matrix, as they were at the moment of the evaluation. For Tables
+          #     CLASSIFICATION
+          #
+          #     [prediction_type-s][google.cloud.automl.v1p1beta.TablesModelMetadata.prediction_type],
+          #     distinct values of the target column at the moment of the model
+          #     evaluation are populated here.
+          # @!attribute [rw] row
+          #   @return [Array<Google::Cloud::AutoML::V1::ClassificationEvaluationMetrics::ConfusionMatrix::Row>]
+          #     Output only. Rows in the confusion matrix. The number of rows is equal to
+          #     the size of `annotation_spec_id`.
+          #     `row[i].example_count[j]` is the number of examples that have ground
+          #     truth of the `annotation_spec_id[i]` and are predicted as
+          #     `annotation_spec_id[j]` by the model being evaluated.
+          class ConfusionMatrix
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+
+            # Output only. A row in the confusion matrix.
+            # @!attribute [rw] example_count
+            #   @return [Array<Integer>]
+            #     Output only. Value of the specific cell in the confusion matrix.
+            #     The number of values each row has (i.e. the length of the row) is equal
+            #     to the length of the `annotation_spec_id` field or, if that one is not
+            #     populated, length of the {Google::Cloud::AutoML::V1::ClassificationEvaluationMetrics::ConfusionMatrix#display_name display_name} field.
+            class Row
+              include Google::Protobuf::MessageExts
+              extend Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+        end
+
+        # Type of the classification problem.
+        module ClassificationType
+          # An un-set value of this enum.
+          CLASSIFICATION_TYPE_UNSPECIFIED = 0
+
+          # At most one label is allowed per example.
+          MULTICLASS = 1
+
+          # Multiple labels are allowed for one example.
+          MULTILABEL = 2
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/automl/v1/data_items.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 AutoML
+      module V1
+        # A representation of an image.
+        # Only images up to 30MB in size are supported.
+        # @!attribute [rw] image_bytes
+        #   @return [String]
+        #     Image content represented as a stream of bytes.
+        #     Note: As with all `bytes` fields, protobuffers use a pure binary
+        #     representation, whereas JSON representations use base64.
+        # @!attribute [rw] thumbnail_uri
+        #   @return [String]
+        #     Output only. HTTP URI to the thumbnail image.
+        class Image
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A representation of a text snippet.
+        # @!attribute [rw] content
+        #   @return [String]
+        #     Required. The content of the text snippet as a string. Up to 250000
+        #     characters long.
+        # @!attribute [rw] mime_type
+        #   @return [String]
+        #     Optional. The format of {Google::Cloud::AutoML::V1::TextSnippet#content content}. Currently the only two allowed
+        #     values are "text/html" and "text/plain". If left blank, the format is
+        #     automatically determined from the type of the uploaded {Google::Cloud::AutoML::V1::TextSnippet#content content}.
+        # @!attribute [rw] content_uri
+        #   @return [String]
+        #     Output only. HTTP URI where you can download the content.
+        class TextSnippet
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message that describes dimension of a document.
+        # @!attribute [rw] unit
+        #   @return [Google::Cloud::AutoML::V1::DocumentDimensions::DocumentDimensionUnit]
+        #     Unit of the dimension.
+        # @!attribute [rw] width
+        #   @return [Float]
+        #     Width value of the document, works together with the unit.
+        # @!attribute [rw] height
+        #   @return [Float]
+        #     Height value of the document, works together with the unit.
+        class DocumentDimensions
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+
+          # Unit of the document dimension.
+          module DocumentDimensionUnit
+            # Should not be used.
+            DOCUMENT_DIMENSION_UNIT_UNSPECIFIED = 0
+
+            # Document dimension is measured in inches.
+            INCH = 1
+
+            # Document dimension is measured in centimeters.
+            CENTIMETER = 2
+
+            # Document dimension is measured in points. 72 points = 1 inch.
+            POINT = 3
+          end
+        end
+
+        # A structured text document e.g. a PDF.
+        # @!attribute [rw] input_config
+        #   @return [Google::Cloud::AutoML::V1::DocumentInputConfig]
+        #     An input config specifying the content of the document.
+        # @!attribute [rw] document_text
+        #   @return [Google::Cloud::AutoML::V1::TextSnippet]
+        #     The plain text version of this document.
+        # @!attribute [rw] layout
+        #   @return [Array<Google::Cloud::AutoML::V1::Document::Layout>]
+        #     Describes the layout of the document.
+        #     Sorted by [page_number][].
+        # @!attribute [rw] document_dimensions
+        #   @return [Google::Cloud::AutoML::V1::DocumentDimensions]
+        #     The dimensions of the page in the document.
+        # @!attribute [rw] page_count
+        #   @return [Integer]
+        #     Number of pages in the document.
+        class Document
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+
+          # Describes the layout information of a {Google::Cloud::AutoML::V1::Document::Layout#text_segment text_segment} in the document.
+          # @!attribute [rw] text_segment
+          #   @return [Google::Cloud::AutoML::V1::TextSegment]
+          #     Text Segment that represents a segment in
+          #     [document_text][google.cloud.automl.v1p1beta.Document.document_text].
+          # @!attribute [rw] page_number
+          #   @return [Integer]
+          #     Page number of the {Google::Cloud::AutoML::V1::Document::Layout#text_segment text_segment} in the original document, starts
+          #     from 1.
+          # @!attribute [rw] bounding_poly
+          #   @return [Google::Cloud::AutoML::V1::BoundingPoly]
+          #     The position of the {Google::Cloud::AutoML::V1::Document::Layout#text_segment text_segment} in the page.
+          #     Contains exactly 4
+          #
+          #     [normalized_vertices][google.cloud.automl.v1p1beta.BoundingPoly.normalized_vertices]
+          #     and they are connected by edges in the order provided, which will
+          #     represent a rectangle parallel to the frame. The
+          #     [NormalizedVertex-s][google.cloud.automl.v1p1beta.NormalizedVertex] are
+          #     relative to the page.
+          #     Coordinates are based on top-left as point (0,0).
+          # @!attribute [rw] text_segment_type
+          #   @return [Google::Cloud::AutoML::V1::Document::Layout::TextSegmentType]
+          #     The type of the {Google::Cloud::AutoML::V1::Document::Layout#text_segment text_segment} in document.
+          class Layout
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+
+            # The type of TextSegment in the context of the original document.
+            module TextSegmentType
+              # Should not be used.
+              TEXT_SEGMENT_TYPE_UNSPECIFIED = 0
+
+              # The text segment is a token. e.g. word.
+              TOKEN = 1
+
+              # The text segment is a paragraph.
+              PARAGRAPH = 2
+
+              # The text segment is a form field.
+              FORM_FIELD = 3
+
+              # The text segment is the name part of a form field. It will be treated
+              # as child of another FORM_FIELD TextSegment if its span is subspan of
+              # another TextSegment with type FORM_FIELD.
+              FORM_FIELD_NAME = 4
+
+              # The text segment is the text content part of a form field. It will be
+              # treated as child of another FORM_FIELD TextSegment if its span is
+              # subspan of another TextSegment with type FORM_FIELD.
+              FORM_FIELD_CONTENTS = 5
+
+              # The text segment is a whole table, including headers, and all rows.
+              TABLE = 6
+
+              # The text segment is a table's headers. It will be treated as child of
+              # another TABLE TextSegment if its span is subspan of another TextSegment
+              # with type TABLE.
+              TABLE_HEADER = 7
+
+              # The text segment is a row in table. It will be treated as child of
+              # another TABLE TextSegment if its span is subspan of another TextSegment
+              # with type TABLE.
+              TABLE_ROW = 8
+
+              # The text segment is a cell in table. It will be treated as child of
+              # another TABLE_ROW TextSegment if its span is subspan of another
+              # TextSegment with type TABLE_ROW.
+              TABLE_CELL = 9
+            end
+          end
+        end
+
+        # Example data used for training or prediction.
+        # @!attribute [rw] image
+        #   @return [Google::Cloud::AutoML::V1::Image]
+        #     Example image.
+        # @!attribute [rw] text_snippet
+        #   @return [Google::Cloud::AutoML::V1::TextSnippet]
+        #     Example text.
+        # @!attribute [rw] document
+        #   @return [Google::Cloud::AutoML::V1::Document]
+        #     Example document.
+        class ExamplePayload
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end