CustomVisionTrainingClient クラス

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

コンストラクター

CustomVisionTrainingClient(endpoint, credentials)

パラメーター

endpoint
str
必須

サポートされている Cognitive Services エンドポイント。

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

画像の数を取得します。

フィルター処理は、and/or の関係性に基づいています。 たとえば、指定されたタグ ID が "Dog" タグと "Cat" タグの場合、Dog または Cat でタグ付けされた画像のみが返されます。

get_image_performance_count

指定されたイテレーション {iterationId} のトレーニングからの予測結果を持つ、指定された {tagIds} でタグ付けされた画像の数を取得します。

フィルター処理は、and/or の関係性に基づいています。 たとえば、指定されたタグ ID が "Dog" タグと "Cat" タグの場合、Dog または Cat でタグ付けされた画像のみが返されます。

get_image_performances

特定のプロジェクトイテレーションの予測を含む画像を取得します。

この API は、バッチ処理と範囲選択をサポートしています。 既定では、画像に一致する最初の 50 の画像のみが返されます。 {take} パラメーターと {skip} パラメーターを使用して、特定のバッチで返すイメージの数を制御します。 フィルター処理は、and/or の関係性に基づいています。 たとえば、指定されたタグ ID が "Dog" タグと "Cat" タグの場合、Dog または Cat でタグ付けされた画像のみが返されます。

get_image_region_proposals

画像のリージョン提案を取得します。 提案が見つからない場合は、空の配列を返します。

この API は、リージョンの信頼度と共に、画像のリージョンの提案を取得します。 提案が見つからない場合は、空の配列が返されます。

get_images

特定のプロジェクトイテレーションまたはワークスペースのイメージを取得します。

この API は、バッチ処理と範囲選択をサポートしています。 既定では、画像に一致する最初の 50 の画像のみが返されます。 {take} パラメーターと {skip} パラメーターを使用して、特定のバッチで返すイメージの数を制御します。 フィルター処理は、and/or の関係性に基づいています。 たとえば、指定されたタグ 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} でタグ付けされた画像の数を取得します。

フィルター処理は、and/or の関係性に基づいています。 たとえば、指定されたタグ ID が "Dog" タグと "Cat" タグの場合、Dog または Cat でタグ付けされた画像のみが返されます。

get_tagged_images

特定のプロジェクトイテレーションのタグ付けされた画像を取得します。

この API は、バッチ処理と範囲選択をサポートしています。 既定では、画像に一致する最初の 50 の画像のみが返されます。 {take} パラメーターと {skip} パラメーターを使用して、特定のバッチで返すイメージの数を制御します。 フィルター処理は、and/or の関係性に基づいています。 たとえば、指定されたタグ 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

提案されたタグが特定のタグと一致し、その確率が指定されたしきい値以上の画像の数を取得します。 何も見つからない場合は、count を 0 として返します。

この API は タグ ID を使用して、特定のしきい値について、提案されたタグごとにタグなし画像の数を取得します。

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(OK) 状態コードが返されます。 それ以外の場合は、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(OK) 状態コードが返されます。 それ以外の場合は、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 です。 最大 6 MB のイメージをサポートします。

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(OK) 状態コードが返されます。 それ以外の場合は、207 (複数の状態) 状態コードが返され、各画像の詳細状態が応答ペイロードに一覧表示されます。

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

パラメーター

project_id
str
必須

プロジェクト ID。

batch
ImageFileCreateBatch
必須

追加するイメージ ファイルのバッチ。 1 バッチあたり 64 個の画像と 20 個のタグに制限されています。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作の構成がオーバーライドされます

戻り値

ImageCreateSummary または ClientRawResponse (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
必須

プロジェクト ID。

batch
ImageIdCreateBatch
必須

画像、タグ ID、およびメタデータ。 1 バッチあたり 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(OK) 状態コードが返されます。 それ以外の場合は、207 (複数の状態) 状態コードが返され、各画像の詳細状態が応答ペイロードに一覧表示されます。

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

パラメーター

project_id
str
必須

プロジェクト ID。

batch
ImageUrlCreateBatch
必須

イメージ URL、タグ ID、およびメタデータ。 1 バッチあたり 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 Storage コンテナーへの URI。

notification_queue_uri
str
既定値: None

プロジェクト関連の通知の送信に使用される Azure Storage キューへの URI。 セットアップとメッセージ形式については 、ストレージ通知 のドキュメントを参照してください。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作の構成がオーバーライドされます

戻り値

project または ClientRawResponse (raw=true の場合)

の戻り値の型 :

例外

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

操作の構成がオーバーライドされます

戻り値

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

プロジェクト ID。

image_ids
list[str]
必須

イメージ ID。 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
必須

プロジェクト 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
必須

操作の構成がオーバーライドされます

戻り値

raw=true の場合は None または ClientRawResponse

の戻り値の型 :

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

操作の構成がオーバーライドされます

戻り値

raw=true の場合は None または ClientRawResponse

の戻り値の型 :

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

操作の構成がオーバーライドされます

戻り値

raw=true の場合は None または ClientRawResponse

の戻り値の型 :

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

操作の構成がオーバーライドされます

戻り値

raw=true の場合は None または ClientRawResponse

の戻り値の型 :

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

操作の構成がオーバーライドされます

戻り値

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

プロジェクト 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
必須

操作の構成がオーバーライドされます

戻り値

raw=true の場合は Export または ClientRawResponse

の戻り値の型 :

例外

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

操作の構成がオーバーライドされます

戻り値

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

プロジェクト ID。

path
str
必須

成果物の相対パス。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

callback
Callable[<xref:Bytes>, <xref:response=None>]
既定値: None

を指定すると、ストリーミングされるデータの各チャンクで が呼び出されます。 コールバックは、現在のデータ チャンクと応答オブジェクトのバイトである 2 つの引数を受け取る必要があります。 データがアップロードされている場合、応答は 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
必須

操作の構成がオーバーライドされます

戻り値

domain or ClientRawResponse if raw=true

の戻り値の型 :

例外

get_domains

使用可能なドメインの一覧を取得します。

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

パラメーター

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作の構成がオーバーライドされます

戻り値

raw=true の場合は list または ClientRawResponse

の戻り値の型 :

例外

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

画像の数を取得します。

フィルター処理は、and/or の関係性に基づいています。 たとえば、指定されたタグ 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 and)、または (Logical or) 演算子をサポートします。 metadata=key1 eq 'value1' と 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

指定されたイテレーション {iterationId} のトレーニングからの予測結果を持つ、指定された {tagIds} でタグ付けされた画像の数を取得します。

フィルター処理は、and/or の関係性に基づいています。 たとえば、指定されたタグ 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} パラメーターを使用して、特定のバッチで返すイメージの数を制御します。 フィルター処理は、and/or の関係性に基づいています。 たとえば、指定されたタグ 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} パラメーターを使用して、特定のバッチで返すイメージの数を制御します。 フィルター処理は、and/or の関係性に基づいています。 たとえば、指定されたタグ 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 and)、または (Logical or) 演算子をサポートします。 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 (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
必須

操作構成のオーバーライド

戻り値

list または ClientRawResponse (raw=true の場合)

の戻り値の型 :

例外

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

操作構成のオーバーライド

戻り値

IterationPerformance または ClientRawResponse (raw=true の場合)

の戻り値の型 :

例外

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

操作構成のオーバーライド

戻り値

list または ClientRawResponse (raw=true の場合)

の戻り値の型 :

例外

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

操作構成のオーバーライド

戻り値

project または ClientRawResponse (raw=true の場合)

の戻り値の型 :

例外

get_projects

プロジェクトを取得します。

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

パラメーター

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

list または ClientRawResponse (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
必須

タグ ID。

iteration_id
str
既定値: None

このタグを取得するイテレーション。 省略可能。既定値は現在のトレーニング セットです。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

raw=true の場合は Tag または ClientRawResponse

の戻り値の型 :

Tag,

例外

get_tagged_image_count

指定された {tagIds} でタグ付けされた画像の数を取得します。

フィルター処理は、and/or の関係性に基づいています。 たとえば、指定されたタグ 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} パラメーターを使用して、特定のバッチで返すイメージの数を制御します。 フィルター処理は、and/or の関係性に基づいています。 たとえば、指定されたタグ 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
必須

操作構成のオーバーライド

戻り値

list または ClientRawResponse (raw=true の場合)

の戻り値の型 :

例外

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

操作構成のオーバーライド

戻り値

list または ClientRawResponse (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
必須

プロジェクト 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
必須

操作の構成がオーバーライドされます

戻り値

raw=true の場合は list または ClientRawResponse

の戻り値の型 :

例外

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

提案されたタグが特定のタグと一致し、その確率が指定されたしきい値以上の画像の数を取得します。 何も見つからない場合は、count を 0 として返します。

この API は タグ ID を使用して、特定のしきい値について、提案されたタグごとにタグなし画像の数を取得します。

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

操作の構成がオーバーライドされます

戻り値

raw=true の場合は dict または ClientRawResponse

の戻り値の型 :

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 です。 最大 6 MB のイメージをサポートします。

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

操作の構成がオーバーライドされます

戻り値

raw=true の場合は list または ClientRawResponse

の戻り値の型 :

例外

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)。 指定できる値は、'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
必須

操作構成のオーバーライド

戻り値

none または ClientRawResponse (raw=true の場合)

の戻り値の型 :

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

操作構成のオーバーライド

戻り値

project または ClientRawResponse (raw=true の場合)

の戻り値の型 :

例外

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,

例外