# SDMetrics

## SDMetrics

- [SDMetrics](https://docs.sdv.dev/sdmetrics/sdmetrics.md)
- [Installation](https://docs.sdv.dev/sdmetrics/getting-started/installation.md)
- [Quickstart](https://docs.sdv.dev/sdmetrics/getting-started/quickstart.md)
- [Metadata](https://docs.sdv.dev/sdmetrics/getting-started/metadata.md)
- [Single Table Metadata](https://docs.sdv.dev/sdmetrics/getting-started/metadata/single-table-metadata.md)
- [Multi Table Metadata](https://docs.sdv.dev/sdmetrics/getting-started/metadata/multi-table-metadata.md)
- [Sequential Metadata](https://docs.sdv.dev/sdmetrics/getting-started/metadata/sequential-metadata.md)
- [Visualization Utilities](https://docs.sdv.dev/sdmetrics/getting-started/visualization-utilities.md)
- [Diagnostic](https://docs.sdv.dev/sdmetrics/data-metrics/diagnostic.md)
- [Diagnostic Report API](https://docs.sdv.dev/sdmetrics/data-metrics/diagnostic/diagnostic-report-api.md)
- [What's included?](https://docs.sdv.dev/sdmetrics/data-metrics/diagnostic/diagnostic-report-api/whats-included.md)
- [Single Table API](https://docs.sdv.dev/sdmetrics/data-metrics/diagnostic/diagnostic-report-api/single-table-api.md)
- [Multi Table API](https://docs.sdv.dev/sdmetrics/data-metrics/diagnostic/diagnostic-report-api/multi-table-api.md)
- [BoundaryAdherence](https://docs.sdv.dev/sdmetrics/data-metrics/diagnostic/boundaryadherence.md)
- [CardinalityBoundaryAdherence](https://docs.sdv.dev/sdmetrics/data-metrics/diagnostic/cardinalityboundaryadherence.md)
- [CategoryAdherence](https://docs.sdv.dev/sdmetrics/data-metrics/diagnostic/categoryadherence.md)
- [ConstraintAdherence](https://docs.sdv.dev/sdmetrics/data-metrics/diagnostic/constraintadherence.md)
- [DatetimeFormatAdherence](https://docs.sdv.dev/sdmetrics/data-metrics/diagnostic/datetimeformatadherence.md)
- [KeyUniqueness](https://docs.sdv.dev/sdmetrics/data-metrics/diagnostic/keyuniqueness.md)
- [RegexFormatAdherence](https://docs.sdv.dev/sdmetrics/data-metrics/diagnostic/regexformatadherence.md)
- [ReferentialIntegrity](https://docs.sdv.dev/sdmetrics/data-metrics/diagnostic/referentialintegrity.md)
- [TableStructure](https://docs.sdv.dev/sdmetrics/data-metrics/diagnostic/tablestructure.md)
- [Quality](https://docs.sdv.dev/sdmetrics/data-metrics/quality.md)
- [Quality Report API](https://docs.sdv.dev/sdmetrics/data-metrics/quality/quality-report-api.md)
- [What's included?](https://docs.sdv.dev/sdmetrics/data-metrics/quality/quality-report-api/whats-included.md)
- [Single Table API](https://docs.sdv.dev/sdmetrics/data-metrics/quality/quality-report-api/single-table-api.md)
- [Multi Table API](https://docs.sdv.dev/sdmetrics/data-metrics/quality/quality-report-api/multi-table-api.md)
- [CardinalityShapeSimilarity](https://docs.sdv.dev/sdmetrics/data-metrics/quality/cardinalityshapesimilarity.md)
- [CategoryCoverage](https://docs.sdv.dev/sdmetrics/data-metrics/quality/categorycoverage.md)
- [ContingencySimilarity](https://docs.sdv.dev/sdmetrics/data-metrics/quality/contingencysimilarity.md)
- [CorrelationSimilarity](https://docs.sdv.dev/sdmetrics/data-metrics/quality/correlationsimilarity.md)
- [InterRowMSAS](https://docs.sdv.dev/sdmetrics/data-metrics/quality/interrowmsas.md)
- [KSComplement](https://docs.sdv.dev/sdmetrics/data-metrics/quality/kscomplement.md)
- [MissingValueSimilarity](https://docs.sdv.dev/sdmetrics/data-metrics/quality/missingvaluesimilarity.md)
- [RangeCoverage](https://docs.sdv.dev/sdmetrics/data-metrics/quality/rangecoverage.md)
- [SequenceLengthSimilarity](https://docs.sdv.dev/sdmetrics/data-metrics/quality/sequencelengthsimilarity.md)
- [StatisticMSAS](https://docs.sdv.dev/sdmetrics/data-metrics/quality/statisticmsas.md)
- [StatisticSimilarity](https://docs.sdv.dev/sdmetrics/data-metrics/quality/statisticsimilarity.md)
- [TVComplement](https://docs.sdv.dev/sdmetrics/data-metrics/quality/tvcomplement.md)
- [Privacy](https://docs.sdv.dev/sdmetrics/data-metrics/privacy.md)
- [DCRBaselineProtection](https://docs.sdv.dev/sdmetrics/data-metrics/privacy/dcrbaselineprotection.md)
- [DCROverfittingProtection](https://docs.sdv.dev/sdmetrics/data-metrics/privacy/dcroverfittingprotection.md)
- [DisclosureProtection](https://docs.sdv.dev/sdmetrics/data-metrics/privacy/disclosureprotection.md)
- [DisclosureProtectionEstimate](https://docs.sdv.dev/sdmetrics/data-metrics/privacy/disclosureprotectionestimate.md)
- [CategoricalCAP](https://docs.sdv.dev/sdmetrics/data-metrics/privacy/categoricalcap.md)
- [Metrics in Beta](https://docs.sdv.dev/sdmetrics/data-metrics/metrics-in-beta.md)
- [CSTest](https://docs.sdv.dev/sdmetrics/data-metrics/metrics-in-beta/cstest.md)
- [Data Likelihood](https://docs.sdv.dev/sdmetrics/data-metrics/metrics-in-beta/data-likelihood.md)
- [BNLikelihood](https://docs.sdv.dev/sdmetrics/data-metrics/metrics-in-beta/data-likelihood/bnlikelihood.md)
- [BNLogLikelihood](https://docs.sdv.dev/sdmetrics/data-metrics/metrics-in-beta/data-likelihood/bnloglikelihood.md)
- [GMLikelihood](https://docs.sdv.dev/sdmetrics/data-metrics/metrics-in-beta/data-likelihood/gmlikelihood.md)
- [Detection: Sequential](https://docs.sdv.dev/sdmetrics/data-metrics/metrics-in-beta/detection-sequential.md)
- [Detection: Single Table](https://docs.sdv.dev/sdmetrics/data-metrics/metrics-in-beta/detection-single-table.md)
- [EqualizedOddsImprovement](https://docs.sdv.dev/sdmetrics/data-metrics/metrics-in-beta/equalizedoddsimprovement.md)
- [ML Efficacy: Sequential](https://docs.sdv.dev/sdmetrics/data-metrics/metrics-in-beta/ml-efficacy-sequential.md)
- [ML Efficacy: Single Table](https://docs.sdv.dev/sdmetrics/data-metrics/metrics-in-beta/ml-efficacy-single-table.md)
- [Binary Classification](https://docs.sdv.dev/sdmetrics/data-metrics/metrics-in-beta/ml-efficacy-single-table/binary-classification.md)
- [Multiclass Classification](https://docs.sdv.dev/sdmetrics/data-metrics/metrics-in-beta/ml-efficacy-single-table/multiclass-classification.md)
- [Regression](https://docs.sdv.dev/sdmetrics/data-metrics/metrics-in-beta/ml-efficacy-single-table/regression.md)
- [NewRowSynthesis](https://docs.sdv.dev/sdmetrics/data-metrics/metrics-in-beta/newrowsynthesis.md)
- [＊ OutlierCoverage](https://docs.sdv.dev/sdmetrics/data-metrics/metrics-in-beta/outliercoverage.md)
- [Privacy Against Inference](https://docs.sdv.dev/sdmetrics/data-metrics/metrics-in-beta/privacy-against-inference.md)
- [＊ SmoothnessSimilarity](https://docs.sdv.dev/sdmetrics/data-metrics/metrics-in-beta/smoothnesssimilarity.md)
- [ML Augmentation](https://docs.sdv.dev/sdmetrics/roi-metrics/ml-augmentation.md)
- [BinaryClassifierPrecisionEfficacy](https://docs.sdv.dev/sdmetrics/roi-metrics/ml-augmentation/binaryclassifierprecisionefficacy.md)
- [BinaryClassifierRecallEfficacy](https://docs.sdv.dev/sdmetrics/roi-metrics/ml-augmentation/binaryclassifierrecallefficacy.md)
- [Citation](https://docs.sdv.dev/sdmetrics/resources/citation.md)
- [Contributions](https://docs.sdv.dev/sdmetrics/resources/contributions.md)
- [Defining your metric](https://docs.sdv.dev/sdmetrics/resources/contributions/defining-your-metric.md)
- [Development](https://docs.sdv.dev/sdmetrics/resources/contributions/development.md)
- [Release FAQs](https://docs.sdv.dev/sdmetrics/resources/contributions/release-faqs.md)
- [Enterprise](https://docs.sdv.dev/sdmetrics/resources/enterprise.md)
- [Domain Specific Reports](https://docs.sdv.dev/sdmetrics/resources/enterprise/domain-specific-reports.md)


---

# 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
This site has an agentic ask interface you may use to query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.sdv.dev/sdmetrics/index.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
