INPUT_OBJECT

UploadEngineResult

Fields needed to upload and store an engine result using multipart form POST.

GraphQL Schema definition

1 input UploadEngineResult {
4 
2 #   ID of the task that created this engine result
3 taskId: ID!
10 
5 #   A string containing the engine result.
6 #   Use either this field, `output`, `uri`, or `file` with multipart form POST, but 
7 #   not
8 #   more than one.
9 outputString: String
17 
11 #   JSON data containing the engine result.
12 #   A string containing the engine result.
13 #   Use either this field, `outputString`, `uri`, or `file` with multipart form 
14 #   POST, but not
15 #   more than one.
16 output: JSONData
21 
18 #   A file to upload. Use multipart form POST to submit this field.
19 #   Use this field, the `output`, `outputString`, or `uri` field, not more than one.
20 file: UploadedFile
25 
22 #   A URI to the file. Use one and only one of `uri`, `file`, or 
23 #   `output`/`outputString`.
24 uri: String
28 
26 #   The file name
27 filename: String
33 
29 #   The type of asset to create. Optional -- if not set, it will be
30 #   deduced from the engine category.
31 #   See https://support.veritone.com/s/article/000003943 for supported values.
32 assetType: String
37 
34 #   The content type of the file. Optional -- if not set, it will
35 #   be deduced from the file name.
36 contentType: String
40 
38 #   Whether or not to mark the task as complete. Defaults to true.
39 completeTask: Boolean
46 
41 #   If the result data uploaded is not a valid JSON string, then
42 #   the task output data stored on the task object will be wrapped into
43 #   a JSON object using this key. The asset created, however, is not
44 #   modified in any way.
45 outputJsonKey: String
49 
47 #   Optionally, set attributes about the file
48 fileData: SetAssetFileData
54 
50 #   if true, sets the new asset to be the primary asset of its type.
51 #   Only certain asset types, such as "media" and "transcript",
52 #   can have primary assets.
53 setAsPrimary: Boolean
58 
55 #   Skips indexing the engine result, preventing mentions from being
56 #   generated over the results.
57 skipIndexing: Boolean
62 
59 #   Whether or not to set the legacy `task_output` data for compatible
60 #   with older clients.
61 setTaskOutput: Boolean
67 
63 #   Indicates that the result is one of a series of accumulated results
64 #   for a task and can replace existing data.
65 #   Used primarily by Veritone platform components.
66 isAccumulatedResult: Boolean
73 
68 #   An optional timestamp that the client can send in combination with
69 #   the `uri` and `isAccumulatedResult` parameters. If set, the uri
70 #   will only be updated if the currently saved asset metadata is older
71 #   than the timestamp value.
72 clientTimestamp: DateTime
74 }

Required by

MutationMutations are used to modify data. Each mutation takes an input that contains the data necessary to create or update the data in question.

1	input UploadEngineResult {
4
2	# ID of the task that created this engine result
3	taskId: ID!
10
5	# A string containing the engine result.
6	# Use either this field, `output`, `uri`, or `file` with multipart form POST, but
7	# not
8	# more than one.
9	outputString: String
17
11	# JSON data containing the engine result.
12	# A string containing the engine result.
13	# Use either this field, `outputString`, `uri`, or `file` with multipart form
14	# POST, but not
15	# more than one.
16	output: JSONData
21
18	# A file to upload. Use multipart form POST to submit this field.
19	# Use this field, the `output`, `outputString`, or `uri` field, not more than one.
20	file: UploadedFile
25
22	# A URI to the file. Use one and only one of `uri`, `file`, or
23	# `output`/`outputString`.
24	uri: String
28
26	# The file name
27	filename: String
33
29	# The type of asset to create. Optional -- if not set, it will be
30	# deduced from the engine category.
31	# See https://support.veritone.com/s/article/000003943 for supported values.
32	assetType: String
37
34	# The content type of the file. Optional -- if not set, it will
35	# be deduced from the file name.
36	contentType: String
40
38	# Whether or not to mark the task as complete. Defaults to true.
39	completeTask: Boolean
46
41	# If the result data uploaded is not a valid JSON string, then
42	# the task output data stored on the task object will be wrapped into
43	# a JSON object using this key. The asset created, however, is not
44	# modified in any way.
45	outputJsonKey: String
49
47	# Optionally, set attributes about the file
48	fileData: SetAssetFileData
54
50	# if true, sets the new asset to be the primary asset of its type.
51	# Only certain asset types, such as "media" and "transcript",
52	# can have primary assets.
53	setAsPrimary: Boolean
58
55	# Skips indexing the engine result, preventing mentions from being
56	# generated over the results.
57	skipIndexing: Boolean
62
59	# Whether or not to set the legacy `task_output` data for compatible
60	# with older clients.
61	setTaskOutput: Boolean
67
63	# Indicates that the result is one of a series of accumulated results
64	# for a task and can replace existing data.
65	# Used primarily by Veritone platform components.
66	isAccumulatedResult: Boolean
73
68	# An optional timestamp that the client can send in combination with
69	# the `uri` and `isAccumulatedResult` parameters. If set, the uri
70	# will only be updated if the currently saved asset metadata is older
71	# than the timestamp value.
72	clientTimestamp: DateTime
74	}

UploadEngineResult

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by