Skip to content
Scenario Docs
Get started
API Reference
Models

Training Images

Add
models.training_images.add(strmodel_id, TrainingImageAddParams**kwargs) -> TrainingImageAddResponse
POST/models/{modelId}/training-images
Replace Pairs
models.training_images.replace_pairs(strmodel_id, TrainingImageReplacePairsParams**kwargs) -> TrainingImageReplacePairsResponse
PUT/models/{modelId}/training-images/pairs
Replace
models.training_images.replace(strtraining_image_id, TrainingImageReplaceParams**kwargs) -> TrainingImageReplaceResponse
PUT/models/{modelId}/training-images/{trainingImageId}
Delete
models.training_images.delete(strtraining_image_id, TrainingImageDeleteParams**kwargs) -> object
DELETE/models/{modelId}/training-images/{trainingImageId}
ModelsExpand Collapse
class TrainingImageAddResponse: …
training_image: TrainingImage
id: str

The training image ID (example: “asset_GTrL3mq4SXWyMxkOHRxlpw”)

automatic_captioning: str

Automatic captioning of the image

created_at: str

The training image upload date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

description: str

Description for the image

download_url: str

The URL of the image

name: str

The original file name of the image (example: “my-training-image.jpg”)

class TrainingImageReplacePairsResponse: …
count: float

Number of training image pairs

pairs: List[Pair]

Array of training image pairs

instruction: Optional[str]

The instruction for the image pair, source to target

source_id: Optional[str]

The source asset ID (must be a training asset)

target_id: Optional[str]

The target asset ID (must be a training asset)

class TrainingImageReplaceResponse: …
training_image: TrainingImage
id: str

The training image ID (example: “asset_GTrL3mq4SXWyMxkOHRxlpw”)

automatic_captioning: str

Automatic captioning of the image

created_at: str

The training image upload date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

description: str

Description for the image

download_url: str

The URL of the image

name: str

The original file name of the image (example: “my-training-image.jpg”)