Skip to content

smartTool.interactiveSegmentation.created

Python model

SmartToolInteractiveSegmentationCreatedEvent — from kili_events import SmartToolInteractiveSegmentationCreatedEvent

Description

This event is raised once the interactive-segmentation service completes an interactive segmentation request. It is used to track smart tool usage per organization.

Properties

event

  • Required
  • The name of the event.
  • Constant value: "smartTool.interactiveSegmentation.created"

project_id

  • Required
  • Type: string
  • Id of the project in which the smart tool was used.

user_id

  • Required
  • Type: string
  • Id of the user who used the smart tool.

organization_id

  • Required
  • Type: string
  • Id of the organization in which the action was done. For project related event, it references the project author organization.

payload

  • Required
  • Type: object
  • Client-relevant metadata about the interactive segmentation run.
  • Properties
    • model_name
      • Required
      • Type: string
      • Name of the model that served the request, including its variant/size (e.g. SAM2_tiny, EfficientTAM_ti_512x512).

event

  • Required
  • The name of the event.
  • Constant value: "smartTool.interactiveSegmentation.created"

projectId

  • Required
  • Type: string
  • Id of the project in which the smart tool was used.

userId

  • Required
  • Type: string
  • Id of the user who used the smart tool.

organizationId

  • Required
  • Type: string
  • Id of the organization in which the action was done. For project related event, it references the project author organization.

payload

  • Required
  • Type: object
  • Client-relevant metadata about the interactive segmentation run.
  • Properties
    • modelName
      • Required
      • Type: string
      • Name of the model that served the request, including its variant/size (e.g. SAM2_tiny, EfficientTAM_ti_512x512).