Content Type - Generate Type Descriptions

The 'Generator' property determines which Data Generator (LLM configuration) is used to generate type descriptions.

Configuration Guidance

• Choose a Data Generator that is well-suited for technical writing, summarization, or schema documentation.
• The selected generator's model, output mode, and chat parameters will directly affect the style, accuracy, and consistency of the generated descriptions.
• For best results, use a model that supports structured output and has been tested for documentation tasks.

Impact

The quality and tone of generated descriptions depend on the capabilities and configuration of the selected generator. Adjusting the generator or its parameters can help tailor documentation to your organization's standards.

The 'Instructions' property allows you to specify detailed guidance for the Data Generator when generating descriptions for each type in the schema.

Usage and Best Practices

• Write clear, concise instructions that describe the desired style, tone, and level of detail for type descriptions.
• You may include examples, formatting requirements, or terminology preferences.
• Instructions are sent directly to the LLM and have a significant impact on the resulting documentation.
• The LLM is supplied with existing type descriptions, so it is capable of refining or expanding them based on your instructions.

Example

Generate a short description for each type, using plain language suitable for business users.
Avoid technical jargon and keep each description under 120 characters.

The 'Overwrite' property controls whether the command replaces all existing type descriptions in the schema, or only fills in those that are missing.

Configuration Guidance

• Set to true to update all descriptions, regardless of whether a description already exists.
• Set to false to preserve existing descriptions and only generate new ones for types that lack documentation.

Impact

Enabling overwrite ensures consistency and applies the latest instructions to all types, but may replace custom or manually written descriptions. Disabling overwrite helps retain prior documentation where present.