NL2SQLTrainingDocumentsList¶
- pydantic model openapi_client.models.nl2_sql_training_documents_list.NL2SQLTrainingDocumentsList¶
Paginated envelope returned by GET /nl2sql/training-documents. Items carry only the projected summary attributes, not the full document record.
- Fields:
- field training_documents: List[NL2SQLTrainingDocumentSummary] [Required] (alias 'TrainingDocuments')¶
Training documents on the current page.
- field next_available: StrictStr [Required]¶
Whether a further page exists. “yes” means more records remain, so request the next page by advancing offset by limit. “no” means this is the last page and the client must stop iterating.
- Constraints:
strict = True
- field count: StrictInt [Required]¶
Number of documents returned on this page.
- Constraints:
strict = True
- field total_count: StrictInt [Required]¶
Total number of documents available across all pages.
- Constraints:
strict = True
- 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 NL2SQLTrainingDocumentsList 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 NL2SQLTrainingDocumentsList from a dict
- Return type:
Optional[Self]