> ## Documentation Index
> Fetch the complete documentation index at: https://docs.effectiveai.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Knowledge file format

> Prepare knowledge files for form comparisons.

Upload UTF-8 Markdown files, up to 1 MiB each. Start with YAML front matter,
then add one entry per `##` heading. A fenced `yaml` block must come directly
after the heading, followed by a nonempty Markdown body:

````markdown theme={null}
---
format: forms-knowledge/v1
namespace: example
title: Coverage knowledge
---

## Water damage

```yaml
id: water-damage
type: concept
kind: coverage
```

Water damage means…
````

* Types: `concept`, `definition`, `guidance`. Definitions require
  `definitionOf` (a full concept ID) and `scope`.
* Concept kinds: `coverage`, `exposure`, `party_role`, `act`, `loss`, `claim`,
  `benefit`, `condition`, `term`.
* IDs use `namespace:id`. Local IDs start with a lowercase letter and contain
  lowercase letters, digits, or hyphens. IDs must be unique across supplied files.

<Accordion title="Optional fields">
  Front matter can include `scope`. Entries can include `label` and `aliases`.

  `connections`: `{ relation, target, note? }`. Targets and `definitionOf` must
  reference entries in the supplied files. Cycles are allowed.

  `sources`: `{ fileId, page?, section?, quote? }`, `{ fileId?, entryId }`, or `{ url }`.
</Accordion>

[Validate the files](/api-reference/form-comparisons/validate-knowledge-files)
before using them. `valid: true` confirms the format, not the interpretation.
Comparison requests also validate knowledge automatically.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.