Schémas : vision
Schémas dont la première opération qui les emploie appartient à la famille vision. Un schéma partagé est décrit une seule fois, ici, et lié depuis toutes les opérations qui l'emploient.
Les descriptions viennent du contrat, rédigé en français sans accents. Elles sont reproduites telles quelles pour rester la source de vérité.
BreakdownOut
Compte d'une categorie.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
category | string | oui | ||
count | integer | oui |
Employé par : visionRead
CellOut
Valeur d'un segment ; tout est `null` s'il est supprime par le seuil.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
breakdown | array<BreakdownOut> | oui | ||
items | integer | null | oui | Objets comptes (denominateur d'un taux). | |
numerator | integer | null | oui | Numerateur d'un taux ; `null` sinon. | |
p90 | string | null | oui | 90e centile d'une duree, en heures. | |
population | integer | null | oui | Population soumise au seuil. | |
suppressed | boolean | oui | Segment sous le seuil, ou supprime en complement. | |
value | string | null | oui | Compte, taux (0 a 1), moyenne ou mediane en heures ; `null` si indefini. |
Employé par : visionRead
Dimension
Axe de segmentation d'un indicateur.
Type : string
Valeurs admises : product, policy, month, channel
Employé par : visionCatalog, visionRead
Freshness
Age de l'information restituee.
Type : string
Valeurs admises : live
Employé par : visionCatalog
IndicatorDefinitionOut
Contrat d'un indicateur : ce qu'il mesure, sur quoi, et comment.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
categories | array<string> | oui | Categories fermees de la repartition. | |
denominator | string | oui | Objets comptes au denominateur, ou comptes. | |
dimensions | array<Dimension> | oui | ||
event_time | string | oui | Horodatage qui place un objet dans la periode. | |
family | IndicatorFamily | oui | ||
formula | string | oui | Formule technique stable, sur les tables sources. | |
freshness | Freshness | oui | ||
key | IndicatorKey | oui | ||
kind | IndicatorKind | oui | ||
missing_data | MissingData | oui | ||
numerator | string | null | oui | Objets comptes au numerateur (taux). | |
population | Population | oui | Ce que le seuil de minimisation compte. | |
sources | array<IndicatorSource> | oui | ||
unit | IndicatorUnit | oui |
Employé par : visionCatalog
IndicatorFamily
Familles d'indicateurs de la Specification A.10.
Type : string
Valeurs admises : activity, decision_quality, data_quality, portfolio, comparison, supervision
Employé par : visionCatalog, visionRead
IndicatorKey
Les indicateurs de VISION, et aucun autre.
Type : string
Valeurs admises : 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
Employé par : visionCatalog, visionRead
IndicatorKind
Nature de la valeur.
Type : string
Valeurs admises : count, rate, mean, duration, distribution
Employé par : visionCatalog
IndicatorSource
Table du locataire lue. Aucune n'appartient a CONTROL (ADR-0055 §8).
Type : string
Valeurs admises : credit_applications, decisions, human_decisions, policies, credit_products, link_batches
Employé par : visionCatalog
IndicatorUnit
Unite d'une valeur. Aucune unite monetaire : aucun montant n'est agrege.
Type : string
Valeurs admises : applications, evaluations, decisions, escalations, ratio, hours, rows
Employé par : visionCatalog
IndicatorValueOut
Valeur d'un indicateur sur la periode, puis par segment.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
key | IndicatorKey | oui | ||
overall | CellOut | oui | ||
segments | array<nexclara_api__api__v1__vision_schemas__SegmentOut> | oui |
Employé par : visionRead
MissingData
Traitement d'une absence de donnee.
Type : string
Valeurs admises : zero_is_value, undefined_when_empty
Employé par : visionCatalog
PolicyReferenceOut
Version de politique nommee par une lecture, et l'echelle de sa grille.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
code | string | oui | ||
id | string (uuid) | oui | ||
product_id | string (uuid) | oui | ||
scale_max | integer | null | oui | ||
scale_min | integer | null | oui | ||
status | string | oui | ||
version | integer | oui |
Employé par : visionRead
Population
Ce que le seuil de minimisation compte dans un segment.
Type : string
Valeurs admises : dossiers, import_rows
Employé par : visionCatalog
ProductReferenceOut
Produit nomme par une lecture.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
code | string | oui | ||
id | string (uuid) | oui | ||
name | string | oui | ||
name_en | string | null | oui | ||
status | string | oui |
Employé par : visionRead
ReadingPeriodOut
Periode lue : mois civils UTC, bornee a l'instant du calcul (fin exclue).
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
end | string (date-time) | oui | ||
first_month | string | oui | ||
last_month | string | oui | ||
months | array<string> | oui | ||
start | string (date-time) | oui |
Employé par : visionRead
VisionCatalogOut
Registre ferme des indicateurs et regles de restitution en vigueur.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
can_export | boolean | oui | L'appelant detient `analytics.export`. | |
indicators | array<IndicatorDefinitionOut> | oui | ||
max_months | integer | oui | Etendue maximale d'une periode, en mois. | |
min_segment_size | integer | oui | Seuil k : aucun segment de 1 a k-1 dossiers n'est restitue. | |
score_bands | integer | oui | Bandes de la repartition des scores par grille. | |
unavailable | array<UnavailableIndicatorOut> | oui |
Employé par : visionCatalog
VisionReadingOut
Une lecture des indicateurs, a un instant.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
computed_at | string (date-time) | oui | ||
indicators | array<IndicatorValueOut> | oui | ||
min_segment_size | integer | oui | ||
period | ReadingPeriodOut | oui | ||
policies | array<PolicyReferenceOut> | oui | ||
policy_id | string (uuid) | null | oui | ||
product_id | string (uuid) | null | oui | ||
products | array<ProductReferenceOut> | oui | ||
unavailable | array<UnavailableIndicatorOut> | oui |
Employé par : visionRead
nexclara_api__api__v1__vision_schemas__SegmentOut
Une modalite d'une dimension et sa valeur.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
cell | CellOut | oui | ||
dimension | Dimension | oui | ||
key | string | oui | Identifiant du produit ou de la politique, mois AAAA-MM, canal. | |
partial | boolean | oui | Mois en cours a l'instant du calcul. |
Employé par : visionRead