OBJECT

Asset

An asset represents a single unit of data, such as a file or URL, and basic metadata about that data. An asset must be contained within a TemporalDataObject.

GraphQL Schema definition

1 type Asset {
2 
3 # The asset ID
4 id: ID! 
5 
6 # Asset name, such as a file name.
7 name: String 
8 
9 # Asset content type. Must be a valid MIME type string.
10 contentType: String 
11 
12 # An optional description of the asset
13 description: String 
14 
15 createdDateTime: DateTime 
16 
17 modifiedDateTime: DateTime 
18 
19 # Freeform metadata in JSON format.
20 jsondata: JSONData 
21 
22 # The ID of the TemporalDataObject that contains this asset
23 containerId: ID! 
24 
25 # The TemporalDataObject that contains this asset
26 container: TemporalDataObject 
27 
28 # The asset's URI. If a file is provided on asset creation, this URI
29 # point to the object in Veritone's object storage.
30 uri: String 
31 
32 # A signed version of the asset's URI.
33 # 
34 # When the `virtualAssetEnabled` feature flag is on, this returns a
35 # virtual-asset URL (resolved/proxied server-side). When the flag is off,
36 # the value is a raw presigned storage URL.
37 signedUri: String 
38 
39 # deprecated - use assetType
40 type: String! @deprecated( reason: "Duplicate, redundant field"  )
41 
42 # The asset type, such as `media`, `transcript`, or `text`.
43 # The asset type determines which engines are able to operate on it.
44 # For example, a transcription engine requires a `media` asset.
45 # Engines that record their results in an asset typically set the type
46 # accordingly, such as `vtn-standard`.
47 # See https://support.veritone.com/s/article/000003943 for supported values.
48 assetType: String 
49 
50 # Size of asset in bytes.
51 assetSize: Float 
52 
53 # Freeform application-defined metadata. This field may contain information
54 # specific to the object type, such as image or video metadata.
55 # 
56 # Arguments
57 # path: optionally, specify a path to retrieve only a specific 
58 # property
59 # within the details JSON
60 details(path: String): JSONData 
61 
62 # Metadata as raw JSON string
63 jsonstring(indent: Int): String 
64 
65 # A structured containing metadata about a file. This will be set if the
66 # asset was created by uploading a file.
67 fileData: AssetFileData 
68 
69 # A structure containing metadata about the source engine and task. This will
70 # be set if the asset was created by an engine.
71 sourceData: AssetSourceData 
72 
73 # Asset transform. The transformation function to be used with the asset.
74 # It can be XML to JSON
75 transform(transformFunction: TransformFunction!): String 
76 
77 # A Boolean indicating whether or not this asset was created by editing
78 # another asset.
79 isUserEdited: Boolean 
80 
81 }

1	type Asset {
2
3	# The asset ID
4	id: ID!
5
6	# Asset name, such as a file name.
7	name: String
8
9	# Asset content type. Must be a valid MIME type string.
10	contentType: String
11
12	# An optional description of the asset
13	description: String
14
15	createdDateTime: DateTime
16
17	modifiedDateTime: DateTime
18
19	# Freeform metadata in JSON format.
20	jsondata: JSONData
21
22	# The ID of the TemporalDataObject that contains this asset
23	containerId: ID!
24
25	# The TemporalDataObject that contains this asset
26	container: TemporalDataObject
27
28	# The asset's URI. If a file is provided on asset creation, this URI
29	# point to the object in Veritone's object storage.
30	uri: String
31
32	# A signed version of the asset's URI.
33	#
34	# When the `virtualAssetEnabled` feature flag is on, this returns a
35	# virtual-asset URL (resolved/proxied server-side). When the flag is off,
36	# the value is a raw presigned storage URL.
37	signedUri: String
38
39	# deprecated - use assetType
40	type: String! @deprecated( reason: "Duplicate, redundant field" )
41
42	# The asset type, such as `media`, `transcript`, or `text`.
43	# The asset type determines which engines are able to operate on it.
44	# For example, a transcription engine requires a `media` asset.
45	# Engines that record their results in an asset typically set the type
46	# accordingly, such as `vtn-standard`.
47	# See https://support.veritone.com/s/article/000003943 for supported values.
48	assetType: String
49
50	# Size of asset in bytes.
51	assetSize: Float
52
53	# Freeform application-defined metadata. This field may contain information
54	# specific to the object type, such as image or video metadata.
55	#
56	# Arguments
57	# path: optionally, specify a path to retrieve only a specific
58	# property
59	# within the details JSON
60	details(path: String): JSONData
61
62	# Metadata as raw JSON string
63	jsonstring(indent: Int): String
64
65	# A structured containing metadata about a file. This will be set if the
66	# asset was created by uploading a file.
67	fileData: AssetFileData
68
69	# A structure containing metadata about the source engine and task. This will
70	# be set if the asset was created by an engine.
71	sourceData: AssetSourceData
72
73	# Asset transform. The transformation function to be used with the asset.
74	# It can be XML to JSON
75	transform(transformFunction: TransformFunction!): String
76
77	# A Boolean indicating whether or not this asset was created by editing
78	# another asset.
79	isUserEdited: Boolean
80
81	}

Asset

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by