-
Notifications
You must be signed in to change notification settings - Fork 175
Expand file tree
/
Copy pathv2-schema.graphql
More file actions
13272 lines (10597 loc) · 404 KB
/
v2-schema.graphql
File metadata and controls
13272 lines (10597 loc) · 404 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
directive @oneOf on INPUT_OBJECT
schema @link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@external", "@key", "@shareable"]) {
query: Query
mutation: Mutation
subscription: Subscription
}
"""Added in 25.16.0. An access token for model deployment."""
type AccessToken implements Node {
"""The Globally Unique ID of this object"""
id: ID!
"""The access token."""
token: String!
"""The creation timestamp of the access token."""
createdAt: DateTime!
"""The expiration timestamp of the access token."""
expiresAt: DateTime
}
"""Added in 25.16.0. Connection for access tokens."""
type AccessTokenConnection {
"""Pagination data for this connection"""
pageInfo: PageInfo!
"""Contains the nodes in this connection"""
edges: [AccessTokenEdge!]!
count: Int!
}
"""An edge in a connection."""
type AccessTokenEdge {
"""A cursor for use in pagination"""
cursor: String!
"""The item at the end of the edge"""
node: AccessToken!
}
"""Added in 25.16.0. """
input AccessTokenFilter {
token: StringFilter = null
expiresAt: DateTimeFilter = null
createdAt: DateTimeFilter = null
AND: [AccessTokenFilter!] = null
OR: [AccessTokenFilter!] = null
NOT: [AccessTokenFilter!] = null
}
"""Added in 25.16.0. """
input AccessTokenOrderBy {
field: AccessTokenOrderField!
direction: OrderDirection! = DESC
}
enum AccessTokenOrderField {
CREATED_AT
}
"""
Added in 25.19.0. Input for activating a revision to be the current revision.
"""
input ActivateRevisionInput {
deploymentId: ID!
revisionId: ID!
}
"""Added in 25.19.0. Result of activating a revision."""
type ActivateRevisionPayload {
"""The deployment with the activated revision"""
deployment: ModelDeployment!
"""ID of the previously active revision"""
previousRevisionId: ID
"""ID of the newly activated revision"""
activatedRevisionId: ID!
"""The deployment policy applied during activation"""
deploymentPolicy: DeploymentPolicy!
}
"""
Added in 26.4.0. Active resource usage overview for a domain or project. Shows the currently occupied resource slots and the number of active sessions.
"""
type ActiveResourceOverview {
"""Resource slots currently occupied"""
slots: ResourceSlot!
"""Number of active sessions"""
sessionCount: Int!
}
"""
Added in 25.19.0. This enum represents the activeness status of a replica, indicating whether the deployment is currently active and able to serve requests.
"""
enum ActivenessStatus {
ACTIVE
INACTIVE
}
"""Added in 25.19.0. """
input AddRevisionInput {
name: String = null
"""
Added in 26.4.2. DeploymentRevisionPreset ID. When specified, preset values are used as defaults and can be overridden by explicitly provided fields.
"""
revisionPresetId: UUID = null
deploymentId: ID!
clusterConfig: ClusterConfigInput!
resourceConfig: ResourceConfigInput!
image: ImageInput!
modelRuntimeConfig: ModelRuntimeConfigInput!
modelMountConfig: ModelMountConfigInput!
"""
Added in 26.4.2. Model definition to override the default values generated by the server
"""
modelDefinition: ModelDefinitionInput = null
"""Extra vfolder mounts"""
extraMounts: [ExtraVFolderMountInput!] = null
}
"""Added in 26.4.2. Options for the add_model_revision mutation."""
input AddRevisionOptions {
"""
When true, automatically activate the newly added revision immediately after creation.
"""
autoActivate: Boolean! = false
}
"""Added in 25.19.0. Payload for adding a revision."""
type AddRevisionPayload {
"""Added revision"""
revision: ModelRevision!
}
"""Added in 26.4.2. Admin input for creating a keypair for a user."""
input AdminCreateKeypairInput {
"""UUID of the target user."""
userId: UUID!
"""Name of the resource policy to assign."""
resourcePolicy: String!
"""Whether the keypair should be active."""
isActive: Boolean! = true
"""Whether the keypair has admin privileges."""
isAdmin: Boolean! = false
"""API rate limit (requests per minute)."""
rateLimit: Int! = 30000
}
"""
Added in 26.4.2. Payload returned after admin creates a keypair. The secret_key is only shown once.
"""
type AdminCreateKeypairPayload {
"""The newly created keypair."""
keypair: KeyPairGQL!
"""The secret key. Only returned at creation time."""
secretKey: String!
}
"""Added in 26.4.2. Payload returned after admin deletes a keypair."""
type AdminDeleteKeypairPayload {
"""The access key of the deleted keypair."""
accessKey: String!
}
"""
Added in 26.4.2. Payload returned after admin clears a user's SSH keypair.
"""
type AdminDeleteSSHKeypairPayload {
"""Access key whose SSH keypair was cleared."""
accessKey: String!
}
"""
Added in 26.4.2. Input for admin querying effective assignable resources for a specific user.
"""
input AdminEffectiveResourceAllocationV2Input {
"""Target user ID."""
userId: UUID!
"""Project ID to check allocation for."""
projectId: UUID!
"""Resource group name to check allocation for."""
resourceGroupName: String!
}
"""Added in 26.4.2. Payload returned by admin SSH keypair lookup."""
type AdminGetSSHKeypairPayload {
"""SSH keypair public information."""
keypair: SSHKeypairNode!
}
"""
Added in 26.4.3. Payload for admin bulk revision refresh mutation result.
"""
type AdminRefreshDeploymentRevisionsPayload {
"""Per-deployment refresh outcomes (partial success by design)"""
results: [RevisionRefreshResult!]!
}
"""
Added in 26.4.2. Admin input for registering (overwriting) a user's SSH keypair.
"""
input AdminRegisterSSHKeypairInput {
"""Access key whose SSH keypair will be replaced."""
accessKey: String!
"""PEM-encoded SSH public key."""
sshPublicKey: String!
"""PEM-encoded SSH private key."""
sshPrivateKey: String!
}
"""
Added in 26.4.2. Payload returned after admin registers a user's SSH keypair.
"""
type AdminRegisterSSHKeypairPayload {
"""Access key whose SSH keypair was updated."""
accessKey: String!
}
"""Added in 26.4.2. Admin input for updating a keypair."""
input AdminUpdateKeypairInput {
"""Access key of the keypair to update."""
accessKey: String!
"""New active state."""
isActive: Boolean = null
"""New admin privilege state."""
isAdmin: Boolean = null
"""New resource policy name."""
resourcePolicy: String = null
"""New API rate limit."""
rateLimit: Int = null
}
"""Added in 26.4.2. Payload returned after admin updates a keypair."""
type AdminUpdateKeypairPayload {
"""The updated keypair."""
keypair: KeyPairGQL!
}
"""Added in 26.1.0. Filter options for querying agents"""
input AgentFilter {
id: StringFilter = null
status: AgentStatusFilter = null
schedulable: Boolean = null
scalingGroup: StringFilter = null
AND: [AgentFilter!] = null
OR: [AgentFilter!] = null
NOT: [AgentFilter!] = null
}
"""Added in 26.1.0. Network-related information for an agent."""
type AgentNetworkInfo {
"""Logical region where the agent is deployed."""
region: String!
"""
Network address and port where the agent can be reached (format: "host:port"). Used by the manager to communicate with the agent.
"""
addr: String!
}
"""Added in 26.1.0. Options for ordering agents"""
input AgentOrderBy {
field: AgentOrderField!
direction: OrderDirection! = ASC
}
"""Added in 26.1.0. Order by specification for agents"""
enum AgentOrderField {
ID
STATUS
FIRST_CONTACT
SCALING_GROUP
SCHEDULABLE
}
"""Added in 26.1.0. Permissions related to agent operations"""
enum AgentPermission {
READ_ATTRIBUTE
UPDATE_ATTRIBUTE
CREATE_COMPUTE_SESSION
CREATE_SERVICE
}
"""
Added in 25.15.0. Hardware resource capacity, usage, and availability of an agent.
"""
type AgentResource {
"""
Total hardware resource capacity available on the agent. Expressed as a JSON object containing resource slots.
"""
capacity: JSON!
"""
Total amount of resources currently consumed by running and scheduled sessions.
"""
used: JSON!
"""
Available resources for scheduling new compute sessions (capacity - used).
"""
free: JSON!
}
"""Added in 26.3.0. Relay-style connection for per-slot agent resources."""
type AgentResourceConnection {
"""Pagination data for this connection"""
pageInfo: PageInfo!
"""Contains the nodes in this connection"""
edges: [AgentResourceSlotEdge!]!
count: Int!
}
"""
Added in 26.3.0. Per-slot resource capacity and usage entry for an agent.
Represents one row from the agent_resources table.
"""
type AgentResourceSlot implements Node {
"""The Globally Unique ID of this object"""
id: ID!
"""Resource slot identifier (e.g., 'cpu', 'mem', 'cuda.device')."""
slotName: String!
"""Total hardware resource capacity for this slot on the agent."""
capacity: Decimal!
"""
Amount of this slot currently consumed by running and scheduled sessions.
"""
used: Decimal!
}
"""An edge in a connection."""
type AgentResourceSlotEdge {
"""A cursor for use in pagination"""
cursor: String!
"""The item at the end of the edge"""
node: AgentResourceSlot!
}
"""Added in 26.3.0. Filter criteria for querying agent resource slots."""
input AgentResourceSlotFilter {
slotName: StringFilter = null
agentId: StringFilter = null
AND: [AgentResourceSlotFilter!] = null
OR: [AgentResourceSlotFilter!] = null
NOT: [AgentResourceSlotFilter!] = null
}
"""Added in 26.3.0. Ordering specification for agent resource slots."""
input AgentResourceSlotOrderBy {
field: AgentResourceSlotOrderField!
direction: OrderDirection! = ASC
}
"""Added in 26.3.0. Fields available for ordering agent resource slots."""
enum AgentResourceSlotOrderField {
SLOT_NAME
CAPACITY
USED
}
"""Added in 25.15.0. Aggregated resource statistics for an agent."""
type AgentStats {
"""
Total hardware resource capacity, usage, and availability across all agents.
"""
totalResource: AgentResource!
}
enum AgentStatusEnum {
ALIVE
LOST
RESTARTING
TERMINATED
}
"""
Added in 24.09.0. Filter options for agent status within AgentFilter.
It includes options to filter whether agent status is in a specific list or equals a specific value.
"""
input AgentStatusFilter {
"""The in field."""
in: [AgentStatusEnum!] = null
equals: AgentStatusEnum = null
}
"""Added in 26.1.0. Status and lifecycle information for an agent."""
type AgentStatusInfo {
"""
Current operational status of the agent. One of: ALIVE, LOST, TERMINATED, RESTARTING.
"""
status: AgentStatusEnum!
"""Timestamp when the agent last changed its status."""
statusChanged: DateTime
"""Timestamp when the agent first registered with the manager."""
firstContact: DateTime
"""
Timestamp when the agent was marked as lost or unreachable. Null if the agent has never been lost or is currently alive.
"""
lostAt: DateTime
"""
Indicates whether the agent is available for scheduling new compute sessions.
"""
schedulable: Boolean!
}
"""Added in 26.1.0. System and configuration information for an agent."""
type AgentSystemInfo {
"""
Hardware architecture of the agent's host system (e.g., "x86_64", "aarch64"). Used to match compute sessions with compatible container images.
"""
architecture: String!
"""
Version string of the Backend.AI agent software running on this node. Follows semantic versioning (e.g., "26.1.0").
"""
version: String!
"""Legacy configuration flag, no longer actively used in the system."""
autoTerminateAbusingKernel: Boolean!
"""
List of compute plugin metadata supported by this agent. Typed as Any because this field holds a nested GQL type (ComputePluginsGQL).
"""
computePlugins: ComputePlugins!
}
"""Added in 26.1.0. Strawberry-based Agent type replacing AgentNode."""
type AgentV2 implements Node {
"""The Globally Unique ID of this object"""
id: ID!
"""
Hardware resource capacity, usage, and availability information. Contains capacity (total), used (occupied by sessions), and free (available) resource slots including CPU cores, memory, accelerators (GPUs, TPUs), and other compute resources.
"""
resourceInfo: AgentResource!
"""
Current operational status and lifecycle timestamps. Includes the agent's status (ALIVE, LOST, etc.), status change history, initial registration time, and schedulability state.
"""
statusInfo: AgentStatusInfo!
"""
System configuration and software version information. Contains the host architecture, agent software version, and available compute plugins for accelerators and specialized hardware.
"""
systemInfo: AgentSystemInfo!
"""
Network location and connectivity information. Provides the agent's region and network address for manager-to-agent communication.
"""
networkInfo: AgentNetworkInfo!
"""
List of permissions the current authenticated user has on this agent. Determines which operations (read attributes, create sessions, etc.) the user can perform on this specific agent based on RBAC policies.
"""
permissions: [AgentPermission!]!
"""
Name of the scaling group this agent belongs to. Scaling groups are logical collections of agents used for resource scheduling, quota management, and workload isolation across different user groups or projects.
"""
scalingGroup: String!
"""Added in 26.1.0. Load the container count for this agent."""
containerCount: Int!
"""
Added in 26.2.0. List of kernels running on this agent with pagination support.
"""
kernels(filter: KernelV2Filter = null, orderBy: [KernelV2OrderBy!] = null, before: String = null, after: String = null, first: Int = null, last: Int = null, limit: Int = null, offset: Int = null): KernelV2Connection!
"""
Added in 26.3.0. List of sessions running on this agent with pagination support.
"""
sessions(filter: SessionV2Filter = null, orderBy: [SessionV2OrderBy!] = null, before: String = null, after: String = null, first: Int = null, last: Int = null, limit: Int = null, offset: Int = null): SessionV2Connection!
"""Added in 26.3.0. Per-slot resource capacity and usage for this agent."""
resourceSlots(filter: AgentResourceSlotFilter = null, orderBy: [AgentResourceSlotOrderBy!] = null, first: Int = null, after: String = null, last: Int = null, before: String = null, limit: Int = null, offset: Int = null): AgentResourceConnection!
}
"""
Added in 26.1.0. Relay-style connection type for paginated lists of agents.
"""
type AgentV2Connection {
"""Pagination data for this connection"""
pageInfo: PageInfo!
"""Contains the nodes in this connection"""
edges: [AgentV2Edge!]!
count: Int!
}
"""An edge in a connection."""
type AgentV2Edge {
"""A cursor for use in pagination"""
cursor: String!
"""The item at the end of the edge"""
node: AgentV2!
}
"""
Added in 26.4.2. Represents a single allocated resource slot entry for a deployment revision or preset.
"""
type AllocatedResourceSlot implements Node {
"""The Globally Unique ID of this object"""
id: ID!
"""Resource slot identifier (e.g., 'cpu', 'mem', 'cuda.device')."""
slotName: String!
"""Allocated quantity for this resource slot."""
quantity: Decimal!
}
"""
Added in 26.4.2. Connection type for paginated allocated resource slot results.
"""
type AllocatedResourceSlotConnection {
"""Pagination data for this connection"""
pageInfo: PageInfo!
"""Contains the nodes in this connection"""
edges: [AllocatedResourceSlotEdge!]!
"""Total number of allocated resource slots matching the filter criteria."""
count: Int!
}
"""An edge in a connection."""
type AllocatedResourceSlotEdge {
"""A cursor for use in pagination"""
cursor: String!
"""The item at the end of the edge"""
node: AllocatedResourceSlot!
}
"""Added in 26.4.2. Filter for allocated resource slots."""
input AllocatedResourceSlotFilter {
slotName: StringFilter = null
AND: [AllocatedResourceSlotFilter!] = null
OR: [AllocatedResourceSlotFilter!] = null
NOT: [AllocatedResourceSlotFilter!] = null
}
"""Added in 26.4.2. Order by specification for allocated resource slots."""
input AllocatedResourceSlotOrderBy {
field: AllocatedResourceSlotOrderField!
direction: OrderDirection! = ASC
}
"""
Added in 26.4.2. Fields available for ordering allocated resource slots.
"""
enum AllocatedResourceSlotOrderField {
SLOT_NAME
QUANTITY
RANK
}
"""Added in 26.4.2. Payload containing allowed domain names."""
type AllowedDomainsPayload {
"""Allowed domain names."""
items: [String!]!
}
"""Added in 26.4.2. Payload containing allowed project IDs."""
type AllowedProjectsPayload {
"""Allowed project IDs."""
items: [UUID!]!
}
"""Added in 26.4.2. Payload containing allowed resource group names."""
type AllowedResourceGroupsPayload {
"""Allowed resource group names."""
items: [String!]!
}
"""Added in 25.16.0. App configuration data."""
type AppConfig {
"""Additional configuration data."""
extraConfig: JSON!
}
"""
Added in 24.09.0. Input for approving an artifact revision.
Admin-only operation to approve artifact revisions for general use.
"""
input ApproveArtifactInput {
artifactRevisionId: ID!
}
"""
Added in 25.14.0. Response payload for artifact revision approval operations. Contains the approved artifact revision. Admin-only operation.
"""
type ApproveArtifactPayload {
"""Approved artifact revision."""
artifactRevision: ArtifactRevision!
}
"""
Added in 25.14.0. An artifact represents AI models, packages, images, or other resources that can be stored, managed, and used within Backend.AI. Artifacts are discovered through scanning external registries and can have multiple revisions. Each artifact contains metadata and references to its source registry. Key concepts: Type (MODEL, PACKAGE, or IMAGE), Availability (ALIVE or DELETED), Source (original external registry where it was discovered).
"""
type Artifact implements Node {
"""The Globally Unique ID of this object"""
id: ID!
name: String!
type: ArtifactType!
description: String
registry: SourceInfo!
source: SourceInfo!
readonly: Boolean!
extra: JSON
scannedAt: DateTime!
updatedAt: DateTime!
availability: ArtifactAvailability!
"""The revisions of this entity."""
revisions(filter: ArtifactRevisionFilter = null, orderBy: [ArtifactRevisionOrderBy!] = null, before: String = null, after: String = null, first: Int = null, last: Int = null, limit: Int = null, offset: Int = null): ArtifactRevisionConnection!
}
enum ArtifactAvailability {
ALIVE
DELETED
}
"""
Added in 25.14.0. Paginated connection for artifacts with total count information. Used for relay-style pagination with cursor-based navigation.
"""
type ArtifactConnection {
"""Pagination data for this connection"""
pageInfo: PageInfo!
"""Contains the nodes in this connection"""
edges: [ArtifactEdge!]!
count: Int!
}
"""An edge in a connection."""
type ArtifactEdge {
"""A cursor for use in pagination"""
cursor: String!
"""The item at the end of the edge"""
node: Artifact!
}
"""
Added in 25.14.0. Filter options for artifacts based on various criteria such as type, name, registry,
source, and availability status.
Supports logical operations (AND, OR, NOT) for complex filtering scenarios.
"""
input ArtifactFilter {
type: [ArtifactType!] = null
name: StringFilter = null
registry: StringFilter = null
source: StringFilter = null
availability: [ArtifactAvailability!] = null
AND: [ArtifactFilter!] = null
OR: [ArtifactFilter!] = null
NOT: [ArtifactFilter!] = null
}
"""
Added in 25.14.0. Payload for artifact import progress subscription events. Provides real-time updates during the artifact import process, including progress percentage and current status.
"""
type ArtifactImportProgressUpdatedPayload {
"""Artifact revision ID."""
artifactId: ID!
"""Import progress as a percentage."""
progress: Float!
"""Current import status."""
status: ArtifactStatus!
}
"""
Added in 24.09.0. Specifies the field and direction for ordering artifacts in queries.
"""
input ArtifactOrderBy {
field: ArtifactOrderField!
direction: OrderDirection! = ASC
}
enum ArtifactOrderField {
NAME
TYPE
SIZE
SCANNED_AT
UPDATED_AT
}
"""Added in 25.14.0. Artifact registry node."""
type ArtifactRegistry {
"""Internal identifier of the artifact registry metadata record."""
id: ID!
"""Identifier of the actual registry implementation."""
registryId: ID!
"""Name of the artifact registry."""
name: String!
"""Type of the artifact registry."""
type: ArtifactRegistryType!
}
"""
Added in 25.15.0. Represents common metadata for an artifact registry. All artifact registry nodes expose that information regardless of type.
"""
type ArtifactRegistryMeta implements Node {
"""The Globally Unique ID of this object"""
id: ID!
name: String!
registryId: ID!
type: ArtifactRegistryType!
url: String!
}
"""
Added in 25.15.0. Relay-style connection for paginated artifact registry meta queries.
"""
type ArtifactRegistryMetaConnection {
"""Pagination data for this connection"""
pageInfo: PageInfo!
"""Contains the nodes in this connection"""
edges: [ArtifactRegistryMetaEdge!]!
count: Int!
}
"""An edge in a connection."""
type ArtifactRegistryMetaEdge {
"""A cursor for use in pagination"""
cursor: String!
"""The item at the end of the edge"""
node: ArtifactRegistryMeta!
}
enum ArtifactRegistryType {
HUGGINGFACE
RESERVOIR
}
enum ArtifactRemoteStatus {
SCANNED
AVAILABLE
FAILED
}
"""
Added in 25.14.0. A specific version/revision of an artifact containing the actual file data. Artifact revisions progress through different statuses: SCANNED (discovered in external registry, metadata only), PULLING (currently downloading from external source), PULLED (downloaded to temporary storage), AVAILABLE (ready for use by users). Contains version information, file size, README content, and timestamps. Most HuggingFace models only have a 'main' revision.
"""
type ArtifactRevision implements Node {
"""The Globally Unique ID of this object"""
id: ID!
status: ArtifactStatus!
"""
Added in 25.15.0. Remote synchronization status of the artifact revision.
"""
remoteStatus: ArtifactRemoteStatus
version: String!
readme: String
size: ByteSize
createdAt: DateTime
updatedAt: DateTime
"""
Added in 25.17.0. Digest at the time of import. None for models that have not been imported.
"""
digest: String
"""
Added in 25.17.0. Verification result containing malware scan results from all verifiers. None if not yet verified.
"""
verificationResult: ArtifactVerificationResult
"""The artifact of this entity."""
artifact: Artifact!
}
"""
Added in 25.14.0. Paginated connection for artifact revisions with total count information. Used for relay-style pagination with cursor-based navigation.
"""
type ArtifactRevisionConnection {
"""Pagination data for this connection"""
pageInfo: PageInfo!
"""Contains the nodes in this connection"""
edges: [ArtifactRevisionEdge!]!
count: Int!
}
"""An edge in a connection."""
type ArtifactRevisionEdge {
"""A cursor for use in pagination"""
cursor: String!
"""The item at the end of the edge"""
node: ArtifactRevision!
}
"""
Added in 25.14.0. Filter options for artifact revisions based on status, version, artifact ID, and file size.
Supports logical operations (AND, OR, NOT) for complex filtering scenarios.
"""
input ArtifactRevisionFilter {
status: ArtifactRevisionStatusFilter = null
"""Added in 25.16.0. Filter by remote synchronization status."""
remoteStatus: ArtifactRevisionRemoteStatusFilter = null
version: StringFilter = null
"""The artifact id field."""
artifactId: UUIDFilter = null
size: IntFilter = null
AND: [ArtifactRevisionFilter!] = null
OR: [ArtifactRevisionFilter!] = null
NOT: [ArtifactRevisionFilter!] = null
}
"""
Added in 25.14.0. Represents a background task for importing an artifact revision. Contains the task ID for monitoring progress and the associated artifact revision being imported from external registries.
"""
type ArtifactRevisionImportTask {
"""Background task ID."""
taskId: ID
"""Artifact revision data."""
artifactRevision: ArtifactRevision!
}
"""
Added in 24.09.0. Specifies the field and direction for ordering artifact revisions in queries.
"""
input ArtifactRevisionOrderBy {
field: ArtifactRevisionOrderField!
direction: OrderDirection! = ASC
}
enum ArtifactRevisionOrderField {
VERSION
SIZE
CREATED_AT
UPDATED_AT
STATUS
}
"""Added in 25.16.0. """
input ArtifactRevisionRemoteStatusFilter {
"""The in field."""
in: [ArtifactRemoteStatus!] = null
equals: ArtifactRemoteStatus = null
}
"""
Added in 24.09.0. Filter for artifact revision status. Supports exact match or inclusion in a list of statuses.
"""
input ArtifactRevisionStatusFilter {
"""The in field."""
in: [ArtifactStatus!] = null
equals: ArtifactStatus = null
}
enum ArtifactStatus {
SCANNED
PULLING
PULLED
VERIFYING
NEEDS_APPROVAL
AVAILABLE
FAILED
REJECTED
}
"""
Added in 24.09.0. Input for subscribing to artifact status change notifications.
Used with artifact_status_changed subscription to receive real-time updates
when artifact revision statuses change.
"""
input ArtifactStatusChangedInput {
artifactRevisionIds: [ID!]!
}
"""
Added in 25.14.0. Payload for artifact status change subscription events. Provides real-time notifications when artifact revision statuses change during import, cleanup, or other operations.
"""
type ArtifactStatusChangedPayload {
"""Updated artifact revision."""
artifactRevision: ArtifactRevision!
}
enum ArtifactType {
MODEL
PACKAGE
IMAGE
}
"""
Added in 25.17.0. Complete verification result containing results from all configured verifiers. Artifacts undergo malware scanning through multiple verifiers after being imported. This type aggregates results from all verifiers that were run on the artifact.
"""
type ArtifactVerificationResult {
"""Results from each verifier that scanned the artifact."""
verifiers: [ArtifactVerifierResultEntry!]!
}
"""
Added in 26.1.0. A collection of metadata from an artifact verifier. Contains key-value pairs providing additional information about the verification.
"""
type ArtifactVerifierMetadata {
"""List of metadata entries."""
entries: [ArtifactVerifierMetadataEntry!]!
}
"""
Added in 26.1.0. A single key-value entry representing metadata from an artifact verifier. Contains additional information about the verification process.
"""
type ArtifactVerifierMetadataEntry {
"""The key identifier for this metadata entry."""
key: String!
"""The value for this metadata entry."""
value: String!
}
"""
Added in 25.17.0. Result from a single malware verifier containing scan results and metadata. Each verifier scans the artifact for potential security issues and reports findings including infected file count, scan time, and any errors encountered.
"""
type ArtifactVerifierResult {
"""Whether the verification completed successfully."""
success: Boolean!
"""Number of infected or suspicious files detected."""
infectedCount: Int!
"""Timestamp when verification started."""
scannedAt: DateTime!
"""Time taken to complete verification in seconds."""
scanTime: Float!
"""Total number of files scanned."""
scannedCount: Int!
"""Additional metadata from the verifier."""
metadata: ArtifactVerifierMetadata!
"""Fatal error message if the verifier failed to complete."""
error: String
}
"""
Added in 25.17.0. Entry for a single verifier's result in the verification results. Associates a verifier name with its scan results.
"""
type ArtifactVerifierResultEntry {
"""Name of the verifier."""
name: String!
"""Scan result from this verifier."""
result: ArtifactVerifierResult!
}
"""Added in 26.3.0. Input for assigning a role to a user"""
input AssignRoleInput {
userId: UUID!