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 signedUri: String 
34 
35 #   deprecated - use assetType
36 type: String! @deprecated( reason: "Duplicate, redundant field"  )
37 
38 #   The asset type, such as `media`, `transcript`, or `text`.
39 #   The asset type determines which engines are able to operate on it.
40 #   For example, a transcription engine requires a `media` asset.
41 #   Engines that record their results in an asset typically set the type
42 #   accordingly, such as `vtn-standard`.
43 #   See https://support.veritone.com/s/article/000003943 for supported values.
44 assetType: String 
45 
46 #   Size of asset in bytes.
47 assetSize: Float 
48 
49 #   Freeform application-defined metadata. This field may contain information
50 #   specific to the object type, such as image or video metadata.
51 # 
52 # Arguments
53 #   path: optionally, specify a path to retrieve only a specific 
54 #   property
55 #   within the details JSON
56 details(path: String): JSONData 
57 
58 #   Metadata as raw JSON string
59 jsonstring(indent: Int): String 
60 
61 #   A structured containing metadata about a file. This will be set if the
62 #   asset was created by uploading a file.
63 fileData: AssetFileData 
64 
65 #   A structure containing metadata about the source engine and task. This will
66 #   be set if the asset was created by an engine.
67 sourceData: AssetSourceData 
68 
69 #   Asset transform. The transformation function to be used with the asset.
70 #   It can be XML to JSON
71 transform(transformFunction: TransformFunction!): String 
72 
73 #   A Boolean indicating whether or not this asset was created by editing
74 #   another asset.
75 isUserEdited: Boolean 
76 
77 }

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	signedUri: String
34
35	# deprecated - use assetType
36	type: String! @deprecated( reason: "Duplicate, redundant field" )
37
38	# The asset type, such as `media`, `transcript`, or `text`.
39	# The asset type determines which engines are able to operate on it.
40	# For example, a transcription engine requires a `media` asset.
41	# Engines that record their results in an asset typically set the type
42	# accordingly, such as `vtn-standard`.
43	# See https://support.veritone.com/s/article/000003943 for supported values.
44	assetType: String
45
46	# Size of asset in bytes.
47	assetSize: Float
48
49	# Freeform application-defined metadata. This field may contain information
50	# specific to the object type, such as image or video metadata.
51	#
52	# Arguments
53	# path: optionally, specify a path to retrieve only a specific
54	# property
55	# within the details JSON
56	details(path: String): JSONData
57
58	# Metadata as raw JSON string
59	jsonstring(indent: Int): String
60
61	# A structured containing metadata about a file. This will be set if the
62	# asset was created by uploading a file.
63	fileData: AssetFileData
64
65	# A structure containing metadata about the source engine and task. This will
66	# be set if the asset was created by an engine.
67	sourceData: AssetSourceData
68
69	# Asset transform. The transformation function to be used with the asset.
70	# It can be XML to JSON
71	transform(transformFunction: TransformFunction!): String
72
73	# A Boolean indicating whether or not this asset was created by editing
74	# another asset.
75	isUserEdited: Boolean
76
77	}

Asset

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by