Field Library

Included is a full version of Zuva’s built-in field library. Fields are Zuva’s built-in analytical models, and are used to extract text and concepts from your documents. Using the new administration console, these models can be managed for both permissions and obtaining field_ids used in the Extraction API endpoint

Exploring the field library

To browse the Zuva built-in fields:

  1. Login to the administration console
  2. Click Field Library. A list of field groups will be displayed. Groups are used to organize fields into categories that capture related content from your documents or are to be used on similar types of documents.
  3. Click on the group you would like to explore. The list of fields in that group will be displayed.
  4. Click on the field you would like to see a description for. The field details are displayed.

Information included in the field details are the name, description, the field_id (used to extract fields from your documents in the API), the publisher (Zuva will be used for any built-in fields), the creation date, as well as the groups the field has been assigned.

Obtaining field_ids

In order to extract text from your documents, you must know the field_id for those models you would like to extract. You can obtain these ids using the GET /fields endpoint in the API, or prepare a select list to extract from the admin console.

To obtain a field_id:

  1. Login to the administration console
  2. Click Field Library
  3. Click on the field group
  4. Click on the field you would like to obtain the field_id
  5. Copy the field_id

Need Help?

Couldn’t find the information you were looking for or need more assistance?

Contact us at support@zuva.ai