NL2SQLTrainingDocumentDetails

pydantic model openapi_client.models.nl2_sql_training_document_details.NL2SQLTrainingDocumentDetails

Full detail of a single SQL AI training document, as returned by GET /nl2sql/training-documents/{id}. The list endpoint returns a reduced form: see NL2SQLTrainingDocumentSummary.

Fields:

• associated_resource_domain (str | None)

• associated_resource_id (str | None)

• associated_resource_name (str | None)

• associated_resource_type (str | None)

• creation_time (str | None)

• document_id (str | None)

• document_name (str | None)

• document_type (str | None)

• download_url (str | None)

• last_modified_by (str | None)

• last_modified_time (str | None)

• uploaded_files (List[openapi_client.models.nl2_sql_training_document_details_uploaded_files_inner.NL2SQLTrainingDocumentDetailsUploadedFilesInner] | None)

• user_id (str | None)

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. Unique across the platform.

field document_type: Optional[StrictStr] = None (alias 'DocumentType')

Kind of training material this document holds. SQL holds example queries, QnA holds question and answer pairs, and Documentation holds free-form reference text.

field associated_resource_type: Optional[StrictStr] = None (alias 'AssociatedResourceType')

Type of resource this document is associated with. Only Dataset is currently supported.

field associated_resource_id: Optional[StrictStr] = None (alias 'AssociatedResourceId')

Identifier of the associated dataset.

field associated_resource_name: Optional[StrictStr] = None (alias 'AssociatedResourceName')

Name of the associated dataset, resolved at creation time.

field associated_resource_domain: Optional[StrictStr] = None (alias 'AssociatedResourceDomain')

Domain of the associated dataset, resolved at creation time.

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.

field download_url: Optional[StrictStr] = None (alias 'DownloadURL')

Presigned URL for the first uploaded file, valid for one hour. Present only when UploadedFiles is non-empty. If URL generation fails the key is silently omitted rather than erroring.

field uploaded_files: Optional[List[NL2SQLTrainingDocumentDetailsUploadedFilesInner]] = None (alias 'UploadedFiles')

Files uploaded against this document. Absent until at least one file has been uploaded.

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

Return type:

Optional[Self]