NL2SQLDocumentsSyncJobDetailsRunStatistics

pydantic model openapi_client.models.nl2_sql_documents_sync_job_details_run_statistics.NL2SQLDocumentsSyncJobDetailsRunStatistics

Document counts for the run. Added once the run’s status has changed at least once, so it is absent from a just-created job.

Fields:
field documents_scanned: Optional[StrictInt] = None (alias 'DocumentsScanned')

Number of documents examined during the run.

field new_documents_indexed: Optional[StrictInt] = None (alias 'NewDocumentsIndexed')

Number of documents indexed for the first time.

field modified_documents_indexed: Optional[StrictInt] = None (alias 'ModifiedDocumentsIndexed')

Number of previously indexed documents that were re-indexed.

field documents_deleted: Optional[StrictInt] = None (alias 'DocumentsDeleted')

Number of documents removed from the index.

field documents_failed: Optional[StrictInt] = None (alias 'DocumentsFailed')

Number of documents that could not be indexed.

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

Return type:

Optional[Self]