Enriched Citations

models.enriched_citations - Data models for USPTO Enriched Citations API.

This module provides data models for representing responses from the USPTO Enriched Cited Reference Metadata API (v3). These models cover enriched citation records extracted from patent office actions using AI/NLP algorithms.

class pyUSPTO.models.enriched_citations.CitationCategoryCode(*values)[source]

Bases: Enum

Citation category codes indicating the relevance of cited documents.

These are standard patent citation categories used in search reports:: X - Particularly relevant if taken alone Y - Particularly relevant if combined with another document A - Technological background E - Earlier patent document published on or after the filing date L - Document cited for other reasons O - Non-written disclosure T - Theory or principle underlying the invention P - Intermediate document & - Member of the same patent family D - Document cited in the application

A = 'A'

AMPERSAND = '&'

D = 'D'

E = 'E'

L = 'L'

O = 'O'

P = 'P'

T = 'T'

X = 'X'

Y = 'Y'

class pyUSPTO.models.enriched_citations.EnrichedCitation(id='', patent_application_number=None, cited_document_identifier=None, publication_number=None, kind_code=None, country_code=None, inventor_name_text=None, office_action_date=None, office_action_category=None, citation_category_code=None, related_claim_number_text=None, examiner_cited_reference_indicator=None, applicant_cited_examiner_reference_indicator=None, npl_indicator=None, work_group_number=None, group_art_unit_number=None, tech_center=None, quality_summary_text=None, passage_location_text=<factory>, obsolete_document_identifier=None, create_user_identifier=None, create_date_time=None)[source]

Bases: object

Represent a single enriched citation record from an office action.

id: Unique identifier for this citation record.

patent_application_number: The application number (series code + serial number).

cited_document_identifier: Identification of the cited patent document.

publication_number: Publication number of the cited document.

kind_code: Kind code of the cited document (e.g., “A1”, “B2”).

country_code: Country code of the cited document.

inventor_name_text: Inventor or owner name from the cited document.

office_action_date: The date the office action was recorded.

office_action_category: Category of the office action (e.g., “CTNF”, “CTFR”).

citation_category_code: Relevance category code (X, Y, A, E, L, O, T, P, &, D).

related_claim_number_text: Comma-separated claim numbers related to this citation.

examiner_cited_reference_indicator: Whether the reference was cited by the examiner (Form PTO-892).

applicant_cited_examiner_reference_indicator: Whether the citation was from Form PTO-1449.

npl_indicator: Whether this is a non-patent literature citation.

work_group_number: The work group number.

group_art_unit_number: Four-digit art unit code for examiner assignment.

tech_center: Technology center code (first two digits of art unit).

quality_summary_text: Quality summary of the review status.

passage_location_text: Pipe-delimited passage locations related to the citation.

obsolete_document_identifier: Legacy document identifier from the IFW repository.

create_user_identifier: Job identifier that created this record.

create_date_time: Date and time the record was inserted in the database.

applicant_cited_examiner_reference_indicator: bool | None = None

citation_category_code: str | None = None

cited_document_identifier: str | None = None

country_code: str | None = None

create_date_time: datetime | None = None

create_user_identifier: str | None = None

examiner_cited_reference_indicator: bool | None = None

classmethod from_dict(data)[source]

Create an EnrichedCitation instance from a dictionary.

Parameters:: data (dict[str, Any]) – Dictionary containing enriched citation data from API response.
Returns:: An instance of EnrichedCitation.
Return type:: EnrichedCitation

group_art_unit_number: str | None = None

id: str = ''

inventor_name_text: str | None = None

kind_code: str | None = None

npl_indicator: bool | None = None

obsolete_document_identifier: str | None = None

office_action_category: str | None = None

office_action_date: datetime | None = None

passage_location_text: list[str]

patent_application_number: str | None = None

publication_number: str | None = None

quality_summary_text: str | None = None

related_claim_number_text: str | None = None

tech_center: str | None = None

to_dict()[source]

Convert the EnrichedCitation instance to a dictionary.

Returns:: Dictionary representation with camelCase keys.
Return type:: dict[str, Any]

work_group_number: str | None = None

class pyUSPTO.models.enriched_citations.EnrichedCitationFieldsResponse(api_key=None, api_version_number=None, api_url=None, api_documentation_url=None, api_status=None, field_count=0, fields=<factory>, last_data_updated_date=None)[source]

Bases: object

Response from the Enriched Citations API fields endpoint.

Contains metadata about the API including available field names and the last data update timestamp.

api_key: The dataset key (e.g., “enriched_cited_reference_metadata”).

api_version_number: API version (e.g., “v3”).

api_url: The URL of this fields endpoint.

api_documentation_url: URL to the Swagger documentation.

api_status: Publication status (e.g., “PUBLISHED”).

field_count: Number of available fields.

fields: List of available field names.

last_data_updated_date: Timestamp of the last data update (non-standard format).

api_documentation_url: str | None = None

api_key: str | None = None

api_status: str | None = None

api_url: str | None = None

api_version_number: str | None = None

field_count: int = 0

fields: list[str]

classmethod from_dict(data, include_raw_data=False)[source]

Create an EnrichedCitationFieldsResponse instance from a dictionary.

Parameters:

data (dict[str, Any]) – Dictionary containing API response data.
include_raw_data (bool) – Unused. Present for FromDictProtocol conformance.

Returns: