NL2SQLDocumentsSyncJobDetails

pydantic model openapi_client.models.nl2_sql_documents_sync_job_details.NL2SQLDocumentsSyncJobDetails

A single SQL AI documents sync job. Sync jobs ingest the uploaded training documents into the knowledge base that backs the SQL AI chatbot.

Fields:

• end_time (str | None)

• last_modified_by (str | None)

• last_modified_time (str | None)

• message (str | None)

• run_id (str | None)

• run_statistics (openapi_client.models.nl2_sql_documents_sync_job_details_run_statistics.NL2SQLDocumentsSyncJobDetailsRunStatistics | None)

• run_status (str | None)

• start_time (str | None)

• tenant_name (str | None)

• triggered_by (str | None)

field run_id: Optional[StrictStr] = None (alias 'RunId')

Unique identifier of the sync job run.

field run_status: Optional[StrictStr] = None (alias 'RunStatus')

Current state of the run. Values observed from the ingestion service include IN_PROGRESS, COMPLETE and FAILED. Deliberately not constrained to an enum, because the value is passed through from the underlying ingestion service and other transitional states may appear.

field tenant_name: Optional[StrictStr] = None (alias 'TenantName')

Tenant whose knowledge base was synced.

field start_time: Optional[StrictStr] = None (alias 'StartTime')

Timestamp at which the run started.

field end_time: Optional[StrictStr] = None (alias 'EndTime')

Timestamp at which the run finished. Present only once RunStatus has reached COMPLETE or FAILED.

field triggered_by: Optional[StrictStr] = None (alias 'TriggeredBy')

User who triggered the run, or the internal system runner identifier for scheduled syncs.

field message: Optional[StrictStr] = None (alias 'Message')

Status or failure text for the run.

field run_statistics: Optional[NL2SQLDocumentsSyncJobDetailsRunStatistics] = None (alias 'RunStatistics')

field last_modified_time: Optional[StrictStr] = None (alias 'LastModifiedTime')

Timestamp of the most recent update to the run record.

field last_modified_by: Optional[StrictStr] = None (alias 'LastModifiedBy')

User or system identifier that last updated the run record.

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

Return type:

Optional[Self]