-
-
Notifications
You must be signed in to change notification settings - Fork 150
Expand file tree
/
Copy pathschema.graphql
More file actions
6705 lines (5478 loc) · 187 KB
/
schema.graphql
File metadata and controls
6705 lines (5478 loc) · 187 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
type Query {
me: UserType
userBySlug(slug: String!): UserType
corpusBySlugs(userSlug: String!, corpusSlug: String!): CorpusType
documentBySlugs(userSlug: String!, documentSlug: String!): DocumentType
documentInCorpusBySlugs(userSlug: String!, corpusSlug: String!, documentSlug: String!): DocumentType
annotations(rawTextContains: String, annotationLabelId: ID, annotationLabel_Text: String, annotationLabel_TextContains: String, annotationLabel_DescriptionContains: String, annotationLabel_LabelType: String, analysisIsnull: Boolean, documentId: ID, corpusId: ID, structural: Boolean, usesLabelFromLabelsetId: ID, createdByAnalysisIds: String, createdWithAnalyzerId: String, orderBy: String, offset: Int, before: String, after: String, first: Int, last: Int): AnnotationTypeConnection
bulkDocRelationshipsInCorpus(corpusId: ID!, documentId: ID!): [RelationshipType]
bulkDocAnnotationsInCorpus(corpusId: ID!, documentId: ID, forAnalysisIds: String, labelType: LabelType): [AnnotationType]
pageAnnotations(currentPage: Int, pageNumberList: String, pageContainingAnnotationWithId: ID, corpusId: ID, documentId: ID!, forAnalysisIds: String, labelType: LabelType): PageAwareAnnotationType
annotation(
"""The ID of the object"""
id: ID!
): AnnotationType
relationships(offset: Int, before: String, after: String, first: Int, last: Int, relationshipLabel: ID, corpusId: ID, documentId: ID): RelationshipTypeConnection
relationship(
"""The ID of the object"""
id: ID!
): RelationshipType
annotationLabels(offset: Int, before: String, after: String, first: Int, last: Int, description_Contains: String, text: String, text_Contains: String, labelType: AnnotationsAnnotationLabelLabelTypeChoices, usedInLabelsetId: String, usedInLabelsetForCorpusId: String, usedInAnalysisIds: String): AnnotationLabelTypeConnection
annotationLabel(
"""The ID of the object"""
id: ID!
): AnnotationLabelType
labelsets(offset: Int, before: String, after: String, first: Int, last: Int, id: ID, description_Contains: String, title: String, title_Contains: String, textSearch: String, labelsetId: String): LabelSetTypeConnection
labelset(
"""The ID of the object"""
id: ID!
): LabelSetType
corpuses(offset: Int, before: String, after: String, first: Int, last: Int, description: String, description_Contains: String, id: ID, title_Contains: String, textSearch: String, usesLabelsetId: String, categories: [ID]): CorpusTypeConnection
corpus(
"""The ID of the object"""
id: ID!
): CorpusType
"""List all corpus categories"""
corpusCategories(offset: Int, before: String, after: String, first: Int, last: Int, name: String, name_Contains: String, description_Contains: String): CorpusCategoryTypeConnection
"""Get all folders in a corpus (flat list for tree construction)"""
corpusFolders(corpusId: ID!): [CorpusFolderType]
"""Get a single folder by ID"""
corpusFolder(id: ID!): CorpusFolderType
"""Get all soft-deleted documents in a corpus (trash folder view)"""
deletedDocumentsInCorpus(corpusId: ID!): [DocumentPathType]
searchCorpusesForMention(
"""Search query to find corpuses by title or description"""
textSearch: String
offset: Int
before: String
after: String
first: Int
last: Int
): CorpusTypeConnection
searchDocumentsForMention(
"""Search query to find documents by title or description"""
textSearch: String
"""Optional corpus ID to scope search to documents in specific corpus"""
corpusId: ID
offset: Int
before: String
after: String
first: Int
last: Int
): DocumentTypeConnection
searchAnnotationsForMention(
"""Search query to find annotations by label text or raw content"""
textSearch: String
"""Optional corpus ID to scope search to specific corpus"""
corpusId: ID
offset: Int
before: String
after: String
first: Int
last: Int
): AnnotationTypeConnection
searchUsersForMention(
"""Search query to find users by username or email"""
textSearch: String
offset: Int
before: String
after: String
first: Int
last: Int
): UserTypeConnection
documents(offset: Int, before: String, after: String, first: Int, last: Int, description: String, description_Contains: String, id: ID, companySearch: String, hasPdf: Boolean, hasAnnotationsWithIds: String, inCorpusWithId: String, inFolderId: String, hasLabelWithTitle: String, hasLabelWithId: String, textSearch: String): DocumentTypeConnection
document(id: String): DocumentType
userimports(offset: Int, before: String, after: String, first: Int, last: Int): UserImportTypeConnection
userimport(
"""The ID of the object"""
id: ID!
): UserImportType
userexports(
offset: Int
before: String
after: String
first: Int
last: Int
name_Contains: String
id: ID
created_Lte: DateTime
started_Lte: DateTime
finished_Lte: DateTime
"""Ordering"""
orderByCreated: String
"""Ordering"""
orderByStarted: String
"""Ordering"""
orderByFinished: String
): UserExportTypeConnection
userexport(
"""The ID of the object"""
id: ID!
): UserExportType
assignments(offset: Int, before: String, after: String, first: Int, last: Int, assignor_Email: String, assignee_Email: String, documentId: String): AssignmentTypeConnection
assignment(
"""The ID of the object"""
id: ID!
): AssignmentType
gremlinEngine(
"""The ID of the object"""
id: ID!
): GremlinEngineType_READ
gremlinEngines(offset: Int, before: String, after: String, first: Int, last: Int, url: String): GremlinEngineType_READConnection
analyzer(
"""The ID of the object"""
id: ID!
): AnalyzerType
analyzers(offset: Int, before: String, after: String, first: Int, last: Int, id_Contains: ID, id: ID, description_Contains: String, disabled: Boolean, analyzerId: String, hostedByGremlinEngineId: String, usedInAnalysisIds: String): AnalyzerTypeConnection
analysis(
"""The ID of the object"""
id: ID!
): AnalysisType
analyses(offset: Int, before: String, after: String, first: Int, last: Int, analyzedCorpus_Isnull: Boolean, analysisStarted_Gte: DateTime, analysisStarted_Lte: DateTime, analysisCompleted_Gte: DateTime, analysisCompleted_Lte: DateTime, status: AnalyzerAnalysisStatusChoices, receivedCallbackResults: Boolean, analyzedCorpusId: String, analyzedDocumentId: String, searchText: String): AnalysisTypeConnection
fieldset(
"""The ID of the object"""
id: ID!
): FieldsetType
fieldsets(offset: Int, before: String, after: String, first: Int, last: Int, name: String, name_Contains: String, description_Contains: String): FieldsetTypeConnection
column(
"""The ID of the object"""
id: ID!
): ColumnType
columns(offset: Int, before: String, after: String, first: Int, last: Int, query_Contains: String, matchText_Contains: String, outputType: String, limitToLabel: String): ColumnTypeConnection
extract(
"""The ID of the object"""
id: ID!
): ExtractType
extracts(offset: Int, before: String, after: String, first: Int, last: Int, corpusAction_Isnull: Boolean, name: String, name_Contains: String, created_Lte: DateTime, created_Gte: DateTime, started_Lte: DateTime, started_Gte: DateTime, finished_Lte: DateTime, finished_Gte: DateTime, corpus: ID): ExtractTypeConnection
datacell(
"""The ID of the object"""
id: ID!
): DatacellType
datacells(offset: Int, before: String, after: String, first: Int, last: Int, dataDefinition: String, started_Lte: DateTime, started_Gte: DateTime, completed_Lte: DateTime, completed_Gte: DateTime, failed_Lte: DateTime, failed_Gte: DateTime, inCorpusWithId: String, forDocumentWithId: String): DatacellTypeConnection
registeredExtractTasks: GenericScalar
corpusStats(corpusId: ID!): CorpusStatsType
documentCorpusActions(documentId: ID!, corpusId: ID): DocumentCorpusActionsType
"""
Retrieve all registered pipeline components, optionally filtered by MIME type.
"""
pipelineComponents(mimetype: FileTypeEnum): PipelineComponentsType
"""
Retrieve conversations, optionally filtered by document_id or corpus_id
"""
conversations(offset: Int, before: String, after: String, first: Int, last: Int, createdAt_Gte: DateTime, createdAt_Lte: DateTime, title_Contains: String, conversationType: ConversationTypeEnum, documentId: String, corpusId: String, hasCorpus: Boolean, hasDocument: Boolean): ConversationTypeConnection
"""Search conversations using vector similarity with pagination"""
searchConversations(
"""Search query text"""
query: String!
"""Filter by corpus ID"""
corpusId: ID
"""Filter by document ID"""
documentId: ID
"""Filter by conversation type (chat/thread)"""
conversationType: String
"""Maximum number of results to fetch from vector store"""
topK: Int = 100
before: String
after: String
first: Int
last: Int
): ConversationConnection
"""Search messages using vector similarity"""
searchMessages(
"""Search query text"""
query: String!
"""Filter by corpus ID"""
corpusId: ID
"""Filter by conversation ID"""
conversationId: ID
"""Filter by message type (HUMAN/LLM/SYSTEM)"""
msgType: String
"""Number of results to return"""
topK: Int = 10
): [MessageType]
"""
Hybrid search combining vector similarity with text filters. Uses DEFAULT_EMBEDDER for global cross-corpus search. Results are first filtered by text criteria, then ranked by similarity.
"""
semanticSearch(
"""Search query text"""
query: String!
"""Optional corpus ID to search within"""
corpusId: ID
"""Optional document ID to search within"""
documentId: ID
"""Filter by content modalities (TEXT, IMAGE)"""
modalities: [String]
"""Filter by annotation label text (case-insensitive substring match)"""
labelText: String
"""Filter by raw_text content (case-insensitive substring match)"""
rawTextContains: String
"""Maximum number of results to return (default: 50, max: 200)"""
limit: Int = 50
"""Number of results to skip for pagination"""
offset: Int = 0
): [SemanticSearchResultType]
"""Query moderation action audit logs with filtering"""
moderationActions(corpusId: ID, threadId: ID, moderatorId: ID, actionTypes: [String], automatedOnly: Boolean, offset: Int, before: String, after: String, first: Int, last: Int, actionType: ConversationsModerationActionActionTypeChoices, actionType_In: [ConversationsModerationActionActionTypeChoices], created_Gte: DateTime, created_Lte: DateTime): ModerationActionTypeConnection
"""Get a specific moderation action by ID"""
moderationAction(id: ID!): ModerationActionType
"""Get moderation metrics for a corpus"""
moderationMetrics(corpusId: ID!, timeRangeHours: Int = 24): ModerationMetricsType
documentRelationships(corpusId: ID, documentId: ID, offset: Int, before: String, after: String, first: Int, last: Int, relationshipType: DocumentsDocumentRelationshipRelationshipTypeChoices, sourceDocument: ID, targetDocument: ID, annotationLabel: ID, creator: ID, isPublic: Boolean): DocumentRelationshipTypeConnection
documentRelationship(
"""The ID of the object"""
id: ID!
): DocumentRelationshipType
bulkDocRelationships(corpusId: ID, documentId: ID!, relationshipType: String): [DocumentRelationshipType]
notes(titleContains: String, contentContains: String, documentId: ID, annotationId: ID, orderBy: String, offset: Int, before: String, after: String, first: Int, last: Int): NoteTypeConnection
note(
"""The ID of the object"""
id: ID!
): NoteType
chatMessages(conversationId: ID!, orderBy: String): [MessageType]
chatMessage(
"""The ID of the object"""
id: ID!
): MessageType
"""
Get messages created by a specific user, with optional filtering and pagination
"""
userMessages(creatorId: ID!, first: Int = 10, msgType: String, orderBy: String): [MessageType]
corpusActions(corpusId: ID, trigger: String, disabled: Boolean, offset: Int, before: String, after: String, first: Int, last: Int): CorpusActionTypeConnection
agentActionResults(corpusActionId: ID, documentId: ID, status: String, offset: Int, before: String, after: String, first: Int, last: Int): AgentActionResultTypeConnection
corpusActionExecutions(corpusId: ID, documentId: ID, corpusActionId: ID, status: String, actionType: String, since: DateTime, offset: Int, before: String, after: String, first: Int, last: Int): CorpusActionExecutionTypeConnection
corpusActionTrailStats(corpusId: ID!, since: DateTime): CorpusActionTrailStatsType
conversation(
"""The ID of the object"""
id: ID!
): ConversationType
"""Check the status of a bulk document upload job by job ID"""
bulkDocumentUploadStatus(jobId: String!): BulkDocumentUploadStatusType
"""Get metadata columns for a corpus"""
corpusMetadataColumns(corpusId: ID!): [ColumnType]
"""Get metadata datacells for a document in a corpus"""
documentMetadataDatacells(documentId: ID!, corpusId: ID!): [DatacellType]
"""
Get metadata completion status for a document using column/datacell system
"""
metadataCompletionStatusV2(documentId: ID!, corpusId: ID!): MetadataCompletionStatusType
"""
Get metadata datacells for multiple documents in a single query (batch)
"""
documentsMetadataDatacellsBatch(documentIds: [ID]!, corpusId: ID!): [DocumentMetadataResultType]
badges(offset: Int, before: String, after: String, first: Int, last: Int, badgeType: BadgesBadgeBadgeTypeChoices, isAutoAwarded: Boolean, name_Contains: String, name: String, corpusId: String): BadgeTypeConnection
badge(
"""The ID of the object"""
id: ID!
): BadgeType
userBadges(offset: Int, before: String, after: String, first: Int, last: Int, awardedAt_Gte: DateTime, awardedAt_Lte: DateTime, userId: String, badgeId: String, corpusId: String): UserBadgeTypeConnection
userBadge(
"""The ID of the object"""
id: ID!
): UserBadgeType
"""Get available badge criteria types from the registry"""
badgeCriteriaTypes(
"""Filter by scope: 'global', 'corpus', or 'both'"""
scope: String
): [CriteriaTypeDefinitionType]
agents(offset: Int, before: String, after: String, first: Int, last: Int, scope: AgentsAgentConfigurationScopeChoices, isActive: Boolean, name_Contains: String, name: String, corpusId: String): AgentConfigurationTypeConnection
agentConfigurations(offset: Int, before: String, after: String, first: Int, last: Int, scope: AgentsAgentConfigurationScopeChoices, isActive: Boolean, name_Contains: String, name: String, corpusId: String): AgentConfigurationTypeConnection
agent(
"""The ID of the object"""
id: ID!
): AgentConfigurationType
searchAgentsForMention(
"""Search query to find agents by name, slug, or description"""
textSearch: String
"""Corpus ID to scope agent search (includes global + corpus agents)"""
corpusId: ID
offset: Int
before: String
after: String
first: Int
last: Int
): AgentConfigurationTypeConnection
"""Get all available tools that can be assigned to agents"""
availableTools(
"""
Filter by tool category (search, document, corpus, notes, annotations, coordination)
"""
category: String
): [AvailableToolType!]
"""Get all available tool categories"""
availableToolCategories: [String!]
"""Get user's notifications (paginated and filterable)"""
notifications(offset: Int, before: String, after: String, first: Int, last: Int, isRead: Boolean, notificationType: NotificationsNotificationNotificationTypeChoices, createdAt_Lte: DateTime, createdAt_Gte: DateTime): NotificationTypeConnection
notification(
"""The ID of the object"""
id: ID!
): NotificationType
"""Get count of unread notifications for the current user"""
unreadNotificationCount: Int
"""Get top contributors for a specific corpus by reputation"""
corpusLeaderboard(corpusId: ID!, limit: Int = 10): [UserType]
"""Get top contributors globally by reputation"""
globalLeaderboard(limit: Int = 10): [UserType]
"""Get leaderboard for a specific metric and scope"""
leaderboard(metric: LeaderboardMetricEnum!, scope: LeaderboardScopeEnum = ALL_TIME, corpusId: ID, limit: Int = 25): LeaderboardType
"""Get overall community engagement statistics"""
communityStats(corpusId: ID): CommunityStatsType
"""Public OG metadata for corpus - no auth required"""
ogCorpusMetadata(userSlug: String!, corpusSlug: String!): OGCorpusMetadataType
"""Public OG metadata for standalone document - no auth required"""
ogDocumentMetadata(userSlug: String!, documentSlug: String!): OGDocumentMetadataType
"""Public OG metadata for document in corpus - no auth required"""
ogDocumentInCorpusMetadata(userSlug: String!, corpusSlug: String!, documentSlug: String!): OGDocumentMetadataType
"""Public OG metadata for discussion thread - no auth required"""
ogThreadMetadata(userSlug: String!, corpusSlug: String!, threadId: String!): OGThreadMetadataType
"""Public OG metadata for data extract - no auth required"""
ogExtractMetadata(extractId: String!): OGExtractMetadataType
}
type UserType implements Node {
"""The ID of the object"""
id: ID!
password: String!
lastLogin: DateTime
"""
Designates that this user has all permissions without explicitly assigning them.
"""
isSuperuser: Boolean!
"""Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only."""
username: String!
"""Designates whether the user can log into this admin site."""
isStaff: Boolean!
dateJoined: DateTime!
name: String!
firstName: String!
lastName: String!
givenName: String!
familyName: String!
auth0Id: String!
phone: String!
email: String!
synced: Boolean!
isActive: Boolean!
emailVerified: Boolean!
isSocialUser: Boolean!
isUsageCapped: Boolean!
lastSynced: DateTime
firstSignedIn: DateTime!
lastIp: String!
"""
Case-sensitive URL slug. Allowed characters: A-Z, a-z, 0-9, and hyphen (-).
"""
slug: String
"""Whether the user has accepted cookie consent"""
cookieConsentAccepted: Boolean!
"""When the user accepted cookie consent"""
cookieConsentDate: DateTime
"""Whether this user's profile is visible to other users"""
isProfilePublic: Boolean!
"""
Whether the user has dismissed the Getting Started guide on the Discover page
"""
dismissedGettingStarted: Boolean!
createdAssignments(offset: Int, before: String, after: String, first: Int, last: Int): AssignmentTypeConnection!
myAssignments(offset: Int, before: String, after: String, first: Int, last: Int): AssignmentTypeConnection!
userexportSet(offset: Int, before: String, after: String, first: Int, last: Int): UserExportTypeConnection!
lockedUserexportObjects(offset: Int, before: String, after: String, first: Int, last: Int): UserExportTypeConnection!
userimportSet(offset: Int, before: String, after: String, first: Int, last: Int): UserImportTypeConnection!
lockedUserimportObjects(offset: Int, before: String, after: String, first: Int, last: Int): UserImportTypeConnection!
lockedDocumentObjects(offset: Int, before: String, after: String, first: Int, last: Int): DocumentTypeConnection!
documentSet(offset: Int, before: String, after: String, first: Int, last: Int): DocumentTypeConnection!
lockedDocumentanalysisrowObjects(offset: Int, before: String, after: String, first: Int, last: Int): DocumentAnalysisRowTypeConnection!
documentanalysisrowSet(offset: Int, before: String, after: String, first: Int, last: Int): DocumentAnalysisRowTypeConnection!
lockedDocumentrelationshipObjects(offset: Int, before: String, after: String, first: Int, last: Int): DocumentRelationshipTypeConnection!
documentrelationshipSet(offset: Int, before: String, after: String, first: Int, last: Int): DocumentRelationshipTypeConnection!
lockedDocumentpathObjects(offset: Int, before: String, after: String, first: Int, last: Int): DocumentPathTypeConnection!
documentpathSet(offset: Int, before: String, after: String, first: Int, last: Int): DocumentPathTypeConnection!
documentSummaryRevisions(offset: Int, before: String, after: String, first: Int, last: Int): DocumentSummaryRevisionTypeConnection!
lockedCorpuscategoryObjects(offset: Int, before: String, after: String, first: Int, last: Int): CorpusCategoryTypeConnection!
corpuscategorySet(offset: Int, before: String, after: String, first: Int, last: Int): CorpusCategoryTypeConnection!
corpusSet(offset: Int, before: String, after: String, first: Int, last: Int): CorpusTypeConnection!
editingCorpuses(offset: Int, before: String, after: String, first: Int, last: Int): CorpusTypeConnection!
lockedCorpusactionObjects(offset: Int, before: String, after: String, first: Int, last: Int, id: ID, name: String, name_Icontains: String, name_Istartswith: String, corpus_Id: ID, fieldset_Id: ID, analyzer_Id: ID, agentConfig_Id: ID, trigger: CorpusesCorpusActionTriggerChoices, creator_Id: ID): CorpusActionTypeConnection!
corpusactionSet(offset: Int, before: String, after: String, first: Int, last: Int, id: ID, name: String, name_Icontains: String, name_Istartswith: String, corpus_Id: ID, fieldset_Id: ID, analyzer_Id: ID, agentConfig_Id: ID, trigger: CorpusesCorpusActionTriggerChoices, creator_Id: ID): CorpusActionTypeConnection!
corpusRevisions(offset: Int, before: String, after: String, first: Int, last: Int): CorpusDescriptionRevisionTypeConnection!
corpusfolderSet(offset: Int, before: String, after: String, first: Int, last: Int): CorpusFolderTypeConnection!
lockedCorpusactionexecutionObjects(offset: Int, before: String, after: String, first: Int, last: Int, id: ID, corpus_Id: ID, corpusAction_Id: ID, document_Id: ID, status: CorpusesCorpusActionExecutionStatusChoices, actionType: CorpusesCorpusActionExecutionActionTypeChoices, trigger: CorpusesCorpusActionExecutionTriggerChoices, creator_Id: ID): CorpusActionExecutionTypeConnection!
corpusactionexecutionSet(offset: Int, before: String, after: String, first: Int, last: Int, id: ID, corpus_Id: ID, corpusAction_Id: ID, document_Id: ID, status: CorpusesCorpusActionExecutionStatusChoices, actionType: CorpusesCorpusActionExecutionActionTypeChoices, trigger: CorpusesCorpusActionExecutionTriggerChoices, creator_Id: ID): CorpusActionExecutionTypeConnection!
annotationlabelSet(offset: Int, before: String, after: String, first: Int, last: Int): AnnotationLabelTypeConnection!
lockedAnnotationlabelObjects(offset: Int, before: String, after: String, first: Int, last: Int): AnnotationLabelTypeConnection!
relationshipSet(offset: Int, before: String, after: String, first: Int, last: Int): RelationshipTypeConnection!
lockedRelationshipObjects(offset: Int, before: String, after: String, first: Int, last: Int): RelationshipTypeConnection!
annotationSet(
offset: Int
before: String
after: String
first: Int
last: Int
rawText_Contains: String
annotationLabelId: ID
annotationLabel_Text: String
annotationLabel_Text_Contains: String
annotationLabel_Description_Contains: String
annotationLabel_LabelType: AnnotationsAnnotationLabelLabelTypeChoices
analysis_Isnull: Boolean
documentId: ID
corpusId: ID
structural: Boolean
usesLabelFromLabelsetId: String
createdByAnalysisIds: String
createdWithAnalyzerId: String
"""Ordering"""
orderBy: String
): AnnotationTypeConnection!
lockedAnnotationObjects(
offset: Int
before: String
after: String
first: Int
last: Int
rawText_Contains: String
annotationLabelId: ID
annotationLabel_Text: String
annotationLabel_Text_Contains: String
annotationLabel_Description_Contains: String
annotationLabel_LabelType: AnnotationsAnnotationLabelLabelTypeChoices
analysis_Isnull: Boolean
documentId: ID
corpusId: ID
structural: Boolean
usesLabelFromLabelsetId: String
createdByAnalysisIds: String
createdWithAnalyzerId: String
"""Ordering"""
orderBy: String
): AnnotationTypeConnection!
lockedLabelsetObjects(offset: Int, before: String, after: String, first: Int, last: Int): LabelSetTypeConnection!
labelsetSet(offset: Int, before: String, after: String, first: Int, last: Int): LabelSetTypeConnection!
noteSet(offset: Int, before: String, after: String, first: Int, last: Int): NoteTypeConnection!
lockedNoteObjects(offset: Int, before: String, after: String, first: Int, last: Int): NoteTypeConnection!
noteRevisions(offset: Int, before: String, after: String, first: Int, last: Int): NoteRevisionTypeConnection!
lockedGremlinengineObjects(offset: Int, before: String, after: String, first: Int, last: Int): GremlinEngineType_WRITEConnection!
gremlinengineSet(offset: Int, before: String, after: String, first: Int, last: Int): GremlinEngineType_WRITEConnection!
lockedAnalyzerObjects(offset: Int, before: String, after: String, first: Int, last: Int): AnalyzerTypeConnection!
analyzerSet(offset: Int, before: String, after: String, first: Int, last: Int): AnalyzerTypeConnection!
analysisSet(offset: Int, before: String, after: String, first: Int, last: Int): AnalysisTypeConnection!
lockedAnalysisObjects(offset: Int, before: String, after: String, first: Int, last: Int): AnalysisTypeConnection!
lockedFieldsetObjects(offset: Int, before: String, after: String, first: Int, last: Int): FieldsetTypeConnection!
fieldsetSet(offset: Int, before: String, after: String, first: Int, last: Int): FieldsetTypeConnection!
lockedColumnObjects(offset: Int, before: String, after: String, first: Int, last: Int): ColumnTypeConnection!
columnSet(offset: Int, before: String, after: String, first: Int, last: Int): ColumnTypeConnection!
lockedExtractObjects(offset: Int, before: String, after: String, first: Int, last: Int): ExtractTypeConnection!
extractSet(offset: Int, before: String, after: String, first: Int, last: Int): ExtractTypeConnection!
approvedCells(offset: Int, before: String, after: String, first: Int, last: Int): DatacellTypeConnection!
rejectedCells(offset: Int, before: String, after: String, first: Int, last: Int): DatacellTypeConnection!
lockedDatacellObjects(offset: Int, before: String, after: String, first: Int, last: Int): DatacellTypeConnection!
datacellSet(offset: Int, before: String, after: String, first: Int, last: Int): DatacellTypeConnection!
lockedUserfeedbackObjects(offset: Int, before: String, after: String, first: Int, last: Int): UserFeedbackTypeConnection!
userfeedbackSet(offset: Int, before: String, after: String, first: Int, last: Int): UserFeedbackTypeConnection!
"""Moderator who locked the thread"""
lockedConversations(offset: Int, before: String, after: String, first: Int, last: Int): ConversationTypeConnection!
"""Moderator who pinned the thread"""
pinnedConversations(offset: Int, before: String, after: String, first: Int, last: Int): ConversationTypeConnection!
lockedConversationObjects(offset: Int, before: String, after: String, first: Int, last: Int): ConversationTypeConnection!
conversationSet(offset: Int, before: String, after: String, first: Int, last: Int): ConversationTypeConnection!
lockedChatmessageObjects(offset: Int, before: String, after: String, first: Int, last: Int): MessageTypeConnection!
chatmessageSet(offset: Int, before: String, after: String, first: Int, last: Int): MessageTypeConnection!
"""Moderator who took this action"""
moderationActionsTaken(offset: Int, before: String, after: String, first: Int, last: Int): ModerationActionTypeConnection!
lockedModerationactionObjects(offset: Int, before: String, after: String, first: Int, last: Int): ModerationActionTypeConnection!
moderationactionSet(offset: Int, before: String, after: String, first: Int, last: Int): ModerationActionTypeConnection!
lockedBadgeObjects(offset: Int, before: String, after: String, first: Int, last: Int): BadgeTypeConnection!
badgeSet(offset: Int, before: String, after: String, first: Int, last: Int): BadgeTypeConnection!
"""User who received the badge"""
badges(offset: Int, before: String, after: String, first: Int, last: Int): UserBadgeTypeConnection!
"""User who awarded the badge (null for auto-awards)"""
badgesAwarded(offset: Int, before: String, after: String, first: Int, last: Int): UserBadgeTypeConnection!
"""User receiving this notification"""
notifications(offset: Int, before: String, after: String, first: Int, last: Int, isRead: Boolean, notificationType: NotificationsNotificationNotificationTypeChoices, createdAt_Lte: DateTime, createdAt_Gte: DateTime): NotificationTypeConnection!
"""User who triggered this notification (if applicable)"""
notificationsTriggered(offset: Int, before: String, after: String, first: Int, last: Int, isRead: Boolean, notificationType: NotificationsNotificationNotificationTypeChoices, createdAt_Lte: DateTime, createdAt_Gte: DateTime): NotificationTypeConnection!
lockedAgentconfigurationObjects(offset: Int, before: String, after: String, first: Int, last: Int, scope: AgentsAgentConfigurationScopeChoices, isActive: Boolean, corpus: ID): AgentConfigurationTypeConnection!
agentconfigurationSet(offset: Int, before: String, after: String, first: Int, last: Int, scope: AgentsAgentConfigurationScopeChoices, isActive: Boolean, corpus: ID): AgentConfigurationTypeConnection!
lockedAgentactionresultObjects(offset: Int, before: String, after: String, first: Int, last: Int, id: ID, corpusAction_Id: ID, document_Id: ID, status: AgentsAgentActionResultStatusChoices, creator_Id: ID): AgentActionResultTypeConnection!
agentactionresultSet(offset: Int, before: String, after: String, first: Int, last: Int, id: ID, corpusAction_Id: ID, document_Id: ID, status: AgentsAgentActionResultStatusChoices, creator_Id: ID): AgentActionResultTypeConnection!
myPermissions: GenericScalar
isPublished: Boolean
objectSharedWith: GenericScalar
"""Global reputation score across all corpuses"""
reputationGlobal: Int
"""Reputation score for a specific corpus"""
reputationForCorpus(corpusId: ID!): Int
"""Total number of messages posted by this user"""
totalMessages: Int
"""Total number of threads created by this user"""
totalThreadsCreated: Int
"""
Total number of annotations created by this user (visible to requester)
"""
totalAnnotationsCreated: Int
"""Total number of documents uploaded by this user (visible to requester)"""
totalDocumentsUploaded: Int
}
"""An object with an ID"""
interface Node {
"""The ID of the object"""
id: ID!
}
"""
The `DateTime` scalar type represents a DateTime
value as specified by
[iso8601](https://en.wikipedia.org/wiki/ISO_8601).
"""
scalar DateTime
type AssignmentTypeConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
"""Contains the nodes in this connection."""
edges: [AssignmentTypeEdge]!
totalCount: Int
}
"""
The Relay compliant `PageInfo` type, containing data necessary to paginate this connection.
"""
type PageInfo {
"""When paginating forwards, are there more items?"""
hasNextPage: Boolean!
"""When paginating backwards, are there more items?"""
hasPreviousPage: Boolean!
"""When paginating backwards, the cursor to continue."""
startCursor: String
"""When paginating forwards, the cursor to continue."""
endCursor: String
}
"""A Relay edge containing a `AssignmentType` and its cursor."""
type AssignmentTypeEdge {
"""The item at the end of the edge"""
node: AssignmentType
"""A cursor for use in pagination"""
cursor: String!
}
type AssignmentType implements Node {
"""The ID of the object"""
id: ID!
name: String
document: DocumentType!
corpus: CorpusType
resultingAnnotations(
offset: Int
before: String
after: String
first: Int
last: Int
rawText_Contains: String
annotationLabelId: ID
annotationLabel_Text: String
annotationLabel_Text_Contains: String
annotationLabel_Description_Contains: String
annotationLabel_LabelType: AnnotationsAnnotationLabelLabelTypeChoices
analysis_Isnull: Boolean
documentId: ID
corpusId: ID
structural: Boolean
usesLabelFromLabelsetId: String
createdByAnalysisIds: String
createdWithAnalyzerId: String
"""Ordering"""
orderBy: String
): AnnotationTypeConnection!
resultingRelationships(offset: Int, before: String, after: String, first: Int, last: Int): RelationshipTypeConnection!
comments: String!
assignor: UserType!
assignee: UserType
completedAt: DateTime
created: DateTime!
modified: DateTime!
myPermissions: GenericScalar
isPublished: Boolean
objectSharedWith: GenericScalar
}
type DocumentType implements Node {
"""The ID of the object"""
id: ID!
parent: DocumentType
userLock: UserType
backendLock: Boolean!
isPublic: Boolean!
creator: UserType!
created: DateTime!
modified: DateTime!
title: String
description: String
"""
Case-sensitive slug unique per creator. Allowed: A-Z, a-z, 0-9, hyphen (-).
"""
slug: String
customMeta: JSONString
fileType: String!
icon: String!
pdfFile: String
txtExtractFile: String
mdSummaryFile: String
pageCount: Int!
pawlsParseFile: String
"""SHA-256 hash of the PDF file content for caching and integrity checks"""
pdfFileHash: String
"""
Groups all content versions of same logical document. Implements Rule C1.
"""
versionTreeId: UUID!
"""True for newest content in this version tree. Implements Rule C3."""
isCurrent: Boolean!
"""
Original document this was copied from (cross-corpus provenance). Implements Rule I2.
"""
sourceDocument: DocumentType
processingStarted: DateTime
processingFinished: DateTime
assignmentSet(offset: Int, before: String, after: String, first: Int, last: Int): AssignmentTypeConnection!
"""
Original document this was copied from (cross-corpus provenance). Implements Rule I2.
"""
corpusCopies(offset: Int, before: String, after: String, first: Int, last: Int): DocumentTypeConnection!
children(offset: Int, before: String, after: String, first: Int, last: Int): DocumentTypeConnection!
rows(offset: Int, before: String, after: String, first: Int, last: Int): DocumentAnalysisRowTypeConnection!
sourceRelationships(offset: Int, before: String, after: String, first: Int, last: Int): DocumentRelationshipTypeConnection!
targetRelationships(offset: Int, before: String, after: String, first: Int, last: Int): DocumentRelationshipTypeConnection!
"""Specific content version this path points to"""
pathRecords(offset: Int, before: String, after: String, first: Int, last: Int): DocumentPathTypeConnection!
"""
List of all summary revisions/versions for a specific corpus, ordered by version.
"""
summaryRevisions(corpusId: ID!): [DocumentSummaryRevisionType]
corpusSet(offset: Int, before: String, after: String, first: Int, last: Int): CorpusTypeConnection!
"""
The document this action was executed on (null for thread-based actions)
"""
corpusActionExecutions(offset: Int, before: String, after: String, first: Int, last: Int, id: ID, corpus_Id: ID, corpusAction_Id: ID, document_Id: ID, status: CorpusesCorpusActionExecutionStatusChoices, actionType: CorpusesCorpusActionExecutionActionTypeChoices, trigger: CorpusesCorpusActionExecutionTriggerChoices, creator_Id: ID): CorpusActionExecutionTypeConnection!
relationships(offset: Int, before: String, after: String, first: Int, last: Int): RelationshipTypeConnection!
docAnnotations(
offset: Int
before: String
after: String
first: Int
last: Int
rawText_Contains: String
annotationLabelId: ID
annotationLabel_Text: String
annotationLabel_Text_Contains: String
annotationLabel_Description_Contains: String
annotationLabel_LabelType: AnnotationsAnnotationLabelLabelTypeChoices
analysis_Isnull: Boolean
documentId: ID
corpusId: ID
structural: Boolean
usesLabelFromLabelsetId: String
createdByAnalysisIds: String
createdWithAnalyzerId: String
"""Ordering"""
orderBy: String
): AnnotationTypeConnection!
notes(offset: Int, before: String, after: String, first: Int, last: Int): NoteTypeConnection!
includedInAnalyses(offset: Int, before: String, after: String, first: Int, last: Int): AnalysisTypeConnection!
extracts(offset: Int, before: String, after: String, first: Int, last: Int): ExtractTypeConnection!
extractedDatacells(offset: Int, before: String, after: String, first: Int, last: Int): DatacellTypeConnection!
"""The document to which this conversation belongs"""
conversations(offset: Int, before: String, after: String, first: Int, last: Int): ConversationTypeConnection!
"""A document that this chat message is based on"""
chatMessages(offset: Int, before: String, after: String, first: Int, last: Int): MessageTypeConnection!
"""The document this action was run on (null for thread-based actions)"""
agentActionResults(offset: Int, before: String, after: String, first: Int, last: Int, id: ID, corpusAction_Id: ID, document_Id: ID, status: AgentsAgentActionResultStatusChoices, creator_Id: ID): AgentActionResultTypeConnection!
myPermissions: GenericScalar
isPublished: Boolean
objectSharedWith: GenericScalar
allStructuralAnnotations: [AnnotationType]
allAnnotations(corpusId: ID, analysisId: ID, isStructural: Boolean): [AnnotationType]
allRelationships(corpusId: ID, analysisId: ID): [RelationshipType]
allDocRelationships(corpusId: String): [DocumentRelationshipType]
"""Count of document relationships for this document in the given corpus"""
docRelationshipCount(corpusId: String): Int
allNotes(corpusId: ID): [NoteType]
"""Current version number of the summary for a specific corpus"""
currentSummaryVersion(corpusId: ID!): Int
"""Current summary content for a specific corpus"""
summaryContent(corpusId: ID!): String
"""Content version number in this corpus (from DocumentPath)"""
versionNumber(corpusId: ID!): Int
"""True if this document has multiple versions (parent exists)"""
hasVersionHistory: Boolean
"""Total number of versions in this document's version tree"""
versionCount: Int
"""True if this is the current version (Document.is_current)"""
isLatestVersion: Boolean
"""When the document was last modified in this corpus"""
lastModified(corpusId: ID!): DateTime
"""Complete version history (lazy-loaded on request)"""
versionHistory: VersionHistoryType
"""Path/location history in corpus (lazy-loaded on request)"""
pathHistory(corpusId: ID!): PathHistoryType
"""Whether user can restore this document (requires UPDATE permission)"""
canRestore(corpusId: ID!): Boolean
"""Whether user can view version history (requires READ permission)"""
canViewHistory: Boolean
"""
Get annots for spec. page(s) using opt. queries. Either 'page' (single) or 'pages' (multiple).
"""
pageAnnotations(corpusId: ID!, page: Int, pages: [Int], structural: Boolean, analysisId: ID): [AnnotationType]
"""
Get relationships where source or target annotations are on the specified page(s).
"""
pageRelationships(corpusId: ID!, pages: [Int]!, structural: Boolean, analysisId: ID): [RelationshipType]
"""
Get relationship summary statistics for this document and corpus (MV-backed).
"""
relationshipSummary(corpusId: ID!): GenericScalar
"""Get summary of annotations used in specific extract."""
extractAnnotationSummary(extractId: ID!): GenericScalar
"""
Get the folder this document is in within a specific corpus (null = root)
"""
folderInCorpus(corpusId: ID!): CorpusFolderType
}
"""
Allows use of a JSON String for input / output from the GraphQL schema.
Use of this type is *not recommended* as you lose the benefits of having a defined, static
schema (one of the key benefits of GraphQL).
"""
scalar JSONString
"""
Leverages the internal Python implementation of UUID (uuid.UUID) to provide native UUID objects
in fields, resolvers and input.
"""
scalar UUID
type DocumentTypeConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
"""Contains the nodes in this connection."""
edges: [DocumentTypeEdge]!
totalCount: Int
}
"""A Relay edge containing a `DocumentType` and its cursor."""
type DocumentTypeEdge {
"""The item at the end of the edge"""
node: DocumentType
"""A cursor for use in pagination"""
cursor: String!
}
type DocumentAnalysisRowTypeConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
"""Contains the nodes in this connection."""
edges: [DocumentAnalysisRowTypeEdge]!
totalCount: Int
}
"""A Relay edge containing a `DocumentAnalysisRowType` and its cursor."""
type DocumentAnalysisRowTypeEdge {
"""The item at the end of the edge"""
node: DocumentAnalysisRowType
"""A cursor for use in pagination"""
cursor: String!
}
type DocumentAnalysisRowType implements Node {
"""The ID of the object"""
id: ID!
userLock: UserType
backendLock: Boolean!
isPublic: Boolean!
creator: UserType!
created: DateTime!
modified: DateTime!
document: DocumentType!
annotations(
offset: Int
before: String
after: String
first: Int
last: Int
rawText_Contains: String
annotationLabelId: ID
annotationLabel_Text: String
annotationLabel_Text_Contains: String
annotationLabel_Description_Contains: String
annotationLabel_LabelType: AnnotationsAnnotationLabelLabelTypeChoices
analysis_Isnull: Boolean
documentId: ID
corpusId: ID
structural: Boolean
usesLabelFromLabelsetId: String
createdByAnalysisIds: String
createdWithAnalyzerId: String
"""Ordering"""
orderBy: String
): AnnotationTypeConnection!
data(offset: Int, before: String, after: String, first: Int, last: Int): DatacellTypeConnection!
analysis: AnalysisType
extract: ExtractType
myPermissions: GenericScalar
isPublished: Boolean
objectSharedWith: GenericScalar
}
type AnnotationTypeConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
"""Contains the nodes in this connection."""
edges: [AnnotationTypeEdge]!
totalCount: Int
}
"""A Relay edge containing a `AnnotationType` and its cursor."""
type AnnotationTypeEdge {
"""The item at the end of the edge"""
node: AnnotationType
"""A cursor for use in pagination"""
cursor: String!
}
type AnnotationType implements Node {
"""The ID of the object"""
id: ID!
userLock: UserType
backendLock: Boolean!
page: Int!
rawText: String
tokensJsons: JSONString
boundingBox: JSONString
json: GenericScalar
parent: AnnotationType
annotationType: AnnotationsAnnotationAnnotationTypeChoices!
annotationLabel: AnnotationLabelType
document: DocumentType
corpus: CorpusType
analysis: AnalysisType
"""If set, this annotation is private to the analysis that created it"""
createdByAnalysis: AnalysisType
"""If set, this annotation is private to the extract that created it"""
createdByExtract: ExtractType
structural: Boolean!
"""Content modalities present in this annotation: TEXT, IMAGE, etc."""
contentModalities: [String]
"""
JSON file containing extracted image data for IMAGE modality annotations
"""
imageContentFile: String
isPublic: Boolean!
creator: UserType!
created: DateTime!
modified: DateTime!
assignmentSet(offset: Int, before: String, after: String, first: Int, last: Int): AssignmentTypeConnection!
rows(offset: Int, before: String, after: String, first: Int, last: Int): DocumentAnalysisRowTypeConnection!
sourceNodeInRelationships(offset: Int, before: String, after: String, first: Int, last: Int): RelationshipTypeConnection!