Our docs got a refresh! Check out the new content and improved navigation. For detailed API reference see our Python SDK docs and TypeScript SDK.
Description
API referenceAnnotations

Update Annotation Criteria

Updates an existing annotation criteria.

PUT
/v1/annotation-criteria/{id}
/v1/annotation-criteria/{id}

The Authorization access token

Authorization

X-API-KEY<token>

In: header

Request Body

application/jsonRequired

name
Required
Name

Minimum length: 1Maximum length: 100

descriptionDescription

annotation_type
Required
AnnotationCriteriaType

Defines the type of data collection method for annotation criteria.

Value in: "binary" | "continuous" | "discrete" | "categorical" | "text_annotation"

categoriesCategories

resource_typesResource Types

Path Parameters

id
Required
Id

Format: "uuid"
curl -X PUT "https://api.patronus.ai/v1/annotation-criteria/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "X-API-KEY: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "annotation_type": "binary",
    "categories": [
      {
        "label": "string",
        "score": 0
      }
    ],
    "resource_types": [
      "trace"
    ]
  }'

Successful Response

{
  "annotation_criteria": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
    "name": "string",
    "description": "string",
    "annotation_type": "string",
    "categories": [
      {
        "label": "string",
        "score": 0
      }
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "resource_types": [
      "trace"
    ],
    "locked": false
  }
}