NL2SQLTrainingDocumentSummary¶
- pydantic model openapi_client.models.nl2_sql_training_document_summary.NL2SQLTrainingDocumentSummary¶
Reduced view of a training document, as returned in the GET /nl2sql/training-documents listing. The list query projects only these seven attributes, so the association fields, UploadedFiles and DownloadURL are never present here. Fetch GET /nl2sql/training-documents/{id} for the full record.
- Fields:
- field document_id: Optional[StrictStr] = None (alias 'DocumentId')¶
Unique identifier of the training document.
- field document_name: Optional[StrictStr] = None (alias 'DocumentName')¶
Name of the training document.
- field document_type: Optional[StrictStr] = None (alias 'DocumentType')¶
Kind of training material this document holds.
- field user_id: Optional[StrictStr] = None (alias 'UserId')¶
User who created the document.
- field creation_time: Optional[StrictStr] = None (alias 'CreationTime')¶
Timestamp at which the document was created.
- field last_modified_by: Optional[StrictStr] = None (alias 'LastModifiedBy')¶
User who last modified the document.
- field last_modified_time: Optional[StrictStr] = None (alias 'LastModifiedTime')¶
Timestamp of the most recent modification.
- 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 NL2SQLTrainingDocumentSummary 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 NL2SQLTrainingDocumentSummary from a dict
- Return type:
Optional[Self]