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 (OK) 狀態碼。 否則,將會傳回 207 (多重狀態) 狀態碼,而且每個區域的詳細狀態都會列在回應承載中。

create_image_tags

建立一組影像與一組標記的關聯。

create_images_from_data

將提供的影像新增至定型影像集。

此 API 接受主體內容做為 multipart/form-data 和 application/octet-stream。 一次使用多部分多個影像檔時,最多可以傳送 64 個檔案。 如果成功建立所有映射,則會傳回 200 (OK) 狀態碼。 否則,將會傳回 207 (多重狀態) 狀態碼,而且每個影像的詳細狀態都會列在回應承載中。

create_images_from_files

將提供的影像批次新增至定型影像集。

此 API 會接受一批檔案,並選擇性地標記來建立映射。 其限制為 64 個影像和 20 個標記。 如果成功建立所有映射,則會傳回 200 (OK) 狀態碼。 否則,將會傳回 207 (多重狀態) 狀態碼,而且每個影像的詳細狀態都會列在回應承載中。

create_images_from_predictions

將指定的預測影像新增至定型影像集。

此 API 會從指定的預測影像建立一批影像。 其限制為 64 個影像和 20 個標記。 如果成功建立所有映射,則會傳回 200 (OK) 狀態碼。 否則,將會傳回 207 (多重狀態) 狀態碼,而且每個影像的詳細狀態都會列在回應承載中。

create_images_from_urls

將提供的影像 URL 新增至定型影像集。

此 API 接受一批 URL,並選擇性地標記來建立影像。 其限制為 64 個影像和 20 個標記。 如果成功建立所有映射,則會傳回 200 (OK) 狀態碼。 否則,將會傳回 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

取得影像數目。

篩選是在 和/或關聯性上。 例如,如果提供的標記識別項適用于 「Dog」 和 「Cat」 標籤,則只會傳回以 Dog 和/或 Cat 標記標記的影像。

get_image_performance_count

取得使用提供的 {tagIds} 標記的影像數目,這些影像具有所提供反復專案 {iterationId} 定型的預測結果。

篩選是在 和/或關聯性上。 例如,如果提供的標記識別項適用于 「Dog」 和 「Cat」 標籤,則只會傳回以 Dog 和/或 Cat 標記標記的影像。

get_image_performances

取得具有指定專案反覆運算預測的影像。

此 API 支援批次處理和範圍選取。 根據預設,它只會傳回前 50 個符合影像的影像。 使用 {take} 和 {skip} 參數來控制指定批次中要傳回的影像數目。 篩選是在 和/或關聯性上。 例如,如果提供的標記識別項適用于 「Dog」 和 「Cat」 標籤,則只會傳回以 Dog 和/或 Cat 標記標記的影像。

get_image_region_proposals

取得影像的區域提案。 如果找不到提案,則傳回空陣列。

此 API 將取得影像的區域提案,以及區域信賴度。 如果找不到提案,則會傳回空陣列。

get_images

取得指定專案反復專案或工作區的影像。

此 API 支援批次處理和範圍選取。 根據預設,它只會傳回前 50 個符合影像的影像。 使用 {take} 和 {skip} 參數來控制指定批次中要傳回的影像數目。 篩選是在 和/或關聯性上。 例如,如果提供的標記識別項適用于 「Dog」 和 「Cat」 標籤,則只會傳回以 Dog 和/或 Cat 標記標記的影像。

get_images_by_ids

依識別碼取得指定專案反復專案的影像。

此 API 會針對指定的標記傳回一組影像,並選擇性地反復專案。 如果未指定任何反復專案,則會使用目前的工作區。

get_iteration

取得特定的反復專案。

get_iteration_performance

取得反復專案的詳細效能資訊。

get_iterations

取得專案的反復專案。

get_project

取得特定專案。

get_projects

取得您的專案。

get_tag

取得特定標籤的相關資訊。

get_tagged_image_count

取得以提供的 {tagIds} 標記的影像數目。

篩選是在 和/或關聯性上。 例如,如果提供的標記識別項適用于 「Dog」 和 「Cat」 標籤,則只會傳回以 Dog 和/或 Cat 標記標記的影像。

get_tagged_images

取得指定專案反復專案的標記影像。

此 API 支援批次處理和範圍選取。 根據預設,它只會傳回前 50 個符合影像的影像。 使用 {take} 和 {skip} 參數來控制指定批次中要傳回的影像數目。 篩選是在 和/或關聯性上。 例如,如果提供的標記識別項適用于 「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 會採用 tagIds,以針對指定的臨界值取得每個建議標籤的未標記影像計數。

query_suggested_images

取得未標記的影像,其建議標記符合指定的標記。 如果沒有找到影像,則傳回空陣列。

此 API 會擷取依建議標記識別項篩選的未標記影像。 如果沒有找到影像,它會傳回空陣列。

quick_test_image

快速測試影像。

quick_test_image_url

快速測試影像 URL。

suggest_tags_and_regions

建議未標記影像陣列/批次的標籤和區域。 如果找不到任何標籤,則傳回空陣列。

此 API 會取得陣列/批次未標記影像的建議標籤和區域,以及標記的信賴度。 如果找不到任何標記,會傳回空陣列。 批次中有 64 個映射的限制。

train_project

用於定型的佇列專案。

unpublish_iteration

取消發佈特定反復專案。

update_image_metadata

更新影像的中繼資料。

此 API 接受一批映射識別碼和中繼資料來更新映射。 有 64 個影像的限制。

update_iteration

更新特定的反復專案。

update_project

更新特定專案。

update_tag

更新標籤。

close

如果keep_alive為 True,請關閉用戶端。

close() -> None

create_image_regions

建立一組映射區域。

此 API 接受一批映射區域,並選擇性地標記,以使用區域資訊更新現有的映射。 批次中有 64 個專案的限制。 如果成功建立所有區域,則會傳回 200 (OK) 狀態碼。 否則,將會傳回 207 (多重狀態) 狀態碼,而且每個區域的詳細狀態都會列在回應承載中。

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

參數

project_id
str
必要

專案識別碼。

regions
list[ImageRegionCreateEntry]
預設值: None
custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

ImageRegionCreateSummary 或 ClientRawResponse if raw=true

傳回類型

例外狀況

create_image_tags

建立一組影像與一組標記的關聯。

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

參數

project_id
str
必要

專案識別碼。

tags
list[ImageTagCreateEntry]
預設值: None

要包含在此批次中的影像標記專案。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

ImageTagCreateSummary 或 ClientRawResponse if raw=true

傳回類型

例外狀況

create_images_from_data

將提供的影像新增至定型影像集。

此 API 接受主體內容做為 multipart/form-data 和 application/octet-stream。 一次使用多部分多個影像檔時,最多可以傳送 64 個檔案。 如果成功建立所有映射,則會傳回 200 (OK) 狀態碼。 否則,將會傳回 207 (多重狀態) 狀態碼,而且每個影像的詳細狀態都會列在回應承載中。

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

參數

project_id
str
必要

專案識別碼。

image_data
Generator
必要

二進位影像資料。 支援的格式包括 JPEG、GIF、PNG 和 BMP。 支援最多 6MB 的映射。

tag_ids
list[str]
預設值: None

標記識別項,用來標記每個影像。 限制為 20。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

ImageCreateSummary 或 ClientRawResponse if raw=true

傳回類型

例外狀況

create_images_from_files

將提供的影像批次新增至定型影像集。

此 API 會接受一批檔案,並選擇性地標記來建立映射。 其限制為 64 個影像和 20 個標記。 如果成功建立所有映射,則會傳回 200 (OK) 狀態碼。 否則,將會傳回 207 (多重狀態) 狀態碼,而且每個影像的詳細狀態都會列在回應承載中。

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

參數

project_id
str
必要

專案識別碼。

batch
ImageFileCreateBatch
必要

要新增的映射檔案批次。 每個批次限制為 64 個影像和 20 個標籤。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

ImageCreateSummary 或 ClientRawResponse if raw=true

傳回類型

例外狀況

create_images_from_predictions

將指定的預測影像新增至定型影像集。

此 API 會從指定的預測影像建立一批影像。 其限制為 64 個影像和 20 個標記。 如果成功建立所有映射,則會傳回 200 (OK) 狀態碼。 否則,將會傳回 207 (多重狀態) 狀態碼,而且每個影像的詳細狀態都會列在回應承載中。

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

參數

project_id
str
必要

專案識別碼。

batch
ImageIdCreateBatch
必要

影像、標記識別項和中繼資料。 每個批次限制為 64 個影像和 20 個標籤。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

ImageCreateSummary 或 ClientRawResponse if raw=true

傳回類型

例外狀況

create_images_from_urls

將提供的影像 URL 新增至定型影像集。

此 API 接受一批 URL,並選擇性地標記來建立影像。 其限制為 64 個影像和 20 個標記。 如果成功建立所有映射,則會傳回 200 (OK) 狀態碼。 否則,將會傳回 207 (多重狀態) 狀態碼,而且每個影像的詳細狀態都會列在回應承載中。

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

參數

project_id
str
必要

專案識別碼。

batch
ImageUrlCreateBatch
必要

影像 URL、標記識別項和中繼資料。 每個批次限制為 64 個影像和 20 個標籤。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

ImageCreateSummary 或 ClientRawResponse if 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

要用於此專案的網域識別碼。 預設為 [一般]。

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,專案或 ClientRawResponse

傳回類型

例外狀況

create_tag

建立專案的標記。

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

參數

project_id
str
必要

專案識別碼。

name
str
必要

標記名稱。

description
str
預設值: None

標記的選擇性描述。

type
str
預設值: None

標記的選擇性類型。 可能的值包括:'Regular'、'Negative'、'GeneralProduct'

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,標記或 ClientRawResponse

傳回類型

Tag,

例外狀況

delete_image_regions

刪除一組映射區域。

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

參數

project_id
str
必要

專案識別碼。

region_ids
list[str]
必要

要刪除的區域。 限制為 64。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,則為 None 或 ClientRawResponse

傳回類型

None,

例外狀況

delete_image_tags

從一組影像中移除一組標記。

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

參數

project_id
str
必要

專案識別碼。

image_ids
list[str]
必要

影像識別碼。 限制為 64 個影像。

tag_ids
list[str]
必要

要從指定的影像中刪除的標記。 限制為 20 個標籤。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,則為 None 或 ClientRawResponse

傳回類型

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
必要

專案識別碼。

image_ids
list[str]
預設值: None

要刪除的影像識別碼。 每個批次限制為 256 個映射。

all_images
bool
預設值: None

指定要刪除所有影像的旗標,請指定此旗標或影像清單。 使用此旗標會傳回 202 回應,指出正在刪除影像。

all_iterations
bool
預設值: None

從所有反復專案中移除這些映射,而不只是目前的工作區。 使用此旗標會傳回 202 回應,指出正在刪除影像。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,則為 None 或 ClientRawResponse

傳回類型

None,

例外狀況

delete_iteration

刪除專案的特定反復專案。

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

參數

project_id
str
必要

專案識別碼。

iteration_id
str
必要

反復專案識別碼。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,則為 None 或 ClientRawResponse

傳回類型

None,

例外狀況

delete_prediction

刪除一組預測影像及其相關聯的預測結果。

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

參數

project_id
str
必要

專案識別碼。

ids
list[str]
必要

預測識別碼。 限制為 64。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,則為 None 或 ClientRawResponse

傳回類型

None,

例外狀況

delete_project

刪除特定的專案。

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

參數

project_id
str
必要

專案識別碼。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,則為 None 或 ClientRawResponse

傳回類型

None,

例外狀況

delete_tag

從專案刪除標記。

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

參數

project_id
str
必要

專案識別碼。

tag_id
str
必要

要刪除的標記識別項。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,則為 None 或 ClientRawResponse

傳回類型

None,

例外狀況

export_iteration

匯出定型的反復專案。

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

參數

project_id
str
必要

專案識別碼。

iteration_id
str
必要

反復專案識別碼。

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
必要

作業組態覆寫

傳回

如果 raw=true,匯出或 ClientRawResponse

傳回類型

例外狀況

export_project

匯出專案。

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

參數

project_id
str
必要

要匯出之專案的專案識別碼。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,ProjectExport 或 ClientRawResponse

傳回類型

例外狀況

get_artifact

根據 Blob 中的成品相對路徑,從 Blob 儲存體取得成品內容。

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

參數

project_id
str
必要

專案識別碼。

path
str
必要

成品的相對路徑。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

callback
Callable[<xref:Bytes>, <xref:response=None>]
預設值: None

指定時,將會使用資料流程處理的每個資料區塊來呼叫。 回呼應該採用兩個引數:目前資料區塊的位元組和回應物件。 如果資料正在上傳,回應會是 None。

operation_config
必要

作業組態覆寫

傳回

object 或 ClientRawResponse if raw=true

傳回類型

例外狀況

get_domain

取得特定網域的相關資訊。

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

參數

domain_id
str
必要

要取得相關資訊之網域的識別碼。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,則網域或 ClientRawResponse

傳回類型

例外狀況

get_domains

取得可用網域的清單。

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

參數

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

list 或 ClientRawResponse if raw=true

傳回類型

例外狀況

get_exports

取得特定反復專案的匯出清單。

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

參數

project_id
str
必要

專案識別碼。

iteration_id
str
必要

反復專案識別碼。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

list 或 ClientRawResponse if raw=true

傳回類型

例外狀況

get_image_count

取得影像數目。

篩選是在 和/或關聯性上。 例如,如果提供的標記識別項適用于 「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
必要

專案識別碼。

iteration_id
str
預設值: None

反復專案識別碼。預設為工作區。

tagging_status
str
預設值: None

標記狀態篩選。 它可以是 'All'、'Taged'或 'Untagged'。 預設為 'All'。 可能的值包括:'All'、'Taged'、'Untagged'

filter
str
預設值: None

用來根據影像中繼資料篩選影像的運算式。 只有運算式評估為 true 的影像才會包含在回應中。 運算式支援 eq (Equal) 、ne (Not equal) ,以及 (Logical 和) ,或 (Logical 或) 運算子。 以下是 metadata=key1 eq 'value1' 和 key2 ne 'value2' 的範例。

tag_ids
list[str]
預設值: None

標記識別項清單,可篩選要計算的影像。 當 Null 時,預設為所有標記。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

int 或 ClientRawResponse if raw=true

傳回類型

int,

例外狀況

get_image_performance_count

取得使用提供的 {tagIds} 標記的影像數目,這些影像具有所提供反復專案 {iterationId} 定型的預測結果。

篩選是在 和/或關聯性上。 例如,如果提供的標記識別項適用于 「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
必要

專案識別碼。

iteration_id
str
必要

反復專案識別碼。預設為工作區。

tag_ids
list[str]
預設值: None

標記識別項清單,可篩選要計算的影像。 當 Null 時,預設為所有標記。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

int 或 ClientRawResponse if raw=true

傳回類型

int,

例外狀況

get_image_performances

取得具有指定專案反覆運算預測的影像。

此 API 支援批次處理和範圍選取。 根據預設,它只會傳回前 50 個符合影像的影像。 使用 {take} 和 {skip} 參數來控制指定批次中要傳回的影像數目。 篩選是在 和/或關聯性上。 例如,如果提供的標記識別項適用于 「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
必要

專案識別碼。

iteration_id
str
必要

反復專案識別碼。預設為工作區。

tag_ids
list[str]
預設值: None

要篩選影像的標記識別項清單。 當 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 if 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
必要

專案識別碼。

image_id
str
必要

映射識別碼。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,ImageRegionProposal 或 ClientRawResponse

傳回類型

例外狀況

get_images

取得指定專案反復專案或工作區的影像。

此 API 支援批次處理和範圍選取。 根據預設,它只會傳回前 50 個符合影像的影像。 使用 {take} 和 {skip} 參數來控制指定批次中要傳回的影像數目。 篩選是在 和/或關聯性上。 例如,如果提供的標記識別項適用于 「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
必要

專案識別碼。

iteration_id
str
預設值: None

反復專案識別碼。預設為工作區。

tag_ids
list[str]
預設值: None

要篩選影像的標記識別項清單。 當 Null 時,預設為所有標記的影像。 限制為 20。

tagging_status
str
預設值: None

標記狀態篩選。 它可以是 'All'、'Taged'或 'Untagged'。 預設為 'All'。 可能的值包括:'All'、'Taged'、'Untagged'

filter
str
預設值: None

用來根據影像中繼資料篩選影像的運算式。 只有運算式評估為 true 的影像才會包含在回應中。 運算式支援 eq (Equal) 、ne (Not equal) ,以及 (Logical 和) ,或 (Logical 或) 運算子。 以下是 metadata=key1 eq 'value1' 和 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 if raw=true

傳回類型

例外狀況

get_images_by_ids

依識別碼取得指定專案反復專案的影像。

此 API 會針對指定的標記傳回一組影像,並選擇性地反復專案。 如果未指定任何反復專案,則會使用目前的工作區。

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

參數

project_id
str
必要

專案識別碼。

image_ids
list[str]
預設值: None

要擷取的影像識別碼清單。 限制為 256。

iteration_id
str
預設值: None

反復專案識別碼。預設為工作區。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

list 或 ClientRawResponse if raw=true

傳回類型

例外狀況

get_iteration

取得特定的反復專案。

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

參數

project_id
str
必要

反復專案所屬專案的識別碼。

iteration_id
str
必要

要取得之反復專案的識別碼。

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
必要

反復專案所屬專案的識別碼。

iteration_id
str
必要

要取得之反復專案的識別碼。

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
必要

專案識別碼。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

list 或 ClientRawResponse if raw=true

傳回類型

例外狀況

get_project

取得特定專案。

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

參數

project_id
str
必要

要取得之專案的識別碼。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,專案或 ClientRawResponse

傳回類型

例外狀況

get_projects

取得您的專案。

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

參數

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

list 或 ClientRawResponse if raw=true

傳回類型

例外狀況

get_tag

取得特定標籤的相關資訊。

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

參數

project_id
str
必要

此標籤所屬的專案。

tag_id
str
必要

標記識別項。

iteration_id
str
預設值: None

要從中擷取此標記的反復專案。 選擇性,預設為目前的定型集。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,標記或 ClientRawResponse

傳回類型

Tag,

例外狀況

get_tagged_image_count

取得以提供的 {tagIds} 標記的影像數目。

篩選是在 和/或關聯性上。 例如,如果提供的標記識別項適用于 「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
必要

專案識別碼。

iteration_id
str
預設值: None

反復專案識別碼。預設為工作區。

tag_ids
list[str]
預設值: None

標記識別項清單,可篩選要計算的影像。 當 Null 時,預設為所有標記。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

int 或 ClientRawResponse if raw=true

傳回類型

int,

例外狀況

get_tagged_images

取得指定專案反復專案的標記影像。

此 API 支援批次處理和範圍選取。 根據預設,它只會傳回前 50 個符合影像的影像。 使用 {take} 和 {skip} 參數來控制指定批次中要傳回的影像數目。 篩選是在 和/或關聯性上。 例如,如果提供的標記識別項適用于 「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
必要

專案識別碼。

iteration_id
str
預設值: None

反復專案識別碼。預設為工作區。

tag_ids
list[str]
預設值: None

要篩選影像的標記識別項清單。 當 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 if raw=true

傳回類型

例外狀況

get_tags

取得指定專案和反復專案的標記。

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

參數

project_id
str
必要

專案識別碼。

iteration_id
str
預設值: None

反復專案識別碼。預設為工作區。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

list 或 ClientRawResponse if raw=true

傳回類型

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
必要

專案識別碼。

iteration_id
str
預設值: None

反復專案識別碼。預設為工作區。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

int 或 ClientRawResponse if 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
必要

專案識別碼。

iteration_id
str
預設值: None

反復專案識別碼。預設為工作區。

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 if 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
必要

作業組態覆寫

傳回

如果 raw=true,專案或 ClientRawResponse

傳回類型

例外狀況

publish_iteration

發佈特定反復專案。

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

參數

project_id
str
必要

專案識別碼。

iteration_id
str
必要

反復專案識別碼。

publish_name
str
必要

要提供已發佈反復專案的名稱。

prediction_id
str
必要

要發行至之預測資源的識別碼。

overwrite
bool
預設值: None

是否要使用指定名稱覆寫已發佈的模型, (預設值:false) 。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

bool 或 ClientRawResponse if raw=true

傳回類型

bool,

例外狀況

query_predictions

取得傳送至預測端點的影像。

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

參數

project_id
str
必要

專案識別碼。

query
PredictionQueryToken
必要

用來查詢預測的參數。 限制為合併 2 個標籤。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,PredictionQueryResult 或 ClientRawResponse

傳回類型

例外狀況

query_suggested_image_count

取得建議標記符合指定標籤的影像計數,且其機率大於或等於指定的臨界值。 如果找不到,則傳回計數為 0。

此 API 會採用 tagIds,以針對指定的臨界值取得每個建議標籤的未標記影像計數。

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

參數

project_id
str
必要

專案識別碼。

iteration_id
str
必要

要用於建議標籤和區域的 IterationId。

tag_ids
list[str]
預設值: None

專案中現有的 TagId,可取得建議的標記計數。

threshold
float
預設值: None

篩選建議標記的信賴閾值。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

dict 或 ClientRawResponse if raw=true

傳回類型

dict[str, int],

例外狀況

query_suggested_images

取得未標記的影像,其建議標記符合指定的標記。 如果沒有找到影像,則傳回空陣列。

此 API 會擷取依建議標記識別項篩選的未標記影像。 如果沒有找到影像,它會傳回空陣列。

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

參數

project_id
str
必要

專案識別碼。

iteration_id
str
必要

要用於建議標籤和區域的 IterationId。

query
SuggestedTagAndRegionQueryToken
必要

包含我們需要查詢建議影像的屬性。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,SuggestedTagAndRegionQuery 或 ClientRawResponse

傳回類型

例外狀況

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
必要

專案識別碼。

image_data
Generator
必要

二進位影像資料。 支援的格式包括 JPEG、GIF、PNG 和 BMP。 支援最多 6MB 的映射。

iteration_id
str
預設值: None

選擇性。 指定要評估的特定反復專案的識別碼。 未指定時,將會使用專案的預設反復專案。

store
bool
預設值: True

選擇性。 指定是否要儲存此預測的結果。 預設值為 true,表示要儲存。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

ImagePrediction 或 ClientRawResponse if 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

選擇性。 指定要評估的特定反復專案的識別碼。 未指定時,將會使用專案的預設反復專案。

store
bool
預設值: True

選擇性。 指定是否要儲存此預測的結果。 預設值為 true,表示要儲存。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

ImagePrediction 或 ClientRawResponse if 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
必要

專案識別碼。

iteration_id
str
必要

要用於標記和區域建議的 IterationId。

image_ids
list[str]
必要

需要影像識別碼標籤建議的陣列。 使用 GetUntaggedImages API 來取得 imageIds。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回直接回應與還原序列化回應

operation_config
必要

作業組態覆寫

傳回

list 或 ClientRawResponse if 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
必要

專案識別碼。

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
必要

專案識別碼。

iteration_id
str
必要

反復專案識別碼。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回與還原序列化回應一起的直接回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,則為 None 或 ClientRawResponse

傳回類型

None,

例外狀況

update_image_metadata

更新影像的中繼資料。

此 API 接受一批映射識別碼和中繼資料來更新映射。 有 64 個影像的限制。

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

參數

project_id
str
必要

專案識別碼。

image_ids
list[str]
必要

要更新的映射識別碼清單。 限制為 64。

metadata
dict[str, str]
必要

要更新為指定影像的中繼資料。 每個影像限制為 10 個機碼/值組。 金鑰長度限制為 128。 值的長度限制為 256。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回與還原序列化回應一起的直接回應

operation_config
必要

作業組態覆寫

傳回

ImageMetadataUpdateSummary 或 ClientRawResponse if raw=true

傳回類型

例外狀況

update_iteration

更新特定的反復專案。

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

參數

project_id
str
必要

專案識別碼。

iteration_id
str
必要

反復專案識別碼。

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
必要

要更新之專案的識別碼。

updated_project
Project
必要

更新的專案模型。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回與還原序列化回應一起的直接回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,則專案或 ClientRawResponse

傳回類型

例外狀況

update_tag

更新標籤。

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

參數

project_id
str
必要

專案識別碼。

tag_id
str
必要

目標標籤的識別碼。

updated_tag
Tag
必要

更新的標記模型。

custom_headers
dict
預設值: None

將新增至要求的標頭

raw
bool
預設值: False

傳回與還原序列化回應一起的直接回應

operation_config
必要

作業組態覆寫

傳回

如果 raw=true,標記或 ClientRawResponse

傳回類型

Tag,

例外狀況