ZUzuva
Fields

Get field list

Changed on

Lists all fields available to the user.

Metadata for non-custom fields will include all properties, but the scores (precision, recall etc.) will be zero.

get/fields

Request

Response

List of fields with metadata.

biasnumber required
descriptionstring required
document_countinteger required
f_scorenumber required
field_idstring required
file_idsstring[] required
is_customboolean required
is_trainedboolean required
namestring required
normalization_typestring required
precisionnumber required
recallnumber required
tagsstring[] required

Example response

[
  {
    "description": "Description of the field.",
    "field_id": "12345678-1234-1234-1234-123456789012",
    "file_ids": [
      "c5e407f1qk1er7odm6tg"
    ],
    "name": "Field Name"
  }
]

Changes

  • 7cace20deba7Revision changes
    • 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