predict_synthetic_binding
Generates deterministic synthetic MHC binding values from candidate peptides and HLA alleles for demos, teaching, and pipeline tests, not for scientific binding evidence.
Instructions
Create deterministic synthetic MHC binding values for demos and software tests from supplied candidates and alleles. Use only when teaching or testing the pipeline; use predict_mhci or predict_mhcii for configured scientific prediction. Output is marked synthetic and must not be treated as binding evidence.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| runId | Yes | Caller-chosen identifier linking this call to one research run. | |
| method | Yes | Algorithm or provider method selected for this operation; inspect allowed schema values. | |
| alleles | Yes | HLA allele identifiers relevant to the selected MHC class. | |
| candidates | Yes | Caller-supplied candidate records; required nested fields depend on this operation. | |
| proteinHash | Yes | SHA-256 identity of the protein sequence associated with these candidates. | |
| candidateType | Yes | MHC class or candidate category this operation applies to. | |
| methodVersion | Yes | Version of the selected calculation method. | |
| datasetVersion | Yes | Version label for the synthetic demonstration dataset. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | Whether execution completed successfully. | |
| data | No | Tool-specific result fields on success. | |
| meta | Yes | Run identifiers, timings, and input/output hashes. | |
| error | No | Structured failure on unsuccessful execution. |