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