INPADOC Published Data#

Manager#

class patent_client.epo.ops.published.manager.SearchManager(config=None)[source]#
result_size = 100#
primary_key = 'publication'#
async alen() int[source]#
async aget(number, doc_type='publication', format='docdb') BiblioResult[source]#

If the critera results in a single record, return it, else raise an exception

Models#

class patent_client.epo.ops.published.model.BiblioResult(*, documents: list[patent_client.epo.ops.published.model.biblio.InpadocBiblio] = None)[source]#
documents: list[patent_client.epo.ops.published.model.biblio.InpadocBiblio]#
model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,)}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'documents': FieldInfo(annotation=list[InpadocBiblio], required=False, default_factory=list)}#

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client.epo.ops.published.model.InpadocBiblio(*, country: Optional[str] = None, doc_number: Optional[str] = None, kind: Optional[str] = None, family_id: Optional[str] = None, publication_number: Optional[str] = None, application_number: Optional[str] = None, publication_reference_docdb: Optional[DocumentId] = None, publication_reference_epodoc: Optional[DocumentId] = None, publication_reference_original: Optional[DocumentId] = None, application_reference_docdb: Optional[DocumentId] = None, application_reference_epodoc: Optional[DocumentId] = None, application_reference_original: Optional[DocumentId] = None, intl_class: List[str] = None, cpc_class: List[str] = None, us_class: List[str] = None, priority_claims: List[DocumentId] = None, title: Optional[str] = None, titles: List[Title] = None, abstract: Optional[str] = None, citations: List[Citation] = None, applicants_epodoc: List[str] = None, applicants_original: List[str] = None, inventors_epodoc: List[str] = None, inventors_original: List[str] = None)[source]#
country: Optional[str]#
doc_number: Optional[str]#
kind: Optional[str]#
family_id: Optional[str]#
publication_number: Optional[str]#
application_number: Optional[str]#
publication_reference_docdb: Optional[DocumentId]#
publication_reference_epodoc: Optional[DocumentId]#
publication_reference_original: Optional[DocumentId]#
application_reference_docdb: Optional[DocumentId]#
application_reference_epodoc: Optional[DocumentId]#
application_reference_original: Optional[DocumentId]#
intl_class: List[str]#
cpc_class: List[str]#
us_class: List[str]#
priority_claims: List[DocumentId]#
title: Optional[str]#
titles: List[Title]#
abstract: Optional[str]#
citations: List[Citation]#
applicants_epodoc: List[str]#
applicants_original: List[str]#
inventors_epodoc: List[str]#
inventors_original: List[str]#
model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,)}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'abstract': FieldInfo(annotation=Union[str, NoneType], required=False), 'applicants_epodoc': FieldInfo(annotation=List[str], required=False, default_factory=list), 'applicants_original': FieldInfo(annotation=List[str], required=False, default_factory=list), 'application_number': FieldInfo(annotation=Union[str, NoneType], required=False), 'application_reference_docdb': FieldInfo(annotation=Union[DocumentId, NoneType], required=False), 'application_reference_epodoc': FieldInfo(annotation=Union[DocumentId, NoneType], required=False), 'application_reference_original': FieldInfo(annotation=Union[DocumentId, NoneType], required=False), 'citations': FieldInfo(annotation=List[Citation], required=False, default_factory=list), 'country': FieldInfo(annotation=Union[str, NoneType], required=False), 'cpc_class': FieldInfo(annotation=List[str], required=False, default_factory=list), 'doc_number': FieldInfo(annotation=Union[str, NoneType], required=False), 'family_id': FieldInfo(annotation=Union[str, NoneType], required=False), 'intl_class': FieldInfo(annotation=List[str], required=False, default_factory=list), 'inventors_epodoc': FieldInfo(annotation=List[str], required=False, default_factory=list), 'inventors_original': FieldInfo(annotation=List[str], required=False, default_factory=list), 'kind': FieldInfo(annotation=Union[str, NoneType], required=False), 'priority_claims': FieldInfo(annotation=List[DocumentId], required=False, default_factory=list), 'publication_number': FieldInfo(annotation=Union[str, NoneType], required=False), 'publication_reference_docdb': FieldInfo(annotation=Union[DocumentId, NoneType], required=False), 'publication_reference_epodoc': FieldInfo(annotation=Union[DocumentId, NoneType], required=False), 'publication_reference_original': FieldInfo(annotation=Union[DocumentId, NoneType], required=False), 'title': FieldInfo(annotation=Union[str, NoneType], required=False), 'titles': FieldInfo(annotation=List[Title], required=False, default_factory=list), 'us_class': FieldInfo(annotation=List[str], required=False, default_factory=list)}#

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client.epo.ops.published.model.Claims(*, document_id: Optional[FTDocumentId] = None, claims: List[Claim] = None, claim_text: Optional[str] = None)[source]#
document_id: Optional[FTDocumentId]#
claims: List[Claim]#
claim_text: Optional[str]#
property docdb_number: str#
model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,)}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'claim_text': FieldInfo(annotation=Union[str, NoneType], required=False), 'claims': FieldInfo(annotation=List[Claim], required=False, default_factory=list), 'document_id': FieldInfo(annotation=Union[FTDocumentId, NoneType], required=False)}#

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client.epo.ops.published.model.Description(*, document_id: Optional[FTDocumentId] = None, description: Optional[str] = None)[source]#
document_id: Optional[FTDocumentId]#
description: Optional[str]#
property docdb_number: str#
model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,)}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'description': FieldInfo(annotation=Union[str, NoneType], required=False), 'document_id': FieldInfo(annotation=Union[FTDocumentId, NoneType], required=False)}#

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client.epo.ops.published.model.Images(*, publication_number: Optional[str] = None, full_document: Optional[ImageDocument] = None, drawing: Optional[ImageDocument] = None, first_page: Optional[ImageDocument] = None)[source]#
publication_number: Optional[str]#
full_document: Optional[ImageDocument]#
drawing: Optional[ImageDocument]#
first_page: Optional[ImageDocument]#
property docdb_number: str#
model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,)}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'drawing': FieldInfo(annotation=Union[ImageDocument, NoneType], required=False), 'first_page': FieldInfo(annotation=Union[ImageDocument, NoneType], required=False), 'full_document': FieldInfo(annotation=Union[ImageDocument, NoneType], required=False), 'publication_number': FieldInfo(annotation=Union[str, NoneType], required=False)}#

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client.epo.ops.published.model.ImageDocument(*, num_pages: Optional[int] = None, description: Optional[str] = None, link: Optional[str] = None, formats: List[str] = None, sections: List[Section] = None, doc_number: Optional[str] = None)[source]#
num_pages: Optional[int]#
description: Optional[str]#
formats: List[str]#
sections: List[Section]#
doc_number: Optional[str]#
download(path='.')[source]#
download_image(path='.', image_format='tif', page_number=1)[source]#
model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,)}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'description': FieldInfo(annotation=Union[str, NoneType], required=False), 'doc_number': FieldInfo(annotation=Union[str, NoneType], required=False), 'formats': FieldInfo(annotation=List[str], required=False, default_factory=list), 'link': FieldInfo(annotation=Union[str, NoneType], required=False), 'num_pages': FieldInfo(annotation=Union[int, NoneType], required=False), 'sections': FieldInfo(annotation=List[Section], required=False, default_factory=list)}#

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

INPADOC Family Data#

Manager#

class patent_client.epo.ops.family.manager.FamilyManager(config=None)[source]#
async aget(doc_number)[source]#

If the critera results in a single record, return it, else raise an exception

Models#

class patent_client.epo.ops.family.model.PriorityClaim(*, application_number: Optional[str] = None, application_reference: Optional[DocumentId] = None, sequence: Optional[int] = None, kind: Optional[str] = None, active: Optional[bool] = None)[source]#
application_number: Optional[str]#
application_reference: Optional[DocumentId]#
sequence: Optional[int]#
kind: Optional[str]#
active: Optional[bool]#
model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,)}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'active': FieldInfo(annotation=Union[bool, NoneType], required=False), 'application_number': FieldInfo(annotation=Union[str, NoneType], required=False), 'application_reference': FieldInfo(annotation=Union[DocumentId, NoneType], required=False), 'kind': FieldInfo(annotation=Union[str, NoneType], required=False), 'sequence': FieldInfo(annotation=Union[int, NoneType], required=False)}#

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client.epo.ops.family.model.FamilyMember(*, publication_number: Optional[str] = None, application_number: Optional[str] = None, family_id: Optional[str] = None, publication_reference: list = None, application_reference: list = None, priority_claims: List[PriorityClaim] = None)[source]#
publication_number: Optional[str]#
application_number: Optional[str]#
family_id: Optional[str]#
publication_reference: list#
application_reference: list#
priority_claims: List[PriorityClaim]#
property docdb_number#
model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,)}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'application_number': FieldInfo(annotation=Union[str, NoneType], required=False), 'application_reference': FieldInfo(annotation=list, required=False, default_factory=list), 'family_id': FieldInfo(annotation=Union[str, NoneType], required=False), 'priority_claims': FieldInfo(annotation=List[PriorityClaim], required=False, default_factory=list), 'publication_number': FieldInfo(annotation=Union[str, NoneType], required=False), 'publication_reference': FieldInfo(annotation=list, required=False, default_factory=list)}#

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class patent_client.epo.ops.family.model.Family(*, publication_reference: Optional[DocumentId] = None, num_records: Optional[int] = None, publication_number: Optional[str] = None, family_members: List[FamilyMember] = None)[source]#
publication_reference: Optional[DocumentId]#
num_records: Optional[int]#
publication_number: Optional[str]#
family_members: List[FamilyMember]#
model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,)}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'family_members': FieldInfo(annotation=List[FamilyMember], required=False, default_factory=list), 'num_records': FieldInfo(annotation=Union[int, NoneType], required=False), 'publication_number': FieldInfo(annotation=Union[str, NoneType], required=False), 'publication_reference': FieldInfo(annotation=Union[DocumentId, NoneType], required=False)}#

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.