ClassyDocAi

Schemas page

Overview

The Schemas page is where you can manage all the classification schemas you have created. On this page, you can create, edit, version, and test schemas to tailor them to your needs.

What is a classification schema?

Classification schemas are the backbone of your classification process. They define the rules, types, and context required to accurately classify your data. A schema contains a Description, which is an explanation of what the schema does and does not affect the accuracy of the classification result itself. It also includes an optional Context, which can be added to provide additional information to enhance the accuracy and usability of the classifications. Additionally, every schema must have Classification Types, which define how data should be categorized.

What is a classification type?

A classification type represents a category that defines how your data will be classified. Each classification type includes a Title and a Result, where the Result is the code returned by the classification process, indicating the category to which the data belongs. Additionally, a classification type can have an optional Context, which provides extra information to enhance the accuracy of the classifications.

Schema Versioning

Schema versioning allows you to maintain multiple versions of a classification schema, ensuring that changes do not impact previous classifications. When creating a new version, the previous version remains available while you refine and test updates. If you want to roll back to a previous version, simply click on the version dropdown at the top right, select the desired version, and then choose Actions → Activate Version to make it the primary version. Versioning is useful for tracking schema changes over time, rolling back to previous versions if necessary, and maintaining consistency across different classification use cases.

To create a new version of a schema, click the New Version button in the schema dropdown menu on the top right. The new version will be a duplicate of the original schema, allowing you to make any necessary modifications. To use a version for classification via API integration, it must be activated as the primary version.

Features

  1. Create from template: You can create a new schema from scratch or use a schema template as a starting point to save time.
  2. Schema duplication: Easily duplicate an existing schema to reuse its structure. This is helpful when creating a similar schema with minor variations.
  3. Schema versioning: Maintain multiple versions of a schema and activate a specific version as needed.
  4. Schema test: Use the schema testing feature to ensure the schema performs as expected and validate the schema's rules before applying it to your actual data.
  5. Manage classification types: Define unique classification types for your schema, including attributes such as title, result, and context.
  6. API integration: Easily integrate classification functionalities into your application.

API integration

ClassyDoc.ai allows you to easily integrate classification functionalities into your application using API requests. For every schema you create, the API endpoint and a sample request body are already provided on the schema's page, making it simple to get started with your API integration. For more information, see the API documentation.