Datasaur GraphQL API Reference

Datasaur GraphQL API Reference

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

Response

Returns a Boolean!

Arguments
Name Description
url - String!

Example

Query
query CheckForMaliciousSite($url: String!) {
  checkForMaliciousSite(url: $url)
}
Variables
{"url": "abc123"}
Response
{"data": {"checkForMaliciousSite": false}}

checkLlmVectorStoreSourceRules

Breaking changes may be introduced anytime in the future without prior notice.
Arguments
Name Description
llmVectorStoreId - ID!
input - LlmVectorStoreSourceCreateInput!

Example

Query
query CheckLlmVectorStoreSourceRules(
  $llmVectorStoreId: ID!,
  $input: LlmVectorStoreSourceCreateInput!
) {
  checkLlmVectorStoreSourceRules(
    llmVectorStoreId: $llmVectorStoreId,
    input: $input
  ) {
    valid
    invalidRules {
      includePatterns
      excludePatterns
    }
  }
}
Variables
{
  "llmVectorStoreId": 4,
  "input": LlmVectorStoreSourceCreateInput
}
Response
{
  "data": {
    "checkLlmVectorStoreSourceRules": {
      "valid": false,
      "invalidRules": LlmVectorStoreSourceInvalidRules
    }
  }
}

countProjectsByExternalObjectStorageId

Response

Returns an Int!

Arguments
Name Description
input - String!

Example

Query
query CountProjectsByExternalObjectStorageId($input: String!) {
  countProjectsByExternalObjectStorageId(input: $input)
}
Variables
{"input": "xyz789"}
Response
{"data": {"countProjectsByExternalObjectStorageId": 987}}

dictionaryLookup

Response

Returns a DictionaryResult!

Arguments
Name Description
word - String!
lang - String

Example

Query
query DictionaryLookup(
  $word: String!,
  $lang: String
) {
  dictionaryLookup(
    word: $word,
    lang: $lang
  ) {
    word
    lang
    entries {
      lexicalCategory
      definitions {
        ...DefinitionEntryFragment
      }
    }
  }
}
Variables
{
  "word": "abc123",
  "lang": "xyz789"
}
Response
{
  "data": {
    "dictionaryLookup": {
      "word": "xyz789",
      "lang": "xyz789",
      "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": ["abc123"],
  "lang": "abc123"
}
Response
{
  "data": {
    "dictionaryLookupBatch": [
      {
        "word": "xyz789",
        "lang": "xyz789",
        "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

Arguments
Name Description
fileTransformerId - ID!
documentId - ID
projectSampleId - ID

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

Arguments
Name Description
fileTransformerId - ID!
content - String!

Example

Query
query ExecuteImportFileTransformer(
  $fileTransformerId: ID!,
  $content: String!
) {
  executeImportFileTransformer(
    fileTransformerId: $fileTransformerId,
    content: $content
  )
}
Variables
{
  "fileTransformerId": "4",
  "content": "abc123"
}
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": "xyz789",
      "fileUrlExpiredAt": "abc123",
      "queued": false,
      "redirect": "xyz789"
    }
  }
}

exportCustomReport

Description

Exports custom report.

Response

Returns an ExportRequestResult!

Arguments
Name Description
teamId - ID!
input - CustomReportBuilderInput!

Example

Query
query ExportCustomReport(
  $teamId: ID!,
  $input: CustomReportBuilderInput!
) {
  exportCustomReport(
    teamId: $teamId,
    input: $input
  ) {
    exportId
    fileUrl
    fileUrlExpiredAt
    queued
    redirect
  }
}
Variables
{"teamId": 4, "input": CustomReportBuilderInput}
Response
{
  "data": {
    "exportCustomReport": {
      "exportId": "4",
      "fileUrl": "xyz789",
      "fileUrlExpiredAt": "abc123",
      "queued": false,
      "redirect": "abc123"
    }
  }
}

exportLabelAccuracyChart

This Query will be removed in the future, please use exportChart with id=ACCURACY_PER_LABEL
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": "xyz789",
      "fileUrlExpiredAt": "abc123",
      "queued": true,
      "redirect": "xyz789"
    }
  }
}

exportTeamIAA

Please use exportTeamIAAV2 instead.
Description

Exports team IAA.

Response

Returns an ExportRequestResult!

Arguments
Name Description
teamId - ID!
labelSetSignatures - [String!]
method - IAAMethodName
projectIds - [ID!]

Example

Query
query ExportTeamIAA(
  $teamId: ID!,
  $labelSetSignatures: [String!],
  $method: IAAMethodName,
  $projectIds: [ID!]
) {
  exportTeamIAA(
    teamId: $teamId,
    labelSetSignatures: $labelSetSignatures,
    method: $method,
    projectIds: $projectIds
  ) {
    exportId
    fileUrl
    fileUrlExpiredAt
    queued
    redirect
  }
}
Variables
{
  "teamId": 4,
  "labelSetSignatures": ["abc123"],
  "method": "COHENS_KAPPA",
  "projectIds": ["4"]
}
Response
{
  "data": {
    "exportTeamIAA": {
      "exportId": "4",
      "fileUrl": "abc123",
      "fileUrlExpiredAt": "abc123",
      "queued": false,
      "redirect": "abc123"
    }
  }
}

exportTeamIAAV2

Description

Exports team IAA.

Response

Returns an ExportRequestResult!

Arguments
Name Description
input - IAAInput!

Example

Query
query ExportTeamIAAV2($input: IAAInput!) {
  exportTeamIAAV2(input: $input) {
    exportId
    fileUrl
    fileUrlExpiredAt
    queued
    redirect
  }
}
Variables
{"input": IAAInput}
Response
{
  "data": {
    "exportTeamIAAV2": {
      "exportId": "4",
      "fileUrl": "abc123",
      "fileUrlExpiredAt": "xyz789",
      "queued": false,
      "redirect": "abc123"
    }
  }
}

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": "abc123",
      "fileUrlExpiredAt": "xyz789",
      "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": "xyz789",
      "fileUrlExpiredAt": "xyz789",
      "queued": false,
      "redirect": "xyz789"
    }
  }
}

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": "xyz789",
      "fileUrlExpiredAt": "xyz789",
      "queued": false,
      "redirect": "xyz789"
    }
  }
}

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": "abc123",
      "fileUrlExpiredAt": "abc123",
      "queued": false,
      "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": "xyz789",
        "downloadUrl": "abc123",
        "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
      allowedASRProviders
      allowedReviewerExportMethods
      commentNotificationType
      customAPICreationLimit
      defaultCustomTextExtractionAPIId
      defaultExternalObjectStorageId
      enableActions
      enableAddDocumentsToProject
      enableAssistedLabeling
      enableDemo
      enableDataProgramming
      enableLabelingFunctionMultipleLabel
      enableDatasaurAssistRowBased
      enableDatasaurDinamicTokenBased
      enableDatasaurPredictiveRowBased
      enableWipeData
      enableExportTeamOverview
      enableTransferOwnership
      allowedExtraAutoLabelProviders
      enableLLMProject
      enableUserProvidedCredentials
    }
    owner {
      id
      username
      name
      email
      package
      profilePicture
      allowedActions
      displayName
      teamPackage
      emailVerified
      totpAuthEnabled
      companyName
      signUpParams {
        ...SignUpParamsFragment
      }
    }
    isExpired
    expiredAt
  }
}
Response
{
  "data": {
    "getAllTeams": [
      {
        "id": 4,
        "logoURL": "xyz789",
        "members": [TeamMember],
        "membersScalar": TeamMembersScalar,
        "name": "xyz789",
        "setting": TeamSetting,
        "owner": User,
        "isExpired": false,
        "expiredAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

getAllowedIPs

Response

Returns [String!]!

Example

Query
query GetAllowedIPs {
  getAllowedIPs
}
Response
{"data": {"getAllowedIPs": ["xyz789"]}}

getAnalyticsLastUpdatedAt

This Query will be removed in the future, please do not use it anymore.
Response

Returns a String!

Example

Query
query GetAnalyticsLastUpdatedAt {
  getAnalyticsLastUpdatedAt
}
Response
{
  "data": {
    "getAnalyticsLastUpdatedAt": "abc123"
  }
}

getAutoLabel

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": "abc123",
        "deleted": true,
        "layer": 123,
        "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": "abc123",
        "shapes": [BBoxShape]
      }
    ]
  }
}

getBoundingBoxConflictList

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": false,
      "items": [ConflictBoundingBoxLabel]
    }
  }
}

getBoundingBoxLabels

Response

Returns [BoundingBoxLabel!]!

Arguments
Name Description
documentId - ID!
startCellLine - Int
endCellLine - Int

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": 987, "endCellLine": 123}
Response
{
  "data": {
    "getBoundingBoxLabels": [
      {
        "id": "4",
        "documentId": 4,
        "coordinates": [Coordinate],
        "counter": 987,
        "pageIndex": 987,
        "layer": 123,
        "position": TextRange,
        "hashCode": "xyz789",
        "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": 123}
    ]
  }
}

getBuiltInProjectTemplates

Description

Fetches built-in project templates. Returns the new ProjectTemplateV2 structure. If you are looking for custom templates created in team workspaces, use getProjectTemplatesV2 instead.

Response

Returns [ProjectTemplateV2!]!

Example

Query
query GetBuiltInProjectTemplates {
  getBuiltInProjectTemplates {
    id
    name
    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
    type
    description
    imagePreviewURL
    videoURL
  }
}
Response
{
  "data": {
    "getBuiltInProjectTemplates": [
      {
        "id": 4,
        "name": "xyz789",
        "logoURL": "xyz789",
        "projectTemplateProjectSettingId": 4,
        "projectTemplateTextDocumentSettingId": 4,
        "projectTemplateProjectSetting": ProjectTemplateProjectSetting,
        "projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
        "labelSetTemplates": [LabelSetTemplate],
        "questionSets": [QuestionSet],
        "createdAt": "xyz789",
        "updatedAt": "xyz789",
        "purpose": "LABELING",
        "creatorId": 4,
        "type": "CUSTOM",
        "description": "xyz789",
        "imagePreviewURL": "xyz789",
        "videoURL": "xyz789"
      }
    ]
  }
}

getCabinet

Description

Returns the specified project's cabinet. Contains list of documents. To get a project's ID, see getProjects.

Response

Returns a Cabinet!

Arguments
Name Description
projectId - ID!
role - Role!

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
      signUpParams {
        ...SignUpParamsFragment
      }
    }
    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"
    }
  }
}

getCabinetDocumentCompletionStates

Response

Returns [DocumentCompletionState!]!

Arguments
Name Description
cabinetId - ID!

Example

Query
query GetCabinetDocumentCompletionStates($cabinetId: ID!) {
  getCabinetDocumentCompletionStates(cabinetId: $cabinetId) {
    id
    isCompleted
  }
}
Variables
{"cabinetId": "4"}
Response
{
  "data": {
    "getCabinetDocumentCompletionStates": [{"id": 4, "isCompleted": true}]
  }
}

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": "xyz789",
        "lines": [123]
      }
    ]
  }
}

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": "xyz789",
        "index": 123,
        "signature": "abc123",
        "tagItems": [TagItem],
        "lastUsedBy": LastUsedProject,
        "arrowLabelRequired": true
      }
    ]
  }
}

getCellPositionsByMetadata

Description

Returns a paginated list of Cell positions along with its origin document ID.

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": "xyz789"
}
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": "xyz789",
        "type": "GROUPED",
        "level": "TEAM",
        "set": ["OLD"],
        "dataTableHeaders": ["abc123"],
        "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]
    }
  }
}

getConfusionMatrixTables

Arguments
Name Description
input - GetConfusionMatrixTablesInput!

Example

Query
query GetConfusionMatrixTables($input: GetConfusionMatrixTablesInput!) {
  getConfusionMatrixTables(input: $input) {
    projectKind
    confusionMatrixTable {
      matrixClasses {
        ...MatrixClassFragment
      }
      data {
        ...MatrixDataFragment
      }
    }
  }
}
Variables
{"input": GetConfusionMatrixTablesInput}
Response
{
  "data": {
    "getConfusionMatrixTables": [
      {
        "projectKind": "DOCUMENT_BASED",
        "confusionMatrixTable": ConfusionMatrixTable
      }
    ]
  }
}

getCreateProjectAction

Description

Get details of a create project Action. Parameters: automationId: ID of the Action

Response

Returns a CreateProjectAction!

Arguments
Name Description
teamId - ID!
actionId - ID!

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": "xyz789",
      "creatorId": 4,
      "lastRunAt": "xyz789",
      "lastFinishedAt": "xyz789",
      "externalObjectStorageId": 4,
      "externalObjectStorage": ExternalObjectStorage,
      "externalObjectStoragePathInput": "xyz789",
      "externalObjectStoragePathResult": "xyz789",
      "projectTemplateId": 4,
      "projectTemplate": ProjectTemplate,
      "assignments": [CreateProjectActionAssignment],
      "additionalTagNames": ["abc123"],
      "numberOfLabelersPerProject": 987,
      "numberOfReviewersPerProject": 123,
      "numberOfLabelersPerDocument": 123,
      "conflictResolutionMode": "MANUAL",
      "consensus": 987,
      "warnings": ["ASSIGNED_LABELER_NOT_MEET_CONSENSUS"]
    }
  }
}

getCreateProjectActionRunDetails

Description

Get all details of a create project Action run. Parameters: input: ProjectCreationAutomationActivityDetailPaginationInput

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": 987,
      "pageInfo": PageInfo,
      "nodes": [CreateProjectActionRunDetail]
    }
  }
}

getCreateProjectActionRuns

Description

Get all activities of a create project Action. Parameters: input: ProjectCreationAutomationPaginationInput

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": "xyz789",
        "teamId": 4,
        "appVersion": "xyz789",
        "creatorId": 4,
        "lastRunAt": "xyz789",
        "lastFinishedAt": "abc123",
        "externalObjectStorageId": "4",
        "externalObjectStorage": ExternalObjectStorage,
        "externalObjectStoragePathInput": "abc123",
        "externalObjectStoragePathResult": "xyz789",
        "projectTemplateId": "4",
        "projectTemplate": ProjectTemplate,
        "assignments": [CreateProjectActionAssignment],
        "additionalTagNames": ["abc123"],
        "numberOfLabelersPerProject": 123,
        "numberOfReviewersPerProject": 123,
        "numberOfLabelersPerDocument": 987,
        "conflictResolutionMode": "MANUAL",
        "consensus": 123,
        "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
      signUpParams {
        ...SignUpParamsFragment
      }
    }
    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": "xyz789",
      "isDeleted": false,
      "joinedDate": "abc123",
      "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": "abc123",
        "name": "xyz789",
        "purpose": "ASR_API"
      }
    ]
  }
}

getCustomReportMetricsGroupTables

Description

Returns custom report metrics group tables. Default dataSet is METABASE.

Arguments
Name Description
dataSet - CustomReportDataSet

Example

Query
query GetCustomReportMetricsGroupTables($dataSet: CustomReportDataSet) {
  getCustomReportMetricsGroupTables(dataSet: $dataSet) {
    id
    name
    description
    clientSegments
    metrics
    filterStrategies
  }
}
Variables
{"dataSet": "METABASE"}
Response
{
  "data": {
    "getCustomReportMetricsGroupTables": [
      {
        "id": 4,
        "name": "abc123",
        "description": "abc123",
        "clientSegments": ["DATE"],
        "metrics": ["LABELS_ACCURACY"],
        "filterStrategies": ["CONTAINS"]
      }
    ]
  }
}

getCustomReportPreview

Description

Preview custom report.

Response

Returns a CustomReportPreviewData!

Arguments
Name Description
teamId - ID!
input - CustomReportBuilderInput!

Example

Query
query GetCustomReportPreview(
  $teamId: ID!,
  $input: CustomReportBuilderInput!
) {
  getCustomReportPreview(
    teamId: $teamId,
    input: $input
  ) {
    rows
  }
}
Variables
{"teamId": 4, "input": CustomReportBuilderInput}
Response
{
  "data": {
    "getCustomReportPreview": {
      "rows": [CustomReportRowScalar]
    }
  }
}

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

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": 123.45,
        "coverage": 987.65,
        "overlap": 123.45,
        "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
      documentIds
    }
  }
}
Variables
{"input": GetDataProgrammingPredictionsInput}
Response
{
  "data": {
    "getDataProgrammingPredictions": {
      "id": "abc123",
      "status": "DELIVERED",
      "progress": 987,
      "errors": [JobError],
      "resultId": "abc123",
      "result": JobResult,
      "createdAt": "xyz789",
      "updatedAt": "abc123",
      "additionalData": JobAdditionalData
    }
  }
}

getDatasaurDinamicRowBased

Response

Returns a DatasaurDinamicRowBased

Arguments
Name Description
input - GetDatasaurDinamicRowBasedInput!

Example

Query
query GetDatasaurDinamicRowBased($input: GetDatasaurDinamicRowBasedInput!) {
  getDatasaurDinamicRowBased(input: $input) {
    id
    projectId
    provider
    inputColumns
    questionColumn
    providerSetting
    modelMetadata
    trainingJobId
    createdAt
    updatedAt
  }
}
Variables
{"input": GetDatasaurDinamicRowBasedInput}
Response
{
  "data": {
    "getDatasaurDinamicRowBased": {
      "id": "4",
      "projectId": "4",
      "provider": "HUGGINGFACE",
      "inputColumns": [123],
      "questionColumn": 123,
      "providerSetting": ProviderSetting,
      "modelMetadata": ModelMetadata,
      "trainingJobId": "4",
      "createdAt": "abc123",
      "updatedAt": "xyz789"
    }
  }
}

getDatasaurDinamicRowBasedProviders

Example

Query
query GetDatasaurDinamicRowBasedProviders {
  getDatasaurDinamicRowBasedProviders {
    name
    provider
  }
}
Response
{
  "data": {
    "getDatasaurDinamicRowBasedProviders": [
      {
        "name": "xyz789",
        "provider": "HUGGINGFACE"
      }
    ]
  }
}

getDatasaurDinamicTokenBased

Response

Returns a DatasaurDinamicTokenBased

Arguments
Name Description
input - GetDatasaurDinamicTokenBasedInput!

Example

Query
query GetDatasaurDinamicTokenBased($input: GetDatasaurDinamicTokenBasedInput!) {
  getDatasaurDinamicTokenBased(input: $input) {
    id
    projectId
    provider
    targetLabelSetIndex
    providerSetting
    modelMetadata
    trainingJobId
    createdAt
    updatedAt
  }
}
Variables
{"input": GetDatasaurDinamicTokenBasedInput}
Response
{
  "data": {
    "getDatasaurDinamicTokenBased": {
      "id": "4",
      "projectId": 4,
      "provider": "HUGGINGFACE",
      "targetLabelSetIndex": 987,
      "providerSetting": ProviderSetting,
      "modelMetadata": ModelMetadata,
      "trainingJobId": 4,
      "createdAt": "xyz789",
      "updatedAt": "abc123"
    }
  }
}

getDatasaurDinamicTokenBasedProviders

Example

Query
query GetDatasaurDinamicTokenBasedProviders {
  getDatasaurDinamicTokenBasedProviders {
    name
    provider
  }
}
Response
{
  "data": {
    "getDatasaurDinamicTokenBasedProviders": [
      {
        "name": "abc123",
        "provider": "HUGGINGFACE"
      }
    ]
  }
}

getDatasaurPredictive

Response

Returns a DatasaurPredictive

Arguments
Name Description
input - GetDatasaurPredictiveInput!

Example

Query
query GetDatasaurPredictive($input: GetDatasaurPredictiveInput!) {
  getDatasaurPredictive(input: $input) {
    id
    projectId
    provider
    inputColumns
    questionColumn
    providerSetting
    modelMetadata
    trainingJobId
    createdAt
    updatedAt
  }
}
Variables
{"input": GetDatasaurPredictiveInput}
Response
{
  "data": {
    "getDatasaurPredictive": {
      "id": "4",
      "projectId": 4,
      "provider": "SETFIT",
      "inputColumns": [987],
      "questionColumn": 123,
      "providerSetting": ProviderSetting,
      "modelMetadata": ModelMetadata,
      "trainingJobId": 4,
      "createdAt": "xyz789",
      "updatedAt": "xyz789"
    }
  }
}

getDatasaurPredictiveProviders

Example

Query
query GetDatasaurPredictiveProviders {
  getDatasaurPredictiveProviders {
    name
    provider
  }
}
Response
{
  "data": {
    "getDatasaurPredictiveProviders": [
      {
        "name": "xyz789",
        "provider": "SETFIT"
      }
    ]
  }
}

getDataset

Response

Returns a Dataset

Arguments
Name Description
id - ID!

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": 987,
      "cabinetIds": [CabinetDocumentIds],
      "createdAt": "xyz789",
      "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": 987,
      "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": 123,
        "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
    metadata {
      path
      labeledBy
      createdAt
      updatedAt
    }
    updatedAt
  }
}
Variables
{"documentId": "4"}
Response
{
  "data": {
    "getDocumentAnswers": {
      "documentId": 4,
      "answers": AnswerScalar,
      "metadata": [AnswerMetadata],
      "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": 123,
        "cabinetId": 123,
        "name": "abc123",
        "width": "xyz789",
        "displayed": false,
        "labelerRestricted": true,
        "rowQuestionIndex": 123
      }
    ]
  }
}

getDocumentNames

Description

Returns the specified project's document names.

Response

Returns [String!]!

Arguments
Name Description
projectId - ID!
role - Role!

Example

Query
query GetDocumentNames(
  $projectId: ID!,
  $role: Role!
) {
  getDocumentNames(
    projectId: $projectId,
    role: $role
  )
}
Variables
{"projectId": "4", "role": "REVIEWER"}
Response
{"data": {"getDocumentNames": ["abc123"]}}

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": false,
        "config": QuestionConfig,
        "bindToColumn": "abc123",
        "activationConditionLogic": "xyz789"
      }
    ]
  }
}

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]
    }
  }
}

getEvaluationMetric

Response

Returns [ProjectEvaluationMetric!]!

Arguments
Name Description
input - GetEvaluationMetricInput!

Example

Query
query GetEvaluationMetric($input: GetEvaluationMetricInput!) {
  getEvaluationMetric(input: $input) {
    projectKind
    metric {
      accuracy
      precision
      recall
      f1Score
      lastUpdatedTime
    }
  }
}
Variables
{"input": GetEvaluationMetricInput}
Response
{
  "data": {
    "getEvaluationMetric": [
      {
        "projectKind": "DOCUMENT_BASED",
        "metric": EvaluationMetric
      }
    ]
  }
}

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": "abc123",
        "title": "xyz789",
        "url": "abc123",
        "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": "xyz789"
      }
    ]
  }
}

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": "xyz789",
        "sizeInBytes": 123
      }
    ]
  }
}

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
      region
      tenantUsername
    }
    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": "abc123",
      "transpiled": "xyz789",
      "createdAt": "abc123",
      "updatedAt": "xyz789",
      "language": "TYPESCRIPT",
      "purpose": "IMPORT",
      "readonly": false,
      "externalId": "abc123",
      "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": "abc123",
        "createdAt": "abc123",
        "updatedAt": "xyz789",
        "language": "TYPESCRIPT",
        "purpose": "IMPORT",
        "readonly": false,
        "externalId": "abc123",
        "warmup": false
      }
    ]
  }
}

getFreeTrialQuota

Breaking changes may be introduced anytime in the future without prior notice.
Response

Returns a FreeTrialQuotaResponse!

Arguments
Name Description
teamId - ID!

Example

Query
query GetFreeTrialQuota($teamId: ID!) {
  getFreeTrialQuota(teamId: $teamId) {
    runPromptCurrentAmount
    runPromptMaxAmount
    runPromptUnit
    embedDocumentCurrentAmount
    embedDocumentMaxAmount
    embedDocumentUnit
    embedDocumentUrlCurrentAmount
    embedDocumentUrlMaxAmount
    embedDocumentUrlUnit
    llmEvaluationCurrentAmount
    llmEvaluationMaxAmount
    llmEvaluationUnit
  }
}
Variables
{"teamId": "4"}
Response
{
  "data": {
    "getFreeTrialQuota": {
      "runPromptCurrentAmount": 123,
      "runPromptMaxAmount": 987,
      "runPromptUnit": "xyz789",
      "embedDocumentCurrentAmount": 123,
      "embedDocumentMaxAmount": 123,
      "embedDocumentUnit": "abc123",
      "embedDocumentUrlCurrentAmount": 123,
      "embedDocumentUrlMaxAmount": 987,
      "embedDocumentUrlUnit": "abc123",
      "llmEvaluationCurrentAmount": 987,
      "llmEvaluationMaxAmount": 987,
      "llmEvaluationUnit": "xyz789"
    }
  }
}

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": false,
      "jumpToNextDocumentOnSubmit": false,
      "jumpToNextSpanOnSubmit": true,
      "multipleSelectLabels": true
    }
  }
}

getGrammarCheckerServiceProviders

Example

Query
query GetGrammarCheckerServiceProviders {
  getGrammarCheckerServiceProviders {
    id
    name
    description
  }
}
Response
{
  "data": {
    "getGrammarCheckerServiceProviders": [
      {
        "id": 4,
        "name": "abc123",
        "description": "abc123"
      }
    ]
  }
}

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": "xyz789",
        "position": TextRange,
        "suggestions": ["abc123"]
      }
    ]
  }
}

getGroundTruthSet

Breaking changes may be introduced anytime in the future without prior notice.
Response

Returns a GroundTruthSet!

Arguments
Name Description
id - ID!

Example

Query
query GetGroundTruthSet($id: ID!) {
  getGroundTruthSet(id: $id) {
    id
    name
    teamId
    createdByUserId
    createdByUser {
      id
      username
      name
      email
      package
      profilePicture
      allowedActions
      displayName
      teamPackage
      emailVerified
      totpAuthEnabled
      companyName
      signUpParams {
        ...SignUpParamsFragment
      }
    }
    items {
      id
      groundTruthSetId
      prompt
      answer
      createdAt
      updatedAt
    }
    itemsCount
    createdAt
    updatedAt
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getGroundTruthSet": {
      "id": "4",
      "name": "abc123",
      "teamId": 4,
      "createdByUserId": 4,
      "createdByUser": User,
      "items": [GroundTruth],
      "itemsCount": 123,
      "createdAt": "xyz789",
      "updatedAt": "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": "xyz789",
        "content": "xyz789",
        "project": Project
      }
    ]
  }
}

getIAAInformation

Response

Returns an IAAInformation!

Arguments
Name Description
input - IAAInput!

Example

Query
query GetIAAInformation($input: IAAInput!) {
  getIAAInformation(input: $input) {
    agreements {
      userId1
      userId2
      agreement
    }
    lastUpdatedTime
  }
}
Variables
{"input": IAAInput}
Response
{
  "data": {
    "getIAAInformation": {
      "agreements": [IAA],
      "lastUpdatedTime": "abc123"
    }
  }
}

getIAALastUpdatedAt

Please use getIAAInformation instead.
Response

Returns a String!

Arguments
Name Description
teamId - ID!
labelSetSignatures - [String!]
method - IAAMethodName
projectIds - [ID!]

Example

Query
query GetIAALastUpdatedAt(
  $teamId: ID!,
  $labelSetSignatures: [String!],
  $method: IAAMethodName,
  $projectIds: [ID!]
) {
  getIAALastUpdatedAt(
    teamId: $teamId,
    labelSetSignatures: $labelSetSignatures,
    method: $method,
    projectIds: $projectIds
  )
}
Variables
{
  "teamId": 4,
  "labelSetSignatures": ["abc123"],
  "method": "COHENS_KAPPA",
  "projectIds": ["4"]
}
Response
{"data": {"getIAALastUpdatedAt": "xyz789"}}

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]
      }
    ]
  }
}

getInvoiceUrl

Breaking changes may be introduced anytime in the future without prior notice.
Response

Returns a String!

Arguments
Name Description
teamId - ID!

Example

Query
query GetInvoiceUrl($teamId: ID!) {
  getInvoiceUrl(teamId: $teamId)
}
Variables
{"teamId": 4}
Response
{"data": {"getInvoiceUrl": "abc123"}}

getJob

Description

Get a specific Job by its ID. Can be used to check the status of a ProjectLaunchJob.

Response

Returns a Job

Arguments
Name Description
jobId - String! Job ID.

Example

Query
query GetJob($jobId: String!) {
  getJob(jobId: $jobId) {
    id
    status
    progress
    errors {
      id
      stack
      args
    }
    resultId
    result
    createdAt
    updatedAt
    additionalData {
      actionRunId
      childrenJobIds
      documentIds
    }
  }
}
Variables
{"jobId": "abc123"}
Response
{
  "data": {
    "getJob": {
      "id": "xyz789",
      "status": "DELIVERED",
      "progress": 987,
      "errors": [JobError],
      "resultId": "abc123",
      "result": JobResult,
      "createdAt": "abc123",
      "updatedAt": "xyz789",
      "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
      documentIds
    }
  }
}
Variables
{"jobIds": ["xyz789"]}
Response
{
  "data": {
    "getJobs": [
      {
        "id": "abc123",
        "status": "DELIVERED",
        "progress": 987,
        "errors": [JobError],
        "resultId": "xyz789",
        "result": JobResult,
        "createdAt": "abc123",
        "updatedAt": "xyz789",
        "additionalData": JobAdditionalData
      }
    ]
  }
}

getLabelAccuracyChart

This Query will be removed in the future, please use getChartData with chartId=ACCURACY_PER_LABEL
Response

Returns [Chart!]!

Arguments
Name Description
teamId - ID!

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": "abc123",
        "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
      signUpParams {
        ...SignUpParamsFragment
      }
    }
    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": "xyz789",
        "index": 987,
        "signature": "xyz789",
        "tagItems": [TagItem],
        "lastUsedBy": LastUsedProject,
        "arrowLabelRequired": true
      }
    ]
  }
}

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": "abc123",
      "content": "abc123",
      "active": true,
      "createdAt": "xyz789",
      "updatedAt": "xyz789"
    }
  }
}

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": "abc123",
        "active": false,
        "createdAt": "xyz789",
        "updatedAt": "xyz789"
      }
    ]
  }
}

getLabelingFunctionsPairKappa

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": "abc123"
}
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
      allowedASRProviders
      allowedReviewerExportMethods
      commentNotificationType
      customAPICreationLimit
      defaultCustomTextExtractionAPIId
      defaultExternalObjectStorageId
      enableActions
      enableAddDocumentsToProject
      enableAssistedLabeling
      enableDemo
      enableDataProgramming
      enableLabelingFunctionMultipleLabel
      enableDatasaurAssistRowBased
      enableDatasaurDinamicTokenBased
      enableDatasaurPredictiveRowBased
      enableWipeData
      enableExportTeamOverview
      enableTransferOwnership
      allowedExtraAutoLabelProviders
      enableLLMProject
      enableUserProvidedCredentials
    }
    owner {
      id
      username
      name
      email
      package
      profilePicture
      allowedActions
      displayName
      teamPackage
      emailVerified
      totpAuthEnabled
      companyName
      signUpParams {
        ...SignUpParamsFragment
      }
    }
    isExpired
    expiredAt
  }
}
Response
{
  "data": {
    "getLatestJoinedTeam": {
      "id": "4",
      "logoURL": "abc123",
      "members": [TeamMember],
      "membersScalar": TeamMembersScalar,
      "name": "abc123",
      "setting": TeamSetting,
      "owner": User,
      "isExpired": true,
      "expiredAt": "2007-12-03T10:15:30Z"
    }
  }
}

getLlmApplication

Breaking changes may be introduced anytime in the future without prior notice.
Response

Returns a LlmApplication

Arguments
Name Description
id - ID!

Example

Query
query GetLlmApplication($id: ID!) {
  getLlmApplication(id: $id) {
    id
    teamId
    createdByUser {
      id
      username
      name
      email
      package
      profilePicture
      allowedActions
      displayName
      teamPackage
      emailVerified
      totpAuthEnabled
      companyName
      signUpParams {
        ...SignUpParamsFragment
      }
    }
    name
    status
    createdAt
    updatedAt
    llmApplicationDeployment {
      id
      deployedByUser {
        ...UserFragment
      }
      llmApplicationId
      llmRagConfig {
        ...LlmRagConfigFragment
      }
      numberOfCalls
      numberOfTokens
      numberOfInputTokens
      numberOfOutputTokens
      deployedAt
      createdAt
      updatedAt
      apiEndpoints {
        ...LlmApplicationDeploymentApiEndpointFragment
      }
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getLlmApplication": {
      "id": 4,
      "teamId": 4,
      "createdByUser": User,
      "name": "abc123",
      "status": "DEPLOYED",
      "createdAt": "xyz789",
      "updatedAt": "xyz789",
      "llmApplicationDeployment": LlmApplicationDeployment
    }
  }
}

getLlmApplicationDeployment

Breaking changes may be introduced anytime in the future without prior notice.
Response

Returns a LlmApplicationDeployment

Arguments
Name Description
llmApplicationId - ID!

Example

Query
query GetLlmApplicationDeployment($llmApplicationId: ID!) {
  getLlmApplicationDeployment(llmApplicationId: $llmApplicationId) {
    id
    deployedByUser {
      id
      username
      name
      email
      package
      profilePicture
      allowedActions
      displayName
      teamPackage
      emailVerified
      totpAuthEnabled
      companyName
      signUpParams {
        ...SignUpParamsFragment
      }
    }
    llmApplicationId
    llmRagConfig {
      id
      llmModel {
        ...LlmModelFragment
      }
      systemInstruction
      userInstruction
      raw
      temperature
      topP
      maxTokens
      llmVectorStore {
        ...LlmVectorStoreFragment
      }
      similarityThreshold
      createdAt
      updatedAt
    }
    numberOfCalls
    numberOfTokens
    numberOfInputTokens
    numberOfOutputTokens
    deployedAt
    createdAt
    updatedAt
    apiEndpoints {
      type
      endpoint
    }
  }
}
Variables
{"llmApplicationId": "4"}
Response
{
  "data": {
    "getLlmApplicationDeployment": {
      "id": 4,
      "deployedByUser": User,
      "llmApplicationId": "4",
      "llmRagConfig": LlmRagConfig,
      "numberOfCalls": 987,
      "numberOfTokens": 987,
      "numberOfInputTokens": 123,
      "numberOfOutputTokens": 987,
      "deployedAt": "xyz789",
      "createdAt": "abc123",
      "updatedAt": "abc123",
      "apiEndpoints": [
        LlmApplicationDeploymentApiEndpoint
      ]
    }
  }
}

getLlmApplicationPlaygroundPrompt

Breaking changes may be introduced anytime in the future without prior notice.
Response

Returns a LlmApplicationPlaygroundPrompt

Arguments
Name Description
id - ID!

Example

Query
query GetLlmApplicationPlaygroundPrompt($id: ID!) {
  getLlmApplicationPlaygroundPrompt(id: $id) {
    id
    llmApplicationId
    name
    prompt
    createdAt
    updatedAt
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getLlmApplicationPlaygroundPrompt": {
      "id": "4",
      "llmApplicationId": 4,
      "name": "xyz789",
      "prompt": "abc123",
      "createdAt": "xyz789",
      "updatedAt": "abc123"
    }
  }
}

getLlmApplicationPlaygroundPrompts

Breaking changes may be introduced anytime in the future without prior notice.
Arguments
Name Description
llmApplicationId - ID!

Example

Query
query GetLlmApplicationPlaygroundPrompts($llmApplicationId: ID!) {
  getLlmApplicationPlaygroundPrompts(llmApplicationId: $llmApplicationId) {
    id
    llmApplicationId
    name
    prompt
    createdAt
    updatedAt
  }
}
Variables
{"llmApplicationId": "4"}
Response
{
  "data": {
    "getLlmApplicationPlaygroundPrompts": [
      {
        "id": 4,
        "llmApplicationId": 4,
        "name": "abc123",
        "prompt": "xyz789",
        "createdAt": "xyz789",
        "updatedAt": "xyz789"
      }
    ]
  }
}

getLlmApplicationPlaygroundRagConfig

Breaking changes may be introduced anytime in the future without prior notice.
Arguments
Name Description
id - ID!

Example

Query
query GetLlmApplicationPlaygroundRagConfig($id: ID!) {
  getLlmApplicationPlaygroundRagConfig(id: $id) {
    id
    llmApplicationId
    llmRagConfig {
      id
      llmModel {
        ...LlmModelFragment
      }
      systemInstruction
      userInstruction
      raw
      temperature
      topP
      maxTokens
      llmVectorStore {
        ...LlmVectorStoreFragment
      }
      similarityThreshold
      createdAt
      updatedAt
    }
    name
    createdAt
    updatedAt
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getLlmApplicationPlaygroundRagConfig": {
      "id": 4,
      "llmApplicationId": "4",
      "llmRagConfig": LlmRagConfig,
      "name": "xyz789",
      "createdAt": "xyz789",
      "updatedAt": "xyz789"
    }
  }
}

getLlmApplicationPlaygroundRagConfigs

Breaking changes may be introduced anytime in the future without prior notice.
Arguments
Name Description
llmApplicationId - ID!

Example

Query
query GetLlmApplicationPlaygroundRagConfigs($llmApplicationId: ID!) {
  getLlmApplicationPlaygroundRagConfigs(llmApplicationId: $llmApplicationId) {
    id
    llmApplicationId
    llmRagConfig {
      id
      llmModel {
        ...LlmModelFragment
      }
      systemInstruction
      userInstruction
      raw
      temperature
      topP
      maxTokens
      llmVectorStore {
        ...LlmVectorStoreFragment
      }
      similarityThreshold
      createdAt
      updatedAt
    }
    name
    createdAt
    updatedAt
  }
}
Variables
{"llmApplicationId": "4"}
Response
{
  "data": {
    "getLlmApplicationPlaygroundRagConfigs": [
      {
        "id": "4",
        "llmApplicationId": 4,
        "llmRagConfig": LlmRagConfig,
        "name": "xyz789",
        "createdAt": "xyz789",
        "updatedAt": "abc123"
      }
    ]
  }
}

getLlmApplications

Breaking changes may be introduced anytime in the future without prior notice.
Arguments
Name Description
input - GetLlmApplicationsPaginatedInput!

Example

Query
query GetLlmApplications($input: GetLlmApplicationsPaginatedInput!) {
  getLlmApplications(input: $input) {
    totalCount
    pageInfo {
      prevCursor
      nextCursor
    }
    nodes {
      id
      teamId
      createdByUser {
        ...UserFragment
      }
      name
      status
      createdAt
      updatedAt
      llmApplicationDeployment {
        ...LlmApplicationDeploymentFragment
      }
    }
  }
}
Variables
{"input": GetLlmApplicationsPaginatedInput}
Response
{
  "data": {
    "getLlmApplications": {
      "totalCount": 123,
      "pageInfo": PageInfo,
      "nodes": [LlmApplication]
    }
  }
}

getLlmEmbeddingModelMetadatas

Breaking changes may be introduced anytime in the future without prior notice.
Response

Returns [LlmModelMetadata!]!

Arguments
Name Description
teamId - ID!

Example

Query
query GetLlmEmbeddingModelMetadatas($teamId: ID!) {
  getLlmEmbeddingModelMetadatas(teamId: $teamId) {
    providers
    name
    displayName
    description
    type
    status
  }
}
Variables
{"teamId": "4"}
Response
{
  "data": {
    "getLlmEmbeddingModelMetadatas": [
      {
        "providers": ["AMAZON_SAGEMAKER_JUMPSTART"],
        "name": "abc123",
        "displayName": "xyz789",
        "description": "abc123",
        "type": "QUESTION_ANSWERING",
        "status": "AVAILABLE"
      }
    ]
  }
}

getLlmEmbeddingModelSpec

Breaking changes may be introduced anytime in the future without prior notice.
Response

Returns a LlmModelSpec!

Arguments
Name Description
teamId - ID!
provider - GqlLlmModelProvider!
name - String!

Example

Query
query GetLlmEmbeddingModelSpec(
  $teamId: ID!,
  $provider: GqlLlmModelProvider!,
  $name: String!
) {
  getLlmEmbeddingModelSpec(
    teamId: $teamId,
    provider: $provider,
    name: $name
  ) {
    supportedInferenceInstanceTypes
    supportedInferenceInstanceTypeDetails {
      name
      cost {
        ...LlmInstanceCostDetailFragment
      }
      createdAt
    }
  }
}
Variables
{
  "teamId": "4",
  "provider": "AMAZON_SAGEMAKER_JUMPSTART",
  "name": "abc123"
}
Response
{
  "data": {
    "getLlmEmbeddingModelSpec": {
      "supportedInferenceInstanceTypes": [
        "abc123"
      ],
      "supportedInferenceInstanceTypeDetails": [
        LlmInstanceTypeDetail
      ]
    }
  }
}

getLlmEmbeddingModels

Breaking changes may be introduced anytime in the future without prior notice.
Response

Returns [LlmEmbeddingModel!]!

Arguments
Name Description
teamId - ID!
includeDefault - Boolean

Example

Query
query GetLlmEmbeddingModels(
  $teamId: ID!,
  $includeDefault: Boolean
) {
  getLlmEmbeddingModels(
    teamId: $teamId,
    includeDefault: $includeDefault
  ) {
    id
    teamId
    provider
    name
    displayName
    url
    maxTokens
    dimensions
    detail {
      status
      instanceType
      instanceTypeDetail {
        ...LlmInstanceTypeDetailFragment
      }
    }
    createdAt
    updatedAt
    customDimension
  }
}
Variables
{"teamId": 4, "includeDefault": false}
Response
{
  "data": {
    "getLlmEmbeddingModels": [
      {
        "id": "4",
        "teamId": "4",
        "provider": "AMAZON_SAGEMAKER_JUMPSTART",
        "name": "xyz789",
        "displayName": "xyz789",
        "url": "xyz789",
        "maxTokens": 987,
        "dimensions": 123,
        "detail": LlmModelDetail,
        "createdAt": "abc123",
        "updatedAt": "abc123",
        "customDimension": true
      }
    ]
  }
}

getLlmEvaluation

Breaking changes may be introduced anytime in the future without prior notice.
Description

Retrieves one LlmEvaluation based on the provided id.

Response

Returns a LlmEvaluation!

Arguments
Name Description
id - ID!

Example

Query
query GetLlmEvaluation($id: ID!) {
  getLlmEvaluation(id: $id) {
    id
    name
    teamId
    projectId
    kind
    status
    creationProgress {
      status
      jobId
      error
    }
    llmEvaluationRagConfigs {
      id
      llmEvaluationId
      llmApplication {
        ...LlmApplicationFragment
      }
      llmPlaygroundRagConfig {
        ...LlmApplicationPlaygroundRagConfigFragment
      }
      llmDeploymentRagConfig {
        ...LlmApplicationDeploymentFragment
      }
      llmRagConfigId
      llmSnapshotRagConfig {
        ...LlmRagConfigFragment
      }
      createdAt
      updatedAt
    }
    llmEvaluationPrompts {
      id
      llmEvaluationId
      prompt
      createdAt
      updatedAt
    }
    createdAt
    updatedAt
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getLlmEvaluation": {
      "id": "4",
      "name": "abc123",
      "teamId": "4",
      "projectId": "4",
      "kind": "DOCUMENT_BASED",
      "status": "CREATED",
      "creationProgress": LlmEvaluationCreationProgress,
      "llmEvaluationRagConfigs": [LlmEvaluationRagConfig],
      "llmEvaluationPrompts": [LlmEvaluationPrompt],
      "createdAt": "xyz789",
      "updatedAt": "abc123"
    }
  }
}

getLlmEvaluationCreationProgress

Breaking changes may be introduced anytime in the future without prior notice.
Description

Retrieves the LLM evaluation creation progress.

Response

Returns a LlmEvaluationCreationProgress!

Arguments
Name Description
id - ID!

Example

Query
query GetLlmEvaluationCreationProgress($id: ID!) {
  getLlmEvaluationCreationProgress(id: $id) {
    status
    jobId
    error
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getLlmEvaluationCreationProgress": {
      "status": "PREPARING",
      "jobId": "abc123",
      "error": "abc123"
    }
  }
}

getLlmEvaluationReport

Response

Returns a Job!

Arguments
Name Description
projectId - String!

Example

Query
query GetLlmEvaluationReport($projectId: String!) {
  getLlmEvaluationReport(projectId: $projectId) {
    id
    status
    progress
    errors {
      id
      stack
      args
    }
    resultId
    result
    createdAt
    updatedAt
    additionalData {
      actionRunId
      childrenJobIds
      documentIds
    }
  }
}
Variables
{"projectId": "abc123"}
Response
{
  "data": {
    "getLlmEvaluationReport": {
      "id": "abc123",
      "status": "DELIVERED",
      "progress": 123,
      "errors": [JobError],
      "resultId": "abc123",
      "result": JobResult,
      "createdAt": "abc123",
      "updatedAt": "xyz789",
      "additionalData": JobAdditionalData
    }
  }
}

getLlmEvaluations

Breaking changes may be introduced anytime in the future without prior notice.
Description

Retrieves an array of LlmMEvaluation based on the provided filters.

Response

Returns a LlmEvaluationPaginatedResponse!

Arguments
Name Description
input - GetLlmEvaluationsPaginatedInput!

Example

Query
query GetLlmEvaluations($input: GetLlmEvaluationsPaginatedInput!) {
  getLlmEvaluations(input: $input) {
    totalCount
    pageInfo {
      prevCursor
      nextCursor
    }
    nodes {
      id
      name
      teamId
      projectId
      kind
      status
      creationProgress {
        ...LlmEvaluationCreationProgressFragment
      }
      llmEvaluationRagConfigs {
        ...LlmEvaluationRagConfigFragment
      }
      llmEvaluationPrompts {
        ...LlmEvaluationPromptFragment
      }
      createdAt
      updatedAt
    }
  }
}
Variables
{"input": GetLlmEvaluationsPaginatedInput}
Response
{
  "data": {
    "getLlmEvaluations": {
      "totalCount": 123,
      "pageInfo": PageInfo,
      "nodes": [LlmEvaluation]
    }
  }
}

getLlmModelMetadatas

Breaking changes may be introduced anytime in the future without prior notice.
Response

Returns [LlmModelMetadata!]!

Arguments
Name Description
teamId - ID!

Example

Query
query GetLlmModelMetadatas($teamId: ID!) {
  getLlmModelMetadatas(teamId: $teamId) {
    providers
    name
    displayName
    description
    type
    status
  }
}
Variables
{"teamId": "4"}
Response
{
  "data": {
    "getLlmModelMetadatas": [
      {
        "providers": ["AMAZON_SAGEMAKER_JUMPSTART"],
        "name": "abc123",
        "displayName": "abc123",
        "description": "xyz789",
        "type": "QUESTION_ANSWERING",
        "status": "AVAILABLE"
      }
    ]
  }
}

getLlmModelSpec

Breaking changes may be introduced anytime in the future without prior notice.
Response

Returns a LlmModelSpec!

Arguments
Name Description
teamId - ID!
provider - GqlLlmModelProvider!
name - String!

Example

Query
query GetLlmModelSpec(
  $teamId: ID!,
  $provider: GqlLlmModelProvider!,
  $name: String!
) {
  getLlmModelSpec(
    teamId: $teamId,
    provider: $provider,
    name: $name
  ) {
    supportedInferenceInstanceTypes
    supportedInferenceInstanceTypeDetails {
      name
      cost {
        ...LlmInstanceCostDetailFragment
      }
      createdAt
    }
  }
}
Variables
{
  "teamId": 4,
  "provider": "AMAZON_SAGEMAKER_JUMPSTART",
  "name": "xyz789"
}
Response
{
  "data": {
    "getLlmModelSpec": {
      "supportedInferenceInstanceTypes": [
        "abc123"
      ],
      "supportedInferenceInstanceTypeDetails": [
        LlmInstanceTypeDetail
      ]
    }
  }
}

getLlmModels

Breaking changes may be introduced anytime in the future without prior notice.
Response

Returns [LlmModel!]!

Arguments
Name Description
teamId - ID!

Example

Query
query GetLlmModels($teamId: ID!) {
  getLlmModels(teamId: $teamId) {
    id
    teamId
    provider
    name
    displayName
    url
    maxTemperature
    maxTopP
    maxTokens
    defaultTemperature
    defaultTopP
    defaultMaxTokens
    detail {
      status
      instanceType
      instanceTypeDetail {
        ...LlmInstanceTypeDetailFragment
      }
    }
    createdAt
    updatedAt
  }
}
Variables
{"teamId": "4"}
Response
{
  "data": {
    "getLlmModels": [
      {
        "id": "4",
        "teamId": 4,
        "provider": "AMAZON_SAGEMAKER_JUMPSTART",
        "name": "abc123",
        "displayName": "abc123",
        "url": "xyz789",
        "maxTemperature": 987.65,
        "maxTopP": 123.45,
        "maxTokens": 987,
        "defaultTemperature": 987.65,
        "defaultTopP": 987.65,
        "defaultMaxTokens": 987,
        "detail": LlmModelDetail,
        "createdAt": "xyz789",
        "updatedAt": "abc123"
      }
    ]
  }
}

getLlmUsageDetail

Response

Returns a LlmUsageDetail!

Arguments
Name Description
id - ID!

Example

Query
query GetLlmUsageDetail($id: ID!) {
  getLlmUsageDetail(id: $id) {
    documents {
      id
      name
      cost
      costCurrency
      usage
    }
    sourceDocuments {
      source {
        ...LlmUsageExternalSourceFragment
      }
      documents
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getLlmUsageDetail": {
      "documents": [LlmUsageDocument],
      "sourceDocuments": [LlmUsageSourceDocument]
    }
  }
}

getLlmUsageSummary

Response

Returns a LlmUsageSummary!

Arguments
Name Description
teamId - ID!
calendarDate - String!

Example

Query
query GetLlmUsageSummary(
  $teamId: ID!,
  $calendarDate: String!
) {
  getLlmUsageSummary(
    teamId: $teamId,
    calendarDate: $calendarDate
  ) {
    totalCost
    totalCostCurrency
    modelSummaries {
      modelName
      modelProvider
      totalUsage
    }
  }
}
Variables
{"teamId": 4, "calendarDate": "xyz789"}
Response
{
  "data": {
    "getLlmUsageSummary": {
      "totalCost": 123.45,
      "totalCostCurrency": "abc123",
      "modelSummaries": [LlmUsageModelSummary]
    }
  }
}

getLlmUsages

Response

Returns a LlmUsagePaginatedResponse!

Arguments
Name Description
input - GetLlmUsagesPaginatedInput!

Example

Query
query GetLlmUsages($input: GetLlmUsagesPaginatedInput!) {
  getLlmUsages(input: $input) {
    totalCount
    pageInfo {
      prevCursor
      nextCursor
    }
    nodes {
      id
      teamId
      name
      type
      modelDetail {
        ...LlmUsageModelDetailFragment
      }
      cost
      costCurrency
      usage
      createdAt
      updatedAt
    }
  }
}
Variables
{"input": GetLlmUsagesPaginatedInput}
Response
{
  "data": {
    "getLlmUsages": {
      "totalCount": 123,
      "pageInfo": PageInfo,
      "nodes": [LlmUsage]
    }
  }
}

getLlmVectorStore

Breaking changes may be introduced anytime in the future without prior notice.
Response

Returns a LlmVectorStore

Arguments
Name Description
id - ID!

Example

Query
query GetLlmVectorStore($id: ID!) {
  getLlmVectorStore(id: $id) {
    id
    teamId
    createdByUser {
      id
      username
      name
      email
      package
      profilePicture
      allowedActions
      displayName
      teamPackage
      emailVerified
      totpAuthEnabled
      companyName
      signUpParams {
        ...SignUpParamsFragment
      }
    }
    llmEmbeddingModel {
      id
      teamId
      provider
      name
      displayName
      url
      maxTokens
      dimensions
      detail {
        ...LlmModelDetailFragment
      }
      createdAt
      updatedAt
      customDimension
    }
    provider
    collectionId
    name
    status
    chunkSize
    overlap
    documents
    failedDocumentCount
    sourceDocuments {
      source {
        ...LlmVectorStoreSourceFragment
      }
      documents
    }
    questions {
      id
      internalId
      type
      name
      label
      required
      config {
        ...QuestionConfigFragment
      }
      bindToColumn
      activationConditionLogic
    }
    jobId
    createdAt
    updatedAt
    dimension
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getLlmVectorStore": {
      "id": 4,
      "teamId": 4,
      "createdByUser": User,
      "llmEmbeddingModel": LlmEmbeddingModel,
      "provider": "DATASAUR",
      "collectionId": "xyz789",
      "name": "xyz789",
      "status": "CREATED",
      "chunkSize": 987,
      "overlap": 123,
      "documents": [LlmVectorStoreDocumentScalar],
      "failedDocumentCount": 987,
      "sourceDocuments": [LlmVectorStoreSourceDocument],
      "questions": [Question],
      "jobId": "xyz789",
      "createdAt": "xyz789",
      "updatedAt": "abc123",
      "dimension": 123
    }
  }
}

getLlmVectorStoreActivities

Breaking changes may be introduced anytime in the future without prior notice.
Arguments
Name Description
input - GetLlmVectorStoreActivityInput

Example

Query
query GetLlmVectorStoreActivities($input: GetLlmVectorStoreActivityInput) {
  getLlmVectorStoreActivities(input: $input) {
    totalCount
    pageInfo {
      prevCursor
      nextCursor
    }
    nodes {
      id
      llmVectorStoreId
      llmVectorStoreName
      llmVectorStoreDocumentId
      llmVectorStoreDocumentName
      userId
      userName
      event
      details
      bucketName
      bucketSource
      createdAt
      updatedAt
    }
  }
}
Variables
{"input": GetLlmVectorStoreActivityInput}
Response
{
  "data": {
    "getLlmVectorStoreActivities": {
      "totalCount": 987,
      "pageInfo": PageInfo,
      "nodes": [LlmVectorStoreActivity]
    }
  }
}

getLlmVectorStoreAnswers

Breaking changes may be introduced anytime in the future without prior notice.
Response

Returns a LlmVectorStoreAnswer!

Arguments
Name Description
llmVectorStoreDocumentId - ID!

Example

Query
query GetLlmVectorStoreAnswers($llmVectorStoreDocumentId: ID!) {
  getLlmVectorStoreAnswers(llmVectorStoreDocumentId: $llmVectorStoreDocumentId) {
    llmVectorStoreDocumentId
    answers
    updatedAt
  }
}
Variables
{"llmVectorStoreDocumentId": "4"}
Response
{
  "data": {
    "getLlmVectorStoreAnswers": {
      "llmVectorStoreDocumentId": 4,
      "answers": AnswerScalar,
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

getLlmVectorStoreSourceDeletedDocuments

Breaking changes may be introduced anytime in the future without prior notice.
Arguments
Name Description
id - ID!

Example

Query
query GetLlmVectorStoreSourceDeletedDocuments($id: ID!) {
  getLlmVectorStoreSourceDeletedDocuments(id: $id)
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getLlmVectorStoreSourceDeletedDocuments": LlmVectorStoreSourceDocumentScalar
  }
}

getLlmVectorStoreSourceNewDocuments

Breaking changes may be introduced anytime in the future without prior notice.
Arguments
Name Description
llmVectorStoreId - ID!
input - LlmVectorStoreSourceCreateInput!

Example

Query
query GetLlmVectorStoreSourceNewDocuments(
  $llmVectorStoreId: ID!,
  $input: LlmVectorStoreSourceCreateInput!
) {
  getLlmVectorStoreSourceNewDocuments(
    llmVectorStoreId: $llmVectorStoreId,
    input: $input
  )
}
Variables
{
  "llmVectorStoreId": "4",
  "input": LlmVectorStoreSourceCreateInput
}
Response
{
  "data": {
    "getLlmVectorStoreSourceNewDocuments": LlmVectorStoreSourceDocumentScalar
  }
}

getLlmVectorStoreSourceUpdatedDocuments

Breaking changes may be introduced anytime in the future without prior notice.
Arguments
Name Description
input - LlmVectorStoreSourceUpdateInput!

Example

Query
query GetLlmVectorStoreSourceUpdatedDocuments($input: LlmVectorStoreSourceUpdateInput!) {
  getLlmVectorStoreSourceUpdatedDocuments(input: $input)
}
Variables
{"input": LlmVectorStoreSourceUpdateInput}
Response
{
  "data": {
    "getLlmVectorStoreSourceUpdatedDocuments": LlmVectorStoreSourceDocumentScalar
  }
}

getLlmVectorStores

Breaking changes may be introduced anytime in the future without prior notice.
Arguments
Name Description
input - GetLlmVectorStoresPaginatedInput!

Example

Query
query GetLlmVectorStores($input: GetLlmVectorStoresPaginatedInput!) {
  getLlmVectorStores(input: $input) {
    totalCount
    pageInfo {
      prevCursor
      nextCursor
    }
    nodes {
      id
      teamId
      createdByUser {
        ...UserFragment
      }
      llmEmbeddingModel {
        ...LlmEmbeddingModelFragment
      }
      provider
      collectionId
      name
      status
      chunkSize
      overlap
      documents
      failedDocumentCount
      sourceDocuments {
        ...LlmVectorStoreSourceDocumentFragment
      }
      questions {
        ...QuestionFragment
      }
      jobId
      createdAt
      updatedAt
      dimension
    }
  }
}
Variables
{"input": GetLlmVectorStoresPaginatedInput}
Response
{
  "data": {
    "getLlmVectorStores": {
      "totalCount": 987,
      "pageInfo": PageInfo,
      "nodes": [LlmVectorStore]
    }
  }
}

getMarkedUnusedLabelClassIds

Description

Get all label class ids which are marked as N/A.

Arguments
Name Description
documentId - ID!
labelSetIds - [ID!]!

Example

Query
query GetMarkedUnusedLabelClassIds(
  $documentId: ID!,
  $labelSetIds: [ID!]!
) {
  getMarkedUnusedLabelClassIds(
    documentId: $documentId,
    labelSetIds: $labelSetIds
  ) {
    documentId
    labelSetId
    labelClassIds
  }
}
Variables
{"documentId": "4", "labelSetIds": [4]}
Response
{
  "data": {
    "getMarkedUnusedLabelClassIds": [
      {
        "documentId": "4",
        "labelSetId": "4",
        "labelClassIds": ["xyz789"]
      }
    ]
  }
}

getMlModel

Response

Returns a MlModel

Arguments
Name Description
id - ID!

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": 123,
      "createdAt": "xyz789",
      "updatedAt": "abc123"
    }
  }
}

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": 123,
      "inProgress": 123,
      "created": 987
    }
  }
}

getPaginatedChartData

This Query will be removed in the future, please use getCharts.
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": 987,
      "pageInfo": PageInfo,
      "nodes": [ChartDataRow]
    }
  }
}

getPaginatedGroundTruthSet

Breaking changes may be introduced anytime in the future without prior notice.
Arguments
Name Description
input - GetPaginatedGroundTruthSetInput!

Example

Query
query GetPaginatedGroundTruthSet($input: GetPaginatedGroundTruthSetInput!) {
  getPaginatedGroundTruthSet(input: $input) {
    totalCount
    pageInfo {
      prevCursor
      nextCursor
    }
    nodes {
      id
      name
      teamId
      createdByUserId
      createdByUser {
        ...UserFragment
      }
      items {
        ...GroundTruthFragment
      }
      itemsCount
      createdAt
      updatedAt
    }
  }
}
Variables
{"input": GetPaginatedGroundTruthSetInput}
Response
{
  "data": {
    "getPaginatedGroundTruthSet": {
      "totalCount": 123,
      "pageInfo": PageInfo,
      "nodes": [GroundTruthSet]
    }
  }
}

getPaginatedGroundTruthSetItems

Breaking changes may be introduced anytime in the future without prior notice.
Arguments
Name Description
input - GetPaginatedGroundTruthSetItemsInput!

Example

Query
query GetPaginatedGroundTruthSetItems($input: GetPaginatedGroundTruthSetItemsInput!) {
  getPaginatedGroundTruthSetItems(input: $input) {
    totalCount
    pageInfo {
      prevCursor
      nextCursor
    }
    nodes {
      id
      groundTruthSetId
      prompt
      answer
      createdAt
      updatedAt
    }
  }
}
Variables
{"input": GetPaginatedGroundTruthSetItemsInput}
Response
{
  "data": {
    "getPaginatedGroundTruthSetItems": {
      "totalCount": 987,
      "pageInfo": PageInfo,
      "nodes": [GroundTruth]
    }
  }
}

getPaginatedQuestionSets

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": 987,
      "pageInfo": PageInfo,
      "nodes": [QuestionSet]
    }
  }
}

getPairKappas

Please use getIAAInformation instead.
Response

Returns [PairKappa!]!

Arguments
Name Description
teamId - ID!
labelSetSignatures - [String!]
method - IAAMethodName
projectIds - [ID!]

Example

Query
query GetPairKappas(
  $teamId: ID!,
  $labelSetSignatures: [String!],
  $method: IAAMethodName,
  $projectIds: [ID!]
) {
  getPairKappas(
    teamId: $teamId,
    labelSetSignatures: $labelSetSignatures,
    method: $method,
    projectIds: $projectIds
  ) {
    userId1
    userId2
    kappa
  }
}
Variables
{
  "teamId": "4",
  "labelSetSignatures": ["abc123"],
  "method": "COHENS_KAPPA",
  "projectIds": ["4"]
}
Response
{"data": {"getPairKappas": [{"userId1": 987, "userId2": 123, "kappa": 123.45}]}}

getPaymentMethod

Breaking changes may be introduced anytime in the future without prior notice.
Response

Returns a PaymentMethod!

Arguments
Name Description
teamId - ID!
stripePaymentMethodId - String

Example

Query
query GetPaymentMethod(
  $teamId: ID!,
  $stripePaymentMethodId: String
) {
  getPaymentMethod(
    teamId: $teamId,
    stripePaymentMethodId: $stripePaymentMethodId
  ) {
    hasPaymentMethod
    detail {
      type
      fundingType
      displayBrand
      creditCardLastFourNumber
      creditCardExpiryMonth
      creditCardExpiryYear
      markedForRemoval
      createdAt
      updatedAt
    }
  }
}
Variables
{
  "teamId": "4",
  "stripePaymentMethodId": "abc123"
}
Response
{
  "data": {
    "getPaymentMethod": {
      "hasPaymentMethod": false,
      "detail": PaymentMethodDetail
    }
  }
}

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": "xyz789",
        "globalTag": true
      }
    ]
  }
}

getPinnedProjectTemplates

Response

Returns [ProjectTemplateV2!]!

Arguments
Name Description
teamId - ID!

Example

Query
query GetPinnedProjectTemplates($teamId: ID!) {
  getPinnedProjectTemplates(teamId: $teamId) {
    id
    name
    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
    type
    description
    imagePreviewURL
    videoURL
  }
}
Variables
{"teamId": 4}
Response
{
  "data": {
    "getPinnedProjectTemplates": [
      {
        "id": 4,
        "name": "abc123",
        "logoURL": "xyz789",
        "projectTemplateProjectSettingId": "4",
        "projectTemplateTextDocumentSettingId": 4,
        "projectTemplateProjectSetting": ProjectTemplateProjectSetting,
        "projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
        "labelSetTemplates": [LabelSetTemplate],
        "questionSets": [QuestionSet],
        "createdAt": "abc123",
        "updatedAt": "xyz789",
        "purpose": "LABELING",
        "creatorId": 4,
        "type": "CUSTOM",
        "description": "abc123",
        "imagePreviewURL": "abc123",
        "videoURL": "abc123"
      }
    ]
  }
}

getPlaygroundCostPrediction

Breaking changes may be introduced anytime in the future without prior notice.
Response

Returns a CostPredictionResponse!

Arguments
Name Description
llmApplicationId - ID!
promptId - ID!
playgroundRagConfigIds - [ID!]

Example

Query
query GetPlaygroundCostPrediction(
  $llmApplicationId: ID!,
  $promptId: ID!,
  $playgroundRagConfigIds: [ID!]
) {
  getPlaygroundCostPrediction(
    llmApplicationId: $llmApplicationId,
    promptId: $promptId,
    playgroundRagConfigIds: $playgroundRagConfigIds
  ) {
    costPerPromptTemplate {
      promptTemplateName
      modelName
      tokens {
        ...TokenUsagesFragment
      }
      tokenUnitPrices {
        ...TokenUnitPricesFragment
      }
      tokenPrices {
        ...TokenPricesFragment
      }
    }
    totalTokens
    totalPrice
  }
}
Variables
{
  "llmApplicationId": "4",
  "promptId": 4,
  "playgroundRagConfigIds": [4]
}
Response
{
  "data": {
    "getPlaygroundCostPrediction": {
      "costPerPromptTemplate": [
        PromptTemplateCostPrediction
      ],
      "totalTokens": 123,
      "totalPrice": 987.65
    }
  }
}

getPlaygroundCreditCost

Breaking changes may be introduced anytime in the future without prior notice.
Response

Returns an Int!

Arguments
Name Description
llmApplicationId - ID!
playgroundPromptIds - [ID]!
playgroundRagConfigIds - [ID!]

Example

Query
query GetPlaygroundCreditCost(
  $llmApplicationId: ID!,
  $playgroundPromptIds: [ID]!,
  $playgroundRagConfigIds: [ID!]
) {
  getPlaygroundCreditCost(
    llmApplicationId: $llmApplicationId,
    playgroundPromptIds: $playgroundPromptIds,
    playgroundRagConfigIds: $playgroundRagConfigIds
  )
}
Variables
{
  "llmApplicationId": "4",
  "playgroundPromptIds": ["4"],
  "playgroundRagConfigIds": ["4"]
}
Response
{"data": {"getPlaygroundCreditCost": 987}}

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
      signUpParams {
        ...SignUpParamsFragment
      }
    }
    labeledByUserId
    createdAt
    updatedAt
    documentId
    start {
      sentenceId
      tokenId
      charId
    }
    end {
      sentenceId
      tokenId
      charId
    }
    confidenceScore
  }
}
Variables
{"input": GetPredictedLabelsInput}
Response
{
  "data": {
    "getPredictedLabels": [
      {
        "id": "abc123",
        "l": "xyz789",
        "layer": 987,
        "deleted": true,
        "hashCode": "abc123",
        "labeledBy": "AUTO",
        "labeledByUser": User,
        "labeledByUserId": 123,
        "createdAt": "xyz789",
        "updatedAt": "abc123",
        "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
      createdAt
      updatedAt
    }
    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
      asrProvider
      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": "abc123",
      "isOwnerMe": false,
      "isReviewByMeAllowed": false,
      "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
      signUpParams {
        ...SignUpParamsFragment
      }
    }
    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

Arguments
Name Description
projectId - ID!
role - Role Default = REVIEWER

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
      }
    ]
  }
}

getProjectContributors

Response

Returns [CabinetContributor!]!

Arguments
Name Description
teamId - ID!
projectId - ID!

Example

Query
query GetProjectContributors(
  $teamId: ID!,
  $projectId: ID!
) {
  getProjectContributors(
    teamId: $teamId,
    projectId: $projectId
  ) {
    cabinetId
    cabinetOwnerId
    contributors {
      id
      username
      name
      email
      package
      profilePicture
      allowedActions
      displayName
      teamPackage
      emailVerified
      totpAuthEnabled
      companyName
      signUpParams {
        ...SignUpParamsFragment
      }
    }
  }
}
Variables
{"teamId": "4", "projectId": 4}
Response
{
  "data": {
    "getProjectContributors": [
      {
        "cabinetId": 4,
        "cabinetOwnerId": 4,
        "contributors": [User]
      }
    ]
  }
}

getProjectDocumentQuestionSet

Response

Returns a ProjectQuestionSet!

Arguments
Name Description
projectId - ID!

Example

Query
query GetProjectDocumentQuestionSet($projectId: ID!) {
  getProjectDocumentQuestionSet(projectId: $projectId) {
    questions {
      id
      internalId
      type
      name
      label
      required
      config {
        ...QuestionConfigFragment
      }
      bindToColumn
      activationConditionLogic
    }
    signature
  }
}
Variables
{"projectId": "4"}
Response
{
  "data": {
    "getProjectDocumentQuestionSet": {
      "questions": [Question],
      "signature": "xyz789"
    }
  }
}

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
    }
  }
}

getProjectLabelersDocumentStatus

Arguments
Name Description
input - GetProjectInput

Example

Query
query GetProjectLabelersDocumentStatus($input: GetProjectInput) {
  getProjectLabelersDocumentStatus(input: $input) {
    originId
    assignedLabelers {
      id
      user {
        ...UserFragment
      }
      role {
        ...TeamRoleFragment
      }
      invitationEmail
      invitationStatus
      invitationKey
      isDeleted
      joinedDate
      performance {
        ...TeamMemberPerformanceFragment
      }
    }
    completedLabelers {
      id
      user {
        ...UserFragment
      }
      role {
        ...TeamRoleFragment
      }
      invitationEmail
      invitationStatus
      invitationKey
      isDeleted
      joinedDate
      performance {
        ...TeamMemberPerformanceFragment
      }
    }
  }
}
Variables
{"input": GetProjectInput}
Response
{
  "data": {
    "getProjectLabelersDocumentStatus": [
      {
        "originId": "4",
        "assignedLabelers": [TeamMember],
        "completedLabelers": [TeamMember]
      }
    ]
  }
}

getProjectRowQuestionSet

Response

Returns a ProjectQuestionSet!

Arguments
Name Description
projectId - ID!

Example

Query
query GetProjectRowQuestionSet($projectId: ID!) {
  getProjectRowQuestionSet(projectId: $projectId) {
    questions {
      id
      internalId
      type
      name
      label
      required
      config {
        ...QuestionConfigFragment
      }
      bindToColumn
      activationConditionLogic
    }
    signature
  }
}
Variables
{"projectId": "4"}
Response
{
  "data": {
    "getProjectRowQuestionSet": {
      "questions": [Question],
      "signature": "xyz789"
    }
  }
}

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": "xyz789"
    }
  }
}

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": "xyz789"}
Response
{
  "data": {
    "getProjectSamples": [
      {
        "id": "4",
        "displayName": "xyz789",
        "exportableJSON": "abc123"
      }
    ]
  }
}

getProjectTemplate

Please use getProjectTemplateV2 instead.
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": "xyz789",
      "projectTemplateProjectSettingId": "4",
      "projectTemplateTextDocumentSettingId": "4",
      "projectTemplateProjectSetting": ProjectTemplateProjectSetting,
      "projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
      "labelSetTemplates": [LabelSetTemplate],
      "questionSets": [QuestionSet],
      "createdAt": "abc123",
      "updatedAt": "abc123",
      "purpose": "LABELING",
      "creatorId": 4
    }
  }
}

getProjectTemplateV2

Response

Returns a ProjectTemplateV2!

Arguments
Name Description
id - ID!

Example

Query
query GetProjectTemplateV2($id: ID!) {
  getProjectTemplateV2(id: $id) {
    id
    name
    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
    type
    description
    imagePreviewURL
    videoURL
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getProjectTemplateV2": {
      "id": "4",
      "name": "abc123",
      "logoURL": "abc123",
      "projectTemplateProjectSettingId": 4,
      "projectTemplateTextDocumentSettingId": "4",
      "projectTemplateProjectSetting": ProjectTemplateProjectSetting,
      "projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
      "labelSetTemplates": [LabelSetTemplate],
      "questionSets": [QuestionSet],
      "createdAt": "abc123",
      "updatedAt": "xyz789",
      "purpose": "LABELING",
      "creatorId": 4,
      "type": "CUSTOM",
      "description": "abc123",
      "imagePreviewURL": "abc123",
      "videoURL": "xyz789"
    }
  }
}

getProjectTemplates

Please use getProjectTemplatesV2 instead.
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": "abc123",
        "teamId": "4",
        "team": Team,
        "logoURL": "xyz789",
        "projectTemplateProjectSettingId": "4",
        "projectTemplateTextDocumentSettingId": "4",
        "projectTemplateProjectSetting": ProjectTemplateProjectSetting,
        "projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
        "labelSetTemplates": [LabelSetTemplate],
        "questionSets": [QuestionSet],
        "createdAt": "xyz789",
        "updatedAt": "xyz789",
        "purpose": "LABELING",
        "creatorId": 4
      }
    ]
  }
}

getProjectTemplatesV2

Response

Returns [ProjectTemplateV2!]!

Arguments
Name Description
teamId - ID!

Example

Query
query GetProjectTemplatesV2($teamId: ID!) {
  getProjectTemplatesV2(teamId: $teamId) {
    id
    name
    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
    type
    description
    imagePreviewURL
    videoURL
  }
}
Variables
{"teamId": "4"}
Response
{
  "data": {
    "getProjectTemplatesV2": [
      {
        "id": 4,
        "name": "xyz789",
        "logoURL": "abc123",
        "projectTemplateProjectSettingId": 4,
        "projectTemplateTextDocumentSettingId": 4,
        "projectTemplateProjectSetting": ProjectTemplateProjectSetting,
        "projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
        "labelSetTemplates": [LabelSetTemplate],
        "questionSets": [QuestionSet],
        "createdAt": "abc123",
        "updatedAt": "abc123",
        "purpose": "LABELING",
        "creatorId": 4,
        "type": "CUSTOM",
        "description": "xyz789",
        "imagePreviewURL": "xyz789",
        "videoURL": "xyz789"
      }
    ]
  }
}

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