Skip to content

Commit 3fdc646

Browse files
markgeejwgithub-actions[bot]
authored andcommitted
docs: sync API specs from openprotein-api
1 parent f968c98 commit 3fdc646

2 files changed

Lines changed: 65 additions & 6 deletions

File tree

source/_static/js/foldSpec.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ const foldSpec = {
240240
tags: ["fold requests", "esmfold2"],
241241
summary: "ESMFold2",
242242
description:
243-
"Create structure prediction using ESMFold2, an all-atom structure prediction\nmodel. Folds protein/DNA/RNA/ligand complexes, optionally conditioned on an MSA.\n\nArgs:\n - `sequences`: List of chain/molecule entities in the input. Each entry describes a protein, nucleic acid, or ligand, including its sequence, identifier(s), and optional attributes such as msa_id, SMILES string, CCD code.\n - `msa_id` should refer to the id of an msa job which included this protein as a query, or `null` for single sequence mode.\n - `smiles` and `ccd` are mutually exclusive for ligands.\n - `diffusion_samples`: Number of diffusion samples to use. Controls how many independent structure samples are generated per input. Default is 1.\n - `num_steps`: Number of sampling steps to use. Sets the number of steps in the diffusion process for each sample. Default is 200.\n - `num_recycles`: Number of recycling steps to use. Determines how many times the model refines its prediction iteratively. Default is 3.\n - `seed`: Random seed for reproducible sampling. `null` lets the system decide.",
243+
"Create structure prediction using ESMFold2, an all-atom structure prediction\nmodel. Folds protein/DNA/RNA/ligand complexes, optionally conditioned on an MSA.\n\nArgs:\n - `sequences`: List of chain/molecule entities in the input. Each entry describes a protein, nucleic acid, or ligand, including its sequence, identifier(s), and optional attributes such as msa_id, SMILES string, CCD code.\n - `msa_id` should refer to the id of an msa job which included this protein as a query, or `null` for single sequence mode.\n - `smiles` and `ccd` are mutually exclusive for ligands.\n - `diffusion_samples`: Number of diffusion samples to use. Controls how many independent structure samples are generated per input. Default is 1.\n - `num_steps`: Number of sampling steps to use. Sets the number of steps in the diffusion process for each sample. Default is 100.\n - `num_recycles`: Number of recycling steps to use. Determines how many times the model refines its prediction iteratively. Default is 3.\n - `seed`: Random seed for reproducible sampling. `null` lets the system decide.",
244244
requestBody: {
245245
description: "Request for structure prediction.",
246246
content: {
@@ -328,7 +328,7 @@ const foldSpec = {
328328
tags: ["fold requests", "esmfold2"],
329329
summary: "ESMFold2-Fast",
330330
description:
331-
"Create structure prediction using ESMFold2-Fast, an inference-optimized\nsingle-sequence variant of ESMFold2 whose folding trunk has half the depth\n(24 vs 48 layers). Folds protein/DNA/RNA/ligand complexes.\n\nUnlike ESMFold2, ESMFold2-Fast is single-sequence only and does not accept\nan MSA (`msa_id`).\n\nArgs:\n - `sequences`: List of chain/molecule entities in the input. Each entry describes a protein, nucleic acid, or ligand, including its sequence, identifier(s), and optional attributes such as SMILES string, CCD code.\n - `smiles` and `ccd` are mutually exclusive for ligands.\n - `diffusion_samples`: Number of diffusion samples to use. Controls how many independent structure samples are generated per input. Default is 1.\n - `num_steps`: Number of sampling steps to use. Sets the number of steps in the diffusion process for each sample. Default is 200.\n - `num_recycles`: Number of recycling steps to use. Determines how many times the model refines its prediction iteratively. Default is 3.\n - `seed`: Random seed for reproducible sampling. `null` lets the system decide.",
331+
"Create structure prediction using ESMFold2-Fast, an inference-optimized\nsingle-sequence variant of ESMFold2 whose folding trunk has half the depth\n(24 vs 48 layers). Folds protein/DNA/RNA/ligand complexes.\n\nUnlike ESMFold2, ESMFold2-Fast is single-sequence only and does not accept\nan MSA (`msa_id`).\n\nArgs:\n - `sequences`: List of chain/molecule entities in the input. Each entry describes a protein, nucleic acid, or ligand, including its sequence, identifier(s), and optional attributes such as SMILES string, CCD code.\n - `smiles` and `ccd` are mutually exclusive for ligands.\n - `diffusion_samples`: Number of diffusion samples to use. Controls how many independent structure samples are generated per input. Default is 1.\n - `num_steps`: Number of sampling steps to use. Sets the number of steps in the diffusion process for each sample. Default is 100.\n - `num_recycles`: Number of recycling steps to use. Determines how many times the model refines its prediction iteratively. Default is 3.\n - `seed`: Random seed for reproducible sampling. `null` lets the system decide.",
332332
requestBody: {
333333
description: "Request for structure prediction.",
334334
content: {
@@ -2006,7 +2006,7 @@ const foldSpec = {
20062006
type: "integer",
20072007
description: "Number of sampling steps to use.",
20082008
minimum: 1,
2009-
default: 200,
2009+
default: 100,
20102010
},
20112011
num_recycles: {
20122012
type: "integer",
@@ -2047,7 +2047,7 @@ const foldSpec = {
20472047
],
20482048
],
20492049
diffusion_samples: 1,
2050-
num_steps: 200,
2050+
num_steps: 100,
20512051
num_recycles: 3,
20522052
},
20532053
},
@@ -2091,7 +2091,7 @@ const foldSpec = {
20912091
type: "integer",
20922092
description: "Number of sampling steps to use.",
20932093
minimum: 1,
2094-
default: 200,
2094+
default: 100,
20952095
},
20962096
num_recycles: {
20972097
type: "integer",
@@ -2131,7 +2131,7 @@ const foldSpec = {
21312131
],
21322132
],
21332133
diffusion_samples: 1,
2134-
num_steps: 200,
2134+
num_steps: 100,
21352135
num_recycles: 3,
21362136
},
21372137
},

source/_static/js/promptSpec.js

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,48 @@ const promptSpec = {
107107
format: "uuid",
108108
},
109109
},
110+
{
111+
name: "scope",
112+
in: "query",
113+
description:
114+
"Restrict the listing to the caller's own prompts (`mine`, the\ndefault), platform system prompts (`system`), or both (`all`).",
115+
required: false,
116+
schema: {
117+
type: "string",
118+
enum: ["mine", "system", "all"],
119+
default: "mine",
120+
},
121+
},
122+
{
123+
name: "search",
124+
in: "query",
125+
description:
126+
"Case-insensitive substring matched against prompt name and description.",
127+
required: false,
128+
schema: {
129+
type: "string",
130+
},
131+
},
132+
{
133+
name: "page_size",
134+
in: "query",
135+
description: "Maximum number of prompts to return.",
136+
required: false,
137+
schema: {
138+
type: "integer",
139+
default: 1024,
140+
},
141+
},
142+
{
143+
name: "page_offset",
144+
in: "query",
145+
description: "Number of prompts to skip before returning results.",
146+
required: false,
147+
schema: {
148+
type: "integer",
149+
default: 0,
150+
},
151+
},
110152
],
111153
responses: {
112154
200: {
@@ -587,6 +629,17 @@ const promptSpec = {
587629
},
588630
},
589631
},
632+
403: {
633+
description:
634+
"The target prompt is a platform system prompt and cannot be modified.",
635+
content: {
636+
"application/json": {
637+
schema: {
638+
$ref: "#/components/schemas/Error",
639+
},
640+
},
641+
},
642+
},
590643
404: {
591644
description: "Prompt not found.",
592645
content: {
@@ -1365,6 +1418,12 @@ const promptSpec = {
13651418
type: "integer",
13661419
nullable: true,
13671420
},
1421+
is_system: {
1422+
type: "boolean",
1423+
default: false,
1424+
description:
1425+
"True for platform-curated system prompts available to every user.\nSystem prompts are read-only over the HTTP API; users cannot create,\nmodify, or delete them. False or absent for user-uploaded prompts.",
1426+
},
13681427
},
13691428
},
13701429
Error: {

0 commit comments

Comments
 (0)