GetSummaryResponse

pydantic model openapi_client.models.get_summary_response.GetSummaryResponse

Generated summary for a single dataset file, with the current state of summary generation.

Fields:

• summary_generation_status (str | None)

• summary_metadata (openapi_client.models.get_summary_response_summary_metadata.GetSummaryResponseSummaryMetadata | None)

field summary_metadata: Optional[GetSummaryResponseSummaryMetadata] = None (alias 'SummaryMetadata')

field summary_generation_status: Optional[StrictStr] = None (alias 'SummaryGenerationStatus')

State of summary generation for the file. Reported as pending when a summary has never been requested.

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 GetSummaryResponse 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 GetSummaryResponse from a dict

Return type:

Optional[Self]