Get Entity Summary

Previous value: -"Entity identifiers (1-10). Type depends on entityType:\n- assay: AID (number), e.g. [1000]\n- gene: Gene ID (number), e.g. [1956]\n- protein: UniProt accession (string), e.g. [\"P00533\"]\n- taxonomy: Tax ID (number), e.g. [9606]"New value: +"Entity identifiers. A comma-joined string is split into one identifier per piece, with whitespace trimmed. The per-call cap is 10 pieces: the first 10 are looked up, and any past that are returned in unprocessed, in input order, and reported in cappedInputs. More than 1000 pieces in all fails the call. ID form depends on entityType:\n- assay: AID, a positive integer, e.g. [\"1000\"]\n- gene: NCBI Gene ID, a positive integer, e.g. [\"1956\"]\n- protein: UniProt accession, e.g. [\"P00533\"]\n- taxonomy: NCBI Taxonomy ID, a positive integer, e.g. [\"9606\"]\nFor assay, gene, and taxonomy, a piece that is not a positive integer written in digits is marked invalid and not looked up."

Removed value: -[
-  {
-    "description": "String identifier (e.g. UniProt accession).",
-    "type": "string"
-  },
-  {
-    "description": "Numeric identifier (e.g. AID, Gene ID, Tax ID).",
-    "type": "number"
-  }
-]

Previous value: -"Entity identifier — string or number depending on entityType."New value: +"Entity identifier, or several joined with commas."

Added value: +"string"

Previous value: -10New value: +1000

Added value: +{
+  "description": "Inputs that asked for more than their per-call cap, with the value requested and the value served. An ID batch lists the IDs past the cap in unprocessed. Omitted when every input was within its cap.",
+  "items": {
+    "additionalProperties": false,
+    "description": "One input served at its per-call cap.",
+    "properties": {
+      "input": {
+        "description": "Input name, e.g. \"maxResults\" or \"cids\".",
+        "type": "string"
+      },
+      "requested": {
+        "description": "Value requested: the page size, or the number of IDs in the batch.",
+        "type": "number"
+      },
+      "served": {
+        "description": "Value served: the per-call cap.",
+        "type": "number"
+      },
+      "unprocessed": {
+        "description": "ID batches only: IDs past the cap, listed in unprocessed in input order.",
+        "type": "number"
+      }
+    },
+    "required": [
+      "input",
+      "requested",
+      "served"
+    ],
+    "type": "object"
+  },
+  "type": "array"
+}

Previous value: -"Machine-readable failure mode."New value: +"Machine-readable failure mode. Declared by this tool: `too_many_identifiers`: Comma splitting yields more than 1000 identifier pieces. `invalid_identifier`: No identifier piece is usable: every piece is blank, or, for assay, gene, or taxonomy, not a positive integer. Other values are possible when a failure originates below the handler."

Added value: +[
+  "too_many_identifiers",
+  "invalid_identifier"
+]

Previous value: -"Recovery guidance when one or more identifiers were not found."New value: +"Recovery guidance when identifiers were invalid or not found."

Previous value: -"Identifiers requested."New value: +"Identifier pieces requested, counted after comma splitting."

Previous value: -"Summary results."New value: +"Summary results, one per identifier piece looked up, in input order."

Added value: +{
+  "description": "Date the assay's data last changed, YYYY-MM-DD (assay summaries).",
+  "type": "string"
+}

Added value: +{
+  "description": "Assay method as PubChem labels it, e.g. \"confirmatory\" (dose-response) or \"screening\" (assay summaries). Omitted when PubChem records none.",
+  "type": "string"
+}

Added value: +{
+  "description": "Compounds (CIDs) the assay marked active (assay summaries).",
+  "type": "number"
+}

Added value: +{
+  "description": "Compounds (CIDs) tested (assay summaries). List them with pubchem_search_compounds searchType \"assay\" and activeOnly: false — its default lists only the actives.",
+  "type": "number"
+}

Added value: +{
+  "description": "Number of targets PubChem lists for the assay (assay summaries).",
+  "type": "number"
+}

Added value: +{
+  "description": "Assay targets, the first 25 PubChem lists (assay summaries); targetCount gives the full number.",
+  "items": {
+    "additionalProperties": false,
+    "description": "Assay target.",
+    "properties": {
+      "accession": {
+        "description": "Target protein or gene accession.",
+        "type": "string"
+      },
+      "name": {
+        "description": "Target name.",
+        "type": "string"
+      }
+    },
+    "type": "object"
+  },
+  "type": "array"
+}

Previous value: -"Queried identifier."New value: +"Queried identifier: a number for assay, gene, and taxonomy; the accession for protein; the piece as sent when invalid."

Added value: +{
+  "description": "True when the identifier is not in the form entityType expects; it was not looked up. Omitted otherwise.",
+  "type": "boolean"
+}

Added value: +{
+  "description": "Identifier pieces past the per-call cap of 10, in input order, not looked up. Pass them in a follow-up call. Omitted when every piece was served.",
+  "items": {
+    "type": "string"
+  },
+  "type": "array"
+}

Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"

Added value: +false

Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"

Added value: +[
+  {
+    "not": {
+      "required": [
+        "error"
+      ]
+    },
+    "required": [
+      "entityType",
+      "summaries",
+      "requestedCount",
+      "foundCount"
+    ]
+  },
+  {
+    "required": [
+      "error"
+    ]
+  }
+]

Added value: +{
+  "additionalProperties": {},
+  "description": "Present when the call failed. Absent on success.",
+  "properties": {
+    "code": {
+      "description": "JSON-RPC error code for this failure.",
+      "maximum": 9007199254740991,
+      "minimum": -9007199254740991,
+      "type": "integer"
+    },
+    "data": {
+      "additionalProperties": {},
+      "properties": {
+        "reason": {
+          "description": "Machine-readable failure mode.",
+          "type": "string"
+        },
+        "recovery": {
+          "additionalProperties": {},
+          "description": "Actionable next step for the caller.",
+          "properties": {
+            "hint": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "hint"
+          ],
+          "type": "object"
+        },
+        "retryable": {
+          "description": "Whether retrying may succeed.",
+          "type": "boolean"
+        }
+      },
+      "type": "object"
+    },
+    "message": {
+      "description": "Human-readable description of what went wrong.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "code",
+    "message"
+  ],
+  "type": "object"
+}

Removed value: -[
-  "entityType",
-  "summaries",
-  "requestedCount",
-  "foundCount"
-]

Previous value: -"Parent taxonomy lineage (taxonomy summaries)."New value: +"Taxonomic lineage ordered from the most inclusive rank to the most specific, e.g. [\"Eukaryota\", \"Metazoa\", \"Chordata\"] (taxonomy summaries). Ranks that do not apply to the entity are omitted."

Added value: +{
+  "description": "Identifiers resolved to a summary.",
+  "type": "number"
+}

Added value: +{
+  "description": "Recovery guidance when one or more identifiers were not found.",
+  "type": "string"
+}

Added value: +{
+  "description": "Identifiers requested.",
+  "type": "number"
+}

Previous value: -[
-  "entityType",
-  "summaries"
-]New value: +[
+  "entityType",
+  "summaries",
+  "requestedCount",
+  "foundCount"
+]

Previous value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "number"
-  }
-]New value: +[
+  {
+    "description": "String identifier (e.g. UniProt accession).",
+    "type": "string"
+  },
+  {
+    "description": "Numeric identifier (e.g. AID, Gene ID, Tax ID).",
+    "type": "number"
+  }
+]

Added value: +"Entity identifier — string or number depending on entityType."

Added value: +"Per-identifier summary result."

Previous value: -{}New value: +false

Previous value: -"Entity summary data (shape varies by type)."New value: +"Entity summary data. Populated fields depend on entityType."

Added value: +{
+  "aid": {
+    "description": "Assay ID — present on assay summaries.",
+    "type": "number"
+  },
+  "commonName": {
+    "description": "Common name (taxonomy summaries).",
+    "type": "string"
+  },
+  "description": {
+    "description": "Descriptive text when available.",
+    "type": "string"
+  },
+  "geneId": {
+    "description": "NCBI Gene ID (gene summaries).",
+    "type": "number"
+  },
+  "lineage": {
+    "description": "Parent taxonomy lineage (taxonomy summaries).",
+    "items": {
+      "type": "string"
+    },
+    "type": "array"
+  },
+  "name": {
+    "description": "Primary display name.",
+    "type": "string"
+  },
+  "numActive": {
+    "description": "Substances marked active (assay summaries).",
+    "type": "number"
+  },
+  "numSubstances": {
+    "description": "Substances tested (assay summaries).",
+    "type": "number"
+  },
+  "proteinAccession": {
+    "description": "Protein accession (protein summaries).",
+    "type": "string"
+  },
+  "rank": {
+    "description": "Taxonomic rank (taxonomy summaries).",
+    "type": "string"
+  },
+  "scientificName": {
+    "description": "Scientific name (taxonomy summaries).",
+    "type": "string"
+  },
+  "sourceName": {
+    "description": "Data source attribution (assay summaries).",
+    "type": "string"
+  },
+  "symbol": {
+    "description": "Gene symbol (gene summaries).",
+    "type": "string"
+  },
+  "synonyms": {
+    "description": "Known synonyms / other names.",
+    "items": {
+      "type": "string"
+    },
+    "type": "array"
+  },
+  "taxonomy": {
+    "description": "Taxonomy scientific name (gene/protein summaries).",
+    "type": "string"
+  },
+  "taxonomyId": {
+    "description": "NCBI Taxonomy ID (gene/protein/taxonomy summaries).",
+    "type": "number"
+  }
+}

Removed value: -{
-  "type": "string"
-}

Previous value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "number"
-  }
-]New value: +[
+  {
+    "description": "String identifier (e.g. UniProt accession).",
+    "type": "string"
+  },
+  {
+    "description": "Numeric identifier (e.g. AID, Gene ID, Tax ID).",
+    "type": "number"
+  }
+]