google-cloud-automl-v1beta1 0.1.0

data/proto_docs/google/cloud/automl/v1beta1/text_extraction.rb

@@ -0,0 +1,73 @@
+# 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 V1beta1
+        # Annotation for identifying spans of text.
+        # @!attribute [rw] text_segment
+        #   @return [Google::Cloud::AutoML::V1beta1::TextSegment]
+        #     An entity annotation will set this, which is the part of the original
+        #     text to which the annotation pertains.
+        # @!attribute [rw] score
+        #   @return [Float]
+        #     Output only. A confidence estimate between 0.0 and 1.0. A higher value
+        #     means greater confidence in correctness of the annotation.
+        class TextExtractionAnnotation
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Model evaluation metrics for text extraction problems.
+        # @!attribute [rw] au_prc
+        #   @return [Float]
+        #     Output only. The Area under precision recall curve metric.
+        # @!attribute [rw] confidence_metrics_entries
+        #   @return [Array<Google::Cloud::AutoML::V1beta1::TextExtractionEvaluationMetrics::ConfidenceMetricsEntry>]
+        #     Output only. Metrics that have confidence thresholds.
+        #     Precision-recall curve can be derived from it.
+        class TextExtractionEvaluationMetrics
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+
+          # Metrics for a single confidence threshold.
+          # @!attribute [rw] confidence_threshold
+          #   @return [Float]
+          #     Output only. The confidence threshold value used to compute the metrics.
+          #     Only annotations with score of at least this threshold are considered to
+          #     be ones the model would return.
+          # @!attribute [rw] recall
+          #   @return [Float]
+          #     Output only. Recall under the given confidence threshold.
+          # @!attribute [rw] precision
+          #   @return [Float]
+          #     Output only. Precision under the given confidence threshold.
+          # @!attribute [rw] f1_score
+          #   @return [Float]
+          #     Output only. The harmonic mean of recall and precision.
+          class ConfidenceMetricsEntry
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/automl/v1beta1/text_segment.rb

@@ -0,0 +1,44 @@
+# 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 V1beta1
+        # A contiguous part of a text (string), assuming it has an UTF-8 NFC encoding.
+        # @!attribute [rw] content
+        #   @return [String]
+        #     Output only. The content of the TextSegment.
+        # @!attribute [rw] start_offset
+        #   @return [Integer]
+        #     Required. Zero-based character index of the first character of the text
+        #     segment (counting characters from the beginning of the text).
+        # @!attribute [rw] end_offset
+        #   @return [Integer]
+        #     Required. Zero-based character index of the first character past the end of
+        #     the text segment (counting character from the beginning of the text).
+        #     The character at the end_offset is NOT included in the text segment.
+        class TextSegment
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/automl/v1beta1/text_sentiment.rb

@@ -0,0 +1,86 @@
+# 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 V1beta1
+        # Contains annotation details specific to text sentiment.
+        # @!attribute [rw] sentiment
+        #   @return [Integer]
+        #     Output only. The sentiment with the semantic, as given to the
+        #     {Google::Cloud::AutoML::V1beta1::AutoML::Client#import_data AutoMl.ImportData} when populating the dataset from which the model used
+        #     for the prediction had been trained.
+        #     The sentiment values are between 0 and
+        #     Dataset.text_sentiment_dataset_metadata.sentiment_max (inclusive),
+        #     with higher value meaning more positive sentiment. They are completely
+        #     relative, i.e. 0 means least positive sentiment and sentiment_max means
+        #     the most positive from the sentiments present in the train data. Therefore
+        #      e.g. if train data had only negative sentiment, then sentiment_max, would
+        #     be still negative (although least negative).
+        #     The sentiment shouldn't be confused with "score" or "magnitude"
+        #     from the previous Natural Language Sentiment Analysis API.
+        class TextSentimentAnnotation
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Model evaluation metrics for text sentiment problems.
+        # @!attribute [rw] precision
+        #   @return [Float]
+        #     Output only. Precision.
+        # @!attribute [rw] recall
+        #   @return [Float]
+        #     Output only. Recall.
+        # @!attribute [rw] f1_score
+        #   @return [Float]
+        #     Output only. The harmonic mean of recall and precision.
+        # @!attribute [rw] mean_absolute_error
+        #   @return [Float]
+        #     Output only. Mean absolute error. Only set for the overall model
+        #     evaluation, not for evaluation of a single annotation spec.
+        # @!attribute [rw] mean_squared_error
+        #   @return [Float]
+        #     Output only. Mean squared error. Only set for the overall model
+        #     evaluation, not for evaluation of a single annotation spec.
+        # @!attribute [rw] linear_kappa
+        #   @return [Float]
+        #     Output only. Linear weighted kappa. Only set for the overall model
+        #     evaluation, not for evaluation of a single annotation spec.
+        # @!attribute [rw] quadratic_kappa
+        #   @return [Float]
+        #     Output only. Quadratic weighted kappa. Only set for the overall model
+        #     evaluation, not for evaluation of a single annotation spec.
+        # @!attribute [rw] confusion_matrix
+        #   @return [Google::Cloud::AutoML::V1beta1::ClassificationEvaluationMetrics::ConfusionMatrix]
+        #     Output only. Confusion matrix of the evaluation.
+        #     Only set for the overall model evaluation, not for evaluation of a single
+        #     annotation spec.
+        # @!attribute [rw] annotation_spec_id
+        #   @return [Array<String>]
+        #     Output only. The annotation spec ids used for this evaluation.
+        #     Deprecated .
+        class TextSentimentEvaluationMetrics
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/automl/v1beta1/translation.rb

@@ -0,0 +1,79 @@
+# 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 V1beta1
+        # Dataset metadata that is specific to translation.
+        # @!attribute [rw] source_language_code
+        #   @return [String]
+        #     Required. The BCP-47 language code of the source language.
+        # @!attribute [rw] target_language_code
+        #   @return [String]
+        #     Required. The BCP-47 language code of the target language.
+        class TranslationDatasetMetadata
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Evaluation metrics for the dataset.
+        # @!attribute [rw] bleu_score
+        #   @return [Float]
+        #     Output only. BLEU score.
+        # @!attribute [rw] base_bleu_score
+        #   @return [Float]
+        #     Output only. BLEU score for base model.
+        class TranslationEvaluationMetrics
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Model metadata that is specific to translation.
+        # @!attribute [rw] base_model
+        #   @return [String]
+        #     The resource name of the model to use as a baseline to train the custom
+        #     model. If unset, we use the default base model provided by Google
+        #     Translate. Format:
+        #     `projects/{project_id}/locations/{location_id}/models/{model_id}`
+        # @!attribute [rw] source_language_code
+        #   @return [String]
+        #     Output only. Inferred from the dataset.
+        #     The source languge (The BCP-47 language code) that is used for training.
+        # @!attribute [rw] target_language_code
+        #   @return [String]
+        #     Output only. The target languge (The BCP-47 language code) that is used for
+        #     training.
+        class TranslationModelMetadata
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Annotation details specific to translation.
+        # @!attribute [rw] translated_content
+        #   @return [Google::Cloud::AutoML::V1beta1::TextSnippet]
+        #     Output only . The translated content.
+        class TranslationAnnotation
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/automl/v1beta1/video.rb

@@ -0,0 +1,51 @@
+# 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 V1beta1
+        # Dataset metadata specific to video classification.
+        # All Video Classification datasets are treated as multi label.
+        class VideoClassificationDatasetMetadata
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Dataset metadata specific to video object tracking.
+        class VideoObjectTrackingDatasetMetadata
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Model metadata specific to video classification.
+        class VideoClassificationModelMetadata
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Model metadata specific to video object tracking.
+        class VideoObjectTrackingModelMetadata
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/longrunning/operations.rb

@@ -0,0 +1,150 @@
+# 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 Longrunning
+    # This resource represents a long-running operation that is the result of a
+    # network API call.
+    # @!attribute [rw] name
+    #   @return [String]
+    #     The server-assigned name, which is only unique within the same service that
+    #     originally returns it. If you use the default HTTP mapping, the
+    #     `name` should have the format of `operations/some/unique/name`.
+    # @!attribute [rw] metadata
+    #   @return [Google::Protobuf::Any]
+    #     Service-specific metadata associated with the operation.  It typically
+    #     contains progress information and common metadata such as create time.
+    #     Some services might not provide such metadata.  Any method that returns a
+    #     long-running operation should document the metadata type, if any.
+    # @!attribute [rw] done
+    #   @return [Boolean]
+    #     If the value is `false`, it means the operation is still in progress.
+    #     If true, the operation is completed, and either `error` or `response` is
+    #     available.
+    # @!attribute [rw] error
+    #   @return [Google::Rpc::Status]
+    #     The error result of the operation in case of failure or cancellation.
+    # @!attribute [rw] response
+    #   @return [Google::Protobuf::Any]
+    #     The normal response of the operation in case of success.  If the original
+    #     method returns no data on success, such as `Delete`, the response is
+    #     `google.protobuf.Empty`.  If the original method is standard
+    #     `Get`/`Create`/`Update`, the response should be the resource.  For other
+    #     methods, the response should have the type `XxxResponse`, where `Xxx`
+    #     is the original method name.  For example, if the original method name
+    #     is `TakeSnapshot()`, the inferred response type is
+    #     `TakeSnapshotResponse`.
+    class Operation
+      include Google::Protobuf::MessageExts
+      extend Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.GetOperation.
+    # @!attribute [rw] name
+    #   @return [String]
+    #     The name of the operation resource.
+    class GetOperationRequest
+      include Google::Protobuf::MessageExts
+      extend Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.ListOperations.
+    # @!attribute [rw] name
+    #   @return [String]
+    #     The name of the operation collection.
+    # @!attribute [rw] filter
+    #   @return [String]
+    #     The standard list filter.
+    # @!attribute [rw] page_size
+    #   @return [Integer]
+    #     The standard list page size.
+    # @!attribute [rw] page_token
+    #   @return [String]
+    #     The standard list page token.
+    class ListOperationsRequest
+      include Google::Protobuf::MessageExts
+      extend Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The response message for Operations.ListOperations.
+    # @!attribute [rw] operations
+    #   @return [Array<Google::Longrunning::Operation>]
+    #     A list of operations that matches the specified filter in the request.
+    # @!attribute [rw] next_page_token
+    #   @return [String]
+    #     The standard List next-page token.
+    class ListOperationsResponse
+      include Google::Protobuf::MessageExts
+      extend Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.CancelOperation.
+    # @!attribute [rw] name
+    #   @return [String]
+    #     The name of the operation resource to be cancelled.
+    class CancelOperationRequest
+      include Google::Protobuf::MessageExts
+      extend Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.DeleteOperation.
+    # @!attribute [rw] name
+    #   @return [String]
+    #     The name of the operation resource to be deleted.
+    class DeleteOperationRequest
+      include Google::Protobuf::MessageExts
+      extend Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # A message representing the message types used by a long-running operation.
+    #
+    # Example:
+    #
+    #   rpc LongRunningRecognize(LongRunningRecognizeRequest)
+    #       returns (google.longrunning.Operation) {
+    #     option (google.longrunning.operation_info) = {
+    #       response_type: "LongRunningRecognizeResponse"
+    #       metadata_type: "LongRunningRecognizeMetadata"
+    #     };
+    #   }
+    # @!attribute [rw] response_type
+    #   @return [String]
+    #     Required. The message name of the primary return type for this
+    #     long-running operation.
+    #     This type will be used to deserialize the LRO's response.
+    #
+    #     If the response is in a different package from the rpc, a fully-qualified
+    #     message name must be used (e.g. `google.protobuf.Struct`).
+    #
+    #     Note: Altering this value constitutes a breaking change.
+    # @!attribute [rw] metadata_type
+    #   @return [String]
+    #     Required. The message name of the metadata type for this long-running
+    #     operation.
+    #
+    #     If the response is in a different package from the rpc, a fully-qualified
+    #     message name must be used (e.g. `google.protobuf.Struct`).
+    #
+    #     Note: Altering this value constitutes a breaking change.
+    class OperationInfo
+      include Google::Protobuf::MessageExts
+      extend Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end