pixano_inference.routers.tasks.image

API routes for Image tasks.

delete_mask_generation(task_id) async

Delete a image mask generation task.

Source code in pixano_inference/routers/tasks/image.py

@router.delete("/mask_generation/{task_id}", response_model=None)
async def delete_mask_generation(task_id: str) -> None:
    """Delete a image mask generation task."""
    return await delete_task(task_id=task_id)

delete_zero_shot_detection(task_id) async

Delete a image zero shot detection task.

Source code in pixano_inference/routers/tasks/image.py

@router.delete("/zero_shot_detection/{task_id}", response_model=None)
async def delete_zero_shot_detection(task_id: str) -> None:
    """Delete a image zero shot detection task."""
    return await delete_task(task_id=task_id)

get_mask_generation(task_id) async

Get the result of a image mask generation task.

Parameters:

Name	Type	Description	Default
task_id	str	ID of the task to retrieve.	required

Returns:

Type	Description
ImageMaskGenerationResponse | CeleryTask	Response for image mask generation.

Source code in pixano_inference/routers/tasks/image.py

@router.get("/mask_generation/{task_id}", response_model=ImageMaskGenerationResponse | CeleryTask)
async def get_mask_generation(task_id: str) -> ImageMaskGenerationResponse | CeleryTask:
    """Get the result of a image mask generation task.

    Args:
        task_id: ID of the task to retrieve.

    Returns:
        Response for image mask generation.
    """
    return await get_task_result(task_id, response_type=ImageMaskGenerationResponse)

get_zero_shot_detection(task_id) async

Get the result of a image zero shot detection task.

Parameters:

Name	Type	Description	Default
task_id	str	ID of the task to retrieve.	required

Returns:

Type	Description
ImageZeroShotDetectionResponse | CeleryTask	Response for image zero shot detection.

Source code in pixano_inference/routers/tasks/image.py

@router.get("/zero_shot_detection/{task_id}", response_model=ImageZeroShotDetectionResponse | CeleryTask)
async def get_zero_shot_detection(task_id: str) -> ImageZeroShotDetectionResponse | CeleryTask:
    """Get the result of a image zero shot detection task.

    Args:
        task_id: ID of the task to retrieve.

    Returns:
        Response for image zero shot detection.
    """
    return await get_task_result(task_id, response_type=ImageZeroShotDetectionResponse)

mask_generation(request, settings) async

Generate mask from an image and optionnaly points and bboxes.

Parameters:

Name	Type	Description	Default
request	ImageMaskGenerationRequest	Request for image mask generation.	required
settings	Annotated[Settings, Depends(get_pixano_inference_settings)]	Settings of the app.	required

Returns:

Type	Description
CeleryTask	Id and status of the task.

Source code in pixano_inference/routers/tasks/image.py

@router.post("/mask_generation/", response_model=CeleryTask)
async def mask_generation(
    request: ImageMaskGenerationRequest,
    settings: Annotated[Settings, Depends(get_pixano_inference_settings)],
) -> CeleryTask:
    """Generate mask from an image and optionnaly points and bboxes.

    Args:
        request: Request for image mask generation.
        settings: Settings of the app.

    Returns:
        Id and status of the task.
    """
    return await execute_task_request(request=request, task=ImageTask.MASK_GENERATION, settings=settings)

zero_shot_detection(request, settings) async

Perform zero shot detection on an image.

Parameters:

Name	Type	Description	Default
request	ImageZeroShotDetectionRequest	Request for image zero shot detection.	required
settings	Annotated[Settings, Depends(get_pixano_inference_settings)]	Settings of the app.	required

Returns:

Type	Description
CeleryTask	Id and status of the task.

Source code in pixano_inference/routers/tasks/image.py

@router.post("/zero_shot_detection/", response_model=CeleryTask)
async def zero_shot_detection(
    request: ImageZeroShotDetectionRequest,
    settings: Annotated[Settings, Depends(get_pixano_inference_settings)],
) -> CeleryTask:
    """Perform zero shot detection on an image.

    Args:
        request: Request for image zero shot detection.
        settings: Settings of the app.

    Returns:
        Id and status of the task.
    """
    return await execute_task_request(request=request, task=ImageTask.ZERO_SHOT_DETECTION, settings=settings)