你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

CustomVisionTrainingClient 类

继承
azure.cognitiveservices.vision.customvision.training.operations._custom_vision_training_client_operations.CustomVisionTrainingClientOperationsMixin
CustomVisionTrainingClient
CustomVisionTrainingClient

构造函数

CustomVisionTrainingClient(endpoint, credentials)

参数

endpoint
str
必需

支持的认知服务终结点。

credentials
None
必需

唯一标识客户端订阅的订阅凭据。

变量

config
CustomVisionTrainingClientConfiguration

客户端的配置。

方法

close

如果keep_alive为 True,请关闭客户端。

create_image_regions

创建一组映像区域。

此 API 接受一批图像区域和(可选)标记,以使用区域信息更新现有图像。 批处理中有 64 个条目的限制。 如果成功创建所有区域,则将返回 200 (正常) 状态代码。 否则,将返回 207 (多状态) 状态代码,并在响应有效负载中列出每个区域的详细信息状态。

create_image_tags

将一组图像与一组标记相关联。

create_images_from_data

将提供的图像添加到训练图像集。

此 API 接受 multipart/form-data 和 application/octet-stream 形式的正文内容。 使用多部分图像文件时,可以一次发送多个图像文件,最多包含 64 个文件。 如果成功创建所有映像,则将返回 200 (正常) 状态代码。 否则,将返回 207 (多状态) 状态代码,并在响应有效负载中列出每个图像的详细信息状态。

create_images_from_files

将提供的一批图像添加到训练图像集。

此 API 接受使用文件批(有时还接受使用标记)来创建图像。 限制为 64 个图像和 20 个标记。 如果成功创建所有映像,则将返回 200 (正常) 状态代码。 否则,将返回 207 (多状态) 状态代码,并在响应有效负载中列出每个图像的详细信息状态。

create_images_from_predictions

将指定的预测图像添加到训练图像集。

此 API 基于指定的预测图像创建一批图像。 限制为 64 个图像和 20 个标记。 如果成功创建所有映像,则将返回 200 (正常) 状态代码。 否则,将返回 207 (多状态) 状态代码,并在响应有效负载中列出每个图像的详细信息状态。

create_images_from_urls

将提供的图像 URL 添加到训练图像集。

此 API 接受使用 URL 批(有时还接受使用标记)来创建图像。 限制为 64 个图像和 20 个标记。 如果成功创建所有映像,则将返回 200 (正常) 状态代码。 否则,将返回 207 (多状态) 状态代码,并在响应有效负载中列出每个图像的详细信息状态。

create_project

创建项目。

create_tag

为项目创建标记。

delete_image_regions

删除一组图像区域。

delete_image_tags

从一组图像中删除一组标记。

delete_images

从训练图像集中删除图像。

delete_iteration

删除项目的特定迭代。

delete_prediction

删除一组预测图像及其关联的预测结果。

delete_project

删除特定的项目。

delete_tag

删除项目的标记。

export_iteration

导出训练的迭代。

export_project

导出项目。

get_artifact

基于 blob 中的项目相对路径,从 blob 存储获取项目内容。

get_domain

获取有关特定域的信息。

get_domains

获取可用域的列表。

get_exports

获取特定迭代的导出列表。

get_image_count

获取图像数。

筛选依据为某个字词和/或关系。 例如,如果提供的标记 ID 用于“Dog”和“Cat”标记,则仅返回标记有 Dog 和/或 Cat 的图像。

get_image_performance_count

获取使用提供的 {tagIds} 标记的图像数,这些图像具有针对提供的迭代 {iterationId} 的训练的预测结果。

筛选依据为某个字词和/或关系。 例如,如果提供的标记 ID 用于“Dog”和“Cat”标记,则仅返回标记有 Dog 和/或 Cat 的图像。

get_image_performances

获取图像及其对给定项目迭代的预测。

此 API 支持批处理和范围选择。 默认情况下,它只返回与图像匹配的前 50 个图像。 使用 {take} 和 {skip} 参数控制要在给定批中返回的图像数。 筛选依据为某个字词和/或关系。 例如,如果提供的标记 ID 用于“Dog”和“Cat”标记,则仅返回标记有 Dog 和/或 Cat 的图像。

get_image_region_proposals

获取映像的区域建议。 如果未找到建议,则返回空数组。

此 API 获取图像的区域建议以及区域的置信度。 如果未找到建议,则返回空数组。

get_images

获取给定项目迭代或工作区的图像。

此 API 支持批处理和范围选择。 默认情况下,它只返回与图像匹配的前 50 个图像。 使用 {take} 和 {skip} 参数控制要在给定批中返回的图像数。 筛选依据为某个字词和/或关系。 例如,如果提供的标记 ID 用于“Dog”和“Cat”标记,则仅返回标记有 Dog 和/或 Cat 的图像。

get_images_by_ids

按 ID 获取给定项目迭代的图像。

此 API 返回指定标记和(可选)迭代的一组图像。 如果未指定迭代,则使用当前工作区。

get_iteration

获取特定的迭代。

get_iteration_performance

获取有关迭代的详细性能信息。

get_iterations

获取项目的迭代。

get_project

获取特定的项目。

get_projects

获取项目。

get_tag

获取有关特定标记的信息。

get_tagged_image_count

获取使用提供的 {tagIds} 标记的图像数。

筛选依据为某个字词和/或关系。 例如,如果提供的标记 ID 为“Dog”和“Cat”标记,则仅返回标记有 Dog 和/或 Cat 的图像。

get_tagged_images

获取给定项目迭代的标记图像。

此 API 支持批处理和范围选择。 默认情况下,它只返回与图像匹配的前 50 个图像。 使用 {take} 和 {skip} 参数控制在给定批中返回的图像数。 筛选依据为某个字词和/或关系。 例如,如果提供的标记 ID 为“Dog”和“Cat”标记,则仅返回标记有 Dog 和/或 Cat 的图像。

get_tags

获取给定项目和迭代的标记。

get_untagged_image_count

获取未标记图像的数量。

此 API 返回没有给定项目的标记和(可选)迭代的图像。 如果未指定迭代,则使用当前工作区。

get_untagged_images

获取给定项目迭代的无标记图像。

此 API 支持批处理和范围选择。 默认情况下,它只返回与图像匹配的前 50 个图像。 使用 {take} 和 {skip} 参数控制要在给定批中返回的图像数。

import_project

导入项目。

publish_iteration

发布特定的迭代。

query_predictions

获取已发送到预测终结点的图像。

query_suggested_image_count

获取其建议标记与给定标记匹配且其概率大于或等于给定阈值的图像计数。 如果未找到任何值,则返回计数为 0。

此 API 使用 tagId 获取按给定阈值的建议标记提供的未标记图像计数。

query_suggested_images

获取其建议标记与给定标记匹配的无标记图像。 如果未找到图像,则返回空数组。

此 API 提取按建议的标记 ID 筛选的未标记图像。 如果未找到图像,则返回空数组。

quick_test_image

快速测试图像。

quick_test_image_url

快速测试图像 URL。

suggest_tags_and_regions

建议一组/一批未标记图像的标记和区域。 如果未找到标记,则返回空数组。

此 API 获取未标记图像数组/批的建议标记和区域,以及标记的置信度。 如果未找到标记,则返回空数组。 批处理中有 64 个图像的限制。

train_project

将要训练的项目排队。

unpublish_iteration

取消发布特定的迭代。

update_image_metadata

更新图像的元数据。

此 API 接受一批映像 ID 和元数据,以更新映像。 图像限制为 64 个。

update_iteration

更新特定的迭代。

update_project

更新特定的项目。

update_tag

更新标记。

close

如果keep_alive为 True,请关闭客户端。

close() -> None

create_image_regions

创建一组映像区域。

此 API 接受一批图像区域和(可选)标记,以使用区域信息更新现有图像。 批处理中有 64 个条目的限制。 如果成功创建所有区域,则将返回 200 (正常) 状态代码。 否则,将返回 207 (多状态) 状态代码,并在响应有效负载中列出每个区域的详细信息状态。

create_image_regions(project_id, regions=None, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

regions
list[ImageRegionCreateEntry]
默认值: None
custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

ImageRegionCreateSummary 或 ClientRawResponse(如果 raw=true)

返回类型

例外

create_image_tags

将一组图像与一组标记相关联。

create_image_tags(project_id, tags=None, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

tags
list[ImageTagCreateEntry]
默认值: None

要在此批处理中包含的图像标记条目。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

ImageTagCreateSummary 或 ClientRawResponse(如果 raw=true)

返回类型

例外

create_images_from_data

将提供的图像添加到训练图像集。

此 API 接受 multipart/form-data 和 application/octet-stream 形式的正文内容。 使用多部分图像文件时,可以一次发送多个图像文件,最多包含 64 个文件。 如果成功创建所有映像,则将返回 200 (正常) 状态代码。 否则,将返回 207 (多状态) 状态代码,并在响应有效负载中列出每个图像的详细信息状态。

create_images_from_data(project_id, image_data, tag_ids=None, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

image_data
Generator
必需

二进制图像数据。 支持的格式包括 JPEG、GIF、PNG 和 BMP。 支持最大 6MB 的映像。

tag_ids
list[str]
默认值: None

用于标记每个图像的标记 ID。 限制为 20。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

ImageCreateSummary 或 ClientRawResponse(如果 raw=true)

返回类型

例外

create_images_from_files

将提供的一批图像添加到训练图像集。

此 API 接受使用文件批(有时还接受使用标记)来创建图像。 限制为 64 个图像和 20 个标记。 如果成功创建所有映像,则将返回 200 (正常) 状态代码。 否则,将返回 207 (多状态) 状态代码,并在响应有效负载中列出每个图像的详细信息状态。

create_images_from_files(project_id, batch, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

batch
ImageFileCreateBatch
必需

要添加的一批图像文件。 每批限制为 64 个图像和 20 个标记。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

ImageCreateSummary 或 ClientRawResponse(如果 raw=true)

返回类型

例外

create_images_from_predictions

将指定的预测图像添加到训练图像集。

此 API 基于指定的预测图像创建一批图像。 限制为 64 个图像和 20 个标记。 如果成功创建所有映像,则将返回 200 (正常) 状态代码。 否则,将返回 207 (多状态) 状态代码,并在响应有效负载中列出每个图像的详细信息状态。

create_images_from_predictions(project_id, batch, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

batch
ImageIdCreateBatch
必需

图像、标记 ID 和元数据。 每批限制为 64 个图像和 20 个标记。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

ImageCreateSummary 或 ClientRawResponse(如果 raw=true)

返回类型

例外

create_images_from_urls

将提供的图像 URL 添加到训练图像集。

此 API 接受使用 URL 批(有时还接受使用标记)来创建图像。 限制为 64 个图像和 20 个标记。 如果成功创建所有映像,则将返回 200 (正常) 状态代码。 否则,将返回 207 (多状态) 状态代码,并在响应有效负载中列出每个图像的详细信息状态。

create_images_from_urls(project_id, batch, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

batch
ImageUrlCreateBatch
必需

图像 URL、标记 ID 和元数据。 每批限制为 64 个图像和 20 个标记。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

ImageCreateSummary 或 ClientRawResponse(如果 raw=true)

返回类型

例外

create_project

创建项目。

create_project(name, description=None, domain_id=None, classification_type=None, target_export_platforms=None, export_model_container_uri=None, notification_queue_uri=None, custom_headers=None, raw=False, **operation_config)

参数

name
str
必需

项目名称。

description
str
默认值: None

项目的说明。

domain_id
str
默认值: None

要用于此项目的域的 ID。 默认为“常规”。

classification_type
str
默认值: None

要为此项目创建的分类器的类型。 可能的值包括:“Multiclass”、“Multilabel”

target_export_platforms
list[str]
默认值: None

训练模型打算导出到的平台列表。

export_model_container_uri
str
默认值: None

用于存储导出模型的 Azure 存储容器的 URI。

notification_queue_uri
str
默认值: None

用于发送与项目相关的通知的 Azure 存储队列的 URI。 有关设置和消息格式 ,请参阅存储通知 文档。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则 Project 或 ClientRawResponse

返回类型

例外

create_tag

为项目创建标记。

create_tag(project_id, name, description=None, type=None, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

name
str
必需

标记名称。

description
str
默认值: None

标记的可选说明。

type
str
默认值: None

标记的可选类型。 可能的值包括:“Regular”、“Negative”、“GeneralProduct”

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则 Tag 或 ClientRawResponse

返回类型

Tag,

例外

delete_image_regions

删除一组图像区域。

delete_image_regions(project_id, region_ids, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

region_ids
list[str]
必需

要删除的区域。 限制为 64。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

None 或 ClientRawResponse(如果 raw=true)

返回类型

None,

例外

delete_image_tags

从一组图像中删除一组标记。

delete_image_tags(project_id, image_ids, tag_ids, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

image_ids
list[str]
必需

图像 ID。 限制为 64 个图像。

tag_ids
list[str]
必需

要从指定映像中删除的标记。 限制为 20 个标记。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

None 或 ClientRawResponse(如果 raw=true)

返回类型

None,

例外

delete_images

从训练图像集中删除图像。

delete_images(project_id, image_ids=None, all_images=None, all_iterations=None, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

image_ids
list[str]
默认值: None

要删除的图像的 ID。 每批限制为 256 个图像。

all_images
bool
默认值: None

用于指定删除所有映像的标志,指定此标志或图像列表。 使用此标志将返回 202 响应,指示正在删除图像。

all_iterations
bool
默认值: None

从所有迭代中删除这些映像,而不仅仅是当前工作区。 使用此标志将返回 202 响应,指示正在删除图像。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

None 或 ClientRawResponse(如果 raw=true)

返回类型

None,

例外

delete_iteration

删除项目的特定迭代。

delete_iteration(project_id, iteration_id, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

iteration_id
str
必需

迭代 ID。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

None 或 ClientRawResponse(如果 raw=true)

返回类型

None,

例外

delete_prediction

删除一组预测图像及其关联的预测结果。

delete_prediction(project_id, ids, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

ids
list[str]
必需

预测 ID。 限制为 64。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

None 或 ClientRawResponse(如果 raw=true)

返回类型

None,

例外

delete_project

删除特定的项目。

delete_project(project_id, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

None 或 ClientRawResponse(如果 raw=true)

返回类型

None,

例外

delete_tag

删除项目的标记。

delete_tag(project_id, tag_id, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

tag_id
str
必需

要删除的标记的 ID。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

None 或 ClientRawResponse(如果 raw=true)

返回类型

None,

例外

export_iteration

导出训练的迭代。

export_iteration(project_id, iteration_id, platform, flavor=None, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

iteration_id
str
必需

迭代 ID。

platform
str
必需

目标平台。 可能的值包括:“CoreML”、“TensorFlow”、“DockerFile”、“ONNX”、“VAIDK”、“OpenVino”

flavor
str
默认值: None

目标平台的风格。 可能的值包括:“Linux”、“Windows”、“ONNX10”、“ONNX12”、“ARM”、“TensorFlowNormal”、“TensorFlowLite”

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

Export 或 ClientRawResponse(如果 raw=true)

返回类型

例外

export_project

导出项目。

export_project(project_id, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

要导出的项目的项目 ID。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

ProjectExport 或 ClientRawResponse(如果 raw=true)

返回类型

例外

get_artifact

基于 blob 中的项目相对路径,从 blob 存储获取项目内容。

get_artifact(project_id, path, custom_headers=None, raw=False, callback=None, **operation_config)

参数

project_id
str
必需

项目 ID。

path
str
必需

项目的相对路径。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

callback
Callable[<xref:Bytes>, <xref:response=None>]
默认值: None

指定后,将使用流式传输的每个数据块调用 。 回调应采用两个参数:当前数据区块的字节数和响应对象。 如果正在上传数据,响应将为“无”。

operation_config
必需

操作配置替代

返回

object 或 ClientRawResponse(如果 raw=true)

返回类型

例外

get_domain

获取有关特定域的信息。

get_domain(domain_id, custom_headers=None, raw=False, **operation_config)

参数

domain_id
str
必需

要获取其相关信息的域的 ID。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则为 Domain 或 ClientRawResponse

返回类型

例外

get_domains

获取可用域的列表。

get_domains(custom_headers=None, raw=False, **operation_config)

参数

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

list 或 ClientRawResponse(如果 raw=true)

返回类型

例外

get_exports

获取特定迭代的导出列表。

get_exports(project_id, iteration_id, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

iteration_id
str
必需

迭代 ID。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

list 或 ClientRawResponse(如果 raw=true)

返回类型

例外

get_image_count

获取图像数。

筛选依据为某个字词和/或关系。 例如,如果提供的标记 ID 用于“Dog”和“Cat”标记,则仅返回标记有 Dog 和/或 Cat 的图像。

get_image_count(project_id, iteration_id=None, tagging_status=None, filter=None, tag_ids=None, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

iteration_id
str
默认值: None

迭代 ID。默认为工作区。

tagging_status
str
默认值: None

标记状态筛选器。 它可以是“All”、“Tagged”或“Untagged”。 默认为“All”。 可能的值包括:“All”、“Tagged”、“Untagged”

filter
str
默认值: None

一个表达式,用于根据图像元数据筛选图像。 只有表达式计算结果为 true 的图像才会包含在响应中。 表达式支持 eq (Equal) 、ne (Not equal) 、 (Logical 和) ,或者 (Logical 或) 运算符。 下面是一个示例,metadata=key1 eq 'value1' and key2 ne 'value2'。

tag_ids
list[str]
默认值: None

用于筛选要计数的图像的标记 ID 的列表。 默认值为 null 时的所有标记。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

int 或 ClientRawResponse(如果 raw=true)

返回类型

int,

例外

get_image_performance_count

获取使用提供的 {tagIds} 标记的图像数,这些图像具有针对提供的迭代 {iterationId} 的训练的预测结果。

筛选依据为某个字词和/或关系。 例如,如果提供的标记 ID 用于“Dog”和“Cat”标记,则仅返回标记有 Dog 和/或 Cat 的图像。

get_image_performance_count(project_id, iteration_id, tag_ids=None, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

iteration_id
str
必需

迭代 ID。默认为工作区。

tag_ids
list[str]
默认值: None

用于筛选要计数的图像的标记 ID 的列表。 默认值为 null 时的所有标记。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

int 或 ClientRawResponse(如果 raw=true)

返回类型

int,

例外

get_image_performances

获取图像及其对给定项目迭代的预测。

此 API 支持批处理和范围选择。 默认情况下,它只返回与图像匹配的前 50 个图像。 使用 {take} 和 {skip} 参数控制要在给定批中返回的图像数。 筛选依据为某个字词和/或关系。 例如,如果提供的标记 ID 用于“Dog”和“Cat”标记,则仅返回标记有 Dog 和/或 Cat 的图像。

get_image_performances(project_id, iteration_id, tag_ids=None, order_by=None, take=50, skip=0, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

iteration_id
str
必需

迭代 ID。默认为工作区。

tag_ids
list[str]
默认值: None

用于筛选图像的标记 ID 的列表。 当为 null 时,默认为所有标记的图像。 限制为 20。

order_by
str
默认值: None

排序。 默认为最新。 可能的值包括:“Newest”、“Oldest”

take
int
默认值: 50

要返回的最大图像数。 默认值为 50,限制为 256。

skip
int
默认值: 0

开始映像批处理之前要跳过的图像数。 默认值为 0。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

list 或 ClientRawResponse(如果 raw=true)

返回类型

例外

get_image_region_proposals

获取映像的区域建议。 如果未找到建议,则返回空数组。

此 API 获取图像的区域建议以及区域的置信度。 如果未找到建议,则返回空数组。

get_image_region_proposals(project_id, image_id, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

image_id
str
必需

映像 ID。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

ImageRegionProposal 或 ClientRawResponse(如果 raw=true)

返回类型

例外

get_images

获取给定项目迭代或工作区的图像。

此 API 支持批处理和范围选择。 默认情况下,它只返回与图像匹配的前 50 个图像。 使用 {take} 和 {skip} 参数控制要在给定批中返回的图像数。 筛选依据为某个字词和/或关系。 例如,如果提供的标记 ID 用于“Dog”和“Cat”标记,则仅返回标记有 Dog 和/或 Cat 的图像。

get_images(project_id, iteration_id=None, tag_ids=None, tagging_status=None, filter=None, order_by=None, take=50, skip=0, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

iteration_id
str
默认值: None

迭代 ID。默认为工作区。

tag_ids
list[str]
默认值: None

用于筛选图像的标记 ID 的列表。 当为 null 时,默认为所有标记的图像。 限制为 20。

tagging_status
str
默认值: None

标记状态筛选器。 它可以是“All”、“Tagged”或“Untagged”。 默认为“All”。 可能的值包括:“All”、“Tagged”、“Untagged”

filter
str
默认值: None

一个表达式,用于根据图像元数据筛选图像。 只有表达式计算结果为 true 的图像才会包含在响应中。 表达式支持 eq (Equal) 、ne (Not equal) 、 (Logical 和) ,或者 (Logical 或) 运算符。 下面是一个示例,metadata=key1 eq 'value1' and key2 ne 'value2'。

order_by
str
默认值: None

排序。 默认为最新。 可能的值包括:“Newest”、“Oldest”

take
int
默认值: 50

要返回的最大图像数。 默认值为 50,限制为 256。

skip
int
默认值: 0

开始映像批处理之前要跳过的图像数。 默认值为 0。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

list 或 ClientRawResponse(如果 raw=true)

返回类型

例外

get_images_by_ids

按 ID 获取给定项目迭代的图像。

此 API 返回指定标记和(可选)迭代的一组图像。 如果未指定迭代,则使用当前工作区。

get_images_by_ids(project_id, image_ids=None, iteration_id=None, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

image_ids
list[str]
默认值: None

要检索的图像 ID 的列表。 限制为 256。

iteration_id
str
默认值: None

迭代 ID。默认为工作区。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则 list 或 ClientRawResponse

返回类型

例外

get_iteration

获取特定的迭代。

get_iteration(project_id, iteration_id, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

迭代所属项目的 ID。

iteration_id
str
必需

要获取的迭代的 ID。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则迭代或 ClientRawResponse

返回类型

例外

get_iteration_performance

获取有关迭代的详细性能信息。

get_iteration_performance(project_id, iteration_id, threshold=None, overlap_threshold=None, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

迭代所属项目的 ID。

iteration_id
str
必需

要获取的迭代的 ID。

threshold
float
默认值: None

用于确定真实预测的阈值。

overlap_threshold
float
默认值: None

如果适用,边界框与用于确定真实预测的阈值重叠。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则 IterationPerformance 或 ClientRawResponse

返回类型

例外

get_iterations

获取项目的迭代。

get_iterations(project_id, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则 list 或 ClientRawResponse

返回类型

例外

get_project

获取特定的项目。

get_project(project_id, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

要获取的项目的 ID。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则 Project 或 ClientRawResponse

返回类型

例外

get_projects

获取项目。

get_projects(custom_headers=None, raw=False, **operation_config)

参数

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则 list 或 ClientRawResponse

返回类型

例外

get_tag

获取有关特定标记的信息。

get_tag(project_id, tag_id, iteration_id=None, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

此标记所属的项目。

tag_id
str
必需

标记 ID。

iteration_id
str
默认值: None

要从中检索此标记的迭代。 可选,默认为当前训练集。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则 Tag 或 ClientRawResponse

返回类型

Tag,

例外

get_tagged_image_count

获取使用提供的 {tagIds} 标记的图像数。

筛选依据为某个字词和/或关系。 例如,如果提供的标记 ID 为“Dog”和“Cat”标记,则仅返回标记有 Dog 和/或 Cat 的图像。

get_tagged_image_count(project_id, iteration_id=None, tag_ids=None, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

iteration_id
str
默认值: None

迭代 ID。默认为工作区。

tag_ids
list[str]
默认值: None

用于筛选要计数的图像的标记 ID 列表。 默认值为 null 时的所有标记。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

int 或 ClientRawResponse(如果 raw=true)

返回类型

int,

例外

get_tagged_images

获取给定项目迭代的标记图像。

此 API 支持批处理和范围选择。 默认情况下,它只返回与图像匹配的前 50 个图像。 使用 {take} 和 {skip} 参数控制在给定批中返回的图像数。 筛选依据为某个字词和/或关系。 例如,如果提供的标记 ID 为“Dog”和“Cat”标记,则仅返回标记有 Dog 和/或 Cat 的图像。

get_tagged_images(project_id, iteration_id=None, tag_ids=None, order_by=None, take=50, skip=0, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

iteration_id
str
默认值: None

迭代 ID。默认为工作区。

tag_ids
list[str]
默认值: None

用于筛选图像的标记 ID 列表。 当为 null 时,默认为所有标记的图像。 限制为 20。

order_by
str
默认值: None

排序。 默认为最新。 可能的值包括:“Newest”、“Oldest”

take
int
默认值: 50

要返回的最大图像数。 默认值为 50,限制为 256。

skip
int
默认值: 0

在开始映像批处理之前要跳过的图像数。 默认值为 0。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则 list 或 ClientRawResponse

返回类型

例外

get_tags

获取给定项目和迭代的标记。

get_tags(project_id, iteration_id=None, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

iteration_id
str
默认值: None

迭代 ID。默认为工作区。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则 list 或 ClientRawResponse

返回类型

list[Tag],

例外

get_untagged_image_count

获取未标记图像的数量。

此 API 返回没有给定项目的标记和(可选)迭代的图像。 如果未指定迭代,则使用当前工作区。

get_untagged_image_count(project_id, iteration_id=None, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

iteration_id
str
默认值: None

迭代 ID。默认为工作区。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

int 或 ClientRawResponse(如果 raw=true)

返回类型

int,

例外

get_untagged_images

获取给定项目迭代的无标记图像。

此 API 支持批处理和范围选择。 默认情况下,它只返回与图像匹配的前 50 个图像。 使用 {take} 和 {skip} 参数控制要在给定批中返回的图像数。

get_untagged_images(project_id, iteration_id=None, order_by=None, take=50, skip=0, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

iteration_id
str
默认值: None

迭代 ID。默认为工作区。

order_by
str
默认值: None

排序。 默认为最新。 可能的值包括:“Newest”、“Oldest”

take
int
默认值: 50

要返回的最大图像数。 默认值为 50,限制为 256。

skip
int
默认值: 0

开始映像批处理之前要跳过的图像数。 默认值为 0。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

list 或 ClientRawResponse(如果 raw=true)

返回类型

例外

import_project

导入项目。

import_project(token, name=None, custom_headers=None, raw=False, **operation_config)

参数

token
str
必需

从导出项目调用生成的令牌。

name
str
默认值: None

可选,是要使用的项目的名称,而不是自动生成的名称。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

Project 或 ClientRawResponse(如果 raw=true)

返回类型

例外

publish_iteration

发布特定的迭代。

publish_iteration(project_id, iteration_id, publish_name, prediction_id, overwrite=None, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

iteration_id
str
必需

迭代 ID。

publish_name
str
必需

要指定已发布迭代的名称。

prediction_id
str
必需

要发布到的预测资源的 ID。

overwrite
bool
默认值: None

是否使用给定名称覆盖已发布的模型 (默认值:false) 。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

bool 或 ClientRawResponse(如果 raw=true)

返回类型

bool,

例外

query_predictions

获取已发送到预测终结点的图像。

query_predictions(project_id, query, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

query
PredictionQueryToken
必需

用于查询预测的参数。 限制为组合 2 个标记。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

PredictionQueryResult 或 ClientRawResponse(如果 raw=true)

返回类型

例外

query_suggested_image_count

获取其建议标记与给定标记匹配且其概率大于或等于给定阈值的图像计数。 如果未找到任何值,则返回计数为 0。

此 API 使用 tagId 获取按给定阈值的建议标记提供的未标记图像计数。

query_suggested_image_count(project_id, iteration_id, tag_ids=None, threshold=None, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

iteration_id
str
必需

用于建议标记和区域的 IterationId。

tag_ids
list[str]
默认值: None

项目中要获取其建议标记计数的现有 TagId。

threshold
float
默认值: None

要筛选建议标记的置信度阈值。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

dict 或 ClientRawResponse(如果 raw=true)

返回类型

dict[str, int],

例外

query_suggested_images

获取其建议标记与给定标记匹配的无标记图像。 如果未找到图像,则返回空数组。

此 API 提取按建议的标记 ID 筛选的未标记图像。 如果未找到图像,则返回空数组。

query_suggested_images(project_id, iteration_id, query, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

iteration_id
str
必需

用于建议标记和区域的 IterationId。

query
SuggestedTagAndRegionQueryToken
必需

包含查询建议的图像所需的属性。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

SuggestedTagAndRegionQuery 或 ClientRawResponse(如果 raw=true)

返回类型

例外

quick_test_image

快速测试图像。

quick_test_image(project_id, image_data, iteration_id=None, store=True, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

image_data
Generator
必需

二进制图像数据。 支持的格式为 JPEG、GIF、PNG 和 BMP。 支持最大 6MB 的映像。

iteration_id
str
默认值: None

可选。 指定要计算的特定迭代的 ID。 如果未指定,将使用项目的默认迭代。

store
bool
默认值: True

可选。 指定是否存储此预测的结果。 要存储的默认值为 true。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

ImagePrediction 或 ClientRawResponse(如果 raw=true)

返回类型

例外

quick_test_image_url

快速测试图像 URL。

quick_test_image_url(project_id, url, iteration_id=None, store=True, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

要评估的项目。

url
str
必需

图像的 URL。

iteration_id
str
默认值: None

可选。 指定要计算的特定迭代的 ID。 如果未指定,将使用项目的默认迭代。

store
bool
默认值: True

可选。 指定是否存储此预测的结果。 要存储的默认值为 true。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

ImagePrediction 或 ClientRawResponse(如果 raw=true)

返回类型

例外

suggest_tags_and_regions

建议一组/一批未标记图像的标记和区域。 如果未找到标记,则返回空数组。

此 API 获取未标记图像数组/批的建议标记和区域,以及标记的置信度。 如果未找到标记,则返回空数组。 批处理中有 64 个图像的限制。

suggest_tags_and_regions(project_id, iteration_id, image_ids, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

iteration_id
str
必需

用于标记和区域建议的 IterationId。

image_ids
list[str]
必需

需要使用图像 ID 标记建议的数组。 使用 GetUntaggedImages API 获取 imageIds。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

list 或 ClientRawResponse(如果 raw=true)

返回类型

例外

train_project

将要训练的项目排队。

train_project(project_id, training_type=None, reserved_budget_in_hours=0, force_train=False, notification_email_address=None, selected_tags=None, custom_base_model_info=None, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

training_type
str
默认值: None

用于训练项目的训练类型默认 (:常规) 。 可能的值包括:“Regular”、“Advanced”

reserved_budget_in_hours
int
默认值: 0

预留为培训预算的小时数 ((如果适用)) 。

force_train
bool
默认值: False

即使数据集和配置未更改,是否强制训练 (默认值:false) 。

notification_email_address
str
默认值: None

训练完成时要向其发送通知的电子邮件地址 (默认值:null) 。

selected_tags
list[str]
默认值: None

为此训练会话选择的标记列表,项目中的其他标记将被忽略。

custom_base_model_info
CustomBaseModelInfo
默认值: None

以前训练的迭代的信息,该迭代为当前迭代的训练提供基础模型。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则迭代或 ClientRawResponse

返回类型

例外

unpublish_iteration

取消发布特定的迭代。

unpublish_iteration(project_id, iteration_id, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

iteration_id
str
必需

迭代 ID。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则为 None 或 ClientRawResponse

返回类型

None,

例外

update_image_metadata

更新图像的元数据。

此 API 接受一批映像 ID 和元数据,以更新映像。 图像限制为 64 个。

update_image_metadata(project_id, image_ids, metadata, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

image_ids
list[str]
必需

要更新的图像 ID 列表。 限制为 64。

metadata
dict[str, str]
必需

要更新到指定图像的元数据。 每个图像限制为 10 个键值对。 密钥的长度限制为 128。 值的长度限制为 256。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

ImageMetadataUpdateSummary 或 ClientRawResponse(如果 raw=true)

返回类型

例外

update_iteration

更新特定的迭代。

update_iteration(project_id, iteration_id, name, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

iteration_id
str
必需

迭代 ID。

name
str
必需

获取或设置迭代的名称。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则迭代或 ClientRawResponse

返回类型

例外

update_project

更新特定的项目。

update_project(project_id, updated_project, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

要更新的项目的 ID。

updated_project
Project
必需

更新的项目模型。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则 Project 或 ClientRawResponse

返回类型

例外

update_tag

更新标记。

update_tag(project_id, tag_id, updated_tag, custom_headers=None, raw=False, **operation_config)

参数

project_id
str
必需

项目 ID。

tag_id
str
必需

目标标记的 ID。

updated_tag
Tag
必需

更新的标记模型。

custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代

返回

如果 raw=true,则 Tag 或 ClientRawResponse

返回类型

Tag,

例外