As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Source code for google.cloud.automl_v1beta1.types.service

# -*- coding: utf-8 -*-
# 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
#
#     http://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.
#
import proto  # type: ignore

from google.cloud.automl_v1beta1.types import column_spec as gca_column_spec
from google.cloud.automl_v1beta1.types import dataset as gca_dataset
from google.cloud.automl_v1beta1.types import image
from google.cloud.automl_v1beta1.types import io
from google.cloud.automl_v1beta1.types import model as gca_model
from google.cloud.automl_v1beta1.types import model_evaluation as gca_model_evaluation
from google.cloud.automl_v1beta1.types import table_spec as gca_table_spec
from google.protobuf import field_mask_pb2  # type: ignore


__protobuf__ = proto.module(
    package="google.cloud.automl.v1beta1",
    manifest={
        "CreateDatasetRequest",
        "GetDatasetRequest",
        "ListDatasetsRequest",
        "ListDatasetsResponse",
        "UpdateDatasetRequest",
        "DeleteDatasetRequest",
        "ImportDataRequest",
        "ExportDataRequest",
        "GetAnnotationSpecRequest",
        "GetTableSpecRequest",
        "ListTableSpecsRequest",
        "ListTableSpecsResponse",
        "UpdateTableSpecRequest",
        "GetColumnSpecRequest",
        "ListColumnSpecsRequest",
        "ListColumnSpecsResponse",
        "UpdateColumnSpecRequest",
        "CreateModelRequest",
        "GetModelRequest",
        "ListModelsRequest",
        "ListModelsResponse",
        "DeleteModelRequest",
        "DeployModelRequest",
        "UndeployModelRequest",
        "ExportModelRequest",
        "ExportEvaluatedExamplesRequest",
        "GetModelEvaluationRequest",
        "ListModelEvaluationsRequest",
        "ListModelEvaluationsResponse",
    },
)


[docs]class CreateDatasetRequest(proto.Message): r"""Request message for [AutoMl.CreateDataset][google.cloud.automl.v1beta1.AutoMl.CreateDataset]. Attributes: parent (str): Required. The resource name of the project to create the dataset for. dataset (google.cloud.automl_v1beta1.types.Dataset): Required. The dataset to create. """ parent = proto.Field(proto.STRING, number=1,) dataset = proto.Field(proto.MESSAGE, number=2, message=gca_dataset.Dataset,)
[docs]class GetDatasetRequest(proto.Message): r"""Request message for [AutoMl.GetDataset][google.cloud.automl.v1beta1.AutoMl.GetDataset]. Attributes: name (str): Required. The resource name of the dataset to retrieve. """ name = proto.Field(proto.STRING, number=1,)
[docs]class ListDatasetsRequest(proto.Message): r"""Request message for [AutoMl.ListDatasets][google.cloud.automl.v1beta1.AutoMl.ListDatasets]. Attributes: parent (str): Required. The resource name of the project from which to list datasets. filter (str): 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. page_size (int): Requested page size. Server may return fewer results than requested. If unspecified, server will pick a default size. page_token (str): A token identifying a page of results for the server to return Typically obtained via [ListDatasetsResponse.next_page_token][google.cloud.automl.v1beta1.ListDatasetsResponse.next_page_token] of the previous [AutoMl.ListDatasets][google.cloud.automl.v1beta1.AutoMl.ListDatasets] call. """ parent = proto.Field(proto.STRING, number=1,) filter = proto.Field(proto.STRING, number=3,) page_size = proto.Field(proto.INT32, number=4,) page_token = proto.Field(proto.STRING, number=6,)
[docs]class ListDatasetsResponse(proto.Message): r"""Response message for [AutoMl.ListDatasets][google.cloud.automl.v1beta1.AutoMl.ListDatasets]. Attributes: datasets (Sequence[google.cloud.automl_v1beta1.types.Dataset]): The datasets read. next_page_token (str): A token to retrieve next page of results. Pass to [ListDatasetsRequest.page_token][google.cloud.automl.v1beta1.ListDatasetsRequest.page_token] to obtain that page. """ @property def raw_page(self): return self datasets = proto.RepeatedField( proto.MESSAGE, number=1, message=gca_dataset.Dataset, ) next_page_token = proto.Field(proto.STRING, number=2,)
[docs]class UpdateDatasetRequest(proto.Message): r"""Request message for [AutoMl.UpdateDataset][google.cloud.automl.v1beta1.AutoMl.UpdateDataset] Attributes: dataset (google.cloud.automl_v1beta1.types.Dataset): Required. The dataset which replaces the resource on the server. update_mask (google.protobuf.field_mask_pb2.FieldMask): The update mask applies to the resource. """ dataset = proto.Field(proto.MESSAGE, number=1, message=gca_dataset.Dataset,) update_mask = proto.Field( proto.MESSAGE, number=2, message=field_mask_pb2.FieldMask, )
[docs]class DeleteDatasetRequest(proto.Message): r"""Request message for [AutoMl.DeleteDataset][google.cloud.automl.v1beta1.AutoMl.DeleteDataset]. Attributes: name (str): Required. The resource name of the dataset to delete. """ name = proto.Field(proto.STRING, number=1,)
[docs]class ImportDataRequest(proto.Message): r"""Request message for [AutoMl.ImportData][google.cloud.automl.v1beta1.AutoMl.ImportData]. Attributes: name (str): Required. Dataset name. Dataset must already exist. All imported annotations and examples will be added. input_config (google.cloud.automl_v1beta1.types.InputConfig): Required. The desired input location and its domain specific semantics, if any. """ name = proto.Field(proto.STRING, number=1,) input_config = proto.Field(proto.MESSAGE, number=3, message=io.InputConfig,)
[docs]class ExportDataRequest(proto.Message): r"""Request message for [AutoMl.ExportData][google.cloud.automl.v1beta1.AutoMl.ExportData]. Attributes: name (str): Required. The resource name of the dataset. output_config (google.cloud.automl_v1beta1.types.OutputConfig): Required. The desired output location. """ name = proto.Field(proto.STRING, number=1,) output_config = proto.Field(proto.MESSAGE, number=3, message=io.OutputConfig,)
[docs]class GetAnnotationSpecRequest(proto.Message): r"""Request message for [AutoMl.GetAnnotationSpec][google.cloud.automl.v1beta1.AutoMl.GetAnnotationSpec]. Attributes: name (str): Required. The resource name of the annotation spec to retrieve. """ name = proto.Field(proto.STRING, number=1,)
[docs]class GetTableSpecRequest(proto.Message): r"""Request message for [AutoMl.GetTableSpec][google.cloud.automl.v1beta1.AutoMl.GetTableSpec]. Attributes: name (str): Required. The resource name of the table spec to retrieve. field_mask (google.protobuf.field_mask_pb2.FieldMask): Mask specifying which fields to read. """ name = proto.Field(proto.STRING, number=1,) field_mask = proto.Field(proto.MESSAGE, number=2, message=field_mask_pb2.FieldMask,)
[docs]class ListTableSpecsRequest(proto.Message): r"""Request message for [AutoMl.ListTableSpecs][google.cloud.automl.v1beta1.AutoMl.ListTableSpecs]. Attributes: parent (str): Required. The resource name of the dataset to list table specs from. field_mask (google.protobuf.field_mask_pb2.FieldMask): Mask specifying which fields to read. filter (str): Filter expression, see go/filtering. page_size (int): Requested page size. The server can return fewer results than requested. If unspecified, the server will pick a default size. page_token (str): A token identifying a page of results for the server to return. Typically obtained from the [ListTableSpecsResponse.next_page_token][google.cloud.automl.v1beta1.ListTableSpecsResponse.next_page_token] field of the previous [AutoMl.ListTableSpecs][google.cloud.automl.v1beta1.AutoMl.ListTableSpecs] call. """ parent = proto.Field(proto.STRING, number=1,) field_mask = proto.Field(proto.MESSAGE, number=2, message=field_mask_pb2.FieldMask,) filter = proto.Field(proto.STRING, number=3,) page_size = proto.Field(proto.INT32, number=4,) page_token = proto.Field(proto.STRING, number=6,)
[docs]class ListTableSpecsResponse(proto.Message): r"""Response message for [AutoMl.ListTableSpecs][google.cloud.automl.v1beta1.AutoMl.ListTableSpecs]. Attributes: table_specs (Sequence[google.cloud.automl_v1beta1.types.TableSpec]): The table specs read. next_page_token (str): A token to retrieve next page of results. Pass to [ListTableSpecsRequest.page_token][google.cloud.automl.v1beta1.ListTableSpecsRequest.page_token] to obtain that page. """ @property def raw_page(self): return self table_specs = proto.RepeatedField( proto.MESSAGE, number=1, message=gca_table_spec.TableSpec, ) next_page_token = proto.Field(proto.STRING, number=2,)
[docs]class UpdateTableSpecRequest(proto.Message): r"""Request message for [AutoMl.UpdateTableSpec][google.cloud.automl.v1beta1.AutoMl.UpdateTableSpec] Attributes: table_spec (google.cloud.automl_v1beta1.types.TableSpec): Required. The table spec which replaces the resource on the server. update_mask (google.protobuf.field_mask_pb2.FieldMask): The update mask applies to the resource. """ table_spec = proto.Field(proto.MESSAGE, number=1, message=gca_table_spec.TableSpec,) update_mask = proto.Field( proto.MESSAGE, number=2, message=field_mask_pb2.FieldMask, )
[docs]class GetColumnSpecRequest(proto.Message): r"""Request message for [AutoMl.GetColumnSpec][google.cloud.automl.v1beta1.AutoMl.GetColumnSpec]. Attributes: name (str): Required. The resource name of the column spec to retrieve. field_mask (google.protobuf.field_mask_pb2.FieldMask): Mask specifying which fields to read. """ name = proto.Field(proto.STRING, number=1,) field_mask = proto.Field(proto.MESSAGE, number=2, message=field_mask_pb2.FieldMask,)
[docs]class ListColumnSpecsRequest(proto.Message): r"""Request message for [AutoMl.ListColumnSpecs][google.cloud.automl.v1beta1.AutoMl.ListColumnSpecs]. Attributes: parent (str): Required. The resource name of the table spec to list column specs from. field_mask (google.protobuf.field_mask_pb2.FieldMask): Mask specifying which fields to read. filter (str): Filter expression, see go/filtering. page_size (int): Requested page size. The server can return fewer results than requested. If unspecified, the server will pick a default size. page_token (str): A token identifying a page of results for the server to return. Typically obtained from the [ListColumnSpecsResponse.next_page_token][google.cloud.automl.v1beta1.ListColumnSpecsResponse.next_page_token] field of the previous [AutoMl.ListColumnSpecs][google.cloud.automl.v1beta1.AutoMl.ListColumnSpecs] call. """ parent = proto.Field(proto.STRING, number=1,) field_mask = proto.Field(proto.MESSAGE, number=2, message=field_mask_pb2.FieldMask,) filter = proto.Field(proto.STRING, number=3,) page_size = proto.Field(proto.INT32, number=4,) page_token = proto.Field(proto.STRING, number=6,)
[docs]class ListColumnSpecsResponse(proto.Message): r"""Response message for [AutoMl.ListColumnSpecs][google.cloud.automl.v1beta1.AutoMl.ListColumnSpecs]. Attributes: column_specs (Sequence[google.cloud.automl_v1beta1.types.ColumnSpec]): The column specs read. next_page_token (str): A token to retrieve next page of results. Pass to [ListColumnSpecsRequest.page_token][google.cloud.automl.v1beta1.ListColumnSpecsRequest.page_token] to obtain that page. """ @property def raw_page(self): return self column_specs = proto.RepeatedField( proto.MESSAGE, number=1, message=gca_column_spec.ColumnSpec, ) next_page_token = proto.Field(proto.STRING, number=2,)
[docs]class UpdateColumnSpecRequest(proto.Message): r"""Request message for [AutoMl.UpdateColumnSpec][google.cloud.automl.v1beta1.AutoMl.UpdateColumnSpec] Attributes: column_spec (google.cloud.automl_v1beta1.types.ColumnSpec): Required. The column spec which replaces the resource on the server. update_mask (google.protobuf.field_mask_pb2.FieldMask): The update mask applies to the resource. """ column_spec = proto.Field( proto.MESSAGE, number=1, message=gca_column_spec.ColumnSpec, ) update_mask = proto.Field( proto.MESSAGE, number=2, message=field_mask_pb2.FieldMask, )
[docs]class CreateModelRequest(proto.Message): r"""Request message for [AutoMl.CreateModel][google.cloud.automl.v1beta1.AutoMl.CreateModel]. Attributes: parent (str): Required. Resource name of the parent project where the model is being created. model (google.cloud.automl_v1beta1.types.Model): Required. The model to create. """ parent = proto.Field(proto.STRING, number=1,) model = proto.Field(proto.MESSAGE, number=4, message=gca_model.Model,)
[docs]class GetModelRequest(proto.Message): r"""Request message for [AutoMl.GetModel][google.cloud.automl.v1beta1.AutoMl.GetModel]. Attributes: name (str): Required. Resource name of the model. """ name = proto.Field(proto.STRING, number=1,)
[docs]class ListModelsRequest(proto.Message): r"""Request message for [AutoMl.ListModels][google.cloud.automl.v1beta1.AutoMl.ListModels]. Attributes: parent (str): Required. Resource name of the project, from which to list the models. filter (str): 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. page_size (int): Requested page size. page_token (str): A token identifying a page of results for the server to return Typically obtained via [ListModelsResponse.next_page_token][google.cloud.automl.v1beta1.ListModelsResponse.next_page_token] of the previous [AutoMl.ListModels][google.cloud.automl.v1beta1.AutoMl.ListModels] call. """ parent = proto.Field(proto.STRING, number=1,) filter = proto.Field(proto.STRING, number=3,) page_size = proto.Field(proto.INT32, number=4,) page_token = proto.Field(proto.STRING, number=6,)
[docs]class ListModelsResponse(proto.Message): r"""Response message for [AutoMl.ListModels][google.cloud.automl.v1beta1.AutoMl.ListModels]. Attributes: model (Sequence[google.cloud.automl_v1beta1.types.Model]): List of models in the requested page. next_page_token (str): A token to retrieve next page of results. Pass to [ListModelsRequest.page_token][google.cloud.automl.v1beta1.ListModelsRequest.page_token] to obtain that page. """ @property def raw_page(self): return self model = proto.RepeatedField(proto.MESSAGE, number=1, message=gca_model.Model,) next_page_token = proto.Field(proto.STRING, number=2,)
[docs]class DeleteModelRequest(proto.Message): r"""Request message for [AutoMl.DeleteModel][google.cloud.automl.v1beta1.AutoMl.DeleteModel]. Attributes: name (str): Required. Resource name of the model being deleted. """ name = proto.Field(proto.STRING, number=1,)
[docs]class DeployModelRequest(proto.Message): r"""Request message for [AutoMl.DeployModel][google.cloud.automl.v1beta1.AutoMl.DeployModel]. Attributes: image_object_detection_model_deployment_metadata (google.cloud.automl_v1beta1.types.ImageObjectDetectionModelDeploymentMetadata): Model deployment metadata specific to Image Object Detection. image_classification_model_deployment_metadata (google.cloud.automl_v1beta1.types.ImageClassificationModelDeploymentMetadata): Model deployment metadata specific to Image Classification. name (str): Required. Resource name of the model to deploy. """ image_object_detection_model_deployment_metadata = proto.Field( proto.MESSAGE, number=2, oneof="model_deployment_metadata", message=image.ImageObjectDetectionModelDeploymentMetadata, ) image_classification_model_deployment_metadata = proto.Field( proto.MESSAGE, number=4, oneof="model_deployment_metadata", message=image.ImageClassificationModelDeploymentMetadata, ) name = proto.Field(proto.STRING, number=1,)
[docs]class UndeployModelRequest(proto.Message): r"""Request message for [AutoMl.UndeployModel][google.cloud.automl.v1beta1.AutoMl.UndeployModel]. Attributes: name (str): Required. Resource name of the model to undeploy. """ name = proto.Field(proto.STRING, number=1,)
[docs]class ExportModelRequest(proto.Message): r"""Request message for [AutoMl.ExportModel][google.cloud.automl.v1beta1.AutoMl.ExportModel]. Models need to be enabled for exporting, otherwise an error code will be returned. Attributes: name (str): Required. The resource name of the model to export. output_config (google.cloud.automl_v1beta1.types.ModelExportOutputConfig): Required. The desired output location and configuration. """ name = proto.Field(proto.STRING, number=1,) output_config = proto.Field( proto.MESSAGE, number=3, message=io.ModelExportOutputConfig, )
[docs]class ExportEvaluatedExamplesRequest(proto.Message): r"""Request message for [AutoMl.ExportEvaluatedExamples][google.cloud.automl.v1beta1.AutoMl.ExportEvaluatedExamples]. Attributes: name (str): Required. The resource name of the model whose evaluated examples are to be exported. output_config (google.cloud.automl_v1beta1.types.ExportEvaluatedExamplesOutputConfig): Required. The desired output location and configuration. """ name = proto.Field(proto.STRING, number=1,) output_config = proto.Field( proto.MESSAGE, number=3, message=io.ExportEvaluatedExamplesOutputConfig, )
[docs]class GetModelEvaluationRequest(proto.Message): r"""Request message for [AutoMl.GetModelEvaluation][google.cloud.automl.v1beta1.AutoMl.GetModelEvaluation]. Attributes: name (str): Required. Resource name for the model evaluation. """ name = proto.Field(proto.STRING, number=1,)
[docs]class ListModelEvaluationsRequest(proto.Message): r"""Request message for [AutoMl.ListModelEvaluations][google.cloud.automl.v1beta1.AutoMl.ListModelEvaluations]. Attributes: parent (str): Required. 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. filter (str): 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. page_size (int): Requested page size. page_token (str): A token identifying a page of results for the server to return. Typically obtained via [ListModelEvaluationsResponse.next_page_token][google.cloud.automl.v1beta1.ListModelEvaluationsResponse.next_page_token] of the previous [AutoMl.ListModelEvaluations][google.cloud.automl.v1beta1.AutoMl.ListModelEvaluations] call. """ parent = proto.Field(proto.STRING, number=1,) filter = proto.Field(proto.STRING, number=3,) page_size = proto.Field(proto.INT32, number=4,) page_token = proto.Field(proto.STRING, number=6,)
[docs]class ListModelEvaluationsResponse(proto.Message): r"""Response message for [AutoMl.ListModelEvaluations][google.cloud.automl.v1beta1.AutoMl.ListModelEvaluations]. Attributes: model_evaluation (Sequence[google.cloud.automl_v1beta1.types.ModelEvaluation]): List of model evaluations in the requested page. next_page_token (str): A token to retrieve next page of results. Pass to the [ListModelEvaluationsRequest.page_token][google.cloud.automl.v1beta1.ListModelEvaluationsRequest.page_token] field of a new [AutoMl.ListModelEvaluations][google.cloud.automl.v1beta1.AutoMl.ListModelEvaluations] request to obtain that page. """ @property def raw_page(self): return self model_evaluation = proto.RepeatedField( proto.MESSAGE, number=1, message=gca_model_evaluation.ModelEvaluation, ) next_page_token = proto.Field(proto.STRING, number=2,)
__all__ = tuple(sorted(__protobuf__.manifest))