google.cloud.automl.v1beta1 软件包

索引

• AutoMl（接口）
• PredictionService（接口）
• AnnotationPayload（消息）
• AnnotationSpec（消息）
• BatchPredictOperationMetadata（消息）
• BatchPredictOperationMetadata.BatchPredictionOutputInfo（消息）
• BatchPredictRequest（消息）
• BatchPredictResult（消息）
• BatchPredictionInputConfig（消息）
• BatchPredictionOutputConfig（消息）
• ClassificationAnnotation（消息）
• ClassificationEvaluationMetrics（消息）
• ClassificationEvaluationMetrics.ConfidenceMetricsEntry（消息）
• ClassificationEvaluationMetrics.ConfusionMatrix（消息）
• ClassificationEvaluationMetrics.ConfusionMatrix.Row（消息）
• CreateDatasetRequest（消息）
• CreateModelOperationMetadata（消息）
• CreateModelRequest（消息）
• Dataset（消息）
• DeleteDatasetRequest（消息）
• DeleteModelRequest（消息）
• DeleteOperationMetadata（消息）
• DeployModelRequest（消息）
• ExamplePayload（消息）
• ExportDataRequest（消息）
• GcsDestination（消息）
• GcsSource（消息）
• GetAnnotationSpecRequest（消息）
• GetDatasetRequest（消息）
• GetModelEvaluationRequest（消息）
• GetModelRequest（消息）
• ImportDataOperationMetadata（消息）
• ImportDataRequest（消息）
• InputConfig（消息）
• ListDatasetsRequest（消息）
• ListDatasetsResponse（消息）
• ListModelEvaluationsRequest（消息）
• ListModelEvaluationsResponse（消息）
• ListModelsRequest（消息）
• ListModelsResponse（消息）
• Model（消息）
• Model.DeploymentState（枚举）
• ModelEvaluation（消息）
• OperationMetadata（消息）
• OutputConfig（消息）
• PredictRequest（消息）
• PredictResponse（消息）
• TimeSegment（消息）
• UndeployModelRequest（消息）
• VideoClassificationAnnotation（消息）
• VideoClassificationDatasetMetadata（消息）
• VideoClassificationModelMetadata（消息）

AutoMl

AutoML Server API。

资源名称由服务器分配。服务器不会重复使用它为已删除的那些资源所创建的名称。

资源 ID 是项目的资源名称的最后一个元素。对于 projects/{project_id}/locations/{location_id}/datasets/{dataset_id}，该项的 ID 为 {dataset_id}。

目前，唯一受支持的 location_id 是“us-central1”。

CreateDataset
rpc CreateDataset(CreateDatasetRequest) returns (Dataset) 创建数据集。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅身份验证概览。

CreateModel
rpc CreateModel(CreateModelRequest) returns (Operation) 创建模型。完成时，它会在 response 字段中返回一个模型。当您创建模型时，系统会为该模型创建多个模型评估：即全局评估以及每个注释规范所对应的一项评估。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅身份验证概览。

DeleteDataset
rpc DeleteDataset(DeleteDatasetRequest) returns (Operation) 删除数据集及其所有内容。完成时，它会在 response 字段中返回空响应，并在 metadata 字段中返回 delete_details。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅身份验证概览。

DeleteModel
rpc DeleteModel(DeleteModelRequest) returns (Operation) 删除模型。完成时，它会在 response 字段中返回 google.protobuf.Empty，在 metadata 字段中返回 delete_details。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅身份验证概览。

DeployModel
rpc DeployModel(DeployModelRequest) returns (Operation) 部署模型。完成时，它会在 response 字段中返回空响应。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅身份验证概览。

ExportData
rpc ExportData(ExportDataRequest) returns (Operation) 将数据集的数据导出到 Google Cloud Storage 存储分区。完成时，它会在 response 字段中返回空响应。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅身份验证概览。

GetAnnotationSpec
rpc GetAnnotationSpec(GetAnnotationSpecRequest) returns (AnnotationSpec) 获取注释规范。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅身份验证概览。

GetDataset
rpc GetDataset(GetDatasetRequest) returns (Dataset) 获取数据集。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅身份验证概览。

GetModel
rpc GetModel(GetModelRequest) returns (Model) 获取模型。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅身份验证概览。

GetModelEvaluation
rpc GetModelEvaluation(GetModelEvaluationRequest) returns (ModelEvaluation) 获取模型评估。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅身份验证概览。

ImportData
rpc ImportData(ImportDataRequest) returns (Operation) 将数据导入数据集。 您只能针对空数据集调用此方法。 如需了解详情，请参阅将数据项导入数据集 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅身份验证概览。

ListDatasets
rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse) 列出项目中的数据集。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅身份验证概览。

ListModelEvaluations
rpc ListModelEvaluations(ListModelEvaluationsRequest) returns (ListModelEvaluationsResponse) 列出模型评估。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅身份验证概览。

ListModels
rpc ListModels(ListModelsRequest) returns (ListModelsResponse) 列出模型。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅身份验证概览。

UndeployModel
rpc UndeployModel(UndeployModelRequest) returns (Operation) 取消部署模型。完成时，它会在 response 字段中返回空响应。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅身份验证概览。

PredictionService

AutoML Prediction API。

BatchPredict
rpc BatchPredict(BatchPredictRequest) returns (Operation) 执行批量预测并返回长时间运行的操作的 ID。您可以使用 GetOperation 方法请求操作结果。当操作完成后，您可以调用 GetOperation，从 response 字段检索 BatchPredictResult。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅身份验证概览。

Predict
rpc Predict(PredictRequest) returns (PredictResponse) 不适用于 AutoML Video Intelligence。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅身份验证概览。

AnnotationPayload

包含与 AutoML 相关的注释信息。

字段
annotation_spec_id	string 仅限输出。与此注释相关的注释规范的资源 ID。注释规范来自祖先数据集或用于训练所用模型的数据集。
display_name	string 仅限输出。训练模型时 AnnotationSpec.display_name 的值。此字段在模型训练时会返回一个值，对于使用相同数据集训练的不同模型，返回值可能不同，因为模型所有者可以在任何两个模型训练之间更新 display_name。
联合字段 detail。仅限输出。有关 AutoML 解决方案特定注释的其他信息。detail 只能是下列其中一项：
classification	ClassificationAnnotation 关于分类预测的注释详情。
video_classification	VideoClassificationAnnotation 关于视频分类的注释详情。为视频分类预测返回此项。

AnnotationSpec

注释的定义。

字段
name	string 仅限输出。注释规范的资源名称。格式： 'projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationSpecs/{annotation_spec_id}'
display_name	string 必填。要在界面中显示的注释规范的名称。名称不得超过 32 个字符，只能包含 ASCII 拉丁字母（A-Z 和 a-z）、下划线 (_) 和 ASCII 数字 (0-9)。
example_count	int32 仅限输出。注释规范标记的父级数据集中的样本数。

BatchPredictOperationMetadata

BatchPredict 操作详情。

字段
input_config	BatchPredictionInputConfig 仅限输出。启动此批量预测操作时提供的输入配置。
output_info	BatchPredictionOutputInfo 仅限输出。进一步介绍此批量预测的输出的信息。

BatchPredictionOutputInfo

进一步介绍此批量预测的输出。补充

BatchPredictionOutputConfig。

字段
gcs_output_directory	string 创建的 Google Cloud Storage 目录的完整路径，其中写入了预测输出。

BatchPredictRequest

PredictionService.BatchPredict 的请求消息。

字段
name	string 被请求提供批量预测的模型的名称。 必须对指定的资源 name 具有以下 Google IAM 权限才能获得授权： automl.models.predict
input_config	BatchPredictionInputConfig 必填。批量预测的输入配置。
output_config	BatchPredictionOutputConfig 必填。指定应写入输出预测结果的位置。
params	map<string, string> 可以是下列选项之一： score_threshold （浮点值）0.0 到 1.0 之间的值。当模型对视频进行预测时，将仅产生至少具有该置信度分数的结果。默认值为 0。 segment_classification （布尔值）设置为 true 以请求片段级分类。AutoML Video Intelligence 返回用户在请求配置中指定的整个视频片段的标签及其置信度分数。默认值为“true”。 shot_classification （布尔值）设置为 true 以请求镜头级分类。AutoML Video Intelligence 确定用户在请求配置中指定的整个视频片段中每个镜头的边界。然后，AutoML Video Intelligence 会返回检测到的每个镜头的标签及其置信度分数，以及镜头的开始和结束时间。警告：对于该分类类型，不执行模型评估，分类的质量取决于训练数据，但不提供用于描述该质量的指标。默认值为“false”。 1s_interval_classification （布尔值）设为 true，以 1 秒钟为时间间隔请求对视频执行分类。AutoML Video Intelligence 返回用户在请求配置中指定的整个视频片段每一秒的标签及其置信度分数。警告：对于该分类类型，不执行模型评估，分类的质量取决于训练数据，但不提供用于描述该质量的指标。默认值为“false”。 请参阅为视频添加注释了解详情。

BatchPredictResult

批量预测结果。

BatchPredictionInputConfig

BatchPredict 操作的输入配置。输入是在 Google Cloud Storage 中存储的一个或多个 CSV 文件，其中 CSV 文件采用以下格式：

GCS_FILE_PATH,TIME_SEGMENT_START,TIME_SEGMENT_END

• GCS_FILE_PATH 标识大小不超过 50GB 且时长不超过 3 小时的视频的 Google Cloud Storage 路径。支持的扩展名：.MOV、.MPEG4、.MP4、.AVI。

• TIME_SEGMENT_START 和 TIME_SEGMENT_END 必须在视频的时长范围内，并且结束时间必须晚于开始时间。

三个样本行：

gs://folder/video1.mp4,10,40
gs://folder/video1.mp4,20,60
gs://folder/vid2.mov,0,inf

请参阅为视频添加注释了解详情。

字段
gcs_source	GcsSource 输入内容所在的 Google Cloud Storage 位置。

BatchPredictionOutputConfig

BatchPredict 操作的输出配置。

AutoML Video Intelligence 创建 gcsDestination 中指定的目录。目录的名称是"prediction-<model-display-name>-<timestamp-of-prediction-call>"，其中时间戳的格式为 YYYY-MM-DDThh:mm:ss.sssZ ISO-8601。

AutoML Video Intelligence 在新目录中创建名为 video_classification.csv 的文件，同时为所请求的每个视频分类创建一个 JSON 文件。即，输入 CSV 文件中的每一行。

video_classification.csv 文件的格式如下：

GCS_FILE_PATH,TIME_SEGMENT_START,TIME_SEGMENT_END,JSON_FILE_NAME,STATUS

• GCS_FILE_PATH、TIME_SEGMENT_START、TIME_SEGMENT_END 与输入 CSV 文件中的相同字段匹配。

• JSON_FILE_NAME 是输出目录中包含视频时间段预测响应的 JSON 文件的名称。

• STATUS 在预测成功完成后包含“OK”；否则包含错误信息。如果 STATUS 不是“OK”，则该预测的 JSON 文件可能为空或者该文件可能不存在。

STATUS 为“OK”的每个 JSON 文件都包含采用 JSON 格式的 AnnotationPayload proto 列表，其中预测了 video_classification.csv 中分配给文件的视频时间段。所有 AnnotationPayload proto 都有 video_classification 字段，并按 video_classification.type 字段排序。返回的类型由 BatchPredictRequest.params 的 classifaction_types 参数决定。

字段
gcs_destination	GcsDestination 输出必须写入的 Google Cloud Storage 目录位置。

ClassificationAnnotation

包含特定于分类的注释详细信息。

字段
score	float 仅限输出。介于 0.0 和 1.0 之间的置信度估计值。值越大意味着注释为正例的置信度越高。如果用户将注释批准为负例或正例，则分数值保持不变。如果用户创建注释，则分数为 0 时表示负例，为 1 时表示正例。

ClassificationEvaluationMetrics

分类问题的模型评估指标。这些指标仅描述类型设为 segment_classification 的预测的质量。要了解预测类型，请参阅 BatchPredictRequest.params。

字段
au_prc	float 仅限输出。精确率/召回率曲线下的面积指标。
base_au_prc	float 仅限输出。基于先验的精确率/召回率曲线下的面积指标。
confidence_metrics_entry[]	ConfidenceMetricsEntry 仅限输出。每个 confidence_threshold 的指标，范围为 0.05、0.10、...、0.95、0.96、0.97、0.98、0.99。由这些指标可以得到精确率/召回率曲线。
confusion_matrix	ConfusionMatrix 仅限输出。评估的混淆矩阵。仅针对标签数不超过 10 的 MULTICLASS 分类问题进行设置。仅针对模型级评估（而非标签级评估）进行设置。
annotation_spec_id[]	string 仅限输出。用于此评估的注释规范 ID。

ConfidenceMetricsEntry

单个置信度阈值的指标。

字段
confidence_threshold	float 仅限输出。用于计算指标的置信度阈值。
recall	float 仅限输出。指定置信度阈值下的召回率。
precision	float 仅限输出。指定置信度阈值下的精确率。
f1_score	float 仅限输出。召回率和精确率的调和平均数。
recall_at1	float 仅限输出。召回率（仅考虑具有最高预测分数且不低于每个样本的置信度阈值的标签）。
precision_at1	float 仅限输出。精确率（仅考虑具有最高预测分数且不低于每个样本的置信度阈值的标签）。
f1_score_at1	float 仅限输出。recall_at1 和 precision_at1 的调和平均数。

ConfusionMatrix

运行分类的模型的混淆矩阵。

字段
annotation_spec_id[]	string 仅限输出。混淆矩阵中使用的注释规范的 ID。
row[]	Row 仅限输出。混淆矩阵中的行。行数等于 annotation_spec_id 的大小。row[i].value[j] 是具有 annotation_spec_id[i] 的评估依据并且被正在评估的模型预测为 annotation_spec_id[j] 的样本的数量。

Row

仅限输出。混淆矩阵中的行。

字段
example_count[]	int32 仅限输出。混淆矩阵中特定单元的值。每行具有的值数（即，行的长度）等于 annotation_spec_id 字段的长度。

CreateDatasetRequest

AutoMl.CreateDataset 的请求消息。

字段
parent	string 要为其创建数据集的项目的资源名称。 必须对指定的资源 parent 具有以下 Google IAM 权限才能获得授权： automl.datasets.create
dataset	Dataset 要创建的数据集。

CreateModelOperationMetadata

CreateModel 操作详情。

CreateModelRequest

AutoMl.CreateModel 的请求消息。

字段
parent	string 要为其创建模型的父级项目的资源名称。 必须对指定的资源 parent 具有以下 Google IAM 权限才能获得授权： automl.models.create
model	Model 要创建的模型。

Dataset

一个工作区，用于解决单一的特定机器学习 (ML) 问题。工作区包含可以添加注释的样本。

字段
name	string 仅限输出。数据集的资源名称。格式如下：projects/{project_id}/locations/{location_id}/datasets/{dataset_id}
display_name	string 必填。要在界面中显示的数据集的名称。名称不得超过 32 个字符，只能包含 ASCII 拉丁字母（A-Z 和 a-z）、下划线 (_) 和 ASCII 数字 (0-9)。
example_count	int32 仅限输出。数据集中的样本数。
create_time	Timestamp 仅限输出。创建此数据集时的时间戳。
video_classification_dataset_metadata	VideoClassificationDatasetMetadata 用于视频分类的数据集的元数据。

DeleteDatasetRequest

AutoMl.DeleteDataset 的请求消息。

字段
name	string 要删除的数据集的资源名称。 必须对指定的资源 name 具有以下 Google IAM 权限才能获得授权： automl.datasets.delete

DeleteModelRequest

AutoMl.DeleteModel 的请求消息。

字段
name	string 要删除的模型的资源名称。 必须对指定的资源 name 具有以下 Google IAM 权限才能获得授权： automl.models.delete

DeleteOperationMetadata

执行删除任何实体的操作的详细信息。

DeployModelRequest

AutoMl.DeployModel 的请求消息。

字段
name	string 要部署的模型的资源名称。 必须对指定的资源 name 具有以下 Google IAM 权限才能获得授权： automl.models.deploy

ExamplePayload

用于训练或预测的样本数据。

ExportDataRequest

AutoMl.ExportData 的请求消息。

字段
name	string 必填。数据集的资源名称。 必须对指定的资源 name 具有以下 Google IAM 权限才能获得授权： automl.datasets.export
output_config	OutputConfig 必填。目标输出位置。

GcsDestination

必须写入输出的 Google Cloud Storage 位置。

字段
output_uri_prefix	string 必填。输出目录的 Google Cloud Storage URI，长度不超过 2000 个字符。接受的形式：* 前缀路径：gs://bucket/directory。发出请求的用户必须对相应存储分区拥有写入权限。如果该目录不存在，将会创建一个。

GcsSource

输入内容所在的 Google Cloud Storage 位置。

字段
input_uris[]	string 必填。输入文件的 Google Cloud Storage URI，长度不超过 2000 个字符。接受的形式：* 完整对象路径，例如 gs://bucket/directory/object.csv

GetAnnotationSpecRequest

AutoMl.GetAnnotationSpec 的请求消息。

字段
name	string 要检索的注释规范的资源名称。 必须对指定的资源 name 具有以下 Google IAM 权限才能获得授权： automl.annotationSpecs.get

GetDatasetRequest

AutoMl.GetDataset 的请求消息。

字段
name	string 要检索的数据集的资源名称。 必须对指定的资源 name 具有以下 Google IAM 权限才能获得授权： automl.datasets.get

GetModelEvaluationRequest

AutoMl.GetModelEvaluation 的请求消息。

字段
name	string 模型评估的资源名称。 必须对指定的资源 name 具有以下 Google IAM 权限才能获得授权： automl.modelEvaluations.get

GetModelRequest

AutoMl.GetModel 的请求消息。

字段
name	string 模型的资源名称。 必须对指定的资源 name 具有以下 Google IAM 权限才能获得授权： automl.models.get

ImportDataOperationMetadata

ImportData 操作详情。

ImportDataRequest

AutoMl.ImportData 的请求消息。

字段
name	string 必填。数据集名称。数据集必须是当前存在的数据集。系统会添加所有导入的注释和示例。 必须对指定的资源 name 具有以下 Google IAM 权限才能获得授权： automl.datasets.import
input_config	InputConfig 必填。目标输入位置及其网域特定语义（如果有）。

InputConfig

ImportData 操作的输入配置。

输入格式取决于正在发生导入操作的数据集所具有的 dataset_metadata。对于输入源，除非另有说明，否则应为 gcs_source。如果多次提到具有相同内容（即使它具有不同的 GCS_FILE_PATH）的文件，则会附加其标签、边界框等等。应始终为同一文件提供相同的 ML_USE 和 GCS_FILE_PATH，否则无法从给定的值中确切地选择这些值。

格式以 EBNF 表示，其中逗号作为字面量，并在该注释末尾附近定义非终结符号。格式如下：

如需了解详情，请参阅准备训练数据。

CSV 文件，每行的格式为：

ML_USE,GCS_FILE_PATH

• ML_USE - 标识当前行（文件）适用的数据集。这个值可以是以下值之一：

  • TRAIN - 此文件中的行用于训练模型。
  • TEST - 此文件中的行用于在训练期间测试模型。
  • UNASSIGNED - 此文件中的行未分类。它们会自动划分为训练数据和测试数据。80% 用于训练，20% 用于测试。

• GCS_FILE_PATH - 标识在 Google Cloud Storage 中存储的文件，其中包含模型训练信息。

在 TRAIN 和 UNASSIGNED CSV 文件中确定训练数据集之后，训练数据被划分为训练数据集和验证数据集。70% 用于训练，30% 用于验证。

使用 GCS_FILE_PATH 字段指定的每个 CSV 文件都采用以下格式：

GCS_FILE_PATH,LABEL,TIME_SEGMENT_START,TIME_SEGMENT_END

• GCS_FILE_PATH - 在 Google Cloud Storage 中存储的视频的路径。视频时长不得超过 1 小时。支持的扩展名：.MOV、.MPEG4、.MP4、.AVI 以及 ffmpeg 支持的任何文件格式。

• LABEL - 标识视频片段对象的标签。

• TIME_SEGMENT_START 和 TIME_SEGMENT_END - 要添加注释的视频片段的开始和结束时间戳（以秒为单位）。这些值必须在视频的时长范围内，TIME_SEGMENT_END 必须晚于 TIME_SEGMENT_START。

视频的任意帧具有一个或多个标签，则会被视为所有其他标签的难分样本。默认情况下，没有标签的帧被视为未知（可以通过 is_exhaustively_labeled 参数进行替换）。特殊标签“-”可用于表示给定时间段是所有标签的难分样本，标有“-”的片段不能与任何其他标签的片段重叠。

样本文件：

TRAIN,gs:folder/train_videos.csv
TEST,gs:folder/test_videos.csv
UNASSIGNED,gs:folder/other_videos.csv

以下是 gcsSource“顶级”文件标识的一个 CSV 文件的格式样本。

 gs:folder/video1.avi,car,120,180.000021
 gs:folder/video1.avi,bike,150,180.000023
 gs:folder/video1.avi,-,180.000024,300.000999
 gs:folder/vid2.avi,car,0,60.5

错误：

如果无法解析提供的任何 CSV 文件，或者如果无法处理超过特定百分比的 CSV 行，则操作失败，并且不会导入任何内容。无论总体成功还是失败，每行失败率（不超过特定计数上限）将列在 Operation.metadata.partial_failures 中。

字段
gcs_source	GcsSource 输入内容所在的 Google Cloud Storage 位置。

ListDatasetsRequest

AutoMl.ListDatasets 的请求消息。

字段
parent	string 要列出其数据集的项目的资源名称。 必须对指定的资源 parent 具有以下 Google IAM 权限才能获得授权： automl.datasets.list
filter	string 用于过滤请求结果的表达式。 dataset_metadata：测试是否存在元数据。 display_name：=、!= 和 regex()。使用 re2 语法。 使用此过滤条件的示例： video_classification_dataset_metadata:* --> 数据集具有 video_classification_dataset_metadata。 regex(display_name, "^A") -> 数据集的显示名以“A”开头
page_size	int32 请求的页面大小。服务器返回的结果可能要比请求的少。如果未指定，服务器将选择默认大小。
page_token	string 一个令牌，用于标识要让服务器返回的结果页面。通常取自前一次 AutoMl.ListDatasets 调用的 ListDatasetsResponse.next_page_token。

ListDatasetsResponse

AutoMl.ListDatasets 的响应消息。

字段
datasets[]	Dataset 读取的数据集。
next_page_token	string 用于检索下一页结果的令牌。传递给 ListDatasetsRequest.page_token 即可获取该页面。

ListModelEvaluationsRequest

AutoMl.ListModelEvaluations 的请求消息。

字段
parent	string 要列出其模型评估的模型资源名称。如果 modelId 设为“-”，则将列出父位置的所有模型的模型评估。 必须对指定的资源 parent 具有以下 Google IAM 权限才能获得授权： automl.modelEvaluations.list
filter	string 用于过滤请求结果的表达式。 annotation_spec_id：=、!= 或存在。后者请见以下示例。 使用该过滤条件的一些示例： annotation_spec_id!=4 --> 已针对 ID 不为 4 的注释规范完成了模型评估。 NOT annotation_spec_id:* --> 已针对所有注释规范的聚合完成了模型评估。
page_size	int32 请求的页面大小。
page_token	string 一个令牌，用于标识要让服务器返回的结果页面。通常取自前一次 AutoMl.ListModelEvaluations 调用的 ListModelEvaluationsResponse.next_page_token。

ListModelEvaluationsResponse

AutoMl.ListModelEvaluations 的响应消息。

字段
model_evaluation[]	ModelEvaluation 所请求页面中的模型评估列表。
next_page_token	string 用于检索下一页结果的令牌。传递给新的 AutoMl.ListModelEvaluations 请求的 ListModelEvaluationsRequest.page_token 字段即可获取该页面。

ListModelsRequest

AutoMl.ListModels 的请求消息。

字段
parent	string 要列出其模型的项目的资源名称。 必须对指定的资源 parent 具有以下 Google IAM 权限才能获得授权： automl.models.list
filter	string 用于过滤请求结果的表达式。 model_metadata：测试是否存在元数据。 dataset_id：= 或 != 数据集 ID。 display_name：=、!= 和 regex()。使用 re2 语法。 使用该过滤条件的一些示例： video_classification_model_metadata:* --> 该模型具有 video_classification_model_metadata。 dataset_id=5 --> 模型根据 ID 为 5 的数据集创建而成。 regex(display_name, "^A") -> 模型的显示名以“A”开头。
page_size	int32 请求的页面大小。
page_token	string 一个令牌，用于标识要让服务器返回的结果页面。通常取自前一次 AutoMl.ListModels 调用的 ListModelsResponse.next_page_token。

ListModelsResponse

AutoMl.ListModels 的响应消息。

字段
model[]	Model 所请求页面中的模型列表。
next_page_token	string 用于检索下一页结果的令牌。传递给 ListModelsRequest.page_token 即可获取该页面。

型号

API proto，代表所训练的机器学习模型。

字段
name	string 仅限输出。模型的资源名称。格式如下：projects/{project_id}/locations/{location_id}/models/{model_id}
display_name	string 必填。要在界面中显示的模型的名称。名称不得超过 32 个字符，只能包含 ASCII 拉丁字母（A-Z 和 a-z）、下划线 (_) 和 ASCII 数字 (0-9)。必须以字母开头。
dataset_id	string 必填。用于创建模型的数据集的资源 ID。数据集必须来自相同的祖先项目和位置。
create_time	Timestamp 仅限输出。创建此模型时的时间戳。
update_time	Timestamp 仅限输出。上次更新此模型时的时间戳。
deployment_state	DeploymentState 仅限输出。模型的部署状态。模型只能在部署后才能服务预测请求。
video_classification_model_metadata	VideoClassificationModelMetadata 视频分类模型的元数据。

DeploymentState

模型的部署状态。

枚举
DEPLOYMENT_STATE_UNSPECIFIED	不应使用，默认情况下，未设置的枚举具有此值。
DEPLOYED	模型已部署。
UNDEPLOYED	模型未部署。

ModelEvaluation

模型的评估结果。

字段
name	string 仅限输出。模型评估的资源名称。格式： projects/{project_id}/locations/{location_id}/models/{model_id}/modelEvaluations/{model_evaluation_id}
annotation_spec_id	string 仅限输出。模型评估适用的注释规范的 ID。整体模型评估的 ID 为空。注意：目前无法从注释规范的 ID 获取其 display_name。要查看 display_name，请查看界面中的模型评估。
display_name	string 仅限输出。训练模型时 AnnotationSpec.display_name 的值。此字段在模型训练时会返回一个值，对于使用相同数据集训练的不同模型，返回值可能不同，因为模型所有者可以在任何两个模型训练之间更新 display_name。整体模型评估的 display_name 为空。
create_time	Timestamp 仅限输出。创建此模型评估时的时间戳。
evaluated_example_count	int32 仅限输出。用于模型评估的样本数，评估时将模型创建时的评估依据与模型创建的预测注释进行比较。对于整体 ModelEvaluation（即未设置 annotation_spec_id），这是用于评估的所有样本的总数。否则，这是根据评估依据由以下项注释的样本数： annotation_spec_id。
classification_evaluation_metrics	ClassificationEvaluationMetrics 分类模型的评估指标。

OperationMetadata

在由 AutoML API 返回的所有长时间运行操作中使用的元数据。

字段
progress_percent	int32 仅限输出。操作进度。范围：[0, 100]。尚未使用。
partial_failures[]	Status 仅限输出。遇到的部分失败。例如，无法读取个别文件。该字段不应超过 20 个条目。状态详细信息字段将包含标准 GCP 错误详情。
create_time	Timestamp 仅限输出。操作的创建时间。
update_time	Timestamp 仅限输出。上次更新操作的时间。
联合字段 details。仅限输出。特定操作详情。即使此字段为空，其存在也可以区分不同的操作类型。details 只能是下列其中一项：
delete_details	DeleteOperationMetadata Delete 操作详情。
create_model_details	CreateModelOperationMetadata CreateModel 操作详情。
import_data_details	ImportDataOperationMetadata ImportData 操作详情。
batch_predict_details	BatchPredictOperationMetadata BatchPredict 操作详情。

OutputConfig

输出配置。

字段
gcs_destination	GcsDestination 必须写入输出的 Google Cloud Storage 位置。

PredictRequest

PredictionService.Predict 的请求消息。

字段
name	string 要请求其提供预测的模型的名称。 必须对指定的资源 name 具有以下 Google IAM 权限才能获得授权： automl.models.predict
payload	ExamplePayload 必填。用于执行预测的负载。负载必须与模型被训练来解决的问题类型相匹配。
params	map<string, string> 其他网域特定参数，任何字符串的长度均不得超过 25000 个字符。

PredictResponse

PredictionService.Predict 的响应消息。

字段
payload[]	AnnotationPayload 预测结果。
metadata	map<string, string> 网域专有的附加预测响应元数据。

TimeSegment

具有时间维度的样本（例如，视频）内的时间段。

字段
start_time_offset	Duration 时间段的开始时间（含边界值），表示为自样本启动以来的时长。
end_time_offset	Duration 时间段结束时间（不含边界值），表示为自样本启动以来的时长。

UndeployModelRequest

AutoMl.UndeployModel 的请求消息。

字段
name	string 要取消部署的模型的资源名称。 必须对指定的资源 name 具有以下 Google IAM 权限才能获得授权： automl.models.undeploy

VideoClassificationAnnotation

包含针对视频分类的注释详细信息。

字段
type	string 仅限输出。表示视频分类的类型。可能的值： segment - 已按用户指定的视频时间段进行分类。如果 AnnotationSpec 存在于该时间段的任何部分，则报告 AnnotationSpec 存在于该时间段中。视频机器学习模型评估仅适用于这种分类。 shot - 镜头级分类。AutoML Video Intelligence 确定用户在请求配置中指定的整个视频片段中每个镜头的边界。然后，AutoML Video Intelligence 会返回检测到的每个镜头的标签及其置信度分数，以及镜头的开始和结束时间。警告：对于该分类类型，不执行模型评估，分类的质量取决于训练数据，但不提供用于描述该质量的指标。 1s_interval - AutoML Video Intelligence 返回用户在请求配置中指定的整个视频片段每一秒的标签及其置信度分数。警告：对于该分类类型，不执行模型评估，分类的质量取决于训练数据，但不提供用于描述该质量的指标。
classification_annotation	ClassificationAnnotation 仅限输出。此注释的分类详情。
time_segment	TimeSegment 仅限输出。注释适用的视频时间段。

VideoClassificationDatasetMetadata

针对视频分类的数据集元数据。所有视频分类数据集均视为多标签。

VideoClassificationModelMetadata

针对视频分类的模型元数据。