QualityApi class reference

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    rq_id = "rq_id_example" # str | The report creation request id. Can be specified to check the report creation status.  (optional)
    quality_report_create_request = QualityReportCreateRequest(
        task_id=1,
        project_id=1,
    ) # QualityReportCreateRequest |  (optional)

    try:
        (data, response) = api_client.quality_api.create_report(
            rq_id=rq_id,
            quality_report_create_request=quality_report_create_request,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling QualityApi.create_report(): %s\n" % e)

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    quality_requirement_request = QualityRequirementRequest(
        settings_id=1,
        name="name_example",
        sort_order=-2147483648,
        filter="filter_example",
        enabled=True,
        annotation_type=PatchedQualityRequirementRequestAnnotationType(None),
        metric=PatchedQualityRequirementRequestMetric(None),
        required_score=0,
        parent_requirement=1,
        iou_threshold=0,
        point_size=0,
        point_size_base=PatchedQualityRequirementRequestPointSizeBase(None),
        line_thickness=0,
        match_orientation=True,
        line_orientation_threshold=0,
        match_groups=True,
        group_match_threshold=0,
        check_covered_annotations=True,
        object_visibility_threshold=0,
        panoptic_comparison=True,
        attribute_comparison=PatchedQualityRequirementRequestAttributeComparison(None),
    ) # QualityRequirementRequest |  (optional)

    try:
        (data, response) = api_client.quality_api.create_settings_requirements(
            quality_requirement_request=quality_requirement_request,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling QualityApi.create_settings_requirements(): %s\n" % e)

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    quality_requirement_bulk_create_request = QualityRequirementBulkCreateRequest(
        settings_id=1,
        requirements=[
            QualityRequirementBulkCreateNodeRequest(
                name="name_example",
                sort_order=-2147483648,
                filter="filter_example",
                enabled=True,
                annotation_type=PatchedQualityRequirementRequestAnnotationType(None),
                metric=PatchedQualityRequirementRequestMetric(None),
                required_score=0,
                parent_requirement=1,
                iou_threshold=0,
                point_size=0,
                point_size_base=PatchedQualityRequirementRequestPointSizeBase(None),
                line_thickness=0,
                match_orientation=True,
                line_orientation_threshold=0,
                match_groups=True,
                group_match_threshold=0,
                check_covered_annotations=True,
                object_visibility_threshold=0,
                panoptic_comparison=True,
                attribute_comparison=PatchedQualityRequirementRequestAttributeComparison(None),
                children=[
                    QualityRequirementBulkCreateNodeRequest(),
                ],
            ),
        ],
    ) # QualityRequirementBulkCreateRequest | 

    try:
        (data, response) = api_client.quality_api.create_settings_requirements_bulk(
            quality_requirement_bulk_create_request,)
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling QualityApi.create_settings_requirements_bulk(): %s\n" % e)

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    id = 1 # int | A unique integer value identifying this quality requirement.

    try:
        api_client.quality_api.destroy_settings_requirements(
            id,)
    except exceptions.ApiException as e:
        print("Exception when calling QualityApi.destroy_settings_requirements(): %s\n" % e)

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    x_organization = "X-Organization_example" # str | Organization unique slug (optional)
    filter = "filter_example" # str |  JSON Logic filter. This filter can be used to perform complex filtering by grouping rules.  For example, using such a filter you can get all resources created by you:      - {\"and\":[{\"==\":[{\"var\":\"owner\"},\"<user>\"]}]}  Details about the syntax used can be found at the link: https://jsonlogic.com/   Available filter_fields: ['frame', 'id', 'job_id', 'project_id', 'severity', 'task_id', 'type']. (optional)
    frame = 1 # int | A simple equality filter for the frame field (optional)
    job_id = 1 # int | A simple equality filter for the job_id field (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)
    page = 1 # int | A page number within the paginated result set. (optional)
    page_size = 1 # int | Number of results to return per page. (optional)
    project_id = 1 # int | A simple equality filter for the project_id field (optional)
    report_id = 1 # int | A simple equality filter for report id (optional)
    severity = "error" # str | A simple equality filter for the severity field (optional) if omitted the server will use the default value of "error"
    sort = "sort_example" # str | Which field to use when ordering the results. Available ordering_fields: ['frame', 'id', 'job_id', 'project_id', 'severity', 'task_id', 'type'] (optional)
    task_id = 1 # int | A simple equality filter for the task_id field (optional)
    type = "missing_annotation" # str | A simple equality filter for the type field (optional)

    try:
        (data, response) = api_client.quality_api.list_conflicts(
            x_organization=x_organization,
            filter=filter,
            frame=frame,
            job_id=job_id,
            org=org,
            org_id=org_id,
            page=page,
            page_size=page_size,
            project_id=project_id,
            report_id=report_id,
            severity=severity,
            sort=sort,
            task_id=task_id,
            type=type,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling QualityApi.list_conflicts(): %s\n" % e)

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    x_organization = "X-Organization_example" # str | Organization unique slug (optional)
    filter = "filter_example" # str |  JSON Logic filter. This filter can be used to perform complex filtering by grouping rules.  For example, using such a filter you can get all resources created by you:      - {\"and\":[{\"==\":[{\"var\":\"owner\"},\"<user>\"]}]}  Details about the syntax used can be found at the link: https://jsonlogic.com/   Available filter_fields: ['created_date', 'gt_last_updated', 'id', 'job_id', 'project_id', 'target_last_updated', 'task_id']. (optional)
    include_legacy = False # bool | Include reports stored in the legacy data format (optional) if omitted the server will use the default value of False
    job_id = 1 # int | A simple equality filter for the job_id field (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)
    page = 1 # int | A page number within the paginated result set. (optional)
    page_size = 1 # int | Number of results to return per page. (optional)
    parent_id = 1 # int | A simple equality filter for parent id (optional)
    project_id = 1 # int | A simple equality filter for project id (optional)
    sort = "sort_example" # str | Which field to use when ordering the results. Available ordering_fields: ['created_date', 'gt_last_updated', 'id', 'job_id', 'project_id', 'target_last_updated', 'task_id'] (optional)
    target = "job" # str | A simple equality filter for target (optional)
    task_id = 1 # int | A simple equality filter for task id (optional)

    try:
        (data, response) = api_client.quality_api.list_reports(
            x_organization=x_organization,
            filter=filter,
            include_legacy=include_legacy,
            job_id=job_id,
            org=org,
            org_id=org_id,
            page=page,
            page_size=page_size,
            parent_id=parent_id,
            project_id=project_id,
            sort=sort,
            target=target,
            task_id=task_id,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling QualityApi.list_reports(): %s\n" % e)

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    x_organization = "X-Organization_example" # str | Organization unique slug (optional)
    filter = "filter_example" # str |  JSON Logic filter. This filter can be used to perform complex filtering by grouping rules.  For example, using such a filter you can get all resources created by you:      - {\"and\":[{\"==\":[{\"var\":\"owner\"},\"<user>\"]}]}  Details about the syntax used can be found at the link: https://jsonlogic.com/   Available filter_fields: ['created_date', 'id', 'inherit', 'project_id', 'task_id', 'updated_date']. (optional)
    inherit = True # bool | A simple equality filter for the inherit field (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)
    page = 1 # int | A page number within the paginated result set. (optional)
    page_size = 1 # int | Number of results to return per page. (optional)
    parent_type = "project" # str | A simple equality filter for parent instance type (optional)
    project_id = 1 # int | A simple equality filter for project id (optional)
    sort = "sort_example" # str | Which field to use when ordering the results. Available ordering_fields: ['created_date', 'id', 'inherit', 'project_id', 'task_id', 'updated_date'] (optional)
    task_id = 1 # int | A simple equality filter for the task_id field (optional)

    try:
        (data, response) = api_client.quality_api.list_settings(
            x_organization=x_organization,
            filter=filter,
            inherit=inherit,
            org=org,
            org_id=org_id,
            page=page,
            page_size=page_size,
            parent_type=parent_type,
            project_id=project_id,
            sort=sort,
            task_id=task_id,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling QualityApi.list_settings(): %s\n" % e)

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    x_organization = "X-Organization_example" # str | Organization unique slug (optional)
    annotation_type = "tag" # str | A simple equality filter for the annotation_type field (optional)
    enabled = True # bool | A simple equality filter for the enabled field (optional)
    filter = "filter_example" # str |  JSON Logic filter. This filter can be used to perform complex filtering by grouping rules.  For example, using such a filter you can get all resources created by you:      - {\"and\":[{\"==\":[{\"var\":\"owner\"},\"<user>\"]}]}  Details about the syntax used can be found at the link: https://jsonlogic.com/   Available filter_fields: ['annotation_type', 'created_date', 'enabled', 'id', 'project_id', 'settings_id', 'task_id', 'updated_date']. (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)
    page = 1 # int | A page number within the paginated result set. (optional)
    page_size = 1 # int | Number of results to return per page. (optional)
    project_id = 1 # int | Project id filter (optional)
    settings_id = 1 # int | Settings id filter (optional)
    sort = "sort_example" # str | Which field to use when ordering the results. Available ordering_fields: ['annotation_type', 'created_date', 'enabled', 'id', 'name', 'project_id', 'settings_id', 'sort_order', 'task_id', 'updated_date'] (optional)
    task_id = 1 # int | Task id filter (optional)

    try:
        (data, response) = api_client.quality_api.list_settings_requirements(
            x_organization=x_organization,
            annotation_type=annotation_type,
            enabled=enabled,
            filter=filter,
            org=org,
            org_id=org_id,
            page=page,
            page_size=page_size,
            project_id=project_id,
            settings_id=settings_id,
            sort=sort,
            task_id=task_id,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling QualityApi.list_settings_requirements(): %s\n" % e)

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    id = 1 # int | An id of a quality settings instance
    patched_quality_settings_request = PatchedQualitySettingsRequest(
        job_filter="job_filter_example",
        inherit=True,
        max_validations_per_job=0,
        requirements=[
            QualityRequirementListItemRequest(
                settings_id=1,
                name="name_example",
                sort_order=-2147483648,
                filter="filter_example",
                enabled=True,
                annotation_type=PatchedQualityRequirementRequestAnnotationType(None),
                metric=PatchedQualityRequirementRequestMetric(None),
                required_score=0,
                parent_requirement=1,
                iou_threshold=0,
                point_size=0,
                point_size_base=PatchedQualityRequirementRequestPointSizeBase(None),
                line_thickness=0,
                match_orientation=True,
                line_orientation_threshold=0,
                match_groups=True,
                group_match_threshold=0,
                check_covered_annotations=True,
                object_visibility_threshold=0,
                panoptic_comparison=True,
                attribute_comparison=PatchedQualityRequirementRequestAttributeComparison(None),
            ),
        ],
    ) # PatchedQualitySettingsRequest |  (optional)

    try:
        (data, response) = api_client.quality_api.partial_update_settings(
            id,
            patched_quality_settings_request=patched_quality_settings_request,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling QualityApi.partial_update_settings(): %s\n" % e)

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    id = 1 # int | A unique integer value identifying this quality requirement.
    patched_quality_requirement_request = PatchedQualityRequirementRequest(
        settings_id=1,
        name="name_example",
        sort_order=-2147483648,
        filter="filter_example",
        enabled=True,
        annotation_type=PatchedQualityRequirementRequestAnnotationType(None),
        metric=PatchedQualityRequirementRequestMetric(None),
        required_score=0,
        parent_requirement=1,
        iou_threshold=0,
        point_size=0,
        point_size_base=PatchedQualityRequirementRequestPointSizeBase(None),
        line_thickness=0,
        match_orientation=True,
        line_orientation_threshold=0,
        match_groups=True,
        group_match_threshold=0,
        check_covered_annotations=True,
        object_visibility_threshold=0,
        panoptic_comparison=True,
        attribute_comparison=PatchedQualityRequirementRequestAttributeComparison(None),
    ) # PatchedQualityRequirementRequest |  (optional)

    try:
        (data, response) = api_client.quality_api.partial_update_settings_requirements(
            id,
            patched_quality_requirement_request=patched_quality_requirement_request,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling QualityApi.partial_update_settings_requirements(): %s\n" % e)

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    id = 1 # int | A unique integer value identifying this quality report.

    try:
        (data, response) = api_client.quality_api.retrieve_report(
            id,)
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling QualityApi.retrieve_report(): %s\n" % e)

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    id = 1 # int | A unique integer value identifying this quality report.

    try:
        (data, response) = api_client.quality_api.retrieve_report_confusion(
            id,)
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling QualityApi.retrieve_report_confusion(): %s\n" % e)

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    id = 1 # int | A unique integer value identifying this quality report.
    format = "json" # str |  (optional) if omitted the server will use the default value of "json"

    try:
        (data, response) = api_client.quality_api.retrieve_report_data(
            id,
            format=format,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling QualityApi.retrieve_report_data(): %s\n" % e)

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    id = 1 # int | A unique integer value identifying this quality report.
    requirement = 1 # int | Quality requirement id in the report
    format = "json" # str |  (optional) if omitted the server will use the default value of "json"

    try:
        (data, response) = api_client.quality_api.retrieve_report_requirement_confusion(
            id,
            requirement,
            format=format,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling QualityApi.retrieve_report_requirement_confusion(): %s\n" % e)

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    id = 1 # int | An id of a quality settings instance

    try:
        (data, response) = api_client.quality_api.retrieve_settings(
            id,)
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling QualityApi.retrieve_settings(): %s\n" % e)

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    id = 1 # int | A unique integer value identifying this quality requirement.

    try:
        (data, response) = api_client.quality_api.retrieve_settings_requirements(
            id,)
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling QualityApi.retrieve_settings_requirements(): %s\n" % e)

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    id = 1 # int | An id of a quality settings instance
    quality_settings_request = QualitySettingsRequest(
        job_filter="job_filter_example",
        inherit=True,
        max_validations_per_job=0,
        requirements=[
            QualityRequirementListItemRequest(
                settings_id=1,
                name="name_example",
                sort_order=-2147483648,
                filter="filter_example",
                enabled=True,
                annotation_type=PatchedQualityRequirementRequestAnnotationType(None),
                metric=PatchedQualityRequirementRequestMetric(None),
                required_score=0,
                parent_requirement=1,
                iou_threshold=0,
                point_size=0,
                point_size_base=PatchedQualityRequirementRequestPointSizeBase(None),
                line_thickness=0,
                match_orientation=True,
                line_orientation_threshold=0,
                match_groups=True,
                group_match_threshold=0,
                check_covered_annotations=True,
                object_visibility_threshold=0,
                panoptic_comparison=True,
                attribute_comparison=PatchedQualityRequirementRequestAttributeComparison(None),
            ),
        ],
    ) # QualitySettingsRequest |  (optional)

    try:
        (data, response) = api_client.quality_api.update_settings(
            id,
            quality_settings_request=quality_settings_request,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling QualityApi.update_settings(): %s\n" % e)

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    id = 1 # int | A unique integer value identifying this quality requirement.
    quality_requirement_request = QualityRequirementRequest(
        settings_id=1,
        name="name_example",
        sort_order=-2147483648,
        filter="filter_example",
        enabled=True,
        annotation_type=PatchedQualityRequirementRequestAnnotationType(None),
        metric=PatchedQualityRequirementRequestMetric(None),
        required_score=0,
        parent_requirement=1,
        iou_threshold=0,
        point_size=0,
        point_size_base=PatchedQualityRequirementRequestPointSizeBase(None),
        line_thickness=0,
        match_orientation=True,
        line_orientation_threshold=0,
        match_groups=True,
        group_match_threshold=0,
        check_covered_annotations=True,
        object_visibility_threshold=0,
        panoptic_comparison=True,
        attribute_comparison=PatchedQualityRequirementRequestAttributeComparison(None),
    ) # QualityRequirementRequest |  (optional)

    try:
        (data, response) = api_client.quality_api.update_settings_requirements(
            id,
            quality_requirement_request=quality_requirement_request,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling QualityApi.update_settings_requirements(): %s\n" % e)