CustomVisionTrainingClient Clase

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

Constructor

CustomVisionTrainingClient(endpoint, credentials)

Parámetros

endpoint
str
Requerido

Puntos de conexión de Cognitive Services compatibles.

credentials
None
Requerido

Credenciales de suscripción que identifican de forma única la suscripción de cliente.

Variables

config
CustomVisionTrainingClientConfiguration

Configuración para el cliente.

Métodos

close

Cierre el cliente si keep_alive es True.

create_image_regions

Cree un conjunto de regiones de imagen.

Esta API acepta un lote de regiones de imágenes y, opcionalmente, etiquetas, para actualizar las imágenes existentes con la información de la región. Hay un límite de 64 entradas en el lote. Si todas las regiones se crean correctamente, se devolverá el código de estado 200(OK). De lo contrario, se devolverá el código de estado 207 (estado múltiple) y se mostrará el estado detallado de cada región en la carga de respuesta.

create_image_tags

Asocia un conjunto de imágenes a un conjunto de etiquetas.

create_images_from_data

Agregue las imágenes proporcionadas al conjunto de imágenes de entrenamiento.

Esta API acepta el contenido del cuerpo como multipart/form-data y application/octet-stream. Cuando se usan varios archivos de imagen de varias partes se pueden enviar a la vez, con un máximo de 64 archivos. Si todas las imágenes se crean correctamente, se devolverá el código de estado 200(OK). De lo contrario, se devolverá el código de estado 207 (estado múltiple) y se mostrará el estado detallado de cada imagen en la carga de respuesta.

create_images_from_files

Agregue el lote proporcionado de imágenes al conjunto de imágenes de entrenamiento.

Esta API acepta un lote de archivos y, opcionalmente, etiquetas, para crear imágenes. Hay un límite de 64 imágenes y 20 etiquetas. Si todas las imágenes se crean correctamente, se devolverá el código de estado 200(OK). De lo contrario, se devolverá el código de estado 207 (estado múltiple) y se mostrará el estado detallado de cada imagen en la carga de respuesta.

create_images_from_predictions

Agregue las imágenes previstas especificadas al conjunto de imágenes de entrenamiento.

Esta API crea un lote de imágenes a partir de las imágenes previstas especificadas. Hay un límite de 64 imágenes y 20 etiquetas. Si todas las imágenes se crean correctamente, se devolverá el código de estado 200(OK). De lo contrario, se devolverá el código de estado 207 (estado múltiple) y se mostrará el estado detallado de cada imagen en la carga de respuesta.

create_images_from_urls

Agregue las direcciones URL de imágenes proporcionadas al conjunto de imágenes de entrenamiento.

Esta API acepta un lote de direcciones URL y, opcionalmente, etiquetas, para crear imágenes. Hay un límite de 64 imágenes y 20 etiquetas. Si todas las imágenes se crean correctamente, se devolverá el código de estado 200(OK). De lo contrario, se devolverá el código de estado 207 (estado múltiple) y se mostrará el estado detallado de cada imagen en la carga de respuesta.

create_project

Crear un proyecto.

create_tag

Crea una etiqueta para el proyecto.

delete_image_regions

Elimina un conjunto de regiones de imágenes.

delete_image_tags

Quita un conjunto de etiquetas de un conjunto de imágenes.

delete_images

Elimina imágenes del conjunto de imágenes de entrenamiento.

delete_iteration

Elimina una iteración específica de un proyecto.

delete_prediction

Elimina un conjunto de imágenes previstas y sus resultados de predicción asociados.

delete_project

Elimina un proyecto específico.

delete_tag

Elimina una etiqueta del proyecto.

export_iteration

Exporta una iteración entrenada.

export_project

Exporta un proyecto.

get_artifact

Obtiene el contenido del artefacto de Blob Storage, en función de la ruta de acceso relativa del artefacto en el blob.

get_domain

Obtiene información sobre un dominio específico.

get_domains

Obtenga una lista de los dominios disponibles.

get_exports

Obtiene la lista de exportaciones para una iteración concreta.

get_image_count

Obtiene el número de imágenes.

El filtrado tiene una relación de y/o. Por ejemplo, si los identificadores de etiqueta proporcionados son para las etiquetas "Dog" y "Cat", solo se devolverán las imágenes etiquetadas con Dog o Cat.

get_image_performance_count

Obtiene el número de imágenes etiquetadas con el {tagIds} proporcionado que tiene resultados de predicción del entrenamiento para la iteración proporcionada {iteraciónId}.

El filtrado tiene una relación de y/o. Por ejemplo, si los identificadores de etiqueta proporcionados son para las etiquetas "Dog" y "Cat", solo se devolverán las imágenes etiquetadas con Dog o Cat.

get_image_performances

Obtenga la imagen con su predicción para una iteración de proyecto determinada.

Esta API admite el procesamiento por lotes y la selección de intervalos. De manera predeterminada, solo devolverá las primeras 50 imágenes que coincidan con las imágenes. Use los parámetros {take} y {skip} para controlar el número de imágenes que se van a devolver en un lote determinado. El filtrado tiene una relación de y/o. Por ejemplo, si los identificadores de etiqueta proporcionados son para las etiquetas "Dog" y "Cat", solo se devolverán las imágenes etiquetadas con Dog o Cat.

get_image_region_proposals

Obtenga propuestas de región para una imagen. Devuelve una matriz vacía si no se encuentra ninguna propuesta.

Esta API obtendrá propuestas de región para una imagen, junto con las confianzas para la región. Devuelve una matriz vacía si no se encuentra ninguna propuesta.

get_images

Obtiene imágenes para una iteración o un área de trabajo de un proyecto determinado.

Esta API admite el procesamiento por lotes y la selección de intervalos. De manera predeterminada, solo devolverá las primeras 50 imágenes que coincidan con las imágenes. Use los parámetros {take} y {skip} para controlar el número de imágenes que se van a devolver en un lote determinado. El filtrado tiene una relación de y/o. Por ejemplo, si los identificadores de etiqueta proporcionados son para las etiquetas "Dog" y "Cat", solo se devolverán las imágenes etiquetadas con Dog o Cat.

get_images_by_ids

Obtiene imágenes por identificador para una iteración de proyecto determinada.

Esta API devolverá un conjunto de imágenes para las etiquetas especificadas y, opcionalmente, la iteración. Si no se especifica ninguna iteración, se usa el área de trabajo actual.

get_iteration

Obtiene una iteración concreta.

get_iteration_performance

Obtiene información detallada sobre el rendimiento de una iteración.

get_iterations

Obtenga iteraciones para el proyecto.

get_project

Obtiene un proyecto específico.

get_projects

Obtenga los proyectos.

get_tag

Obtiene información sobre una etiqueta específica.

get_tagged_image_count

Obtiene el número de imágenes etiquetadas con el {tagIds} proporcionado.

El filtrado tiene una relación de y/o. Por ejemplo, si los identificadores de etiqueta proporcionados son para las etiquetas "Dog" y "Cat", solo se devolverán las imágenes etiquetadas con Dog o Cat.

get_tagged_images

Obtiene imágenes etiquetadas para una iteración de proyecto determinada.

Esta API admite el procesamiento por lotes y la selección de intervalos. De manera predeterminada, solo devolverá las primeras 50 imágenes que coincidan con las imágenes. Use los parámetros {take} y {skip} para controlar el número de imágenes que se van a devolver en un lote determinado. El filtrado tiene una relación de y/o. Por ejemplo, si los identificadores de etiqueta proporcionados son para las etiquetas "Dog" y "Cat", solo se devolverán las imágenes etiquetadas con Dog o Cat.

get_tags

Obtenga las etiquetas de un proyecto determinado y la iteración.

get_untagged_image_count

Obtiene el número de imágenes sin etiquetar.

Esta API devuelve las imágenes que no tienen etiquetas para un proyecto determinado y, opcionalmente, una iteración. Si no se especifica ninguna iteración, se usa el área de trabajo actual.

get_untagged_images

Obtiene imágenes sin etiquetar para una iteración de proyecto determinada.

Esta API admite el procesamiento por lotes y la selección de intervalos. De manera predeterminada, solo devolverá las primeras 50 imágenes que coincidan con las imágenes. Use los parámetros {take} y {skip} para controlar el número de imágenes que se van a devolver en un lote determinado.

import_project

Importa un proyecto.

publish_iteration

Publica una iteración concreta.

query_predictions

Obtiene las imágenes que se enviaron al punto de conexión de predicción.

query_suggested_image_count

Obtiene el recuento de imágenes cuyas etiquetas sugeridas coinciden con las etiquetas dadas y sus probabilidades son mayores o iguales que el umbral especificado. Devuelve el recuento como 0 si no se encuentra ninguno.

Esta API toma id. de etiquetas para obtener el recuento de imágenes no etiquetadas por etiquetas sugeridas para un umbral determinado.

query_suggested_images

Obtiene imágenes sin etiqueta cuyas etiquetas sugeridas coinciden con etiquetas dadas. Devuelve una matriz vacía si no se encuentra ninguna imagen.

Esta API capturará las imágenes no etiquetadas filtradas por identificadores de etiquetas sugeridos. Devuelve una matriz vacía si no se encuentra ninguna imagen.

quick_test_image

Realiza una prueba rápida de una imagen.

quick_test_image_url

Realiza una prueba rápida de la dirección URL de una imagen.

suggest_tags_and_regions

Sugerir etiquetas y regiones para una matriz o lote de imágenes sin etiquetar. Devuelve una matriz vacía si no se encuentra ninguna etiqueta.

Esta API obtendrá etiquetas y regiones sugeridas para una matriz o lote de imágenes sin etiquetar, junto con las confianzas de las etiquetas. Devuelve una matriz vacía si no se encuentra ninguna etiqueta. Hay un límite de 64 imágenes en el lote.

train_project

Pone en cola el proyecto para entrenamiento.

unpublish_iteration

Cancela la publicación de una iteración concreta.

update_image_metadata

Actualice los metadatos de las imágenes.

Esta API acepta un lote de identificadores de imagen y metadatos para actualizar imágenes. Hay un límite de 64 imágenes.

update_iteration

Actualiza una iteración concreta.

update_project

Actualiza un proyecto específico.

update_tag

Actualiza una etiqueta.

close

Cierre el cliente si keep_alive es True.

close() -> None

create_image_regions

Cree un conjunto de regiones de imagen.

Esta API acepta un lote de regiones de imágenes y, opcionalmente, etiquetas, para actualizar las imágenes existentes con la información de la región. Hay un límite de 64 entradas en el lote. Si todas las regiones se crean correctamente, se devolverá el código de estado 200(OK). De lo contrario, se devolverá el código de estado 207 (estado múltiple) y se mostrará el estado detallado de cada región en la carga de respuesta.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

regions
list[ImageRegionCreateEntry]
valor predeterminado: None
custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

ImageRegionCreateSummary o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

create_image_tags

Asocia un conjunto de imágenes a un conjunto de etiquetas.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

tags
list[ImageTagCreateEntry]
valor predeterminado: None

Entradas de etiqueta de imagen que se van a incluir en este lote.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

ImageTagCreateSummary o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

create_images_from_data

Agregue las imágenes proporcionadas al conjunto de imágenes de entrenamiento.

Esta API acepta el contenido del cuerpo como multipart/form-data y application/octet-stream. Cuando se usan varios archivos de imagen de varias partes se pueden enviar a la vez, con un máximo de 64 archivos. Si todas las imágenes se crean correctamente, se devolverá el código de estado 200(OK). De lo contrario, se devolverá el código de estado 207 (estado múltiple) y se mostrará el estado detallado de cada imagen en la carga de respuesta.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

image_data
Generator
Requerido

Datos de imagen binaria. Los formatos admitidos son JPEG, GIF, PNG y BMP. Admite imágenes de hasta 6 MB.

tag_ids
list[str]
valor predeterminado: None

Identificadores de etiquetas con los que se etiqueta cada imagen. Limitado a 20.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

ImageCreateSummary o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

create_images_from_files

Agregue el lote proporcionado de imágenes al conjunto de imágenes de entrenamiento.

Esta API acepta un lote de archivos y, opcionalmente, etiquetas, para crear imágenes. Hay un límite de 64 imágenes y 20 etiquetas. Si todas las imágenes se crean correctamente, se devolverá el código de estado 200(OK). De lo contrario, se devolverá el código de estado 207 (estado múltiple) y se mostrará el estado detallado de cada imagen en la carga de respuesta.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

batch
ImageFileCreateBatch
Requerido

Lote de archivos de imagen que se van a agregar. Limitado a 64 imágenes y 20 etiquetas por lote.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

ImageCreateSummary o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

create_images_from_predictions

Agregue las imágenes previstas especificadas al conjunto de imágenes de entrenamiento.

Esta API crea un lote de imágenes a partir de las imágenes previstas especificadas. Hay un límite de 64 imágenes y 20 etiquetas. Si todas las imágenes se crean correctamente, se devolverá el código de estado 200(OK). De lo contrario, se devolverá el código de estado 207 (estado múltiple) y se mostrará el estado detallado de cada imagen en la carga de respuesta.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

batch
ImageIdCreateBatch
Requerido

Imagen, identificadores de etiqueta y metadatos. Limitado a 64 imágenes y 20 etiquetas por lote.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

ImageCreateSummary o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

create_images_from_urls

Agregue las direcciones URL de imágenes proporcionadas al conjunto de imágenes de entrenamiento.

Esta API acepta un lote de direcciones URL y, opcionalmente, etiquetas, para crear imágenes. Hay un límite de 64 imágenes y 20 etiquetas. Si todas las imágenes se crean correctamente, se devolverá el código de estado 200(OK). De lo contrario, se devolverá el código de estado 207 (estado múltiple) y se mostrará el estado detallado de cada imagen en la carga de respuesta.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

batch
ImageUrlCreateBatch
Requerido

Direcciones URL de imagen, identificadores de etiqueta y metadatos. Limitado a 64 imágenes y 20 etiquetas por lote.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

ImageCreateSummary o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

create_project

Crear un proyecto.

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)

Parámetros

name
str
Requerido

Nombre del proyecto.

description
str
valor predeterminado: None

Descripción del proyecto.

domain_id
str
valor predeterminado: None

Identificador del dominio que se va a usar para este proyecto. El valor predeterminado es General.

classification_type
str
valor predeterminado: None

Tipo de clasificador que se va a crear para este proyecto. Entre los valores posibles se incluyen: "Multiclass", "Multilabel"

target_export_platforms
list[str]
valor predeterminado: None

Lista de plataformas a las que el modelo entrenado pretende exportar.

export_model_container_uri
str
valor predeterminado: None

El URI del contenedor de Azure Storage que se usará para almacenar los modelos exportados.

notification_queue_uri
str
valor predeterminado: None

El URI de la cola de Azure Storage que se usará para enviar notificaciones relacionadas con el proyecto. Consulte la documentación de notificaciones de almacenamiento para la configuración y el formato de mensaje.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Project o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

create_tag

Crea una etiqueta para el proyecto.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

name
str
Requerido

El nombre de la etiqueta.

description
str
valor predeterminado: None

Descripción opcional de la etiqueta.

type
str
valor predeterminado: None

Tipo opcional para la etiqueta. Entre los valores posibles se incluyen: "Regular", "Negative", "GeneralProduct"

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Tag o ClientRawResponse si raw=true

Tipo de valor devuelto

Tag,

Excepciones

delete_image_regions

Elimina un conjunto de regiones de imágenes.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

region_ids
list[str]
Requerido

Regiones que se van a eliminar. Limitado a 64.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Ninguno o ClientRawResponse si raw=true

Tipo de valor devuelto

None,

Excepciones

delete_image_tags

Quita un conjunto de etiquetas de un conjunto de imágenes.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

image_ids
list[str]
Requerido

Identificadores de imagen. Limitado a 64 imágenes.

tag_ids
list[str]
Requerido

Etiquetas que se eliminarán de las imágenes especificadas. Limitado a 20 etiquetas.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Ninguno o ClientRawResponse si raw=true

Tipo de valor devuelto

None,

Excepciones

delete_images

Elimina imágenes del conjunto de imágenes de entrenamiento.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

image_ids
list[str]
valor predeterminado: None

Identificadores de las imágenes que se van a eliminar. Limitado a 256 imágenes por lote.

all_images
bool
valor predeterminado: None

Marca para especificar la eliminación de todas las imágenes, especifique esta marca o una lista de imágenes. El uso de esta marca devolverá una respuesta 202 para indicar que se están eliminando las imágenes.

all_iterations
bool
valor predeterminado: None

Quita estas imágenes de todas las iteraciones, no solo del área de trabajo actual. El uso de esta marca devolverá una respuesta 202 para indicar que se están eliminando las imágenes.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Ninguno o ClientRawResponse si raw=true

Tipo de valor devuelto

None,

Excepciones

delete_iteration

Elimina una iteración específica de un proyecto.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

iteration_id
str
Requerido

Identificador de iteración.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Ninguno o ClientRawResponse si raw=true

Tipo de valor devuelto

None,

Excepciones

delete_prediction

Elimina un conjunto de imágenes previstas y sus resultados de predicción asociados.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

ids
list[str]
Requerido

Identificadores de predicción. Limitado a 64.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Ninguno o ClientRawResponse si raw=true

Tipo de valor devuelto

None,

Excepciones

delete_project

Elimina un proyecto específico.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Ninguno o ClientRawResponse si raw=true

Tipo de valor devuelto

None,

Excepciones

delete_tag

Elimina una etiqueta del proyecto.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

tag_id
str
Requerido

Identificador de la etiqueta que se va a eliminar.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Ninguno o ClientRawResponse si raw=true

Tipo de valor devuelto

None,

Excepciones

export_iteration

Exporta una iteración entrenada.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

iteration_id
str
Requerido

Identificador de iteración.

platform
str
Requerido

La plataforma de destino. Entre los valores posibles se incluyen: "CoreML", "TensorFlow", "DockerFile", "ONNX", "VAIDK", "OpenVino".

flavor
str
valor predeterminado: None

El tipo de la plataforma de destino. Entre los valores posibles se incluyen: "Linux", "Windows", "ONNX10", "ONNX12", "ARM", "TensorFlowNormal", "TensorFlowLite".

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Exporte o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

export_project

Exporta un proyecto.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto que se va a exportar.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

ProjectExport o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

get_artifact

Obtiene el contenido del artefacto de Blob Storage, en función de la ruta de acceso relativa del artefacto en el blob.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

path
str
Requerido

Ruta de acceso relativa del artefacto.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

callback
Callable[<xref:Bytes>, <xref:response=None>]
valor predeterminado: None

Cuando se especifique, se llamará a con cada fragmento de datos que se transmita. La devolución de llamada debe tomar dos argumentos, los bytes del fragmento actual de datos y el objeto de respuesta. Si los datos se cargan, la respuesta será Ninguna.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

object o ClientRawResponse if raw=true

Tipo de valor devuelto

Excepciones

get_domain

Obtiene información sobre un dominio específico.

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

Parámetros

domain_id
str
Requerido

Identificador del dominio sobre el que obtener información.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Domain o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

get_domains

Obtenga una lista de los dominios disponibles.

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

Parámetros

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

list o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

get_exports

Obtiene la lista de exportaciones para una iteración concreta.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

iteration_id
str
Requerido

Identificador de iteración.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

list o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

get_image_count

Obtiene el número de imágenes.

El filtrado tiene una relación de y/o. Por ejemplo, si los identificadores de etiqueta proporcionados son para las etiquetas "Dog" y "Cat", solo se devolverán las imágenes etiquetadas con Dog o Cat.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

iteration_id
str
valor predeterminado: None

Identificador de iteración. El valor predeterminado es el área de trabajo.

tagging_status
str
valor predeterminado: None

Filtro de estado de etiquetado. Puede ser "All", "Tagged" o "Untagged". El valor predeterminado es "All". Entre los valores posibles se incluyen: "All", "Tagged", "Untagged"

filter
str
valor predeterminado: None

Expresión para filtrar las imágenes con los metadatos de la imagen. Solo las imágenes en las que la expresión se evalúa como true se incluyen en la respuesta. La expresión admite operadores eq (Equal), ne (Not equal) y (Logical y) o (Logical o). Este es un ejemplo, metadata=key1 eq 'value1' y key2 ne 'value2'.

tag_ids
list[str]
valor predeterminado: None

Lista de identificadores de etiquetas para filtrar las imágenes que se van a contar. El valor predeterminado es todas las etiquetas cuando es NULL.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

int o ClientRawResponse si raw=true

Tipo de valor devuelto

int,

Excepciones

get_image_performance_count

Obtiene el número de imágenes etiquetadas con el {tagIds} proporcionado que tiene resultados de predicción del entrenamiento para la iteración proporcionada {iteraciónId}.

El filtrado tiene una relación de y/o. Por ejemplo, si los identificadores de etiqueta proporcionados son para las etiquetas "Dog" y "Cat", solo se devolverán las imágenes etiquetadas con Dog o Cat.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

iteration_id
str
Requerido

Identificador de iteración. El valor predeterminado es el área de trabajo.

tag_ids
list[str]
valor predeterminado: None

Lista de identificadores de etiquetas para filtrar las imágenes que se van a contar. El valor predeterminado es todas las etiquetas cuando es NULL.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

int o ClientRawResponse si raw=true

Tipo de valor devuelto

int,

Excepciones

get_image_performances

Obtenga la imagen con su predicción para una iteración de proyecto determinada.

Esta API admite el procesamiento por lotes y la selección de intervalos. De manera predeterminada, solo devolverá las primeras 50 imágenes que coincidan con las imágenes. Use los parámetros {take} y {skip} para controlar el número de imágenes que se van a devolver en un lote determinado. El filtrado tiene una relación de y/o. Por ejemplo, si los identificadores de etiqueta proporcionados son para las etiquetas "Dog" y "Cat", solo se devolverán las imágenes etiquetadas con Dog o 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)

Parámetros

project_id
str
Requerido

Identificador del proyecto.

iteration_id
str
Requerido

Identificador de iteración. El valor predeterminado es el área de trabajo.

tag_ids
list[str]
valor predeterminado: None

Lista de identificadores de etiquetas para filtrar las imágenes. El valor predeterminado es todas las imágenes etiquetadas cuando son NULL. Limitado a 20.

order_by
str
valor predeterminado: None

La ordenación. El valor predeterminado es el más reciente. Entre los valores posibles se incluyen: "Newest", "Oldest"

take
int
valor predeterminado: 50

Número máximo de imágenes que se van a devolver. El valor predeterminado es 50, limitado a 256.

skip
int
valor predeterminado: 0

Número de imágenes que se omitirán antes de comenzar el lote de imágenes. El valor predeterminado es 0.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

list o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

get_image_region_proposals

Obtenga propuestas de región para una imagen. Devuelve una matriz vacía si no se encuentra ninguna propuesta.

Esta API obtendrá propuestas de región para una imagen, junto con las confianzas para la región. Devuelve una matriz vacía si no se encuentra ninguna propuesta.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

image_id
str
Requerido

Id. de imagen.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

ImageRegionProposal o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

get_images

Obtiene imágenes para una iteración o un área de trabajo de un proyecto determinado.

Esta API admite el procesamiento por lotes y la selección de intervalos. De manera predeterminada, solo devolverá las primeras 50 imágenes que coincidan con las imágenes. Use los parámetros {take} y {skip} para controlar el número de imágenes que se van a devolver en un lote determinado. El filtrado tiene una relación de y/o. Por ejemplo, si los identificadores de etiqueta proporcionados son para las etiquetas "Dog" y "Cat", solo se devolverán las imágenes etiquetadas con Dog o 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)

Parámetros

project_id
str
Requerido

Identificador del proyecto.

iteration_id
str
valor predeterminado: None

Identificador de iteración. El valor predeterminado es el área de trabajo.

tag_ids
list[str]
valor predeterminado: None

Lista de identificadores de etiquetas para filtrar las imágenes. El valor predeterminado es todas las imágenes etiquetadas cuando son NULL. Limitado a 20.

tagging_status
str
valor predeterminado: None

Filtro de estado de etiquetado. Puede ser "All", "Tagged" o "Untagged". El valor predeterminado es "All". Entre los valores posibles se incluyen: "All", "Tagged", "Untagged"

filter
str
valor predeterminado: None

Expresión para filtrar las imágenes con los metadatos de la imagen. Solo las imágenes en las que la expresión se evalúa como true se incluyen en la respuesta. La expresión admite operadores eq (Equal), ne (Not equal) y (Logical y) o (Logical o). Este es un ejemplo, metadata=key1 eq 'value1' y key2 ne 'value2'.

order_by
str
valor predeterminado: None

La ordenación. El valor predeterminado es el más reciente. Entre los valores posibles se incluyen: "Newest", "Oldest"

take
int
valor predeterminado: 50

Número máximo de imágenes que se van a devolver. El valor predeterminado es 50, limitado a 256.

skip
int
valor predeterminado: 0

Número de imágenes que se omitirán antes de comenzar el lote de imágenes. El valor predeterminado es 0.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

list o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

get_images_by_ids

Obtiene imágenes por identificador para una iteración de proyecto determinada.

Esta API devolverá un conjunto de imágenes para las etiquetas especificadas y, opcionalmente, la iteración. Si no se especifica ninguna iteración, se usa el área de trabajo actual.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

image_ids
list[str]
valor predeterminado: None

Lista de identificadores de imagen que se van a recuperar. Limitado a 256.

iteration_id
str
valor predeterminado: None

Identificador de iteración. El valor predeterminado es el área de trabajo.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

list o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

get_iteration

Obtiene una iteración concreta.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto al que pertenece la iteración.

iteration_id
str
Requerido

Identificador de la iteración que se va a obtener.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Iteración o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

get_iteration_performance

Obtiene información detallada sobre el rendimiento de una iteración.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto al que pertenece la iteración.

iteration_id
str
Requerido

Identificador de la iteración que se va a obtener.

threshold
float
valor predeterminado: None

Umbral utilizado para determinar las predicciones verdaderas.

overlap_threshold
float
valor predeterminado: None

Si procede, el umbral de superposición del rectángulo de límite usado para determinar las predicciones verdaderas.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

IteraciónPerformance o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

get_iterations

Obtenga iteraciones para el proyecto.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

list o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

get_project

Obtiene un proyecto específico.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto que se va a obtener.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Project o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

get_projects

Obtenga los proyectos.

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

Parámetros

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

list o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

get_tag

Obtiene información sobre una etiqueta específica.

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

Parámetros

project_id
str
Requerido

El proyecto al que pertenece esta etiqueta.

tag_id
str
Requerido

Identificador de etiqueta.

iteration_id
str
valor predeterminado: None

Iteración de la que se va a recuperar esta etiqueta. Opcional, el valor predeterminado es el conjunto de entrenamiento actual.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Tag o ClientRawResponse si raw=true

Tipo de valor devuelto

Tag,

Excepciones

get_tagged_image_count

Obtiene el número de imágenes etiquetadas con el {tagIds} proporcionado.

El filtrado tiene una relación de y/o. Por ejemplo, si los identificadores de etiqueta proporcionados son para las etiquetas "Dog" y "Cat", solo se devolverán las imágenes etiquetadas con Dog o Cat.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

iteration_id
str
valor predeterminado: None

Identificador de iteración. El valor predeterminado es el área de trabajo.

tag_ids
list[str]
valor predeterminado: None

Lista de identificadores de etiquetas para filtrar las imágenes que se van a contar. El valor predeterminado es todas las etiquetas cuando es NULL.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

int o ClientRawResponse si raw=true

Tipo de valor devuelto

int,

Excepciones

get_tagged_images

Obtiene imágenes etiquetadas para una iteración de proyecto determinada.

Esta API admite el procesamiento por lotes y la selección de intervalos. De manera predeterminada, solo devolverá las primeras 50 imágenes que coincidan con las imágenes. Use los parámetros {take} y {skip} para controlar el número de imágenes que se van a devolver en un lote determinado. El filtrado tiene una relación de y/o. Por ejemplo, si los identificadores de etiqueta proporcionados son para las etiquetas "Dog" y "Cat", solo se devolverán las imágenes etiquetadas con Dog o 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)

Parámetros

project_id
str
Requerido

Identificador del proyecto.

iteration_id
str
valor predeterminado: None

Identificador de iteración. El valor predeterminado es el área de trabajo.

tag_ids
list[str]
valor predeterminado: None

Lista de identificadores de etiquetas para filtrar las imágenes. El valor predeterminado es todas las imágenes etiquetadas cuando son NULL. Limitado a 20.

order_by
str
valor predeterminado: None

La ordenación. El valor predeterminado es el más reciente. Entre los valores posibles se incluyen: "Newest", "Oldest"

take
int
valor predeterminado: 50

Número máximo de imágenes que se van a devolver. El valor predeterminado es 50, limitado a 256.

skip
int
valor predeterminado: 0

Número de imágenes que se omitirán antes de comenzar el lote de imágenes. El valor predeterminado es 0.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

list o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

get_tags

Obtenga las etiquetas de un proyecto determinado y la iteración.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

iteration_id
str
valor predeterminado: None

Identificador de iteración. El valor predeterminado es el área de trabajo.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

list o ClientRawResponse si raw=true

Tipo de valor devuelto

list[Tag],

Excepciones

get_untagged_image_count

Obtiene el número de imágenes sin etiquetar.

Esta API devuelve las imágenes que no tienen etiquetas para un proyecto determinado y, opcionalmente, una iteración. Si no se especifica ninguna iteración, se usa el área de trabajo actual.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

iteration_id
str
valor predeterminado: None

Identificador de iteración. El valor predeterminado es el área de trabajo.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

int o ClientRawResponse si raw=true

Tipo de valor devuelto

int,

Excepciones

get_untagged_images

Obtiene imágenes sin etiquetar para una iteración de proyecto determinada.

Esta API admite el procesamiento por lotes y la selección de intervalos. De manera predeterminada, solo devolverá las primeras 50 imágenes que coincidan con las imágenes. Use los parámetros {take} y {skip} para controlar el número de imágenes que se van a devolver en un lote determinado.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

iteration_id
str
valor predeterminado: None

Identificador de iteración. El valor predeterminado es el área de trabajo.

order_by
str
valor predeterminado: None

La ordenación. El valor predeterminado es el más reciente. Entre los valores posibles se incluyen: "Newest", "Oldest"

take
int
valor predeterminado: 50

Número máximo de imágenes que se van a devolver. El valor predeterminado es 50, limitado a 256.

skip
int
valor predeterminado: 0

Número de imágenes que se omitirán antes de comenzar el lote de imágenes. El valor predeterminado es 0.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

list o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

import_project

Importa un proyecto.

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

Parámetros

token
str
Requerido

Token generado a partir de la llamada al proyecto de exportación.

name
str
valor predeterminado: None

Opcional, nombre del proyecto que se va a usar en lugar de nombre generado automáticamente.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Project o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

publish_iteration

Publica una iteración concreta.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

iteration_id
str
Requerido

Identificador de iteración.

publish_name
str
Requerido

Nombre que se va a asignar a la iteración publicada.

prediction_id
str
Requerido

Identificador del recurso de predicción en el que se va a publicar.

overwrite
bool
valor predeterminado: None

Si se va a sobrescribir el modelo publicado con el nombre especificado (valor predeterminado: false).

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

bool o ClientRawResponse si raw=true

Tipo de valor devuelto

bool,

Excepciones

query_predictions

Obtiene las imágenes que se enviaron al punto de conexión de predicción.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

query
PredictionQueryToken
Requerido

Parámetros usados para consultar las predicciones. Limitado a combinar 2 etiquetas.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

PredictionQueryResult o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

query_suggested_image_count

Obtiene el recuento de imágenes cuyas etiquetas sugeridas coinciden con las etiquetas dadas y sus probabilidades son mayores o iguales que el umbral especificado. Devuelve el recuento como 0 si no se encuentra ninguno.

Esta API toma id. de etiquetas para obtener el recuento de imágenes no etiquetadas por etiquetas sugeridas para un umbral determinado.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

iteration_id
str
Requerido

IteraciónId que se va a usar para las etiquetas y regiones sugeridas.

tag_ids
list[str]
valor predeterminado: None

TagIds existentes en el proyecto para obtener el recuento de etiquetas sugeridas.

threshold
float
valor predeterminado: None

Umbral de confianza en el que filtrar las etiquetas sugeridas.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

dict o ClientRawResponse si raw=true

Tipo de valor devuelto

dict[str, int],

Excepciones

query_suggested_images

Obtiene imágenes sin etiqueta cuyas etiquetas sugeridas coinciden con etiquetas dadas. Devuelve una matriz vacía si no se encuentra ninguna imagen.

Esta API capturará las imágenes no etiquetadas filtradas por identificadores de etiquetas sugeridos. Devuelve una matriz vacía si no se encuentra ninguna imagen.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

iteration_id
str
Requerido

IteraciónId que se va a usar para las etiquetas y regiones sugeridas.

query
SuggestedTagAndRegionQueryToken
Requerido

Contiene las propiedades que necesitamos para consultar imágenes sugeridas.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

SuggestedTagAndRegionQuery o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

quick_test_image

Realiza una prueba rápida de una imagen.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

image_data
Generator
Requerido

Datos de imagen binaria. Los formatos admitidos son JPEG, GIF, PNG y BMP. Admite imágenes de hasta 6 MB.

iteration_id
str
valor predeterminado: None

Opcional. Especifica el identificador de una iteración determinada con la que se va a evaluar. La iteración predeterminada para el proyecto se usará cuando no se especifique.

store
bool
valor predeterminado: True

Opcional. Especifica si se va a almacenar o no el resultado de esta predicción. El valor predeterminado es true para almacenar.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

ImagePrediction o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

quick_test_image_url

Realiza una prueba rápida de la dirección URL de una imagen.

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

Parámetros

project_id
str
Requerido

Proyecto con el que se va a evaluar.

url
str
Requerido

Dirección URL de la imagen.

iteration_id
str
valor predeterminado: None

Opcional. Especifica el identificador de una iteración determinada con la que se va a evaluar. La iteración predeterminada para el proyecto se usará cuando no se especifique.

store
bool
valor predeterminado: True

Opcional. Especifica si se va a almacenar o no el resultado de esta predicción. El valor predeterminado es true para almacenar.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

ImagePrediction o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

suggest_tags_and_regions

Sugerir etiquetas y regiones para una matriz o lote de imágenes sin etiquetar. Devuelve una matriz vacía si no se encuentra ninguna etiqueta.

Esta API obtendrá etiquetas y regiones sugeridas para una matriz o lote de imágenes sin etiquetar, junto con las confianzas de las etiquetas. Devuelve una matriz vacía si no se encuentra ninguna etiqueta. Hay un límite de 64 imágenes en el lote.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

iteration_id
str
Requerido

IteraciónId que se va a usar para la sugerencia de etiqueta y región.

image_ids
list[str]
Requerido

Se necesita una matriz de sugerencias de etiqueta de identificadores de imagen. Use getUntaggedImages API para obtener imageIds.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

list o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

train_project

Pone en cola el proyecto para entrenamiento.

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)

Parámetros

project_id
str
Requerido

Identificador del proyecto.

training_type
str
valor predeterminado: None

Tipo de entrenamiento que se va a usar para entrenar el proyecto (valor predeterminado: Normal). Entre los valores posibles se incluyen: "Regular", "Advanced"

reserved_budget_in_hours
int
valor predeterminado: 0

Número de horas reservadas como presupuesto para el entrenamiento (si procede).

force_train
bool
valor predeterminado: False

Si se va a forzar el entrenamiento aunque el conjunto de datos y la configuración no cambien (valor predeterminado: false).

notification_email_address
str
valor predeterminado: None

Dirección de correo electrónico a la que se enviará una notificación cuando finalice el entrenamiento (valor predeterminado: null).

selected_tags
list[str]
valor predeterminado: None

Lista de etiquetas seleccionadas para esta sesión de entrenamiento, se omitirán otras etiquetas del proyecto.

custom_base_model_info
CustomBaseModelInfo
valor predeterminado: None

Información de la iteración previamente entrenada que proporciona el modelo base para el entrenamiento de la iteración actual.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Iteración o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

unpublish_iteration

Cancela la publicación de una iteración concreta.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

iteration_id
str
Requerido

Identificador de iteración.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Ninguno o ClientRawResponse si raw=true

Tipo de valor devuelto

None,

Excepciones

update_image_metadata

Actualice los metadatos de las imágenes.

Esta API acepta un lote de identificadores de imagen y metadatos para actualizar imágenes. Hay un límite de 64 imágenes.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

image_ids
list[str]
Requerido

Lista de identificadores de imagen que se van a actualizar. Limitado a 64.

metadata
dict[str, str]
Requerido

Metadatos que se van a actualizar a las imágenes especificadas. Limitado a 10 pares clave-valor por imagen. La longitud de la clave está limitada a 128. La longitud del valor está limitada a 256.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

ImageMetadataUpdateSummary o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

update_iteration

Actualiza una iteración concreta.

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

Parámetros

project_id
str
Requerido

Id. del proyecto.

iteration_id
str
Requerido

Id. de iteración.

name
str
Requerido

Obtiene o establece el nombre de la iteración.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Iteración o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

update_project

Actualiza un proyecto específico.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto que se va a actualizar.

updated_project
Project
Requerido

Modelo de proyecto actualizado.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Project o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

update_tag

Actualiza una etiqueta.

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

Parámetros

project_id
str
Requerido

Identificador del proyecto.

tag_id
str
Requerido

Identificador de la etiqueta de destino.

updated_tag
Tag
Requerido

Modelo de etiqueta actualizado.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Tag o ClientRawResponse si raw=true

Tipo de valor devuelto

Tag,

Excepciones