Overview Use Cases Connectors Authentication Getting Started with the Python SDK API Reference ai_agents ai_chat algorithm annotations application_connectors batch_prediction code_completion custom_loss_function custom_metric database_connectors dataset createDatasetFromApplicationConnector createDatasetFromDatabaseConnector createDatasetFromFileConnector createDatasetFromStreamingConnector createDatasetFromUpload createDatasetVersionFromApplicationConnector createDatasetVersionFromDatabaseConnector createDatasetVersionFromDocumentReprocessing createDatasetVersionFromFileConnector createDatasetVersionFromUpload createRealtimeContentStore deleteDataset deleteDatasetVersion describeDataset describeDatasetVersion getDatasetSchema getDatasetVersionLogs getDatasetVersionMetrics listDatasetVersions listDatasets setDatasetColumnDataType setDatasetDatabaseConnectorConfig setStreamingRetentionPolicy snapshotStreamingData updateDatasetVersionLimit deployment deployment_conversations docstore document_retrievers documentation eda external_app feature_drift feature_group feature_group_row_process feature_group_template file_connectors graph_dashboard holdout_analysis llm_apps model model_monitoring module natural_language_explanation organization pipelines predict prediction_operator project python_function refresh secrets streaming streaming_connectors upload webhooks API Classes API Inputs Documentation Chat Bot API Search Video Tutorials ChatLLM

Method

snapshotStreamingData POST

Copy POST

Snapshots the current data in the streaming dataset.

Arguments:

REQUIRED	KEY	TYPE	DESCRIPTION
Yes	datasetId	str	The unique ID associated with the dataset.

Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY

TYPE

DESCRIPTION

success

Boolean

true if the call succeeded, false if there was an error

result

DatasetVersion

KEY	TYPE	Description
datasetVersion	str	The unique identifier of the dataset version.
status	str	The current status of the dataset version
datasetId	str	A reference to the Dataset this dataset version belongs to.
size	int	The size in bytes of the file.
rowCount	int	Number of rows in the dataset version.
fileInspectMetadata	dict	Metadata information about file's inspection. For example - the detected delimiter for CSV files.
createdAt	str	The timestamp this dataset version was created.
error	str	If status is FAILED, this field will be populated with an error.
incrementalQueriedAt	str	If the dataset version is from an incremental dataset, this is the last entry of timestamp column when the dataset version was created.
uploadId	str	If the dataset version is being uploaded, this the reference to the Upload
mergeFileSchemas	bool	If the merge file schemas policy is enabled.
databaseConnectorConfig	dict	The database connector query used to retrieve data for this version.
applicationConnectorConfig	dict	The application connector used to retrieve data for this version.
invalidRecords	str	Invalid records in the dataset version

Exceptions:

TYPE	WHEN
DataNotFoundError	`datasetId` is not found.

Language: