Annotation Configs

Create an annotation config

Changed on

Create a new annotation config.

Payload Requirements

  • The annotation config name must be unique within the given space.

Valid example

{
  "name": "my-annotation-config",
  "space_id": "spc_123",
  "annotation_config_type": "CATEGORICAL",
  "values": [
    {
      "label": "value1",
      "score": 0
    },
    {
      "label": "value2",
      "score": 1
    }
  ],
  "optimization_direction": "MAXIMIZE"
}
post/v2/annotation-configs

Request

  • Base URL
    https://api.arize.com
  • URL
    https://api.arize.com/v2/annotation-configs
  • Auth
    HTTP bearer

Request body

OR
OR

Response

An annotation config object

OR
OR

Changes

  • 4f94eb2fd1abRevision changes
    • breaking

      added the new required request property

    • breaking

      removed from the request body oneOf list

    • breaking

      the /// response's property type changed from no type to object for status

    • breaking

      the /// response's property type changed from no type to object for status

    • breaking

      the /// response's property type changed from no type to object for status

    • info

      api operation id annotation_configs_create removed and replaced with create_annotation_config

    • info

      added CONTINUOUS CATEGORICAL FREEFORM mapping keys to the request discriminator

    • info

      removed continuous categorical freeform mapping keys from the request discriminator

    • info

      added to the request body oneOf list

    • info

      added CONTINUOUS CATEGORICAL FREEFORM mapping keys to the response discriminator for the response status

    • info

      removed continuous categorical freeform mapping keys from the response discriminator for the response status

    • info

      added the non-success response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      removed subschema #2 from the /// response property allOf list for the response status

    • info

      removed subschema #2 from the /// response property allOf list for the response status

    • info

      removed subschema #2 from the /// response property allOf list for the response status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status