As part of the cognition workflow, organizations can upload lots of content (media files, etc.) to object storage. As engines run, they can store their results in additional assets and tables. This content may need to be cleaned up or deleted to save space or comply with certain policies but not entirely delete all data.
The Veritone GraphQL API allows users fine-grained control over what data is deleted and what's left on Veritone's servers.
In the GraphQL schema a temporal data object, or TDO, is the top-level container for media assets and engine results. A TDO is called "recording" in the Data Center application.
Steps
- Log into the Veritone platform.
- You'll need to know the ID of the TDO, or recording, to operate on. To get the ID, go to Data Center and click the media detail. The ID is the final part of the URL that appears in the browser's address bar.
- Open the interactive GraphQL user interface at https://api.veritone.com/v3/graphiql.
- On the left panel, type your GraphQL query. A GraphQL query is like a small computer program that uses a simplified language to interact with Veritone's services. The UI has built-in help and auto-completion (CTRL-space) to assist.
[Note] A GraphQL query that modifies information is a mutation. The specific mutation used to clean up TDO content is cleanupTDO.
- To use the default settings, type this segment and hit the arrow button or CTRL-ENTER to execute the query:
mutation {
cleanupTDO(id: "<insert TDO ID here>") {
id
message
}
}
On the right panel, you'll see a result indicating that the operation ran successfully and the requested data was deleted. The TDO itself is still in the database, along with the records of all engine tasks run against it.
For more precise control over the data that is deleted, you can pass an additional options parameter. Possible values are:
storage: Indicates that all assets should be deleted from storage, including those used to store engine results. Metadata about the assets will remain until the container TemporalDataObject is permanently deleted.searchIndex: Indicates that all search index data should be deleted. The TemporalDataObject and its assets will no longer be accessible through search.*engineResults: Indicates that engine results stored on related task objects should be deleted. Engine results stored as assets will remain until assets are removed using the storage option.
The default behavior is to use the storage and searchIndex settings. To change this, pass any combination of valid option values as shown below:
mutation {
cleanupTDO(id: "<insert TDO ID here>", options: [engineResults, storage]) {
id
message
}
}
Delete a TDO
To delete a TDO entirely, use the deleteTDO mutation. This deletes the TDO and its metadata, but won't delete any task records or engine results.
