CustomVisionTrainingClient Класс

Наследование

azure.cognitiveservices.vision.customvision.training.operations._custom_vision_training_client_operations.CustomVisionTrainingClientOperationsMixin

CustomVisionTrainingClient

SDKClient

CustomVisionTrainingClient

Конструктор

CustomVisionTrainingClient(endpoint, credentials)

Параметры

endpoint

str

Обязательно

Поддерживаемые конечные точки Cognitive Services.

credentials

None

Обязательно

Учетные данные подписки, которые однозначно идентифицируют подписку клиента.

Переменные

config

CustomVisionTrainingClientConfiguration

Конфигурация для клиента.

Методы

close	Закройте клиент, если keep_alive имеет значение True.
create_image_regions	Создайте набор областей изображений. Этот API принимает пакет регионов изображений и при необходимости теги, чтобы добавить в существующие изображения информацию о регионах. В пакете существует ограничение в 64 записей. Если все регионы успешно созданы, будет возвращен код состояния 200 (ОК). В противном случае будет возвращен код состояния 207 (multi-Status), а подробные сведения о состоянии для каждого региона будут перечислены в полезных данных ответа.
create_image_tags	Связывает набор изображений с набором тегов.
create_images_from_data	Добавьте предоставленные изображения в набор обучающих изображений. Этот API принимает содержимое текста как multipart/form-data и application/octet-stream. При использовании нескольких составных файлов изображений можно отправлять одновременно, при этом не более 64 файлов. Если все образы успешно созданы, возвращается код состояния 200(OK). В противном случае будет возвращен код состояния 207 (multi-Status), а подробные сведения о состоянии каждого изображения будут перечислены в полезных данных ответа.
create_images_from_files	Добавьте предоставленный пакет изображений в набор обучающих образов. Этот API принимает пакет файлов и при необходимости теги для создания изображений. Существует ограничение в 64 изображения и 20 тегов. Если все образы успешно созданы, возвращается код состояния 200(OK). В противном случае будет возвращен код состояния 207 (multi-Status), а подробные сведения о состоянии каждого изображения будут перечислены в полезных данных ответа.
create_images_from_predictions	Добавьте указанные прогнозируемые изображения в набор обучающих изображений. Этот API создает пакет изображений из указанных прогнозируемых изображений. Существует ограничение в 64 изображения и 20 тегов. Если все образы успешно созданы, возвращается код состояния 200(OK). В противном случае будет возвращен код состояния 207 (multi-Status), а подробные сведения о состоянии каждого изображения будут перечислены в полезных данных ответа.
create_images_from_urls	Добавьте предоставленные URL-адреса изображений в набор обучающих изображений. Этот API принимает пакет URL-адресов и при необходимости теги для создания изображений. Существует ограничение в 64 изображения и 20 тегов. Если все образы успешно созданы, возвращается код состояния 200(OK). В противном случае будет возвращен код состояния 207 (multi-Status), а подробные сведения о состоянии каждого изображения будут перечислены в полезных данных ответа.
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-объектов на основе относительного пути артефакта в большом двоичном объекте.
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 принимает идентификаторы тегов, чтобы получить количество изображений без тегов для каждого из предложенных тегов для заданного порогового значения.
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 (ОК). В противном случае будет возвращен код состояния 207 (multi-Status), а подробные сведения о состоянии для каждого региона будут перечислены в полезных данных ответа.

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, если raw=true

Возвращаемый тип

ImageRegionCreateSummary,

ClientRawResponse

Исключения

CustomVisionErrorException

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, если raw=true

Возвращаемый тип

ImageTagCreateSummary,

ClientRawResponse

Исключения

CustomVisionErrorException

create_images_from_data

Добавьте предоставленные изображения в набор обучающих изображений.

Этот API принимает содержимое текста как multipart/form-data и application/octet-stream. При использовании нескольких составных файлов изображений можно отправлять одновременно, при этом не более 64 файлов. Если все образы успешно созданы, возвращается код состояния 200(OK). В противном случае будет возвращен код состояния 207 (multi-Status), а подробные сведения о состоянии каждого изображения будут перечислены в полезных данных ответа.

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. Поддерживает изображения до 6 МБ.

tag_ids

list[str]

значение по умолчанию: None

Идентификаторы тегов, с помощью которых помечается каждое изображение. Ограничено 20.

custom_headers

dict

значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw

bool

значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом

operation_config

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

ImageCreateSummary или ClientRawResponse, если raw=true

Возвращаемый тип

ImageCreateSummary,

ClientRawResponse

Исключения

CustomVisionErrorException

create_images_from_files

Добавьте предоставленный пакет изображений в набор обучающих образов.

Этот API принимает пакет файлов и при необходимости теги для создания изображений. Существует ограничение в 64 изображения и 20 тегов. Если все образы успешно созданы, возвращается код состояния 200(OK). В противном случае будет возвращен код состояния 207 (multi-Status), а подробные сведения о состоянии каждого изображения будут перечислены в полезных данных ответа.

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, если raw=true

Возвращаемый тип

ImageCreateSummary,

ClientRawResponse

Исключения

CustomVisionErrorException

create_images_from_predictions

Добавьте указанные прогнозируемые изображения в набор обучающих изображений.

Этот API создает пакет изображений из указанных прогнозируемых изображений. Существует ограничение в 64 изображения и 20 тегов. Если все образы успешно созданы, возвращается код состояния 200(OK). В противном случае будет возвращен код состояния 207 (multi-Status), а подробные сведения о состоянии каждого изображения будут перечислены в полезных данных ответа.

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, если raw=true

Возвращаемый тип

ImageCreateSummary,

ClientRawResponse

Исключения

CustomVisionErrorException

create_images_from_urls

Добавьте предоставленные URL-адреса изображений в набор обучающих изображений.

Этот API принимает пакет URL-адресов и при необходимости теги для создания изображений. Существует ограничение в 64 изображения и 20 тегов. Если все образы успешно созданы, возвращается код состояния 200(OK). В противном случае будет возвращен код состояния 207 (multi-Status), а подробные сведения о состоянии каждого изображения будут перечислены в полезных данных ответа.

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, если raw=true

Возвращаемый тип

ImageCreateSummary,

ClientRawResponse

Исключения

CustomVisionErrorException

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

Универсальный код ресурса (URI) контейнера службы хранилища Azure, который будет использоваться для хранения экспортированных моделей.

notification_queue_uri

str

значение по умолчанию: None

URI очереди службы хранилища Azure, которая будет использоваться для отправки уведомлений, связанных с проектом. Сведения о настройке и формате сообщений см. в документации по уведомлениям хранилища .

custom_headers

dict

значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw

bool

значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом

operation_config

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Project или ClientRawResponse, если raw=true

Возвращаемый тип

Project,

ClientRawResponse

Исключения

CustomVisionErrorException

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Tag или ClientRawResponse, если raw=true

Возвращаемый тип

Tag,

ClientRawResponse

Исключения

CustomVisionErrorException

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

None или ClientRawResponse, если raw=true

Возвращаемый тип

None,

ClientRawResponse

Исключения

CustomVisionErrorException

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

None или ClientRawResponse, если raw=true

Возвращаемый тип

None,

ClientRawResponse

Исключения

CustomVisionErrorException

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

None или ClientRawResponse, если raw=true

Возвращаемый тип

None,

ClientRawResponse

Исключения

CustomVisionErrorException

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

None или ClientRawResponse, если raw=true

Возвращаемый тип

None,

ClientRawResponse

Исключения

CustomVisionErrorException

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

None или ClientRawResponse, если raw=true

Возвращаемый тип

None,

ClientRawResponse

Исключения

CustomVisionErrorException

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

None или ClientRawResponse, если raw=true

Возвращаемый тип

None,

ClientRawResponse

Исключения

CustomVisionErrorException

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

None или ClientRawResponse, если raw=true

Возвращаемый тип

None,

ClientRawResponse

Исключения

CustomVisionErrorException

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Export или ClientRawResponse, если raw=true

Возвращаемый тип

Export,

ClientRawResponse

Исключения

CustomVisionErrorException

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

ProjectExport или ClientRawResponse, если raw=true

Возвращаемый тип

ProjectExport,

ClientRawResponse

Исключения

CustomVisionErrorException

get_artifact

Получает содержимое артефакта из хранилища 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, если raw=true

Возвращаемый тип

Generator,

ClientRawResponse

Исключения

HttpOperationError

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Domain или ClientRawResponse, если raw=true

Возвращаемый тип

Domain,

ClientRawResponse

Исключения

CustomVisionErrorException

get_domains

Получите список доступных доменов.

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

Параметры

custom_headers

dict

значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw

bool

значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом

operation_config

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

list или ClientRawResponse, если raw=true

Возвращаемый тип

list[Domain],

ClientRawResponse

Исключения

CustomVisionErrorException

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, если raw=true

Возвращаемый тип

list[Export],

ClientRawResponse

Исключения

CustomVisionErrorException

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, Tagged или Untagged. Значение по умолчанию — "Все". Возможные значения: 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

Список идентификаторов тегов для фильтрации изображений для подсчета. По умолчанию для всех тегов задано значение NULL.

custom_headers

dict

значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw

bool

значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом

operation_config

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

int или ClientRawResponse, если raw=true

Возвращаемый тип

int,

ClientRawResponse

Исключения

CustomVisionErrorException

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, если raw=true

Возвращаемый тип

int,

ClientRawResponse

Исключения

CustomVisionErrorException

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. Возможные значения: "Newest", "Oldest"

take

int

значение по умолчанию: 50

Максимальное количество возвращаемых изображений. Значение по умолчанию — 50, ограничение — 256.

skip

int

значение по умолчанию: 0

Количество образов, которые необходимо пропустить перед запуском пакета образов. Значение по умолчанию — 0.

custom_headers

dict

значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw

bool

значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом

operation_config

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

list или ClientRawResponse, если raw=true

Возвращаемый тип

list[ImagePerformance],

ClientRawResponse

Исключения

CustomVisionErrorException

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

ImageRegionProposal или ClientRawResponse, если raw=true

Возвращаемый тип

ImageRegionProposal,

ClientRawResponse

Исключения

CustomVisionErrorException

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, Tagged или Untagged. Значение по умолчанию — "Все". Возможные значения: 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. Возможные значения: "Newest", "Oldest"

take

int

значение по умолчанию: 50

Максимальное количество возвращаемых изображений. Значение по умолчанию — 50, ограничение — 256.

skip

int

значение по умолчанию: 0

Количество образов, которые необходимо пропустить перед запуском пакета образов. Значение по умолчанию — 0.

custom_headers

dict

значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw

bool

значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом

operation_config

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

list или ClientRawResponse, если raw=true

Возвращаемый тип

list[Image],

ClientRawResponse

Исключения

CustomVisionErrorException

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, если raw=true

Возвращаемый тип

list[Image],

ClientRawResponse

Исключения

CustomVisionErrorException

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Iteration или ClientRawResponse if raw=true

Возвращаемый тип

Iteration,

ClientRawResponse

Исключения

CustomVisionErrorException

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

IterationPerformance или ClientRawResponse, если raw=true

Возвращаемый тип

IterationPerformance,

ClientRawResponse

Исключения

CustomVisionErrorException

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, если raw=true

Возвращаемый тип

list[Iteration],

ClientRawResponse

Исключения

CustomVisionErrorException

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Project или ClientRawResponse, если raw=true

Возвращаемый тип

Project,

ClientRawResponse

Исключения

CustomVisionErrorException

get_projects

Получение проектов.

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

Параметры

custom_headers

dict

значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw

bool

значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом.

operation_config

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

list или ClientRawResponse, если raw=true

Возвращаемый тип

list[Project],

ClientRawResponse

Исключения

CustomVisionErrorException

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Tag или ClientRawResponse, если raw=true

Возвращаемый тип

Tag,

ClientRawResponse

Исключения

CustomVisionErrorException

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, если raw=true

Возвращаемый тип

int,

ClientRawResponse

Исключения

CustomVisionErrorException

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, если raw=true

Возвращаемый тип

list[Image],

ClientRawResponse

Исключения

CustomVisionErrorException

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, если raw=true

Возвращаемый тип

list[Tag],

ClientRawResponse

Исключения

CustomVisionErrorException

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, если raw=true

Возвращаемый тип

int,

ClientRawResponse

Исключения

CustomVisionErrorException

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, если raw=true

Возвращаемый тип

list[Image],

ClientRawResponse

Исключения

CustomVisionErrorException

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

Возвращаемый тип

Project,

ClientRawResponse

Исключения

CustomVisionErrorException

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, если raw=true

Возвращаемый тип

bool,

ClientRawResponse

Исключения

CustomVisionErrorException

query_predictions

Получение изображений, отправленных в конечную точку прогнозирования.

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

Параметры

project_id

str

Обязательно

Идентификатор проекта.

query

PredictionQueryToken

Обязательно

Параметры, используемые для запроса прогнозов. Ограничивается объединением двух тегов.

custom_headers

dict

значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw

bool

значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом.

operation_config

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

PredictionQueryResult или ClientRawResponse, если raw=true

Возвращаемый тип

PredictionQueryResult,

ClientRawResponse

Исключения

CustomVisionErrorException

query_suggested_image_count

Получение количества изображений, предлагаемые теги которых соответствуют заданным тегам, и их вероятности больше или равны заданному пороговой величине. Возвращает значение 0, если значение не найдено.

Этот API принимает идентификаторы тегов, чтобы получить количество изображений без тегов для каждого из предложенных тегов для заданного порогового значения.

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

Существующие идентификаторы тегов в проекте для получения рекомендуемых тегов.

threshold

float

значение по умолчанию: None

Порог достоверности для фильтрации предлагаемых тегов.

custom_headers

dict

значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw

bool

значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом.

operation_config

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

dict или ClientRawResponse, если raw=true

Возвращаемый тип

dict[str, int],

ClientRawResponse

Исключения

CustomVisionErrorException

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

SuggestedTagAndRegionQuery или ClientRawResponse, если raw=true

Возвращаемый тип

SuggestedTagAndRegionQuery,

ClientRawResponse

Исключения

CustomVisionErrorException

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. Поддерживает образы до 6 МБ.

iteration_id

str

значение по умолчанию: None

Необязательный элемент. Указывает идентификатор определенной итерации для оценки. Итерация по умолчанию для проекта будет использоваться, если она не указана.

store

bool

значение по умолчанию: True

Необязательный элемент. Указывает, следует ли хранить результат этого прогноза. Значение по умолчанию — true, для хранения.

custom_headers

dict

значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw

bool

значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом.

operation_config

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

ImagePrediction или ClientRawResponse, если raw=true

Возвращаемый тип

ImagePrediction,

ClientRawResponse

Исключения

CustomVisionErrorException

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, если raw=true

Возвращаемый тип

ImagePrediction,

ClientRawResponse

Исключения

CustomVisionErrorException

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]

Обязательно

Для массива идентификаторов изображений требуется предложение тега. Используйте API GetUntaggedImages для получения идентификаторов imageId.

custom_headers

dict

значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw

bool

значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом.

operation_config

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

list или ClientRawResponse, если raw=true

Возвращаемый тип

list[SuggestedTagAndRegion],

ClientRawResponse

Исключения

CustomVisionErrorException

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Итерация или ClientRawResponse, если raw=true

Возвращаемый тип

Iteration,

ClientRawResponse

Исключения

CustomVisionErrorException

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

None или ClientRawResponse, если raw=true

Возвращаемый тип

None,

ClientRawResponse

Исключения

CustomVisionErrorException

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, если raw=true

Возвращаемый тип

ImageMetadataUpdateSummary,

ClientRawResponse

Исключения

CustomVisionErrorException

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Итерация или ClientRawResponse, если raw=true

Возвращаемый тип

Iteration,

ClientRawResponse

Исключения

CustomVisionErrorException

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Project или ClientRawResponse, если raw=true

Возвращаемый тип

Project,

ClientRawResponse

Исключения

CustomVisionErrorException

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

Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Tag или ClientRawResponse, если raw=true

Возвращаемый тип

Tag,

ClientRawResponse

Исключения

CustomVisionErrorException