Datasaur GraphQL API Reference
Datasaur GraphQL API Reference
Terms of Service
API Endpoints
# Production:
https://app.datasaur.ai/graphql
Headers
Authorization: Bearer <YOUR_TOKEN_HERE>
Queries
checkExternalObjectStorageConnection
Response
Returns a Boolean!
Arguments
Name | Description |
---|---|
input - CreateExternalObjectStorageInput!
|
Example
Query
query CheckExternalObjectStorageConnection($input: CreateExternalObjectStorageInput!) {
checkExternalObjectStorageConnection(input: $input)
}
Variables
{"input": CreateExternalObjectStorageInput}
Response
{"data": {"checkExternalObjectStorageConnection": true}}
checkForMaliciousSite
countProjectsByExternalObjectStorageId
dictionaryLookup
Response
Returns a DictionaryResult!
Example
Query
query DictionaryLookup(
$word: String!,
$lang: String
) {
dictionaryLookup(
word: $word,
lang: $lang
) {
word
lang
entries {
lexicalCategory
definitions {
...DefinitionEntryFragment
}
}
}
}
Variables
{
"word": "xyz789",
"lang": "abc123"
}
Response
{
"data": {
"dictionaryLookup": {
"word": "xyz789",
"lang": "abc123",
"entries": [DictionaryResultEntry]
}
}
}
dictionaryLookupBatch
Response
Returns [DictionaryResult!]!
Arguments
Name | Description |
---|---|
words - [String!]!
|
|
lang - String!
|
Example
Query
query DictionaryLookupBatch(
$words: [String!]!,
$lang: String!
) {
dictionaryLookupBatch(
words: $words,
lang: $lang
) {
word
lang
entries {
lexicalCategory
definitions {
...DefinitionEntryFragment
}
}
}
}
Variables
{
"words": ["xyz789"],
"lang": "abc123"
}
Response
{
"data": {
"dictionaryLookupBatch": [
{
"word": "xyz789",
"lang": "abc123",
"entries": [DictionaryResultEntry]
}
]
}
}
executeExportFileTransformer
Description
Simulates what an export file transformer will do to a document in a project, or to a project sample One of documentId or projectSampleId is required
Response
Returns an ExportFileTransformerExecuteResult!
Example
Query
query ExecuteExportFileTransformer(
$fileTransformerId: ID!,
$documentId: ID,
$projectSampleId: ID
) {
executeExportFileTransformer(
fileTransformerId: $fileTransformerId,
documentId: $documentId,
projectSampleId: $projectSampleId
)
}
Variables
{"fileTransformerId": 4, "documentId": 4, "projectSampleId": 4}
Response
{
"data": {
"executeExportFileTransformer": ExportFileTransformerExecuteResult
}
}
executeImportFileTransformer
Description
Simulates what an import file transformer will do to an input
Response
Returns an ImportFileTransformerExecuteResult!
Example
Query
query ExecuteImportFileTransformer(
$fileTransformerId: ID!,
$content: String!
) {
executeImportFileTransformer(
fileTransformerId: $fileTransformerId,
content: $content
)
}
Variables
{
"fileTransformerId": 4,
"content": "xyz789"
}
Response
{
"data": {
"executeImportFileTransformer": ImportFileTransformerExecuteResult
}
}
exportChart
Response
Returns an ExportRequestResult!
Arguments
Name | Description |
---|---|
id - ID!
|
|
input - AnalyticsDashboardQueryInput!
|
|
method - ExportChartMethod
|
Example
Query
query ExportChart(
$id: ID!,
$input: AnalyticsDashboardQueryInput!,
$method: ExportChartMethod
) {
exportChart(
id: $id,
input: $input,
method: $method
) {
exportId
fileUrl
fileUrlExpiredAt
queued
redirect
}
}
Variables
{
"id": 4,
"input": AnalyticsDashboardQueryInput,
"method": "EMAIL"
}
Response
{
"data": {
"exportChart": {
"exportId": "4",
"fileUrl": "abc123",
"fileUrlExpiredAt": "abc123",
"queued": false,
"redirect": "xyz789"
}
}
}
exportCustomReport
Description
Exports custom report.
Response
Returns an ExportRequestResult!
Arguments
Name | Description |
---|---|
teamId - String!
|
|
input - CustomReportBuilderInput!
|
Example
Query
query ExportCustomReport(
$teamId: String!,
$input: CustomReportBuilderInput!
) {
exportCustomReport(
teamId: $teamId,
input: $input
) {
exportId
fileUrl
fileUrlExpiredAt
queued
redirect
}
}
Variables
{
"teamId": "xyz789",
"input": CustomReportBuilderInput
}
Response
{
"data": {
"exportCustomReport": {
"exportId": "4",
"fileUrl": "xyz789",
"fileUrlExpiredAt": "abc123",
"queued": false,
"redirect": "xyz789"
}
}
}
exportLabelAccuracyChart
Response
Returns an ExportRequestResult!
Arguments
Name | Description |
---|---|
id - ID!
|
|
input - AnalyticsDashboardQueryInput!
|
|
method - ExportChartMethod
|
Example
Query
query ExportLabelAccuracyChart(
$id: ID!,
$input: AnalyticsDashboardQueryInput!,
$method: ExportChartMethod
) {
exportLabelAccuracyChart(
id: $id,
input: $input,
method: $method
) {
exportId
fileUrl
fileUrlExpiredAt
queued
redirect
}
}
Variables
{
"id": 4,
"input": AnalyticsDashboardQueryInput,
"method": "EMAIL"
}
Response
{
"data": {
"exportLabelAccuracyChart": {
"exportId": "4",
"fileUrl": "abc123",
"fileUrlExpiredAt": "abc123",
"queued": true,
"redirect": "xyz789"
}
}
}
exportTeamIAA
Description
Exports team IAA.
Response
Returns an ExportRequestResult!
Example
Query
query ExportTeamIAA(
$teamId: ID!,
$labelSetSignatures: [String!],
$projectIds: [ID!]
) {
exportTeamIAA(
teamId: $teamId,
labelSetSignatures: $labelSetSignatures,
projectIds: $projectIds
) {
exportId
fileUrl
fileUrlExpiredAt
queued
redirect
}
}
Variables
{
"teamId": 4,
"labelSetSignatures": ["abc123"],
"projectIds": ["4"]
}
Response
{
"data": {
"exportTeamIAA": {
"exportId": "4",
"fileUrl": "abc123",
"fileUrlExpiredAt": "abc123",
"queued": true,
"redirect": "xyz789"
}
}
}
exportTeamOverview
Description
Exports team overview.
Response
Returns an ExportRequestResult!
Arguments
Name | Description |
---|---|
input - ExportTeamOverviewInput!
|
Example
Query
query ExportTeamOverview($input: ExportTeamOverviewInput!) {
exportTeamOverview(input: $input) {
exportId
fileUrl
fileUrlExpiredAt
queued
redirect
}
}
Variables
{"input": ExportTeamOverviewInput}
Response
{
"data": {
"exportTeamOverview": {
"exportId": 4,
"fileUrl": "xyz789",
"fileUrlExpiredAt": "abc123",
"queued": true,
"redirect": "abc123"
}
}
}
exportTestProjectResult
Description
Exports test project result.
Response
Returns an ExportRequestResult!
Arguments
Name | Description |
---|---|
input - ExportTestProjectResultInput!
|
Example
Query
query ExportTestProjectResult($input: ExportTestProjectResultInput!) {
exportTestProjectResult(input: $input) {
exportId
fileUrl
fileUrlExpiredAt
queued
redirect
}
}
Variables
{"input": ExportTestProjectResultInput}
Response
{
"data": {
"exportTestProjectResult": {
"exportId": "4",
"fileUrl": "abc123",
"fileUrlExpiredAt": "abc123",
"queued": true,
"redirect": "abc123"
}
}
}
exportTextProject
Description
Exports all files in a project.
Response
Returns an ExportRequestResult!
Arguments
Name | Description |
---|---|
input - ExportTextProjectInput!
|
Example
Query
query ExportTextProject($input: ExportTextProjectInput!) {
exportTextProject(input: $input) {
exportId
fileUrl
fileUrlExpiredAt
queued
redirect
}
}
Variables
{"input": ExportTextProjectInput}
Response
{
"data": {
"exportTextProject": {
"exportId": 4,
"fileUrl": "abc123",
"fileUrlExpiredAt": "xyz789",
"queued": true,
"redirect": "abc123"
}
}
}
exportTextProjectDocument
Description
Exports a single document / file.
Response
Returns an ExportRequestResult!
Arguments
Name | Description |
---|---|
input - ExportTextProjectDocumentInput!
|
Example
Query
query ExportTextProjectDocument($input: ExportTextProjectDocumentInput!) {
exportTextProjectDocument(input: $input) {
exportId
fileUrl
fileUrlExpiredAt
queued
redirect
}
}
Variables
{"input": ExportTextProjectDocumentInput}
Response
{
"data": {
"exportTextProjectDocument": {
"exportId": "4",
"fileUrl": "xyz789",
"fileUrlExpiredAt": "abc123",
"queued": true,
"redirect": "xyz789"
}
}
}
generateFileUrls
Response
Returns [FileUrlInfo!]!
Arguments
Name | Description |
---|---|
input - GenerateFileUrlsInput!
|
Example
Query
query GenerateFileUrls($input: GenerateFileUrlsInput!) {
generateFileUrls(input: $input) {
uploadUrl
downloadUrl
fileName
}
}
Variables
{"input": GenerateFileUrlsInput}
Response
{
"data": {
"generateFileUrls": [
{
"uploadUrl": "abc123",
"downloadUrl": "xyz789",
"fileName": "abc123"
}
]
}
}
getAllTeams
Response
Returns [Team!]!
Example
Query
query GetAllTeams {
getAllTeams {
id
logoURL
members {
id
user {
...UserFragment
}
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
}
membersScalar
name
setting {
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enableActions
enableAssistedLabeling
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurPredictiveRowBased
enableWipeData
enableExportTeamOverview
allowedExtraAutoLabelProviders
enableLLMProject
}
owner {
id
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
}
isExpired
expiredAt
}
}
Response
{
"data": {
"getAllTeams": [
{
"id": "4",
"logoURL": "xyz789",
"members": [TeamMember],
"membersScalar": TeamMembersScalar,
"name": "abc123",
"setting": TeamSetting,
"owner": User,
"isExpired": true,
"expiredAt": "2007-12-03T10:15:30Z"
}
]
}
}
getAllowedIPs
Response
Returns [String!]!
Example
Query
query GetAllowedIPs {
getAllowedIPs
}
Response
{"data": {"getAllowedIPs": ["abc123"]}}
getAnalyticsLastUpdatedAt
Response
Returns a String!
Example
Query
query GetAnalyticsLastUpdatedAt {
getAnalyticsLastUpdatedAt
}
Response
{
"data": {
"getAnalyticsLastUpdatedAt": "xyz789"
}
}
getAutoLabel
Response
Returns [AutoLabelTokenBasedOutput!]!
Arguments
Name | Description |
---|---|
input - AutoLabelTokenBasedInput
|
Example
Query
query GetAutoLabel($input: AutoLabelTokenBasedInput) {
getAutoLabel(input: $input) {
label
deleted
layer
start {
sentenceId
tokenId
charId
}
end {
sentenceId
tokenId
charId
}
confidenceScore
}
}
Variables
{"input": AutoLabelTokenBasedInput}
Response
{
"data": {
"getAutoLabel": [
{
"label": "xyz789",
"deleted": true,
"layer": 987,
"start": TextCursor,
"end": TextCursor,
"confidenceScore": 987.65
}
]
}
}
getAutoLabelModels
Response
Returns [AutoLabelModel!]!
Arguments
Name | Description |
---|---|
input - AutoLabelModelsInput!
|
Example
Query
query GetAutoLabelModels($input: AutoLabelModelsInput!) {
getAutoLabelModels(input: $input) {
name
provider
privacy
}
}
Variables
{"input": AutoLabelModelsInput}
Response
{
"data": {
"getAutoLabelModels": [
{
"name": "xyz789",
"provider": "ASSISTED_LABELING",
"privacy": "PUBLIC"
}
]
}
}
getAutoLabelRowBased
Response
Returns [AutoLabelRowBasedOutput!]!
Arguments
Name | Description |
---|---|
input - AutoLabelRowBasedInput
|
Example
Query
query GetAutoLabelRowBased($input: AutoLabelRowBasedInput) {
getAutoLabelRowBased(input: $input) {
id
label
}
}
Variables
{"input": AutoLabelRowBasedInput}
Response
{
"data": {
"getAutoLabelRowBased": [
{"id": 987, "label": "xyz789"}
]
}
}
getBBoxLabelSetsByProject
Response
Returns [BBoxLabelSet!]!
Arguments
Name | Description |
---|---|
projectId - ID!
|
Example
Query
query GetBBoxLabelSetsByProject($projectId: ID!) {
getBBoxLabelSetsByProject(projectId: $projectId) {
id
name
classes {
id
name
color
captionAllowed
captionRequired
}
autoLabelProvider
}
}
Variables
{"projectId": 4}
Response
{
"data": {
"getBBoxLabelSetsByProject": [
{
"id": 4,
"name": "abc123",
"classes": [BBoxLabelClass],
"autoLabelProvider": "TESSERACT"
}
]
}
}
getBBoxLabelsByDocument
Response
Returns [BBoxLabel!]!
Arguments
Name | Description |
---|---|
documentId - ID!
|
Example
Query
query GetBBoxLabelsByDocument($documentId: ID!) {
getBBoxLabelsByDocument(documentId: $documentId) {
id
documentId
bboxLabelClassId
deleted
caption
shapes {
pageIndex
points {
...BBoxPointFragment
}
}
}
}
Variables
{"documentId": "4"}
Response
{
"data": {
"getBBoxLabelsByDocument": [
{
"id": 4,
"documentId": "4",
"bboxLabelClassId": 4,
"deleted": false,
"caption": "xyz789",
"shapes": [BBoxShape]
}
]
}
}
getBoundingBoxConflictList
Response
Returns a GetBoundingBoxConflictListResult!
Arguments
Name | Description |
---|---|
documentId - ID!
|
Example
Query
query GetBoundingBoxConflictList($documentId: ID!) {
getBoundingBoxConflictList(documentId: $documentId) {
upToDate
items {
id
documentId
coordinates {
...CoordinateFragment
}
pageIndex
layer
position {
...TextRangeFragment
}
resolved
hashCode
labelerIds
text
}
}
}
Variables
{"documentId": 4}
Response
{
"data": {
"getBoundingBoxConflictList": {
"upToDate": true,
"items": [ConflictBoundingBoxLabel]
}
}
}
getBoundingBoxLabels
Response
Returns [BoundingBoxLabel!]!
Example
Query
query GetBoundingBoxLabels(
$documentId: ID!,
$startCellLine: Int,
$endCellLine: Int
) {
getBoundingBoxLabels(
documentId: $documentId,
startCellLine: $startCellLine,
endCellLine: $endCellLine
) {
id
documentId
coordinates {
x
y
}
counter
pageIndex
layer
position {
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
}
hashCode
type
labeledBy
}
}
Variables
{
"documentId": "4",
"startCellLine": 123,
"endCellLine": 123
}
Response
{
"data": {
"getBoundingBoxLabels": [
{
"id": "4",
"documentId": "4",
"coordinates": [Coordinate],
"counter": 987,
"pageIndex": 123,
"layer": 987,
"position": TextRange,
"hashCode": "abc123",
"type": "ARROW",
"labeledBy": "PRELABELED"
}
]
}
}
getBoundingBoxPages
Response
Returns [BoundingBoxPage!]!
Arguments
Name | Description |
---|---|
documentId - ID!
|
Example
Query
query GetBoundingBoxPages($documentId: ID!) {
getBoundingBoxPages(documentId: $documentId) {
pageIndex
pageHeight
pageWidth
}
}
Variables
{"documentId": "4"}
Response
{
"data": {
"getBoundingBoxPages": [
{"pageIndex": 123, "pageHeight": 987, "pageWidth": 987}
]
}
}
getCabinet
Description
Returns the specified project's cabinet. Contains list of documents. To get a project's ID, see getProjects
.
Example
Query
query GetCabinet(
$projectId: ID!,
$role: Role!
) {
getCabinet(
projectId: $projectId,
role: $role
) {
id
documents
role
status
lastOpenedDocumentId
statistic {
id
numberOfTokens
numberOfLines
}
owner {
id
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
}
createdAt
}
}
Variables
{"projectId": "4", "role": "REVIEWER"}
Response
{
"data": {
"getCabinet": {
"id": 4,
"documents": [TextDocumentScalar],
"role": "REVIEWER",
"status": "IN_PROGRESS",
"lastOpenedDocumentId": 4,
"statistic": CabinetStatistic,
"owner": User,
"createdAt": "2007-12-03T10:15:30Z"
}
}
}
getCabinetEditSentenceConflicts
Response
Returns [EditSentenceConflict!]!
Arguments
Name | Description |
---|---|
cabinetId - ID!
|
Example
Query
query GetCabinetEditSentenceConflicts($cabinetId: ID!) {
getCabinetEditSentenceConflicts(cabinetId: $cabinetId) {
documentId
fileName
lines
}
}
Variables
{"cabinetId": "4"}
Response
{
"data": {
"getCabinetEditSentenceConflicts": [
{
"documentId": "abc123",
"fileName": "abc123",
"lines": [987]
}
]
}
}
getCabinetLabelSetsById
Response
Returns [LabelSet!]!
Arguments
Name | Description |
---|---|
cabinetId - ID!
|
Example
Query
query GetCabinetLabelSetsById($cabinetId: ID!) {
getCabinetLabelSetsById(cabinetId: $cabinetId) {
id
name
index
signature
tagItems {
id
parentId
tagName
desc
color
type
arrowRules {
...LabelClassArrowRuleFragment
}
}
lastUsedBy {
projectId
name
}
arrowLabelRequired
}
}
Variables
{"cabinetId": 4}
Response
{
"data": {
"getCabinetLabelSetsById": [
{
"id": "4",
"name": "abc123",
"index": 123,
"signature": "xyz789",
"tagItems": [TagItem],
"lastUsedBy": LastUsedProject,
"arrowLabelRequired": true
}
]
}
}
getCellPositionsByMetadata
Description
Returns a paginated list of Cell positions along with its origin document ID.
Response
Arguments
Name | Description |
---|---|
projectId - ID!
|
|
input - GetCellPositionsByMetadataPaginatedInput!
|
Example
Query
query GetCellPositionsByMetadata(
$projectId: ID!,
$input: GetCellPositionsByMetadataPaginatedInput!
) {
getCellPositionsByMetadata(
projectId: $projectId,
input: $input
) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
originDocumentId
line
index
}
}
}
Variables
{
"projectId": "4",
"input": GetCellPositionsByMetadataPaginatedInput
}
Response
{
"data": {
"getCellPositionsByMetadata": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [CellPositionWithOriginDocumentId]
}
}
}
getCells
Response
Returns a GetCellsPaginatedResponse!
Arguments
Name | Description |
---|---|
documentId - ID!
|
|
input - GetCellsPaginatedInput!
|
|
signature - String
|
Example
Query
query GetCells(
$documentId: ID!,
$input: GetCellsPaginatedInput!,
$signature: String
) {
getCells(
documentId: $documentId,
input: $input,
signature: $signature
) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes
}
}
Variables
{
"documentId": 4,
"input": GetCellsPaginatedInput,
"signature": "abc123"
}
Response
{
"data": {
"getCells": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [CellScalar]
}
}
}
getChartData
Response
Returns [ChartDataRow!]!
Arguments
Name | Description |
---|---|
id - ID!
|
|
input - AnalyticsDashboardQueryInput!
|
Example
Query
query GetChartData(
$id: ID!,
$input: AnalyticsDashboardQueryInput!
) {
getChartData(
id: $id,
input: $input
) {
key
values {
key
value
}
keyPayloadType
keyPayload
}
}
Variables
{
"id": "4",
"input": AnalyticsDashboardQueryInput
}
Response
{
"data": {
"getChartData": [
{
"key": "xyz789",
"values": [ChartDataRowValue],
"keyPayloadType": "USER",
"keyPayload": KeyPayload
}
]
}
}
getCharts
Response
Returns [Chart!]!
Arguments
Name | Description |
---|---|
teamId - ID!
|
|
level - ChartLevel!
|
|
set - ChartSet!
|
Example
Query
query GetCharts(
$teamId: ID!,
$level: ChartLevel!,
$set: ChartSet!
) {
getCharts(
teamId: $teamId,
level: $level,
set: $set
) {
id
name
description
type
level
set
dataTableHeaders
visualizationParams {
visualization
vAxisTitle
hAxisTitle
pieHoleText
chartArea {
...ChartAreaFragment
}
legend {
...LegendFragment
}
colorGradient {
...ColorGradientFragment
}
isStacked
itemsPerPage
colors
abbreviateKey
showTable
unit
}
}
}
Variables
{
"teamId": "4",
"level": "TEAM",
"set": "OLD"
}
Response
{
"data": {
"getCharts": [
{
"id": 4,
"name": "xyz789",
"description": "abc123",
"type": "GROUPED",
"level": "TEAM",
"set": "OLD",
"dataTableHeaders": ["xyz789"],
"visualizationParams": VisualizationParams
}
]
}
}
getComments
Response
Returns a GetCommentsResponse!
Arguments
Name | Description |
---|---|
input - GetCommentsInput!
|
Example
Query
query GetComments($input: GetCommentsInput!) {
getComments(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
parentId
documentId
originDocumentId
userId
user {
...UserFragment
}
message
resolved
resolvedAt
resolvedBy {
...UserFragment
}
repliesCount
createdAt
updatedAt
hashCode
commentedContent {
...CommentedContentFragment
}
}
}
}
Variables
{"input": GetCommentsInput}
Response
{
"data": {
"getComments": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [Comment]
}
}
}
getCreateProjectAction
Description
Get details of a create project Action. Parameters: automationId
: ID of the Action
Response
Returns a CreateProjectAction!
Example
Query
query GetCreateProjectAction(
$teamId: ID!,
$actionId: ID!
) {
getCreateProjectAction(
teamId: $teamId,
actionId: $actionId
) {
id
name
teamId
appVersion
creatorId
lastRunAt
lastFinishedAt
externalObjectStorageId
externalObjectStorage {
id
cloudService
bucketName
credentials {
...ExternalObjectStorageCredentialsFragment
}
team {
...TeamFragment
}
projects {
...ProjectFragment
}
createdAt
updatedAt
}
externalObjectStoragePathInput
externalObjectStoragePathResult
projectTemplateId
projectTemplate {
id
name
teamId
team {
...TeamFragment
}
logoURL
projectTemplateProjectSettingId
projectTemplateTextDocumentSettingId
projectTemplateProjectSetting {
...ProjectTemplateProjectSettingFragment
}
projectTemplateTextDocumentSetting {
...ProjectTemplateTextDocumentSettingFragment
}
labelSetTemplates {
...LabelSetTemplateFragment
}
questionSets {
...QuestionSetFragment
}
createdAt
updatedAt
purpose
creatorId
}
assignments {
id
actionId
role
teamMember {
...TeamMemberFragment
}
teamMemberId
totalAssignedAsLabeler
totalAssignedAsReviewer
}
additionalTagNames
numberOfLabelersPerProject
numberOfReviewersPerProject
numberOfLabelersPerDocument
conflictResolutionMode
consensus
warnings
}
}
Variables
{
"teamId": "4",
"actionId": "4"
}
Response
{
"data": {
"getCreateProjectAction": {
"id": 4,
"name": "abc123",
"teamId": 4,
"appVersion": "abc123",
"creatorId": "4",
"lastRunAt": "abc123",
"lastFinishedAt": "xyz789",
"externalObjectStorageId": "4",
"externalObjectStorage": ExternalObjectStorage,
"externalObjectStoragePathInput": "xyz789",
"externalObjectStoragePathResult": "xyz789",
"projectTemplateId": "4",
"projectTemplate": ProjectTemplate,
"assignments": [CreateProjectActionAssignment],
"additionalTagNames": ["xyz789"],
"numberOfLabelersPerProject": 123,
"numberOfReviewersPerProject": 987,
"numberOfLabelersPerDocument": 987,
"conflictResolutionMode": "MANUAL",
"consensus": 123,
"warnings": ["ASSIGNED_LABELER_NOT_MEET_CONSENSUS"]
}
}
}
getCreateProjectActionRunDetails
Description
Get all details of a create project Action run. Parameters: input
: ProjectCreationAutomationActivityDetailPaginationInput
Response
Arguments
Name | Description |
---|---|
input - CreateProjectActionRunDetailPaginationInput!
|
Example
Query
query GetCreateProjectActionRunDetails($input: CreateProjectActionRunDetailPaginationInput!) {
getCreateProjectActionRunDetails(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
status
runId
startAt
endAt
error {
...DatasaurErrorFragment
}
project
projectPath
documentNames
}
}
}
Variables
{"input": CreateProjectActionRunDetailPaginationInput}
Response
{
"data": {
"getCreateProjectActionRunDetails": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [CreateProjectActionRunDetail]
}
}
}
getCreateProjectActionRuns
Description
Get all activities of a create project Action. Parameters: input
: ProjectCreationAutomationPaginationInput
Response
Returns a CreateProjectActionRunPaginatedResponse!
Arguments
Name | Description |
---|---|
input - CreateProjectActionPaginationInput!
|
Example
Query
query GetCreateProjectActionRuns($input: CreateProjectActionPaginationInput!) {
getCreateProjectActionRuns(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
actionId
status
currentAppVersion
triggeredByUserId
triggeredBy {
...UserFragment
}
startAt
endAt
totalSuccess
totalFailure
externalObjectStorageId
externalObjectStoragePathInput
externalObjectStoragePathResult
projectTemplate
assignments
numberOfLabelersPerProject
numberOfReviewersPerProject
numberOfLabelersPerDocument
conflictResolutionMode
consensus
}
}
}
Variables
{"input": CreateProjectActionPaginationInput}
Response
{
"data": {
"getCreateProjectActionRuns": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [CreateProjectActionRun]
}
}
}
getCreateProjectActions
Description
Get all create project automations of a team. Parameters: teamId
: ID of the team
Response
Returns [CreateProjectAction!]!
Arguments
Name | Description |
---|---|
teamId - ID!
|
Example
Query
query GetCreateProjectActions($teamId: ID!) {
getCreateProjectActions(teamId: $teamId) {
id
name
teamId
appVersion
creatorId
lastRunAt
lastFinishedAt
externalObjectStorageId
externalObjectStorage {
id
cloudService
bucketName
credentials {
...ExternalObjectStorageCredentialsFragment
}
team {
...TeamFragment
}
projects {
...ProjectFragment
}
createdAt
updatedAt
}
externalObjectStoragePathInput
externalObjectStoragePathResult
projectTemplateId
projectTemplate {
id
name
teamId
team {
...TeamFragment
}
logoURL
projectTemplateProjectSettingId
projectTemplateTextDocumentSettingId
projectTemplateProjectSetting {
...ProjectTemplateProjectSettingFragment
}
projectTemplateTextDocumentSetting {
...ProjectTemplateTextDocumentSettingFragment
}
labelSetTemplates {
...LabelSetTemplateFragment
}
questionSets {
...QuestionSetFragment
}
createdAt
updatedAt
purpose
creatorId
}
assignments {
id
actionId
role
teamMember {
...TeamMemberFragment
}
teamMemberId
totalAssignedAsLabeler
totalAssignedAsReviewer
}
additionalTagNames
numberOfLabelersPerProject
numberOfReviewersPerProject
numberOfLabelersPerDocument
conflictResolutionMode
consensus
warnings
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getCreateProjectActions": [
{
"id": 4,
"name": "abc123",
"teamId": 4,
"appVersion": "xyz789",
"creatorId": "4",
"lastRunAt": "abc123",
"lastFinishedAt": "abc123",
"externalObjectStorageId": "4",
"externalObjectStorage": ExternalObjectStorage,
"externalObjectStoragePathInput": "abc123",
"externalObjectStoragePathResult": "abc123",
"projectTemplateId": 4,
"projectTemplate": ProjectTemplate,
"assignments": [CreateProjectActionAssignment],
"additionalTagNames": ["abc123"],
"numberOfLabelersPerProject": 987,
"numberOfReviewersPerProject": 987,
"numberOfLabelersPerDocument": 987,
"conflictResolutionMode": "MANUAL",
"consensus": 987,
"warnings": ["ASSIGNED_LABELER_NOT_MEET_CONSENSUS"]
}
]
}
}
getCurrentUserTeamMember
Response
Returns a TeamMember!
Arguments
Name | Description |
---|---|
input - GetCurrentUserTeamMemberInput!
|
Example
Query
query GetCurrentUserTeamMember($input: GetCurrentUserTeamMemberInput!) {
getCurrentUserTeamMember(input: $input) {
id
user {
id
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
}
role {
id
name
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
id
userId
projectStatistic {
...TeamMemberProjectStatisticFragment
}
totalTimeSpent
effectiveTotalTimeSpent
accuracy
}
}
}
Variables
{"input": GetCurrentUserTeamMemberInput}
Response
{
"data": {
"getCurrentUserTeamMember": {
"id": "4",
"user": User,
"role": TeamRole,
"invitationEmail": "abc123",
"invitationStatus": "abc123",
"invitationKey": "abc123",
"isDeleted": true,
"joinedDate": "xyz789",
"performance": TeamMemberPerformance
}
}
}
getCustomAPI
Response
Returns a CustomAPI!
Arguments
Name | Description |
---|---|
customAPIId - ID!
|
Example
Query
query GetCustomAPI($customAPIId: ID!) {
getCustomAPI(customAPIId: $customAPIId) {
id
teamId
endpointURL
name
purpose
}
}
Variables
{"customAPIId": 4}
Response
{
"data": {
"getCustomAPI": {
"id": "4",
"teamId": "4",
"endpointURL": "abc123",
"name": "abc123",
"purpose": "ASR_API"
}
}
}
getCustomAPIs
Response
Returns [CustomAPI!]!
Arguments
Name | Description |
---|---|
teamId - ID!
|
|
purpose - CustomAPIPurpose
|
Example
Query
query GetCustomAPIs(
$teamId: ID!,
$purpose: CustomAPIPurpose
) {
getCustomAPIs(
teamId: $teamId,
purpose: $purpose
) {
id
teamId
endpointURL
name
purpose
}
}
Variables
{"teamId": 4, "purpose": "ASR_API"}
Response
{
"data": {
"getCustomAPIs": [
{
"id": "4",
"teamId": 4,
"endpointURL": "xyz789",
"name": "xyz789",
"purpose": "ASR_API"
}
]
}
}
getCustomReportMetricsGroupTables
Description
Returns custom report metrics group tables.
Response
Example
Query
query GetCustomReportMetricsGroupTables {
getCustomReportMetricsGroupTables {
id
name
description
clientSegments
metrics
filterStrategies
}
}
Response
{
"data": {
"getCustomReportMetricsGroupTables": [
{
"id": 4,
"name": "abc123",
"description": "abc123",
"clientSegments": ["DATE"],
"metrics": ["LABELS_ACCURACY"],
"filterStrategies": ["CONTAINS"]
}
]
}
}
getDataProgramming
Response
Returns a DataProgramming
Arguments
Name | Description |
---|---|
input - GetDataProgrammingInput
|
Example
Query
query GetDataProgramming($input: GetDataProgrammingInput) {
getDataProgramming(input: $input) {
id
provider
projectId
kind
labelsSignature
labels {
labelId
labelName
}
createdAt
updatedAt
lastGetPredictionsAt
}
}
Variables
{"input": GetDataProgrammingInput}
Response
{
"data": {
"getDataProgramming": {
"id": 4,
"provider": "SNORKEL",
"projectId": "4",
"kind": "DOCUMENT_BASED",
"labelsSignature": "abc123",
"labels": [DataProgrammingLabel],
"createdAt": "xyz789",
"updatedAt": "xyz789",
"lastGetPredictionsAt": "xyz789"
}
}
}
getDataProgrammingLabelingFunctionAnalysis
Response
Arguments
Name | Description |
---|---|
input - GetDataProgrammingLabelingFunctionAnalysisInput!
|
Example
Query
query GetDataProgrammingLabelingFunctionAnalysis($input: GetDataProgrammingLabelingFunctionAnalysisInput!) {
getDataProgrammingLabelingFunctionAnalysis(input: $input) {
dataProgrammingId
labelingFunctionId
conflict
coverage
overlap
polarity
}
}
Variables
{"input": GetDataProgrammingLabelingFunctionAnalysisInput}
Response
{
"data": {
"getDataProgrammingLabelingFunctionAnalysis": [
{
"dataProgrammingId": "4",
"labelingFunctionId": 4,
"conflict": 987.65,
"coverage": 987.65,
"overlap": 987.65,
"polarity": [123]
}
]
}
}
getDataProgrammingLibraries
Response
Returns a DataProgrammingLibraries!
Example
Query
query GetDataProgrammingLibraries {
getDataProgrammingLibraries {
libraries
}
}
Response
{
"data": {
"getDataProgrammingLibraries": {
"libraries": ["xyz789"]
}
}
}
getDataProgrammingPredictions
Response
Returns a Job!
Arguments
Name | Description |
---|---|
input - GetDataProgrammingPredictionsInput!
|
Example
Query
query GetDataProgrammingPredictions($input: GetDataProgrammingPredictionsInput!) {
getDataProgrammingPredictions(input: $input) {
id
status
progress
errors {
id
stack
args
}
resultId
result
createdAt
updatedAt
additionalData {
actionRunId
childrenJobIds
}
}
}
Variables
{"input": GetDataProgrammingPredictionsInput}
Response
{
"data": {
"getDataProgrammingPredictions": {
"id": "xyz789",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "abc123",
"additionalData": JobAdditionalData
}
}
}
getDatasaurDinamic
Response
Returns a DatasaurDinamic
Arguments
Name | Description |
---|---|
input - GetDatasaurDinamicInput!
|
Example
Query
query GetDatasaurDinamic($input: GetDatasaurDinamicInput!) {
getDatasaurDinamic(input: $input) {
id
projectId
kind
provider
inputColumns
questionColumn
providerSetting
modelMetadata
trainingJobId
createdAt
updatedAt
}
}
Variables
{"input": GetDatasaurDinamicInput}
Response
{
"data": {
"getDatasaurDinamic": {
"id": 4,
"projectId": 4,
"kind": "DOCUMENT_BASED",
"provider": "HUGGINGFACE",
"inputColumns": [987],
"questionColumn": 987,
"providerSetting": ProviderSetting,
"modelMetadata": ModelMetadata,
"trainingJobId": 4,
"createdAt": "abc123",
"updatedAt": "xyz789"
}
}
}
getDatasaurDinamicProviders
Response
Returns [DatasaurDinamicProviders!]!
Example
Query
query GetDatasaurDinamicProviders {
getDatasaurDinamicProviders {
name
provider
}
}
Response
{
"data": {
"getDatasaurDinamicProviders": [
{
"name": "xyz789",
"provider": "HUGGINGFACE"
}
]
}
}
getDatasaurPredictive
Response
Returns a DatasaurPredictive
Arguments
Name | Description |
---|---|
input - GetDatasaurPredictiveInput!
|
Example
Query
query GetDatasaurPredictive($input: GetDatasaurPredictiveInput!) {
getDatasaurPredictive(input: $input) {
id
projectId
kind
provider
inputColumns
questionColumn
providerSetting
modelMetadata
trainingJobId
createdAt
updatedAt
}
}
Variables
{"input": GetDatasaurPredictiveInput}
Response
{
"data": {
"getDatasaurPredictive": {
"id": 4,
"projectId": "4",
"kind": "DOCUMENT_BASED",
"provider": "SETFIT",
"inputColumns": [987],
"questionColumn": 987,
"providerSetting": ProviderSetting,
"modelMetadata": ModelMetadata,
"trainingJobId": 4,
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
getDatasaurPredictiveProviders
Response
Returns [DatasaurPredictiveProviders!]!
Example
Query
query GetDatasaurPredictiveProviders {
getDatasaurPredictiveProviders {
name
provider
}
}
Response
{
"data": {
"getDatasaurPredictiveProviders": [
{
"name": "xyz789",
"provider": "SETFIT"
}
]
}
}
getDataset
Example
Query
query GetDataset($id: ID!) {
getDataset(id: $id) {
id
teamId
mlModelSettingId
kind
labelCount
cabinetIds {
cabinetId
documentIds
}
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"getDataset": {
"id": "4",
"teamId": 4,
"mlModelSettingId": "4",
"kind": "DOCUMENT_BASED",
"labelCount": 123,
"cabinetIds": [CabinetDocumentIds],
"createdAt": "abc123",
"updatedAt": "xyz789"
}
}
}
getDatasets
Response
Returns a DatasetPaginatedResponse!
Arguments
Name | Description |
---|---|
input - GetDatasetsPaginatedInput!
|
Example
Query
query GetDatasets($input: GetDatasetsPaginatedInput!) {
getDatasets(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
teamId
mlModelSettingId
kind
labelCount
cabinetIds {
...CabinetDocumentIdsFragment
}
createdAt
updatedAt
}
}
}
Variables
{"input": GetDatasetsPaginatedInput}
Response
{
"data": {
"getDatasets": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [Dataset]
}
}
}
getDocumentAnswerConflicts
Response
Returns [ConflictAnswer!]!
Arguments
Name | Description |
---|---|
documentId - ID!
|
Example
Query
query GetDocumentAnswerConflicts($documentId: ID!) {
getDocumentAnswerConflicts(documentId: $documentId) {
questionId
parentQuestionId
nestedAnswerIndex
answers {
resolved
value
userIds
users {
...UserFragment
}
}
type
}
}
Variables
{"documentId": 4}
Response
{
"data": {
"getDocumentAnswerConflicts": [
{
"questionId": "4",
"parentQuestionId": "4",
"nestedAnswerIndex": 987,
"answers": [ConflictAnswerValue],
"type": "MULTIPLE"
}
]
}
}
getDocumentAnswers
Response
Returns a DocumentAnswer!
Arguments
Name | Description |
---|---|
documentId - ID!
|
Example
Query
query GetDocumentAnswers($documentId: ID!) {
getDocumentAnswers(documentId: $documentId) {
documentId
answers
updatedAt
}
}
Variables
{"documentId": "4"}
Response
{
"data": {
"getDocumentAnswers": {
"documentId": "4",
"answers": AnswerScalar,
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
getDocumentMetasByCabinetId
Response
Returns [DocumentMeta!]!
Arguments
Name | Description |
---|---|
cabinetId - ID!
|
Example
Query
query GetDocumentMetasByCabinetId($cabinetId: ID!) {
getDocumentMetasByCabinetId(cabinetId: $cabinetId) {
id
cabinetId
name
width
displayed
labelerRestricted
rowQuestionIndex
}
}
Variables
{"cabinetId": "4"}
Response
{
"data": {
"getDocumentMetasByCabinetId": [
{
"id": 987,
"cabinetId": 987,
"name": "abc123",
"width": "xyz789",
"displayed": true,
"labelerRestricted": false,
"rowQuestionIndex": 123
}
]
}
}
getDocumentQuestions
Response
Returns [Question!]!
Arguments
Name | Description |
---|---|
projectId - ID!
|
Example
Query
query GetDocumentQuestions($projectId: ID!) {
getDocumentQuestions(projectId: $projectId) {
id
internalId
type
name
label
required
config {
defaultValue
format
multiple
multiline
options {
...QuestionConfigOptionsFragment
}
leafOptionsOnly
questions {
...QuestionFragment
}
minLength
maxLength
pattern
theme
gradientColors
min
max
step
hint
hideScaleLabel
}
bindToColumn
activationConditionLogic
}
}
Variables
{"projectId": 4}
Response
{
"data": {
"getDocumentQuestions": [
{
"id": 123,
"internalId": "abc123",
"type": "DROPDOWN",
"name": "abc123",
"label": "xyz789",
"required": true,
"config": QuestionConfig,
"bindToColumn": "abc123",
"activationConditionLogic": "abc123"
}
]
}
}
getEditSentenceConflicts
Response
Returns an EditSentenceConflict!
Arguments
Name | Description |
---|---|
documentId - ID!
|
Example
Query
query GetEditSentenceConflicts($documentId: ID!) {
getEditSentenceConflicts(documentId: $documentId) {
documentId
fileName
lines
}
}
Variables
{"documentId": "4"}
Response
{
"data": {
"getEditSentenceConflicts": {
"documentId": "abc123",
"fileName": "abc123",
"lines": [123]
}
}
}
getExportDeliveryStatus
Description
Return the export job information, specifically whether it succeed or failed, since all exports are done asynchronously.
Response
Returns a GetExportDeliveryStatusResult!
Arguments
Name | Description |
---|---|
exportId - ID!
|
Example
Query
query GetExportDeliveryStatus($exportId: ID!) {
getExportDeliveryStatus(exportId: $exportId) {
deliveryStatus
errors {
id
stack
args
}
}
}
Variables
{"exportId": 4}
Response
{
"data": {
"getExportDeliveryStatus": {
"deliveryStatus": "DELIVERED",
"errors": [JobError]
}
}
}
getExportable
Response
Returns an ExportableJSON!
Arguments
Name | Description |
---|---|
documentId - ID
|
Example
Query
query GetExportable($documentId: ID) {
getExportable(documentId: $documentId)
}
Variables
{"documentId": 4}
Response
{"data": {"getExportable": ExportableJSON}}
getExtensions
Response
Returns [Extension!]
Arguments
Name | Description |
---|---|
cabinetId - String!
|
Example
Query
query GetExtensions($cabinetId: String!) {
getExtensions(cabinetId: $cabinetId) {
id
title
url
elementType
elementKind
documentType
}
}
Variables
{"cabinetId": "xyz789"}
Response
{
"data": {
"getExtensions": [
{
"id": "xyz789",
"title": "xyz789",
"url": "xyz789",
"elementType": "abc123",
"elementKind": "xyz789",
"documentType": "xyz789"
}
]
}
}
getExternalFilesByApi
Response
Returns [ExternalFile!]!
Arguments
Name | Description |
---|---|
input - GetExternalFilesByApiInput!
|
Example
Query
query GetExternalFilesByApi($input: GetExternalFilesByApiInput!) {
getExternalFilesByApi(input: $input) {
name
url
}
}
Variables
{"input": GetExternalFilesByApiInput}
Response
{
"data": {
"getExternalFilesByApi": [
{
"name": "abc123",
"url": "abc123"
}
]
}
}
getExternalObjectMeta
Response
Returns [ObjectMeta!]!
Arguments
Name | Description |
---|---|
externalObjectStorageId - ID!
|
|
objectKeys - [String!]!
|
Example
Query
query GetExternalObjectMeta(
$externalObjectStorageId: ID!,
$objectKeys: [String!]!
) {
getExternalObjectMeta(
externalObjectStorageId: $externalObjectStorageId,
objectKeys: $objectKeys
) {
createdAt
key
sizeInBytes
}
}
Variables
{
"externalObjectStorageId": "4",
"objectKeys": ["abc123"]
}
Response
{
"data": {
"getExternalObjectMeta": [
{
"createdAt": "abc123",
"key": "abc123",
"sizeInBytes": 987
}
]
}
}
getExternalObjectStorages
Response
Returns [ExternalObjectStorage!]
Arguments
Name | Description |
---|---|
teamId - ID!
|
Example
Query
query GetExternalObjectStorages($teamId: ID!) {
getExternalObjectStorages(teamId: $teamId) {
id
cloudService
bucketName
credentials {
roleArn
externalId
serviceAccount
tenantId
storageContainerUrl
}
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
projects {
id
team {
...TeamFragment
}
teamId
rootDocumentId
assignees {
...ProjectAssignmentFragment
}
name
tags {
...TagFragment
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
...ProjectSettingsFragment
}
workspaceSettings {
...WorkspaceSettingsFragment
}
reviewingStatus {
...ReviewingStatusFragment
}
labelingStatus {
...LabelingStatusFragment
}
status
performance {
...ProjectPerformanceFragment
}
selfLabelingStatus
purpose
rootCabinet {
...CabinetFragment
}
reviewCabinet {
...CabinetFragment
}
labelerCabinets {
...CabinetFragment
}
guideline {
...GuidelineFragment
}
isArchived
}
createdAt
updatedAt
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getExternalObjectStorages": [
{
"id": 4,
"cloudService": "AWS_S3",
"bucketName": "abc123",
"credentials": ExternalObjectStorageCredentials,
"team": Team,
"projects": [Project],
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
getFileTransformer
Response
Returns a FileTransformer!
Arguments
Name | Description |
---|---|
fileTransformerId - ID!
|
Example
Query
query GetFileTransformer($fileTransformerId: ID!) {
getFileTransformer(fileTransformerId: $fileTransformerId) {
id
name
content
transpiled
createdAt
updatedAt
language
purpose
readonly
externalId
warmup
}
}
Variables
{"fileTransformerId": 4}
Response
{
"data": {
"getFileTransformer": {
"id": 4,
"name": "xyz789",
"content": "xyz789",
"transpiled": "xyz789",
"createdAt": "xyz789",
"updatedAt": "abc123",
"language": "TYPESCRIPT",
"purpose": "IMPORT",
"readonly": false,
"externalId": "xyz789",
"warmup": true
}
}
}
getFileTransformers
Response
Returns [FileTransformer!]!
Arguments
Name | Description |
---|---|
teamId - ID!
|
|
purpose - FileTransformerPurpose
|
Example
Query
query GetFileTransformers(
$teamId: ID!,
$purpose: FileTransformerPurpose
) {
getFileTransformers(
teamId: $teamId,
purpose: $purpose
) {
id
name
content
transpiled
createdAt
updatedAt
language
purpose
readonly
externalId
warmup
}
}
Variables
{"teamId": "4", "purpose": "IMPORT"}
Response
{
"data": {
"getFileTransformers": [
{
"id": "4",
"name": "xyz789",
"content": "abc123",
"transpiled": "xyz789",
"createdAt": "abc123",
"updatedAt": "abc123",
"language": "TYPESCRIPT",
"purpose": "IMPORT",
"readonly": false,
"externalId": "abc123",
"warmup": false
}
]
}
}
getGeneralWorkspaceSettings
Response
Returns a GeneralWorkspaceSettings!
Arguments
Name | Description |
---|---|
projectId - ID!
|
Example
Query
query GetGeneralWorkspaceSettings($projectId: ID!) {
getGeneralWorkspaceSettings(projectId: $projectId) {
id
editorFontType
editorFontSize
editorLineSpacing
showIndexBar
showLabels
keepLabelBoxOpenAfterRelabel
jumpToNextDocumentOnSubmit
jumpToNextSpanOnSubmit
multipleSelectLabels
}
}
Variables
{"projectId": 4}
Response
{
"data": {
"getGeneralWorkspaceSettings": {
"id": "4",
"editorFontType": "SANS_SERIF",
"editorFontSize": "MEDIUM",
"editorLineSpacing": "DENSE",
"showIndexBar": true,
"showLabels": "ALWAYS",
"keepLabelBoxOpenAfterRelabel": true,
"jumpToNextDocumentOnSubmit": true,
"jumpToNextSpanOnSubmit": true,
"multipleSelectLabels": false
}
}
}
getGrammarCheckerServiceProviders
Response
Example
Query
query GetGrammarCheckerServiceProviders {
getGrammarCheckerServiceProviders {
id
name
description
}
}
Response
{
"data": {
"getGrammarCheckerServiceProviders": [
{
"id": "4",
"name": "abc123",
"description": "xyz789"
}
]
}
}
getGrammarMistakes
Response
Returns [GrammarMistake!]!
Arguments
Name | Description |
---|---|
input - GrammarCheckerInput!
|
Example
Query
query GetGrammarMistakes($input: GrammarCheckerInput!) {
getGrammarMistakes(input: $input) {
text
message
position {
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
}
suggestions
}
}
Variables
{"input": GrammarCheckerInput}
Response
{
"data": {
"getGrammarMistakes": [
{
"text": "xyz789",
"message": "abc123",
"position": TextRange,
"suggestions": ["abc123"]
}
]
}
}
getGuidelines
Response
Returns [Guideline!]!
Arguments
Name | Description |
---|---|
teamId - ID
|
Example
Query
query GetGuidelines($teamId: ID) {
getGuidelines(teamId: $teamId) {
id
name
content
project {
id
team {
...TeamFragment
}
teamId
rootDocumentId
assignees {
...ProjectAssignmentFragment
}
name
tags {
...TagFragment
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
...ProjectSettingsFragment
}
workspaceSettings {
...WorkspaceSettingsFragment
}
reviewingStatus {
...ReviewingStatusFragment
}
labelingStatus {
...LabelingStatusFragment
}
status
performance {
...ProjectPerformanceFragment
}
selfLabelingStatus
purpose
rootCabinet {
...CabinetFragment
}
reviewCabinet {
...CabinetFragment
}
labelerCabinets {
...CabinetFragment
}
guideline {
...GuidelineFragment
}
isArchived
}
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getGuidelines": [
{
"id": 4,
"name": "abc123",
"content": "abc123",
"project": Project
}
]
}
}
getIAALastUpdatedAt
Response
Returns a String!
Example
Query
query GetIAALastUpdatedAt(
$teamId: ID!,
$labelSetSignatures: [String!],
$projectIds: [ID!]
) {
getIAALastUpdatedAt(
teamId: $teamId,
labelSetSignatures: $labelSetSignatures,
projectIds: $projectIds
)
}
Variables
{
"teamId": 4,
"labelSetSignatures": ["xyz789"],
"projectIds": ["4"]
}
Response
{"data": {"getIAALastUpdatedAt": "abc123"}}
getInvalidDocumentAnswerInfos
Response
Returns [InvalidAnswerInfo!]!
Arguments
Name | Description |
---|---|
cabinetId - ID!
|
Example
Query
query GetInvalidDocumentAnswerInfos($cabinetId: ID!) {
getInvalidDocumentAnswerInfos(cabinetId: $cabinetId) {
documentId
fileName
lines
}
}
Variables
{"cabinetId": 4}
Response
{
"data": {
"getInvalidDocumentAnswerInfos": [
{
"documentId": "4",
"fileName": "abc123",
"lines": [987]
}
]
}
}
getInvalidRowAnswerInfos
Response
Returns [InvalidAnswerInfo!]!
Arguments
Name | Description |
---|---|
cabinetId - ID!
|
Example
Query
query GetInvalidRowAnswerInfos($cabinetId: ID!) {
getInvalidRowAnswerInfos(cabinetId: $cabinetId) {
documentId
fileName
lines
}
}
Variables
{"cabinetId": "4"}
Response
{
"data": {
"getInvalidRowAnswerInfos": [
{
"documentId": 4,
"fileName": "abc123",
"lines": [123]
}
]
}
}
getJob
Description
Get a specific Job by its ID. Can be used to check the status of a ProjectLaunchJob
.
Example
Query
query GetJob($jobId: String!) {
getJob(jobId: $jobId) {
id
status
progress
errors {
id
stack
args
}
resultId
result
createdAt
updatedAt
additionalData {
actionRunId
childrenJobIds
}
}
}
Variables
{"jobId": "xyz789"}
Response
{
"data": {
"getJob": {
"id": "abc123",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "abc123",
"additionalData": JobAdditionalData
}
}
}
getJobs
Response
Returns [Job]!
Arguments
Name | Description |
---|---|
jobIds - [String!]!
|
Example
Query
query GetJobs($jobIds: [String!]!) {
getJobs(jobIds: $jobIds) {
id
status
progress
errors {
id
stack
args
}
resultId
result
createdAt
updatedAt
additionalData {
actionRunId
childrenJobIds
}
}
}
Variables
{"jobIds": ["abc123"]}
Response
{
"data": {
"getJobs": [
{
"id": "xyz789",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"additionalData": JobAdditionalData
}
]
}
}
getLabelAccuracyChart
Example
Query
query GetLabelAccuracyChart($teamId: ID!) {
getLabelAccuracyChart(teamId: $teamId) {
id
name
description
type
level
set
dataTableHeaders
visualizationParams {
visualization
vAxisTitle
hAxisTitle
pieHoleText
chartArea {
...ChartAreaFragment
}
legend {
...LegendFragment
}
colorGradient {
...ColorGradientFragment
}
isStacked
itemsPerPage
colors
abbreviateKey
showTable
unit
}
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getLabelAccuracyChart": [
{
"id": "4",
"name": "xyz789",
"description": "abc123",
"type": "GROUPED",
"level": "TEAM",
"set": "OLD",
"dataTableHeaders": ["abc123"],
"visualizationParams": VisualizationParams
}
]
}
}
getLabelAccuracyData
Response
Returns [ChartDataRow!]!
Arguments
Name | Description |
---|---|
input - AnalyticsDashboardQueryInput!
|
Example
Query
query GetLabelAccuracyData($input: AnalyticsDashboardQueryInput!) {
getLabelAccuracyData(input: $input) {
key
values {
key
value
}
keyPayloadType
keyPayload
}
}
Variables
{"input": AnalyticsDashboardQueryInput}
Response
{
"data": {
"getLabelAccuracyData": [
{
"key": "xyz789",
"values": [ChartDataRowValue],
"keyPayloadType": "USER",
"keyPayload": KeyPayload
}
]
}
}
getLabelSetTemplate
Description
Returns a single labelset template.
Response
Returns a LabelSetTemplate
Arguments
Name | Description |
---|---|
id - ID!
|
Example
Query
query GetLabelSetTemplate($id: ID!) {
getLabelSetTemplate(id: $id) {
id
name
owner {
id
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
}
type
items {
id
labelSetTemplateId
index
parentIndex
name
description
options {
...LabelSetConfigOptionsFragment
}
arrowLabelRequired
required
multipleChoice
type
minLength
maxLength
pattern
min
max
step
multiline
hint
theme
bindToColumn
format
defaultValue
createdAt
updatedAt
activationConditionLogic
}
count
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"getLabelSetTemplate": {
"id": "4",
"name": "abc123",
"owner": User,
"type": "QUESTION",
"items": [LabelSetTemplateItem],
"count": 123,
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
getLabelSetTemplates
Description
Returns a list of labelset templates.
Response
Returns a GetLabelSetTemplatesResponse!
Arguments
Name | Description |
---|---|
input - GetLabelSetTemplatesPaginatedInput!
|
Example
Query
query GetLabelSetTemplates($input: GetLabelSetTemplatesPaginatedInput!) {
getLabelSetTemplates(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
}
}
}
Variables
{"input": GetLabelSetTemplatesPaginatedInput}
Response
{
"data": {
"getLabelSetTemplates": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [LabelSetTemplate]
}
}
}
getLabelSetsByTeamId
Response
Returns [LabelSet!]!
Arguments
Name | Description |
---|---|
teamId - ID!
|
Example
Query
query GetLabelSetsByTeamId($teamId: ID!) {
getLabelSetsByTeamId(teamId: $teamId) {
id
name
index
signature
tagItems {
id
parentId
tagName
desc
color
type
arrowRules {
...LabelClassArrowRuleFragment
}
}
lastUsedBy {
projectId
name
}
arrowLabelRequired
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getLabelSetsByTeamId": [
{
"id": "4",
"name": "abc123",
"index": 123,
"signature": "xyz789",
"tagItems": [TagItem],
"lastUsedBy": LastUsedProject,
"arrowLabelRequired": false
}
]
}
}
getLabelingFunction
Response
Returns a LabelingFunction!
Arguments
Name | Description |
---|---|
input - GetLabelingFunctionInput!
|
Example
Query
query GetLabelingFunction($input: GetLabelingFunctionInput!) {
getLabelingFunction(input: $input) {
id
dataProgrammingId
heuristicArgument
annotatorArgument
name
content
active
createdAt
updatedAt
}
}
Variables
{"input": GetLabelingFunctionInput}
Response
{
"data": {
"getLabelingFunction": {
"id": "4",
"dataProgrammingId": 4,
"heuristicArgument": HeuristicArgumentScalar,
"annotatorArgument": AnnotatorArgumentScalar,
"name": "xyz789",
"content": "xyz789",
"active": false,
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
getLabelingFunctions
Response
Returns [LabelingFunction!]
Arguments
Name | Description |
---|---|
input - GetLabelingFunctionsInput!
|
Example
Query
query GetLabelingFunctions($input: GetLabelingFunctionsInput!) {
getLabelingFunctions(input: $input) {
id
dataProgrammingId
heuristicArgument
annotatorArgument
name
content
active
createdAt
updatedAt
}
}
Variables
{"input": GetLabelingFunctionsInput}
Response
{
"data": {
"getLabelingFunctions": [
{
"id": 4,
"dataProgrammingId": "4",
"heuristicArgument": HeuristicArgumentScalar,
"annotatorArgument": AnnotatorArgumentScalar,
"name": "xyz789",
"content": "xyz789",
"active": false,
"createdAt": "abc123",
"updatedAt": "abc123"
}
]
}
}
getLabelingFunctionsPairKappa
Response
Returns a GetLabelingFunctionsPairKappaOutput!
Arguments
Name | Description |
---|---|
input - GetLabelingFunctionsPairKappaInput!
|
Example
Query
query GetLabelingFunctionsPairKappa($input: GetLabelingFunctionsPairKappaInput!) {
getLabelingFunctionsPairKappa(input: $input) {
labelingFunctionPairKappas {
labelingFunctionId1
labelingFunctionId2
kappa
}
lastCalculatedAt
}
}
Variables
{"input": GetLabelingFunctionsPairKappaInput}
Response
{
"data": {
"getLabelingFunctionsPairKappa": {
"labelingFunctionPairKappas": [
LabelingFunctionPairKappa
],
"lastCalculatedAt": "xyz789"
}
}
}
getLabelsPaginated
Response
Returns a GetLabelsPaginatedResponse!
Arguments
Name | Description |
---|---|
documentId - ID!
|
|
input - GetLabelsPaginatedInput!
|
|
signature - String
|
Example
Query
query GetLabelsPaginated(
$documentId: ID!,
$input: GetLabelsPaginatedInput!,
$signature: String
) {
getLabelsPaginated(
documentId: $documentId,
input: $input,
signature: $signature
) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes
}
}
Variables
{
"documentId": "4",
"input": GetLabelsPaginatedInput,
"signature": "xyz789"
}
Response
{
"data": {
"getLabelsPaginated": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [TextLabelScalar]
}
}
}
getLatestJoinedTeam
Response
Returns a Team
Example
Query
query GetLatestJoinedTeam {
getLatestJoinedTeam {
id
logoURL
members {
id
user {
...UserFragment
}
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
}
membersScalar
name
setting {
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enableActions
enableAssistedLabeling
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurPredictiveRowBased
enableWipeData
enableExportTeamOverview
allowedExtraAutoLabelProviders
enableLLMProject
}
owner {
id
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
}
isExpired
expiredAt
}
}
Response
{
"data": {
"getLatestJoinedTeam": {
"id": 4,
"logoURL": "xyz789",
"members": [TeamMember],
"membersScalar": TeamMembersScalar,
"name": "xyz789",
"setting": TeamSetting,
"owner": User,
"isExpired": true,
"expiredAt": "2007-12-03T10:15:30Z"
}
}
}
getLlmEvaluationReport
Example
Query
query GetLlmEvaluationReport($projectId: String!) {
getLlmEvaluationReport(projectId: $projectId) {
id
status
progress
errors {
id
stack
args
}
resultId
result
createdAt
updatedAt
additionalData {
actionRunId
childrenJobIds
}
}
}
Variables
{"projectId": "xyz789"}
Response
{
"data": {
"getLlmEvaluationReport": {
"id": "abc123",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "abc123",
"additionalData": JobAdditionalData
}
}
}
getMlModel
Example
Query
query GetMlModel($id: ID!) {
getMlModel(id: $id) {
id
teamId
mlModelSettingId
kind
version
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"getMlModel": {
"id": "4",
"teamId": "4",
"mlModelSettingId": 4,
"kind": "DOCUMENT_BASED",
"version": 987,
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
getMlModels
Response
Returns a MlModelPaginatedResponse!
Arguments
Name | Description |
---|---|
input - GetMlModelsPaginatedInput!
|
Example
Query
query GetMlModels($input: GetMlModelsPaginatedInput!) {
getMlModels(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
teamId
mlModelSettingId
kind
version
createdAt
updatedAt
}
}
}
Variables
{"input": GetMlModelsPaginatedInput}
Response
{
"data": {
"getMlModels": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [MlModel]
}
}
}
getOverallProjectPerformance
Description
Get projects count based on its status.
Response
Returns an OverallProjectPerformance!
Arguments
Name | Description |
---|---|
teamId - ID!
|
Example
Query
query GetOverallProjectPerformance($teamId: ID!) {
getOverallProjectPerformance(teamId: $teamId) {
total
completed
inReview
reviewReady
inProgress
created
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getOverallProjectPerformance": {
"total": 123,
"completed": 987,
"inReview": 987,
"reviewReady": 987,
"inProgress": 123,
"created": 987
}
}
}
getPaginatedChartData
Response
Returns a PaginatedChartDataResponse!
Arguments
Name | Description |
---|---|
input - PaginatedAnalyticsDashboardQueryInput!
|
Example
Query
query GetPaginatedChartData($input: PaginatedAnalyticsDashboardQueryInput!) {
getPaginatedChartData(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
key
values {
...ChartDataRowValueFragment
}
keyPayloadType
keyPayload
}
}
}
Variables
{"input": PaginatedAnalyticsDashboardQueryInput}
Response
{
"data": {
"getPaginatedChartData": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [ChartDataRow]
}
}
}
getPaginatedQuestionSets
Response
Returns a GetPaginatedQuestionSetResponse!
Arguments
Name | Description |
---|---|
input - GetPaginatedQuestionSetInput!
|
Example
Query
query GetPaginatedQuestionSets($input: GetPaginatedQuestionSetInput!) {
getPaginatedQuestionSets(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
createdAt
updatedAt
}
}
}
Variables
{"input": GetPaginatedQuestionSetInput}
Response
{
"data": {
"getPaginatedQuestionSets": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [QuestionSet]
}
}
}
getPairKappas
Response
Returns [PairKappa!]!
Example
Query
query GetPairKappas(
$teamId: ID!,
$labelSetSignatures: [String!],
$projectIds: [ID!]
) {
getPairKappas(
teamId: $teamId,
labelSetSignatures: $labelSetSignatures,
projectIds: $projectIds
) {
userId1
userId2
kappa
}
}
Variables
{
"teamId": "4",
"labelSetSignatures": ["abc123"],
"projectIds": [4]
}
Response
{"data": {"getPairKappas": [{"userId1": 987, "userId2": 987, "kappa": 123.45}]}}
getPersonalTags
Description
Returns a list of personal tags.
Response
Returns [Tag!]!
Arguments
Name | Description |
---|---|
input - GetPersonalTagsInput
|
Example
Query
query GetPersonalTags($input: GetPersonalTagsInput) {
getPersonalTags(input: $input) {
id
name
globalTag
}
}
Variables
{"input": GetPersonalTagsInput}
Response
{
"data": {
"getPersonalTags": [
{
"id": "4",
"name": "abc123",
"globalTag": false
}
]
}
}
getPredictedLabels
Response
Returns [TextLabel!]!
Arguments
Name | Description |
---|---|
input - GetPredictedLabelsInput!
|
Example
Query
query GetPredictedLabels($input: GetPredictedLabelsInput!) {
getPredictedLabels(input: $input) {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
id
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
}
labeledByUserId
documentId
start {
sentenceId
tokenId
charId
}
end {
sentenceId
tokenId
charId
}
confidenceScore
}
}
Variables
{"input": GetPredictedLabelsInput}
Response
{
"data": {
"getPredictedLabels": [
{
"id": "abc123",
"l": "xyz789",
"layer": 123,
"deleted": false,
"hashCode": "abc123",
"labeledBy": "AUTO",
"labeledByUser": User,
"labeledByUserId": 987,
"documentId": "abc123",
"start": TextCursor,
"end": TextCursor,
"confidenceScore": 123.45
}
]
}
}
getPredictedRowAnswers
Response
Returns [RowAnswer!]!
Arguments
Name | Description |
---|---|
documentId - ID!
|
Example
Query
query GetPredictedRowAnswers($documentId: ID!) {
getPredictedRowAnswers(documentId: $documentId) {
documentId
line
answers
metadata {
path
labeledBy
}
updatedAt
}
}
Variables
{"documentId": 4}
Response
{
"data": {
"getPredictedRowAnswers": [
{
"documentId": "4",
"line": 123,
"answers": AnswerScalar,
"metadata": [AnswerMetadata],
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
getProject
Description
Returns a single project identified by its ID.
Response
Returns a Project!
Arguments
Name | Description |
---|---|
input - GetProjectInput!
|
Example
Query
query GetProject($input: GetProjectInput!) {
getProject(input: $input) {
id
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
teamId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
createdAt
updatedAt
}
name
tags {
id
name
globalTag
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
autoMarkDocumentAsComplete
consensus
conflictResolution {
...ConflictResolutionFragment
}
dynamicReviewMethod
dynamicReviewMemberId
enableEditLabelSet
enableReviewerEditSentence
enableReviewerInsertSentence
enableReviewerDeleteSentence
enableEditSentence
enableInsertSentence
enableDeleteSentence
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
shouldConfirmUnusedLabelSetItems
}
workspaceSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
kinds
sentenceSeparator
displayedRows
mediaDisplayStrategy
tokenizer
firstRowAsHeader
transcriptMethod
ocrProvider
customScriptId
fileTransformerId
customTextExtractionAPIId
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
}
reviewingStatus {
isCompleted
statistic {
...ReviewingStatusStatisticFragment
}
}
labelingStatus {
labeler {
...TeamMemberFragment
}
isCompleted
isStarted
statistic {
...LabelingStatusStatisticFragment
}
statisticsToShow {
...StatisticItemFragment
}
}
status
performance {
project {
...ProjectFragment
}
projectId
totalTimeSpent
effectiveTotalTimeSpent
conflicts
totalLabelApplied
numberOfAcceptedLabels
numberOfDocuments
numberOfTokens
numberOfLines
}
selfLabelingStatus
purpose
rootCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
reviewCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
labelerCabinets {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
guideline {
id
name
content
project {
...ProjectFragment
}
}
isArchived
}
}
Variables
{"input": GetProjectInput}
Response
{
"data": {
"getProject": {
"id": 4,
"team": Team,
"teamId": "4",
"rootDocumentId": "4",
"assignees": [ProjectAssignment],
"name": "xyz789",
"tags": [Tag],
"type": "xyz789",
"createdDate": "abc123",
"completedDate": "abc123",
"exportedDate": "xyz789",
"updatedDate": "xyz789",
"isOwnerMe": true,
"isReviewByMeAllowed": true,
"settings": ProjectSettings,
"workspaceSettings": WorkspaceSettings,
"reviewingStatus": ReviewingStatus,
"labelingStatus": [LabelingStatus],
"status": "CREATED",
"performance": ProjectPerformance,
"selfLabelingStatus": "NOT_STARTED",
"purpose": "LABELING",
"rootCabinet": Cabinet,
"reviewCabinet": Cabinet,
"labelerCabinets": [Cabinet],
"guideline": Guideline,
"isArchived": true
}
}
}
getProjectCabinets
Description
Returns all of the project's cabinets.
Response
Returns [Cabinet!]!
Arguments
Name | Description |
---|---|
projectId - ID!
|
Example
Query
query GetProjectCabinets($projectId: ID!) {
getProjectCabinets(projectId: $projectId) {
id
documents
role
status
lastOpenedDocumentId
statistic {
id
numberOfTokens
numberOfLines
}
owner {
id
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
}
createdAt
}
}
Variables
{"projectId": "4"}
Response
{
"data": {
"getProjectCabinets": [
{
"id": 4,
"documents": [TextDocumentScalar],
"role": "REVIEWER",
"status": "IN_PROGRESS",
"lastOpenedDocumentId": 4,
"statistic": CabinetStatistic,
"owner": User,
"createdAt": "2007-12-03T10:15:30Z"
}
]
}
}
getProjectConflictsCount
Description
Total Project Conflict Count. Returns total label conflicts plus edit sentence conflicts
Response
Returns [ProjectConflictsCountItem!]!
Example
Query
query GetProjectConflictsCount(
$projectId: ID!,
$role: Role
) {
getProjectConflictsCount(
projectId: $projectId,
role: $role
) {
documentId
numberOfConflicts
}
}
Variables
{"projectId": 4, "role": "REVIEWER"}
Response
{
"data": {
"getProjectConflictsCount": [
{
"documentId": "abc123",
"numberOfConflicts": 123
}
]
}
}
getProjectExtension
Response
Returns a ProjectExtension
Arguments
Name | Description |
---|---|
cabinetId - ID!
|
Example
Query
query GetProjectExtension($cabinetId: ID!) {
getProjectExtension(cabinetId: $cabinetId) {
id
cabinetId
elements {
id
enabled
extension {
...ExtensionFragment
}
height
order
setting {
...ExtensionElementSettingFragment
}
}
width
}
}
Variables
{"cabinetId": "4"}
Response
{
"data": {
"getProjectExtension": {
"id": 4,
"cabinetId": 4,
"elements": [ExtensionElement],
"width": 123
}
}
}
getProjectSample
Description
Returns a single project identified by its ID.
Response
Returns a ProjectSample!
Arguments
Name | Description |
---|---|
id - ID!
|
Example
Query
query GetProjectSample($id: ID!) {
getProjectSample(id: $id) {
id
displayName
exportableJSON
}
}
Variables
{"id": 4}
Response
{
"data": {
"getProjectSample": {
"id": 4,
"displayName": "abc123",
"exportableJSON": "abc123"
}
}
}
getProjectSamples
Description
Returns a list of ProjectSample matching the given name
Response
Returns [ProjectSample!]!
Arguments
Name | Description |
---|---|
displayName - String
|
Example
Query
query GetProjectSamples($displayName: String) {
getProjectSamples(displayName: $displayName) {
id
displayName
exportableJSON
}
}
Variables
{"displayName": "abc123"}
Response
{
"data": {
"getProjectSamples": [
{
"id": 4,
"displayName": "xyz789",
"exportableJSON": "abc123"
}
]
}
}
getProjectTemplate
Response
Returns a ProjectTemplate!
Arguments
Name | Description |
---|---|
id - ID!
|
Example
Query
query GetProjectTemplate($id: ID!) {
getProjectTemplate(id: $id) {
id
name
teamId
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
logoURL
projectTemplateProjectSettingId
projectTemplateTextDocumentSettingId
projectTemplateProjectSetting {
autoMarkDocumentAsComplete
enableEditLabelSet
enableEditSentence
enableLabelerProjectCompletionNotificationThreshold
enableReviewerEditSentence
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
}
projectTemplateTextDocumentSetting {
customScriptId
fileTransformerId
customTextExtractionAPIId
sentenceSeparator
mediaDisplayStrategy
enableTabularMarkdownParsing
firstRowAsHeader
displayedRows
kind
kinds
allTokensMustBeLabeled
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
textLabelMaxTokenLength
ocrMethod
transcriptMethod
ocrProvider
autoScrollWhenLabeling
tokenizer
editSentenceTokenizer
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getProjectTemplate": {
"id": 4,
"name": "xyz789",
"teamId": "4",
"team": Team,
"logoURL": "abc123",
"projectTemplateProjectSettingId": 4,
"projectTemplateTextDocumentSettingId": "4",
"projectTemplateProjectSetting": ProjectTemplateProjectSetting,
"projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
"labelSetTemplates": [LabelSetTemplate],
"questionSets": [QuestionSet],
"createdAt": "abc123",
"updatedAt": "xyz789",
"purpose": "LABELING",
"creatorId": "4"
}
}
}
getProjectTemplates
Response
Returns [ProjectTemplate!]!
Arguments
Name | Description |
---|---|
teamId - ID!
|
Example
Query
query GetProjectTemplates($teamId: ID!) {
getProjectTemplates(teamId: $teamId) {
id
name
teamId
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
logoURL
projectTemplateProjectSettingId
projectTemplateTextDocumentSettingId
projectTemplateProjectSetting {
autoMarkDocumentAsComplete
enableEditLabelSet
enableEditSentence
enableLabelerProjectCompletionNotificationThreshold
enableReviewerEditSentence
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
}
projectTemplateTextDocumentSetting {
customScriptId
fileTransformerId
customTextExtractionAPIId
sentenceSeparator
mediaDisplayStrategy
enableTabularMarkdownParsing
firstRowAsHeader
displayedRows
kind
kinds
allTokensMustBeLabeled
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
textLabelMaxTokenLength
ocrMethod
transcriptMethod
ocrProvider
autoScrollWhenLabeling
tokenizer
editSentenceTokenizer
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getProjectTemplates": [
{
"id": "4",
"name": "xyz789",
"teamId": "4",
"team": Team,
"logoURL": "abc123",
"projectTemplateProjectSettingId": "4",
"projectTemplateTextDocumentSettingId": 4,
"projectTemplateProjectSetting": ProjectTemplateProjectSetting,
"projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
"labelSetTemplates": [LabelSetTemplate],
"questionSets": [QuestionSet],
"createdAt": "xyz789",
"updatedAt": "xyz789",
"purpose": "LABELING",
"creatorId": 4
}
]
}
}
getProjects
Description
Returns a paginated list of projects.
Response
Returns a ProjectPaginatedResponse!
Arguments
Name | Description |
---|---|
input - GetProjectsPaginatedInput!
|
Example
Query
query GetProjects($input: GetProjectsPaginatedInput!) {
getProjects(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
team {
...TeamFragment
}
teamId
rootDocumentId
assignees {
...ProjectAssignmentFragment
}
name
tags {
...TagFragment
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
...ProjectSettingsFragment
}
workspaceSettings {
...WorkspaceSettingsFragment
}
reviewingStatus {
...ReviewingStatusFragment
}
labelingStatus {
...LabelingStatusFragment
}
status
performance {
...ProjectPerformanceFragment
}
selfLabelingStatus
purpose
rootCabinet {
...CabinetFragment
}
reviewCabinet {
...CabinetFragment
}
labelerCabinets {
...CabinetFragment
}
guideline {
...GuidelineFragment
}
isArchived
}
}
}
Variables
{"input": GetProjectsPaginatedInput}
Response
{
"data": {
"getProjects": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [Project]
}
}
}
getProjectsFinalReport
Response
Returns [ProjectFinalReport!]!
Arguments
Name | Description |
---|---|
projectIds - [ID!]!
|
Example
Query
query GetProjectsFinalReport($projectIds: [ID!]!) {
getProjectsFinalReport(projectIds: $projectIds) {
project {
id
team {
...TeamFragment
}
teamId
rootDocumentId
assignees {
...ProjectAssignmentFragment
}
name
tags {
...TagFragment
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
...ProjectSettingsFragment
}
workspaceSettings {
...WorkspaceSettingsFragment
}
reviewingStatus {
...ReviewingStatusFragment
}
labelingStatus {
...LabelingStatusFragment
}
status
performance {
...ProjectPerformanceFragment
}
selfLabelingStatus
purpose
rootCabinet {
...CabinetFragment
}
reviewCabinet {
...CabinetFragment
}
labelerCabinets {
...CabinetFragment
}
guideline {
...GuidelineFragment
}
isArchived
}
documentFinalReports {
rowFinalReports {
...RowFinalReportFragment
}
cabinet {
...CabinetFragment
}
document {
...TextDocumentFragment
}
finalReport {
...FinalReportFragment
}
teamMember {
...TeamMemberFragment
}
}
}
}
Variables
{"projectIds": ["4"]}
Response
{
"data": {
"getProjectsFinalReport": [
{
"project": Project,
"documentFinalReports": [DocumentFinalReport]
}
]
}
}
getQuestionSet
Response
Returns a QuestionSet!
Arguments
Name | Description |
---|---|
id - ID!
|
Example
Query
query GetQuestionSet($id: ID!) {
getQuestionSet(id: $id) {
name
id
creator {
id
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
}
items {
id
index
questionSetId
label
type
multipleAnswer
required
bindToColumn
activationConditionLogic
createdAt
updatedAt
options {
...DropdownConfigOptionsFragment
}
leafOptionsOnly
format
defaultValue
max
min
theme
gradientColors
step
hideScaleLabel
multiline
maxLength
minLength
pattern
hint
nestedQuestions {
...QuestionSetItemFragment
}
parentId
}
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getQuestionSet": {
"name": "abc123",
"id": "4",
"creator": User,
"items": [QuestionSetItem],
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
getQuestionSetTemplate
Response
Returns a QuestionSetTemplate!
Example
Query
query GetQuestionSetTemplate(
$teamId: ID!,
$id: ID!
) {
getQuestionSetTemplate(
teamId: $teamId,
id: $id
) {
id
teamId
name
template
createdAt
updatedAt
}
}
Variables
{
"teamId": "4",
"id": "4"
}
Response
{
"data": {
"getQuestionSetTemplate": {
"id": 4,
"teamId": "4",
"name": "xyz789",
"template": "abc123",
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
getQuestionSetTemplates
Response
Returns [QuestionSetTemplate!]!
Arguments
Name | Description |
---|---|
teamId - ID!
|
Example
Query
query GetQuestionSetTemplates($teamId: ID!) {
getQuestionSetTemplates(teamId: $teamId) {
id
teamId
name
template
createdAt
updatedAt
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getQuestionSetTemplates": [
{
"id": 4,
"teamId": 4,
"name": "abc123",
"template": "abc123",
"createdAt": "abc123",
"updatedAt": "xyz789"
}
]
}
}
getRemainingFilesStatistic
Description
Get the remaining project files count based on the corresponding project status.
Response
Returns a RemainingFilesStatistic!
Arguments
Name | Description |
---|---|
teamId - ID!
|
Example
Query
query GetRemainingFilesStatistic($teamId: ID!) {
getRemainingFilesStatistic(teamId: $teamId) {
total
inReview
reviewReady
inProgress
created
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getRemainingFilesStatistic": {
"total": 987,
"inReview": 987,
"reviewReady": 987,
"inProgress": 123,
"created": 123
}
}
}
getRowAnalyticEvents
Response
Returns a RowAnalyticEventPaginatedResponse!
Arguments
Name | Description |
---|---|
input - RowAnalyticEventInput!
|
Example
Query
query GetRowAnalyticEvents($input: RowAnalyticEventInput!) {
getRowAnalyticEvents(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
cell {
...RowAnalyticEventCellFragment
}
createdAt
event
id
user {
...RowAnalyticEventUserFragment
}
}
}
}
Variables
{"input": RowAnalyticEventInput}
Response
{
"data": {
"getRowAnalyticEvents": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [RowAnalyticEvent]
}
}
}
getRowAnswerConflicts
Response
Returns [RowAnswerConflicts!]!
Arguments
Name | Description |
---|---|
input - GetRowAnswerConflictsInput
|
Example
Query
query GetRowAnswerConflicts($input: GetRowAnswerConflictsInput) {
getRowAnswerConflicts(input: $input) {
line
conflicts
conflictStatus
}
}
Variables
{"input": GetRowAnswerConflictsInput}
Response
{
"data": {
"getRowAnswerConflicts": [
{
"line": 987,
"conflicts": [ConflictAnswerScalar],
"conflictStatus": "CONFLICT"
}
]
}
}
getRowAnswersPaginated
Response
Returns a GetRowAnswersPaginatedResponse!
Arguments
Name | Description |
---|---|
documentId - ID!
|
|
input - GetRowAnswersPaginatedInput
|
|
signature - String
|
Example
Query
query GetRowAnswersPaginated(
$documentId: ID!,
$input: GetRowAnswersPaginatedInput,
$signature: String
) {
getRowAnswersPaginated(
documentId: $documentId,
input: $input,
signature: $signature
) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
documentId
line
answers
metadata {
...AnswerMetadataFragment
}
updatedAt
}
}
}
Variables
{
"documentId": 4,
"input": GetRowAnswersPaginatedInput,
"signature": "abc123"
}
Response
{
"data": {
"getRowAnswersPaginated": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [RowAnswer]
}
}
}
getRowQuestions
Response
Returns [Question!]!
Arguments
Name | Description |
---|---|
projectId - ID!
|
Example
Query
query GetRowQuestions($projectId: ID!) {
getRowQuestions(projectId: $projectId) {
id
internalId
type
name
label
required
config {
defaultValue
format
multiple
multiline
options {
...QuestionConfigOptionsFragment
}
leafOptionsOnly
questions {
...QuestionFragment
}
minLength
maxLength
pattern
theme
gradientColors
min
max
step
hint
hideScaleLabel
}
bindToColumn
activationConditionLogic
}
}
Variables
{"projectId": 4}
Response
{
"data": {
"getRowQuestions": [
{
"id": 987,
"internalId": "xyz789",
"type": "DROPDOWN",
"name": "xyz789",
"label": "xyz789",
"required": false,
"config": QuestionConfig,
"bindToColumn": "xyz789",
"activationConditionLogic": "xyz789"
}
]
}
}
getSearchHistoryKeywords
Response
Returns [SearchHistoryKeyword!]!
Example
Query
query GetSearchHistoryKeywords {
getSearchHistoryKeywords {
id
keyword
}
}
Response
{
"data": {
"getSearchHistoryKeywords": [
{
"id": "4",
"keyword": "abc123"
}
]
}
}
getSpanAndArrowConflictContributorIds
Response
Returns [ConflictContributorIds!]!
Arguments
Name | Description |
---|---|
documentId - ID!
|
|
labelHashCodes - [String!]!
|
Example
Query
query GetSpanAndArrowConflictContributorIds(
$documentId: ID!,
$labelHashCodes: [String!]!
) {
getSpanAndArrowConflictContributorIds(
documentId: $documentId,
labelHashCodes: $labelHashCodes
) {
labelHashCode
contributorIds
contributorInfos {
id
labelPhase
}
}
}
Variables
{
"documentId": "4",
"labelHashCodes": ["abc123"]
}
Response
{
"data": {
"getSpanAndArrowConflictContributorIds": [
{
"labelHashCode": "abc123",
"contributorIds": [987],
"contributorInfos": [ContributorInfo]
}
]
}
}
getSpanAndArrowConflicts
Response
Arguments
Name | Description |
---|---|
documentId - ID!
|
|
input - GetSpanAndArrowConflictsPaginatedInput!
|
|
signature - String
|
Example
Query
query GetSpanAndArrowConflicts(
$documentId: ID!,
$input: GetSpanAndArrowConflictsPaginatedInput!,
$signature: String
) {
getSpanAndArrowConflicts(
documentId: $documentId,
input: $input,
signature: $signature
) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes
}
}
Variables
{
"documentId": 4,
"input": GetSpanAndArrowConflictsPaginatedInput,
"signature": "xyz789"
}
Response
{
"data": {
"getSpanAndArrowConflicts": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [ConflictTextLabelScalar]
}
}
}
getSpanAndArrowRejectedLabels
Response
Arguments
Name | Description |
---|---|
documentId - ID!
|
|
input - GetSpanAndArrowRejectedLabelsPaginatedInput!
|
|
signature - String
|
Example
Query
query GetSpanAndArrowRejectedLabels(
$documentId: ID!,
$input: GetSpanAndArrowRejectedLabelsPaginatedInput!,
$signature: String
) {
getSpanAndArrowRejectedLabels(
documentId: $documentId,
input: $input,
signature: $signature
) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes
}
}
Variables
{
"documentId": "4",
"input": GetSpanAndArrowRejectedLabelsPaginatedInput,
"signature": "abc123"
}
Response
{
"data": {
"getSpanAndArrowRejectedLabels": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [ConflictTextLabelScalar]
}
}
}
getSynchronizeJobs
Example
Query
query GetSynchronizeJobs($projectId: ID!) {
getSynchronizeJobs(projectId: $projectId) {
id
status
progress
errors {
id
stack
args
}
resultId
result
createdAt
updatedAt
additionalData {
actionRunId
childrenJobIds
}
}
}
Variables
{"projectId": 4}
Response
{
"data": {
"getSynchronizeJobs": [
{
"id": "xyz789",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "abc123",
"additionalData": JobAdditionalData
}
]
}
}
getTags
Description
Returns a list of team-owned tags.
Response
Returns [Tag!]!
Arguments
Name | Description |
---|---|
input - GetTagsInput!
|
Example
Query
query GetTags($input: GetTagsInput!) {
getTags(input: $input) {
id
name
globalTag
}
}
Variables
{"input": GetTagsInput}
Response
{
"data": {
"getTags": [
{
"id": 4,
"name": "abc123",
"globalTag": false
}
]
}
}
getTeamDetail
Response
Returns a Team!
Arguments
Name | Description |
---|---|
input - GetTeamDetailInput
|
Example
Query
query GetTeamDetail($input: GetTeamDetailInput) {
getTeamDetail(input: $input) {
id
logoURL
members {
id
user {
...UserFragment
}
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
}
membersScalar
name
setting {
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enableActions
enableAssistedLabeling
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurPredictiveRowBased
enableWipeData
enableExportTeamOverview
allowedExtraAutoLabelProviders
enableLLMProject
}
owner {
id
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
}
isExpired
expiredAt
}
}
Variables
{"input": GetTeamDetailInput}
Response
{
"data": {
"getTeamDetail": {
"id": "4",
"logoURL": "xyz789",
"members": [TeamMember],
"membersScalar": TeamMembersScalar,
"name": "abc123",
"setting": TeamSetting,
"owner": User,
"isExpired": true,
"expiredAt": "2007-12-03T10:15:30Z"
}
}
}
getTeamMemberDetail
Response
Returns a TeamMember!
Example
Query
query GetTeamMemberDetail(
$teamId: ID!,
$memberId: ID!
) {
getTeamMemberDetail(
teamId: $teamId,
memberId: $memberId
) {
id
user {
id
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
}
role {
id
name
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
id
userId
projectStatistic {
...TeamMemberProjectStatisticFragment
}
totalTimeSpent
effectiveTotalTimeSpent
accuracy
}
}
}
Variables
{"teamId": "4", "memberId": 4}
Response
{
"data": {
"getTeamMemberDetail": {
"id": "4",
"user": User,
"role": TeamRole,
"invitationEmail": "abc123",
"invitationStatus": "abc123",
"invitationKey": "abc123",
"isDeleted": false,
"joinedDate": "abc123",
"performance": TeamMemberPerformance
}
}
}
getTeamMemberPerformance
Response
Arguments
Name | Description |
---|---|
input - GetPaginatedTeamMemberPerformanceInput!
|
Example
Query
query GetTeamMemberPerformance($input: GetPaginatedTeamMemberPerformanceInput!) {
getTeamMemberPerformance(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
projectId
resourceId
projectName
labelingStatus
projectStatus
totalLabelApplied
totalConflictResolved
numberOfAcceptedLabels
numberOfRejectedLabels
activeDurationInMillis
}
}
}
Variables
{"input": GetPaginatedTeamMemberPerformanceInput}
Response
{
"data": {
"getTeamMemberPerformance": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [GetPaginatedTeamMemberPerformance]
}
}
}
getTeamMembers
Description
Returns the specified team's members. teamId
can be seen in web UI, visible in the URL (https://datasaur.ai/teams/{teamId}/...) , or obtained via getAllTeams
.
Response
Returns [TeamMember!]!
Arguments
Name | Description |
---|---|
teamId - ID!
|
Example
Query
query GetTeamMembers($teamId: ID!) {
getTeamMembers(teamId: $teamId) {
id
user {
id
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
}
role {
id
name
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
id
userId
projectStatistic {
...TeamMemberProjectStatisticFragment
}
totalTimeSpent
effectiveTotalTimeSpent
accuracy
}
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getTeamMembers": [
{
"id": "4",
"user": User,
"role": TeamRole,
"invitationEmail": "xyz789",
"invitationStatus": "abc123",
"invitationKey": "abc123",
"isDeleted": true,
"joinedDate": "abc123",
"performance": TeamMemberPerformance
}
]
}
}
getTeamMembersPaginated
Response
Returns a GetTeamMembersPaginatedResponse!
Arguments
Name | Description |
---|---|
input - GetTeamMembersPaginatedInput!
|
Example
Query
query GetTeamMembersPaginated($input: GetTeamMembersPaginatedInput!) {
getTeamMembersPaginated(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
user {
...UserFragment
}
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
}
}
}
Variables
{"input": GetTeamMembersPaginatedInput}
Response
{
"data": {
"getTeamMembersPaginated": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [TeamMember]
}
}
}
getTeamProjectAssignees
Response
Returns [ProjectAssignment!]!
Arguments
Name | Description |
---|---|
input - GetTeamProjectAssigneesInput!
|
Example
Query
query GetTeamProjectAssignees($input: GetTeamProjectAssigneesInput!) {
getTeamProjectAssignees(input: $input) {
teamMember {
id
user {
...UserFragment
}
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
}
documentIds
documents {
id
chunks {
...TextChunkFragment
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
...TextDocumentSettingsFragment
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
...TextSentenceFragment
}
settings {
...SettingsFragment
}
statistic {
...TextDocumentStatisticFragment
}
type
updatedChunks {
...TextChunkFragment
}
updatedTokenLabels {
...TextLabelFragment
}
url
version
workspaceState {
...WorkspaceStateFragment
}
originId
signature
part
}
role
createdAt
updatedAt
}
}
Variables
{"input": GetTeamProjectAssigneesInput}
Response
{
"data": {
"getTeamProjectAssignees": [
{
"teamMember": TeamMember,
"documentIds": ["xyz789"],
"documents": [TextDocument],
"role": "LABELER",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
getTeamRoles
Response
Returns [TeamRole!]
Example
Query
query GetTeamRoles {
getTeamRoles {
id
name
}
}
Response
{"data": {"getTeamRoles": [{"id": 4, "name": "ADMIN"}]}}
getTeamTimelineEvent
Response
Returns [TimelineEvent!]!
Arguments
Name | Description |
---|---|
teamId - ID!
|
Example
Query
query GetTeamTimelineEvent($teamId: ID!) {
getTeamTimelineEvent(teamId: $teamId) {
id
user {
id
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
}
event
targetProject {
id
name
isDeleted
}
targetUser {
id
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
}
created
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getTeamTimelineEvent": [
{
"id": "4",
"user": User,
"event": "xyz789",
"targetProject": TimelineProject,
"targetUser": User,
"created": "xyz789"
}
]
}
}
getTeamTimelineEvents
Response
Returns a GetTeamTimelineEventsResponse!
Arguments
Name | Description |
---|---|
input - GetTeamTimelineEventsInput
|
Example
Query
query GetTeamTimelineEvents($input: GetTeamTimelineEventsInput) {
getTeamTimelineEvents(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
user {
...UserFragment
}
event
targetProject {
...TimelineProjectFragment
}
targetUser {
...UserFragment
}
created
}
}
}
Variables
{"input": GetTeamTimelineEventsInput}
Response
{
"data": {
"getTeamTimelineEvents": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [TimelineEvent]
}
}
}
getTextDocument
Response
Returns a TextDocument!
Example
Query
query GetTextDocument(
$fileId: ID!,
$signature: String
) {
getTextDocument(
fileId: $fileId,
signature: $signature
) {
id
chunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
kinds
sentenceSeparator
tokenizer
editSentenceTokenizer
displayedRows
mediaDisplayStrategy
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
fileTransformerId
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
id
documentId
userId
status
content
tokens
posLabels {
...TextLabelFragment
}
nerLabels {
...TextLabelFragment
}
docLabels {
...DocLabelObjectFragment
}
docLabelsString
conflicts {
...ConflictTextLabelFragment
}
conflictAnswers {
...ConflictAnswerFragment
}
answers {
...AnswerFragment
}
sentenceConflict {
...SentenceConflictFragment
}
conflictAnswerResolved
metadata {
...CellMetadataFragment
}
}
settings {
textLang
}
statistic {
documentId
numberOfChunks
numberOfSentences
numberOfTokens
effectiveTimeSpent
touchedSentences
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
}
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
}
url
version
workspaceState {
id
chunkId
sentenceStart
sentenceEnd
touchedChunks
touchedSentences
}
originId
signature
part
}
}
Variables
{"fileId": 4, "signature": "abc123"}
Response
{
"data": {
"getTextDocument": {
"id": 4,
"chunks": [TextChunk],
"createdAt": "abc123",
"currentSentenceCursor": 123,
"lastLabeledLine": 123,
"documentSettings": TextDocumentSettings,
"fileName": "xyz789",
"isCompleted": true,
"lastSavedAt": "xyz789",
"mimeType": "xyz789",
"name": "xyz789",
"projectId": 4,
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "xyz789",
"version": 987,
"workspaceState": WorkspaceState,
"originId": "4",
"signature": "abc123",
"part": 123
}
}
}
getTextDocumentOriginIdsByDocumentName
Description
Filter Text Document whose name matches the given regular expression. Returns the Text Document origin ID.
Example
Query
query GetTextDocumentOriginIdsByDocumentName(
$projectId: ID!,
$nameRegexString: String!
) {
getTextDocumentOriginIdsByDocumentName(
projectId: $projectId,
nameRegexString: $nameRegexString
)
}
Variables
{
"projectId": "4",
"nameRegexString": "abc123"
}
Response
{"data": {"getTextDocumentOriginIdsByDocumentName": [4]}}
getTextDocumentSettings
Response
Returns a TextDocumentSettings!
Arguments
Name | Description |
---|---|
projectId - ID!
|
Example
Query
query GetTextDocumentSettings($projectId: ID!) {
getTextDocumentSettings(projectId: $projectId) {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
kinds
sentenceSeparator
tokenizer
editSentenceTokenizer
displayedRows
mediaDisplayStrategy
viewer
viewerConfig {
urlColumnNames
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
name
pattern
flags
}
fileTransformerId
}
}
Variables
{"projectId": "4"}
Response
{
"data": {
"getTextDocumentSettings": {
"id": 4,
"textLabelMaxTokenLength": 987,
"allTokensMustBeLabeled": true,
"autoScrollWhenLabeling": false,
"allowArcDrawing": false,
"allowCharacterBasedLabeling": false,
"allowMultiLabels": false,
"kinds": ["DOCUMENT_BASED"],
"sentenceSeparator": "abc123",
"tokenizer": "xyz789",
"editSentenceTokenizer": "xyz789",
"displayedRows": 123,
"mediaDisplayStrategy": "NONE",
"viewer": "TOKEN",
"viewerConfig": TextDocumentViewerConfig,
"hideBoundingBoxIfNoSpanOrArrowLabel": false,
"enableTabularMarkdownParsing": false,
"enableAnonymization": true,
"anonymizationEntityTypes": [
"xyz789"
],
"anonymizationMaskingMethod": "abc123",
"anonymizationRegExps": [RegularExpression],
"fileTransformerId": "xyz789"
}
}
}
getTextDocumentStatistic
Response
Returns a TextDocumentStatistic!
Arguments
Name | Description |
---|---|
documentId - ID!
|
Example
Query
query GetTextDocumentStatistic($documentId: ID!) {
getTextDocumentStatistic(documentId: $documentId) {
documentId
numberOfChunks
numberOfSentences
numberOfTokens
effectiveTimeSpent
touchedSentences
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
userId
areDocumentQuestionsAnswered
numberOfAcceptedLabels
numberOfAppliedLabelTokens
numberOfRejectedLabels
}
documentTouched
}
}
Variables
{"documentId": "4"}
Response
{
"data": {
"getTextDocumentStatistic": {
"documentId": "4",
"numberOfChunks": 123,
"numberOfSentences": 123,
"numberOfTokens": 123,
"effectiveTimeSpent": 123,
"touchedSentences": [987],
"nonDisplayedLines": [987],
"numberOfEntitiesLabeled": 123,
"numberOfNonDocumentEntitiesLabeled": 987,
"maxLabeledLine": 123,
"labelerStatistic": [LabelerStatistic],
"documentTouched": true
}
}
}
getTimestampLabels
Response
Returns [TimestampLabel!]!
Example
Query
query GetTimestampLabels(
$documentId: ID!,
$fromTimestampMillis: Int
) {
getTimestampLabels(
documentId: $documentId,
fromTimestampMillis: $fromTimestampMillis
) {
id
documentId
layer
position {
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
}
startTimestampMillis
endTimestampMillis
type
}
}
Variables
{"documentId": 4, "fromTimestampMillis": 123}
Response
{
"data": {
"getTimestampLabels": [
{
"id": "4",
"documentId": 4,
"layer": 987,
"position": TextRange,
"startTimestampMillis": 123,
"endTimestampMillis": 987,
"type": "ARROW"
}
]
}
}
getTimestampLabelsAtTimestamp
Response
Returns [TimestampLabel!]!
Example
Query
query GetTimestampLabelsAtTimestamp(
$documentId: ID!,
$timestampMillis: Int
) {
getTimestampLabelsAtTimestamp(
documentId: $documentId,
timestampMillis: $timestampMillis
) {
id
documentId
layer
position {
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
}
startTimestampMillis
endTimestampMillis
type
}
}
Variables
{"documentId": "4", "timestampMillis": 123}
Response
{
"data": {
"getTimestampLabelsAtTimestamp": [
{
"id": "4",
"documentId": 4,
"layer": 123,
"position": TextRange,
"startTimestampMillis": 987,
"endTimestampMillis": 987,
"type": "ARROW"
}
]
}
}
getTrainingJobs
Response
Returns [TrainingJob!]!
Example
Query
query GetTrainingJobs {
getTrainingJobs {
teamId
mlModelSettingId
kind
version
}
}
Response
{
"data": {
"getTrainingJobs": [
{
"teamId": "4",
"mlModelSettingId": "4",
"kind": "DOCUMENT_BASED",
"version": 987
}
]
}
}
getUnusedLabelSetItemInfos
Response
Returns [UnusedLabelSetItemInfo!]!
Arguments
Name | Description |
---|---|
documentId - ID!
|
Example
Query
query GetUnusedLabelSetItemInfos($documentId: ID!) {
getUnusedLabelSetItemInfos(documentId: $documentId) {
labelSetId
labelSetName
items {
id
parentId
tagName
desc
color
type
arrowRules {
...LabelClassArrowRuleFragment
}
}
}
}
Variables
{"documentId": "4"}
Response
{
"data": {
"getUnusedLabelSetItemInfos": [
{
"labelSetId": 4,
"labelSetName": "xyz789",
"items": [TagItem]
}
]
}
}
getUsage
Response
Returns a Usage!
Arguments
Name | Description |
---|---|
input - GetUsageInput!
|
Example
Query
query GetUsage($input: GetUsageInput!) {
getUsage(input: $input) {
start
end
labels
}
}
Variables
{"input": GetUsageInput}
Response
{
"data": {
"getUsage": {
"start": "xyz789",
"end": "abc123",
"labels": 987
}
}
}
getUserAccountDetails
Response
Returns a UserAccountDetails!
Example
Query
query GetUserAccountDetails {
getUserAccountDetails {
hasPassword
signUpMethod
}
}
Response
{
"data": {
"getUserAccountDetails": {"hasPassword": false, "signUpMethod": "DEFAULT"}
}
}
getUserTotpRecoveryCodes
Response
Returns a TotpRecoveryCodes!
Arguments
Name | Description |
---|---|
totpCode - TotpCodeInput!
|
Example
Query
query GetUserTotpRecoveryCodes($totpCode: TotpCodeInput!) {
getUserTotpRecoveryCodes(totpCode: $totpCode) {
recoveryCodes
}
}
Variables
{"totpCode": TotpCodeInput}
Response
{
"data": {
"getUserTotpRecoveryCodes": {
"recoveryCodes": ["abc123"]
}
}
}
getWaveformPeaks
Description
Generate audiowaveform data for an audio project. Waveform data generated by using https://github.com/bbc/audiowaveform
Response
Returns a WaveformPeaks!
Example
Query
query GetWaveformPeaks(
$documentId: String!,
$pixelPerSecond: Int
) {
getWaveformPeaks(
documentId: $documentId,
pixelPerSecond: $pixelPerSecond
) {
peaks
pixelPerSecond
}
}
Variables
{
"documentId": "abc123",
"pixelPerSecond": 987
}
Response
{"data": {"getWaveformPeaks": {"peaks": [123.45], "pixelPerSecond": 123}}}
isDatasaurPredictiveReadyForTraining
Response
Returns a Boolean!
Arguments
Name | Description |
---|---|
input - DatasaurPredictiveReadyForTrainingInput!
|
Example
Query
query IsDatasaurPredictiveReadyForTraining($input: DatasaurPredictiveReadyForTrainingInput!) {
isDatasaurPredictiveReadyForTraining(input: $input)
}
Variables
{"input": DatasaurPredictiveReadyForTrainingInput}
Response
{"data": {"isDatasaurPredictiveReadyForTraining": false}}
isOAuthClientExist
Description
Returns true if oauth client has been generated before.
Response
Returns a Boolean!
Example
Query
query IsOAuthClientExist {
isOAuthClientExist
}
Response
{"data": {"isOAuthClientExist": true}}
isTotpVerificationRequired
Response
Returns a Boolean!
Example
Query
query IsTotpVerificationRequired {
isTotpVerificationRequired
}
Response
{"data": {"isTotpVerificationRequired": false}}
me
Response
Returns a User
Example
Query
query Me {
me {
id
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
}
}
Response
{
"data": {
"me": {
"id": "4",
"username": "abc123",
"name": "xyz789",
"email": "abc123",
"package": "ENTERPRISE",
"profilePicture": "xyz789",
"allowedActions": ["CONFIGURE_ASSISTED_LABELING"],
"displayName": "abc123",
"teamPackage": "ENTERPRISE",
"emailVerified": true,
"totpAuthEnabled": true,
"companyName": "xyz789"
}
}
}
replicateCabinet
Description
Replicate cabinet if not exist
Example
Query
query ReplicateCabinet(
$projectId: ID!,
$role: Role!
) {
replicateCabinet(
projectId: $projectId,
role: $role
) {
id
status
progress
errors {
id
stack
args
}
resultId
result
createdAt
updatedAt
additionalData {
actionRunId
childrenJobIds
}
}
}
Variables
{"projectId": 4, "role": "REVIEWER"}
Response
{
"data": {
"replicateCabinet": {
"id": "abc123",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "xyz789",
"additionalData": JobAdditionalData
}
}
}
tutorialVideos
Response
Returns [TutorialVideo!]!
Example
Query
query TutorialVideos {
tutorialVideos {
title
id
url
}
}
Response
{
"data": {
"tutorialVideos": [
{
"title": "xyz789",
"id": "4",
"url": "abc123"
}
]
}
}
validateCabinet
Description
Checks whether the cabinet can be safely mark as completed or not. Returns true if valid, causes error otherwise
Example
Query
query ValidateCabinet(
$projectId: ID!,
$role: Role!
) {
validateCabinet(
projectId: $projectId,
role: $role
)
}
Variables
{"projectId": 4, "role": "REVIEWER"}
Response
{"data": {"validateCabinet": false}}
verifyBetaKey
verifyInvitationLink
Response
Returns an InvitationVerificationResult!
Example
Query
query VerifyInvitationLink(
$teamId: String!,
$invitationKey: String!
) {
verifyInvitationLink(
teamId: $teamId,
invitationKey: $invitationKey
) {
isValid
userIsRegistered
email
teamId
}
}
Variables
{
"teamId": "abc123",
"invitationKey": "xyz789"
}
Response
{
"data": {
"verifyInvitationLink": {
"isValid": false,
"userIsRegistered": true,
"email": "abc123",
"teamId": 4
}
}
}
verifyResetPasswordSignature
verifyUserTotpEnabled
Mutations
acceptBoundingBoxConflict
Response
Returns [BoundingBoxLabel!]!
Example
Query
mutation AcceptBoundingBoxConflict(
$documentId: ID!,
$boundingBoxLabelIds: [ID!]!
) {
acceptBoundingBoxConflict(
documentId: $documentId,
boundingBoxLabelIds: $boundingBoxLabelIds
) {
id
documentId
coordinates {
x
y
}
counter
pageIndex
layer
position {
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
}
hashCode
type
labeledBy
}
}
Variables
{
"documentId": 4,
"boundingBoxLabelIds": ["4"]
}
Response
{
"data": {
"acceptBoundingBoxConflict": [
{
"id": 4,
"documentId": 4,
"coordinates": [Coordinate],
"counter": 123,
"pageIndex": 987,
"layer": 123,
"position": TextRange,
"hashCode": "xyz789",
"type": "ARROW",
"labeledBy": "PRELABELED"
}
]
}
}
acceptInvitation
Example
Query
mutation AcceptInvitation($invitationKey: String!) {
acceptInvitation(invitationKey: $invitationKey) {
id
logoURL
members {
id
user {
...UserFragment
}
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
}
membersScalar
name
setting {
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enableActions
enableAssistedLabeling
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurPredictiveRowBased
enableWipeData
enableExportTeamOverview
allowedExtraAutoLabelProviders
enableLLMProject
}
owner {
id
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
}
isExpired
expiredAt
}
}
Variables
{"invitationKey": "xyz789"}
Response
{
"data": {
"acceptInvitation": {
"id": "4",
"logoURL": "abc123",
"members": [TeamMember],
"membersScalar": TeamMembersScalar,
"name": "abc123",
"setting": TeamSetting,
"owner": User,
"isExpired": false,
"expiredAt": "2007-12-03T10:15:30Z"
}
}
}
acceptTimestampLabelConflicts
Response
Returns [TimestampLabel!]!
Example
Query
mutation AcceptTimestampLabelConflicts(
$documentId: ID!,
$labelIds: [ID!]!
) {
acceptTimestampLabelConflicts(
documentId: $documentId,
labelIds: $labelIds
) {
id
documentId
layer
position {
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
}
startTimestampMillis
endTimestampMillis
type
}
}
Variables
{"documentId": "4", "labelIds": [4]}
Response
{
"data": {
"acceptTimestampLabelConflicts": [
{
"id": 4,
"documentId": "4",
"layer": 987,
"position": TextRange,
"startTimestampMillis": 987,
"endTimestampMillis": 987,
"type": "ARROW"
}
]
}
}
activateUser
Response
Returns a LoginSuccess
Example
Query
mutation ActivateUser(
$email: String!,
$activationCode: String!
) {
activateUser(
email: $email,
activationCode: $activationCode
) {
user {
id
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
}
redirect
}
}
Variables
{
"email": "xyz789",
"activationCode": "abc123"
}
Response
{
"data": {
"activateUser": {
"user": User,
"redirect": "xyz789"
}
}
}
addActiveDuration
Response
Returns a Boolean
Arguments
Name | Description |
---|---|
input - AddActiveDurationInput!
|
Example
Query
mutation AddActiveDuration($input: AddActiveDurationInput!) {
addActiveDuration(input: $input)
}
Variables
{"input": AddActiveDurationInput}
Response
{"data": {"addActiveDuration": false}}
addFileToDataset
Response
Returns a Boolean!
Arguments
Name | Description |
---|---|
input - AddFileToDatasetInput!
|
Example
Query
mutation AddFileToDataset($input: AddFileToDatasetInput!) {
addFileToDataset(input: $input)
}
Variables
{"input": AddFileToDatasetInput}
Response
{"data": {"addFileToDataset": true}}
addLabelingFunction
Response
Returns a LabelingFunction!
Arguments
Name | Description |
---|---|
input - AddLabelingFunctionInput!
|
Example
Query
mutation AddLabelingFunction($input: AddLabelingFunctionInput!) {
addLabelingFunction(input: $input) {
id
dataProgrammingId
heuristicArgument
annotatorArgument
name
content
active
createdAt
updatedAt
}
}
Variables
{"input": AddLabelingFunctionInput}
Response
{
"data": {
"addLabelingFunction": {
"id": "4",
"dataProgrammingId": 4,
"heuristicArgument": HeuristicArgumentScalar,
"annotatorArgument": AnnotatorArgumentScalar,
"name": "abc123",
"content": "xyz789",
"active": true,
"createdAt": "abc123",
"updatedAt": "xyz789"
}
}
}
allowIPs
Response
Returns [String!]!
Arguments
Name | Description |
---|---|
allowedIPs - [String!]!
|
Example
Query
mutation AllowIPs($allowedIPs: [String!]!) {
allowIPs(allowedIPs: $allowedIPs)
}
Variables
{"allowedIPs": ["xyz789"]}
Response
{"data": {"allowIPs": ["xyz789"]}}
appendLabelSetTagItems
Description
Adds new labelset item to the specified labelset.
Response
Returns [TagItem!]
Arguments
Name | Description |
---|---|
input - AppendLabelSetTagItemsInput!
|
Example
Query
mutation AppendLabelSetTagItems($input: AppendLabelSetTagItemsInput!) {
appendLabelSetTagItems(input: $input) {
id
parentId
tagName
desc
color
type
arrowRules {
originIds
destinationIds
}
}
}
Variables
{"input": AppendLabelSetTagItemsInput}
Response
{
"data": {
"appendLabelSetTagItems": [
{
"id": "xyz789",
"parentId": "4",
"tagName": "xyz789",
"desc": "abc123",
"color": "abc123",
"type": "SPAN",
"arrowRules": [LabelClassArrowRule]
}
]
}
}
autoLabelReviewTextDocumentBasedOnConsensus
Response
Returns a TextDocument!
Arguments
Name | Description |
---|---|
input - AutoLabelReviewTextDocumentBasedOnConsensusInput!
|
Example
Query
mutation AutoLabelReviewTextDocumentBasedOnConsensus($input: AutoLabelReviewTextDocumentBasedOnConsensusInput!) {
autoLabelReviewTextDocumentBasedOnConsensus(input: $input) {
id
chunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
kinds
sentenceSeparator
tokenizer
editSentenceTokenizer
displayedRows
mediaDisplayStrategy
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
fileTransformerId
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
id
documentId
userId
status
content
tokens
posLabels {
...TextLabelFragment
}
nerLabels {
...TextLabelFragment
}
docLabels {
...DocLabelObjectFragment
}
docLabelsString
conflicts {
...ConflictTextLabelFragment
}
conflictAnswers {
...ConflictAnswerFragment
}
answers {
...AnswerFragment
}
sentenceConflict {
...SentenceConflictFragment
}
conflictAnswerResolved
metadata {
...CellMetadataFragment
}
}
settings {
textLang
}
statistic {
documentId
numberOfChunks
numberOfSentences
numberOfTokens
effectiveTimeSpent
touchedSentences
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
}
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
}
url
version
workspaceState {
id
chunkId
sentenceStart
sentenceEnd
touchedChunks
touchedSentences
}
originId
signature
part
}
}
Variables
{
"input": AutoLabelReviewTextDocumentBasedOnConsensusInput
}
Response
{
"data": {
"autoLabelReviewTextDocumentBasedOnConsensus": {
"id": 4,
"chunks": [TextChunk],
"createdAt": "xyz789",
"currentSentenceCursor": 987,
"lastLabeledLine": 123,
"documentSettings": TextDocumentSettings,
"fileName": "xyz789",
"isCompleted": true,
"lastSavedAt": "abc123",
"mimeType": "abc123",
"name": "xyz789",
"projectId": "4",
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "xyz789",
"version": 987,
"workspaceState": WorkspaceState,
"originId": 4,
"signature": "abc123",
"part": 123
}
}
}
autoLabelTokenBasedProject
Response
Returns a Job!
Arguments
Name | Description |
---|---|
input - AutoLabelTokenBasedProjectInput!
|
Example
Query
mutation AutoLabelTokenBasedProject($input: AutoLabelTokenBasedProjectInput!) {
autoLabelTokenBasedProject(input: $input) {
id
status
progress
errors {
id
stack
args
}
resultId
result
createdAt
updatedAt
additionalData {
actionRunId
childrenJobIds
}
}
}
Variables
{"input": AutoLabelTokenBasedProjectInput}
Response
{
"data": {
"autoLabelTokenBasedProject": {
"id": "abc123",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"additionalData": JobAdditionalData
}
}
}
awsMarketplaceReportMeteredRecords
Example
Query
mutation AwsMarketplaceReportMeteredRecords($timestamp: String!) {
awsMarketplaceReportMeteredRecords(timestamp: $timestamp)
}
Variables
{"timestamp": "abc123"}
Response
{"data": {"awsMarketplaceReportMeteredRecords": false}}
awsMarketplaceSubscription
Response
Returns a Boolean!
Arguments
Name | Description |
---|---|
input - AwsMarketplaceSubscriptionInput!
|
Example
Query
mutation AwsMarketplaceSubscription($input: AwsMarketplaceSubscriptionInput!) {
awsMarketplaceSubscription(input: $input)
}
Variables
{"input": AwsMarketplaceSubscriptionInput}
Response
{"data": {"awsMarketplaceSubscription": true}}
bulkSetPasswordsExpiredAt
Response
Returns a Boolean!
Arguments
Name | Description |
---|---|
userIds - [String!]!
|
|
passwordExpiredAt - DateTime
|
Example
Query
mutation BulkSetPasswordsExpiredAt(
$userIds: [String!]!,
$passwordExpiredAt: DateTime
) {
bulkSetPasswordsExpiredAt(
userIds: $userIds,
passwordExpiredAt: $passwordExpiredAt
)
}
Variables
{
"userIds": ["abc123"],
"passwordExpiredAt": "2007-12-03T10:15:30Z"
}
Response
{"data": {"bulkSetPasswordsExpiredAt": false}}
calculateAgreementTables
Example
Query
mutation CalculateAgreementTables($projectId: ID!) {
calculateAgreementTables(projectId: $projectId) {
id
status
progress
errors {
id
stack
args
}
resultId
result
createdAt
updatedAt
additionalData {
actionRunId
childrenJobIds
}
}
}
Variables
{"projectId": "4"}
Response
{
"data": {
"calculateAgreementTables": {
"id": "abc123",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "abc123",
"additionalData": JobAdditionalData
}
}
}
calculatePairKappas
Response
Returns [String!]!
Arguments
Name | Description |
---|---|
projectIds - [ID!]!
|
Example
Query
mutation CalculatePairKappas($projectIds: [ID!]!) {
calculatePairKappas(projectIds: $projectIds)
}
Variables
{"projectIds": ["4"]}
Response
{
"data": {
"calculatePairKappas": ["abc123"]
}
}
changePassword
Response
Returns a String!
Arguments
Name | Description |
---|---|
input - ChangePasswordInput!
|
Example
Query
mutation ChangePassword($input: ChangePasswordInput!) {
changePassword(input: $input)
}
Variables
{"input": ChangePasswordInput}
Response
{"data": {"changePassword": "abc123"}}
clearAllLabelsOnTextDocument
Response
Returns a ClearAllLabelsOnTextDocumentResult!
Arguments
Name | Description |
---|---|
documentId - ID!
|
Example
Query
mutation ClearAllLabelsOnTextDocument($documentId: ID!) {
clearAllLabelsOnTextDocument(documentId: $documentId) {
affectedChunkIds
statistic {
documentId
numberOfChunks
numberOfSentences
numberOfTokens
effectiveTimeSpent
touchedSentences
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
}
lastSavedAt
}
}
Variables
{"documentId": "4"}
Response
{
"data": {
"clearAllLabelsOnTextDocument": {
"affectedChunkIds": [987],
"statistic": TextDocumentStatistic,
"lastSavedAt": "abc123"
}
}
}
clearAllSpanAndArrowLabels
Response
Returns a ClearAllLabelsOnTextDocumentResult!
Arguments
Name | Description |
---|---|
documentId - ID!
|
Example
Query
mutation ClearAllSpanAndArrowLabels($documentId: ID!) {
clearAllSpanAndArrowLabels(documentId: $documentId) {
affectedChunkIds
statistic {
documentId
numberOfChunks
numberOfSentences
numberOfTokens
effectiveTimeSpent
touchedSentences
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
}
lastSavedAt
}
}
Variables
{"documentId": 4}
Response
{
"data": {
"clearAllSpanAndArrowLabels": {
"affectedChunkIds": [123]