create_issue

imerit_ango.sdk.SDK.

create_issue(task_id, content, content_mentions, object_id, position, error_codes, pct_details)

Creates an issue for the specified task based on the provided configuration parameters.

Parameters

• task_id: string

  • ID of the task where the issue will be created. Task IDs can be obtained from the UI and from get_tasks.

  • Example: "0000000aa0a00a0000aaaa0a"

• content: string

  • The text content of the issue.

  • Example: "The bounding box here should reach the edges."

• content_mentions: List[dict]

  • List of users to mention in the issue content.

  • Example: [{"userEmail":"[email protected]"}]

• object_id: string

  • ID of the object the issue is related to. If provided, the issue is attached to this object.

• position: List[int]

  • Position, in pixels, of where the issue should be placed on the image asset.

  • Example: [25, 15]

• error_codes: List[dict]

  • Error codes to associate with the issue.

  • Example: [{"category": "Wrong", "name": "Class", "key": "Wrong+Class"}]

• pct_details: dict

  • Optional PCT-specific metadata for the issue.

Returns:

• output: dict

  • A dictionary containing the result of the operation.

Example

Create an issue on a task

python

import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')
project_id = os.getenv('PROJECT_ID')

ango_sdk = SDK(api_key)

task_id = "<YOUR TASK ID>"
content = "There is an inconsistency in the annotation."

ango_sdk.create_issue(task_id=task_id, content=content)

curl

Create an issue on a specific object

python

import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')
project_id = os.getenv('PROJECT_ID')

ango_sdk = SDK(api_key)

task_id = "<YOUR TASK ID>"
content = "This object seems incorrectly labeled."
object_id = "<YOUR OBJECT ID>"

ango_sdk.create_issue(task_id=task_id, content=content, object_id=object_id)

curl

Create an issue at a specified location

python

import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')
project_id = os.getenv('PROJECT_ID')

ango_sdk = SDK(api_key)

task_id = "<YOUR TASK ID>"
content = "Please review this area."
position = [25, 15]

ango_sdk.create_issue(task_id=task_id, content=content, position=position)

curl

Mention a user in the issue content

python

import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')
project_id = os.getenv('PROJECT_ID')

ango_sdk = SDK(api_key)

task_id = "<YOUR TASK ID>"
content = "Can you take a look at this @[email protected]?"
content_mentions = [{"userEmail":"[email protected]"}]

ango_sdk.create_issue(task_id=task_id, content=content, content_mentions=content_mentions)

curl

Create an issue on an object and attach an error code to it

python

import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')
project_id = os.getenv('PROJECT_ID')

ango_sdk = SDK(api_key)

task_id = "<YOUR TASK ID>"
content = "Wrong class assigned to this object."
object_id = "<YOUR OBJECT ID>"
error_codes = [{"category": "Wrong", "name": "Class", "key": "Wrong+Class"}]

ango_sdk.create_issue(task_id=task_id, content=content, object_id=object_id, error_codes=error_codes)

curl

See also

get_issues, delete_issue