google-cloud-automl 0.1.0

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

@@ -0,0 +1,368 @@
+# Copyright 2019 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
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::CreateDataset AutoML::CreateDataset}.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     The resource name of the project to create the dataset for.
+        # @!attribute [rw] dataset
+        #   @return [Google::Cloud::AutoML::V1beta1::Dataset]
+        #     The dataset to create.
+        class CreateDatasetRequest; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::GetDataset AutoML::GetDataset}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     The resource name of the dataset to retrieve.
+        class GetDatasetRequest; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::ListDatasets AutoML::ListDatasets}.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     The resource name of the project from which to list datasets.
+        # @!attribute [rw] filter
+        #   @return [String]
+        #     An expression for filtering the results of the request.
+        #
+        #     * `dataset_metadata` - for existence of the case (e.g.
+        #       image_classification_dataset_metadata:*). Some examples of using the filter are:
+        #
+        #       * `translation_dataset_metadata:*` --> The dataset has
+        #         translation_dataset_metadata.
+        # @!attribute [rw] page_size
+        #   @return [Integer]
+        #     Requested page size. Server may return fewer results than requested.
+        #     If unspecified, server will pick a default size.
+        # @!attribute [rw] page_token
+        #   @return [String]
+        #     A token identifying a page of results for the server to return
+        #     Typically obtained via
+        #     {Google::Cloud::AutoML::V1beta1::ListDatasetsResponse#next_page_token ListDatasetsResponse#next_page_token} of the previous
+        #     {Google::Cloud::AutoML::V1beta1::AutoML::ListDatasets AutoML::ListDatasets} call.
+        class ListDatasetsRequest; end
+
+        # Response message for {Google::Cloud::AutoML::V1beta1::AutoML::ListDatasets AutoML::ListDatasets}.
+        # @!attribute [rw] datasets
+        #   @return [Array<Google::Cloud::AutoML::V1beta1::Dataset>]
+        #     The datasets read.
+        # @!attribute [rw] next_page_token
+        #   @return [String]
+        #     A token to retrieve next page of results.
+        #     Pass to {Google::Cloud::AutoML::V1beta1::ListDatasetsRequest#page_token ListDatasetsRequest#page_token} to obtain that page.
+        class ListDatasetsResponse; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::UpdateDataset AutoML::UpdateDataset}
+        # @!attribute [rw] dataset
+        #   @return [Google::Cloud::AutoML::V1beta1::Dataset]
+        #     The dataset which replaces the resource on the server.
+        # @!attribute [rw] update_mask
+        #   @return [Google::Protobuf::FieldMask]
+        #     The update mask applies to the resource. For the `FieldMask` definition,
+        #     see
+        #
+        #     https:
+        #     //developers.google.com/protocol-buffers
+        #     // /docs/reference/google.protobuf#fieldmask
+        class UpdateDatasetRequest; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::DeleteDataset AutoML::DeleteDataset}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     The resource name of the dataset to delete.
+        class DeleteDatasetRequest; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::ImportData AutoML::ImportData}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Required. Dataset name. Dataset must already exist. All imported
+        #     annotations and examples will be added.
+        # @!attribute [rw] input_config
+        #   @return [Google::Cloud::AutoML::V1beta1::InputConfig]
+        #     Required. The desired input location and its domain specific semantics,
+        #     if any.
+        class ImportDataRequest; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::ExportData AutoML::ExportData}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Required. The resource name of the dataset.
+        # @!attribute [rw] output_config
+        #   @return [Google::Cloud::AutoML::V1beta1::OutputConfig]
+        #     Required. The desired output location.
+        class ExportDataRequest; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::GetAnnotationSpec AutoML::GetAnnotationSpec}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     The resource name of the annotation spec to retrieve.
+        class GetAnnotationSpecRequest; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::GetTableSpec AutoML::GetTableSpec}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     The resource name of the table spec to retrieve.
+        # @!attribute [rw] field_mask
+        #   @return [Google::Protobuf::FieldMask]
+        #     Mask specifying which fields to read.
+        class GetTableSpecRequest; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::ListTableSpecs AutoML::ListTableSpecs}.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     The resource name of the dataset to list table specs from.
+        # @!attribute [rw] field_mask
+        #   @return [Google::Protobuf::FieldMask]
+        #     Mask specifying which fields to read.
+        # @!attribute [rw] filter
+        #   @return [String]
+        #     Filter expression, see go/filtering.
+        # @!attribute [rw] page_size
+        #   @return [Integer]
+        #     Requested page size. The server can return fewer results than requested.
+        #     If unspecified, the server will pick a default size.
+        # @!attribute [rw] page_token
+        #   @return [String]
+        #     A token identifying a page of results for the server to return.
+        #     Typically obtained from the
+        #     {Google::Cloud::AutoML::V1beta1::ListTableSpecsResponse#next_page_token ListTableSpecsResponse#next_page_token} field of the previous
+        #     {Google::Cloud::AutoML::V1beta1::AutoML::ListTableSpecs AutoML::ListTableSpecs} call.
+        class ListTableSpecsRequest; end
+
+        # Response message for {Google::Cloud::AutoML::V1beta1::AutoML::ListTableSpecs AutoML::ListTableSpecs}.
+        # @!attribute [rw] table_specs
+        #   @return [Array<Google::Cloud::AutoML::V1beta1::TableSpec>]
+        #     The table specs read.
+        # @!attribute [rw] next_page_token
+        #   @return [String]
+        #     A token to retrieve next page of results.
+        #     Pass to {Google::Cloud::AutoML::V1beta1::ListTableSpecsRequest#page_token ListTableSpecsRequest#page_token} to obtain that page.
+        class ListTableSpecsResponse; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::UpdateTableSpec AutoML::UpdateTableSpec}
+        # @!attribute [rw] table_spec
+        #   @return [Google::Cloud::AutoML::V1beta1::TableSpec]
+        #     The table spec which replaces the resource on the server.
+        # @!attribute [rw] update_mask
+        #   @return [Google::Protobuf::FieldMask]
+        #     The update mask applies to the resource. For the `FieldMask` definition,
+        #     see
+        #
+        #     https:
+        #     //developers.google.com/protocol-buffers
+        #     // /docs/reference/google.protobuf#fieldmask
+        class UpdateTableSpecRequest; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::GetColumnSpec AutoML::GetColumnSpec}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     The resource name of the column spec to retrieve.
+        # @!attribute [rw] field_mask
+        #   @return [Google::Protobuf::FieldMask]
+        #     Mask specifying which fields to read.
+        class GetColumnSpecRequest; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::ListColumnSpecs AutoML::ListColumnSpecs}.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     The resource name of the table spec to list column specs from.
+        # @!attribute [rw] field_mask
+        #   @return [Google::Protobuf::FieldMask]
+        #     Mask specifying which fields to read.
+        # @!attribute [rw] filter
+        #   @return [String]
+        #     Filter expression, see go/filtering.
+        # @!attribute [rw] page_size
+        #   @return [Integer]
+        #     Requested page size. The server can return fewer results than requested.
+        #     If unspecified, the server will pick a default size.
+        # @!attribute [rw] page_token
+        #   @return [String]
+        #     A token identifying a page of results for the server to return.
+        #     Typically obtained from the
+        #     {Google::Cloud::AutoML::V1beta1::ListColumnSpecsResponse#next_page_token ListColumnSpecsResponse#next_page_token} field of the previous
+        #     {Google::Cloud::AutoML::V1beta1::AutoML::ListColumnSpecs AutoML::ListColumnSpecs} call.
+        class ListColumnSpecsRequest; end
+
+        # Response message for {Google::Cloud::AutoML::V1beta1::AutoML::ListColumnSpecs AutoML::ListColumnSpecs}.
+        # @!attribute [rw] column_specs
+        #   @return [Array<Google::Cloud::AutoML::V1beta1::ColumnSpec>]
+        #     The column specs read.
+        # @!attribute [rw] next_page_token
+        #   @return [String]
+        #     A token to retrieve next page of results.
+        #     Pass to {Google::Cloud::AutoML::V1beta1::ListColumnSpecsRequest#page_token ListColumnSpecsRequest#page_token} to obtain that page.
+        class ListColumnSpecsResponse; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::UpdateColumnSpec AutoML::UpdateColumnSpec}
+        # @!attribute [rw] column_spec
+        #   @return [Google::Cloud::AutoML::V1beta1::ColumnSpec]
+        #     The column spec which replaces the resource on the server.
+        # @!attribute [rw] update_mask
+        #   @return [Google::Protobuf::FieldMask]
+        #     The update mask applies to the resource. For the `FieldMask` definition,
+        #     see
+        #
+        #     https:
+        #     //developers.google.com/protocol-buffers
+        #     // /docs/reference/google.protobuf#fieldmask
+        class UpdateColumnSpecRequest; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::CreateModel AutoML::CreateModel}.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     Resource name of the parent project where the model is being created.
+        # @!attribute [rw] model
+        #   @return [Google::Cloud::AutoML::V1beta1::Model]
+        #     The model to create.
+        class CreateModelRequest; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::GetModel AutoML::GetModel}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Resource name of the model.
+        class GetModelRequest; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::ListModels AutoML::ListModels}.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     Resource name of the project, from which to list the models.
+        # @!attribute [rw] filter
+        #   @return [String]
+        #     An expression for filtering the results of the request.
+        #
+        #     * `model_metadata` - for existence of the case (e.g.
+        #       video_classification_model_metadata:*).
+        #       * `dataset_id` - for = or !=. Some examples of using the filter are:
+        #
+        #       * `image_classification_model_metadata:*` --> The model has
+        #         image_classification_model_metadata.
+        #       * `dataset_id=5` --> The model was created from a dataset with ID 5.
+        # @!attribute [rw] page_size
+        #   @return [Integer]
+        #     Requested page size.
+        # @!attribute [rw] page_token
+        #   @return [String]
+        #     A token identifying a page of results for the server to return
+        #     Typically obtained via
+        #     {Google::Cloud::AutoML::V1beta1::ListModelsResponse#next_page_token ListModelsResponse#next_page_token} of the previous
+        #     {Google::Cloud::AutoML::V1beta1::AutoML::ListModels AutoML::ListModels} call.
+        class ListModelsRequest; end
+
+        # Response message for {Google::Cloud::AutoML::V1beta1::AutoML::ListModels AutoML::ListModels}.
+        # @!attribute [rw] model
+        #   @return [Array<Google::Cloud::AutoML::V1beta1::Model>]
+        #     List of models in the requested page.
+        # @!attribute [rw] next_page_token
+        #   @return [String]
+        #     A token to retrieve next page of results.
+        #     Pass to {Google::Cloud::AutoML::V1beta1::ListModelsRequest#page_token ListModelsRequest#page_token} to obtain that page.
+        class ListModelsResponse; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::DeleteModel AutoML::DeleteModel}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Resource name of the model being deleted.
+        class DeleteModelRequest; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::DeployModel AutoML::DeployModel}.
+        # @!attribute [rw] image_object_detection_model_deployment_metadata
+        #   @return [Google::Cloud::AutoML::V1beta1::ImageObjectDetectionModelDeploymentMetadata]
+        #     Model deployment metadata specific to Image Object Detection.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Resource name of the model to deploy.
+        class DeployModelRequest; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::UndeployModel AutoML::UndeployModel}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Resource name of the model to undeploy.
+        class UndeployModelRequest; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::ExportModel AutoML::ExportModel}.
+        # Models need to be enabled for exporting, otherwise an error code will be
+        # returned.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Required. The resource name of the model to export.
+        # @!attribute [rw] output_config
+        #   @return [Google::Cloud::AutoML::V1beta1::ModelExportOutputConfig]
+        #     Required. The desired output location and configuration.
+        class ExportModelRequest; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::ExportEvaluatedExamples AutoML::ExportEvaluatedExamples}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Required. The resource name of the model whose evaluated examples are to
+        #     be exported.
+        # @!attribute [rw] output_config
+        #   @return [Google::Cloud::AutoML::V1beta1::ExportEvaluatedExamplesOutputConfig]
+        #     Required. The desired output location and configuration.
+        class ExportEvaluatedExamplesRequest; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::GetModelEvaluation AutoML::GetModelEvaluation}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Resource name for the model evaluation.
+        class GetModelEvaluationRequest; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::ListModelEvaluations AutoML::ListModelEvaluations}.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     Resource name of the model to list the model evaluations for.
+        #     If modelId is set as "-", this will list model evaluations from across all
+        #     models of the parent location.
+        # @!attribute [rw] filter
+        #   @return [String]
+        #     An expression for filtering the results of the request.
+        #
+        #     * `annotation_spec_id` - for =, !=  or existence. See example below for
+        #       the last.
+        #
+        #     Some examples of using the filter are:
+        #
+        #     * `annotation_spec_id!=4` --> The model evaluation was done for
+        #       annotation spec with ID different than 4.
+        #       * `NOT annotation_spec_id:*` --> The model evaluation was done for
+        #         aggregate of all annotation specs.
+        # @!attribute [rw] page_size
+        #   @return [Integer]
+        #     Requested page size.
+        # @!attribute [rw] page_token
+        #   @return [String]
+        #     A token identifying a page of results for the server to return.
+        #     Typically obtained via
+        #     {Google::Cloud::AutoML::V1beta1::ListModelEvaluationsResponse#next_page_token ListModelEvaluationsResponse#next_page_token} of the previous
+        #     {Google::Cloud::AutoML::V1beta1::AutoML::ListModelEvaluations AutoML::ListModelEvaluations} call.
+        class ListModelEvaluationsRequest; end
+
+        # Response message for {Google::Cloud::AutoML::V1beta1::AutoML::ListModelEvaluations AutoML::ListModelEvaluations}.
+        # @!attribute [rw] model_evaluation
+        #   @return [Array<Google::Cloud::AutoML::V1beta1::ModelEvaluation>]
+        #     List of model evaluations in the requested page.
+        # @!attribute [rw] next_page_token
+        #   @return [String]
+        #     A token to retrieve next page of results.
+        #     Pass to the {Google::Cloud::AutoML::V1beta1::ListModelEvaluationsRequest#page_token ListModelEvaluationsRequest#page_token} field of a new
+        #     {Google::Cloud::AutoML::V1beta1::AutoML::ListModelEvaluations AutoML::ListModelEvaluations} request to obtain that page.
+        class ListModelEvaluationsResponse; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# Copyright 2019 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 specification of a relational table.
+        # The table's schema is represented via its child column specs. It is
+        # pre-populated as part of ImportData by schema inference algorithm, the
+        # version of which is a required parameter of ImportData InputConfig.
+        # Note: While working with a table, at times the schema may be
+        # inconsistent with the data in the table (e.g. string in a FLOAT64 column).
+        # The consistency validation is done upon creation of a model.
+        # Used by:
+        # * Tables
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Output only. The resource name of the table spec.
+        #     Form:
+        #
+        #     `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/tableSpecs/{table_spec_id}`
+        # @!attribute [rw] time_column_spec_id
+        #   @return [String]
+        #     column_spec_id of the time column. Only used if the parent dataset's
+        #     ml_use_column_spec_id is not set. Used to split rows into TRAIN, VALIDATE
+        #     and TEST sets such that oldest rows go to TRAIN set, newest to TEST, and
+        #     those in between to VALIDATE.
+        #     Required type: TIMESTAMP.
+        #     If both this column and ml_use_column are not set, then ML use of all rows
+        #     will be assigned by AutoML. NOTE: Updates of this field will instantly
+        #     affect any other users concurrently working with the dataset.
+        # @!attribute [rw] row_count
+        #   @return [Integer]
+        #     Output only. The number of rows (i.e. examples) in the table.
+        # @!attribute [rw] column_count
+        #   @return [Integer]
+        #     Output only. The number of columns of the table. That is, the number of
+        #     child ColumnSpec-s.
+        # @!attribute [rw] input_configs
+        #   @return [Array<Google::Cloud::AutoML::V1beta1::InputConfig>]
+        #     Output only. Input configs via which data currently residing in the table
+        #     had been imported.
+        # @!attribute [rw] etag
+        #   @return [String]
+        #     Used to perform consistent read-modify-write updates. If not set, a blind
+        #     "overwrite" update happens.
+        class TableSpec; end
+      end
+    end
+  end
+end