Skip to content

pixano_inference.routers.tasks.video

API routes for Image tasks.

delete_video_mask_generation(task_id) async

Delete a mask generation task.

Source code in pixano_inference/routers/tasks/video.py
@router.delete("/mask_generation/{task_id}", response_model=None)
async def delete_video_mask_generation(task_id: str) -> None:
    """Delete a mask generation task."""
    return await delete_task(task_id=task_id)

get_video_mask_generation(task_id) async

Get the result of a mask generation task.

Parameters:

Name Type Description Default
task_id str

ID of the task to retrieve.

required

Returns:

Type Description
VideoMaskGenerationResponse | CeleryTask

Response for mask generation.

Source code in pixano_inference/routers/tasks/video.py
@router.get("/mask_generation/{task_id}", response_model=VideoMaskGenerationResponse | CeleryTask)
async def get_video_mask_generation(task_id: str) -> VideoMaskGenerationResponse | CeleryTask:
    """Get the result of a mask generation task.

    Args:
        task_id: ID of the task to retrieve.

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

video_mask_generation(request, settings) async

Generate mask from a video and optionnaly points and bboxes.

Parameters:

Name Type Description Default
request VideoMaskGenerationRequest

Request for mask generation.

required
settings Annotated[Settings, Depends(get_pixano_inference_settings)]

Settings of the app.

required

Returns:

Type Description
CeleryTask

Response for mask generation.

Source code in pixano_inference/routers/tasks/video.py
@router.post("/mask_generation/", response_model=CeleryTask)
async def video_mask_generation(
    request: VideoMaskGenerationRequest,
    settings: Annotated[Settings, Depends(get_pixano_inference_settings)],
) -> CeleryTask:
    """Generate mask from a video and optionnaly points and bboxes.

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

    Returns:
        Response for mask generation.
    """
    return await execute_task_request(request=request, task=VideoTask.MASK_GENERATION, settings=settings)