Schémas : historical-simulation
Schémas dont la première opération qui les emploie appartient à la famille historical-simulation. 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. Elles sont reproduites telles quelles pour rester la source de vérité.
ChangesOut
Sens des changements de recommandation, de la reference a la candidate.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
less_favourable | integer | oui | ||
more_favourable | integer | oui | ||
not_comparable | integer | oui | ||
same | integer | oui |
Employé par : historicalSimulationsGet, historicalSimulationsSeal
ComparisonOut
Comparaison candidate / reference ; comptes seulement.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
candidate | SideOut | oui | ||
changed | integer | oui | ||
changes | ChangesOut | oui | ||
default_impact | DefaultImpactOut | oui | ||
factors | map<string, FactorOut> | oui | ||
format | string | oui | ||
recorded | map<string, integer> | oui | ||
recorded_transitions | map<string, map<string, integer>> | oui | ||
reference | SideOut | oui | ||
segments | map<string, map<string, nexclara_api__api__v1__historical_schemas__SegmentOut>> | oui | ||
size | integer | oui | ||
transitions | map<string, map<string, integer>> | oui |
Employé par : historicalSimulationsGet, historicalSimulationsSeal
DatasetCreateIn
Gel d'un jeu historique pour un produit.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
criteria | DatasetCriteriaIn | oui | ||
product_id | string (uuid) | oui |
Employé par : historicalDatasetsFreeze
DatasetCriteriaIn
Periode (date de reference des evaluations, bornes comprises), population, exclusions.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
applicant_kinds | array<"natural_person" | "legal_entity"> | non | maxItems: 2 ; default: [] | |
exclude_channels | array<"desk" | "api" | "import" | "fixture"> | non | maxItems: 4 ; default: [] | |
exclude_recorded_outcomes | array<"approve" | "approve_with_conditions" | "review" | "decline"> | non | maxItems: 4 ; default: [] | |
min_completeness | string | null | non | pattern: "^(0(\\.\\d{1,4})?|1(\\.0{1,4})?)$" | |
period_from | string (date) | oui | ||
period_to | string (date) | oui |
Employé par : historicalDatasetsFreeze, historicalDatasetsGet, historicalDatasetsList, historicalSimulationsGet, historicalSimulationsSeal
DatasetOut
Jeu gele : criteres, comptes, empreinte. Aucun dossier n'est cite.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
created_at | string (date-time) | oui | ||
created_by | string (uuid) | oui | ||
criteria | DatasetCriteriaIn | oui | ||
excluded | map<string, integer> | oui | ||
fingerprint | string | oui | ||
id | string (uuid) | oui | ||
product_id | string (uuid) | oui | ||
scanned | integer | oui | ||
size | integer | oui |
Employé par : historicalDatasetsFreeze, historicalDatasetsGet, historicalDatasetsList, historicalSimulationsGet, historicalSimulationsSeal
DefaultImpactOut
Effet sur les defauts : NON MESURABLE, faute de donnees de resultat.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
measurable | false | oui | ||
reason | "no_outcome_data" | oui |
Employé par : historicalSimulationsGet, historicalSimulationsSeal
FactorOut
Une variable de la grille : dossiers compares, dossiers dont la tranche change de points.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
changed | integer | oui | ||
compared | integer | oui |
Employé par : historicalSimulationsGet, historicalSimulationsSeal
HistoricalReconstitutionOut
Verdict de la reconstitution d'une simulation, piece par piece.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
conforming | boolean | oui | ||
dataset_conforming | boolean | oui | ||
engine_version | string | oui | ||
mismatched_cases | integer | oui | ||
policies_conforming | boolean | oui | ||
recomputed_results_fingerprint | string | oui | ||
reconstituted_at | string (date-time) | oui | ||
results_conforming | boolean | oui | ||
seal_conforming | boolean | null | oui | ||
simulation_id | string (uuid) | oui | ||
stored_results_fingerprint | string | oui | ||
summary_conforming | boolean | oui |
Employé par : historicalSimulationsReconstitute
HistoricalSimulationCreateIn
Comparaison d'une politique candidate a une politique de reference, sur un jeu gele.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
candidate_policy_id | string (uuid) | oui | ||
dataset_id | string (uuid) | oui | ||
reference_policy_id | string (uuid) | oui |
Employé par : historicalSimulationsStart
HistoricalSimulationDetailOut
Simulation, son jeu, sa comparaison si elle est terminee, son sceau.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
attempts | integer | oui | ||
candidate_fingerprint | string | oui | ||
candidate_policy_id | string (uuid) | oui | ||
comparison | ComparisonOut | null | oui | ||
completed_at | string (date-time) | null | oui | ||
created_at | string (date-time) | oui | ||
created_by | string (uuid) | oui | ||
dataset | DatasetOut | oui | ||
dataset_id | string (uuid) | oui | ||
engine_version | string | oui | ||
failure_code | string | null | oui | ||
id | string (uuid) | oui | ||
processed | integer | oui | ||
reference_fingerprint | string | oui | ||
reference_policy_id | string (uuid) | oui | ||
results_fingerprint | string | null | oui | ||
row_version | integer | oui | ||
seal | SealOut | null | oui | ||
sealed | boolean | oui | ||
size | integer | oui | ||
started_at | string (date-time) | null | oui | ||
status | "queued" | "running" | "completed" | "failed" | oui |
Employé par : historicalSimulationsGet, historicalSimulationsSeal
HistoricalSimulationOut
Simulation historique : versions, moteur, etat du traitement.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
attempts | integer | oui | ||
candidate_fingerprint | string | oui | ||
candidate_policy_id | string (uuid) | oui | ||
completed_at | string (date-time) | null | oui | ||
created_at | string (date-time) | oui | ||
created_by | string (uuid) | oui | ||
dataset_id | string (uuid) | oui | ||
engine_version | string | oui | ||
failure_code | string | null | oui | ||
id | string (uuid) | oui | ||
processed | integer | oui | ||
reference_fingerprint | string | oui | ||
reference_policy_id | string (uuid) | oui | ||
results_fingerprint | string | null | oui | ||
row_version | integer | oui | ||
sealed | boolean | oui | ||
size | integer | oui | ||
started_at | string (date-time) | null | oui | ||
status | "queued" | "running" | "completed" | "failed" | oui |
Employé par : historicalSimulationsList, historicalSimulationsStart
SealDocumentOut
Ce que couvre le sceau : a conserver par l'institution avant toute revelation.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
candidate_policy_fingerprint | string | oui | ||
dataset_fingerprint | string | oui | ||
engine_version | string | oui | ||
format | string | oui | ||
kind | "seal" | oui | ||
reference_policy_fingerprint | string | oui | ||
results_fingerprint | string | oui | ||
run_id | string (uuid) | oui | ||
sealed_at | string | oui |
Employé par : historicalSimulationsGet, historicalSimulationsSeal
SealOut
Sceau d'une simulation : document, empreinte, auteur.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
document | SealDocumentOut | oui | ||
fingerprint | string | oui | ||
sealed_at | string (date-time) | oui | ||
sealed_by | string (uuid) | oui |
Employé par : historicalSimulationsGet, historicalSimulationsSeal
SealRequestIn
Sceau : version lue de la simulation.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
row_version | integer | oui | minimum: 1 |
Employé par : historicalSimulationsSeal
SideOut
Ce qu'une des deux politiques recommande sur le jeu.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
completeness | StatsOut | null | oui | ||
distribution | map<string, integer> | oui | ||
evaluated | integer | oui | ||
exclusions | map<string, integer> | oui | ||
forced_reviews | map<string, integer> | oui | ||
refused | integer | oui | ||
refused_fields | map<string, integer> | oui | ||
score | StatsOut | null | oui |
Employé par : historicalSimulationsGet, historicalSimulationsSeal
StatsOut
Effectif, minimum, mediane, maximum (chaines decimales).
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
count | integer | oui | ||
max | string | oui | ||
median | string | oui | ||
min | string | oui |
Employé par : historicalSimulationsGet, historicalSimulationsSeal
nexclara_api__api__v1__historical_schemas__SegmentOut
Un segment : taille, changements, et les deux repartitions.
Type : object
| Propriété | Type | Requis | Description | Contraintes |
|---|---|---|---|---|
candidate | map<string, integer> | oui | ||
changed | integer | oui | ||
reference | map<string, integer> | oui | ||
size | integer | oui |
Employé par : historicalSimulationsGet, historicalSimulationsSeal