annotation-queues

Update Annotation Queue

Changed on
patch/api/v1/annotation-queues/{queue_id}

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/annotation-queues/{queue_id}
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Tenant-Id
    • or HTTP bearer

Path parameters

queue_idstring uuid required

ID of the annotation queue.

Request body

namestring nullable

New name for the queue.

descriptionstring nullable

New description.

default_datasetstring uuid nullable

Dataset that reviewed runs are added to by default.

rubric_instructionsstring nullable

Instructions shown to reviewers.

reviewer_access_mode'any' | 'assigned' nullable

Who completes a run: any (one reviewer is enough) or assigned (every assigned reviewer must submit).

Response

Successful Response

unknown required

Changes

    • breaking

      the request property type changed from boolean to no type

    • breaking

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

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added to the request property anyOf list

    • info

      added subschema #1 to the request property anyOf list

    • info

      the request property default value {"__missing__":"__missing__"} was added

    • info

      the request property default value changed from true to {"__missing__":"__missing__"}

    • info

      the request property default value changed from 1 to {"__missing__":"__missing__"}

    • info

      added the new optional request property

    • info

      added the new optional request property ///