NL2SQLTrainingDocumentCreateResponse

pydantic model openapi_client.models.nl2_sql_training_document_create_response.NL2SQLTrainingDocumentCreateResponse

Success body for POST /nl2sql/training-documents. The document is registered but has no file attached yet; request an upload URL via GET /nl2sql/training-documents/{id}?action=get_upload_url to add one.

Fields:
field document_id: StrictStr [Required] (alias 'DocumentId')

Identifier of the newly created training document.

Constraints:
  • strict = True

field message: StrictStr [Required] (alias 'Message')

Confirmation message.

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

Return type:

Optional[Self]