Skip to main content
Upload any data file and receive an AI-generated profile — summary statistics, data quality issues, and recommendations for validation rules and transformations. Use profiling to understand your data before setting up a pipeline configuration.

Endpoint

POST /api/v1/pipeline/profile

Parameters

Example

Response

The endpoint returns a JSON object with three sections:

Response fields

Suggested data quality rules

The suggestedDataQuality section provides a complete, copy-paste-ready dataQuality configuration based on what the AI observed in the data:
  • aiRule — a single comprehensive plain-English instruction covering all validation checks: format patterns (emails, phone numbers, dates), value ranges, cross-column relationships (e.g., high >= low), and business logic. If no validation rule is appropriate, this field is omitted.
See AI Rule for full documentation.

How it works

  1. You upload a file — no pipeline registration needed
  2. For large CSV files, the pipeline randomly samples sampleSize rows (keeping the header)
  3. The sampled content is sent to the AI model with a profiling prompt
  4. The AI analyzes the data and returns a structured JSON profile
Profiling is a standalone operation — it does not require a registered pipeline, data quality rules, or any pipeline configuration. It is designed to be the first step when working with a new data source, before setting up validation or ingestion.

Use cases

  • Explore new data — understand the structure, types, and quality of an unfamiliar file before writing a pipeline configuration
  • Discover quality issues — find missing values, outliers, format inconsistencies, and suspicious patterns
  • Generate rule ideas — the AI suggests aiRule instructions and transformations based on what it observes
  • Validate assumptions — confirm that a file matches expected schema and data quality before loading

Sampling

For CSV files larger than sampleSize rows, the profiling endpoint automatically samples a random subset. The header row is always included. For JSON and XML files, the content is truncated if it exceeds the AI model’s context window. The default sample of 200 rows is typically sufficient to detect patterns, types, and quality issues. Increase sampleSize for more thorough profiling at the cost of slower response times.

Requirements

  • ai.enabled: true must be set in application.yaml
  • A configured AI provider (see AI Configuration)
  • Cloud providers (Anthropic, OpenAI) recommended for best results