CitationPageImageRequest¶
- pydantic model openapi_client.models.citation_page_image_request.CitationPageImageRequest¶
CitationPageImageRequest
- Fields:
- field file_name: StrictStr [Required] (alias 'FileName')¶
Source file path. Catalog files use domain/dataset/…/filename (typically domain/dataset/upload_date={date}/filename). Project files use projects/files/{project_id}/{filename} or {project_id}/{filename} where project_id is a UUID.
- Constraints:
strict = True
- field page_number: Annotated[int, Field(strict=True, ge=1)] [Required] (alias 'PageNumber')¶
1-based page number of the PDF/DOCX page image to retrieve.
- Constraints:
strict = True
ge = 1
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- classmethod from_json(json_str)¶
Create an instance of CitationPageImageRequest from a JSON string
- Return type:
Optional[Self]
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True):
None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- Return type:
Dict[str,Any]
- classmethod from_dict(obj)¶
Create an instance of CitationPageImageRequest from a dict
- Return type:
Optional[Self]