Datasaur GraphQL API Reference

Datasaur GraphQL API Reference

API Endpoints
# Production:
https://app.datasaur.ai/graphql
Headers
Authorization: Bearer <YOUR_TOKEN_HERE>

Queries

attemptTeamAction

Response

Returns a Boolean!

Arguments
Name Description
action - TeamActionNames!
teamId - ID!

Example

Query
query AttemptTeamAction(
  $action: TeamActionNames!,
  $teamId: ID!
) {
  attemptTeamAction(
    action: $action,
    teamId: $teamId
  )
}
Variables
{"action": "MANAGE_EXTERNAL_PROVIDER", "teamId": 4}
Response
{"data": {"attemptTeamAction": true}}

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

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": "xyz789",
  "lang": "xyz789"
}
Response
{
  "data": {
    "dictionaryLookup": {
      "word": "xyz789",
      "lang": "abc123",
      "entries": [DictionaryResultEntry]
    }
  }
}

dictionaryLookupBatch

Response

Returns [DictionaryResult!]!

Arguments
Name Description
words - [String!]!
lang - String!

Example

Query
query DictionaryLookupBatch(
  $words: [String!]!,
  $lang: String!
) {
  dictionaryLookupBatch(
    words: $words,
    lang: $lang
  ) {
    word
    lang
    entries {
      lexicalCategory
      definitions {
        ...DefinitionEntryFragment
      }
    }
  }
}
Variables
{
  "words": ["xyz789"],
  "lang": "abc123"
}
Response
{
  "data": {
    "dictionaryLookupBatch": [
      {
        "word": "abc123",
        "lang": "abc123",
        "entries": [DictionaryResultEntry]
      }
    ]
  }
}

executeExportFileTransformer

Description

Simulates what an export file transformer will do to a document in a project, or to a project sample One of documentId or projectSampleId is required

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

exportActivities

Response

Returns an ExportRequestResult!

Arguments
Name Description
input - ExportActivitiesInput!

Example

Query
query ExportActivities($input: ExportActivitiesInput!) {
  exportActivities(input: $input) {
    exportId
    fileUrl
    fileUrlExpiredAt
    queued
    redirect
  }
}
Variables
{"input": ExportActivitiesInput}
Response
{
  "data": {
    "exportActivities": {
      "exportId": 4,
      "fileUrl": "xyz789",
      "fileUrlExpiredAt": "abc123",
      "queued": true,
      "redirect": "abc123"
    }
  }
}

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

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

exportLlmEvaluationAutomated

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

Exports automated LLM evaluation.

Response

Returns an ExportRequestResult!

Arguments
Name Description
input - ExportLlmEvaluationAutomatedInput!

Example

Query
query ExportLlmEvaluationAutomated($input: ExportLlmEvaluationAutomatedInput!) {
  exportLlmEvaluationAutomated(input: $input) {
    exportId
    fileUrl
    fileUrlExpiredAt
    queued
    redirect
  }
}
Variables
{"input": ExportLlmEvaluationAutomatedInput}
Response
{
  "data": {
    "exportLlmEvaluationAutomated": {
      "exportId": "4",
      "fileUrl": "abc123",
      "fileUrlExpiredAt": "abc123",
      "queued": true,
      "redirect": "abc123"
    }
  }
}

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": ["xyz789"],
  "method": "COHENS_KAPPA",
  "projectIds": ["4"]
}
Response
{
  "data": {
    "exportTeamIAA": {
      "exportId": 4,
      "fileUrl": "xyz789",
      "fileUrlExpiredAt": "abc123",
      "queued": false,
      "redirect": "xyz789"
    }
  }
}

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

exportTextProject

Description

Exports all files in a project.

Response

Returns an ExportRequestResult!

Arguments
Name Description
input - ExportTextProjectInput!

Example

Query
query ExportTextProject($input: ExportTextProjectInput!) {
  exportTextProject(input: $input) {
    exportId
    fileUrl
    fileUrlExpiredAt
    queued
    redirect
  }
}
Variables
{"input": ExportTextProjectInput}
Response
{
  "data": {
    "exportTextProject": {
      "exportId": "4",
      "fileUrl": "abc123",
      "fileUrlExpiredAt": "abc123",
      "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": "xyz789",
      "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": "xyz789",
        "fileName": "xyz789"
      }
    ]
  }
}

getActivities

Response

Returns a GetActivitiesResponse!

Arguments
Name Description
input - GetActivitiesInput!

Example

Query
query GetActivities($input: GetActivitiesInput!) {
  getActivities(input: $input) {
    totalCount
    pageInfo {
      prevCursor
      nextCursor
    }
    nodes {
      event
      visibility
      teamId
      userId
      userDisplayName
      createdAt
      projectId
      projectName
      documentId
      documentType
      documentName
      labelAddressHashCode
      labelType
      bulkId
      additionalData {
        ...ActivityAdditionalDataFragment
      }
    }
  }
}
Variables
{"input": GetActivitiesInput}
Response
{
  "data": {
    "getActivities": {
      "totalCount": 123,
      "pageInfo": PageInfo,
      "nodes": [ActivityEvent]
    }
  }
}

getActivitiesSuggestion

Arguments
Name Description
input - GetActivitiesSuggestionInput!

Example

Query
query GetActivitiesSuggestion($input: GetActivitiesSuggestionInput!) {
  getActivitiesSuggestion(input: $input) {
    suggestions {
      displayName
      id
    }
  }
}
Variables
{"input": GetActivitiesSuggestionInput}
Response
{
  "data": {
    "getActivitiesSuggestion": {
      "suggestions": [ActivitySuggestion]
    }
  }
}

getAllExtensions

Response

Returns [ExtensionGroup!]!

Example

Query
query GetAllExtensions {
  getAllExtensions {
    kind
    extensions {
      id
      title
      url
      elementType
      elementKind
      documentType
    }
  }
}
Response
{
  "data": {
    "getAllExtensions": [
      {
        "kind": "DOCUMENT_BASED",
        "extensions": [Extension]
      }
    ]
  }
}

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 {
      activitySettings {
        ...TeamActivitySettingsFragment
      }
      allowedAdminExportMethods
      allowedLabelerExportMethods
      allowedOCRProviders
      allowedASRProviders
      allowedReviewerExportMethods
      commentNotificationType
      customAPICreationLimit
      defaultCustomTextExtractionAPIId
      defaultExternalObjectStorageId
      enableActions
      enableAddDocumentsToProject
      enableDemo
      enableDataProgramming
      enableLabelingFunctionMultipleLabel
      enableDatasaurAssistRowBased
      enableDatasaurDinamicTokenBased
      enableDatasaurPredictiveRowBased
      enableWipeData
      enableExportTeamOverview
      enableSelfAssignment
      enableTransferOwnership
      enableLabelErrorDetectionRowBased
      allowedExtraAutoLabelProviders
      enableLLMProject
      enableRegexSentenceSeparator
      enableTeamRoleSupervisor
      endExtensionTrialAt
      allowInvalidPaymentMethod
      enableExternalKnowledgeBase
      enableForceAnonymization
      enableValidationScript
      enableSpanLabelingWithRowQuestions
    }
    owner {
      id
      amazonCustomerId
      username
      name
      email
      package
      profilePicture
      allowedActions
      displayName
      teamPackage
      emailVerified
      totpAuthEnabled
      companyName
      createdAt
      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 use getChartsLastUpdatedAt.
Response

Returns a String!

Example

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

getAnalyticsPerformance

Arguments
Name Description
input - GetAnalyticsPerformanceInput!

Example

Query
query GetAnalyticsPerformance($input: GetAnalyticsPerformanceInput!) {
  getAnalyticsPerformance(input: $input) {
    projectId
    resourceId
    projectName
    labelingStatus
    projectStatus
    totalLabelApplied
    totalAnswerApplied
    totalConflictResolved
    numberOfAcceptedLabels
    numberOfRejectedLabels
    numberOfConflictedLabels
    numberOfMissingLabels
    numberOfAcceptedAnswers
    numberOfRejectedAnswers
    numberOfConflictedAnswers
    numberOfAnsweredLines
    activeDurationInMillis
  }
}
Variables
{"input": GetAnalyticsPerformanceInput}
Response
{
  "data": {
    "getAnalyticsPerformance": [
      {
        "projectId": "4",
        "resourceId": "xyz789",
        "projectName": "xyz789",
        "labelingStatus": "NOT_STARTED",
        "projectStatus": "CREATED",
        "totalLabelApplied": 987,
        "totalAnswerApplied": 123,
        "totalConflictResolved": 123,
        "numberOfAcceptedLabels": 123,
        "numberOfRejectedLabels": 123,
        "numberOfConflictedLabels": 987,
        "numberOfMissingLabels": 987,
        "numberOfAcceptedAnswers": 123,
        "numberOfRejectedAnswers": 987,
        "numberOfConflictedAnswers": 123,
        "numberOfAnsweredLines": 123,
        "activeDurationInMillis": 123
      }
    ]
  }
}

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
    error {
      status
      message
    }
  }
}
Variables
{"input": AutoLabelTokenBasedInput}
Response
{
  "data": {
    "getAutoLabel": [
      {
        "label": "xyz789",
        "deleted": true,
        "layer": 123,
        "start": TextCursor,
        "end": TextCursor,
        "confidenceScore": 123.45,
        "error": AutoLabelError
      }
    ]
  }
}

getAutoLabelBBoxBased

Response

Returns [AutoLabelBBoxBasedOutput!]!

Arguments
Name Description
input - AutoLabelBBoxBasedInput

Example

Query
query GetAutoLabelBBoxBased($input: AutoLabelBBoxBasedInput) {
  getAutoLabelBBoxBased(input: $input) {
    id
    documentId
    bboxLabelClassId
    caption
    shapes {
      pageIndex
      points {
        ...BBoxPointFragment
      }
    }
    confidenceScore
    error {
      status
      message
    }
  }
}
Variables
{"input": AutoLabelBBoxBasedInput}
Response
{
  "data": {
    "getAutoLabelBBoxBased": [
      {
        "id": "4",
        "documentId": "4",
        "bboxLabelClassId": "4",
        "caption": "abc123",
        "shapes": [BBoxShape],
        "confidenceScore": 987.65,
        "error": AutoLabelError
      }
    ]
  }
}

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": "abc123",
        "provider": "CUSTOM",
        "privacy": "PUBLIC"
      }
    ]
  }
}

getAutoLabelRowBased

Response

Returns [AutoLabelRowBasedOutput!]!

Arguments
Name Description
input - AutoLabelRowBasedInput

Example

Query
query GetAutoLabelRowBased($input: AutoLabelRowBasedInput) {
  getAutoLabelRowBased(input: $input) {
    id
    label
    error {
      status
      message
    }
  }
}
Variables
{"input": AutoLabelRowBasedInput}
Response
{
  "data": {
    "getAutoLabelRowBased": [
      {
        "id": 123,
        "label": "xyz789",
        "error": AutoLabelError
      }
    ]
  }
}

getAwsMarketplaceNlpFreeTrialExpiration

Arguments
Name Description
teamId - ID!

Example

Query
query GetAwsMarketplaceNlpFreeTrialExpiration($teamId: ID!) {
  getAwsMarketplaceNlpFreeTrialExpiration(teamId: $teamId) {
    expiredAt
    isExpired
  }
}
Variables
{"teamId": "4"}
Response
{
  "data": {
    "getAwsMarketplaceNlpFreeTrialExpiration": {
      "expiredAt": "xyz789",
      "isExpired": false
    }
  }
}

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
      questions {
        ...QuestionFragment
      }
    }
    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
      }
    }
    answers
  }
}
Variables
{"documentId": "4"}
Response
{
  "data": {
    "getBBoxLabelsByDocument": [
      {
        "id": "4",
        "documentId": "4",
        "bboxLabelClassId": "4",
        "deleted": true,
        "caption": "xyz789",
        "shapes": [BBoxShape],
        "answers": AnswerScalar
      }
    ]
  }
}

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

getBoundingBoxPages

Response

Returns [BoundingBoxPage!]!

Arguments
Name Description
documentId - ID!

Example

Query
query GetBoundingBoxPages($documentId: ID!) {
  getBoundingBoxPages(documentId: $documentId) {
    pageIndex
    pageHeight
    pageWidth
  }
}
Variables
{"documentId": "4"}
Response
{
  "data": {
    "getBoundingBoxPages": [
      {"pageIndex": 123, "pageHeight": 123, "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": "abc123",
        "logoURL": "xyz789",
        "projectTemplateProjectSettingId": "4",
        "projectTemplateTextDocumentSettingId": 4,
        "projectTemplateProjectSetting": ProjectTemplateProjectSetting,
        "projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
        "labelSetTemplates": [LabelSetTemplate],
        "questionSets": [QuestionSet],
        "createdAt": "abc123",
        "updatedAt": "abc123",
        "purpose": "LABELING",
        "creatorId": 4,
        "type": "CUSTOM",
        "description": "abc123",
        "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
      amazonCustomerId
      username
      name
      email
      package
      profilePicture
      allowedActions
      displayName
      teamPackage
      emailVerified
      totpAuthEnabled
      companyName
      createdAt
      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": false}
    ]
  }
}

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": [987]
      }
    ]
  }
}

getCabinetLabelSetsById

Response

Returns [LabelSet!]!

Arguments
Name Description
cabinetId - ID!

Example

Query
query GetCabinetLabelSetsById($cabinetId: ID!) {
  getCabinetLabelSetsById(cabinetId: $cabinetId) {
    id
    name
    index
    signature
    tagItems {
      id
      parentId
      tagName
      desc
      color
      type
      arrowRules {
        ...LabelClassArrowRuleFragment
      }
    }
    lastUsedBy {
      projectId
      name
    }
    arrowLabelRequired
  }
}
Variables
{"cabinetId": "4"}
Response
{
  "data": {
    "getCabinetLabelSetsById": [
      {
        "id": "4",
        "name": "abc123",
        "index": 123,
        "signature": "xyz789",
        "tagItems": [TagItem],
        "lastUsedBy": LastUsedProject,
        "arrowLabelRequired": true
      }
    ]
  }
}

getCellPositionsByMetadata

Description

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

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": 987,
      "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": ["xyz789"],
        "visualizationParams": VisualizationParams
      }
    ]
  }
}

getChartsLastUpdatedAt

Response

Returns a String

Arguments
Name Description
level - ChartLevel!
set - ChartSet!
input - AnalyticsDashboardQueryInput!

Example

Query
query GetChartsLastUpdatedAt(
  $level: ChartLevel!,
  $set: ChartSet!,
  $input: AnalyticsDashboardQueryInput!
) {
  getChartsLastUpdatedAt(
    level: $level,
    set: $set,
    input: $input
  )
}
Variables
{
  "level": "TEAM",
  "set": "OLD",
  "input": AnalyticsDashboardQueryInput
}
Response
{
  "data": {
    "getChartsLastUpdatedAt": "abc123"
  }
}

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

getCurrentUserTeamMember

Response

Returns a TeamMember!

Arguments
Name Description
input - GetCurrentUserTeamMemberInput!

Example

Query
query GetCurrentUserTeamMember($input: GetCurrentUserTeamMemberInput!) {
  getCurrentUserTeamMember(input: $input) {
    id
    user {
      id
      amazonCustomerId
      username
      name
      email
      package
      profilePicture
      allowedActions
      displayName
      teamPackage
      emailVerified
      totpAuthEnabled
      companyName
      createdAt
      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": "xyz789",
      "invitationStatus": "xyz789",
      "invitationKey": "abc123",
      "isDeleted": true,
      "joinedDate": "xyz789",
      "performance": TeamMemberPerformance
    }
  }
}

getCustomAPI

Response

Returns a CustomAPI!

Arguments
Name Description
customAPIId - ID!

Example

Query
query GetCustomAPI($customAPIId: ID!) {
  getCustomAPI(customAPIId: $customAPIId) {
    id
    teamId
    endpointURL
    name
    purpose
  }
}
Variables
{"customAPIId": "4"}
Response
{
  "data": {
    "getCustomAPI": {
      "id": "4",
      "teamId": "4",
      "endpointURL": "xyz789",
      "name": "abc123",
      "purpose": "ASR_API"
    }
  }
}

getCustomAPIs

Response

Returns [CustomAPI!]!

Arguments
Name Description
teamId - ID!
purpose - CustomAPIPurpose

Example

Query
query GetCustomAPIs(
  $teamId: ID!,
  $purpose: CustomAPIPurpose
) {
  getCustomAPIs(
    teamId: $teamId,
    purpose: $purpose
  ) {
    id
    teamId
    endpointURL
    name
    purpose
  }
}
Variables
{"teamId": 4, "purpose": "ASR_API"}
Response
{
  "data": {
    "getCustomAPIs": [
      {
        "id": 4,
        "teamId": 4,
        "endpointURL": "xyz789",
        "name": "abc123",
        "purpose": "ASR_API"
      }
    ]
  }
}

getCustomReportMetricsGroupTables

Description

Returns custom report metrics group tables.

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

getCustomerPlan

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

Returns a String!

Arguments
Name Description
teamId - ID!

Example

Query
query GetCustomerPlan($teamId: ID!) {
  getCustomerPlan(teamId: $teamId)
}
Variables
{"teamId": "4"}
Response
{"data": {"getCustomerPlan": "xyz789"}}

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": "xyz789",
      "labels": [DataProgrammingLabel],
      "createdAt": "xyz789",
      "updatedAt": "abc123",
      "lastGetPredictionsAt": "abc123"
    }
  }
}

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": 987.65,
        "coverage": 987.65,
        "overlap": 987.65,
        "polarity": [123]
      }
    ]
  }
}

getDataProgrammingLibraries

Response

Returns a DataProgrammingLibraries!

Example

Query
query GetDataProgrammingLibraries {
  getDataProgrammingLibraries {
    libraries
  }
}
Response
{
  "data": {
    "getDataProgrammingLibraries": {
      "libraries": ["xyz789"]
    }
  }
}

getDataProgrammingPredictions

Response

Returns a Job!

Arguments
Name Description
input - GetDataProgrammingPredictionsInput!

Example

Query
query GetDataProgrammingPredictions($input: GetDataProgrammingPredictionsInput!) {
  getDataProgrammingPredictions(input: $input) {
    id
    status
    progress
    errors {
      id
      stack
      args
      message
    }
    resultId
    result
    createdAt
    updatedAt
    additionalData {
      actionRunId
      childrenJobIds
      documentIds
      reversedLabels {
        ...UpdateReversedLabelsResultFragment
      }
    }
  }
}
Variables
{"input": GetDataProgrammingPredictionsInput}
Response
{
  "data": {
    "getDataProgrammingPredictions": {
      "id": "xyz789",
      "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
    inputColumnIds
    questionColumnId
    providerSetting
    modelMetadata
    trainingJobId
    createdAt
    updatedAt
  }
}
Variables
{"input": GetDatasaurDinamicRowBasedInput}
Response
{
  "data": {
    "getDatasaurDinamicRowBased": {
      "id": 4,
      "projectId": 4,
      "provider": "HUGGINGFACE",
      "inputColumnIds": [123],
      "questionColumnId": 123,
      "providerSetting": ProviderSetting,
      "modelMetadata": ModelMetadata,
      "trainingJobId": 4,
      "createdAt": "xyz789",
      "updatedAt": "abc123"
    }
  }
}

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
    inputColumnIds
    questionColumnId
    providerSetting
    modelMetadata
    trainingJobId
    createdAt
    updatedAt
  }
}
Variables
{"input": GetDatasaurPredictiveInput}
Response
{
  "data": {
    "getDatasaurPredictive": {
      "id": "4",
      "projectId": "4",
      "provider": "SETFIT",
      "inputColumnIds": [987],
      "questionColumnId": 987,
      "providerSetting": ProviderSetting,
      "modelMetadata": ModelMetadata,
      "trainingJobId": 4,
      "createdAt": "xyz789",
      "updatedAt": "xyz789"
    }
  }
}

getDatasaurPredictiveProviders

Example

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

getDefaultExtensions

Response

Returns [DefaultExtension!]!

Arguments
Name Description
teamId - ID!

Example

Query
query GetDefaultExtensions($teamId: ID!) {
  getDefaultExtensions(teamId: $teamId) {
    kind
    labelerExtensions {
      extensionId
    }
    reviewerExtensions {
      extensionId
    }
  }
}
Variables
{"teamId": 4}
Response
{
  "data": {
    "getDefaultExtensions": [
      {
        "kind": "DOCUMENT_BASED",
        "labelerExtensions": [DefaultExtensionElement],
        "reviewerExtensions": [DefaultExtensionElement]
      }
    ]
  }
}

getDocumentAnswerConflicts

Response

Returns [ConflictAnswer!]!

Arguments
Name Description
documentId - ID!

Example

Query
query GetDocumentAnswerConflicts($documentId: ID!) {
  getDocumentAnswerConflicts(documentId: $documentId) {
    questionId
    parentQuestionId
    nestedAnswerIndex
    answers {
      resolved
      value
      userIds
      users {
        ...UserFragment
      }
    }
    type
  }
}
Variables
{"documentId": 4}
Response
{
  "data": {
    "getDocumentAnswerConflicts": [
      {
        "questionId": 4,
        "parentQuestionId": "4",
        "nestedAnswerIndex": 987,
        "answers": [ConflictAnswerValue],
        "type": "MULTIPLE"
      }
    ]
  }
}

getDocumentAnswers

Response

Returns a DocumentAnswer!

Arguments
Name Description
documentId - ID!

Example

Query
query GetDocumentAnswers($documentId: ID!) {
  getDocumentAnswers(documentId: $documentId) {
    documentId
    answers
    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": 987,
        "cabinetId": 123,
        "name": "abc123",
        "width": "abc123",
        "displayed": false,
        "labelerRestricted": true,
        "rowQuestionIndex": 987
      }
    ]
  }
}

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

getEvaluationRagConfigsByTeamId

Description

Retrieves the LLM evaluation RAG configs by the team id.

Response

Returns [LlmEvaluationRagConfig!]!

Arguments
Name Description
teamId - ID!

Example

Query
query GetEvaluationRagConfigsByTeamId($teamId: ID!) {
  getEvaluationRagConfigsByTeamId(teamId: $teamId) {
    id
    llmEvaluationId
    llmApplication {
      id
      teamId
      createdByUser {
        ...UserFragment
      }
      name
      status
      createdAt
      updatedAt
      llmApplicationDeployment {
        ...LlmApplicationDeploymentFragment
      }
    }
    llmPlaygroundRagConfig {
      id
      llmApplicationId
      llmRagConfig {
        ...LlmRagConfigFragment
      }
      name
      createdAt
      updatedAt
    }
    llmDeploymentRagConfig {
      id
      deployedByUser {
        ...UserFragment
      }
      llmApplicationId
      llmApplication {
        ...LlmApplicationFragment
      }
      llmRagConfig {
        ...LlmRagConfigFragment
      }
      numberOfCalls
      numberOfTokens
      numberOfInputTokens
      numberOfOutputTokens
      deployedAt
      createdAt
      updatedAt
      apiEndpoints {
        ...LlmApplicationDeploymentApiEndpointFragment
      }
    }
    llmRagConfigId
    llmSnapshotRagConfig {
      id
      llmModel {
        ...LlmModelFragment
      }
      systemInstruction
      userInstruction
      raw
      temperature
      topP
      maxTokens
      advancedHyperparameters
      maxVectorStoreTokens
      llmVectorStore {
        ...LlmVectorStoreFragment
      }
      similarityThreshold
      enableAnonymization
      createdAt
      updatedAt
    }
    llmApplicationConfigurationRagConfig {
      id
      name
      teamId
      createdByUserId
      createdByUser {
        ...UserFragment
      }
      updatedByUserId
      updatedByUser {
        ...UserFragment
      }
      llmRagConfigId
      llmRagConfig {
        ...LlmRagConfigFragment
      }
      createdAt
      updatedAt
    }
    ragConfigSourceType
    createdAt
    updatedAt
    isDeleted
  }
}
Variables
{"teamId": "4"}
Response
{
  "data": {
    "getEvaluationRagConfigsByTeamId": [
      {
        "id": 4,
        "llmEvaluationId": 4,
        "llmApplication": LlmApplication,
        "llmPlaygroundRagConfig": LlmApplicationPlaygroundRagConfig,
        "llmDeploymentRagConfig": LlmApplicationDeployment,
        "llmRagConfigId": "4",
        "llmSnapshotRagConfig": LlmRagConfig,
        "llmApplicationConfigurationRagConfig": LlmApplicationConfiguration,
        "ragConfigSourceType": "APPLICATION_DEPLOYMENT",
        "createdAt": "xyz789",
        "updatedAt": "xyz789",
        "isDeleted": false
      }
    ]
  }
}

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
      message
    }
  }
}
Variables
{"exportId": "4"}
Response
{
  "data": {
    "getExportDeliveryStatus": {
      "deliveryStatus": "DELIVERED",
      "errors": [JobError]
    }
  }
}

getExportable

Response

Returns an ExportableJSON!

Arguments
Name Description
documentId - ID

Example

Query
query GetExportable($documentId: ID) {
  getExportable(documentId: $documentId)
}
Variables
{"documentId": 4}
Response
{"data": {"getExportable": ExportableJSON}}

getExtensions

Response

Returns [Extension!]

Arguments
Name Description
cabinetId - String!

Example

Query
query GetExtensions($cabinetId: String!) {
  getExtensions(cabinetId: $cabinetId) {
    id
    title
    url
    elementType
    elementKind
    documentType
  }
}
Variables
{"cabinetId": "xyz789"}
Response
{
  "data": {
    "getExtensions": [
      {
        "id": "xyz789",
        "title": "abc123",
        "url": "xyz789",
        "elementType": "abc123",
        "elementKind": "xyz789",
        "documentType": "abc123"
      }
    ]
  }
}

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

getExternalId

Description

Required for AWS S3

Response

Returns an ExternalId!

Example

Query
query GetExternalId {
  getExternalId {
    externalId
    timeLimit
  }
}
Response
{
  "data": {
    "getExternalId": {
      "externalId": "xyz789",
      "timeLimit": 987
    }
  }
}

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

getExternalObjectStorages

Response

Returns [ExternalObjectStorage!]

Arguments
Name Description
teamId - ID!

Example

Query
query GetExternalObjectStorages($teamId: ID!) {
  getExternalObjectStorages(teamId: $teamId) {
    id
    cloudService
    bucketId
    bucketName
    credentials {
      roleArn
      externalId
      serviceAccount
      tenantId
      storageContainerUrl
      region
      tenantUsername
    }
    securityToken
    team {
      id
      logoURL
      members {
        ...TeamMemberFragment
      }
      membersScalar
      name
      setting {
        ...TeamSettingFragment
      }
      owner {
        ...UserFragment
      }
      isExpired
      expiredAt
    }
    projects {
      id
      team {
        ...TeamFragment
      }
      teamId
      owner {
        ...UserFragment
      }
      externalObjectStorageId
      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
      projectMetadataItems {
        ...ProjectMetadataItemFragment
      }
      availableDocumentsCount
    }
    createdAt
    updatedAt
  }
}
Variables
{"teamId": 4}
Response
{
  "data": {
    "getExternalObjectStorages": [
      {
        "id": "4",
        "cloudService": "AWS_S3",
        "bucketId": "abc123",
        "bucketName": "xyz789",
        "credentials": ExternalObjectStorageCredentials,
        "securityToken": "xyz789",
        "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": "abc123",
      "content": "xyz789",
      "transpiled": "abc123",
      "createdAt": "abc123",
      "updatedAt": "xyz789",
      "language": "TYPESCRIPT",
      "purpose": "IMPORT",
      "readonly": true,
      "externalId": "abc123",
      "warmup": false
    }
  }
}

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

getFineTunedLlmModels

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

Retrieves a list of all fine tuned LLM models of a team.

Response

Returns [LlmModel!]!

Arguments
Name Description
teamId - ID!

Example

Query
query GetFineTunedLlmModels($teamId: ID!) {
  getFineTunedLlmModels(teamId: $teamId) {
    id
    detail {
      status
      instanceType
      instanceTypeDetail {
        ...LlmInstanceTypeDetailFragment
      }
    }
    teamId
    provider
    name
    displayName
    url
    maxTemperature
    maxTopP
    maxTokens
    maxContextWindow
    defaultTemperature
    defaultTopP
    defaultMaxTokens
    llmModelFineTuningJob {
      id
      name
      teamId
      status
      errorMessage
      baseModelId
      parentId
      resultModelId
      trainingJobId
      trainingDataset {
        ...GroundTruthSetFragment
      }
      trainingDatasetFilename
      validationSize
      validationDataset {
        ...GroundTruthSetFragment
      }
      validationDatasetFilename
      epochs
      learningRate
      batchSize
      earlyStoppingThreshold
      earlyStoppingPatience
      learningRateWarmUpStep
      learningRateMultiplier
      createdByUser {
        ...UserFragment
      }
      createdAt
      updatedAt
    }
    deployableModelId
    isModelDeployable
    forceAnonymization
    variant
    createdAt
    updatedAt
  }
}
Variables
{"teamId": 4}
Response
{
  "data": {
    "getFineTunedLlmModels": [
      {
        "id": 4,
        "detail": LlmModelDetail,
        "teamId": "4",
        "provider": "AMAZON_BEDROCK",
        "name": "abc123",
        "displayName": "abc123",
        "url": "xyz789",
        "maxTemperature": 123.45,
        "maxTopP": 123.45,
        "maxTokens": 987,
        "maxContextWindow": 987,
        "defaultTemperature": 123.45,
        "defaultTopP": 987.65,
        "defaultMaxTokens": 987,
        "llmModelFineTuningJob": LlmModelFineTuningJob,
        "deployableModelId": "abc123",
        "isModelDeployable": false,
        "forceAnonymization": true,
        "variant": "META",
        "createdAt": "abc123",
        "updatedAt": "xyz789"
      }
    ]
  }
}

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": 987,
      "runPromptMaxAmount": 123,
      "runPromptUnit": "abc123",
      "embedDocumentCurrentAmount": 987,
      "embedDocumentMaxAmount": 123,
      "embedDocumentUnit": "xyz789",
      "embedDocumentUrlCurrentAmount": 123,
      "embedDocumentUrlMaxAmount": 987,
      "embedDocumentUrlUnit": "xyz789",
      "llmEvaluationCurrentAmount": 987,
      "llmEvaluationMaxAmount": 123,
      "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
    editorLineSpacingRatio
    showIndexBar
    showLabels
    keepLabelBoxOpenAfterRelabel
    jumpToNextDocumentOnSubmit
    jumpToNextDocumentOnDocumentCompleted
    jumpToNextSpanOnSubmit
    multipleSelectLabels
  }
}
Variables
{"projectId": 4}
Response
{
  "data": {
    "getGeneralWorkspaceSettings": {
      "id": 4,
      "editorFontType": "SANS_SERIF",
      "editorFontSize": "SMALL",
      "editorLineSpacing": "DENSE",
      "editorLineSpacingRatio": 123.45,
      "showIndexBar": true,
      "showLabels": "ALWAYS",
      "keepLabelBoxOpenAfterRelabel": true,
      "jumpToNextDocumentOnSubmit": false,
      "jumpToNextDocumentOnDocumentCompleted": true,
      "jumpToNextSpanOnSubmit": false,
      "multipleSelectLabels": false
    }
  }
}

getGrammarCheckerServiceProviders

Example

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

getGrammarMistakes

Response

Returns [GrammarMistake!]!

Arguments
Name Description
input - GrammarCheckerInput!

Example

Query
query GetGrammarMistakes($input: GrammarCheckerInput!) {
  getGrammarMistakes(input: $input) {
    text
    message
    position {
      start {
        ...TextCursorFragment
      }
      end {
        ...TextCursorFragment
      }
    }
    suggestions
  }
}
Variables
{"input": GrammarCheckerInput}
Response
{
  "data": {
    "getGrammarMistakes": [
      {
        "text": "xyz789",
        "message": "abc123",
        "position": TextRange,
        "suggestions": ["xyz789"]
      }
    ]
  }
}

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
      amazonCustomerId
      username
      name
      email
      package
      profilePicture
      allowedActions
      displayName
      teamPackage
      emailVerified
      totpAuthEnabled
      companyName
      createdAt
      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": "xyz789"
    }
  }
}

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
      owner {
        ...UserFragment
      }
      externalObjectStorageId
      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
      projectMetadataItems {
        ...ProjectMetadataItemFragment
      }
      availableDocumentsCount
    }
  }
}
Variables
{"teamId": 4}
Response
{
  "data": {
    "getGuidelines": [
      {
        "id": 4,
        "name": "abc123",
        "content": "abc123",
        "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": "abc123"}}

getInvalidDocumentAnswerInfos

Response

Returns [InvalidAnswerInfo!]!

Arguments
Name Description
cabinetId - ID!

Example

Query
query GetInvalidDocumentAnswerInfos($cabinetId: ID!) {
  getInvalidDocumentAnswerInfos(cabinetId: $cabinetId) {
    documentId
    fileName
    lines
  }
}
Variables
{"cabinetId": "4"}
Response
{
  "data": {
    "getInvalidDocumentAnswerInfos": [
      {
        "documentId": "4",
        "fileName": "xyz789",
        "lines": [123]
      }
    ]
  }
}

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": "xyz789",
        "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
      message
    }
    resultId
    result
    createdAt
    updatedAt
    additionalData {
      actionRunId
      childrenJobIds
      documentIds
      reversedLabels {
        ...UpdateReversedLabelsResultFragment
      }
    }
  }
}
Variables
{"jobId": "abc123"}
Response
{
  "data": {
    "getJob": {
      "id": "abc123",
      "status": "DELIVERED",
      "progress": 987,
      "errors": [JobError],
      "resultId": "xyz789",
      "result": JobResult,
      "createdAt": "xyz789",
      "updatedAt": "abc123",
      "additionalData": JobAdditionalData
    }
  }
}

getJobs

Response

Returns [Job]!

Arguments
Name Description
jobIds - [String!]!

Example

Query
query GetJobs($jobIds: [String!]!) {
  getJobs(jobIds: $jobIds) {
    id
    status
    progress
    errors {
      id
      stack
      args
      message
    }
    resultId
    result
    createdAt
    updatedAt
    additionalData {
      actionRunId
      childrenJobIds
      documentIds
      reversedLabels {
        ...UpdateReversedLabelsResultFragment
      }
    }
  }
}
Variables
{"jobIds": ["abc123"]}
Response
{
  "data": {
    "getJobs": [
      {
        "id": "xyz789",
        "status": "DELIVERED",
        "progress": 987,
        "errors": [JobError],
        "resultId": "abc123",
        "result": JobResult,
        "createdAt": "xyz789",
        "updatedAt": "xyz789",
        "additionalData": JobAdditionalData
      }
    ]
  }
}

getLLMAssistedLabelingProviders

Arguments
Name Description
input - LLMAssistedLabelingProvidersInput!

Example

Query
query GetLLMAssistedLabelingProviders($input: LLMAssistedLabelingProvidersInput!) {
  getLLMAssistedLabelingProviders(input: $input) {
    name
    models {
      model
      maxTokens
    }
    inputFields {
      key
      name
      type
      required
      maxValue
      minValue
    }
  }
}
Variables
{"input": LLMAssistedLabelingProvidersInput}
Response
{
  "data": {
    "getLLMAssistedLabelingProviders": [
      {
        "name": "OPENAI",
        "models": [LLMAssistedLabelingProviderModel],
        "inputFields": [
          LLMAssistedLabelingProviderInputField
        ]
      }
    ]
  }
}

getLabelErrorDetectionRowBasedSuggestions

Example

Query
query GetLabelErrorDetectionRowBasedSuggestions($input: GetLabelErrorDetectionRowBasedSuggestionsInput!) {
  getLabelErrorDetectionRowBasedSuggestions(input: $input) {
    id
    documentId
    labelErrorDetectionId
    line
    errorPossibility
    suggestedLabel
    previousLabel
    createdAt
    updatedAt
  }
}
Variables
{"input": GetLabelErrorDetectionRowBasedSuggestionsInput}
Response
{
  "data": {
    "getLabelErrorDetectionRowBasedSuggestions": [
      {
        "id": "4",
        "documentId": 4,
        "labelErrorDetectionId": 4,
        "line": 123,
        "errorPossibility": 987.65,
        "suggestedLabel": "xyz789",
        "previousLabel": "xyz789",
        "createdAt": "abc123",
        "updatedAt": "xyz789"
      }
    ]
  }
}

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
      amazonCustomerId
      username
      name
      email
      package
      profilePicture
      allowedActions
      displayName
      teamPackage
      emailVerified
      totpAuthEnabled
      companyName
      createdAt
      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": "xyz789",
      "owner": User,
      "type": "QUESTION",
      "items": [LabelSetTemplateItem],
      "count": 987,
      "createdAt": "xyz789",
      "updatedAt": "abc123"
    }
  }
}

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

getLabelSetsByTeamId

Response

Returns [LabelSet!]!

Arguments
Name Description
teamId - ID!

Example

Query
query GetLabelSetsByTeamId($teamId: ID!) {
  getLabelSetsByTeamId(teamId: $teamId) {
    id
    name
    index
    signature
    tagItems {
      id
      parentId
      tagName
      desc
      color
      type
      arrowRules {
        ...LabelClassArrowRuleFragment
      }
    }
    lastUsedBy {
      projectId
      name
    }
    arrowLabelRequired
  }
}
Variables
{"teamId": "4"}
Response
{
  "data": {
    "getLabelSetsByTeamId": [
      {
        "id": 4,
        "name": "abc123",
        "index": 123,
        "signature": "xyz789",
        "tagItems": [TagItem],
        "lastUsedBy": LastUsedProject,
        "arrowLabelRequired": false
      }
    ]
  }
}

getLabelingFunction

Response

Returns a LabelingFunction!

Arguments
Name Description
input - GetLabelingFunctionInput!

Example

Query
query GetLabelingFunction($input: GetLabelingFunctionInput!) {
  getLabelingFunction(input: $input) {
    id
    dataProgrammingId
    heuristicArgument
    annotatorArgument
    name
    content
    active
    createdAt
    updatedAt
  }
}
Variables
{"input": GetLabelingFunctionInput}
Response
{
  "data": {
    "getLabelingFunction": {
      "id": "4",
      "dataProgrammingId": "4",
      "heuristicArgument": HeuristicArgumentScalar,
      "annotatorArgument": AnnotatorArgumentScalar,
      "name": "xyz789",
      "content": "xyz789",
      "active": true,
      "createdAt": "abc123",
      "updatedAt": "abc123"
    }
  }
}

getLabelingFunctions

Response

Returns [LabelingFunction!]

Arguments
Name Description
input - GetLabelingFunctionsInput!

Example

Query
query GetLabelingFunctions($input: GetLabelingFunctionsInput!) {
  getLabelingFunctions(input: $input) {
    id
    dataProgrammingId
    heuristicArgument
    annotatorArgument
    name
    content
    active
    createdAt
    updatedAt
  }
}
Variables
{"input": GetLabelingFunctionsInput}
Response
{
  "data": {
    "getLabelingFunctions": [
      {
        "id": 4,
        "dataProgrammingId": "4",
        "heuristicArgument": HeuristicArgumentScalar,
        "annotatorArgument": AnnotatorArgumentScalar,
        "name": "xyz789",
        "content": "xyz789",
        "active": false,
        "createdAt": "abc123",
        "updatedAt": "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": "abc123"
    }
  }
}

getLabelsPaginated

Response

Returns a GetLabelsPaginatedResponse!

Arguments
Name Description
documentId - ID!
input - GetLabelsPaginatedInput!
signature - String

Example

Query
query GetLabelsPaginated(
  $documentId: ID!,
  $input: GetLabelsPaginatedInput!,
  $signature: String
) {
  getLabelsPaginated(
    documentId: $documentId,
    input: $input,
    signature: $signature
  ) {
    totalCount
    pageInfo {
      prevCursor
      nextCursor
    }
    nodes
  }
}
Variables
{
  "documentId": 4,
  "input": GetLabelsPaginatedInput,
  "signature": "xyz789"
}
Response
{
  "data": {
    "getLabelsPaginated": {
      "totalCount": 123,
      "pageInfo": PageInfo,
      "nodes": [TextLabelScalar]
    }
  }
}

getLatestInfoBar

Response

Returns an InfoBar

Example

Query
query GetLatestInfoBar {
  getLatestInfoBar {
    id
    content
    isVisible
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "getLatestInfoBar": {
      "id": 4,
      "content": "xyz789",
      "isVisible": true,
      "createdAt": "abc123",
      "updatedAt": "xyz789"
    }
  }
}

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 {
      activitySettings {
        ...TeamActivitySettingsFragment
      }
      allowedAdminExportMethods
      allowedLabelerExportMethods
      allowedOCRProviders
      allowedASRProviders
      allowedReviewerExportMethods
      commentNotificationType
      customAPICreationLimit
      defaultCustomTextExtractionAPIId
      defaultExternalObjectStorageId
      enableActions
      enableAddDocumentsToProject
      enableDemo
      enableDataProgramming
      enableLabelingFunctionMultipleLabel
      enableDatasaurAssistRowBased
      enableDatasaurDinamicTokenBased
      enableDatasaurPredictiveRowBased
      enableWipeData
      enableExportTeamOverview
      enableSelfAssignment
      enableTransferOwnership
      enableLabelErrorDetectionRowBased
      allowedExtraAutoLabelProviders
      enableLLMProject
      enableRegexSentenceSeparator
      enableTeamRoleSupervisor
      endExtensionTrialAt
      allowInvalidPaymentMethod
      enableExternalKnowledgeBase
      enableForceAnonymization
      enableValidationScript
      enableSpanLabelingWithRowQuestions
    }
    owner {
      id
      amazonCustomerId
      username
      name
      email
      package
      profilePicture
      allowedActions
      displayName
      teamPackage
      emailVerified
      totpAuthEnabled
      companyName
      createdAt
      signUpParams {
        ...SignUpParamsFragment
      }
    }
    isExpired
    expiredAt
  }
}
Response
{
  "data": {
    "getLatestJoinedTeam": {
      "id": "4",
      "logoURL": "xyz789",
      "members": [TeamMember],
      "membersScalar": TeamMembersScalar,
      "name": "abc123",
      "setting": TeamSetting,
      "owner": User,
      "isExpired": false,
      "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
      amazonCustomerId
      username
      name
      email
      package
      profilePicture
      allowedActions
      displayName
      teamPackage
      emailVerified
      totpAuthEnabled
      companyName
      createdAt
      signUpParams {
        ...SignUpParamsFragment
      }
    }
    name
    status
    createdAt
    updatedAt
    llmApplicationDeployment {
      id
      deployedByUser {
        ...UserFragment
      }
      llmApplicationId
      llmApplication {
        ...LlmApplicationFragment
      }
      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": "abc123",
      "updatedAt": "abc123",
      "llmApplicationDeployment": LlmApplicationDeployment
    }
  }
}

getLlmApplicationConfiguration

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

Returns a LlmApplicationConfiguration!

Arguments
Name Description
id - ID!

Example

Query
query GetLlmApplicationConfiguration($id: ID!) {
  getLlmApplicationConfiguration(id: $id) {
    id
    name
    teamId
    createdByUserId
    createdByUser {
      id
      amazonCustomerId
      username
      name
      email
      package
      profilePicture
      allowedActions
      displayName
      teamPackage
      emailVerified
      totpAuthEnabled
      companyName
      createdAt
      signUpParams {
        ...SignUpParamsFragment
      }
    }
    updatedByUserId
    updatedByUser {
      id
      amazonCustomerId
      username
      name
      email
      package
      profilePicture
      allowedActions
      displayName
      teamPackage
      emailVerified
      totpAuthEnabled
      companyName
      createdAt
      signUpParams {
        ...SignUpParamsFragment
      }
    }
    llmRagConfigId
    llmRagConfig {
      id
      llmModel {
        ...LlmModelFragment
      }
      systemInstruction
      userInstruction
      raw
      temperature
      topP
      maxTokens
      advancedHyperparameters
      maxVectorStoreTokens
      llmVectorStore {
        ...LlmVectorStoreFragment
      }
      similarityThreshold
      enableAnonymization
      createdAt
      updatedAt
    }
    createdAt
    updatedAt
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getLlmApplicationConfiguration": {
      "id": "4",
      "name": "xyz789",
      "teamId": "4",
      "createdByUserId": "4",
      "createdByUser": User,
      "updatedByUserId": 4,
      "updatedByUser": User,
      "llmRagConfigId": "4",
      "llmRagConfig": LlmRagConfig,
      "createdAt": "xyz789",
      "updatedAt": "xyz789"
    }
  }
}

getLlmApplicationConfigurations

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

Example

Query
query GetLlmApplicationConfigurations($teamId: ID!) {
  getLlmApplicationConfigurations(teamId: $teamId) {
    id
    name
    teamId
    createdByUserId
    createdByUser {
      id
      amazonCustomerId
      username
      name
      email
      package
      profilePicture
      allowedActions
      displayName
      teamPackage
      emailVerified
      totpAuthEnabled
      companyName
      createdAt
      signUpParams {
        ...SignUpParamsFragment
      }
    }
    updatedByUserId
    updatedByUser {
      id
      amazonCustomerId
      username
      name
      email
      package
      profilePicture
      allowedActions
      displayName
      teamPackage
      emailVerified
      totpAuthEnabled
      companyName
      createdAt
      signUpParams {
        ...SignUpParamsFragment
      }
    }
    llmRagConfigId
    llmRagConfig {
      id
      llmModel {
        ...LlmModelFragment
      }
      systemInstruction
      userInstruction
      raw
      temperature
      topP
      maxTokens
      advancedHyperparameters
      maxVectorStoreTokens
      llmVectorStore {
        ...LlmVectorStoreFragment
      }
      similarityThreshold
      enableAnonymization
      createdAt
      updatedAt
    }
    createdAt
    updatedAt
  }
}
Variables
{"teamId": 4}
Response
{
  "data": {
    "getLlmApplicationConfigurations": [
      {
        "id": "4",
        "name": "xyz789",
        "teamId": 4,
        "createdByUserId": "4",
        "createdByUser": User,
        "updatedByUserId": "4",
        "updatedByUser": User,
        "llmRagConfigId": "4",
        "llmRagConfig": LlmRagConfig,
        "createdAt": "xyz789",
        "updatedAt": "xyz789"
      }
    ]
  }
}

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
      amazonCustomerId
      username
      name
      email
      package
      profilePicture
      allowedActions
      displayName
      teamPackage
      emailVerified
      totpAuthEnabled
      companyName
      createdAt
      signUpParams {
        ...SignUpParamsFragment
      }
    }
    llmApplicationId
    llmApplication {
      id
      teamId
      createdByUser {
        ...UserFragment
      }
      name
      status
      createdAt
      updatedAt
      llmApplicationDeployment {
        ...LlmApplicationDeploymentFragment
      }
    }
    llmRagConfig {
      id
      llmModel {
        ...LlmModelFragment
      }
      systemInstruction
      userInstruction
      raw
      temperature
      topP
      maxTokens
      advancedHyperparameters
      maxVectorStoreTokens
      llmVectorStore {
        ...LlmVectorStoreFragment
      }
      similarityThreshold
      enableAnonymization
      createdAt
      updatedAt
    }
    numberOfCalls
    numberOfTokens
    numberOfInputTokens
    numberOfOutputTokens
    deployedAt
    createdAt
    updatedAt
    apiEndpoints {
      type
      endpoint
    }
  }
}
Variables
{"llmApplicationId": 4}
Response
{
  "data": {
    "getLlmApplicationDeployment": {
      "id": 4,
      "deployedByUser": User,
      "llmApplicationId": "4",
      "llmApplication": LlmApplication,
      "llmRagConfig": LlmRagConfig,
      "numberOfCalls": 987,
      "numberOfTokens": 123,
      "numberOfInputTokens": 123,
      "numberOfOutputTokens": 123,
      "deployedAt": "abc123",
      "createdAt": "xyz789",
      "updatedAt": "xyz789",
      "apiEndpoints": [
        LlmApplicationDeploymentApiEndpoint
      ]
    }
  }
}

getLlmApplicationDeployments

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

Returns [LlmApplicationDeployment!]!

Arguments
Name Description
teamId - ID!

Example

Query
query GetLlmApplicationDeployments($teamId: ID!) {
  getLlmApplicationDeployments(teamId: $teamId) {
    id
    deployedByUser {
      id
      amazonCustomerId
      username
      name
      email
      package
      profilePicture
      allowedActions
      displayName
      teamPackage
      emailVerified
      totpAuthEnabled
      companyName
      createdAt
      signUpParams {
        ...SignUpParamsFragment
      }
    }
    llmApplicationId
    llmApplication {
      id
      teamId
      createdByUser {
        ...UserFragment
      }
      name
      status
      createdAt
      updatedAt
      llmApplicationDeployment {
        ...LlmApplicationDeploymentFragment
      }
    }
    llmRagConfig {
      id
      llmModel {
        ...LlmModelFragment
      }
      systemInstruction
      userInstruction
      raw
      temperature
      topP
      maxTokens
      advancedHyperparameters
      maxVectorStoreTokens
      llmVectorStore {
        ...LlmVectorStoreFragment
      }
      similarityThreshold
      enableAnonymization
      createdAt
      updatedAt
    }
    numberOfCalls
    numberOfTokens
    numberOfInputTokens
    numberOfOutputTokens
    deployedAt
    createdAt
    updatedAt
    apiEndpoints {
      type
      endpoint
    }
  }
}
Variables
{"teamId": "4"}
Response
{
  "data": {
    "getLlmApplicationDeployments": [
      {
        "id": "4",
        "deployedByUser": User,
        "llmApplicationId": "4",
        "llmApplication": LlmApplication,
        "llmRagConfig": LlmRagConfig,
        "numberOfCalls": 987,
        "numberOfTokens": 123,
        "numberOfInputTokens": 123,
        "numberOfOutputTokens": 987,
        "deployedAt": "xyz789",
        "createdAt": "abc123",
        "updatedAt": "xyz789",
        "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": "abc123",
      "prompt": "abc123",
      "createdAt": "abc123",
      "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": "xyz789",
        "prompt": "abc123",
        "createdAt": "xyz789",
        "updatedAt": "abc123"
      }
    ]
  }
}

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
      advancedHyperparameters
      maxVectorStoreTokens
      llmVectorStore {
        ...LlmVectorStoreFragment
      }
      similarityThreshold
      enableAnonymization
      createdAt
      updatedAt
    }
    name
    createdAt
    updatedAt
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getLlmApplicationPlaygroundRagConfig": {
      "id": 4,
      "llmApplicationId": "4",
      "llmRagConfig": LlmRagConfig,
      "name": "xyz789",
      "createdAt": "abc123",
      "updatedAt": "abc123"
    }
  }
}

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
      advancedHyperparameters
      maxVectorStoreTokens
      llmVectorStore {
        ...LlmVectorStoreFragment
      }
      similarityThreshold
      enableAnonymization
      createdAt
      updatedAt
    }
    name
    createdAt
    updatedAt
  }
}
Variables
{"llmApplicationId": 4}
Response
{
  "data": {
    "getLlmApplicationPlaygroundRagConfigs": [
      {
        "id": "4",
        "llmApplicationId": "4",
        "llmRagConfig": LlmRagConfig,
        "name": "xyz789",
        "createdAt": "abc123",
        "updatedAt": "xyz789"
      }
    ]
  }
}

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

getLlmApplicationsByTeam

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

Returns [LlmApplication!]!

Arguments
Name Description
teamId - ID!

Example

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

getLlmBaseModels

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

Retrieves a list of all LLM base models of a team.

Response

Returns [LlmBaseModel!]!

Arguments
Name Description
teamId - ID!

Example

Query
query GetLlmBaseModels($teamId: ID!) {
  getLlmBaseModels(teamId: $teamId) {
    id
    baseModelIdentifier
    customModelIdentifier
    teamId
    name
    serviceProvider
    provider
    region
    methodTypes
    supportedDatasetTypes
    supportedHyperparameters {
      name
      actualName
      type
      minValue
      maxValue
      defaultValue
    }
    pricingModels {
      id
      llmBaseModelId
      unitPrice
      unitType
      unitPurpose
    }
  }
}
Variables
{"teamId": 4}
Response
{
  "data": {
    "getLlmBaseModels": [
      {
        "id": 4,
        "baseModelIdentifier": "abc123",
        "customModelIdentifier": "xyz789",
        "teamId": "4",
        "name": "xyz789",
        "serviceProvider": "AMAZON_BEDROCK",
        "provider": "AMAZON",
        "region": "abc123",
        "methodTypes": ["FINE_TUNING"],
        "supportedDatasetTypes": ["COMPLETION"],
        "supportedHyperparameters": [
          LlmBaseModelHyperparameter
        ],
        "pricingModels": [LlmBaseModelPricingModel]
      }
    ]
  }
}

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_BEDROCK"],
        "name": "xyz789",
        "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_BEDROCK",
  "name": "xyz789"
}
Response
{
  "data": {
    "getLlmEmbeddingModelSpec": {
      "supportedInferenceInstanceTypes": [
        "xyz789"
      ],
      "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
    detail {
      status
      instanceType
      instanceTypeDetail {
        ...LlmInstanceTypeDetailFragment
      }
    }
    teamId
    provider
    name
    displayName
    url
    maxTokens
    dimensions
    deployableModelId
    isModelDeployable
    createdAt
    updatedAt
    customDimension
  }
}
Variables
{"teamId": "4", "includeDefault": false}
Response
{
  "data": {
    "getLlmEmbeddingModels": [
      {
        "id": "4",
        "detail": LlmModelDetail,
        "teamId": 4,
        "provider": "AMAZON_BEDROCK",
        "name": "abc123",
        "displayName": "abc123",
        "url": "abc123",
        "maxTokens": 987,
        "dimensions": 123,
        "deployableModelId": "xyz789",
        "isModelDeployable": false,
        "createdAt": "xyz789",
        "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
      }
      llmApplicationConfigurationRagConfig {
        ...LlmApplicationConfigurationFragment
      }
      ragConfigSourceType
      createdAt
      updatedAt
      isDeleted
    }
    llmEvaluationPrompts {
      id
      llmEvaluationId
      prompt
      expectedCompletion
      LlmEvaluationGeneratedAnswer {
        ...LlmEvaluationGeneratedAnswerFragment
      }
      createdAt
      updatedAt
      isDeleted
    }
    llmEvaluationEvaluators {
      id
      llmEvaluationId
      evaluator
      metric
      provider
      version
      llmModelId
      llmModel {
        ...LlmModelFragment
      }
      llmEmbeddingModelId
      llmEmbeddingModel {
        ...LlmEmbeddingModelFragment
      }
      alertExpression
      createdAt
      updatedAt
      deletedAt
    }
    llmEvaluationExecutions {
      id
      llmEvaluationId
      status
      errorMessage
      createdAt
      updatedAt
      isDeleted
    }
    scheduledCommandConfig {
      id
      cronPattern
      repeatInterval
      runImmediately
      endTime
      numberOfRepetition
      isNeverEnding
      isPeriodic
      updatedAt
    }
    isScheduled
    createdAt
    updatedAt
    isDeleted
    type
    schedulingStatus
    nextSchedule
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getLlmEvaluation": {
      "id": "4",
      "name": "xyz789",
      "teamId": 4,
      "projectId": 4,
      "kind": "DOCUMENT_BASED",
      "status": "CREATED",
      "creationProgress": LlmEvaluationCreationProgress,
      "llmEvaluationRagConfigs": [LlmEvaluationRagConfig],
      "llmEvaluationPrompts": [LlmEvaluationPrompt],
      "llmEvaluationEvaluators": [LlmEvaluationEvaluator],
      "llmEvaluationExecutions": [LlmEvaluationExecution],
      "scheduledCommandConfig": ScheduledCommandConfig,
      "isScheduled": true,
      "createdAt": "abc123",
      "updatedAt": "xyz789",
      "isDeleted": true,
      "type": "RATING",
      "schedulingStatus": "NOT_STARTED",
      "nextSchedule": "abc123"
    }
  }
}

getLlmEvaluationAutomatedAvailableStrategies

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

Returns the available automated LLM evaluation strategies.

Arguments
Name Description
teamId - ID!

Example

Query
query GetLlmEvaluationAutomatedAvailableStrategies($teamId: ID!) {
  getLlmEvaluationAutomatedAvailableStrategies(teamId: $teamId) {
    name
    displayName
    provider
    version
    description
    deprecated
    evaluatorModelTypes
    minValue
    maxValue
    invertedValue
    requiresContext
  }
}
Variables
{"teamId": 4}
Response
{
  "data": {
    "getLlmEvaluationAutomatedAvailableStrategies": [
      {
        "name": "abc123",
        "displayName": "xyz789",
        "provider": "xyz789",
        "version": "abc123",
        "description": "xyz789",
        "deprecated": true,
        "evaluatorModelTypes": ["LLM_MODEL"],
        "minValue": 987.65,
        "maxValue": 123.45,
        "invertedValue": false,
        "requiresContext": true
      }
    ]
  }
}

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

getLlmEvaluationDetail

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

Retrieves the LLM evaluation detail based on the provided id.

Arguments
Name Description
input - GetLlmEvaluationDetailPaginatedInput!

Example

Query
query GetLlmEvaluationDetail($input: GetLlmEvaluationDetailPaginatedInput!) {
  getLlmEvaluationDetail(input: $input) {
    totalCount
    pageInfo {
      prevCursor
      nextCursor
    }
    nodes {
      prompt
      expectedCompletion
      completions {
        ...LlmEvaluationGeneratedAnswerFragment
      }
      scores {
        ...LlmEvaluationAnswerScoreFragment
      }
    }
  }
}
Variables
{"input": GetLlmEvaluationDetailPaginatedInput}
Response
{
  "data": {
    "getLlmEvaluationDetail": {
      "totalCount": 987,
      "pageInfo": PageInfo,
      "nodes": [LlmEvaluationDetail]
    }
  }
}

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
      message
    }
    resultId
    result
    createdAt
    updatedAt
    additionalData {
      actionRunId
      childrenJobIds
      documentIds
      reversedLabels {
        ...UpdateReversedLabelsResultFragment
      }
    }
  }
}
Variables
{"projectId": "xyz789"}
Response
{
  "data": {
    "getLlmEvaluationReport": {
      "id": "xyz789",
      "status": "DELIVERED",
      "progress": 987,
      "errors": [JobError],
      "resultId": "xyz789",
      "result": JobResult,
      "createdAt": "xyz789",
      "updatedAt": "abc123",
      "additionalData": JobAdditionalData
    }
  }
}

getLlmEvaluationSummary

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

Retrieves the LLM evaluation summary based on the provided id.

Response

Returns a LlmEvaluationSummary!

Arguments
Name Description
id - ID!
llmEvaluationExecutionId - ID

Example

Query
query GetLlmEvaluationSummary(
  $id: ID!,
  $llmEvaluationExecutionId: ID
) {
  getLlmEvaluationSummary(
    id: $id,
    llmEvaluationExecutionId: $llmEvaluationExecutionId
  ) {
    llmEvaluationId
    llmEvaluation {
      id
      name
      teamId
      projectId
      kind
      status
      creationProgress {
        ...LlmEvaluationCreationProgressFragment
      }
      llmEvaluationRagConfigs {
        ...LlmEvaluationRagConfigFragment
      }
      llmEvaluationPrompts {
        ...LlmEvaluationPromptFragment
      }
      llmEvaluationEvaluators {
        ...LlmEvaluationEvaluatorFragment
      }
      llmEvaluationExecutions {
        ...LlmEvaluationExecutionFragment
      }
      scheduledCommandConfig {
        ...ScheduledCommandConfigFragment
      }
      isScheduled
      createdAt
      updatedAt
      isDeleted
      type
      schedulingStatus
      nextSchedule
    }
    totalPromptCount
    totalUnansweredPromptCount
    totalFailedThresholdCompletionsCount
    summaries {
      llmEvaluationRagConfigId
      cost
      processingTime
      scores {
        ...LlmEvaluationEvaluatorSummaryFragment
      }
    }
  }
}
Variables
{"id": 4, "llmEvaluationExecutionId": 4}
Response
{
  "data": {
    "getLlmEvaluationSummary": {
      "llmEvaluationId": "4",
      "llmEvaluation": LlmEvaluation,
      "totalPromptCount": 123,
      "totalUnansweredPromptCount": 987,
      "totalFailedThresholdCompletionsCount": 123,
      "summaries": [LlmEvaluationRagConfigSummary]
    }
  }
}

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
      }
      llmEvaluationEvaluators {
        ...LlmEvaluationEvaluatorFragment
      }
      llmEvaluationExecutions {
        ...LlmEvaluationExecutionFragment
      }
      scheduledCommandConfig {
        ...ScheduledCommandConfigFragment
      }
      isScheduled
      createdAt
      updatedAt
      isDeleted
      type
      schedulingStatus
      nextSchedule
    }
  }
}
Variables
{"input": GetLlmEvaluationsPaginatedInput}
Response
{
  "data": {
    "getLlmEvaluations": {
      "totalCount": 123,
      "pageInfo": PageInfo,
      "nodes": [LlmEvaluation]
    }
  }
}

getLlmGeneratedInstruction

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

Returns a String!

Arguments
Name Description
input - GetLlmGeneratedInstructionInput!

Example

Query
query GetLlmGeneratedInstruction($input: GetLlmGeneratedInstructionInput!) {
  getLlmGeneratedInstruction(input: $input)
}
Variables
{"input": GetLlmGeneratedInstructionInput}
Response
{
  "data": {
    "getLlmGeneratedInstruction": "abc123"
  }
}

getLlmModelFineTuningCostPredictionAsync

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

Get Predicted cost for fine-tuning

Arguments
Name Description
input - LlmModelFineTuningCostPredictionInput!

Example

Query
query GetLlmModelFineTuningCostPredictionAsync($input: LlmModelFineTuningCostPredictionInput!) {
  getLlmModelFineTuningCostPredictionAsync(input: $input) {
    job {
      id
      status
      progress
      errors {
        ...JobErrorFragment
      }
      resultId
      result
      createdAt
      updatedAt
      additionalData {
        ...JobAdditionalDataFragment
      }
    }
    name
  }
}
Variables
{"input": LlmModelFineTuningCostPredictionInput}
Response
{
  "data": {
    "getLlmModelFineTuningCostPredictionAsync": {
      "job": Job,
      "name": "xyz789"
    }
  }
}

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_BEDROCK"],
        "name": "xyz789",
        "displayName": "xyz789",
        "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_BEDROCK",
  "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
    detail {
      status
      instanceType
      instanceTypeDetail {
        ...LlmInstanceTypeDetailFragment
      }
    }
    teamId
    provider
    name
    displayName
    url
    maxTemperature
    maxTopP
    maxTokens
    maxContextWindow
    defaultTemperature
    defaultTopP
    defaultMaxTokens
    llmModelFineTuningJob {
      id
      name
      teamId
      status
      errorMessage
      baseModelId
      parentId
      resultModelId
      trainingJobId
      trainingDataset {
        ...GroundTruthSetFragment
      }
      trainingDatasetFilename
      validationSize
      validationDataset {
        ...GroundTruthSetFragment
      }
      validationDatasetFilename
      epochs
      learningRate
      batchSize
      earlyStoppingThreshold
      earlyStoppingPatience
      learningRateWarmUpStep
      learningRateMultiplier
      createdByUser {
        ...UserFragment
      }
      createdAt
      updatedAt
    }
    deployableModelId
    isModelDeployable
    forceAnonymization
    variant
    createdAt
    updatedAt
  }
}
Variables
{"teamId": 4}
Response
{
  "data": {
    "getLlmModels": [
      {
        "id": "4",
        "detail": LlmModelDetail,
        "teamId": 4,
        "provider": "AMAZON_BEDROCK",
        "name": "abc123",
        "displayName": "xyz789",
        "url": "xyz789",
        "maxTemperature": 123.45,
        "maxTopP": 987.65,
        "maxTokens": 123,
        "maxContextWindow": 987,
        "defaultTemperature": 123.45,
        "defaultTopP": 987.65,
        "defaultMaxTokens": 123,
        "llmModelFineTuningJob": LlmModelFineTuningJob,
        "deployableModelId": "abc123",
        "isModelDeployable": true,
        "forceAnonymization": true,
        "variant": "META",
        "createdAt": "abc123",
        "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
      }
      metadata {
        ...LlmUsageMetadataFragment
      }
      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
      amazonCustomerId
      username
      name
      email
      package
      profilePicture
      allowedActions
      displayName
      teamPackage
      emailVerified
      totpAuthEnabled
      companyName
      createdAt
      signUpParams {
        ...SignUpParamsFragment
      }
    }
    llmEmbeddingModel {
      id
      detail {
        ...LlmModelDetailFragment
      }
      teamId
      provider
      name
      displayName
      url
      maxTokens
      dimensions
      deployableModelId
      isModelDeployable
      createdAt
      updatedAt
      customDimension
    }
    provider
    collectionId
    name
    status
    chunkSize
    overlap
    documents
    documentStatusCount {
      totalQueued
      totalProcessing
      totalDeleting
      totalCompleted
      totalProcessFailed
      totalDeleteFailed
      totalDocumentInvalid
      totalDocuments
    }
    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": 123,
      "overlap": 123,
      "documents": [LlmVectorStoreDocumentScalar],
      "documentStatusCount": LlmVectorStoreDocumentCountByStatus,
      "sourceDocuments": [LlmVectorStoreSourceDocument],
      "questions": [Question],
      "jobId": "abc123",
      "createdAt": "abc123",
      "updatedAt": "xyz789",
      "dimension": 987
    }
  }
}

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

getLlmVectorStoreDocument

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

Returns a LlmVectorStoreDocument

Arguments
Name Description
id - ID!
fileId - ID!

Example

Query
query GetLlmVectorStoreDocument(
  $id: ID!,
  $fileId: ID!
) {
  getLlmVectorStoreDocument(
    id: $id,
    fileId: $fileId
  ) {
    id
    name
    objectKey
    path
    previewPath
    type
    status
    errorMessage
    llmVectorStoreSource {
      id
      llmVectorStoreId
      externalObjectStorage {
        ...ExternalObjectStorageFragment
      }
      rules {
        ...LlmVectorStoreSourceRulesFragment
      }
      isDeleting
      createdAt
      updatedAt
    }
    llmVectorStoreSourceId
    createdAt
    updatedAt
  }
}
Variables
{
  "id": "4",
  "fileId": "4"
}
Response
{
  "data": {
    "getLlmVectorStoreDocument": {
      "id": 4,
      "name": "xyz789",
      "objectKey": "abc123",
      "path": "xyz789",
      "previewPath": "xyz789",
      "type": "FOLDER",
      "status": "QUEUED",
      "errorMessage": "xyz789",
      "llmVectorStoreSource": LlmVectorStoreSource,
      "llmVectorStoreSourceId": "4",
      "createdAt": "abc123",
      "updatedAt": "xyz789"
    }
  }
}

getLlmVectorStoreDocumentsIncludingDeleted

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

Example

Query
query GetLlmVectorStoreDocumentsIncludingDeleted($id: ID!) {
  getLlmVectorStoreDocumentsIncludingDeleted(id: $id) {
    documents
    sourceDocuments {
      source {
        ...LlmVectorStoreSourceFragment
      }
      documents
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getLlmVectorStoreDocumentsIncludingDeleted": {
      "documents": [LlmVectorStoreDocumentScalar],
      "sourceDocuments": [LlmVectorStoreSourceDocument]
    }
  }
}

getLlmVectorStoreDocumentsPaginated

Breaking changes may be introduced anytime in the future without prior notice.
Arguments
Name Description
llmVectorStoreId - ID!
input - GetLlmVectorStoreDocumentsPaginatedInput!
disableFetchCount - Boolean Disables fetching the total count of documents for pagination. This can improve performance for large datasets, since count fetching run the heavy query twice.

Example

Query
query GetLlmVectorStoreDocumentsPaginated(
  $llmVectorStoreId: ID!,
  $input: GetLlmVectorStoreDocumentsPaginatedInput!,
  $disableFetchCount: Boolean
) {
  getLlmVectorStoreDocumentsPaginated(
    llmVectorStoreId: $llmVectorStoreId,
    input: $input,
    disableFetchCount: $disableFetchCount
  ) {
    totalCount
    pageInfo {
      prevCursor
      nextCursor
    }
    nodes {
      id
      name
      objectKey
      path
      previewPath
      type
      status
      errorMessage
      llmVectorStoreSourceId
      createdAt
      updatedAt
    }
  }
}
Variables
{
  "llmVectorStoreId": "4",
  "input": GetLlmVectorStoreDocumentsPaginatedInput,
  "disableFetchCount": false
}
Response
{
  "data": {
    "getLlmVectorStoreDocumentsPaginated": {
      "totalCount": 123,
      "pageInfo": PageInfo,
      "nodes": [LlmVectorStoreDocumentPaginationItem]
    }
  }
}

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

getLlmVectorStoreSources

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

Returns [LlmVectorStoreSource!]!

Arguments
Name Description
llmVectorStoreId - ID!

Example

Query
query GetLlmVectorStoreSources($llmVectorStoreId: ID!) {
  getLlmVectorStoreSources(llmVectorStoreId: $llmVectorStoreId) {
    id
    llmVectorStoreId
    externalObjectStorage {
      id
      cloudService
      bucketId
      bucketName
      credentials {
        ...ExternalObjectStorageCredentialsFragment
      }
      securityToken
      team {
        ...TeamFragment
      }
      projects {
        ...ProjectFragment
      }
      createdAt
      updatedAt
    }
    rules {
      includeRule {
        ...LlmVectorStoreSourceRuleFragment
      }
      excludeRule {
        ...LlmVectorStoreSourceRuleFragment
      }
    }
    isDeleting
    createdAt
    updatedAt
  }
}
Variables
{"llmVectorStoreId": 4}
Response
{
  "data": {
    "getLlmVectorStoreSources": [
      {
        "id": "4",
        "llmVectorStoreId": "4",
        "externalObjectStorage": ExternalObjectStorage,
        "rules": LlmVectorStoreSourceRules,
        "isDeleting": true,
        "createdAt": "abc123",
        "updatedAt": "xyz789"
      }
    ]
  }
}

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
      documentStatusCount {
        ...LlmVectorStoreDocumentCountByStatusFragment
      }
      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": ["abc123"]
      }
    ]
  }
}

getMarkedUnusedLabelClasses

Description

Get all label classes which are marked as N/A in a project.

Arguments
Name Description
projectId - ID!