google-cloud-automl 0.7.1 → 1.1.1

data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/column_spec.rb

@@ -1,67 +0,0 @@
-# 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.
-
-
-module Google
-  module Cloud
-    module AutoML
-      module V1beta1
-        # A representation of a column in a relational table. When listing them, column specs are returned in the same order in which they were
-        # given on import .
-        # Used by:
-        # * Tables
-        # @!attribute [rw] name
-        #   @return [String]
-        #     Output only. The resource name of the column specs.
-        #     Form:
-        #
-        #     `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/tableSpecs/{table_spec_id}/columnSpecs/{column_spec_id}`
-        # @!attribute [rw] data_type
-        #   @return [Google::Cloud::AutoML::V1beta1::DataType]
-        #     The data type of elements stored in the column.
-        # @!attribute [rw] display_name
-        #   @return [String]
-        #     Output only. The name of the column to show in the interface. The name can
-        #     be up to 100 characters long and can consist only of ASCII Latin letters
-        #     A-Z and a-z, ASCII digits 0-9, underscores(_), and forward slashes(/), and
-        #     must start with a letter or a digit.
-        # @!attribute [rw] data_stats
-        #   @return [Google::Cloud::AutoML::V1beta1::DataStats]
-        #     Output only. Stats of the series of values in the column.
-        #     This field may be stale, see the ancestor's
-        #     Dataset.tables_dataset_metadata.stats_update_time field
-        #     for the timestamp at which these stats were last updated.
-        # @!attribute [rw] top_correlated_columns
-        #   @return [Array<Google::Cloud::AutoML::V1beta1::ColumnSpec::CorrelatedColumn>]
-        #     Deprecated.
-        # @!attribute [rw] etag
-        #   @return [String]
-        #     Used to perform consistent read-modify-write updates. If not set, a blind
-        #     "overwrite" update happens.
-        class ColumnSpec
-          # Identifies the table's column, and its correlation with the column this
-          # ColumnSpec describes.
-          # @!attribute [rw] column_spec_id
-          #   @return [String]
-          #     The column_spec_id of the correlated column, which belongs to the same
-          #     table as the in-context column.
-          # @!attribute [rw] correlation_stats
-          #   @return [Google::Cloud::AutoML::V1beta1::CorrelationStats]
-          #     Correlation between this and the in-context column.
-          class CorrelatedColumn; end
-        end
-      end
-    end
-  end
-end

data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/data_items.rb

@@ -1,202 +0,0 @@
-# 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.
-
-
-module Google
-  module Cloud
-    module AutoML
-      module V1beta1
-        # 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] input_config
-        #   @return [Google::Cloud::AutoML::V1beta1::InputConfig]
-        #     An input config specifying the content of the image.
-        # @!attribute [rw] thumbnail_uri
-        #   @return [String]
-        #     Output only. HTTP URI to the thumbnail image.
-        class Image; 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::V1beta1::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::V1beta1::TextSnippet#content content}.
-        # @!attribute [rw] content_uri
-        #   @return [String]
-        #     Output only. HTTP URI where you can download the content.
-        class TextSnippet; end
-
-        # Message that describes dimension of a document.
-        # @!attribute [rw] unit
-        #   @return [Google::Cloud::AutoML::V1beta1::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
-          # 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::V1beta1::DocumentInputConfig]
-        #     An input config specifying the content of the document.
-        # @!attribute [rw] document_text
-        #   @return [Google::Cloud::AutoML::V1beta1::TextSnippet]
-        #     The plain text version of this document.
-        # @!attribute [rw] layout
-        #   @return [Array<Google::Cloud::AutoML::V1beta1::Document::Layout>]
-        #     Describes the layout of the document.
-        #     Sorted by \\{Page_number}.
-        # @!attribute [rw] document_dimensions
-        #   @return [Google::Cloud::AutoML::V1beta1::DocumentDimensions]
-        #     The dimensions of the page in the document.
-        # @!attribute [rw] page_count
-        #   @return [Integer]
-        #     Number of pages in the document.
-        class Document
-          # Describes the layout information of a {Google::Cloud::AutoML::V1beta1::Document::Layout#text_segment text_segment} in the document.
-          # @!attribute [rw] text_segment
-          #   @return [Google::Cloud::AutoML::V1beta1::TextSegment]
-          #     Text Segment that represents a segment in
-          #     {Google::Cloud::AutoML::V1beta1::Document#document_text document_text}.
-          # @!attribute [rw] page_number
-          #   @return [Integer]
-          #     Page number of the {Google::Cloud::AutoML::V1beta1::Document::Layout#text_segment text_segment} in the original document, starts
-          #     from 1.
-          # @!attribute [rw] bounding_poly
-          #   @return [Google::Cloud::AutoML::V1beta1::BoundingPoly]
-          #     The position of the {Google::Cloud::AutoML::V1beta1::Document::Layout#text_segment text_segment} in the page.
-          #     Contains exactly 4
-          #
-          #     {Google::Cloud::AutoML::V1beta1::BoundingPoly#normalized_vertices normalized_vertices}
-          #     and they are connected by edges in the order provided, which will
-          #     represent a rectangle parallel to the frame. The
-          #     {Google::Cloud::AutoML::V1beta1::NormalizedVertex NormalizedVertex-s} are
-          #     relative to the page.
-          #     Coordinates are based on top-left as point (0,0).
-          # @!attribute [rw] text_segment_type
-          #   @return [Google::Cloud::AutoML::V1beta1::Document::Layout::TextSegmentType]
-          #     The type of the {Google::Cloud::AutoML::V1beta1::Document::Layout#text_segment text_segment} in document.
-          class Layout
-            # 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
-
-        # A representation of a row in a relational table.
-        # @!attribute [rw] column_spec_ids
-        #   @return [Array<String>]
-        #     The resource IDs of the column specs describing the columns of the row.
-        #     If set must contain, but possibly in a different order, all input
-        #     feature
-        #
-        #     {Google::Cloud::AutoML::V1beta1::TablesModelMetadata#input_feature_column_specs column_spec_ids}
-        #     of the Model this row is being passed to.
-        #     Note: The below `values` field must match order of this field, if this
-        #     field is set.
-        # @!attribute [rw] values
-        #   @return [Array<Google::Protobuf::Value>]
-        #     Required. The values of the row cells, given in the same order as the
-        #     column_spec_ids, or, if not set, then in the same order as input
-        #     feature
-        #
-        #     {Google::Cloud::AutoML::V1beta1::TablesModelMetadata#input_feature_column_specs column_specs}
-        #     of the Model this row is being passed to.
-        class Row; end
-
-        # Example data used for training or prediction.
-        # @!attribute [rw] image
-        #   @return [Google::Cloud::AutoML::V1beta1::Image]
-        #     Example image.
-        # @!attribute [rw] text_snippet
-        #   @return [Google::Cloud::AutoML::V1beta1::TextSnippet]
-        #     Example text.
-        # @!attribute [rw] document
-        #   @return [Google::Cloud::AutoML::V1beta1::Document]
-        #     Example document.
-        # @!attribute [rw] row
-        #   @return [Google::Cloud::AutoML::V1beta1::Row]
-        #     Example relational table row.
-        class ExamplePayload; end
-      end
-    end
-  end
-end

data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/data_stats.rb

@@ -1,160 +0,0 @@
-# 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.
-
-
-module Google
-  module Cloud
-    module AutoML
-      module V1beta1
-        # The data statistics of a series of values that share the same DataType.
-        # @!attribute [rw] float64_stats
-        #   @return [Google::Cloud::AutoML::V1beta1::Float64Stats]
-        #     The statistics for FLOAT64 DataType.
-        # @!attribute [rw] string_stats
-        #   @return [Google::Cloud::AutoML::V1beta1::StringStats]
-        #     The statistics for STRING DataType.
-        # @!attribute [rw] timestamp_stats
-        #   @return [Google::Cloud::AutoML::V1beta1::TimestampStats]
-        #     The statistics for TIMESTAMP DataType.
-        # @!attribute [rw] array_stats
-        #   @return [Google::Cloud::AutoML::V1beta1::ArrayStats]
-        #     The statistics for ARRAY DataType.
-        # @!attribute [rw] struct_stats
-        #   @return [Google::Cloud::AutoML::V1beta1::StructStats]
-        #     The statistics for STRUCT DataType.
-        # @!attribute [rw] category_stats
-        #   @return [Google::Cloud::AutoML::V1beta1::CategoryStats]
-        #     The statistics for CATEGORY DataType.
-        # @!attribute [rw] distinct_value_count
-        #   @return [Integer]
-        #     The number of distinct values.
-        # @!attribute [rw] null_value_count
-        #   @return [Integer]
-        #     The number of values that are null.
-        # @!attribute [rw] valid_value_count
-        #   @return [Integer]
-        #     The number of values that are valid.
-        class DataStats; end
-
-        # The data statistics of a series of FLOAT64 values.
-        # @!attribute [rw] mean
-        #   @return [Float]
-        #     The mean of the series.
-        # @!attribute [rw] standard_deviation
-        #   @return [Float]
-        #     The standard deviation of the series.
-        # @!attribute [rw] quantiles
-        #   @return [Array<Float>]
-        #     Ordered from 0 to k k-quantile values of the data series of n values.
-        #     The value at index i is, approximately, the i*n/k-th smallest value in the
-        #     series; for i = 0 and i = k these are, respectively, the min and max
-        #     values.
-        # @!attribute [rw] histogram_buckets
-        #   @return [Array<Google::Cloud::AutoML::V1beta1::Float64Stats::HistogramBucket>]
-        #     Histogram buckets of the data series. Sorted by the min value of the
-        #     bucket, ascendingly, and the number of the buckets is dynamically
-        #     generated. The buckets are non-overlapping and completely cover whole
-        #     FLOAT64 range with min of first bucket being `"-Infinity"`, and max of
-        #     the last one being `"Infinity"`.
-        class Float64Stats
-          # A bucket of a histogram.
-          # @!attribute [rw] min
-          #   @return [Float]
-          #     The minimum value of the bucket, inclusive.
-          # @!attribute [rw] max
-          #   @return [Float]
-          #     The maximum value of the bucket, exclusive unless max = `"Infinity"`, in
-          #     which case it's inclusive.
-          # @!attribute [rw] count
-          #   @return [Integer]
-          #     The number of data values that are in the bucket, i.e. are between
-          #     min and max values.
-          class HistogramBucket; end
-        end
-
-        # The data statistics of a series of STRING values.
-        # @!attribute [rw] top_unigram_stats
-        #   @return [Array<Google::Cloud::AutoML::V1beta1::StringStats::UnigramStats>]
-        #     The statistics of the top 20 unigrams, ordered by
-        #     {Google::Cloud::AutoML::V1beta1::StringStats::UnigramStats#count count}.
-        class StringStats
-          # The statistics of a unigram.
-          # @!attribute [rw] value
-          #   @return [String]
-          #     The unigram.
-          # @!attribute [rw] count
-          #   @return [Integer]
-          #     The number of occurrences of this unigram in the series.
-          class UnigramStats; end
-        end
-
-        # The data statistics of a series of TIMESTAMP values.
-        # @!attribute [rw] granular_stats
-        #   @return [Hash{String => Google::Cloud::AutoML::V1beta1::TimestampStats::GranularStats}]
-        #     The string key is the pre-defined granularity. Currently supported:
-        #     hour_of_day, day_of_week, month_of_year.
-        #     Granularities finer that the granularity of timestamp data are not
-        #     populated (e.g. if timestamps are at day granularity, then hour_of_day
-        #     is not populated).
-        class TimestampStats
-          # Stats split by a defined in context granularity.
-          # @!attribute [rw] buckets
-          #   @return [Hash{Integer => Integer}]
-          #     A map from granularity key to example count for that key.
-          #     E.g. for hour_of_day `13` means 1pm, or for month_of_year `5` means May).
-          class GranularStats; end
-        end
-
-        # The data statistics of a series of ARRAY values.
-        # @!attribute [rw] member_stats
-        #   @return [Google::Cloud::AutoML::V1beta1::DataStats]
-        #     Stats of all the values of all arrays, as if they were a single long
-        #     series of data. The type depends on the element type of the array.
-        class ArrayStats; end
-
-        # The data statistics of a series of STRUCT values.
-        # @!attribute [rw] field_stats
-        #   @return [Hash{String => Google::Cloud::AutoML::V1beta1::DataStats}]
-        #     Map from a field name of the struct to data stats aggregated over series
-        #     of all data in that field across all the structs.
-        class StructStats; end
-
-        # The data statistics of a series of CATEGORY values.
-        # @!attribute [rw] top_category_stats
-        #   @return [Array<Google::Cloud::AutoML::V1beta1::CategoryStats::SingleCategoryStats>]
-        #     The statistics of the top 20 CATEGORY values, ordered by
-        #
-        #     {Google::Cloud::AutoML::V1beta1::CategoryStats::SingleCategoryStats#count count}.
-        class CategoryStats
-          # The statistics of a single CATEGORY value.
-          # @!attribute [rw] value
-          #   @return [String]
-          #     The CATEGORY value.
-          # @!attribute [rw] count
-          #   @return [Integer]
-          #     The number of occurrences of this value in the series.
-          class SingleCategoryStats; end
-        end
-
-        # A correlation statistics between two series of DataType values. The series
-        # may have differing DataType-s, but within a single series the DataType must
-        # be the same.
-        # @!attribute [rw] cramers_v
-        #   @return [Float]
-        #     The correlation value using the Cramer's V measure.
-        class CorrelationStats; end
-      end
-    end
-  end
-end

data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/data_types.rb

@@ -1,99 +0,0 @@
-# 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.
-
-
-module Google
-  module Cloud
-    module AutoML
-      module V1beta1
-        # Indicated the type of data that can be stored in a structured data entity
-        # (e.g. a table).
-        # @!attribute [rw] list_element_type
-        #   @return [Google::Cloud::AutoML::V1beta1::DataType]
-        #     If {Google::Cloud::AutoML::V1beta1::DataType#type_code type_code} == {Google::Cloud::AutoML::V1beta1::TypeCode::ARRAY ARRAY},
-        #     then `list_element_type` is the type of the elements.
-        # @!attribute [rw] struct_type
-        #   @return [Google::Cloud::AutoML::V1beta1::StructType]
-        #     If {Google::Cloud::AutoML::V1beta1::DataType#type_code type_code} == {Google::Cloud::AutoML::V1beta1::TypeCode::STRUCT STRUCT}, then `struct_type`
-        #     provides type information for the struct's fields.
-        # @!attribute [rw] time_format
-        #   @return [String]
-        #     If {Google::Cloud::AutoML::V1beta1::DataType#type_code type_code} == {Google::Cloud::AutoML::V1beta1::TypeCode::TIMESTAMP TIMESTAMP}
-        #     then `time_format` provides the format in which that time field is
-        #     expressed. The time_format must either be one of:
-        #     * `UNIX_SECONDS`
-        #     * `UNIX_MILLISECONDS`
-        #     * `UNIX_MICROSECONDS`
-        #     * `UNIX_NANOSECONDS`
-        #       (for respectively number of seconds, milliseconds, microseconds and
-        #       nanoseconds since start of the Unix epoch);
-        #       or be written in `strftime` syntax. If time_format is not set, then the
-        #       default format as described on the type_code is used.
-        # @!attribute [rw] type_code
-        #   @return [Google::Cloud::AutoML::V1beta1::TypeCode]
-        #     Required. The {Google::Cloud::AutoML::V1beta1::TypeCode TypeCode} for this type.
-        # @!attribute [rw] nullable
-        #   @return [true, false]
-        #     If true, this DataType can also be `NULL`. In .CSV files `NULL` value is
-        #     expressed as an empty string.
-        class DataType; end
-
-        # `StructType` defines the DataType-s of a {Google::Cloud::AutoML::V1beta1::TypeCode::STRUCT STRUCT} type.
-        # @!attribute [rw] fields
-        #   @return [Hash{String => Google::Cloud::AutoML::V1beta1::DataType}]
-        #     Unordered map of struct field names to their data types.
-        #     Fields cannot be added or removed via Update. Their names and
-        #     data types are still mutable.
-        class StructType; end
-
-        # `TypeCode` is used as a part of
-        # {Google::Cloud::AutoML::V1beta1::DataType DataType}.
-        module TypeCode
-          # Not specified. Should not be used.
-          TYPE_CODE_UNSPECIFIED = 0
-
-          # Encoded as `number`, or the strings `"NaN"`, `"Infinity"`, or
-          # `"-Infinity"`.
-          FLOAT64 = 3
-
-          # Must be between 0AD and 9999AD. Encoded as `string` according to
-          # {Google::Cloud::AutoML::V1beta1::DataType#time_format time_format}, or, if
-          # that format is not set, then in RFC 3339 `date-time` format, where
-          # `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z).
-          TIMESTAMP = 4
-
-          # Encoded as `string`.
-          STRING = 6
-
-          # Encoded as `list`, where the list elements are represented according to
-          #
-          # {Google::Cloud::AutoML::V1beta1::DataType#list_element_type list_element_type}.
-          ARRAY = 8
-
-          # Encoded as `struct`, where field values are represented according to
-          # {Google::Cloud::AutoML::V1beta1::DataType#struct_type struct_type}.
-          STRUCT = 9
-
-          # Values of this type are not further understood by AutoML,
-          # e.g. AutoML is unable to tell the order of values (as it could with
-          # FLOAT64), or is unable to say if one value contains another (as it
-          # could with STRING).
-          # Encoded as `string` (bytes should be base64-encoded, as described in RFC
-          # 4648, section 4).
-          CATEGORY = 10
-        end
-      end
-    end
-  end
-end