# API Documentation

- [Reading the Docs](https://prisma-util.gitbook.io/stable/api-documentation/reading-the-docs.md): This page acts as an introduction to the Prisma Util API Documentation. Due to the amount of features, we have decided to release a guide to understanding the docs.
- [Types & Objects](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects.md): This page provides information on all types and objects that are used across Prisma Util configuration, modules and other pages.
- [Path](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/path.md)
- [Model](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/model.md)
- [TemplatedPath](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/templated-path.md)
- [FileModel](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/file-model.md)
- [FileGenerator](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/file-generator.md)
- [FileModelColumn](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/file-model-column.md)
- [OptionalFeature](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/optional-feature.md)
- [Map\<K, V>](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/map.md)
- [PrismaSchema](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/prisma-schema.md)
- [IndexData](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/index-data.md)
- [DefaultFunction](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/default-function.md)
- [ModelTake](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/model-take.md)
- [ModelTakeWithGlobal](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/model-take-with-global.md)
- [AbstractModelTake](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/abstract-model-take.md)
- [EnvironmentVariable](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/environment-variable.md)
- [GeneratorRunCondition](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/generator-run-condition.md)
- [GeneratorConfig](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/generator-config.md)
- [ImportedType](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/imported-type.md)
- [IntrospectionModel](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/introspection-model.md)
- [SimpleIntrospectionMatcher](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/simple-introspection-matcher.md)
- [StringIntrospectionMatcher](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/string-introspection-matcher.md)
- [BaseIntrospectionMatcher](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/base-introspection-matcher.md)
- [ComplexIntrospectionMatcher](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/complex-introspection-matcher.md)
- [ModelPatterns](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/model-patterns.md)
- [IntrospectionConfig](https://prisma-util.gitbook.io/stable/api-documentation/types-and-objects/introspection-config.md)
- [Command Reference](https://prisma-util.gitbook.io/stable/api-documentation/command-reference.md): This page provides information on all commands, flags and configurations that you can use with the improved Prisma Util CLI.
- [prisma-util prepare](https://prisma-util.gitbook.io/stable/api-documentation/command-reference/prepare.md)
- [prisma-util configure](https://prisma-util.gitbook.io/stable/api-documentation/command-reference/configure.md)
- [prisma-util schema](https://prisma-util.gitbook.io/stable/api-documentation/command-reference/schema.md)
- [prisma-util interactive](https://prisma-util.gitbook.io/stable/api-documentation/command-reference/interactive.md)
- [prisma-util format](https://prisma-util.gitbook.io/stable/api-documentation/command-reference/format.md)
- [prisma-util migrate reset](https://prisma-util.gitbook.io/stable/api-documentation/command-reference/migrate-reset.md)
- [Configuration Reference](https://prisma-util.gitbook.io/stable/api-documentation/configuration-reference.md): This page provides information on every configuration option available in the Prisma Util configuration file.
- [baseSchema](https://prisma-util.gitbook.io/stable/api-documentation/configuration-reference/base-schema.md)
- [includeFiles](https://prisma-util.gitbook.io/stable/api-documentation/configuration-reference/include-files.md)
- [excludeModels](https://prisma-util.gitbook.io/stable/api-documentation/configuration-reference/exclude-models.md)
- [optionalFeatures](https://prisma-util.gitbook.io/stable/api-documentation/configuration-reference/optional-features.md)
- [extendModels](https://prisma-util.gitbook.io/stable/api-documentation/configuration-reference/extend-models.md)
- [relations](https://prisma-util.gitbook.io/stable/api-documentation/configuration-reference/relations.md)
- [codeGenerators](https://prisma-util.gitbook.io/stable/api-documentation/configuration-reference/code-generators.md)
- [ftsIndexes](https://prisma-util.gitbook.io/stable/api-documentation/configuration-reference/fts-indexes.md)
- [schema](https://prisma-util.gitbook.io/stable/api-documentation/configuration-reference/schema.md)
- [middleware](https://prisma-util.gitbook.io/stable/api-documentation/configuration-reference/middleware.md)
- [defaultFunctions](https://prisma-util.gitbook.io/stable/api-documentation/configuration-reference/default-functions.md)
- [environment](https://prisma-util.gitbook.io/stable/api-documentation/configuration-reference/environment.md)
- [deprecated](https://prisma-util.gitbook.io/stable/api-documentation/configuration-reference/deprecated.md)
- [take](https://prisma-util.gitbook.io/stable/api-documentation/configuration-reference/take.md)
- [generators](https://prisma-util.gitbook.io/stable/api-documentation/configuration-reference/generators.md)
- [fieldTypes](https://prisma-util.gitbook.io/stable/api-documentation/configuration-reference/field-types.md)
- [introspection](https://prisma-util.gitbook.io/stable/api-documentation/configuration-reference/introspection.md)


---

# Agent Instructions: 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://prisma-util.gitbook.io/stable/api-documentation.md?ask=<question>
```

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.