GetCitationPresignedUrlRequest

class openapi_client.models.get_citation_presigned_url_request.GetCitationPresignedUrlRequest(**data)[source]

Bases: BaseModel

file_name: StrictStr
page_number: Annotated[int, Field(strict=True, ge=1)]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}

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

to_str()[source]

Returns the string representation of the model using alias

Return type:

str

to_json()[source]

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)[source]

Create an instance of GetCitationPresignedUrlRequest from a JSON string

Return type:

Optional[Self]

to_dict()[source]

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)[source]

Create an instance of GetCitationPresignedUrlRequest from a dict

Return type:

Optional[Self]

model_fields: ClassVar[dict[str, FieldInfo]] = {'file_name': FieldInfo(annotation=str, required=True, alias='FileName', alias_priority=2, description='File name of the source file (e.g., domain/dataset/upload_date=XXXX/filename)', metadata=[Strict(strict=True)]), 'page_number': FieldInfo(annotation=int, required=True, alias='PageNumber', alias_priority=2, description='Page number (1-indexed)', metadata=[Strict(strict=True), Ge(ge=1)])}

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

This replaces Model.__fields__ from Pydantic V1.

model_post_init(__context)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:
  • self (BaseModel) – The BaseModel instance.

  • __context (Any) – The context.

Return type:

None