ads.models.document

Document data model.

Classes

Document(*args, **kwargs)

A document in the SAO/NASA Astrophysics Data System.

class ads.models.document.Document(*args, **kwargs)

A document in the SAO/NASA Astrophysics Data System.

id = <IntegerField: Document.id>

A unique identifier for the document, curated by ADS.

abstract = <TextField: Document.abstract>

The document abstract.

ack = <VirtualField: Document.ack>

Search for a word or phrase in the acknowledgements extracted from fulltexts.

aff = <ArrayField: Document.aff>

The raw, provided affiliation field.

aff_id = <ArrayField: Document.aff_id>

Curated affiliation identifier, parsed from the given affiliation string. See https://ui.adsabs.harvard.edu/blog/affils-update for more details.

alternate_bibcode = <ArrayField: Document.alternate_bibcode>

An alternate bibcode.

alternate_title = <TextField: Document.alternate_title>

Alternate title, usually present when the original title is not in English.

arxiv_class = <TextField: Document.arxiv_class>

The arXiv class a document was submitted to.

author = <ArrayField: Document.author>

Author name.

author_count = <IntegerField: Document.author_count>

The number of authors.

author_norm = <ArrayField: Document.author_norm>

Author name in the form ‘Lastname, F’.

bibcode = <TextField: Document.bibcode>

Document bibliographic code. See https://ui.adsabs.harvard.edu/help/actions/bibcode for more information.

bibgroup = <TextField: Document.bibgroup>

Records by bibliographic groups, curated by staff outside of ADS.

bibstem = <ArrayField: Document.bibstem>

Abbreviated name of the journal or publication (e.g., ApJ).

body = <VirtualField: Document.body>

Search for a word or phrase in (only) the full text.

citation_count = <IntegerField: Document.citation_count>

The number of citations to this document.

citation_count_norm = <FloatField: Document.citation_count_norm>

Normalised citation count.

cite_read_boost = <IntegerField: Document.cite_read_boost>

The normalized boost factor.

classic_factor = <FloatField: Document.classic_factor>

A classic prestige score, designed to more highly rank papers that are relevant and popular now.

data = <TextField: Document.data>

Related data sources.

database = <ArrayField: Document.database>

The database the document resides in (e.g., astronomy or physics).

date = <DateTimeField: Document.date>

Publication date, represented by a time format and used for indexing.

doctype = <TextField: Document.doctype>

Document type (e.g., article, thesis, etc.

doi = <ArrayField: Document.doi>

Digital object identifier

eid = <TextField: Document.eid>

Electronic identifier of the paper, which is the equivalent of a page number.

email = <ArrayField: Document.email>

Email addresses of the authors.

entry_date = <DateTimeField: Document.entry_date>

Creation date of the ADS record.

esources = <ArrayField: Document.esources>

Types of electronic sources available for a record (e.g., PUB_HTML, EPRINT_PDF).

facility = <ArrayField: Document.facility>

Facilities declared in a record, based on a controlled list by AAS journals.

grant = <TextField: Document.grant>

Search by grant identifiers and grant agencies (ads.Document.grant_id and ads.Document.grant_agencies).

grant_agencies = <TextField: Document.grant_agencies>

A field with just the grant agencies name (e.g., NASA).

grant_id = <TextField: Document.grant_id>

Search by grant identifier.

identifier = <ArrayField: Document.identifier>

Search by an array of alternative identifiers for a record. May contain alternative bibcodes, DOIs, and/or arXiv identifiers.

indexstamp = <DateTimeField: Document.indexstamp>

Datetime when the document was last index by the ADS Solr service.

inst = <VirtualField: Document.inst>

Find records that contain a curated (ADS-identified) affiliation or institution. See also: ads.Document.affiliation.

isbn = <TextField: Document.isbn>

International Standard Book Number

issn = <ArrayField: Document.issn>

International Standard Serial NUmber

issue = <TextField: Document.issue>

Issue number of the journal that includes the article.

keyword = <TextField: Document.keyword>

An array of normalized and non-normalized keyword values associated with the record.

lang = <TextField: Document.lang>

The language of the main title.

links_data = <TextField: Document.links_data>

Information on what linked documents are available.

nedid = <ArrayField: Document.nedid>

List of NED IDs for a record.

nedtype = <ArrayField: Document.nedtype>

Keywords used to describe the NED type (e.g., galaxy, star).

orcid_other = <ArrayField: Document.orcid_other>

ORCID claims from users who used the ADS claiming interface.

orcid_pub = <ArrayField: Document.orcid_pub>

ORCIDs supplied by publishers.

orcid_user = <ArrayField: Document.orcid_user>

ORCID claims from users who gave ADS consent to expose their public profile.

page = <ArrayField: Document.page>

Page number of a record.

page_count = <IntegerField: Document.page_count>

The difference between the first and last page numbers in ads.Document.page_range.

property = <ArrayField: Document.property>

An array of miscellaneous flags associated with a record. Examples include: refereed, notrefereed, article, nonarticle, ads_openaccess, eprint_openaccess, pub_openaccess, openaccess, ocrabstract.

pub = <TextField: Document.pub>

The canonical name of the publication that the record appeared in.

pub_raw = <TextField: Document.pub_raw>

Name of the publisher, but also includes the volume, page, and issue if exists.

pubdate = <DateField: Document.pubdate>

Publication date in the form YYYY-MM-DD, where DD will always be ‘00’.

read_count = <IntegerField: Document.read_count>

The number of times the record has been viewed within a 90 day window.

score = <FloatField: Document.score>

The closeness of the document to the query match.

simbid = <ArrayField: Document.simbid>

List of SIMBAD IDs within a document. This field has privacy restrictions.

simbtype = <ArrayField: Document.simbtype>

Keywords used to describe the SIMBAD type.

title = <ArrayField: Document.title>

The title of the record.

vizier = <TextField: Document.vizier>

Keywords, ‘subject’ tags from Vizier.

volume = <IntegerField: Document.volume>

The journal volume.

year = <IntegerField: Document.year>

Year of publication.

affiliation = <AffiliationField: Document.affiliation>

Any ads.Affiliation objects associated with the record, parsed from the ads.Document.aff_id field.

journal = <JournalField: Document.journal>

The ads.Journal associated with the record, parsed from the ads.Document.bibcode field.

abs = <VirtualField: Document.abs>

Search for a word or phrase in ads.Document.abstract, ads.Document.title, and ads.Document.keyword.

all = <VirtualField: Document.all>

Search by ads.Document.author_norm, ads.Document.alternate_title, ads.Document.bibcode, ads.Document.doi, and ads.Document.identifier.

arxiv = <VirtualField: Document.arxiv>

Search by arXiv identifier.

full = <VirtualField: Document.full>

Search by ads.Document.title, ads.Document.abstract, ads.Document.body, ads.Document.keyword, and ads.Document.ack.

orcid = <VirtualField: Document.orcid>

Search by ORCID identifier, from all possible sources: ads.Document.orcid_other, ads.Document.orcid_pub, and ads.Document.orcid_user.

classmethod citations(expression)

Return documents that cite documents returned by the given expression.

Do you want ads.Document.citations or ads.Document.references?

• citations(Document.bibcode == "2003AJ....125..525J") returns documents that cite the document with bibcode 2003AJ....125..525J.

• references(Document.bibcode == "2003AJ....125..525J") returns documents that are cited by the document with bibcode 2003AJ....125..525J.

See https://ui.adsabs.harvard.edu/help/search/citations-and-references for more details.

Parameters

expression – The expression to search for. Documents that cite documents returned by this expression will be returned.

classmethod citis(expression)

A different implementation of ads.Document.citations that uses less memory, but is slower.

Parameters

expression – The expression to search for. Documents that cite documents returned by this expression will be returned.

classmethod classic_relevance(expression)

A toy implementation of the ADS Classic relevance score algorithm. You can wrap any query in this operator and obtain the hits sorted (almost) in the ADS Classic way.

Parameters

expression – The search expression.

classmethod instructive(expression)

Return documents that are the synonymn of ads.Document.reviews.

Parameters

expression – The expression to search for instructive papers.

classmethod join_citations(expression)

This operator is the equivalent of ads.Document.citations but using a Lucene block-join.

In Solr syntax, this operator is called joincitations(), not join_citations().

Parameters

expression – The expression to join citations for.

classmethod join_references(expression)

This operator is the equivalent of ads.Document.references but using a Lucene block-join.

In Solr syntax, this operator is called joinreferences(), not join_references().

Parameters

expression – The expression to join references for.

classmethod pos(expression, position, end_position=None)

Return documents where the given expression is matched only by an item in a given position, or range of positions (e.g., author or affiliation position).

Parameters

• expression – The search expression to match against.

• position – The start position (1-indexed) to match against. For example, if searching by author name then use position=1 for first author.

• end_position – [optional] The end position value. If None is given (default) then it defaults to position.

classmethod references(expression)

Return documents that are cited by documents in the given expression.

Do you want ads.Document.citations or ads.Document.references?

• citations(Document.bibcode == "2003AJ....125..525J") returns documents that cite the document with bibcode 2003AJ....125..525J.

• references(Document.bibcode == "2003AJ....125..525J") returns documents that are cited by the document with bibcode 2003AJ....125..525J.

See https://ui.adsabs.harvard.edu/help/search/citations-and-references for more details.

Parameters

expression – The search expression to find references for.

classmethod reviews(expression)

The reviews operator takes the list of articles which cited the papers in the given expression, combines them, and returns this list sorted by how frequently a citing paper appears in the combined list.

The documents returned cite the most relevant papers on the topic being researched; these are papers containing the most extensive reviews of the field.

See https://ui.adsabs.harvard.edu/help/search/second-order for more details.

Parameters

expression – The expression to find reviews articles for.

classmethod reviews2(expression)

The original implementation of the ads.Document.reviews operator.

Parameters

expression – The expression to find reviews articles for.

classmethod similar(expression)

Return documents that have abstracts similar in wording to documents returned by the given expression.

See https://ui.adsabs.harvard.edu/help/search/second-order for more details.

Parameters

expression – The expression to use to find documents to compare against.

classmethod top_n(n, expression, order_by=None)

Return the top n documents matching the given expression.

In Solr syntax, this operator is called topn(), not top_n().

Parameters

• n – The number of documents to return.

• expression – The expression to query documents.

classmethod trending(expression)

Query documents that are most read by users who read recent papers on the topic being researched. These are papers currently being read by people interested in this field.

See https://ui.adsabs.harvard.edu/help/search/second-order for more details.

Parameters

expression – The expression to search for trending documents.

classmethod useful(expression)

Return documents frequently cited by the most relevant papers returned by the given expression.

These are usually studies that discuss methods and techniques useful to conduct research in the field.

Parameters

expression – The search expression to find useful articles for.

classmethod useful2(expression)

The original implementation of the ads.Document.useful operator.

Parameters

expression – The expression to search for useful documents.

DoesNotExist

alias of ads.models.document.DocumentDoesNotExist