Entrez Document Summaries
eutils_esummaryFetch compact summaries for a set of UIDs to screen records by title, authors, journal, and date before downloading full records. Returns DocSums for UID lists or stored history sets.
Instructions
Fetch compact summaries (DocSums) for a set of UIDs.
Use this to screen records by title, authors, journal, and date before paying the cost of downloading full records.
Args:
db (string, optional): database, for example "pubmed". Required unless history is given.
uids (string[] | string, optional): UIDs or accessions.
history (object, optional): handle from eutils_esearch, eutils_epost, or eutils_elink.
retstart (number, optional): first record index, for history sets. Default 0.
retmax (number, optional): records to return for a history set. Default 20, max 500.
response_format ('markdown' | 'json'): output format. Default 'markdown'.
Supply either uids or history, never both.
Returns: { database, total, count, offset, has_more, next_offset?, batches?, records: [{ uid, title, authors[], journal, source, pubdate, volume, issue, pages, doi?, pmcid?, pubtype[], lang[] }] }
Non-PubMed databases return whichever scalar fields the DocSum carries.
Examples:
Use when: "show me the titles of these PMIDs" -> db="pubmed", uids=["31452104"]
Use when: screening a large result set -> pass history from eutils_esearch
Don't use when: you need the full abstract or sequence (use eutils_efetch)
Error Handling:
Refuses more than 500 UIDs per call and batches larger lists internally
Refuses to combine uids and history in one call
Rejects retmax above 500 rather than silently truncating
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| db | No | Entrez database, for example "pubmed". May be omitted when history is given. | |
| uids | No | UIDs or accession.version identifiers, as an array or a comma-separated string. Example: ["31452104", "31452105"]. | |
| retmax | No | Maximum summaries to return when using history (default 20, max 500). | |
| history | No | Pointer to a UID set stored on the NCBI History server. Pass back the object returned by a previous call, unchanged. | |
| retstart | No | Index of the first summary to return. Use with history. | |
| response_format | No | Output format: 'markdown' for human-readable text, or 'json' for machine-readable data. Default: 'markdown'. | markdown |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | ||
| total | Yes | ||
| offset | Yes | ||
| batches | No | Present when the UID list needed more than one request. | |
| records | Yes | ||
| database | Yes | ||
| has_more | Yes | ||
| next_offset | No |