本文档适用于 AutoML Video Intelligence,它与 Vertex AI 不同。如果您使用的是 Vertex AI,请参阅 Vertex AI 文档

google.cloud.automl.v1beta1 软件包

索引

AutoMl

AutoML Server API。

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

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

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

任何记录在 snake_case 或 kebab-case 中的字符串参数都是可接受的。

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)

将数据集的数据导出到提供的输出位置。完成时,它会在 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。

任何记录在 snake_case 或 kebab-case 中的字符串参数都是可接受的。

BatchPredict

rpc BatchPredict(BatchPredictRequest) returns (Operation)

执行批量预测并返回长时间运行的操作的 ID。您可以使用 GetOperation 方法请求操作结果。当操作完成后,您可以调用 GetOperation,从 response 字段检索 BatchPredictResult

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

预测

rpc Predict(PredictRequest) returns (PredictResponse)

不适用于 AutoML Video Intelligence 对象跟踪。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

StreamingPredictionService

AutoML Streaming Prediction API。

任何记录在 snake_case 或 kebab-case 中的字符串参数都是可接受的。

AnnotationPayload

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

字段
annotation_spec_id

string

仅限输出。与此注释相关的注释规范的资源 ID。注释规范来自祖先数据集或用于训练所用模型的数据集。

display_name

string

仅限输出。训练模型时 AnnotationSpec.display_name 的值。此字段在模型训练时会返回一个值,对于使用相同数据集训练的不同模型,返回值可能不同,因为模型所有者可以在任何两个模型训练之间更新 display_name。

联合字段 detail。仅限输出。有关 AutoML 解决方案特定注释的其他信息。detail 只能是下列其中一项:
classification

ClassificationAnnotation

不适用于 AutoML Video Intelligence 对象跟踪。

video_object_tracking

VideoObjectTrackingAnnotation

对象跟踪预测的注释详情。

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

仅限输出。注释规范标记的父级数据集中的样本数。

BatchPredictInputConfig

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_STARTTIME_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 位置。

BatchPredictOperationMetadata

BatchPredict 操作详情。

字段
input_config

BatchPredictInputConfig

仅限输出。启动此批量预测操作时提供的输入配置。

output_info

BatchPredictOutputInfo

仅限输出。进一步介绍此批量预测的输出的信息。

BatchPredictOutputInfo

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

[BatchPredictionOutputConfig][google.cloud.automl.v1beta1。BatchPredictionOutputConfig]。

字段
联合字段 output_location。写入预测输出的输出位置。output_location 只能是以下之一:
gcs_output_directory

string

创建的 Google Cloud Storage 目录的完整路径,其中写入了预测输出。

bigquery_output_dataset

string

bq://projectId.bqDatasetId 格式创建的 BigQuery 数据集的路径,其中写入了预测输出。

BatchPredictOutputConfig

BatchPredict 操作的输出配置。

AutoML Video Intelligence 创建 [gcsDestination][google.cloud.automl.v1beta1.BatchPredictionOutputConfig.gcs_destination] 中指定的目录。目录的名称是"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_PATHTIME_SEGMENT_STARTTIME_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.paramsclassifaction_types 参数决定。

字段
联合字段 destination。必填。输出的目的地。destination 只能是下列其中一项:
gcs_destination

GcsDestination

要写入输出的目录的 Google Cloud Storage 位置。

bigquery_destination

BigQueryDestination

要写入输出的 BigQuery 位置。

BatchPredictRequest

PredictionService.BatchPredict 的请求消息。

字段
name

string

被请求提供批量预测的模型的名称。

如要获得授权,必须具有指定资源 name 的以下 Google IAM 权限:

  • automl.models.predict

input_config

BatchPredictInputConfig

必填。批量预测的输入配置。

output_config

BatchPredictOutputConfig

必填。指定应写入输出预测结果的位置。

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

批量预测结果。

字段
metadata

map<string, string>

网域专有的附加预测响应元数据。

BigQueryDestination

不适用于 AutoML Video Intelligence 对象跟踪。

字段
output_uri

string

必填。项目的 BigQuery URI,长度不得超过 2000 个字符。接受的形式:* BigQuery 路径,例如 bq://projectId

BoundingBoxMetricsEntry

边界框匹配单个交并比阈值和多个标签匹配置信度阈值的模型指标。

字段
iou_threshold

float

仅限输出。用于计算此指标条目的交并比阈值。

mean_average_precision

float

仅限输出。平均精度,通常接近 au_prc。

confidence_metrics_entries[]

ConfidenceMetricsEntry

仅限输出。每个标签匹配的置信度阈值的指标,范围为 0.05、0.10、...、0.95、0.96、0.97、0.98、0.99。由这些指标可以得到精确率/召回率曲线。

ConfidenceMetricsEntry

单个置信度阈值的指标。

字段
confidence_threshold

float

仅限输出。用于计算指标的置信度阈值。

recall

float

仅限输出。指定置信度阈值下的召回率。

precision

float

仅限输出。指定置信度阈值下的精确率。

f1_score

float

仅限输出。召回率和精确率的调和平均数。

BoundingPoly

平面上检测到的对象的外接多边形。输出中提供了顶点和规范化顶点。按列出的顺序连接顶点便可构成多边形。

字段
normalized_vertices[]

NormalizedVertex

仅限输出。外接多边形的规范化顶点。

ClassificationAnnotation

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

字段
score

float

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

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_object_tracking_dataset_metadata

VideoObjectTrackingDatasetMetadata

用于视频对象跟踪的数据集的元数据。

DeleteDatasetRequest

AutoMl.DeleteDataset 的请求消息。

字段
name

string

要删除的数据集的资源名称。

如要获得授权,必须具有指定资源 name 的以下 Google IAM 权限:

  • automl.datasets.delete

DeleteModelRequest

AutoMl.DeleteModel 的请求消息。

字段
name

string

要删除的模型的资源名称。

如要获得授权,必须具有指定资源 name 的以下 Google IAM 权限:

  • automl.models.delete

DeleteOperationMetadata

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

DeployModelOperationMetadata

DeployModel 操作详情。

DeployModelRequest

AutoMl.DeployModel 的请求消息。

字段
name

string

要部署的模型的资源名称。

如要获得授权,必须具有指定资源 name 的以下 Google IAM 权限:

  • automl.models.deploy

ExamplePayload

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

ExportDataOperationMetadata

ExportData 操作详情。

字段
output_info

ExportDataOutputInfo

仅限输出。进一步介绍此导出数据的输出。

ExportDataOutputInfo

进一步介绍此导出数据的输出。补充 OutputConfig

字段
联合字段 output_location。写入导出数据的输出位置。output_location 只能是以下之一:
gcs_output_directory

string

创建的 Google Cloud Storage 目录的完整路径,其中写入了导入的数据。

bigquery_output_dataset

string

bq://projectId.bqDatasetId 格式创建的 BigQuery 数据集的路径,其中写入了导出的数据。

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_USEGCS_FILE_PATH,否则无法从给定的值中确切地选择这些值。

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

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

CSV 文件,每行的格式为:

ML_USE,GCS_FILE_PATH
  • ML_USE - 标识当前行(文件)适用的数据集。这个值可以是以下值之一:

    • TRAIN - 此文件中的行用于训练模型。
    • TEST - 此文件中的行用于在训练期间测试模型。
    • UNASSIGNED - 此文件中的行未分类。它们会自动划分为训练数据和测试数据。80% 用于训练,20% 用于测试。
  • GCS_FILE_PATH - 标识在 Google Cloud Storage 中存储的文件,其中包含模型训练信息。

TRAINUNASSIGNED 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_STARTTIME_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_object_tracking_dataset_metadata:* --> 数据集具有 video_object_tracking_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_object_tracking_model_metadata:* --> 模型具有 video_object_tracking_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_object_tracking_model_metadata

VideoObjectTrackingModelMetadata

视频对象跟踪模型的元数据。

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

video_object_tracking_evaluation_metrics

VideoObjectTrackingEvaluationMetrics

对象跟踪模型的评估指标。

NormalizedVertex

顶点表示图像中的 2D 点。规范化顶点坐标相对于原始平面(图像、视频)在 0 到 1 之间。例如,如果平面(例如,整个图像)的尺寸为 10 x 20,则采用规范化坐标 (0.1, 0.3) 的点在该平面上的位置为 (1, 6)。

字段
x

float

必填。水平坐标。

y

float

必填。垂直坐标。

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 操作详情。

deploy_model_details

DeployModelOperationMetadata

DeployModel 操作详情。

undeploy_model_details

UndeployModelOperationMetadata

UndeployModel 操作详情。

create_model_details

CreateModelOperationMetadata

CreateModel 操作详情。

import_data_details

ImportDataOperationMetadata

ImportData 操作详情。

batch_predict_details

BatchPredictOperationMetadata

BatchPredict 操作详情。

export_data_details

ExportDataOperationMetadata

ExportData 操作详情。

OutputConfig

ExportData 的输出配置。

对于目的地,除非另有说明,否则必须为网域设置 gcs_destination。仅导出作为评估依据的注释(未导出未获批准的注释)。

输出与数据的导入方式相对应,并可用作导入数据的输入。输出格式以使用字面量逗号的 EBNF 表示,相同的非终端符号定义是导入数据的 InputConfig

这是一个 CSV 文件 video_object_tracking.csv,每行采用以下格式,并且每个 ML_USE 可能具有多个行:

ML_USE,GCS_FILE_PATH

每个 GCS_FILE_PATH 都会指向另一个 .csv 文件,该文件采用以下行格式描述具有给定 ML_USE 的样本:

GCS_FILE_PATH,LABEL,INSTANCE_ID,TIMESTAMP,BOUNDING_BOX

此处 GCS_FILE_PATH 列中的数据指向导入视频的原始来源位置。

字段
联合字段 destination。必填。输出的目的地。destination 只能是下列其中一项:
gcs_destination

GcsDestination

必须写入输出的 Google Cloud Storage 位置。对于视频对象跟踪,在给定目录中创建一个如下所示的新目录,其中时间戳采用 YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 格式:


export_data-<dataset-display-name>-<timestamp-of-export-call>

所有导出输出都将写入该目录。

bigquery_destination

BigQueryDestination

要写入输出的 BigQuery 位置。

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>

网域专有的附加预测响应元数据。

UndeployModelOperationMetadata

UndeployModel 操作详情。

UndeployModelRequest

AutoMl.UndeployModel 的请求消息。

字段
name

string

要取消部署的模型的资源名称。

如要获得授权,必须具有指定资源 name 的以下 Google IAM 权限:

  • automl.models.undeploy

VideoObjectTrackingAnnotation

视频对象跟踪的注释详情。

字段
instance_id

string

选填。对象的实例,表示为正整数。在单个示例中存在多个对象时,用于分离同类对象(即 AnnotationSpec)。注意:实例 ID 预测质量不属于模型评估,应尽力执行。特别是在实体离开屏幕较长时间(数分钟)的情况下,当它返回时,可能被赋予一个新的实例 ID。

time_offset

Duration

必填。该注释所属的视频的时间(帧)。表示为视频播放的时长。

bounding_box

BoundingPoly

必填。矩形表示对象在帧上的位置(即在视频的 timeOffset 处)。

score

float

仅限输出。视频在 time_offset 处的注释为正样本时的置信度,值范围为 [0,1],该值越高意味着正置信度越高。对于用户创建的注释,分数为 1。当用户批准注释时,保留其原始浮点分数(并且不会更改为 1)。

VideoObjectTrackingDatasetMetadata

视频对象跟踪的专用数据集元数据。

VideoObjectTrackingEvaluationMetrics

视频对象跟踪问题的模型评估指标。评估标记的边界框和标记的轨道(即共享相同标签和实例 ID 的一系列边界框)的预测质量。

字段
evaluated_frame_count

int32

仅限输出。用于创建此评估的视频帧数。

evaluated_bounding_box_count

int32

仅限输出。用于创建此评估的原标记已有的边界框总数(即对所有帧求和)。

evaluated_track_count

int32

仅限输出。用于创建此评估的原标记已有的轨道总数(即在所有帧中看到的)。

bounding_box_metrics_entries[]

BoundingBoxMetricsEntry

仅限输出。边界框匹配每个交并比阈值 0.05、0.10、...、0.95、0.96、0.97、0.98、0.99 以及每个标签置信度阈值 0.05、0.10、...、0.95、0.96、0.97、0.98、0.99 对的指标。

bounding_box_mean_average_precision

float

仅限输出。边界框评估的单一指标:所有 boundingBoxMetricsEntries 的平均值 meanAveragePrecision。

VideoObjectTrackingModelMetadata

针对视频对象跟踪的模型元数据。