Schemas: vision

Schemas whose first using operation belongs to the vision family. A shared schema is described once, here, and linked from every operation that uses it.

Descriptions come from the contract, which is written in French without accents. They are reproduced as is so that the contract remains the source of truth.

`BreakdownOut`

Compte d'une categorie.

Type : object

Property	Type	Required	Description	Constraints
`category`	`string`	yes
`count`	`integer`	yes

Used by : visionRead

`CellOut`

Valeur d'un segment ; tout est `null` s'il est supprime par le seuil.

Type : object

Property	Type	Required	Description
`breakdown`	`array<BreakdownOut>`	yes
`items`	`integer \| null`	yes	Objets comptes (denominateur d'un taux).
`numerator`	`integer \| null`	yes	Numerateur d'un taux ; `null` sinon.
`p90`	`string \| null`	yes	90e centile d'une duree, en heures.
`population`	`integer \| null`	yes	Population soumise au seuil.
`suppressed`	`boolean`	yes	Segment sous le seuil, ou supprime en complement.
`value`	`string \| null`	yes	Compte, taux (0 a 1), moyenne ou mediane en heures ; `null` si indefini.

Used by : visionRead

`Dimension`

Axe de segmentation d'un indicateur.

Type : string

Allowed values : product, policy, month, channel

Used by : visionCatalog, visionRead

`Freshness`

Age de l'information restituee.

Type : string

Allowed values : live

Used by : visionCatalog

`IndicatorDefinitionOut`

Contrat d'un indicateur : ce qu'il mesure, sur quoi, et comment.

Type : object

Property	Type	Required	Description
`categories`	`array<string>`	yes	Categories fermees de la repartition.
`denominator`	`string`	yes	Objets comptes au denominateur, ou comptes.
`dimensions`	`array<Dimension>`	yes
`event_time`	`string`	yes	Horodatage qui place un objet dans la periode.
`family`	`IndicatorFamily`	yes
`formula`	`string`	yes	Formule technique stable, sur les tables sources.
`freshness`	`Freshness`	yes
`key`	`IndicatorKey`	yes
`kind`	`IndicatorKind`	yes
`missing_data`	`MissingData`	yes
`numerator`	`string \| null`	yes	Objets comptes au numerateur (taux).
`population`	`Population`	yes	Ce que le seuil de minimisation compte.
`sources`	`array<IndicatorSource>`	yes
`unit`	`IndicatorUnit`	yes

Used by : visionCatalog

`IndicatorFamily`

Familles d'indicateurs de la Specification A.10.

Type : string

Allowed values : activity, decision_quality, data_quality, portfolio, comparison, supervision

Used by : visionCatalog, visionRead

`IndicatorKey`

Les indicateurs de VISION, et aucun autre.

Type : string

Allowed values : applications.created, evaluations.count, evaluations.outcomes, evaluations.review_rate, evaluations.zones, evaluations.scores, evaluations.completeness, decisions.count, decisions.approval_rate, decisions.decline_rate, decisions.deviation_rate, decisions.escalations, decisions.time_to_decision, imports.row_validity

Used by : visionCatalog, visionRead

`IndicatorKind`

Nature de la valeur.

Type : string

Allowed values : count, rate, mean, duration, distribution

Used by : visionCatalog

`IndicatorSource`

Table du locataire lue. Aucune n'appartient a CONTROL (ADR-0055 §8).

Type : string

Allowed values : credit_applications, decisions, human_decisions, policies, credit_products, link_batches

Used by : visionCatalog

`IndicatorUnit`

Unite d'une valeur. Aucune unite monetaire : aucun montant n'est agrege.

Type : string

Allowed values : applications, evaluations, decisions, escalations, ratio, hours, rows

Used by : visionCatalog

`IndicatorValueOut`

Valeur d'un indicateur sur la periode, puis par segment.

Type : object

Property	Type	Required
`key`	`IndicatorKey`	yes
`overall`	`CellOut`	yes
`segments`	`array<nexclara_api__api__v1__vision_schemas__SegmentOut>`	yes

Used by : visionRead

`MissingData`

Traitement d'une absence de donnee.

Type : string

Allowed values : zero_is_value, undefined_when_empty

Used by : visionCatalog

`PolicyReferenceOut`

Version de politique nommee par une lecture, et l'echelle de sa grille.

Type : object

Property	Type	Required
`code`	`string`	yes
`id`	`string (uuid)`	yes
`product_id`	`string (uuid)`	yes
`scale_max`	`integer \| null`	yes
`scale_min`	`integer \| null`	yes
`status`	`string`	yes
`version`	`integer`	yes

Used by : visionRead

`Population`

Ce que le seuil de minimisation compte dans un segment.

Type : string

Allowed values : dossiers, import_rows

Used by : visionCatalog

`ProductReferenceOut`

Produit nomme par une lecture.

Type : object

Property	Type	Required
`code`	`string`	yes
`id`	`string (uuid)`	yes
`name`	`string`	yes
`name_en`	`string \| null`	yes
`status`	`string`	yes

Used by : visionRead

`ReadingPeriodOut`

Periode lue : mois civils UTC, bornee a l'instant du calcul (fin exclue).

Type : object

Property	Type	Required
`end`	`string (date-time)`	yes
`first_month`	`string`	yes
`last_month`	`string`	yes
`months`	`array<string>`	yes
`start`	`string (date-time)`	yes

Used by : visionRead

`UnavailabilityReason`

Pourquoi un indicateur attendu n'a pas de valeur.

Type : string

Allowed values : no_observed_outcome, no_loss_source, no_financial_source, no_statistical_model, no_branch_in_model, no_segment_in_model, awaiting_decision, no_supervision_source

Used by : visionCatalog, visionRead

`UnavailableIndicator`

Indicateurs attendus (Plan Lot 8, Specifications A.10), sans source aujourd'hui.

Type : string

Allowed values : portfolio.default_rate_by_score_band, portfolio.predicted_vs_observed, portfolio.discriminatory_power, portfolio.losses, portfolio.profitability, portfolio.probability_of_default, comparison.by_branch, comparison.by_segment, comparison.by_analyst, supervision.instance

Used by : visionCatalog, visionRead

`UnavailableIndicatorOut`

Indicateur attendu, sans source : il n'a pas de valeur, il a un motif.

Type : object

Property	Type	Required
`family`	`IndicatorFamily`	yes
`key`	`UnavailableIndicator`	yes
`reason`	`UnavailabilityReason`	yes

Used by : visionCatalog, visionRead

`VisionCatalogOut`

Registre ferme des indicateurs et regles de restitution en vigueur.

Type : object

Property	Type	Required	Description
`can_export`	`boolean`	yes	L'appelant detient `analytics.export`.
`indicators`	`array<IndicatorDefinitionOut>`	yes
`max_months`	`integer`	yes	Etendue maximale d'une periode, en mois.
`min_segment_size`	`integer`	yes	Seuil k : aucun segment de 1 a k-1 dossiers n'est restitue.
`score_bands`	`integer`	yes	Bandes de la repartition des scores par grille.
`unavailable`	`array<UnavailableIndicatorOut>`	yes

Used by : visionCatalog

`VisionReadingOut`

Une lecture des indicateurs, a un instant.

Type : object

Property	Type	Required
`computed_at`	`string (date-time)`	yes
`indicators`	`array<IndicatorValueOut>`	yes
`min_segment_size`	`integer`	yes
`period`	`ReadingPeriodOut`	yes
`policies`	`array<PolicyReferenceOut>`	yes
`policy_id`	`string (uuid) \| null`	yes
`product_id`	`string (uuid) \| null`	yes
`products`	`array<ProductReferenceOut>`	yes
`unavailable`	`array<UnavailableIndicatorOut>`	yes

Used by : visionRead

`nexclara_apiapiv1__vision_schemas__SegmentOut`

Une modalite d'une dimension et sa valeur.

Type : object

Property	Type	Required	Description
`cell`	`CellOut`	yes
`dimension`	`Dimension`	yes
`key`	`string`	yes	Identifiant du produit ou de la politique, mois AAAA-MM, canal.
`partial`	`boolean`	yes	Mois en cours a l'instant du calcul.

Used by : visionRead

Schemas: vision

BreakdownOut

CellOut

Dimension

Freshness

IndicatorDefinitionOut

IndicatorFamily

IndicatorKey

IndicatorKind

IndicatorSource

IndicatorUnit

IndicatorValueOut

MissingData

PolicyReferenceOut

Population

ProductReferenceOut

ReadingPeriodOut

UnavailabilityReason

UnavailableIndicator

UnavailableIndicatorOut

VisionCatalogOut

VisionReadingOut

nexclara_api__api__v1__vision_schemas__SegmentOut

`BreakdownOut`

`CellOut`

`Dimension`

`Freshness`

`IndicatorDefinitionOut`

`IndicatorFamily`

`IndicatorKey`

`IndicatorKind`

`IndicatorSource`

`IndicatorUnit`

`IndicatorValueOut`

`MissingData`

`PolicyReferenceOut`

`Population`

`ProductReferenceOut`

`ReadingPeriodOut`

`UnavailabilityReason`

`UnavailableIndicator`

`UnavailableIndicatorOut`

`VisionCatalogOut`

`VisionReadingOut`

`nexclara_apiapiv1__vision_schemas__SegmentOut`