> For the complete documentation index, see [llms.txt](https://docs.tonic.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tonic.ai/textual/entity-types/entity-type-custom-model.md). # Adding model-based types {% hint style="info" %} **Required global permission - either:** * Create custom entity types * Edit any custom entity type Self-hosted instances must also [configure a connection to the LLM to use](/textual/textual-install-administer/configuring-textual/enable-and-configure-textual-features/textual-config-model-based-custom-entity-type.md). {% endhint %} While a regex-based entity type identifies values that match regular expressions, for a model-based custom entity type, you train a model to identify the entity values. A model-based entity type is useful when the values are identified more by context than by format. For example, for an entity type that identifies the names of health conditions, it would not be possible to set up regular expressions that identify the values. You iterate over text-based guidelines that identify the entity type values in a smaller set of data, then use a larger set of data to train one or more models. Each trained model is based on a selected version of the guidelines. You select the trained model to use for the custom entity type. ## Getting started


Overview of the model definition process General workflow to define a model-based custom entity type	/pages/fzZxxDMoTgoMgfNPGJoY
Use the progression tracker On the Entity Types page, see the current status for each step in the process.	/pages/6Grl6K8nSYL3VUhcBJGf
Start a new entity type Begin the process of creating a new model-based custom entity type	/pages/xSyLu6SbvPAOsnlOQuMC

## Defining the entity type


Select test data Identify the entity values in a small set of files.	/pages/HmnEoIYTP5iKEqsMBr99
Refine model guidelines Fine-tune the guidelines used to identify values for the entity type.	/pages/9tY2muP0CcrNvjbG3oMV
Select training data Assemble a much larger set of files to use to train models for the entity type.	/pages/Y5YzLEnHqGJ04jvWlbsy
Create and train models Create models that are based on a selected guidelines version, and train those models on the training data.	/pages/edcZUeuSesHLg5hdStEs

## Activating and managing an entity type


Select the published model Identify the trained model to use for the entity type.	/pages/JdGtH9SZT7Wm9WsHxEMq
Rename or delete the entity type Change the entity type name or delete the entity type.	/pages/QuZaNTMZq85RfE9AT30r
Export and import an entity type Export the entity type to an encrypted .zip file, and import the entity type into another instance.	/pages/jKjp7WhUCbTfIMBaNrTI

--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.tonic.ai/textual/entity-types/entity-type-custom-model.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.