Datasaur GraphQL API Reference
Datasaur GraphQL API Reference
Terms of Service
API Endpoints
# Production:
https://app.datasaur.ai/graphql
Headers
Authorization: Bearer <YOUR_TOKEN_HERE>Queries
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": false}}
checkForMaliciousSite
checkLlmVectorStoreSourceRules
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmVectorStoreSourceCheckRulesResult!
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": true,
"invalidRules": LlmVectorStoreSourceInvalidRules
}
}
}
countProjectsByExternalObjectStorageId
dictionaryLookup
Response
Returns a DictionaryResult!
Example
Query
query DictionaryLookup(
$word: String!,
$lang: String
) {
dictionaryLookup(
word: $word,
lang: $lang
) {
word
lang
entries {
lexicalCategory
definitions {
...DefinitionEntryFragment
}
}
}
}
Variables
{
"word": "abc123",
"lang": "abc123"
}
Response
{
"data": {
"dictionaryLookup": {
"word": "xyz789",
"lang": "xyz789",
"entries": [DictionaryResultEntry]
}
}
}
dictionaryLookupBatch
Response
Returns [DictionaryResult!]!
Arguments
| Name | Description |
|---|---|
words - [String!]!
|
|
lang - String!
|
Example
Query
query DictionaryLookupBatch(
$words: [String!]!,
$lang: String!
) {
dictionaryLookupBatch(
words: $words,
lang: $lang
) {
word
lang
entries {
lexicalCategory
definitions {
...DefinitionEntryFragment
}
}
}
}
Variables
{
"words": ["xyz789"],
"lang": "xyz789"
}
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
Response
Returns an ExportFileTransformerExecuteResult!
Example
Query
query ExecuteExportFileTransformer(
$fileTransformerId: ID!,
$documentId: ID,
$projectSampleId: ID
) {
executeExportFileTransformer(
fileTransformerId: $fileTransformerId,
documentId: $documentId,
projectSampleId: $projectSampleId
)
}
Variables
{
"fileTransformerId": 4,
"documentId": "4",
"projectSampleId": "4"
}
Response
{
"data": {
"executeExportFileTransformer": ExportFileTransformerExecuteResult
}
}
executeImportFileTransformer
Description
Simulates what an import file transformer will do to an input
Response
Returns an ImportFileTransformerExecuteResult!
Example
Query
query ExecuteImportFileTransformer(
$fileTransformerId: ID!,
$content: String!
) {
executeImportFileTransformer(
fileTransformerId: $fileTransformerId,
content: $content
)
}
Variables
{
"fileTransformerId": 4,
"content": "abc123"
}
Response
{
"data": {
"executeImportFileTransformer": ImportFileTransformerExecuteResult
}
}
exportChart
Response
Returns an ExportRequestResult!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - AnalyticsDashboardQueryInput!
|
|
method - ExportChartMethod
|
Example
Query
query ExportChart(
$id: ID!,
$input: AnalyticsDashboardQueryInput!,
$method: ExportChartMethod
) {
exportChart(
id: $id,
input: $input,
method: $method
) {
exportId
fileUrl
fileUrlExpiredAt
queued
redirect
}
}
Variables
{
"id": "4",
"input": AnalyticsDashboardQueryInput,
"method": "EMAIL"
}
Response
{
"data": {
"exportChart": {
"exportId": 4,
"fileUrl": "xyz789",
"fileUrlExpiredAt": "abc123",
"queued": true,
"redirect": "xyz789"
}
}
}
exportCustomReport
Description
Exports custom report.
Response
Returns an ExportRequestResult!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
|
input - CustomReportBuilderInput!
|
Example
Query
query ExportCustomReport(
$teamId: ID!,
$input: CustomReportBuilderInput!
) {
exportCustomReport(
teamId: $teamId,
input: $input
) {
exportId
fileUrl
fileUrlExpiredAt
queued
redirect
}
}
Variables
{"teamId": 4, "input": CustomReportBuilderInput}
Response
{
"data": {
"exportCustomReport": {
"exportId": "4",
"fileUrl": "abc123",
"fileUrlExpiredAt": "abc123",
"queued": false,
"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": "xyz789",
"fileUrlExpiredAt": "xyz789",
"queued": false,
"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": ["abc123"],
"method": "COHENS_KAPPA",
"projectIds": [4]
}
Response
{
"data": {
"exportTeamIAA": {
"exportId": "4",
"fileUrl": "xyz789",
"fileUrlExpiredAt": "xyz789",
"queued": true,
"redirect": "abc123"
}
}
}
exportTeamIAAV2
Description
Exports team IAA.
Response
Returns an ExportRequestResult!
Arguments
| Name | Description |
|---|---|
input - IAAInput!
|
Example
Query
query ExportTeamIAAV2($input: IAAInput!) {
exportTeamIAAV2(input: $input) {
exportId
fileUrl
fileUrlExpiredAt
queued
redirect
}
}
Variables
{"input": IAAInput}
Response
{
"data": {
"exportTeamIAAV2": {
"exportId": 4,
"fileUrl": "xyz789",
"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": "abc123",
"fileUrlExpiredAt": "abc123",
"queued": true,
"redirect": "xyz789"
}
}
}
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": "abc123",
"queued": true,
"redirect": "abc123"
}
}
}
exportTextProject
Description
Exports all files in a project.
Response
Returns an ExportRequestResult!
Arguments
| Name | Description |
|---|---|
input - ExportTextProjectInput!
|
Example
Query
query ExportTextProject($input: ExportTextProjectInput!) {
exportTextProject(input: $input) {
exportId
fileUrl
fileUrlExpiredAt
queued
redirect
}
}
Variables
{"input": ExportTextProjectInput}
Response
{
"data": {
"exportTextProject": {
"exportId": 4,
"fileUrl": "xyz789",
"fileUrlExpiredAt": "xyz789",
"queued": false,
"redirect": "xyz789"
}
}
}
exportTextProjectDocument
Description
Exports a single document / file.
Response
Returns an ExportRequestResult!
Arguments
| Name | Description |
|---|---|
input - ExportTextProjectDocumentInput!
|
Example
Query
query ExportTextProjectDocument($input: ExportTextProjectDocumentInput!) {
exportTextProjectDocument(input: $input) {
exportId
fileUrl
fileUrlExpiredAt
queued
redirect
}
}
Variables
{"input": ExportTextProjectDocumentInput}
Response
{
"data": {
"exportTextProjectDocument": {
"exportId": "4",
"fileUrl": "abc123",
"fileUrlExpiredAt": "abc123",
"queued": true,
"redirect": "abc123"
}
}
}
generateFileUrls
Response
Returns [FileUrlInfo!]!
Arguments
| Name | Description |
|---|---|
input - GenerateFileUrlsInput!
|
Example
Query
query GenerateFileUrls($input: GenerateFileUrlsInput!) {
generateFileUrls(input: $input) {
uploadUrl
downloadUrl
fileName
}
}
Variables
{"input": GenerateFileUrlsInput}
Response
{
"data": {
"generateFileUrls": [
{
"uploadUrl": "abc123",
"downloadUrl": "xyz789",
"fileName": "xyz789"
}
]
}
}
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 {
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedASRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enableActions
enableAddDocumentsToProject
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurDinamicTokenBased
enableDatasaurPredictiveRowBased
enableWipeData
enableExportTeamOverview
enableTransferOwnership
enableLabelErrorDetectionRowBased
allowedExtraAutoLabelProviders
enableLLMProject
enableRegexSentenceSeparator
enableTeamRoleSupervisor
endExtensionTrialAt
allowInvalidPaymentMethod
enableExternalKnowledgeBase
enableForceAnonymization
}
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": "abc123",
"setting": TeamSetting,
"owner": User,
"isExpired": true,
"expiredAt": "2007-12-03T10:15:30Z"
}
]
}
}
getAllowedIPs
Response
Returns [String!]!
Example
Query
query GetAllowedIPs {
getAllowedIPs
}
Response
{"data": {"getAllowedIPs": ["abc123"]}}
getAnalyticsLastUpdatedAt
This Query will be removed in the future, please use getChartsLastUpdatedAt.
Response
Returns a String!
Example
Query
query GetAnalyticsLastUpdatedAt {
getAnalyticsLastUpdatedAt
}
Response
{
"data": {
"getAnalyticsLastUpdatedAt": "xyz789"
}
}
getAnalyticsPerformance
Response
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": "abc123",
"projectName": "xyz789",
"labelingStatus": "NOT_STARTED",
"projectStatus": "CREATED",
"totalLabelApplied": 987,
"totalAnswerApplied": 123,
"totalConflictResolved": 987,
"numberOfAcceptedLabels": 987,
"numberOfRejectedLabels": 123,
"numberOfConflictedLabels": 987,
"numberOfMissingLabels": 123,
"numberOfAcceptedAnswers": 123,
"numberOfRejectedAnswers": 987,
"numberOfConflictedAnswers": 987,
"numberOfAnsweredLines": 987,
"activeDurationInMillis": 987
}
]
}
}
getAutoLabel
Response
Returns [AutoLabelTokenBasedOutput!]!
Arguments
| Name | Description |
|---|---|
input - AutoLabelTokenBasedInput
|
Example
Query
query GetAutoLabel($input: AutoLabelTokenBasedInput) {
getAutoLabel(input: $input) {
label
deleted
layer
start {
sentenceId
tokenId
charId
}
end {
sentenceId
tokenId
charId
}
confidenceScore
error {
status
message
}
}
}
Variables
{"input": AutoLabelTokenBasedInput}
Response
{
"data": {
"getAutoLabel": [
{
"label": "abc123",
"deleted": false,
"layer": 987,
"start": TextCursor,
"end": TextCursor,
"confidenceScore": 987.65,
"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": "xyz789",
"shapes": [BBoxShape],
"confidenceScore": 123.45,
"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": "xyz789",
"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": 987,
"label": "xyz789",
"error": AutoLabelError
}
]
}
}
getAwsMarketplaceNlpFreeTrialExpiration
Response
Returns an AwsMarketplaceNlpFreeTrialExpiration!
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": true
}
}
}
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": "xyz789",
"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": false,
"caption": "xyz789",
"shapes": [BBoxShape],
"answers": AnswerScalar
}
]
}
}
getBoundingBoxConflictList
Response
Returns a GetBoundingBoxConflictListResult!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
Example
Query
query GetBoundingBoxConflictList($documentId: ID!) {
getBoundingBoxConflictList(documentId: $documentId) {
upToDate
items {
id
documentId
coordinates {
...CoordinateFragment
}
pageIndex
layer
position {
...TextRangeFragment
}
resolved
hashCode
labelerIds
text
}
}
}
Variables
{"documentId": 4}
Response
{
"data": {
"getBoundingBoxConflictList": {
"upToDate": true,
"items": [ConflictBoundingBoxLabel]
}
}
}
getBoundingBoxLabels
Response
Returns [BoundingBoxLabel!]!
Example
Query
query GetBoundingBoxLabels(
$documentId: ID!,
$startCellLine: Int,
$endCellLine: Int
) {
getBoundingBoxLabels(
documentId: $documentId,
startCellLine: $startCellLine,
endCellLine: $endCellLine
) {
id
documentId
coordinates {
x
y
}
counter
pageIndex
layer
position {
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
}
hashCode
type
labeledBy
}
}
Variables
{"documentId": 4, "startCellLine": 123, "endCellLine": 987}
Response
{
"data": {
"getBoundingBoxLabels": [
{
"id": "4",
"documentId": "4",
"coordinates": [Coordinate],
"counter": 123,
"pageIndex": 987,
"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": 987, "pageHeight": 987, "pageWidth": 123}
]
}
}
getBuiltInProjectTemplates
Description
Fetches built-in project templates. Returns the new ProjectTemplateV2 structure. If you are looking for custom templates created in team workspaces, use getProjectTemplatesV2 instead.
Response
Returns [ProjectTemplateV2!]!
Example
Query
query GetBuiltInProjectTemplates {
getBuiltInProjectTemplates {
id
name
logoURL
projectTemplateProjectSettingId
projectTemplateTextDocumentSettingId
projectTemplateProjectSetting {
autoMarkDocumentAsComplete
enableEditLabelSet
enableEditSentence
enableLabelerProjectCompletionNotificationThreshold
enableReviewerEditSentence
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
}
projectTemplateTextDocumentSetting {
customScriptId
fileTransformerId
customTextExtractionAPIId
sentenceSeparator
mediaDisplayStrategy
enableTabularMarkdownParsing
firstRowAsHeader
displayedRows
kind
kinds
allTokensMustBeLabeled
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
textLabelMaxTokenLength
ocrMethod
transcriptMethod
ocrProvider
autoScrollWhenLabeling
tokenizer
editSentenceTokenizer
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
type
description
imagePreviewURL
videoURL
}
}
Response
{
"data": {
"getBuiltInProjectTemplates": [
{
"id": 4,
"name": "xyz789",
"logoURL": "abc123",
"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": "abc123",
"videoURL": "xyz789"
}
]
}
}
getCabinet
Description
Returns the specified project's cabinet. Contains list of documents. To get a project's ID, see getProjects.
Example
Query
query GetCabinet(
$projectId: ID!,
$role: Role!
) {
getCabinet(
projectId: $projectId,
role: $role
) {
id
documents
role
status
lastOpenedDocumentId
statistic {
id
numberOfTokens
numberOfLines
}
owner {
id
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": true}
]
}
}
getCabinetEditSentenceConflicts
Response
Returns [EditSentenceConflict!]!
Arguments
| Name | Description |
|---|---|
cabinetId - ID!
|
Example
Query
query GetCabinetEditSentenceConflicts($cabinetId: ID!) {
getCabinetEditSentenceConflicts(cabinetId: $cabinetId) {
documentId
fileName
lines
}
}
Variables
{"cabinetId": "4"}
Response
{
"data": {
"getCabinetEditSentenceConflicts": [
{
"documentId": "xyz789",
"fileName": "abc123",
"lines": [123]
}
]
}
}
getCabinetLabelSetsById
Response
Returns [LabelSet!]!
Arguments
| Name | Description |
|---|---|
cabinetId - ID!
|
Example
Query
query GetCabinetLabelSetsById($cabinetId: ID!) {
getCabinetLabelSetsById(cabinetId: $cabinetId) {
id
name
index
signature
tagItems {
id
parentId
tagName
desc
color
type
arrowRules {
...LabelClassArrowRuleFragment
}
}
lastUsedBy {
projectId
name
}
arrowLabelRequired
}
}
Variables
{"cabinetId": 4}
Response
{
"data": {
"getCabinetLabelSetsById": [
{
"id": "4",
"name": "abc123",
"index": 987,
"signature": "abc123",
"tagItems": [TagItem],
"lastUsedBy": LastUsedProject,
"arrowLabelRequired": false
}
]
}
}
getCellPositionsByMetadata
Description
Returns a paginated list of Cell positions along with its origin document ID.
Response
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
|
input - GetCellPositionsByMetadataPaginatedInput!
|
Example
Query
query GetCellPositionsByMetadata(
$projectId: ID!,
$input: GetCellPositionsByMetadataPaginatedInput!
) {
getCellPositionsByMetadata(
projectId: $projectId,
input: $input
) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
originDocumentId
line
index
}
}
}
Variables
{
"projectId": "4",
"input": GetCellPositionsByMetadataPaginatedInput
}
Response
{
"data": {
"getCellPositionsByMetadata": {
"totalCount": 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": "abc123"
}
Response
{
"data": {
"getCells": {
"totalCount": 123,
"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": "abc123",
"values": [ChartDataRowValue],
"keyPayloadType": "USER",
"keyPayload": KeyPayload
}
]
}
}
getCharts
Response
Returns [Chart!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
|
level - ChartLevel!
|
|
set - ChartSet!
|
Example
Query
query GetCharts(
$teamId: ID!,
$level: ChartLevel!,
$set: ChartSet!
) {
getCharts(
teamId: $teamId,
level: $level,
set: $set
) {
id
name
description
type
level
set
dataTableHeaders
visualizationParams {
visualization
vAxisTitle
hAxisTitle
pieHoleText
chartArea {
...ChartAreaFragment
}
legend {
...LegendFragment
}
colorGradient {
...ColorGradientFragment
}
isStacked
itemsPerPage
colors
abbreviateKey
showTable
unit
}
}
}
Variables
{
"teamId": "4",
"level": "TEAM",
"set": "OLD"
}
Response
{
"data": {
"getCharts": [
{
"id": "4",
"name": "xyz789",
"description": "abc123",
"type": "GROUPED",
"level": "TEAM",
"set": ["OLD"],
"dataTableHeaders": ["abc123"],
"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
Response
Returns [ProjectConfusionMatrixTable!]!
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!
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": "abc123",
"creatorId": "4",
"lastRunAt": "xyz789",
"lastFinishedAt": "abc123",
"externalObjectStorageId": 4,
"externalObjectStorage": ExternalObjectStorage,
"externalObjectStoragePathInput": "abc123",
"externalObjectStoragePathResult": "abc123",
"projectTemplateId": 4,
"projectTemplate": ProjectTemplate,
"assignments": [CreateProjectActionAssignment],
"additionalTagNames": ["abc123"],
"numberOfLabelersPerProject": 987,
"numberOfReviewersPerProject": 987,
"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
Response
Arguments
| Name | Description |
|---|---|
input - CreateProjectActionRunDetailPaginationInput!
|
Example
Query
query GetCreateProjectActionRunDetails($input: CreateProjectActionRunDetailPaginationInput!) {
getCreateProjectActionRunDetails(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
status
runId
startAt
endAt
error {
...DatasaurErrorFragment
}
project
projectPath
documentNames
}
}
}
Variables
{"input": CreateProjectActionRunDetailPaginationInput}
Response
{
"data": {
"getCreateProjectActionRunDetails": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [CreateProjectActionRunDetail]
}
}
}
getCreateProjectActionRuns
Description
Get all activities of a create project Action. Parameters: input: ProjectCreationAutomationPaginationInput
Response
Returns a CreateProjectActionRunPaginatedResponse!
Arguments
| Name | Description |
|---|---|
input - CreateProjectActionPaginationInput!
|
Example
Query
query GetCreateProjectActionRuns($input: CreateProjectActionPaginationInput!) {
getCreateProjectActionRuns(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
actionId
status
currentAppVersion
triggeredByUserId
triggeredBy {
...UserFragment
}
startAt
endAt
totalSuccess
totalFailure
externalObjectStorageId
externalObjectStoragePathInput
externalObjectStoragePathResult
projectTemplate
assignments
numberOfLabelersPerProject
numberOfReviewersPerProject
numberOfLabelersPerDocument
conflictResolutionMode
consensus
}
}
}
Variables
{"input": CreateProjectActionPaginationInput}
Response
{
"data": {
"getCreateProjectActionRuns": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [CreateProjectActionRun]
}
}
}
getCreateProjectActions
Description
Get all create project automations of a team. Parameters: teamId: ID of the team
Response
Returns [CreateProjectAction!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetCreateProjectActions($teamId: ID!) {
getCreateProjectActions(teamId: $teamId) {
id
name
teamId
appVersion
creatorId
lastRunAt
lastFinishedAt
externalObjectStorageId
externalObjectStorage {
id
cloudService
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": "abc123",
"creatorId": 4,
"lastRunAt": "xyz789",
"lastFinishedAt": "xyz789",
"externalObjectStorageId": 4,
"externalObjectStorage": ExternalObjectStorage,
"externalObjectStoragePathInput": "xyz789",
"externalObjectStoragePathResult": "abc123",
"projectTemplateId": "4",
"projectTemplate": ProjectTemplate,
"assignments": [CreateProjectActionAssignment],
"additionalTagNames": ["abc123"],
"numberOfLabelersPerProject": 987,
"numberOfReviewersPerProject": 987,
"numberOfLabelersPerDocument": 123,
"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": "abc123",
"invitationStatus": "xyz789",
"invitationKey": "xyz789",
"isDeleted": true,
"joinedDate": "abc123",
"performance": TeamMemberPerformance
}
}
}
getCustomAPI
Response
Returns a CustomAPI!
Arguments
| Name | Description |
|---|---|
customAPIId - ID!
|
Example
Query
query GetCustomAPI($customAPIId: ID!) {
getCustomAPI(customAPIId: $customAPIId) {
id
teamId
endpointURL
name
purpose
}
}
Variables
{"customAPIId": 4}
Response
{
"data": {
"getCustomAPI": {
"id": 4,
"teamId": 4,
"endpointURL": "abc123",
"name": "abc123",
"purpose": "ASR_API"
}
}
}
getCustomAPIs
Response
Returns [CustomAPI!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
|
purpose - CustomAPIPurpose
|
Example
Query
query GetCustomAPIs(
$teamId: ID!,
$purpose: CustomAPIPurpose
) {
getCustomAPIs(
teamId: $teamId,
purpose: $purpose
) {
id
teamId
endpointURL
name
purpose
}
}
Variables
{"teamId": "4", "purpose": "ASR_API"}
Response
{
"data": {
"getCustomAPIs": [
{
"id": "4",
"teamId": 4,
"endpointURL": "abc123",
"name": "abc123",
"purpose": "ASR_API"
}
]
}
}
getCustomReportMetricsGroupTables
Description
Returns custom report metrics group tables.
Response
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.
getDataProgramming
Response
Returns a DataProgramming
Arguments
| Name | Description |
|---|---|
input - GetDataProgrammingInput
|
Example
Query
query GetDataProgramming($input: GetDataProgrammingInput) {
getDataProgramming(input: $input) {
id
provider
projectId
kind
labelsSignature
labels {
labelId
labelName
}
createdAt
updatedAt
lastGetPredictionsAt
}
}
Variables
{"input": GetDataProgrammingInput}
Response
{
"data": {
"getDataProgramming": {
"id": 4,
"provider": "SNORKEL",
"projectId": 4,
"kind": "DOCUMENT_BASED",
"labelsSignature": "abc123",
"labels": [DataProgrammingLabel],
"createdAt": "xyz789",
"updatedAt": "xyz789",
"lastGetPredictionsAt": "xyz789"
}
}
}
getDataProgrammingLabelingFunctionAnalysis
Response
Arguments
| Name | Description |
|---|---|
input - GetDataProgrammingLabelingFunctionAnalysisInput!
|
Example
Query
query GetDataProgrammingLabelingFunctionAnalysis($input: GetDataProgrammingLabelingFunctionAnalysisInput!) {
getDataProgrammingLabelingFunctionAnalysis(input: $input) {
dataProgrammingId
labelingFunctionId
conflict
coverage
overlap
polarity
}
}
Variables
{"input": GetDataProgrammingLabelingFunctionAnalysisInput}
Response
{
"data": {
"getDataProgrammingLabelingFunctionAnalysis": [
{
"dataProgrammingId": 4,
"labelingFunctionId": "4",
"conflict": 987.65,
"coverage": 123.45,
"overlap": 123.45,
"polarity": [987]
}
]
}
}
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": "abc123",
"updatedAt": "xyz789",
"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": "abc123",
"updatedAt": "abc123"
}
}
}
getDatasaurDinamicRowBasedProviders
Response
Example
Query
query GetDatasaurDinamicRowBasedProviders {
getDatasaurDinamicRowBasedProviders {
name
provider
}
}
Response
{
"data": {
"getDatasaurDinamicRowBasedProviders": [
{
"name": "abc123",
"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": "xyz789"
}
}
}
getDatasaurDinamicTokenBasedProviders
Response
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": 123,
"providerSetting": ProviderSetting,
"modelMetadata": ModelMetadata,
"trainingJobId": "4",
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
getDatasaurPredictiveProviders
Response
Returns [DatasaurPredictiveProviders!]!
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": 987,
"name": "xyz789",
"width": "xyz789",
"displayed": true,
"labelerRestricted": false,
"rowQuestionIndex": 987
}
]
}
}
getDocumentNames
Description
Returns the specified project's document names.
Response
Returns [String!]!
Example
Query
query GetDocumentNames(
$projectId: ID!,
$role: Role!
) {
getDocumentNames(
projectId: $projectId,
role: $role
)
}
Variables
{"projectId": 4, "role": "REVIEWER"}
Response
{"data": {"getDocumentNames": ["xyz789"]}}
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": "abc123",
"required": false,
"config": QuestionConfig,
"bindToColumn": "abc123",
"activationConditionLogic": "xyz789"
}
]
}
}
getEditSentenceConflicts
Response
Returns an EditSentenceConflict!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
Example
Query
query GetEditSentenceConflicts($documentId: ID!) {
getEditSentenceConflicts(documentId: $documentId) {
documentId
fileName
lines
}
}
Variables
{"documentId": "4"}
Response
{
"data": {
"getEditSentenceConflicts": {
"documentId": "abc123",
"fileName": "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": "abc123"}
Response
{
"data": {
"getExtensions": [
{
"id": "abc123",
"title": "abc123",
"url": "xyz789",
"elementType": "xyz789",
"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": "abc123",
"url": "xyz789"
}
]
}
}
getExternalId
Description
Required for AWS S3
Response
Returns an ExternalId!
Example
Query
query GetExternalId {
getExternalId {
externalId
timeLimit
}
}
Response
{
"data": {
"getExternalId": {
"externalId": "abc123",
"timeLimit": 123
}
}
}
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
}
}
createdAt
updatedAt
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getExternalObjectStorages": [
{
"id": 4,
"cloudService": "AWS_S3",
"bucketId": "xyz789",
"bucketName": "xyz789",
"credentials": ExternalObjectStorageCredentials,
"securityToken": "abc123",
"team": Team,
"projects": [Project],
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
getFileTransformer
Response
Returns a FileTransformer!
Arguments
| Name | Description |
|---|---|
fileTransformerId - ID!
|
Example
Query
query GetFileTransformer($fileTransformerId: ID!) {
getFileTransformer(fileTransformerId: $fileTransformerId) {
id
name
content
transpiled
createdAt
updatedAt
language
purpose
readonly
externalId
warmup
}
}
Variables
{"fileTransformerId": "4"}
Response
{
"data": {
"getFileTransformer": {
"id": "4",
"name": "xyz789",
"content": "abc123",
"transpiled": "xyz789",
"createdAt": "abc123",
"updatedAt": "xyz789",
"language": "TYPESCRIPT",
"purpose": "IMPORT",
"readonly": false,
"externalId": "xyz789",
"warmup": true
}
}
}
getFileTransformers
Response
Returns [FileTransformer!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
|
purpose - FileTransformerPurpose
|
Example
Query
query GetFileTransformers(
$teamId: ID!,
$purpose: FileTransformerPurpose
) {
getFileTransformers(
teamId: $teamId,
purpose: $purpose
) {
id
name
content
transpiled
createdAt
updatedAt
language
purpose
readonly
externalId
warmup
}
}
Variables
{"teamId": 4, "purpose": "IMPORT"}
Response
{
"data": {
"getFileTransformers": [
{
"id": 4,
"name": "xyz789",
"content": "xyz789",
"transpiled": "abc123",
"createdAt": "abc123",
"updatedAt": "abc123",
"language": "TYPESCRIPT",
"purpose": "IMPORT",
"readonly": true,
"externalId": "abc123",
"warmup": true
}
]
}
}
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
createdAt
updatedAt
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getFineTunedLlmModels": [
{
"id": 4,
"detail": LlmModelDetail,
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "xyz789",
"displayName": "xyz789",
"url": "abc123",
"maxTemperature": 123.45,
"maxTopP": 123.45,
"maxTokens": 987,
"maxContextWindow": 987,
"defaultTemperature": 123.45,
"defaultTopP": 123.45,
"defaultMaxTokens": 987,
"llmModelFineTuningJob": LlmModelFineTuningJob,
"deployableModelId": "abc123",
"isModelDeployable": true,
"forceAnonymization": true,
"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": 123,
"runPromptMaxAmount": 123,
"runPromptUnit": "abc123",
"embedDocumentCurrentAmount": 987,
"embedDocumentMaxAmount": 987,
"embedDocumentUnit": "abc123",
"embedDocumentUrlCurrentAmount": 987,
"embedDocumentUrlMaxAmount": 123,
"embedDocumentUrlUnit": "abc123",
"llmEvaluationCurrentAmount": 123,
"llmEvaluationMaxAmount": 987,
"llmEvaluationUnit": "xyz789"
}
}
}
getGeneralWorkspaceSettings
Response
Returns a GeneralWorkspaceSettings!
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
Example
Query
query GetGeneralWorkspaceSettings($projectId: ID!) {
getGeneralWorkspaceSettings(projectId: $projectId) {
id
editorFontType
editorFontSize
editorLineSpacing
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": true,
"jumpToNextDocumentOnDocumentCompleted": false,
"jumpToNextSpanOnSubmit": true,
"multipleSelectLabels": true
}
}
}
getGrammarCheckerServiceProviders
Response
Example
Query
query GetGrammarCheckerServiceProviders {
getGrammarCheckerServiceProviders {
id
name
description
}
}
Response
{
"data": {
"getGrammarCheckerServiceProviders": [
{
"id": "4",
"name": "xyz789",
"description": "abc123"
}
]
}
}
getGrammarMistakes
Response
Returns [GrammarMistake!]!
Arguments
| Name | Description |
|---|---|
input - GrammarCheckerInput!
|
Example
Query
query GetGrammarMistakes($input: GrammarCheckerInput!) {
getGrammarMistakes(input: $input) {
text
message
position {
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
}
suggestions
}
}
Variables
{"input": GrammarCheckerInput}
Response
{
"data": {
"getGrammarMistakes": [
{
"text": "abc123",
"message": "abc123",
"position": TextRange,
"suggestions": ["abc123"]
}
]
}
}
getGroundTruthSet
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a GroundTruthSet!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetGroundTruthSet($id: ID!) {
getGroundTruthSet(id: $id) {
id
name
teamId
createdByUserId
createdByUser {
id
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": 987,
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
getGuidelines
Response
Returns [Guideline!]!
Arguments
| Name | Description |
|---|---|
teamId - ID
|
Example
Query
query GetGuidelines($teamId: ID) {
getGuidelines(teamId: $teamId) {
id
name
content
project {
id
team {
...TeamFragment
}
teamId
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
}
}
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getGuidelines": [
{
"id": "4",
"name": "xyz789",
"content": "xyz789",
"project": Project
}
]
}
}
getIAAInformation
Response
Returns an IAAInformation!
Arguments
| Name | Description |
|---|---|
input - IAAInput!
|
Example
Query
query GetIAAInformation($input: IAAInput!) {
getIAAInformation(input: $input) {
agreements {
userId1
userId2
agreement
}
lastUpdatedTime
}
}
Variables
{"input": IAAInput}
Response
{
"data": {
"getIAAInformation": {
"agreements": [IAA],
"lastUpdatedTime": "abc123"
}
}
}
getIAALastUpdatedAt
Please use getIAAInformation instead.
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
|
labelSetSignatures - [String!]
|
|
method - IAAMethodName
|
|
projectIds - [ID!]
|
Example
Query
query GetIAALastUpdatedAt(
$teamId: ID!,
$labelSetSignatures: [String!],
$method: IAAMethodName,
$projectIds: [ID!]
) {
getIAALastUpdatedAt(
teamId: $teamId,
labelSetSignatures: $labelSetSignatures,
method: $method,
projectIds: $projectIds
)
}
Variables
{
"teamId": 4,
"labelSetSignatures": ["abc123"],
"method": "COHENS_KAPPA",
"projectIds": [4]
}
Response
{"data": {"getIAALastUpdatedAt": "xyz789"}}
getInvalidDocumentAnswerInfos
Response
Returns [InvalidAnswerInfo!]!
Arguments
| Name | Description |
|---|---|
cabinetId - ID!
|
Example
Query
query GetInvalidDocumentAnswerInfos($cabinetId: ID!) {
getInvalidDocumentAnswerInfos(cabinetId: $cabinetId) {
documentId
fileName
lines
}
}
Variables
{"cabinetId": 4}
Response
{
"data": {
"getInvalidDocumentAnswerInfos": [
{
"documentId": "4",
"fileName": "xyz789",
"lines": [987]
}
]
}
}
getInvalidRowAnswerInfos
Response
Returns [InvalidAnswerInfo!]!
Arguments
| Name | Description |
|---|---|
cabinetId - ID!
|
Example
Query
query GetInvalidRowAnswerInfos($cabinetId: ID!) {
getInvalidRowAnswerInfos(cabinetId: $cabinetId) {
documentId
fileName
lines
}
}
Variables
{"cabinetId": 4}
Response
{
"data": {
"getInvalidRowAnswerInfos": [
{
"documentId": "4",
"fileName": "abc123",
"lines": [987]
}
]
}
}
getInvoiceUrl
Breaking changes may be introduced anytime in the future without prior notice.
getJob
Description
Get a specific Job by its ID. Can be used to check the status of a ProjectLaunchJob.
Example
Query
query GetJob($jobId: String!) {
getJob(jobId: $jobId) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
}
}
}
Variables
{"jobId": "xyz789"}
Response
{
"data": {
"getJob": {
"id": "abc123",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "xyz789",
"additionalData": JobAdditionalData
}
}
}
getJobs
Response
Returns [Job]!
Arguments
| Name | Description |
|---|---|
jobIds - [String!]!
|
Example
Query
query GetJobs($jobIds: [String!]!) {
getJobs(jobIds: $jobIds) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
}
}
}
Variables
{"jobIds": ["xyz789"]}
Response
{
"data": {
"getJobs": [
{
"id": "abc123",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"additionalData": JobAdditionalData
}
]
}
}
getLLMAssistedLabelingProviders
Response
Arguments
| Name | Description |
|---|---|
input - LLMAssistedLabelingProvidersInput!
|
Example
Query
query GetLLMAssistedLabelingProviders($input: LLMAssistedLabelingProvidersInput!) {
getLLMAssistedLabelingProviders(input: $input) {
name
models
inputFields {
key
name
type
required
maxValue
minValue
}
}
}
Variables
{"input": LLMAssistedLabelingProvidersInput}
Response
{
"data": {
"getLLMAssistedLabelingProviders": [
{
"name": "OPENAI",
"models": ["abc123"],
"inputFields": [
LLMAssistedLabelingProviderInputField
]
}
]
}
}
getLabelErrorDetectionRowBasedSuggestions
Response
Arguments
| Name | Description |
|---|---|
input - GetLabelErrorDetectionRowBasedSuggestionsInput!
|
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": 123.45,
"suggestedLabel": "abc123",
"previousLabel": "xyz789",
"createdAt": "abc123",
"updatedAt": "abc123"
}
]
}
}
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": "abc123",
"updatedAt": "xyz789"
}
}
}
getLabelSetTemplates
Description
Returns a list of labelset templates.
Response
Returns a GetLabelSetTemplatesResponse!
Arguments
| Name | Description |
|---|---|
input - GetLabelSetTemplatesPaginatedInput!
|
Example
Query
query GetLabelSetTemplates($input: GetLabelSetTemplatesPaginatedInput!) {
getLabelSetTemplates(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
}
}
}
Variables
{"input": GetLabelSetTemplatesPaginatedInput}
Response
{
"data": {
"getLabelSetTemplates": {
"totalCount": 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": "abc123",
"tagItems": [TagItem],
"lastUsedBy": LastUsedProject,
"arrowLabelRequired": true
}
]
}
}
getLabelingFunction
Response
Returns a LabelingFunction!
Arguments
| Name | Description |
|---|---|
input - GetLabelingFunctionInput!
|
Example
Query
query GetLabelingFunction($input: GetLabelingFunctionInput!) {
getLabelingFunction(input: $input) {
id
dataProgrammingId
heuristicArgument
annotatorArgument
name
content
active
createdAt
updatedAt
}
}
Variables
{"input": GetLabelingFunctionInput}
Response
{
"data": {
"getLabelingFunction": {
"id": "4",
"dataProgrammingId": "4",
"heuristicArgument": HeuristicArgumentScalar,
"annotatorArgument": AnnotatorArgumentScalar,
"name": "abc123",
"content": "xyz789",
"active": false,
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
getLabelingFunctions
Response
Returns [LabelingFunction!]
Arguments
| Name | Description |
|---|---|
input - GetLabelingFunctionsInput!
|
Example
Query
query GetLabelingFunctions($input: GetLabelingFunctionsInput!) {
getLabelingFunctions(input: $input) {
id
dataProgrammingId
heuristicArgument
annotatorArgument
name
content
active
createdAt
updatedAt
}
}
Variables
{"input": GetLabelingFunctionsInput}
Response
{
"data": {
"getLabelingFunctions": [
{
"id": "4",
"dataProgrammingId": "4",
"heuristicArgument": HeuristicArgumentScalar,
"annotatorArgument": AnnotatorArgumentScalar,
"name": "xyz789",
"content": "xyz789",
"active": true,
"createdAt": "abc123",
"updatedAt": "abc123"
}
]
}
}
getLabelingFunctionsPairKappa
Response
Returns a GetLabelingFunctionsPairKappaOutput!
Arguments
| Name | Description |
|---|---|
input - GetLabelingFunctionsPairKappaInput!
|
Example
Query
query GetLabelingFunctionsPairKappa($input: GetLabelingFunctionsPairKappaInput!) {
getLabelingFunctionsPairKappa(input: $input) {
labelingFunctionPairKappas {
labelingFunctionId1
labelingFunctionId2
kappa
}
lastCalculatedAt
}
}
Variables
{"input": GetLabelingFunctionsPairKappaInput}
Response
{
"data": {
"getLabelingFunctionsPairKappa": {
"labelingFunctionPairKappas": [
LabelingFunctionPairKappa
],
"lastCalculatedAt": "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": 987,
"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 {
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedASRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enableActions
enableAddDocumentsToProject
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurDinamicTokenBased
enableDatasaurPredictiveRowBased
enableWipeData
enableExportTeamOverview
enableTransferOwnership
enableLabelErrorDetectionRowBased
allowedExtraAutoLabelProviders
enableLLMProject
enableRegexSentenceSeparator
enableTeamRoleSupervisor
endExtensionTrialAt
allowInvalidPaymentMethod
enableExternalKnowledgeBase
enableForceAnonymization
}
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": "xyz789",
"setting": TeamSetting,
"owner": User,
"isExpired": true,
"expiredAt": "2007-12-03T10:15:30Z"
}
}
}
getLlmApplication
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplication
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetLlmApplication($id: ID!) {
getLlmApplication(id: $id) {
id
teamId
createdByUser {
id
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": "xyz789",
"status": "DEPLOYED",
"createdAt": "xyz789",
"updatedAt": "xyz789",
"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": "abc123",
"updatedAt": "abc123"
}
}
}
getLlmApplicationConfigurations
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns [LlmApplicationConfiguration!]!
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": "abc123",
"teamId": 4,
"createdByUserId": "4",
"createdByUser": User,
"updatedByUserId": "4",
"updatedByUser": User,
"llmRagConfigId": 4,
"llmRagConfig": LlmRagConfig,
"createdAt": "abc123",
"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": 987,
"numberOfInputTokens": 987,
"numberOfOutputTokens": 987,
"deployedAt": "xyz789",
"createdAt": "xyz789",
"updatedAt": "abc123",
"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": 123,
"numberOfTokens": 987,
"numberOfInputTokens": 123,
"numberOfOutputTokens": 123,
"deployedAt": "abc123",
"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": "xyz789",
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
getLlmApplicationPlaygroundPrompts
Breaking changes may be introduced anytime in the future without prior notice.
Response
Arguments
| Name | Description |
|---|---|
llmApplicationId - ID!
|
Example
Query
query GetLlmApplicationPlaygroundPrompts($llmApplicationId: ID!) {
getLlmApplicationPlaygroundPrompts(llmApplicationId: $llmApplicationId) {
id
llmApplicationId
name
prompt
createdAt
updatedAt
}
}
Variables
{"llmApplicationId": "4"}
Response
{
"data": {
"getLlmApplicationPlaygroundPrompts": [
{
"id": 4,
"llmApplicationId": "4",
"name": "abc123",
"prompt": "abc123",
"createdAt": "abc123",
"updatedAt": "abc123"
}
]
}
}
getLlmApplicationPlaygroundRagConfig
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplicationPlaygroundRagConfig!
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": "xyz789",
"updatedAt": "xyz789"
}
}
}
getLlmApplicationPlaygroundRagConfigs
Breaking changes may be introduced anytime in the future without prior notice.
Response
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.
Response
Returns a LlmApplicationPaginatedResponse!
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": "xyz789",
"status": "DEPLOYED",
"createdAt": "abc123",
"updatedAt": "xyz789",
"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": "abc123",
"teamId": "4",
"name": "abc123",
"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": "xyz789",
"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": [
"abc123"
],
"supportedInferenceInstanceTypeDetails": [
LlmInstanceTypeDetail
]
}
}
}
getLlmEmbeddingModels
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns [LlmEmbeddingModel!]!
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": "xyz789",
"displayName": "xyz789",
"url": "abc123",
"maxTokens": 987,
"dimensions": 987,
"deployableModelId": "xyz789",
"isModelDeployable": false,
"createdAt": "abc123",
"updatedAt": "abc123",
"customDimension": false
}
]
}
}
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": "abc123",
"teamId": 4,
"projectId": "4",
"kind": "DOCUMENT_BASED",
"status": "CREATED",
"creationProgress": LlmEvaluationCreationProgress,
"llmEvaluationRagConfigs": [LlmEvaluationRagConfig],
"llmEvaluationPrompts": [LlmEvaluationPrompt],
"llmEvaluationEvaluators": [LlmEvaluationEvaluator],
"llmEvaluationExecutions": [LlmEvaluationExecution],
"scheduledCommandConfig": ScheduledCommandConfig,
"isScheduled": false,
"createdAt": "abc123",
"updatedAt": "abc123",
"isDeleted": false,
"type": "RATING",
"schedulingStatus": "NOT_STARTED",
"nextSchedule": "xyz789"
}
}
}
getLlmEvaluationAutomatedAvailableStrategies
Breaking changes may be introduced anytime in the future without prior notice.
Description
Returns the available automated LLM evaluation strategies.
Response
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": "xyz789",
"displayName": "xyz789",
"provider": "xyz789",
"version": "abc123",
"description": "xyz789",
"deprecated": false,
"evaluatorModelTypes": ["LLM_MODEL"],
"minValue": 987.65,
"maxValue": 987.65,
"invertedValue": false,
"requiresContext": false
}
]
}
}
getLlmEvaluationCreationProgress
Breaking changes may be introduced anytime in the future without prior notice.
Description
Retrieves the LLM evaluation creation progress.
Response
Returns a LlmEvaluationCreationProgress!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetLlmEvaluationCreationProgress($id: ID!) {
getLlmEvaluationCreationProgress(id: $id) {
status
jobId
error
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getLlmEvaluationCreationProgress": {
"status": "PREPARING",
"jobId": "abc123",
"error": "abc123"
}
}
}
getLlmEvaluationDetail
Breaking changes may be introduced anytime in the future without prior notice.
Description
Retrieves the LLM evaluation detail based on the provided id.
Response
Returns a LlmEvaluationDetailPaginatedResponse!
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": 123,
"pageInfo": PageInfo,
"nodes": [LlmEvaluationDetail]
}
}
}
getLlmEvaluationReport
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": "abc123",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "abc123",
"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!
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": 987,
"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": 987,
"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": "xyz789"
}
}
getLlmModelFineTuningCostPredictionAsync
Breaking changes may be introduced anytime in the future without prior notice.
Description
Get Predicted cost for fine-tuning
Response
Returns a LlmModelFineTuningCostPredictionJob!
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": "abc123",
"displayName": "abc123",
"description": "abc123",
"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": [
"xyz789"
],
"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
createdAt
updatedAt
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getLlmModels": [
{
"id": 4,
"detail": LlmModelDetail,
"teamId": 4,
"provider": "AMAZON_BEDROCK",
"name": "xyz789",
"displayName": "abc123",
"url": "abc123",
"maxTemperature": 987.65,
"maxTopP": 987.65,
"maxTokens": 123,
"maxContextWindow": 123,
"defaultTemperature": 123.45,
"defaultTopP": 987.65,
"defaultMaxTokens": 987,
"llmModelFineTuningJob": LlmModelFineTuningJob,
"deployableModelId": "xyz789",
"isModelDeployable": false,
"forceAnonymization": false,
"createdAt": "abc123",
"updatedAt": "xyz789"
}
]
}
}
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!
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": 987,
"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": 987,
"documents": [LlmVectorStoreDocumentScalar],
"documentStatusCount": LlmVectorStoreDocumentCountByStatus,
"sourceDocuments": [LlmVectorStoreSourceDocument],
"questions": [Question],
"jobId": "abc123",
"createdAt": "abc123",
"updatedAt": "xyz789",
"dimension": 123
}
}
}
getLlmVectorStoreActivities
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a GetLlmVectorStoreActivityResponse!
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
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": "xyz789",
"path": "abc123",
"previewPath": "abc123",
"type": "FOLDER",
"status": "QUEUED",
"errorMessage": "abc123",
"llmVectorStoreSource": LlmVectorStoreSource,
"llmVectorStoreSourceId": 4,
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
getLlmVectorStoreDocumentsIncludingDeleted
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a GetLlmVectorStoreDocumentsIncludingDeletedResponse
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.
Response
Returns a LlmVectorStoreDocumentPaginatedResponse!
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": 987,
"pageInfo": PageInfo,
"nodes": [LlmVectorStoreDocumentPaginationItem]
}
}
}
getLlmVectorStoreSourceDeletedDocuments
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmVectorStoreSourceDocumentScalar!
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.
Response
Returns a LlmVectorStoreSourceDocumentScalar!
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.
Response
Returns a LlmVectorStoreSourceDocumentScalar!
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": "xyz789",
"updatedAt": "abc123"
}
]
}
}
getLlmVectorStores
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmVectorStorePaginatedResponse!
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": 123,
"pageInfo": PageInfo,
"nodes": [LlmVectorStore]
}
}
}
getMarkedUnusedLabelClassIds
Description
Get all label class ids which are marked as N/A.
Response
Returns [MarkedUnusedLabelClassIds!]!
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.
Response
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
Example
Query
query GetMarkedUnusedLabelClasses($projectId: ID!) {
getMarkedUnusedLabelClasses(projectId: $projectId)
}
Variables
{"projectId": "4"}
Response
{
"data": {
"getMarkedUnusedLabelClasses": [
ProjectUnusedLabelClassScalar
]
}
}
getMonthlySubscriptionPrice
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a Float!
Example
Query
query GetMonthlySubscriptionPrice {
getMonthlySubscriptionPrice
}
Response
{"data": {"getMonthlySubscriptionPrice": 123.45}}
getOCRContentPositionMaps
Response
Returns an OCRContentPositionMapsResult!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
Example
Query
query GetOCRContentPositionMaps($documentId: ID!) {
getOCRContentPositionMaps(documentId: $documentId) {
documentId
maps {
mediaToTranscript
transcriptToMedia
}
}
}
Variables
{"documentId": "4"}
Response
{
"data": {
"getOCRContentPositionMaps": {
"documentId": 4,
"maps": OCRContentPositionMaps
}
}
}
getOverallProjectPerformance
Description
Get projects count based on its status. (Optional) Filter by tag names (supports multiple selections with OR logic).
Response
Returns an OverallProjectPerformance!
Example
Query
query GetOverallProjectPerformance(
$teamId: ID!,
$tagNames: [String!]
) {
getOverallProjectPerformance(
teamId: $teamId,
tagNames: $tagNames
) {
total
completed
inReview
reviewReady
inProgress
created
}
}
Variables
{"teamId": 4, "tagNames": ["abc123"]}
Response
{
"data": {
"getOverallProjectPerformance": {
"total": 123,
"completed": 123,
"inReview": 123,
"reviewReady": 123,
"inProgress": 987,
"created": 123
}
}
}
getPaginatedChartData
This Query will be removed in the future, please use getCharts.
Response
Returns a PaginatedChartDataResponse!
Arguments
| Name | Description |
|---|---|
input - PaginatedAnalyticsDashboardQueryInput!
|
Example
Query
query GetPaginatedChartData($input: PaginatedAnalyticsDashboardQueryInput!) {
getPaginatedChartData(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
key
values {
...ChartDataRowValueFragment
}
keyPayloadType
keyPayload
}
}
}
Variables
{"input": PaginatedAnalyticsDashboardQueryInput}
Response
{
"data": {
"getPaginatedChartData": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [ChartDataRow]
}
}
}
getPaginatedGroundTruthSet
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a GetPaginatedGroundTruthSetResponse!
Arguments
| Name | Description |
|---|---|
input - GetPaginatedGroundTruthSetInput!
|
Example
Query
query GetPaginatedGroundTruthSet($input: GetPaginatedGroundTruthSetInput!) {
getPaginatedGroundTruthSet(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
name
teamId
createdByUserId
createdByUser {
...UserFragment
}
items {
...GroundTruthFragment
}
itemsCount
createdAt
updatedAt
}
}
}
Variables
{"input": GetPaginatedGroundTruthSetInput}
Response
{
"data": {
"getPaginatedGroundTruthSet": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [GroundTruthSet]
}
}
}
getPaginatedGroundTruthSetItems
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a GetPaginatedGroundTruthSetItemsResponse!
Arguments
| Name | Description |
|---|---|
input - GetPaginatedGroundTruthSetItemsInput!
|
Example
Query
query GetPaginatedGroundTruthSetItems($input: GetPaginatedGroundTruthSetItemsInput!) {
getPaginatedGroundTruthSetItems(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
groundTruthSetId
prompt
answer
createdAt
updatedAt
}
}
}
Variables
{"input": GetPaginatedGroundTruthSetItemsInput}
Response
{
"data": {
"getPaginatedGroundTruthSetItems": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [GroundTruth]
}
}
}
getPaginatedLlmApplicationConfigurations
Breaking changes may be introduced anytime in the future without prior notice.
Response
Arguments
| Name | Description |
|---|---|
input - GetPaginatedLlmApplicationConfigurationInput!
|
Example
Query
query GetPaginatedLlmApplicationConfigurations($input: GetPaginatedLlmApplicationConfigurationInput!) {
getPaginatedLlmApplicationConfigurations(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
name
teamId
createdByUserId
createdByUser {
...UserFragment
}
updatedByUserId
updatedByUser {
...UserFragment
}
llmRagConfigId
llmRagConfig {
...LlmRagConfigFragment
}
createdAt
updatedAt
}
}
}
Variables
{"input": GetPaginatedLlmApplicationConfigurationInput}
Response
{
"data": {
"getPaginatedLlmApplicationConfigurations": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [LlmApplicationConfiguration]
}
}
}
getPaginatedQuestionSets
Response
Returns a GetPaginatedQuestionSetResponse!
Arguments
| Name | Description |
|---|---|
input - GetPaginatedQuestionSetInput!
|
Example
Query
query GetPaginatedQuestionSets($input: GetPaginatedQuestionSetInput!) {
getPaginatedQuestionSets(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
createdAt
updatedAt
}
}
}
Variables
{"input": GetPaginatedQuestionSetInput}
Response
{
"data": {
"getPaginatedQuestionSets": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [QuestionSet]
}
}
}
getPairKappas
Please use getIAAInformation instead.
Response
Returns [PairKappa!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
|
labelSetSignatures - [String!]
|
|
method - IAAMethodName
|
|
projectIds - [ID!]
|
Example
Query
query GetPairKappas(
$teamId: ID!,
$labelSetSignatures: [String!],
$method: IAAMethodName,
$projectIds: [ID!]
) {
getPairKappas(
teamId: $teamId,
labelSetSignatures: $labelSetSignatures,
method: $method,
projectIds: $projectIds
) {
userId1
userId2
kappa
}
}
Variables
{
"teamId": 4,
"labelSetSignatures": ["abc123"],
"method": "COHENS_KAPPA",
"projectIds": ["4"]
}
Response
{"data": {"getPairKappas": [{"userId1": 123, "userId2": 987, "kappa": 987.65}]}}
getPaymentMethod
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a PaymentMethod!
Example
Query
query GetPaymentMethod(
$teamId: ID!,
$stripePaymentMethodId: String
) {
getPaymentMethod(
teamId: $teamId,
stripePaymentMethodId: $stripePaymentMethodId
) {
hasPaymentMethod
detail {
type
fundingType
displayBrand
creditCardLastFourNumber
creditCardExpiryMonth
creditCardExpiryYear
markedForRemoval
status
createdAt
updatedAt
}
}
}
Variables
{
"teamId": 4,
"stripePaymentMethodId": "abc123"
}
Response
{
"data": {
"getPaymentMethod": {
"hasPaymentMethod": false,
"detail": PaymentMethodDetail
}
}
}
getPersonalTags
Description
Returns a list of personal tags.
Response
Returns [Tag!]!
Arguments
| Name | Description |
|---|---|
input - GetPersonalTagsInput
|
Example
Query
query GetPersonalTags($input: GetPersonalTagsInput) {
getPersonalTags(input: $input) {
id
name
globalTag
}
}
Variables
{"input": GetPersonalTagsInput}
Response
{
"data": {
"getPersonalTags": [
{
"id": "4",
"name": "xyz789",
"globalTag": true
}
]
}
}
getPinnedProjectTemplates
Response
Returns [ProjectTemplateV2!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetPinnedProjectTemplates($teamId: ID!) {
getPinnedProjectTemplates(teamId: $teamId) {
id
name
logoURL
projectTemplateProjectSettingId
projectTemplateTextDocumentSettingId
projectTemplateProjectSetting {
autoMarkDocumentAsComplete
enableEditLabelSet
enableEditSentence
enableLabelerProjectCompletionNotificationThreshold
enableReviewerEditSentence
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
}
projectTemplateTextDocumentSetting {
customScriptId
fileTransformerId
customTextExtractionAPIId
sentenceSeparator
mediaDisplayStrategy
enableTabularMarkdownParsing
firstRowAsHeader
displayedRows
kind
kinds
allTokensMustBeLabeled
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
textLabelMaxTokenLength
ocrMethod
transcriptMethod
ocrProvider
autoScrollWhenLabeling
tokenizer
editSentenceTokenizer
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
type
description
imagePreviewURL
videoURL
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getPinnedProjectTemplates": [
{
"id": 4,
"name": "xyz789",
"logoURL": "xyz789",
"projectTemplateProjectSettingId": "4",
"projectTemplateTextDocumentSettingId": "4",
"projectTemplateProjectSetting": ProjectTemplateProjectSetting,
"projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
"labelSetTemplates": [LabelSetTemplate],
"questionSets": [QuestionSet],
"createdAt": "xyz789",
"updatedAt": "abc123",
"purpose": "LABELING",
"creatorId": 4,
"type": "CUSTOM",
"description": "abc123",
"imagePreviewURL": "abc123",
"videoURL": "abc123"
}
]
}
}
getPlaygroundCostPrediction
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a CostPredictionResponse!
Example
Query
query GetPlaygroundCostPrediction(
$llmApplicationId: ID!,
$promptId: ID!,
$playgroundRagConfigIds: [ID!]
) {
getPlaygroundCostPrediction(
llmApplicationId: $llmApplicationId,
promptId: $promptId,
playgroundRagConfigIds: $playgroundRagConfigIds
) {
costPerPromptTemplate {
promptTemplateId
promptTemplateName
modelName
tokens {
...TokenUsagesFragment
}
tokenUnitPrices {
...TokenUnitPricesFragment
}
tokenPrices {
...TokenPricesFragment
}
coveredByDatasaur
pricingUsageType
}
totalChars {
coveredByDatasaur
notCoveredByDatasaur
total
}
totalTokens {
coveredByDatasaur
notCoveredByDatasaur
total
}
totalPrice {
coveredByDatasaur
notCoveredByDatasaur
total
}
}
}
Variables
{
"llmApplicationId": 4,
"promptId": "4",
"playgroundRagConfigIds": [4]
}
Response
{
"data": {
"getPlaygroundCostPrediction": {
"costPerPromptTemplate": [
PromptTemplateCostPrediction
],
"totalChars": CostPredictionTotal,
"totalTokens": CostPredictionTotal,
"totalPrice": CostPredictionTotalPrice
}
}
}
getPlaygroundCreditCost
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns an Int!
Example
Query
query GetPlaygroundCreditCost(
$llmApplicationId: ID!,
$playgroundPromptIds: [ID]!,
$playgroundRagConfigIds: [ID!]
) {
getPlaygroundCreditCost(
llmApplicationId: $llmApplicationId,
playgroundPromptIds: $playgroundPromptIds,
playgroundRagConfigIds: $playgroundRagConfigIds
)
}
Variables
{
"llmApplicationId": 4,
"playgroundPromptIds": [4],
"playgroundRagConfigIds": ["4"]
}
Response
{"data": {"getPlaygroundCreditCost": 123}}
getPredictedLabels
Response
Returns [TextLabel!]!
Arguments
| Name | Description |
|---|---|
input - GetPredictedLabelsInput!
|
Example
Query
query GetPredictedLabels($input: GetPredictedLabelsInput!) {
getPredictedLabels(input: $input) {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
labeledByUserId
createdAt
updatedAt
documentId
start {
sentenceId
tokenId
charId
}
end {
sentenceId
tokenId
charId
}
confidenceScore
}
}
Variables
{"input": GetPredictedLabelsInput}
Response
{
"data": {
"getPredictedLabels": [
{
"id": "abc123",
"l": "xyz789",
"layer": 987,
"deleted": true,
"hashCode": "abc123",
"labeledBy": "AUTO",
"labeledByUser": User,
"labeledByUserId": 987,
"createdAt": "abc123",
"updatedAt": "xyz789",
"documentId": "abc123",
"start": TextCursor,
"end": TextCursor,
"confidenceScore": 123.45
}
]
}
}
getPredictedRowAnswers
Response
Returns [RowAnswer!]!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
Example
Query
query GetPredictedRowAnswers($documentId: ID!) {
getPredictedRowAnswers(documentId: $documentId) {
documentId
line
answers
metadata {
path
labeledBy
createdAt
updatedAt
}
updatedAt
}
}
Variables
{"documentId": 4}
Response
{
"data": {
"getPredictedRowAnswers": [
{
"documentId": "4",
"line": 123,
"answers": AnswerScalar,
"metadata": [AnswerMetadata],
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
getProject
Description
Returns a single project identified by its ID.
Response
Returns a Project!
Arguments
| Name | Description |
|---|---|
input - GetProjectInput!
|
Example
Query
query GetProject($input: GetProjectInput!) {
getProject(input: $input) {
id
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
teamId
owner {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
createdAt
updatedAt
}
name
tags {
id
name
globalTag
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
autoMarkDocumentAsComplete
consensus
conflictResolution {
...ConflictResolutionFragment
}
dynamicReviewMethod
dynamicReviewMemberId
enableEditLabelSet
enableReviewerEditSentence
enableReviewerInsertSentence
enableReviewerDeleteSentence
enableEditSentence
enableInsertSentence
enableDeleteSentence
enableDirectBBoxEditing
enableEnforceAutoLabelReviewerSettings
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
shouldConfirmUnusedLabelSetItems
spotChecking {
...SpotCheckingFragment
}
}
workspaceSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
asrProvider
kinds
sentenceSeparator
displayedRows
mediaDisplayStrategy
tokenizer
firstRowAsHeader
transcriptMethod
ocrProvider
customScriptId
fileTransformerId
customTextExtractionAPIId
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
}
reviewingStatus {
isCompleted
statistic {
...ReviewingStatusStatisticFragment
}
}
labelingStatus {
labeler {
...TeamMemberFragment
}
isCompleted
isStarted
statistic {
...LabelingStatusStatisticFragment
}
statisticsToShow {
...StatisticItemFragment
}
}
status
performance {
project {
...ProjectFragment
}
projectId
totalTimeSpent
effectiveTotalTimeSpent
conflicts
totalLabelApplied
numberOfAcceptedLabels
numberOfDocuments
numberOfTokens
numberOfLines
}
selfLabelingStatus
purpose
rootCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
reviewCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
labelerCabinets {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
guideline {
id
name
content
project {
...ProjectFragment
}
}
isArchived
projectMetadataItems {
id
teamId
creatorId
key
value
createdAt
updatedAt
}
}
}
Variables
{"input": GetProjectInput}
Response
{
"data": {
"getProject": {
"id": "4",
"team": Team,
"teamId": "4",
"owner": User,
"externalObjectStorageId": "abc123",
"rootDocumentId": 4,
"assignees": [ProjectAssignment],
"name": "abc123",
"tags": [Tag],
"type": "xyz789",
"createdDate": "xyz789",
"completedDate": "xyz789",
"exportedDate": "xyz789",
"updatedDate": "xyz789",
"isOwnerMe": true,
"isReviewByMeAllowed": true,
"settings": ProjectSettings,
"workspaceSettings": WorkspaceSettings,
"reviewingStatus": ReviewingStatus,
"labelingStatus": [LabelingStatus],
"status": "CREATED",
"performance": ProjectPerformance,
"selfLabelingStatus": "NOT_STARTED",
"purpose": "LABELING",
"rootCabinet": Cabinet,
"reviewCabinet": Cabinet,
"labelerCabinets": [Cabinet],
"guideline": Guideline,
"isArchived": true,
"projectMetadataItems": [ProjectMetadataItem]
}
}
}
getProjectCabinets
Description
Returns all of the project's cabinets.
Response
Returns [Cabinet!]!
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
Example
Query
query GetProjectCabinets($projectId: ID!) {
getProjectCabinets(projectId: $projectId) {
id
documents
role
status
lastOpenedDocumentId
statistic {
id
numberOfTokens
numberOfLines
}
owner {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
createdAt
}
}
Variables
{"projectId": 4}
Response
{
"data": {
"getProjectCabinets": [
{
"id": 4,
"documents": [TextDocumentScalar],
"role": "REVIEWER",
"status": "IN_PROGRESS",
"lastOpenedDocumentId": 4,
"statistic": CabinetStatistic,
"owner": User,
"createdAt": "2007-12-03T10:15:30Z"
}
]
}
}
getProjectConflictsCount
Description
Total Project Conflict Count. Returns total label conflicts plus edit sentence conflicts
Response
Returns [ProjectConflictsCountItem!]!
Example
Query
query GetProjectConflictsCount(
$projectId: ID!,
$role: Role
) {
getProjectConflictsCount(
projectId: $projectId,
role: $role
) {
documentId
numberOfConflicts
}
}
Variables
{"projectId": 4, "role": "REVIEWER"}
Response
{
"data": {
"getProjectConflictsCount": [
{
"documentId": "xyz789",
"numberOfConflicts": 123
}
]
}
}
getProjectContributors
Response
Returns [CabinetContributor!]!
Example
Query
query GetProjectContributors(
$teamId: ID!,
$projectId: ID!
) {
getProjectContributors(
teamId: $teamId,
projectId: $projectId
) {
cabinetId
cabinetOwnerId
contributors {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
}
}
Variables
{"teamId": 4, "projectId": 4}
Response
{
"data": {
"getProjectContributors": [
{
"cabinetId": 4,
"cabinetOwnerId": 4,
"contributors": [User]
}
]
}
}
getProjectDocumentAnswerReviewProgress
Response
Returns a ProjectDocumentsReviewProgress!
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
Example
Query
query GetProjectDocumentAnswerReviewProgress($projectId: ID!) {
getProjectDocumentAnswerReviewProgress(projectId: $projectId) {
projectId
totalToReview
totalReviewed
}
}
Variables
{"projectId": "4"}
Response
{
"data": {
"getProjectDocumentAnswerReviewProgress": {
"projectId": "4",
"totalToReview": 987,
"totalReviewed": 987
}
}
}
getProjectDocumentQuestionSet
Response
Returns a ProjectQuestionSet!
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
Example
Query
query GetProjectDocumentQuestionSet($projectId: ID!) {
getProjectDocumentQuestionSet(projectId: $projectId) {
questions {
id
internalId
type
name
label
required
config {
...QuestionConfigFragment
}
bindToColumn
activationConditionLogic
}
signature
}
}
Variables
{"projectId": 4}
Response
{
"data": {
"getProjectDocumentQuestionSet": {
"questions": [Question],
"signature": "abc123"
}
}
}
getProjectExtension
Response
Returns a ProjectExtension
Arguments
| Name | Description |
|---|---|
cabinetId - ID!
|
Example
Query
query GetProjectExtension($cabinetId: ID!) {
getProjectExtension(cabinetId: $cabinetId) {
id
cabinetId
elements {
id
enabled
extension {
...ExtensionFragment
}
height
order
setting {
...ExtensionElementSettingFragment
}
}
width
}
}
Variables
{"cabinetId": 4}
Response
{
"data": {
"getProjectExtension": {
"id": "4",
"cabinetId": 4,
"elements": [ExtensionElement],
"width": 987
}
}
}
getProjectLabelersDocumentStatus
Response
Arguments
| Name | Description |
|---|---|
input - GetProjectInput
|
Example
Query
query GetProjectLabelersDocumentStatus($input: GetProjectInput) {
getProjectLabelersDocumentStatus(input: $input) {
originId
assignedLabelers {
id
user {
...UserFragment
}
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
}
completedLabelers {
id
user {
...UserFragment
}
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
}
}
}
Variables
{"input": GetProjectInput}
Response
{
"data": {
"getProjectLabelersDocumentStatus": [
{
"originId": "4",
"assignedLabelers": [TeamMember],
"completedLabelers": [TeamMember]
}
]
}
}
getProjectMetadataItems
Response
Returns a PaginatedProjectMetadataItem!
Arguments
| Name | Description |
|---|---|
input - GetProjectMetadataItemsInput!
|
Example
Query
query GetProjectMetadataItems($input: GetProjectMetadataItemsInput!) {
getProjectMetadataItems(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
teamId
creatorId
key
value
createdAt
updatedAt
}
}
}
Variables
{"input": GetProjectMetadataItemsInput}
Response
{
"data": {
"getProjectMetadataItems": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [ProjectMetadataItem]
}
}
}
getProjectRowQuestionSet
Response
Returns a ProjectQuestionSet!
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
Example
Query
query GetProjectRowQuestionSet($projectId: ID!) {
getProjectRowQuestionSet(projectId: $projectId) {
questions {
id
internalId
type
name
label
required
config {
...QuestionConfigFragment
}
bindToColumn
activationConditionLogic
}
signature
}
}
Variables
{"projectId": "4"}
Response
{
"data": {
"getProjectRowQuestionSet": {
"questions": [Question],
"signature": "xyz789"
}
}
}
getProjectSample
Description
Returns a single project identified by its ID.
Response
Returns a ProjectSample!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetProjectSample($id: ID!) {
getProjectSample(id: $id) {
id
displayName
exportableJSON
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getProjectSample": {
"id": 4,
"displayName": "xyz789",
"exportableJSON": "xyz789"
}
}
}
getProjectSamples
Description
Returns a list of ProjectSample matching the given name
Response
Returns [ProjectSample!]!
Arguments
| Name | Description |
|---|---|
displayName - String
|
Example
Query
query GetProjectSamples($displayName: String) {
getProjectSamples(displayName: $displayName) {
id
displayName
exportableJSON
}
}
Variables
{"displayName": "xyz789"}
Response
{
"data": {
"getProjectSamples": [
{
"id": 4,
"displayName": "xyz789",
"exportableJSON": "abc123"
}
]
}
}
getProjectSummaryReport
Response
Returns a ProjectSummaryReport!
Example
Query
query GetProjectSummaryReport(
$teamId: ID!,
$projectId: ID!
) {
getProjectSummaryReport(
teamId: $teamId,
projectId: $projectId
) {
projectId
metrics {
key
value
}
}
}
Variables
{"teamId": "4", "projectId": 4}
Response
{
"data": {
"getProjectSummaryReport": {
"projectId": 4,
"metrics": [ProjectSummaryMetric]
}
}
}
getProjectTemplate
Please use getProjectTemplateV2 instead.
Response
Returns a ProjectTemplate!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetProjectTemplate($id: ID!) {
getProjectTemplate(id: $id) {
id
name
teamId
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
logoURL
projectTemplateProjectSettingId
projectTemplateTextDocumentSettingId
projectTemplateProjectSetting {
autoMarkDocumentAsComplete
enableEditLabelSet
enableEditSentence
enableLabelerProjectCompletionNotificationThreshold
enableReviewerEditSentence
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
}
projectTemplateTextDocumentSetting {
customScriptId
fileTransformerId
customTextExtractionAPIId
sentenceSeparator
mediaDisplayStrategy
enableTabularMarkdownParsing
firstRowAsHeader
displayedRows
kind
kinds
allTokensMustBeLabeled
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
textLabelMaxTokenLength
ocrMethod
transcriptMethod
ocrProvider
autoScrollWhenLabeling
tokenizer
editSentenceTokenizer
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getProjectTemplate": {
"id": "4",
"name": "xyz789",
"teamId": 4,
"team": Team,
"logoURL": "xyz789",
"projectTemplateProjectSettingId": 4,
"projectTemplateTextDocumentSettingId": 4,
"projectTemplateProjectSetting": ProjectTemplateProjectSetting,
"projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
"labelSetTemplates": [LabelSetTemplate],
"questionSets": [QuestionSet],
"createdAt": "xyz789",
"updatedAt": "xyz789",
"purpose": "LABELING",
"creatorId": 4
}
}
}
getProjectTemplateV2
Response
Returns a ProjectTemplateV2!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetProjectTemplateV2($id: ID!) {
getProjectTemplateV2(id: $id) {
id
name
logoURL
projectTemplateProjectSettingId
projectTemplateTextDocumentSettingId
projectTemplateProjectSetting {
autoMarkDocumentAsComplete
enableEditLabelSet
enableEditSentence
enableLabelerProjectCompletionNotificationThreshold
enableReviewerEditSentence
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
}
projectTemplateTextDocumentSetting {
customScriptId
fileTransformerId
customTextExtractionAPIId
sentenceSeparator
mediaDisplayStrategy
enableTabularMarkdownParsing
firstRowAsHeader
displayedRows
kind
kinds
allTokensMustBeLabeled
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
textLabelMaxTokenLength
ocrMethod
transcriptMethod
ocrProvider
autoScrollWhenLabeling
tokenizer
editSentenceTokenizer
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
type
description
imagePreviewURL
videoURL
}
}
Variables
{"id": 4}
Response
{
"data": {
"getProjectTemplateV2": {
"id": "4",
"name": "abc123",
"logoURL": "abc123",
"projectTemplateProjectSettingId": 4,
"projectTemplateTextDocumentSettingId": "4",
"projectTemplateProjectSetting": ProjectTemplateProjectSetting,
"projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
"labelSetTemplates": [LabelSetTemplate],
"questionSets": [QuestionSet],
"createdAt": "abc123",
"updatedAt": "abc123",
"purpose": "LABELING",
"creatorId": "4",
"type": "CUSTOM",
"description": "xyz789",
"imagePreviewURL": "xyz789",
"videoURL": "xyz789"
}
}
}
getProjectTemplates
Please use getProjectTemplatesV2 instead.
Response
Returns [ProjectTemplate!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetProjectTemplates($teamId: ID!) {
getProjectTemplates(teamId: $teamId) {
id
name
teamId
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
logoURL
projectTemplateProjectSettingId
projectTemplateTextDocumentSettingId
projectTemplateProjectSetting {
autoMarkDocumentAsComplete
enableEditLabelSet
enableEditSentence
enableLabelerProjectCompletionNotificationThreshold
enableReviewerEditSentence
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
}
projectTemplateTextDocumentSetting {
customScriptId
fileTransformerId
customTextExtractionAPIId
sentenceSeparator
mediaDisplayStrategy
enableTabularMarkdownParsing
firstRowAsHeader
displayedRows
kind
kinds
allTokensMustBeLabeled
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
textLabelMaxTokenLength
ocrMethod
transcriptMethod
ocrProvider
autoScrollWhenLabeling
tokenizer
editSentenceTokenizer
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getProjectTemplates": [
{
"id": 4,
"name": "xyz789",
"teamId": "4",
"team": Team,
"logoURL": "xyz789",
"projectTemplateProjectSettingId": 4,
"projectTemplateTextDocumentSettingId": 4,
"projectTemplateProjectSetting": ProjectTemplateProjectSetting,
"projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
"labelSetTemplates": [LabelSetTemplate],
"questionSets": [QuestionSet],
"createdAt": "xyz789",
"updatedAt": "abc123",
"purpose": "LABELING",
"creatorId": 4
}
]
}
}
getProjectTemplatesV2
Response
Returns [ProjectTemplateV2!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetProjectTemplatesV2($teamId: ID!) {
getProjectTemplatesV2(teamId: $teamId) {
id
name
logoURL
projectTemplateProjectSettingId
projectTemplateTextDocumentSettingId
projectTemplateProjectSetting {
autoMarkDocumentAsComplete
enableEditLabelSet
enableEditSentence
enableLabelerProjectCompletionNotificationThreshold
enableReviewerEditSentence
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
}
projectTemplateTextDocumentSetting {
customScriptId
fileTransformerId
customTextExtractionAPIId
sentenceSeparator
mediaDisplayStrategy
enableTabularMarkdownParsing
firstRowAsHeader
displayedRows
kind
kinds
allTokensMustBeLabeled
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
textLabelMaxTokenLength
ocrMethod
transcriptMethod
ocrProvider
autoScrollWhenLabeling
tokenizer
editSentenceTokenizer
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
type
description
imagePreviewURL
videoURL
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getProjectTemplatesV2": [
{
"id": 4,
"name": "xyz789",
"logoURL": "abc123",
"projectTemplateProjectSettingId": "4",
"projectTemplateTextDocumentSettingId": "4",
"projectTemplateProjectSetting": ProjectTemplateProjectSetting,
"projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
"labelSetTemplates": [LabelSetTemplate],
"questionSets": [QuestionSet],
"createdAt": "xyz789",
"updatedAt": "abc123",
"purpose": "LABELING",
"creatorId": 4,
"type": "CUSTOM",
"description": "abc123",
"imagePreviewURL": "xyz789",
"videoURL": "abc123"
}
]
}
}
getProjectTopLabelsReport
Response
Returns a ProjectTopLabelsReport!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
|
projectId - ID!
|
|
sourceNavigation - ProjectAnalyticsSourceNavigation
|
Example
Query
query GetProjectTopLabelsReport(
$teamId: ID!,
$projectId: ID!,
$sourceNavigation: ProjectAnalyticsSourceNavigation
) {
getProjectTopLabelsReport(
teamId: $teamId,
projectId: $projectId,
sourceNavigation: $sourceNavigation
) {
projectId
topLabels {
labelType
metrics {
...ProjectTopLabelsMetricFragment
}
}
}
}
Variables
{
"teamId": "4",
"projectId": 4,
"sourceNavigation": "SUMMARY_DIALOG"
}
Response
{
"data": {
"getProjectTopLabelsReport": {
"projectId": "4",
"topLabels": [ProjectTopLabels]
}
}
}
getProjects
Description
Returns a paginated list of projects.
Response
Returns a ProjectPaginatedResponse!
Arguments
| Name | Description |
|---|---|
input - GetProjectsPaginatedInput!
|
Example
Query
query GetProjects($input: GetProjectsPaginatedInput!) {
getProjects(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
team {
...TeamFragment
}
teamId
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
}
}
}
}
Variables
{"input": GetProjectsPaginatedInput}
Response
{
"data": {
"getProjects": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [Project]
}
}
}
getProjectsFinalReport
Response
Returns [ProjectFinalReport!]!
Arguments
| Name | Description |
|---|---|
projectIds - [ID!]!
|
Example
Query
query GetProjectsFinalReport($projectIds: [ID!]!) {
getProjectsFinalReport(projectIds: $projectIds) {
project {
id
team {
...TeamFragment
}
teamId
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
}
}
documentFinalReports {
rowFinalReports {
...RowFinalReportFragment
}
cabinet {
...CabinetFragment
}
document {
...TextDocumentFragment
}
finalReport {
...FinalReportFragment
}
teamMember {
...TeamMemberFragment
}
}
}
}
Variables
{"projectIds": ["4"]}
Response
{
"data": {
"getProjectsFinalReport": [
{
"project": Project,
"documentFinalReports": [DocumentFinalReport]
}
]
}
}
getQuestionSet
Response
Returns a QuestionSet!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetQuestionSet($id: ID!) {
getQuestionSet(id: $id) {
name
id
creator {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
items {
id
index
questionSetId
label
type
multipleAnswer
required
bindToColumn
activationConditionLogic
createdAt
updatedAt
options {
...DropdownConfigOptionsFragment
}
leafOptionsOnly
format
defaultValue
max
min
theme
gradientColors
step
hideScaleLabel
multiline
maxLength
minLength
pattern
hint
nestedQuestions {
...QuestionSetItemFragment
}
parentId
}
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"getQuestionSet": {
"name": "xyz789",
"id": 4,
"creator": User,
"items": [QuestionSetItem],
"createdAt": "abc123",
"updatedAt": "xyz789"
}
}
}
getQuestionSetTemplate
Response
Returns a QuestionSetTemplate!
Example
Query
query GetQuestionSetTemplate(
$teamId: ID!,
$id: ID!
) {
getQuestionSetTemplate(
teamId: $teamId,
id: $id
) {
id
teamId
name
template
createdAt
updatedAt
}
}
Variables
{"teamId": 4, "id": "4"}
Response
{
"data": {
"getQuestionSetTemplate": {
"id": "4",
"teamId": "4",
"name": "abc123",
"template": "abc123",
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
getQuestionSetTemplates
Response
Returns [QuestionSetTemplate!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetQuestionSetTemplates($teamId: ID!) {
getQuestionSetTemplates(teamId: $teamId) {
id
teamId
name
template
createdAt
updatedAt
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getQuestionSetTemplates": [
{
"id": "4",
"teamId": "4",
"name": "xyz789",
"template": "abc123",
"createdAt": "abc123",
"updatedAt": "xyz789"
}
]
}
}
getRemainingFilesStatistic
Description
Get the remaining project files count based on the corresponding project status. (Optional) Filter by tag names (supports multiple selections with OR logic).
Response
Returns a RemainingFilesStatistic!
Example
Query
query GetRemainingFilesStatistic(
$teamId: ID!,
$tagNames: [String!]
) {
getRemainingFilesStatistic(
teamId: $teamId,
tagNames: $tagNames
) {
total
inReview
reviewReady
inProgress
created
}
}
Variables
{"teamId": 4, "tagNames": ["xyz789"]}
Response
{
"data": {
"getRemainingFilesStatistic": {
"total": 123,
"inReview": 987,
"reviewReady": 987,
"inProgress": 987,
"created": 123
}
}
}
getReversedLabels
Response
Returns [ReversedLabels!]!
Arguments
| Name | Description |
|---|---|
input - ReversedLabelsOperationInput!
|
Example
Query
query GetReversedLabels($input: ReversedLabelsOperationInput!) {
getReversedLabels(input: $input) {
document
reversedLabels
reversedLabelsCount
replacedReversedLabels
replacedReversedLabelsCount
replacementLabels
replacementLabelsCount
}
}
Variables
{"input": ReversedLabelsOperationInput}
Response
{
"data": {
"getReversedLabels": [
{
"document": TextDocumentScalar,
"reversedLabels": [TextLabelScalar],
"reversedLabelsCount": 123,
"replacedReversedLabels": [TextLabelScalar],
"replacedReversedLabelsCount": 123,
"replacementLabels": [TextLabelScalar],
"replacementLabelsCount": 987
}
]
}
}
getRowAnalyticEvents
Response
Returns a RowAnalyticEventPaginatedResponse!
Arguments
| Name | Description |
|---|---|
input - RowAnalyticEventInput!
|
Example
Query
query GetRowAnalyticEvents($input: RowAnalyticEventInput!) {
getRowAnalyticEvents(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
cell {
...RowAnalyticEventCellFragment
}
createdAt
event
id
user {
...RowAnalyticEventUserFragment
}
}
}
}
Variables
{"input": RowAnalyticEventInput}
Response
{
"data": {
"getRowAnalyticEvents": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [RowAnalyticEvent]
}
}
}
getRowAnswerConflicts
Response
Returns [RowAnswerConflicts!]!
Arguments
| Name | Description |
|---|---|
input - GetRowAnswerConflictsInput
|
Example
Query
query GetRowAnswerConflicts($input: GetRowAnswerConflictsInput) {
getRowAnswerConflicts(input: $input) {
line
conflicts
conflictStatus
}
}
Variables
{"input": GetRowAnswerConflictsInput}
Response
{
"data": {
"getRowAnswerConflicts": [
{
"line": 123,
"conflicts": [ConflictAnswerScalar],
"conflictStatus": "CONFLICT"
}
]
}
}
getRowAnswersPaginated
Response
Returns a GetRowAnswersPaginatedResponse!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
input - GetRowAnswersPaginatedInput
|
|
signature - String
|
Example
Query
query GetRowAnswersPaginated(
$documentId: ID!,
$input: GetRowAnswersPaginatedInput,
$signature: String
) {
getRowAnswersPaginated(
documentId: $documentId,
input: $input,
signature: $signature
) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
documentId
line
answers
metadata {
...AnswerMetadataFragment
}
updatedAt
}
}
}
Variables
{
"documentId": 4,
"input": GetRowAnswersPaginatedInput,
"signature": "abc123"
}
Response
{
"data": {
"getRowAnswersPaginated": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [RowAnswer]
}
}
}
getRowQuestions
Response
Returns [Question!]!
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
Example
Query
query GetRowQuestions($projectId: ID!) {
getRowQuestions(projectId: $projectId) {
id
internalId
type
name
label
required
config {
defaultValue
format
multiple
multiline
options {
...QuestionConfigOptionsFragment
}
leafOptionsOnly
questions {
...QuestionFragment
}
minLength
maxLength
pattern
theme
gradientColors
min
max
step
hint
hideScaleLabel
}
bindToColumn
activationConditionLogic
}
}
Variables
{"projectId": "4"}
Response
{
"data": {
"getRowQuestions": [
{
"id": 987,
"internalId": "xyz789",
"type": "DROPDOWN",
"name": "xyz789",
"label": "xyz789",
"required": true,
"config": QuestionConfig,
"bindToColumn": "abc123",
"activationConditionLogic": "xyz789"
}
]
}
}
getSamlTenantByTeamId
Response
Returns a SamlTenant
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetSamlTenantByTeamId($teamId: ID!) {
getSamlTenantByTeamId(teamId: $teamId) {
id
active
companyId
idpIssuer
idpUrl
spIssuer
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
allowMembersToSetPassword
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getSamlTenantByTeamId": {
"id": "4",
"active": true,
"companyId": 4,
"idpIssuer": "abc123",
"idpUrl": "xyz789",
"spIssuer": "xyz789",
"team": Team,
"allowMembersToSetPassword": true
}
}
}
getScimByTeamId
Example
Query
query GetScimByTeamId($teamId: ID!) {
getScimByTeamId(teamId: $teamId) {
id
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
samlTenant {
id
active
companyId
idpIssuer
idpUrl
spIssuer
team {
...TeamFragment
}
allowMembersToSetPassword
}
active
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getScimByTeamId": {
"id": "4",
"team": Team,
"samlTenant": SamlTenant,
"active": true
}
}
}
getScimGroupByTeamId
Response
Returns [ScimGroup!]
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetScimGroupByTeamId($teamId: ID!) {
getScimGroupByTeamId(teamId: $teamId) {
id
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
scim {
id
team {
...TeamFragment
}
samlTenant {
...SamlTenantFragment
}
active
}
groupName
role
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getScimGroupByTeamId": [
{
"id": 4,
"team": Team,
"scim": Scim,
"groupName": "abc123",
"role": "LABELER"
}
]
}
}
getSearchHistoryKeywords
Response
Returns [SearchHistoryKeyword!]!
Example
Query
query GetSearchHistoryKeywords {
getSearchHistoryKeywords {
id
keyword
}
}
Response
{
"data": {
"getSearchHistoryKeywords": [
{"id": 4, "keyword": "abc123"}
]
}
}
getSpanAndArrowConflictContributorIds
Response
Returns [ConflictContributorIds!]!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
labelHashCodes - [String!]!
|
Example
Query
query GetSpanAndArrowConflictContributorIds(
$documentId: ID!,
$labelHashCodes: [String!]!
) {
getSpanAndArrowConflictContributorIds(
documentId: $documentId,
labelHashCodes: $labelHashCodes
) {
labelHashCode
contributorIds
contributorInfos {
id
labelPhase
}
}
}
Variables
{
"documentId": 4,
"labelHashCodes": ["xyz789"]
}
Response
{
"data": {
"getSpanAndArrowConflictContributorIds": [
{
"labelHashCode": "abc123",
"contributorIds": [987],
"contributorInfos": [ContributorInfo]
}
]
}
}
getSpanAndArrowConflicts
Response
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
input - GetSpanAndArrowConflictsPaginatedInput!
|
|
signature - String
|
Example
Query
query GetSpanAndArrowConflicts(
$documentId: ID!,
$input: GetSpanAndArrowConflictsPaginatedInput!,
$signature: String
) {
getSpanAndArrowConflicts(
documentId: $documentId,
input: $input,
signature: $signature
) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes
}
}
Variables
{
"documentId": 4,
"input": GetSpanAndArrowConflictsPaginatedInput,
"signature": "abc123"
}
Response
{
"data": {
"getSpanAndArrowConflicts": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [ConflictTextLabelScalar]
}
}
}
getSpanAndArrowRejectedLabels
Response
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
input - GetSpanAndArrowRejectedLabelsPaginatedInput!
|
|
signature - String
|
Example
Query
query GetSpanAndArrowRejectedLabels(
$documentId: ID!,
$input: GetSpanAndArrowRejectedLabelsPaginatedInput!,
$signature: String
) {
getSpanAndArrowRejectedLabels(
documentId: $documentId,
input: $input,
signature: $signature
) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes
}
}
Variables
{
"documentId": 4,
"input": GetSpanAndArrowRejectedLabelsPaginatedInput,
"signature": "abc123"
}
Response
{
"data": {
"getSpanAndArrowRejectedLabels": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [ConflictTextLabelScalar]
}
}
}
getSynchronizeJobs
Example
Query
query GetSynchronizeJobs($projectId: ID!) {
getSynchronizeJobs(projectId: $projectId) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
}
}
}
Variables
{"projectId": "4"}
Response
{
"data": {
"getSynchronizeJobs": [
{
"id": "xyz789",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "abc123",
"additionalData": JobAdditionalData
}
]
}
}
getTags
Description
Returns a list of team-owned tags.
Response
Returns [Tag!]!
Arguments
| Name | Description |
|---|---|
input - GetTagsInput!
|
Example
Query
query GetTags($input: GetTagsInput!) {
getTags(input: $input) {
id
name
globalTag
}
}
Variables
{"input": GetTagsInput}
Response
{
"data": {
"getTags": [
{
"id": "4",
"name": "abc123",
"globalTag": false
}
]
}
}
getTeamApiKeys
Response
Returns [TeamApiKey!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetTeamApiKeys($teamId: ID!) {
getTeamApiKeys(teamId: $teamId) {
id
teamId
name
key
lastUsedAt
createdAt
updatedAt
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getTeamApiKeys": [
{
"id": 4,
"teamId": 4,
"name": "xyz789",
"key": "xyz789",
"lastUsedAt": "abc123",
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
]
}
}
getTeamDetail
Response
Returns a Team!
Arguments
| Name | Description |
|---|---|
input - GetTeamDetailInput
|
Example
Query
query GetTeamDetail($input: GetTeamDetailInput) {
getTeamDetail(input: $input) {
id
logoURL
members {
id
user {
...UserFragment
}
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
}
membersScalar
name
setting {
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedASRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enableActions
enableAddDocumentsToProject
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurDinamicTokenBased
enableDatasaurPredictiveRowBased
enableWipeData
enableExportTeamOverview
enableTransferOwnership
enableLabelErrorDetectionRowBased
allowedExtraAutoLabelProviders
enableLLMProject
enableRegexSentenceSeparator
enableTeamRoleSupervisor
endExtensionTrialAt
allowInvalidPaymentMethod
enableExternalKnowledgeBase
enableForceAnonymization
}
owner {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
isExpired
expiredAt
}
}
Variables
{"input": GetTeamDetailInput}
Response
{
"data": {
"getTeamDetail": {
"id": "4",
"logoURL": "abc123",
"members": [TeamMember],
"membersScalar": TeamMembersScalar,
"name": "xyz789",
"setting": TeamSetting,
"owner": User,
"isExpired": true,
"expiredAt": "2007-12-03T10:15:30Z"
}
}
}
getTeamExternalApiKey
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a TeamExternalApiKey
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetTeamExternalApiKey($teamId: ID!) {
getTeamExternalApiKey(teamId: $teamId) {
id
teamId
credentials {
provider
isConnected
openAIKey
azureOpenAIKey
azureOpenAIEndpoint
azureAITenantId
azureAISubscriptionId
azureAIResourceGroupName
azureAIAccountName
awsSagemakerRegion
awsSagemakerExternalId
awsSagemakerRoleArn
awsBedrockRegion
awsBedrockExternalId
awsBedrockRoleArn
}
createdAt
updatedAt
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getTeamExternalApiKey": {
"id": "4",
"teamId": 4,
"credentials": [TeamExternalApiKeyCredential],
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
getTeamMemberDetail
Response
Returns a TeamMember!
Example
Query
query GetTeamMemberDetail(
$teamId: ID!,
$memberId: ID!
) {
getTeamMemberDetail(
teamId: $teamId,
memberId: $memberId
) {
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
{"teamId": 4, "memberId": 4}
Response
{
"data": {
"getTeamMemberDetail": {
"id": 4,
"user": User,
"role": TeamRole,
"invitationEmail": "xyz789",
"invitationStatus": "abc123",
"invitationKey": "xyz789",
"isDeleted": false,
"joinedDate": "xyz789",
"performance": TeamMemberPerformance
}
}
}
getTeamMemberPerformance
Response
Arguments
| Name | Description |
|---|---|
input - GetPaginatedTeamMemberPerformanceInput!
|
Example
Query
query GetTeamMemberPerformance($input: GetPaginatedTeamMemberPerformanceInput!) {
getTeamMemberPerformance(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
projectId
resourceId
projectName
labelingStatus
projectStatus
totalLabelApplied
totalAnswerApplied
totalConflictResolved
numberOfAcceptedLabels
numberOfRejectedLabels
numberOfConflictedLabels
numberOfMissingLabels
numberOfAcceptedAnswers
numberOfRejectedAnswers
numberOfConflictedAnswers
numberOfAnsweredLines
activeDurationInMillis
}
}
}
Variables
{"input": GetPaginatedTeamMemberPerformanceInput}
Response
{
"data": {
"getTeamMemberPerformance": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [GetPaginatedTeamMemberPerformance]
}
}
}
getTeamMembers
Description
Returns the specified team's members. teamId can be seen in web UI, visible in the URL (https://datasaur.ai/teams/{teamId}/...) , or obtained via getAllTeams.
Response
Returns [TeamMember!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetTeamMembers($teamId: ID!) {
getTeamMembers(teamId: $teamId) {
id
user {
id
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
{"teamId": "4"}
Response
{
"data": {
"getTeamMembers": [
{
"id": 4,
"user": User,
"role": TeamRole,
"invitationEmail": "abc123",
"invitationStatus": "xyz789",
"invitationKey": "abc123",
"isDeleted": true,
"joinedDate": "abc123",
"performance": TeamMemberPerformance
}
]
}
}
getTeamMembersPaginated
Response
Returns a GetTeamMembersPaginatedResponse!
Arguments
| Name | Description |
|---|---|
input - GetTeamMembersPaginatedInput!
|
Example
Query
query GetTeamMembersPaginated($input: GetTeamMembersPaginatedInput!) {
getTeamMembersPaginated(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
user {
...UserFragment
}
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
}
}
}
Variables
{"input": GetTeamMembersPaginatedInput}
Response
{
"data": {
"getTeamMembersPaginated": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [TeamMember]
}
}
}
getTeamOnboarding
Response
Returns a TeamOnboarding
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetTeamOnboarding($teamId: ID!) {
getTeamOnboarding(teamId: $teamId) {
id
teamId
state
version
tasks {
id
name
reward
completedAt
}
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getTeamOnboarding": {
"id": "4",
"teamId": 4,
"state": "NOT_OPENED",
"version": 123,
"tasks": [TeamOnboardingTask]
}
}
}
getTeamProjectAssignees
Response
Returns [ProjectAssignment!]!
Arguments
| Name | Description |
|---|---|
input - GetTeamProjectAssigneesInput!
|
Example
Query
query GetTeamProjectAssignees($input: GetTeamProjectAssigneesInput!) {
getTeamProjectAssignees(input: $input) {
teamMember {
id
user {
...UserFragment
}
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
}
documentIds
documents {
id
chunks {
...TextChunkFragment
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
...TextDocumentSettingsFragment
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
...TextSentenceFragment
}
settings {
...SettingsFragment
}
statistic {
...TextDocumentStatisticFragment
}
type
updatedChunks {
...TextChunkFragment
}
updatedTokenLabels {
...TextLabelFragment
}
url
version
workspaceState {
...WorkspaceStateFragment
}
originId
signature
part
}
role
createdAt
updatedAt
}
}
Variables
{"input": GetTeamProjectAssigneesInput}
Response
{
"data": {
"getTeamProjectAssignees": [
{
"teamMember": TeamMember,
"documentIds": ["xyz789"],
"documents": [TextDocument],
"role": "LABELER",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
getTeamRoles
Response
Returns [TeamRole!]
Example
Query
query GetTeamRoles {
getTeamRoles {
id
name
}
}
Response
{
"data": {
"getTeamRoles": [
{"id": "4", "name": "ADMIN"}
]
}
}
getTeamTimelineEvent
Response
Returns [TimelineEvent!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetTeamTimelineEvent($teamId: ID!) {
getTeamTimelineEvent(teamId: $teamId) {
id
user {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
event
targetProject {
id
resourceId
name
isDeleted
}
targetDocument {
id
name
}
targetUser {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
created
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getTeamTimelineEvent": [
{
"id": 4,
"user": User,
"event": "abc123",
"targetProject": TimelineProject,
"targetDocument": TimelineDocument,
"targetUser": User,
"created": "xyz789"
}
]
}
}
getTeamTimelineEvents
Response
Returns a GetTeamTimelineEventsResponse!
Arguments
| Name | Description |
|---|---|
input - GetTeamTimelineEventsInput
|
Example
Query
query GetTeamTimelineEvents($input: GetTeamTimelineEventsInput) {
getTeamTimelineEvents(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
user {
...UserFragment
}
event
targetProject {
...TimelineProjectFragment
}
targetDocument {
...TimelineDocumentFragment
}
targetUser {
...UserFragment
}
created
}
}
}
Variables
{"input": GetTeamTimelineEventsInput}
Response
{
"data": {
"getTeamTimelineEvents": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [TimelineEvent]
}
}
}
getTenantRedirectUrlFromCompanyId
Response
Returns a SamlRedirectResult!
Arguments
| Name | Description |
|---|---|
companyId - ID!
|
Example
Query
query GetTenantRedirectUrlFromCompanyId($companyId: ID!) {
getTenantRedirectUrlFromCompanyId(companyId: $companyId) {
samlTenant {
id
active
companyId
idpIssuer
idpUrl
spIssuer
team {
...TeamFragment
}
allowMembersToSetPassword
}
redirectUrl
}
}
Variables
{"companyId": 4}
Response
{
"data": {
"getTenantRedirectUrlFromCompanyId": {
"samlTenant": SamlTenant,
"redirectUrl": "xyz789"
}
}
}
getTextDocument
Response
Returns a TextDocument!
Example
Query
query GetTextDocument(
$fileId: ID!,
$signature: String
) {
getTextDocument(
fileId: $fileId,
signature: $signature
) {
id
chunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
kinds
sentenceSeparator
tokenizer
editSentenceTokenizer
displayedRows
mediaDisplayStrategy
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
fileTransformerId
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
id
documentId
userId
status
content
tokens
posLabels {
...TextLabelFragment
}
nerLabels {
...TextLabelFragment
}
docLabels {
...DocLabelObjectFragment
}
docLabelsString
conflicts {
...ConflictTextLabelFragment
}
conflictAnswers {
...ConflictAnswerFragment
}
answers {
...AnswerFragment
}
sentenceConflict {
...SentenceConflictFragment
}
conflictAnswerResolved
metadata {
...CellMetadataFragment
}
}
settings {
textLang
}
statistic {
documentId
numberOfChunks
numberOfSentences
numberOfTokens
effectiveTimeSpent
touchedSentences
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
}
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
}
url
version
workspaceState {
id
chunkId
sentenceStart
sentenceEnd
touchedChunks
touchedSentences
}
originId
signature
part
}
}
Variables
{"fileId": 4, "signature": "abc123"}
Response
{
"data": {
"getTextDocument": {
"id": "4",
"chunks": [TextChunk],
"createdAt": "xyz789",
"currentSentenceCursor": 123,
"lastLabeledLine": 987,
"documentSettings": TextDocumentSettings,
"fileName": "xyz789",
"isCompleted": false,
"lastSavedAt": "xyz789",
"mimeType": "abc123",
"name": "xyz789",
"projectId": 4,
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "abc123",
"version": 987,
"workspaceState": WorkspaceState,
"originId": "4",
"signature": "xyz789",
"part": 123
}
}
}
getTextDocumentOriginIdsByDocumentName
Description
Filter Text Document whose name matches the given regular expression. Returns the Text Document origin ID.
Example
Query
query GetTextDocumentOriginIdsByDocumentName(
$projectId: ID!,
$nameRegexString: String!
) {
getTextDocumentOriginIdsByDocumentName(
projectId: $projectId,
nameRegexString: $nameRegexString
)
}
Variables
{
"projectId": "4",
"nameRegexString": "xyz789"
}
Response
{"data": {"getTextDocumentOriginIdsByDocumentName": [4]}}
getTextDocumentSettings
Response
Returns a TextDocumentSettings!
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
Example
Query
query GetTextDocumentSettings($projectId: ID!) {
getTextDocumentSettings(projectId: $projectId) {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
kinds
sentenceSeparator
tokenizer
editSentenceTokenizer
displayedRows
mediaDisplayStrategy
viewer
viewerConfig {
urlColumnNames
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
name
pattern
flags
}
fileTransformerId
}
}
Variables
{"projectId": "4"}
Response
{
"data": {
"getTextDocumentSettings": {
"id": "4",
"textLabelMaxTokenLength": 123,
"allTokensMustBeLabeled": true,
"autoScrollWhenLabeling": false,
"allowArcDrawing": true,
"allowCharacterBasedLabeling": false,
"allowMultiLabels": false,
"kinds": ["DOCUMENT_BASED"],
"sentenceSeparator": "xyz789",
"tokenizer": "xyz789",
"editSentenceTokenizer": "abc123",
"displayedRows": 987,
"mediaDisplayStrategy": "NONE",
"viewer": "TOKEN",
"viewerConfig": TextDocumentViewerConfig,
"hideBoundingBoxIfNoSpanOrArrowLabel": true,
"enableTabularMarkdownParsing": false,
"enableAnonymization": false,
"anonymizationEntityTypes": [
"xyz789"
],
"anonymizationMaskingMethod": "abc123",
"anonymizationRegExps": [RegularExpression],
"fileTransformerId": "abc123"
}
}
}
getTextDocumentStatistic
Response
Returns a TextDocumentStatistic!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
Example
Query
query GetTextDocumentStatistic($documentId: ID!) {
getTextDocumentStatistic(documentId: $documentId) {
documentId
numberOfChunks
numberOfSentences
numberOfTokens
effectiveTimeSpent
touchedSentences
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
userId
areDocumentQuestionsAnswered
numberOfAcceptedLabels
numberOfAppliedLabelTokens
numberOfRejectedLabels
}
documentTouched
}
}
Variables
{"documentId": "4"}
Response
{
"data": {
"getTextDocumentStatistic": {
"documentId": "4",
"numberOfChunks": 123,
"numberOfSentences": 123,
"numberOfTokens": 987,
"effectiveTimeSpent": 123,
"touchedSentences": [987],
"nonDisplayedLines": [123],
"numberOfEntitiesLabeled": 987,
"numberOfNonDocumentEntitiesLabeled": 987,
"maxLabeledLine": 123,
"labelerStatistic": [LabelerStatistic],
"documentTouched": true
}
}
}
getTimestampLabels
Response
Returns [TimestampLabel!]!
Example
Query
query GetTimestampLabels(
$documentId: ID!,
$fromTimestampMillis: Int
) {
getTimestampLabels(
documentId: $documentId,
fromTimestampMillis: $fromTimestampMillis
) {
id
documentId
layer
position {
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
}
startTimestampMillis
endTimestampMillis
type
}
}
Variables
{
"documentId": "4",
"fromTimestampMillis": 987
}
Response
{
"data": {
"getTimestampLabels": [
{
"id": 4,
"documentId": "4",
"layer": 987,
"position": TextRange,
"startTimestampMillis": 123,
"endTimestampMillis": 987,
"type": "ARROW"
}
]
}
}
getTimestampLabelsAtTimestamp
Response
Returns [TimestampLabel!]!
Example
Query
query GetTimestampLabelsAtTimestamp(
$documentId: ID!,
$timestampMillis: Int
) {
getTimestampLabelsAtTimestamp(
documentId: $documentId,
timestampMillis: $timestampMillis
) {
id
documentId
layer
position {
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
}
startTimestampMillis
endTimestampMillis
type
}
}
Variables
{"documentId": "4", "timestampMillis": 123}
Response
{
"data": {
"getTimestampLabelsAtTimestamp": [
{
"id": "4",
"documentId": "4",
"layer": 987,
"position": TextRange,
"startTimestampMillis": 987,
"endTimestampMillis": 123,
"type": "ARROW"
}
]
}
}
getTokenUnitPrices
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a TokenUnitPriceResponse!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
|
input - TokenUnitPriceInput!
|
Example
Query
query GetTokenUnitPrices(
$teamId: ID!,
$input: TokenUnitPriceInput!
) {
getTokenUnitPrices(
teamId: $teamId,
input: $input
) {
inputTokenUnitPrice
outputTokenUnitPrice
embeddingTokenUnitPrice
}
}
Variables
{"teamId": 4, "input": TokenUnitPriceInput}
Response
{
"data": {
"getTokenUnitPrices": {
"inputTokenUnitPrice": 987.65,
"outputTokenUnitPrice": 123.45,
"embeddingTokenUnitPrice": 123.45
}
}
}
getTotalPlaygroundCostPrediction
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a CostPredictionTotalPrice!
Example
Query
query GetTotalPlaygroundCostPrediction(
$llmApplicationId: ID!,
$promptIds: [ID!],
$playgroundRagConfigIds: [ID!]
) {
getTotalPlaygroundCostPrediction(
llmApplicationId: $llmApplicationId,
promptIds: $promptIds,
playgroundRagConfigIds: $playgroundRagConfigIds
) {
coveredByDatasaur
notCoveredByDatasaur
total
}
}
Variables
{"llmApplicationId": 4, "promptIds": [4], "playgroundRagConfigIds": [4]}
Response
{
"data": {
"getTotalPlaygroundCostPrediction": {
"coveredByDatasaur": 123.45,
"notCoveredByDatasaur": 123.45,
"total": 123.45
}
}
}
getUnusedLabelSetItemInfos
Description
Get all unused label classes excluding label class which marked as N/A
Response
Returns [UnusedLabelSetItemInfo!]!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
Example
Query
query GetUnusedLabelSetItemInfos($documentId: ID!) {
getUnusedLabelSetItemInfos(documentId: $documentId) {
labelSetId
labelSetName
items {
id
parentId
tagName
desc
color
type
arrowRules {
...LabelClassArrowRuleFragment
}
}
}
}
Variables
{"documentId": 4}
Response
{
"data": {
"getUnusedLabelSetItemInfos": [
{
"labelSetId": "4",
"labelSetName": "abc123",
"items": [TagItem]
}
]
}
}
getUserAccountDetails
Response
Returns a UserAccountDetails!
Example
Query
query GetUserAccountDetails {
getUserAccountDetails {
hasPassword
signUpMethod
}
}
Response
{
"data": {
"getUserAccountDetails": {
"hasPassword": false,
"signUpMethod": "EMAIL_PASSWORD"
}
}
}
getUserTeamMemberSetPasswordPermission
Response
Returns a Boolean!
Example
Query
query GetUserTeamMemberSetPasswordPermission {
getUserTeamMemberSetPasswordPermission
}
Response
{"data": {"getUserTeamMemberSetPasswordPermission": true}}
getUserTotpRecoveryCodes
Response
Returns a TotpRecoveryCodes!
Arguments
| Name | Description |
|---|---|
totpCode - TotpCodeInput!
|
Example
Query
query GetUserTotpRecoveryCodes($totpCode: TotpCodeInput!) {
getUserTotpRecoveryCodes(totpCode: $totpCode) {
recoveryCodes
}
}
Variables
{"totpCode": TotpCodeInput}
Response
{
"data": {
"getUserTotpRecoveryCodes": {
"recoveryCodes": ["abc123"]
}
}
}
getWaveformPeaks
Description
Generate audiowaveform data for an audio project. Waveform data generated by using https://github.com/bbc/audiowaveform
Response
Returns a WaveformPeaks!
Example
Query
query GetWaveformPeaks(
$documentId: String!,
$pixelPerSecond: Int
) {
getWaveformPeaks(
documentId: $documentId,
pixelPerSecond: $pixelPerSecond
) {
peaks
pixelPerSecond
}
}
Variables
{
"documentId": "xyz789",
"pixelPerSecond": 123
}
Response
{"data": {"getWaveformPeaks": {"peaks": [123.45], "pixelPerSecond": 987}}}
isCustomerOnFreeTrial
Breaking changes may be introduced anytime in the future without prior notice.
isDatasaurPredictiveReadyForTraining
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - DatasaurPredictiveReadyForTrainingInput!
|
Example
Query
query IsDatasaurPredictiveReadyForTraining($input: DatasaurPredictiveReadyForTrainingInput!) {
isDatasaurPredictiveReadyForTraining(input: $input)
}
Variables
{"input": DatasaurPredictiveReadyForTrainingInput}
Response
{"data": {"isDatasaurPredictiveReadyForTraining": true}}
isLlmInternalApplicationAvailable
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - IsLlmInternalApplicationAvailableInput!
|
Example
Query
query IsLlmInternalApplicationAvailable($input: IsLlmInternalApplicationAvailableInput!) {
isLlmInternalApplicationAvailable(input: $input)
}
Variables
{"input": IsLlmInternalApplicationAvailableInput}
Response
{"data": {"isLlmInternalApplicationAvailable": false}}
isOAuthClientExist
Description
Returns true if oauth client has been generated before.
Response
Returns a Boolean!
Example
Query
query IsOAuthClientExist {
isOAuthClientExist
}
Response
{"data": {"isOAuthClientExist": false}}
isTotpVerificationRequired
Response
Returns a Boolean!
Example
Query
query IsTotpVerificationRequired {
isTotpVerificationRequired
}
Response
{"data": {"isTotpVerificationRequired": true}}
llmVectorStoreSearch
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns [LlmVectorStoreSearchResponse!]!
Arguments
| Name | Description |
|---|---|
input - LlmVectorStoreSearchInput!
|
Example
Query
query LlmVectorStoreSearch($input: LlmVectorStoreSearchInput!) {
llmVectorStoreSearch(input: $input) {
content
metadata
score
}
}
Variables
{"input": LlmVectorStoreSearchInput}
Response
{
"data": {
"llmVectorStoreSearch": [
{
"content": "xyz789",
"metadata": "abc123",
"score": 123.45
}
]
}
}
me
Response
Returns a User
Example
Query
query Me {
me {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
utmSource
utmMedium
utmCampaign
}
}
}
Response
{
"data": {
"me": {
"id": "4",
"amazonCustomerId": "xyz789",
"username": "abc123",
"name": "xyz789",
"email": "abc123",
"package": "ENTERPRISE",
"profilePicture": "xyz789",
"allowedActions": ["CREATE_TEAM"],
"displayName": "abc123",
"teamPackage": "ENTERPRISE",
"emailVerified": false,
"totpAuthEnabled": true,
"companyName": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"signUpParams": SignUpParams
}
}
}
replicateCabinet
Description
Replicate cabinet if not exist
Example
Query
query ReplicateCabinet(
$projectId: ID!,
$role: Role!
) {
replicateCabinet(
projectId: $projectId,
role: $role
) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
}
}
}
Variables
{"projectId": 4, "role": "REVIEWER"}
Response
{
"data": {
"replicateCabinet": {
"id": "xyz789",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"additionalData": JobAdditionalData
}
}
}
validateCabinet
Description
Checks whether the cabinet can be safely mark as completed or not. Returns true if valid, causes error otherwise
Example
Query
query ValidateCabinet(
$projectId: ID!,
$role: Role!
) {
validateCabinet(
projectId: $projectId,
role: $role
)
}
Variables
{"projectId": "4", "role": "REVIEWER"}
Response
{"data": {"validateCabinet": true}}
validateLLMAssistedLabelingSettings
Response
Returns an ValidateLLMAssistedLabelingSettingsOutput!
Arguments
| Name | Description |
|---|---|
input - ValidateLLMAssistedLabelingSettingsInput!
|
Example
Query
query ValidateLLMAssistedLabelingSettings($input: ValidateLLMAssistedLabelingSettingsInput!) {
validateLLMAssistedLabelingSettings(input: $input) {
valid
errorMessage
}
}
Variables
{"input": ValidateLLMAssistedLabelingSettingsInput}
Response
{
"data": {
"validateLLMAssistedLabelingSettings": {
"valid": false,
"errorMessage": "abc123"
}
}
}
verifyBetaKey
verifyInvitationLink
Response
Returns an InvitationVerificationResult!
Example
Query
query VerifyInvitationLink(
$teamId: String!,
$invitationKey: String!
) {
verifyInvitationLink(
teamId: $teamId,
invitationKey: $invitationKey
) {
isValid
userIsRegistered
email
teamId
companyName
}
}
Variables
{
"teamId": "abc123",
"invitationKey": "xyz789"
}
Response
{
"data": {
"verifyInvitationLink": {
"isValid": false,
"userIsRegistered": true,
"email": "abc123",
"teamId": 4,
"companyName": "abc123"
}
}
}
verifyPassword
verifyResetPasswordSignature
verifyTotpCode
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
totpCode - TotpCodeInput!
|
Example
Query
query VerifyTotpCode($totpCode: TotpCodeInput!) {
verifyTotpCode(totpCode: $totpCode)
}
Variables
{"totpCode": TotpCodeInput}
Response
{"data": {"verifyTotpCode": false}}
verifyUserTotpEnabled
Mutations
acceptBoundingBoxConflict
Response
Returns [BoundingBoxLabel!]!
Example
Query
mutation AcceptBoundingBoxConflict(
$documentId: ID!,
$boundingBoxLabelIds: [ID!]!
) {
acceptBoundingBoxConflict(
documentId: $documentId,
boundingBoxLabelIds: $boundingBoxLabelIds
) {
id
documentId
coordinates {
x
y
}
counter
pageIndex
layer
position {
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
}
hashCode
type
labeledBy
}
}
Variables
{
"documentId": "4",
"boundingBoxLabelIds": [4]
}
Response
{
"data": {
"acceptBoundingBoxConflict": [
{
"id": "4",
"documentId": 4,
"coordinates": [Coordinate],
"counter": 123,
"pageIndex": 123,
"layer": 123,
"position": TextRange,
"hashCode": "xyz789",
"type": "ARROW",
"labeledBy": "PRELABELED"
}
]
}
}
acceptInvitation
Example
Query
mutation AcceptInvitation($invitationKey: String!) {
acceptInvitation(invitationKey: $invitationKey) {
id
logoURL
members {
id
user {
...UserFragment
}
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
}
membersScalar
name
setting {
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedASRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enableActions
enableAddDocumentsToProject
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurDinamicTokenBased
enableDatasaurPredictiveRowBased
enableWipeData
enableExportTeamOverview
enableTransferOwnership
enableLabelErrorDetectionRowBased
allowedExtraAutoLabelProviders
enableLLMProject
enableRegexSentenceSeparator
enableTeamRoleSupervisor
endExtensionTrialAt
allowInvalidPaymentMethod
enableExternalKnowledgeBase
enableForceAnonymization
}
owner {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
isExpired
expiredAt
}
}
Variables
{"invitationKey": "xyz789"}
Response
{
"data": {
"acceptInvitation": {
"id": "4",
"logoURL": "abc123",
"members": [TeamMember],
"membersScalar": TeamMembersScalar,
"name": "xyz789",
"setting": TeamSetting,
"owner": User,
"isExpired": false,
"expiredAt": "2007-12-03T10:15:30Z"
}
}
}
acceptTimestampLabelConflicts
Response
Returns [TimestampLabel!]!
Example
Query
mutation AcceptTimestampLabelConflicts(
$documentId: ID!,
$labelIds: [ID!]!
) {
acceptTimestampLabelConflicts(
documentId: $documentId,
labelIds: $labelIds
) {
id
documentId
layer
position {
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
}
startTimestampMillis
endTimestampMillis
type
}
}
Variables
{
"documentId": "4",
"labelIds": ["4"]
}
Response
{
"data": {
"acceptTimestampLabelConflicts": [
{
"id": "4",
"documentId": 4,
"layer": 987,
"position": TextRange,
"startTimestampMillis": 987,
"endTimestampMillis": 123,
"type": "ARROW"
}
]
}
}
activateUser
Response
Returns a LoginSuccess
Example
Query
mutation ActivateUser(
$email: String!,
$activationCode: String!
) {
activateUser(
email: $email,
activationCode: $activationCode
) {
user {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
redirect
}
}
Variables
{
"email": "xyz789",
"activationCode": "abc123"
}
Response
{
"data": {
"activateUser": {
"user": User,
"redirect": "xyz789"
}
}
}
addActiveDuration
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
input - AddActiveDurationInput!
|
Example
Query
mutation AddActiveDuration($input: AddActiveDurationInput!) {
addActiveDuration(input: $input)
}
Variables
{"input": AddActiveDurationInput}
Response
{"data": {"addActiveDuration": true}}
addCustomModel
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmModel!
Arguments
| Name | Description |
|---|---|
input - LlmCustomModelInput!
|
Example
Query
mutation AddCustomModel($input: LlmCustomModelInput!) {
addCustomModel(input: $input) {
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
createdAt
updatedAt
}
}
Variables
{"input": LlmCustomModelInput}
Response
{
"data": {
"addCustomModel": {
"id": "4",
"detail": LlmModelDetail,
"teamId": 4,
"provider": "AMAZON_BEDROCK",
"name": "xyz789",
"displayName": "xyz789",
"url": "xyz789",
"maxTemperature": 987.65,
"maxTopP": 123.45,
"maxTokens": 987,
"maxContextWindow": 987,
"defaultTemperature": 987.65,
"defaultTopP": 987.65,
"defaultMaxTokens": 987,
"llmModelFineTuningJob": LlmModelFineTuningJob,
"deployableModelId": "abc123",
"isModelDeployable": true,
"forceAnonymization": true,
"createdAt": "abc123",
"updatedAt": "xyz789"
}
}
}
addDocumentsToProject
Description
Adds new documents to the specified project Documents' source configuration will follow the original project's config. If the original project uses an External Object Storage, the new documents must also come from the same storage.
Response
Returns an AddDocumentsToProjectJob!
Arguments
| Name | Description |
|---|---|
input - AddDocumentsToProjectInput!
|
Example
Query
mutation AddDocumentsToProject($input: AddDocumentsToProjectInput!) {
addDocumentsToProject(input: $input) {
job {
id
status
progress
errors {
...JobErrorFragment
}
resultId
result
createdAt
updatedAt
additionalData {
...JobAdditionalDataFragment
}
}
name
}
}
Variables
{"input": AddDocumentsToProjectInput}
Response
{
"data": {
"addDocumentsToProject": {
"job": Job,
"name": "xyz789"
}
}
}
addGroundTruthsToGroundTruthSet
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns [GroundTruth!]!
Arguments
| Name | Description |
|---|---|
input - AddGroundTruthsToGroundTruthSetInput!
|
Example
Query
mutation AddGroundTruthsToGroundTruthSet($input: AddGroundTruthsToGroundTruthSetInput!) {
addGroundTruthsToGroundTruthSet(input: $input) {
id
groundTruthSetId
prompt
answer
createdAt
updatedAt
}
}
Variables
{"input": AddGroundTruthsToGroundTruthSetInput}
Response
{
"data": {
"addGroundTruthsToGroundTruthSet": [
{
"id": 4,
"groundTruthSetId": 4,
"prompt": "xyz789",
"answer": "xyz789",
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
]
}
}
addLabelingFunction
Response
Returns a LabelingFunction!
Arguments
| Name | Description |
|---|---|
input - AddLabelingFunctionInput!
|
Example
Query
mutation AddLabelingFunction($input: AddLabelingFunctionInput!) {
addLabelingFunction(input: $input) {
id
dataProgrammingId
heuristicArgument
annotatorArgument
name
content
active
createdAt
updatedAt
}
}
Variables
{"input": AddLabelingFunctionInput}
Response
{
"data": {
"addLabelingFunction": {
"id": 4,
"dataProgrammingId": 4,
"heuristicArgument": HeuristicArgumentScalar,
"annotatorArgument": AnnotatorArgumentScalar,
"name": "abc123",
"content": "abc123",
"active": true,
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
addProjectMetadata
Description
Adds metadata to a project. If the specified metadata already exists, mutation will throw an error.
Response
Returns a Project!
Arguments
| Name | Description |
|---|---|
input - ProjectMetadataInput!
|
Example
Query
mutation AddProjectMetadata($input: ProjectMetadataInput!) {
addProjectMetadata(input: $input) {
id
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
teamId
owner {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
createdAt
updatedAt
}
name
tags {
id
name
globalTag
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
autoMarkDocumentAsComplete
consensus
conflictResolution {
...ConflictResolutionFragment
}
dynamicReviewMethod
dynamicReviewMemberId
enableEditLabelSet
enableReviewerEditSentence
enableReviewerInsertSentence
enableReviewerDeleteSentence
enableEditSentence
enableInsertSentence
enableDeleteSentence
enableDirectBBoxEditing
enableEnforceAutoLabelReviewerSettings
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
shouldConfirmUnusedLabelSetItems
spotChecking {
...SpotCheckingFragment
}
}
workspaceSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
asrProvider
kinds
sentenceSeparator
displayedRows
mediaDisplayStrategy
tokenizer
firstRowAsHeader
transcriptMethod
ocrProvider
customScriptId
fileTransformerId
customTextExtractionAPIId
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
}
reviewingStatus {
isCompleted
statistic {
...ReviewingStatusStatisticFragment
}
}
labelingStatus {
labeler {
...TeamMemberFragment
}
isCompleted
isStarted
statistic {
...LabelingStatusStatisticFragment
}
statisticsToShow {
...StatisticItemFragment
}
}
status
performance {
project {
...ProjectFragment
}
projectId
totalTimeSpent
effectiveTotalTimeSpent
conflicts
totalLabelApplied
numberOfAcceptedLabels
numberOfDocuments
numberOfTokens
numberOfLines
}
selfLabelingStatus
purpose
rootCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
reviewCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
labelerCabinets {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
guideline {
id
name
content
project {
...ProjectFragment
}
}
isArchived
projectMetadataItems {
id
teamId
creatorId
key
value
createdAt
updatedAt
}
}
}
Variables
{"input": ProjectMetadataInput}
Response
{
"data": {
"addProjectMetadata": {
"id": "4",
"team": Team,
"teamId": 4,
"owner": User,
"externalObjectStorageId": "xyz789",
"rootDocumentId": 4,
"assignees": [ProjectAssignment],
"name": "xyz789",
"tags": [Tag],
"type": "abc123",
"createdDate": "xyz789",
"completedDate": "abc123",
"exportedDate": "abc123",
"updatedDate": "xyz789",
"isOwnerMe": false,
"isReviewByMeAllowed": false,
"settings": ProjectSettings,
"workspaceSettings": WorkspaceSettings,
"reviewingStatus": ReviewingStatus,
"labelingStatus": [LabelingStatus],
"status": "CREATED",
"performance": ProjectPerformance,
"selfLabelingStatus": "NOT_STARTED",
"purpose": "LABELING",
"rootCabinet": Cabinet,
"reviewCabinet": Cabinet,
"labelerCabinets": [Cabinet],
"guideline": Guideline,
"isArchived": false,
"projectMetadataItems": [ProjectMetadataItem]
}
}
}
allowIPs
Response
Returns [String!]!
Arguments
| Name | Description |
|---|---|
allowedIPs - [String!]!
|
Example
Query
mutation AllowIPs($allowedIPs: [String!]!) {
allowIPs(allowedIPs: $allowedIPs)
}
Variables
{"allowedIPs": ["xyz789"]}
Response
{"data": {"allowIPs": ["xyz789"]}}
appendLabelSetTagItems
Description
Adds new labelset item to the specified labelset.
Response
Returns [TagItem!]
Arguments
| Name | Description |
|---|---|
input - AppendLabelSetTagItemsInput!
|
Example
Query
mutation AppendLabelSetTagItems($input: AppendLabelSetTagItemsInput!) {
appendLabelSetTagItems(input: $input) {
id
parentId
tagName
desc
color
type
arrowRules {
originIds
destinationIds
}
}
}
Variables
{"input": AppendLabelSetTagItemsInput}
Response
{
"data": {
"appendLabelSetTagItems": [
{
"id": "xyz789",
"parentId": 4,
"tagName": "abc123",
"desc": "abc123",
"color": "xyz789",
"type": "SPAN",
"arrowRules": [LabelClassArrowRule]
}
]
}
}
autoLabelReviewTextDocumentBasedOnConsensus
Response
Returns a TextDocument!
Arguments
| Name | Description |
|---|---|
input - AutoLabelReviewTextDocumentBasedOnConsensusInput!
|
Example
Query
mutation AutoLabelReviewTextDocumentBasedOnConsensus($input: AutoLabelReviewTextDocumentBasedOnConsensusInput!) {
autoLabelReviewTextDocumentBasedOnConsensus(input: $input) {
id
chunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
kinds
sentenceSeparator
tokenizer
editSentenceTokenizer
displayedRows
mediaDisplayStrategy
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
fileTransformerId
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
id
documentId
userId
status
content
tokens
posLabels {
...TextLabelFragment
}
nerLabels {
...TextLabelFragment
}
docLabels {
...DocLabelObjectFragment
}
docLabelsString
conflicts {
...ConflictTextLabelFragment
}
conflictAnswers {
...ConflictAnswerFragment
}
answers {
...AnswerFragment
}
sentenceConflict {
...SentenceConflictFragment
}
conflictAnswerResolved
metadata {
...CellMetadataFragment
}
}
settings {
textLang
}
statistic {
documentId
numberOfChunks
numberOfSentences
numberOfTokens
effectiveTimeSpent
touchedSentences
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
}
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
}
url
version
workspaceState {
id
chunkId
sentenceStart
sentenceEnd
touchedChunks
touchedSentences
}
originId
signature
part
}
}
Variables
{
"input": AutoLabelReviewTextDocumentBasedOnConsensusInput
}
Response
{
"data": {
"autoLabelReviewTextDocumentBasedOnConsensus": {
"id": 4,
"chunks": [TextChunk],
"createdAt": "abc123",
"currentSentenceCursor": 123,
"lastLabeledLine": 987,
"documentSettings": TextDocumentSettings,
"fileName": "xyz789",
"isCompleted": false,
"lastSavedAt": "xyz789",
"mimeType": "abc123",
"name": "abc123",
"projectId": "4",
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "abc123",
"version": 123,
"workspaceState": WorkspaceState,
"originId": 4,
"signature": "xyz789",
"part": 987
}
}
}
autoLabelRowBasedProject
Response
Returns a Job!
Arguments
| Name | Description |
|---|---|
input - AutoLabelRowBasedProjectInput!
|
Example
Query
mutation AutoLabelRowBasedProject($input: AutoLabelRowBasedProjectInput!) {
autoLabelRowBasedProject(input: $input) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
}
}
}
Variables
{"input": AutoLabelRowBasedProjectInput}
Response
{
"data": {
"autoLabelRowBasedProject": {
"id": "xyz789",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "abc123",
"additionalData": JobAdditionalData
}
}
}
autoLabelTokenBasedProject
Response
Returns a Job!
Arguments
| Name | Description |
|---|---|
input - AutoLabelTokenBasedProjectInput!
|
Example
Query
mutation AutoLabelTokenBasedProject($input: AutoLabelTokenBasedProjectInput!) {
autoLabelTokenBasedProject(input: $input) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
}
}
}
Variables
{"input": AutoLabelTokenBasedProjectInput}
Response
{
"data": {
"autoLabelTokenBasedProject": {
"id": "abc123",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "abc123",
"additionalData": JobAdditionalData
}
}
}
awsMarketplaceSubscription
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - AwsMarketplaceSubscriptionInput!
|
Example
Query
mutation AwsMarketplaceSubscription($input: AwsMarketplaceSubscriptionInput!) {
awsMarketplaceSubscription(input: $input)
}
Variables
{"input": AwsMarketplaceSubscriptionInput}
Response
{"data": {"awsMarketplaceSubscription": false}}
bulkSetPasswordsExpiredAt
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
userIds - [String!]!
|
|
passwordExpiredAt - DateTime
|
|
datasaurApp - DatasaurApp
|
Example
Query
mutation BulkSetPasswordsExpiredAt(
$userIds: [String!]!,
$passwordExpiredAt: DateTime,
$datasaurApp: DatasaurApp
) {
bulkSetPasswordsExpiredAt(
userIds: $userIds,
passwordExpiredAt: $passwordExpiredAt,
datasaurApp: $datasaurApp
)
}
Variables
{
"userIds": ["abc123"],
"passwordExpiredAt": "2007-12-03T10:15:30Z",
"datasaurApp": "NLP"
}
Response
{"data": {"bulkSetPasswordsExpiredAt": true}}
calculateAgreementTables
No longer supported
Example
Query
mutation CalculateAgreementTables($projectId: ID!) {
calculateAgreementTables(projectId: $projectId) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
}
}
}
Variables
{"projectId": 4}
Response
{
"data": {
"calculateAgreementTables": {
"id": "xyz789",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "abc123",
"additionalData": JobAdditionalData
}
}
}
calculateIAA
Response
Returns [String!]!
Arguments
| Name | Description |
|---|---|
projectIds - [ID!]!
|
Example
Query
mutation CalculateIAA($projectIds: [ID!]!) {
calculateIAA(projectIds: $projectIds)
}
Variables
{"projectIds": [4]}
Response
{"data": {"calculateIAA": ["xyz789"]}}
calculatePairKappas
No longer supported
Response
Returns [String!]!
Arguments
| Name | Description |
|---|---|
projectIds - [ID!]!
|
Example
Query
mutation CalculatePairKappas($projectIds: [ID!]!) {
calculatePairKappas(projectIds: $projectIds)
}
Variables
{"projectIds": ["4"]}
Response
{
"data": {
"calculatePairKappas": ["abc123"]
}
}
changePassword
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - ChangePasswordInput!
|
Example
Query
mutation ChangePassword($input: ChangePasswordInput!) {
changePassword(input: $input)
}
Variables
{"input": ChangePasswordInput}
Response
{"data": {"changePassword": "abc123"}}
clearAllLabelsOnTextDocument
Not used, please use
resetLabelingWork instead. Description
Deprecated. If you want to clear all labels on a document, please use resetLabelingWork instead.
Response
Returns a ClearAllLabelsOnTextDocumentResult!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
Example
Query
mutation ClearAllLabelsOnTextDocument($documentId: ID!) {
clearAllLabelsOnTextDocument(documentId: $documentId) {
affectedChunkIds
statistic {
documentId
numberOfChunks
numberOfSentences
numberOfTokens
effectiveTimeSpent
touchedSentences
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
}
lastSavedAt
}
}
Variables
{"documentId": "4"}
Response
{
"data": {
"clearAllLabelsOnTextDocument": {
"affectedChunkIds": [123],
"statistic": TextDocumentStatistic,
"lastSavedAt": "abc123"
}
}
}
clearAllSpanAndArrowLabels
Response
Returns a ClearAllLabelsOnTextDocumentResult!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
Example
Query
mutation ClearAllSpanAndArrowLabels($documentId: ID!) {
clearAllSpanAndArrowLabels(documentId: $documentId) {
affectedChunkIds
statistic {
documentId
numberOfChunks
numberOfSentences
numberOfTokens
effectiveTimeSpent
touchedSentences
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
}
lastSavedAt
}
}
Variables
{"documentId": 4}
Response
{
"data": {
"clearAllSpanAndArrowLabels": {
"affectedChunkIds": [123],
"statistic": TextDocumentStatistic,
"lastSavedAt": "xyz789"
}
}
}
createAndDeployLlmModel
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmModel!
Arguments
| Name | Description |
|---|---|
input - LlmModelDeployInput!
|
Example
Query
mutation CreateAndDeployLlmModel($input: LlmModelDeployInput!) {
createAndDeployLlmModel(input: $input) {
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
createdAt
updatedAt
}
}
Variables
{"input": LlmModelDeployInput}
Response
{
"data": {
"createAndDeployLlmModel": {
"id": 4,
"detail": LlmModelDetail,
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "abc123",
"displayName": "xyz789",
"url": "xyz789",
"maxTemperature": 123.45,
"maxTopP": 987.65,
"maxTokens": 123,
"maxContextWindow": 123,
"defaultTemperature": 987.65,
"defaultTopP": 987.65,
"defaultMaxTokens": 987,
"llmModelFineTuningJob": LlmModelFineTuningJob,
"deployableModelId": "xyz789",
"isModelDeployable": true,
"forceAnonymization": false,
"createdAt": "abc123",
"updatedAt": "xyz789"
}
}
}
createComment
Response
Returns a Comment!
Example
Query
mutation CreateComment(
$documentId: ID!,
$message: String!,
$hashCode: String!
) {
createComment(
documentId: $documentId,
message: $message,
hashCode: $hashCode
) {
id
parentId
documentId
originDocumentId
userId
user {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
message
resolved
resolvedAt
resolvedBy {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
repliesCount
createdAt
updatedAt
lastEditedAt
hashCode
commentedContent {
hashCodeType
contexts {
...CommentedContentContextValueFragment
}
currentValue {
...CommentedContentCurrentValueFragment
}
}
}
}
Variables
{
"documentId": 4,
"message": "xyz789",
"hashCode": "abc123"
}
Response
{
"data": {
"createComment": {
"id": "4",
"parentId": 4,
"documentId": "4",
"originDocumentId": 4,
"userId": 987,
"user": User,
"message": "xyz789",
"resolved": true,
"resolvedAt": "abc123",
"resolvedBy": User,
"repliesCount": 987,
"createdAt": "xyz789",
"updatedAt": "abc123",
"lastEditedAt": "abc123",
"hashCode": "xyz789",
"commentedContent": CommentedContent
}
}
}
createCreateProjectAction
Response
Returns a CreateProjectAction
Arguments
| Name | Description |
|---|---|
input - CreateCreateProjectActionInput!
|
Example
Query
mutation CreateCreateProjectAction($input: CreateCreateProjectActionInput!) {
createCreateProjectAction(input: $input) {
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
{"input": CreateCreateProjectActionInput}
Response
{
"data": {
"createCreateProjectAction": {
"id": "4",
"name": "xyz789",
"teamId": "4",
"appVersion": "abc123",
"creatorId": 4,
"lastRunAt": "abc123",
"lastFinishedAt": "abc123",
"externalObjectStorageId": 4,
"externalObjectStorage": ExternalObjectStorage,
"externalObjectStoragePathInput": "abc123",
"externalObjectStoragePathResult": "abc123",
"projectTemplateId": 4,
"projectTemplate": ProjectTemplate,
"assignments": [CreateProjectActionAssignment],
"additionalTagNames": ["xyz789"],
"numberOfLabelersPerProject": 123,
"numberOfReviewersPerProject": 123,
"numberOfLabelersPerDocument": 987,
"conflictResolutionMode": "MANUAL",
"consensus": 987,
"warnings": ["ASSIGNED_LABELER_NOT_MEET_CONSENSUS"]
}
}
}
createCustomAPI
Response
Returns a CustomAPI!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
|
input - CreateCustomAPIInput!
|
Example
Query
mutation CreateCustomAPI(
$teamId: ID!,
$input: CreateCustomAPIInput!
) {
createCustomAPI(
teamId: $teamId,
input: $input
) {
id
teamId
endpointURL
name
purpose
}
}
Variables
{"teamId": 4, "input": CreateCustomAPIInput}
Response
{
"data": {
"createCustomAPI": {
"id": 4,
"teamId": 4,
"endpointURL": "xyz789",
"name": "xyz789",
"purpose": "ASR_API"
}
}
}
createExternalObjectStorage
Response
Returns an ExternalObjectStorage!
Arguments
| Name | Description |
|---|---|
input - CreateExternalObjectStorageInput!
|
Example
Query
mutation CreateExternalObjectStorage($input: CreateExternalObjectStorageInput!) {
createExternalObjectStorage(input: $input) {
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
}
}
createdAt
updatedAt
}
}
Variables
{"input": CreateExternalObjectStorageInput}
Response
{
"data": {
"createExternalObjectStorage": {
"id": "4",
"cloudService": "AWS_S3",
"bucketId": "abc123",
"bucketName": "abc123",
"credentials": ExternalObjectStorageCredentials,
"securityToken": "xyz789",
"team": Team,
"projects": [Project],
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
createFileTransformer
Response
Returns a FileTransformer!
Arguments
| Name | Description |
|---|---|
input - CreateFileTransformerInput!
|
Example
Query
mutation CreateFileTransformer($input: CreateFileTransformerInput!) {
createFileTransformer(input: $input) {
id
name
content
transpiled
createdAt
updatedAt
language
purpose
readonly
externalId
warmup
}
}
Variables
{"input": CreateFileTransformerInput}
Response
{
"data": {
"createFileTransformer": {
"id": "4",
"name": "abc123",
"content": "abc123",
"transpiled": "abc123",
"createdAt": "xyz789",
"updatedAt": "xyz789",
"language": "TYPESCRIPT",
"purpose": "IMPORT",
"readonly": true,
"externalId": "xyz789",
"warmup": false
}
}
}
createGroundTruthSet
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a GroundTruthSet!
Arguments
| Name | Description |
|---|---|
input - CreateGroundTruthSetInput!
|
Example
Query
mutation CreateGroundTruthSet($input: CreateGroundTruthSetInput!) {
createGroundTruthSet(input: $input) {
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
{"input": CreateGroundTruthSetInput}
Response
{
"data": {
"createGroundTruthSet": {
"id": 4,
"name": "abc123",
"teamId": "4",
"createdByUserId": 4,
"createdByUser": User,
"items": [GroundTruth],
"itemsCount": 987,
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
createGuideline
Response
Returns a Guideline!
Example
Query
mutation CreateGuideline(
$name: String!,
$content: String!,
$teamId: ID
) {
createGuideline(
name: $name,
content: $content,
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
}
}
}
}
Variables
{
"name": "xyz789",
"content": "xyz789",
"teamId": 4
}
Response
{
"data": {
"createGuideline": {
"id": "4",
"name": "xyz789",
"content": "abc123",
"project": Project
}
}
}
createLabelSet
Description
Creates a new labelset. The created labelset will appear in getCabinetLabelSetsById
Response
Returns a LabelSet!
Arguments
| Name | Description |
|---|---|
input - CreateLabelSetInput!
|
|
projectId - ID
|
Example
Query
mutation CreateLabelSet(
$input: CreateLabelSetInput!,
$projectId: ID
) {
createLabelSet(
input: $input,
projectId: $projectId
) {
id
name
index
signature
tagItems {
id
parentId
tagName
desc
color
type
arrowRules {
...LabelClassArrowRuleFragment
}
}
lastUsedBy {
projectId
name
}
arrowLabelRequired
}
}
Variables
{
"input": CreateLabelSetInput,
"projectId": "4"
}
Response
{
"data": {
"createLabelSet": {
"id": 4,
"name": "xyz789",
"index": 123,
"signature": "xyz789",
"tagItems": [TagItem],
"lastUsedBy": LastUsedProject,
"arrowLabelRequired": true
}
}
}
createLabelSetTemplate
Description
Creates a new labelset template.
Response
Returns a LabelSetTemplate
Arguments
| Name | Description |
|---|---|
input - CreateLabelSetTemplateInput!
|
Example
Query
mutation CreateLabelSetTemplate($input: CreateLabelSetTemplateInput!) {
createLabelSetTemplate(input: $input) {
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
{"input": CreateLabelSetTemplateInput}
Response
{
"data": {
"createLabelSetTemplate": {
"id": 4,
"name": "xyz789",
"owner": User,
"type": "QUESTION",
"items": [LabelSetTemplateItem],
"count": 987,
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
createLlmApplication
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplication!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
mutation CreateLlmApplication($teamId: ID!) {
createLlmApplication(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": {
"createLlmApplication": {
"id": "4",
"teamId": "4",
"createdByUser": User,
"name": "xyz789",
"status": "DEPLOYED",
"createdAt": "abc123",
"updatedAt": "abc123",
"llmApplicationDeployment": LlmApplicationDeployment
}
}
}
createLlmApplicationConfiguration
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplicationConfiguration!
Arguments
| Name | Description |
|---|---|
input - CreateLlmApplicationConfigurationInput!
|
Example
Query
mutation CreateLlmApplicationConfiguration($input: CreateLlmApplicationConfigurationInput!) {
createLlmApplicationConfiguration(input: $input) {
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
{"input": CreateLlmApplicationConfigurationInput}
Response
{
"data": {
"createLlmApplicationConfiguration": {
"id": 4,
"name": "abc123",
"teamId": "4",
"createdByUserId": "4",
"createdByUser": User,
"updatedByUserId": 4,
"updatedByUser": User,
"llmRagConfigId": "4",
"llmRagConfig": LlmRagConfig,
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
createLlmApplicationPlaygroundPrompts
Breaking changes may be introduced anytime in the future without prior notice.
Response
Arguments
| Name | Description |
|---|---|
input - LlmApplicationPlaygroundPromptCreateInput!
|
Example
Query
mutation CreateLlmApplicationPlaygroundPrompts($input: LlmApplicationPlaygroundPromptCreateInput!) {
createLlmApplicationPlaygroundPrompts(input: $input) {
id
llmApplicationId
name
prompt
createdAt
updatedAt
}
}
Variables
{"input": LlmApplicationPlaygroundPromptCreateInput}
Response
{
"data": {
"createLlmApplicationPlaygroundPrompts": [
{
"id": 4,
"llmApplicationId": "4",
"name": "abc123",
"prompt": "xyz789",
"createdAt": "xyz789",
"updatedAt": "abc123"
}
]
}
}
createLlmApplicationPlaygroundRagConfig
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplicationPlaygroundRagConfig!
Arguments
| Name | Description |
|---|---|
input - LlmApplicationPlaygroundRagConfigCreateInput!
|
Example
Query
mutation CreateLlmApplicationPlaygroundRagConfig($input: LlmApplicationPlaygroundRagConfigCreateInput!) {
createLlmApplicationPlaygroundRagConfig(input: $input) {
id
llmApplicationId
llmRagConfig {
id
llmModel {
...LlmModelFragment
}
systemInstruction
userInstruction
raw
temperature
topP
maxTokens
advancedHyperparameters
maxVectorStoreTokens
llmVectorStore {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
createdAt
updatedAt
}
name
createdAt
updatedAt
}
}
Variables
{"input": LlmApplicationPlaygroundRagConfigCreateInput}
Response
{
"data": {
"createLlmApplicationPlaygroundRagConfig": {
"id": "4",
"llmApplicationId": 4,
"llmRagConfig": LlmRagConfig,
"name": "xyz789",
"createdAt": "abc123",
"updatedAt": "xyz789"
}
}
}
createLlmEvaluation
Breaking changes may be introduced anytime in the future without prior notice.
Description
Creates a new manual (NLP) LLM evaluation.
Response
Returns a LlmEvaluation!
Arguments
| Name | Description |
|---|---|
input - LlmEvaluationInput!
|
Example
Query
mutation CreateLlmEvaluation($input: LlmEvaluationInput!) {
createLlmEvaluation(input: $input) {
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
{"input": LlmEvaluationInput}
Response
{
"data": {
"createLlmEvaluation": {
"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": "xyz789",
"updatedAt": "xyz789",
"isDeleted": true,
"type": "RATING",
"schedulingStatus": "NOT_STARTED",
"nextSchedule": "abc123"
}
}
}
createLlmEvaluationAutomated
Breaking changes may be introduced anytime in the future without prior notice.
Description
Creates a new automated LLM evaluation.
Response
Returns a LlmEvaluation!
Arguments
| Name | Description |
|---|---|
input - LlmEvaluationAutomatedInput!
|
Example
Query
mutation CreateLlmEvaluationAutomated($input: LlmEvaluationAutomatedInput!) {
createLlmEvaluationAutomated(input: $input) {
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
{"input": LlmEvaluationAutomatedInput}
Response
{
"data": {
"createLlmEvaluationAutomated": {
"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": "xyz789",
"updatedAt": "xyz789",
"isDeleted": false,
"type": "RATING",
"schedulingStatus": "NOT_STARTED",
"nextSchedule": "abc123"
}
}
}
createLlmVectorStore
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmVectorStore!
Arguments
| Name | Description |
|---|---|
input - CreateLlmVectorStoreInput!
|
Example
Query
mutation CreateLlmVectorStore($input: CreateLlmVectorStoreInput!) {
createLlmVectorStore(input: $input) {
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
{"input": CreateLlmVectorStoreInput}
Response
{
"data": {
"createLlmVectorStore": {
"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": "xyz789",
"updatedAt": "xyz789",
"dimension": 123
}
}
}
createNewPassword
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - CreateNewPasswordInput!
|
Example
Query
mutation CreateNewPassword($input: CreateNewPasswordInput!) {
createNewPassword(input: $input)
}
Variables
{"input": CreateNewPasswordInput}
Response
{"data": {"createNewPassword": "abc123"}}
createOnboardingLlmApplication
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplication!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
mutation CreateOnboardingLlmApplication($teamId: ID!) {
createOnboardingLlmApplication(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": {
"createOnboardingLlmApplication": {
"id": "4",
"teamId": 4,
"createdByUser": User,
"name": "abc123",
"status": "DEPLOYED",
"createdAt": "abc123",
"updatedAt": "xyz789",
"llmApplicationDeployment": LlmApplicationDeployment
}
}
}
createPersonalTag
Response
Returns a Tag!
Arguments
| Name | Description |
|---|---|
input - CreatePersonalTagInput!
|
Example
Query
mutation CreatePersonalTag($input: CreatePersonalTagInput!) {
createPersonalTag(input: $input) {
id
name
globalTag
}
}
Variables
{"input": CreatePersonalTagInput}
Response
{
"data": {
"createPersonalTag": {
"id": "4",
"name": "abc123",
"globalTag": true
}
}
}
createProject
Description
New mutation for creating a new project. Replaces launchTextProjectAsync mutation.
See LaunchProjectInput for input details.
Response is a job to poll via getJob query.
Response
Returns a ProjectLaunchJob!
Arguments
| Name | Description |
|---|---|
input - LaunchProjectInput!
|
Example
Query
mutation CreateProject($input: LaunchProjectInput!) {
createProject(input: $input) {
job {
id
status
progress
errors {
...JobErrorFragment
}
resultId
result
createdAt
updatedAt
additionalData {
...JobAdditionalDataFragment
}
}
name
}
}
Variables
{"input": LaunchProjectInput}
Response
{
"data": {
"createProject": {
"job": Job,
"name": "abc123"
}
}
}
createProjectBBoxLabelSet
Response
Returns a BBoxLabelSet!
Arguments
| Name | Description |
|---|---|
input - CreateBBoxLabelSetInput!
|
|
projectId - ID!
|
Example
Query
mutation CreateProjectBBoxLabelSet(
$input: CreateBBoxLabelSetInput!,
$projectId: ID!
) {
createProjectBBoxLabelSet(
input: $input,
projectId: $projectId
) {
id
name
classes {
id
name
color
captionAllowed
captionRequired
questions {
...QuestionFragment
}
}
autoLabelProvider
}
}
Variables
{
"input": CreateBBoxLabelSetInput,
"projectId": "4"
}
Response
{
"data": {
"createProjectBBoxLabelSet": {
"id": 4,
"name": "xyz789",
"classes": [BBoxLabelClass],
"autoLabelProvider": "TESSERACT"
}
}
}
createProjectMetadataItem
Response
Returns a ProjectMetadataItem!
Arguments
| Name | Description |
|---|---|
input - CreateProjectMetadataItemInput!
|
Example
Query
mutation CreateProjectMetadataItem($input: CreateProjectMetadataItemInput!) {
createProjectMetadataItem(input: $input) {
id
teamId
creatorId
key
value
createdAt
updatedAt
}
}
Variables
{"input": CreateProjectMetadataItemInput}
Response
{
"data": {
"createProjectMetadataItem": {
"id": "4",
"teamId": "4",
"creatorId": 4,
"key": "xyz789",
"value": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
createProjectTemplate
Response
Returns a ProjectTemplate!
Arguments
| Name | Description |
|---|---|
input - CreateProjectTemplateInput!
|
Example
Query
mutation CreateProjectTemplate($input: CreateProjectTemplateInput!) {
createProjectTemplate(input: $input) {
id
name
teamId
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
logoURL
projectTemplateProjectSettingId
projectTemplateTextDocumentSettingId
projectTemplateProjectSetting {
autoMarkDocumentAsComplete
enableEditLabelSet
enableEditSentence
enableLabelerProjectCompletionNotificationThreshold
enableReviewerEditSentence
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
}
projectTemplateTextDocumentSetting {
customScriptId
fileTransformerId
customTextExtractionAPIId
sentenceSeparator
mediaDisplayStrategy
enableTabularMarkdownParsing
firstRowAsHeader
displayedRows
kind
kinds
allTokensMustBeLabeled
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
textLabelMaxTokenLength
ocrMethod
transcriptMethod
ocrProvider
autoScrollWhenLabeling
tokenizer
editSentenceTokenizer
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
}
}
Variables
{"input": CreateProjectTemplateInput}
Response
{
"data": {
"createProjectTemplate": {
"id": "4",
"name": "abc123",
"teamId": 4,
"team": Team,
"logoURL": "xyz789",
"projectTemplateProjectSettingId": 4,
"projectTemplateTextDocumentSettingId": 4,
"projectTemplateProjectSetting": ProjectTemplateProjectSetting,
"projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
"labelSetTemplates": [LabelSetTemplate],
"questionSets": [QuestionSet],
"createdAt": "abc123",
"updatedAt": "abc123",
"purpose": "LABELING",
"creatorId": "4"
}
}
}
createQuestionSet
Response
Returns a QuestionSet!
Arguments
| Name | Description |
|---|---|
input - CreateQuestionSetInput!
|
Example
Query
mutation CreateQuestionSet($input: CreateQuestionSetInput!) {
createQuestionSet(input: $input) {
name
id
creator {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
items {
id
index
questionSetId
label
type
multipleAnswer
required
bindToColumn
activationConditionLogic
createdAt
updatedAt
options {
...DropdownConfigOptionsFragment
}
leafOptionsOnly
format
defaultValue
max
min
theme
gradientColors
step
hideScaleLabel
multiline
maxLength
minLength
pattern
hint
nestedQuestions {
...QuestionSetItemFragment
}
parentId
}
createdAt
updatedAt
}
}
Variables
{"input": CreateQuestionSetInput}
Response
{
"data": {
"createQuestionSet": {
"name": "abc123",
"id": "4",
"creator": User,
"items": [QuestionSetItem],
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
createQuestionSetTemplate
Response
Returns a QuestionSetTemplate!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
|
input - QuestionSetTemplateInput
|
Example
Query
mutation CreateQuestionSetTemplate(
$teamId: ID!,
$input: QuestionSetTemplateInput
) {
createQuestionSetTemplate(
teamId: $teamId,
input: $input
) {
id
teamId
name
template
createdAt
updatedAt
}
}
Variables
{
"teamId": "4",
"input": QuestionSetTemplateInput
}
Response
{
"data": {
"createQuestionSetTemplate": {
"id": 4,
"teamId": "4",
"name": "abc123",
"template": "xyz789",
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
createScim
Example
Query
mutation CreateScim(
$teamId: ID!,
$samlTenantId: ID!
) {
createScim(
teamId: $teamId,
samlTenantId: $samlTenantId
) {
id
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
samlTenant {
id
active
companyId
idpIssuer
idpUrl
spIssuer
team {
...TeamFragment
}
allowMembersToSetPassword
}
active
}
}
Variables
{"teamId": 4, "samlTenantId": "4"}
Response
{
"data": {
"createScim": {
"id": "4",
"team": Team,
"samlTenant": SamlTenant,
"active": true
}
}
}
createSetupIntentPaymentMethod
Breaking changes may be introduced anytime in the future without prior notice.
createTag
Response
Returns a Tag!
Arguments
| Name | Description |
|---|---|
input - CreateTagInput!
|
Example
Query
mutation CreateTag($input: CreateTagInput!) {
createTag(input: $input) {
id
name
globalTag
}
}
Variables
{"input": CreateTagInput}
Response
{
"data": {
"createTag": {
"id": 4,
"name": "abc123",
"globalTag": true
}
}
}
createTagsIfNotExist
Response
Returns [Tag!]!
Arguments
| Name | Description |
|---|---|
input - CreateTagsIfNotExistInput!
|
Example
Query
mutation CreateTagsIfNotExist($input: CreateTagsIfNotExistInput!) {
createTagsIfNotExist(input: $input) {
id
name
globalTag
}
}
Variables
{"input": CreateTagsIfNotExistInput}
Response
{
"data": {
"createTagsIfNotExist": [
{
"id": "4",
"name": "abc123",
"globalTag": false
}
]
}
}
createTeam
Response
Returns a Team!
Arguments
| Name | Description |
|---|---|
input - CreateTeamInput!
|
Example
Query
mutation CreateTeam($input: CreateTeamInput!) {
createTeam(input: $input) {
id
logoURL
members {
id
user {
...UserFragment
}
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
}
membersScalar
name
setting {
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedASRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enableActions
enableAddDocumentsToProject
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurDinamicTokenBased
enableDatasaurPredictiveRowBased
enableWipeData
enableExportTeamOverview
enableTransferOwnership
enableLabelErrorDetectionRowBased
allowedExtraAutoLabelProviders
enableLLMProject
enableRegexSentenceSeparator
enableTeamRoleSupervisor
endExtensionTrialAt
allowInvalidPaymentMethod
enableExternalKnowledgeBase
enableForceAnonymization
}
owner {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
isExpired
expiredAt
}
}
Variables
{"input": CreateTeamInput}
Response
{
"data": {
"createTeam": {
"id": 4,
"logoURL": "abc123",
"members": [TeamMember],
"membersScalar": TeamMembersScalar,
"name": "abc123",
"setting": TeamSetting,
"owner": User,
"isExpired": true,
"expiredAt": "2007-12-03T10:15:30Z"
}
}
}
createTeamApiKey
Response
Returns a TeamApiKey!
Arguments
| Name | Description |
|---|---|
input - TeamApiKeyInput!
|
Example
Query
mutation CreateTeamApiKey($input: TeamApiKeyInput!) {
createTeamApiKey(input: $input) {
id
teamId
name
key
lastUsedAt
createdAt
updatedAt
}
}
Variables
{"input": TeamApiKeyInput}
Response
{
"data": {
"createTeamApiKey": {
"id": 4,
"teamId": "4",
"name": "abc123",
"key": "xyz789",
"lastUsedAt": "xyz789",
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
createTenant
Response
Returns a SamlTenant!
Arguments
| Name | Description |
|---|---|
input - CreateSamlTenantInput!
|
Example
Query
mutation CreateTenant($input: CreateSamlTenantInput!) {
createTenant(input: $input) {
id
active
companyId
idpIssuer
idpUrl
spIssuer
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
allowMembersToSetPassword
}
}
Variables
{"input": CreateSamlTenantInput}
Response
{
"data": {
"createTenant": {
"id": 4,
"active": true,
"companyId": 4,
"idpIssuer": "xyz789",
"idpUrl": "xyz789",
"spIssuer": "abc123",
"team": Team,
"allowMembersToSetPassword": true
}
}
}
deleteBBoxLabels
Response
Returns [BBoxLabel!]!
Example
Query
mutation DeleteBBoxLabels(
$documentId: ID!,
$labelIds: [ID!]!
) {
deleteBBoxLabels(
documentId: $documentId,
labelIds: $labelIds
) {
id
documentId
bboxLabelClassId
deleted
caption
shapes {
pageIndex
points {
...BBoxPointFragment
}
}
answers
}
}
Variables
{"documentId": 4, "labelIds": ["4"]}
Response
{
"data": {
"deleteBBoxLabels": [
{
"id": "4",
"documentId": 4,
"bboxLabelClassId": "4",
"deleted": false,
"caption": "xyz789",
"shapes": [BBoxShape],
"answers": AnswerScalar
}
]
}
}
deleteBoundingBox
Response
Returns [BoundingBoxLabel!]!
Example
Query
mutation DeleteBoundingBox(
$documentId: ID!,
$boundingBoxLabelIds: [ID!]!
) {
deleteBoundingBox(
documentId: $documentId,
boundingBoxLabelIds: $boundingBoxLabelIds
) {
id
documentId
coordinates {
x
y
}
counter
pageIndex
layer
position {
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
}
hashCode
type
labeledBy
}
}
Variables
{
"documentId": 4,
"boundingBoxLabelIds": ["4"]
}
Response
{
"data": {
"deleteBoundingBox": [
{
"id": "4",
"documentId": "4",
"coordinates": [Coordinate],
"counter": 987,
"pageIndex": 123,
"layer": 987,
"position": TextRange,
"hashCode": "abc123",
"type": "ARROW",
"labeledBy": "PRELABELED"
}
]
}
}
deleteComment
deleteCreateProjectAction
Example
Query
mutation DeleteCreateProjectAction(
$teamId: ID!,
$actionId: ID!
) {
deleteCreateProjectAction(
teamId: $teamId,
actionId: $actionId
)
}
Variables
{"teamId": "4", "actionId": 4}
Response
{"data": {"deleteCreateProjectAction": true}}
deleteCustomAPI
Response
Returns a CustomAPI!
Arguments
| Name | Description |
|---|---|
customAPIId - ID!
|
Example
Query
mutation DeleteCustomAPI($customAPIId: ID!) {
deleteCustomAPI(customAPIId: $customAPIId) {
id
teamId
endpointURL
name
purpose
}
}
Variables
{"customAPIId": "4"}
Response
{
"data": {
"deleteCustomAPI": {
"id": 4,
"teamId": "4",
"endpointURL": "abc123",
"name": "xyz789",
"purpose": "ASR_API"
}
}
}
deleteDocumentAnswers
Response
Returns a Boolean!
Example
Query
mutation DeleteDocumentAnswers(
$documentId: ID!,
$questionSetSignature: String
) {
deleteDocumentAnswers(
documentId: $documentId,
questionSetSignature: $questionSetSignature
)
}
Variables
{
"documentId": 4,
"questionSetSignature": "abc123"
}
Response
{"data": {"deleteDocumentAnswers": false}}
deleteExtensionElement
Response
Returns a ProjectExtension
Arguments
| Name | Description |
|---|---|
input - DeleteExtensionElementInput!
|
Example
Query
mutation DeleteExtensionElement($input: DeleteExtensionElementInput!) {
deleteExtensionElement(input: $input) {
id
cabinetId
elements {
id
enabled
extension {
...ExtensionFragment
}
height
order
setting {
...ExtensionElementSettingFragment
}
}
width
}
}
Variables
{"input": DeleteExtensionElementInput}
Response
{
"data": {
"deleteExtensionElement": {
"id": 4,
"cabinetId": 4,
"elements": [ExtensionElement],
"width": 987
}
}
}
deleteExternalObjectStorage
Response
Returns an ExternalObjectStorage!
Arguments
| Name | Description |
|---|---|
externalObjectStorageId - ID!
|
Example
Query
mutation DeleteExternalObjectStorage($externalObjectStorageId: ID!) {
deleteExternalObjectStorage(externalObjectStorageId: $externalObjectStorageId) {
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
}
}
createdAt
updatedAt
}
}
Variables
{"externalObjectStorageId": 4}
Response
{
"data": {
"deleteExternalObjectStorage": {
"id": "4",
"cloudService": "AWS_S3",
"bucketId": "xyz789",
"bucketName": "xyz789",
"credentials": ExternalObjectStorageCredentials,
"securityToken": "xyz789",
"team": Team,
"projects": [Project],
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
deleteGroundTruthSets
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns [String!]!
Arguments
| Name | Description |
|---|---|
ids - [ID!]!
|
Example
Query
mutation DeleteGroundTruthSets($ids: [ID!]!) {
deleteGroundTruthSets(ids: $ids)
}
Variables
{"ids": ["4"]}
Response
{
"data": {
"deleteGroundTruthSets": ["xyz789"]
}
}
deleteGroundTruths
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns [String!]!
Arguments
| Name | Description |
|---|---|
ids - [ID!]!
|
Example
Query
mutation DeleteGroundTruths($ids: [ID!]!) {
deleteGroundTruths(ids: $ids)
}
Variables
{"ids": ["4"]}
Response
{"data": {"deleteGroundTruths": ["abc123"]}}
deleteGuideline
deleteLabelErrorDetectionRowBasedSuggestionsByIds
Response
Arguments
| Name | Description |
|---|---|
input - DeleteLabelErrorDetectionRowBasedSuggestionByIdsInput!
|
Example
Query
mutation DeleteLabelErrorDetectionRowBasedSuggestionsByIds($input: DeleteLabelErrorDetectionRowBasedSuggestionByIdsInput!) {
deleteLabelErrorDetectionRowBasedSuggestionsByIds(input: $input) {
id
documentId
labelErrorDetectionId
line
errorPossibility
suggestedLabel
previousLabel
createdAt
updatedAt
}
}
Variables
{
"input": DeleteLabelErrorDetectionRowBasedSuggestionByIdsInput
}
Response
{
"data": {
"deleteLabelErrorDetectionRowBasedSuggestionsByIds": [
{
"id": 4,
"documentId": "4",
"labelErrorDetectionId": 4,
"line": 987,
"errorPossibility": 123.45,
"suggestedLabel": "xyz789",
"previousLabel": "xyz789",
"createdAt": "abc123",
"updatedAt": "abc123"
}
]
}
}
deleteLabelSet
Description
Deletes a labelset. If the labelset is used in a project, any labelset item from the labelset that has been applied will be removed.
deleteLabelSetTemplates
Description
Deletes the specified labelset templates. Returns true if the templates are deleted successfully.
deleteLabelingFunctions
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - DeleteLabelingFunctionsInput!
|
Example
Query
mutation DeleteLabelingFunctions($input: DeleteLabelingFunctionsInput!) {
deleteLabelingFunctions(input: $input)
}
Variables
{"input": DeleteLabelingFunctionsInput}
Response
{"data": {"deleteLabelingFunctions": true}}
deleteLabelsOnTextDocument
Response
Returns a DeleteLabelsOnTextDocumentResult!
Arguments
| Name | Description |
|---|---|
input - DeleteLabelsOnTextDocumentInput!
|
Example
Query
mutation DeleteLabelsOnTextDocument($input: DeleteLabelsOnTextDocumentInput!) {
deleteLabelsOnTextDocument(input: $input) {
affectedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
deletedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
}
statistic {
documentId
numberOfChunks
numberOfSentences
numberOfTokens
effectiveTimeSpent
touchedSentences
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
}
lastSavedAt
}
}
Variables
{"input": DeleteLabelsOnTextDocumentInput}
Response
{
"data": {
"deleteLabelsOnTextDocument": {
"affectedChunks": [TextChunk],
"deletedTokenLabels": [TextLabel],
"statistic": TextDocumentStatistic,
"lastSavedAt": "abc123"
}
}
}
deleteLlmApplicationConfigurations
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns [LlmApplicationConfiguration!]!
Arguments
| Name | Description |
|---|---|
ids - [ID!]!
|
Example
Query
mutation DeleteLlmApplicationConfigurations($ids: [ID!]!) {
deleteLlmApplicationConfigurations(ids: $ids) {
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
{"ids": ["4"]}
Response
{
"data": {
"deleteLlmApplicationConfigurations": [
{
"id": "4",
"name": "abc123",
"teamId": 4,
"createdByUserId": "4",
"createdByUser": User,
"updatedByUserId": 4,
"updatedByUser": User,
"llmRagConfigId": "4",
"llmRagConfig": LlmRagConfig,
"createdAt": "abc123",
"updatedAt": "xyz789"
}
]
}
}
deleteLlmApplicationDeployment
Breaking changes may be introduced anytime in the future without prior notice.
deleteLlmApplicationPlaygroundPrompt
Breaking changes may be introduced anytime in the future without prior notice.
deleteLlmApplicationPlaygroundRagConfig
Breaking changes may be introduced anytime in the future without prior notice.
deleteLlmApplications
Breaking changes may be introduced anytime in the future without prior notice.
deleteLlmEvaluations
Breaking changes may be introduced anytime in the future without prior notice.
Description
Deletes the LLM evaluations based on the provided ids.
Response
Returns [LlmEvaluation!]!
Arguments
| Name | Description |
|---|---|
ids - [ID!]!
|
Example
Query
mutation DeleteLlmEvaluations($ids: [ID!]!) {
deleteLlmEvaluations(ids: $ids) {
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
{"ids": [4]}
Response
{
"data": {
"deleteLlmEvaluations": [
{
"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": false,
"createdAt": "xyz789",
"updatedAt": "abc123",
"isDeleted": true,
"type": "RATING",
"schedulingStatus": "NOT_STARTED",
"nextSchedule": "abc123"
}
]
}
}
deleteLlmModel
Breaking changes may be introduced anytime in the future without prior notice.
Example
Query
mutation DeleteLlmModel($id: ID!) {
deleteLlmModel(id: $id) {
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
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteLlmModel": {
"id": "4",
"detail": LlmModelDetail,
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "xyz789",
"displayName": "xyz789",
"url": "abc123",
"maxTemperature": 987.65,
"maxTopP": 123.45,
"maxTokens": 123,
"maxContextWindow": 123,
"defaultTemperature": 123.45,
"defaultTopP": 987.65,
"defaultMaxTokens": 987,
"llmModelFineTuningJob": LlmModelFineTuningJob,
"deployableModelId": "abc123",
"isModelDeployable": false,
"forceAnonymization": true,
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
deleteLlmVectorStores
Breaking changes may be introduced anytime in the future without prior notice.
deleteProject
Response
Returns a Project!
Arguments
| Name | Description |
|---|---|
input - DeleteProjectInput!
|
Example
Query
mutation DeleteProject($input: DeleteProjectInput!) {
deleteProject(input: $input) {
id
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
teamId
owner {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
createdAt
updatedAt
}
name
tags {
id
name
globalTag
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
autoMarkDocumentAsComplete
consensus
conflictResolution {
...ConflictResolutionFragment
}
dynamicReviewMethod
dynamicReviewMemberId
enableEditLabelSet
enableReviewerEditSentence
enableReviewerInsertSentence
enableReviewerDeleteSentence
enableEditSentence
enableInsertSentence
enableDeleteSentence
enableDirectBBoxEditing
enableEnforceAutoLabelReviewerSettings
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
shouldConfirmUnusedLabelSetItems
spotChecking {
...SpotCheckingFragment
}
}
workspaceSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
asrProvider
kinds
sentenceSeparator
displayedRows
mediaDisplayStrategy
tokenizer
firstRowAsHeader
transcriptMethod
ocrProvider
customScriptId
fileTransformerId
customTextExtractionAPIId
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
}
reviewingStatus {
isCompleted
statistic {
...ReviewingStatusStatisticFragment
}
}
labelingStatus {
labeler {
...TeamMemberFragment
}
isCompleted
isStarted
statistic {
...LabelingStatusStatisticFragment
}
statisticsToShow {
...StatisticItemFragment
}
}
status
performance {
project {
...ProjectFragment
}
projectId
totalTimeSpent
effectiveTotalTimeSpent
conflicts
totalLabelApplied
numberOfAcceptedLabels
numberOfDocuments
numberOfTokens
numberOfLines
}
selfLabelingStatus
purpose
rootCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
reviewCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
labelerCabinets {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
guideline {
id
name
content
project {
...ProjectFragment
}
}
isArchived
projectMetadataItems {
id
teamId
creatorId
key
value
createdAt
updatedAt
}
}
}
Variables
{"input": DeleteProjectInput}
Response
{
"data": {
"deleteProject": {
"id": 4,
"team": Team,
"teamId": 4,
"owner": User,
"externalObjectStorageId": "abc123",
"rootDocumentId": 4,
"assignees": [ProjectAssignment],
"name": "abc123",
"tags": [Tag],
"type": "xyz789",
"createdDate": "abc123",
"completedDate": "xyz789",
"exportedDate": "xyz789",
"updatedDate": "abc123",
"isOwnerMe": false,
"isReviewByMeAllowed": true,
"settings": ProjectSettings,
"workspaceSettings": WorkspaceSettings,
"reviewingStatus": ReviewingStatus,
"labelingStatus": [LabelingStatus],
"status": "CREATED",
"performance": ProjectPerformance,
"selfLabelingStatus": "NOT_STARTED",
"purpose": "LABELING",
"rootCabinet": Cabinet,
"reviewCabinet": Cabinet,
"labelerCabinets": [Cabinet],
"guideline": Guideline,
"isArchived": false,
"projectMetadataItems": [ProjectMetadataItem]
}
}
}
deleteProjectMetadataItems
deleteProjectTemplates
deleteProjects
Response
Returns [Project!]!
Arguments
| Name | Description |
|---|---|
projectIds - [String!]!
|
Example
Query
mutation DeleteProjects($projectIds: [String!]!) {
deleteProjects(projectIds: $projectIds) {
id
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
teamId
owner {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
createdAt
updatedAt
}
name
tags {
id
name
globalTag
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
autoMarkDocumentAsComplete
consensus
conflictResolution {
...ConflictResolutionFragment
}
dynamicReviewMethod
dynamicReviewMemberId
enableEditLabelSet
enableReviewerEditSentence
enableReviewerInsertSentence
enableReviewerDeleteSentence
enableEditSentence
enableInsertSentence
enableDeleteSentence
enableDirectBBoxEditing
enableEnforceAutoLabelReviewerSettings
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
shouldConfirmUnusedLabelSetItems
spotChecking {
...SpotCheckingFragment
}
}
workspaceSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
asrProvider
kinds
sentenceSeparator
displayedRows
mediaDisplayStrategy
tokenizer
firstRowAsHeader
transcriptMethod
ocrProvider
customScriptId
fileTransformerId
customTextExtractionAPIId
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
}
reviewingStatus {
isCompleted
statistic {
...ReviewingStatusStatisticFragment
}
}
labelingStatus {
labeler {
...TeamMemberFragment
}
isCompleted
isStarted
statistic {
...LabelingStatusStatisticFragment
}
statisticsToShow {
...StatisticItemFragment
}
}
status
performance {
project {
...ProjectFragment
}
projectId
totalTimeSpent
effectiveTotalTimeSpent
conflicts
totalLabelApplied
numberOfAcceptedLabels
numberOfDocuments
numberOfTokens
numberOfLines
}
selfLabelingStatus
purpose
rootCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
reviewCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
labelerCabinets {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
guideline {
id
name
content
project {
...ProjectFragment
}
}
isArchived
projectMetadataItems {
id
teamId
creatorId
key
value
createdAt
updatedAt
}
}
}
Variables
{"projectIds": ["abc123"]}
Response
{
"data": {
"deleteProjects": [
{
"id": "4",
"team": Team,
"teamId": "4",
"owner": User,
"externalObjectStorageId": "abc123",
"rootDocumentId": 4,
"assignees": [ProjectAssignment],
"name": "abc123",
"tags": [Tag],
"type": "xyz789",
"createdDate": "xyz789",
"completedDate": "abc123",
"exportedDate": "abc123",
"updatedDate": "xyz789",
"isOwnerMe": false,
"isReviewByMeAllowed": false,
"settings": ProjectSettings,
"workspaceSettings": WorkspaceSettings,
"reviewingStatus": ReviewingStatus,
"labelingStatus": [LabelingStatus],
"status": "CREATED",
"performance": ProjectPerformance,
"selfLabelingStatus": "NOT_STARTED",
"purpose": "LABELING",
"rootCabinet": Cabinet,
"reviewCabinet": Cabinet,
"labelerCabinets": [Cabinet],
"guideline": Guideline,
"isArchived": false,
"projectMetadataItems": [ProjectMetadataItem]
}
]
}
}
deleteQuestionSet
deleteQuestionSets
deleteRowAnswers
Response
Returns a Boolean!
Example
Query
mutation DeleteRowAnswers(
$documentId: ID!,
$line: Int!,
$questionSetSignature: String
) {
deleteRowAnswers(
documentId: $documentId,
line: $line,
questionSetSignature: $questionSetSignature
)
}
Variables
{
"documentId": "4",
"line": 123,
"questionSetSignature": "abc123"
}
Response
{"data": {"deleteRowAnswers": false}}
deleteSentence
Response
Returns a DeleteSentenceResult!
Example
Query
mutation DeleteSentence(
$documentId: String!,
$signature: String!,
$sentenceId: Int!
) {
deleteSentence(
documentId: $documentId,
signature: $signature,
sentenceId: $sentenceId
) {
document {
id
chunks {
...TextChunkFragment
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
...TextDocumentSettingsFragment
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
...TextSentenceFragment
}
settings {
...SettingsFragment
}
statistic {
...TextDocumentStatisticFragment
}
type
updatedChunks {
...TextChunkFragment
}
updatedTokenLabels {
...TextLabelFragment
}
url
version
workspaceState {
...WorkspaceStateFragment
}
originId
signature
part
}
updatedCell {
line
index
content
tokens
metadata {
...CellMetadataFragment
}
conversationalMetadata {
...ConversationalMetadataFragment
}
status
conflict
conflicts {
...CellConflictFragment
}
originCell {
...CellFragment
}
}
addedLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
}
deletedLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
}
}
}
Variables
{
"documentId": "abc123",
"signature": "xyz789",
"sentenceId": 987
}
Response
{
"data": {
"deleteSentence": {
"document": TextDocument,
"updatedCell": Cell,
"addedLabels": [TextLabel],
"deletedLabels": [TextLabel]
}
}
}
deleteTeamApiKey
deleteTextDocument
Response
Returns a DeleteTextDocumentResult
Arguments
| Name | Description |
|---|---|
textDocumentId - String!
|
Example
Query
mutation DeleteTextDocument($textDocumentId: String!) {
deleteTextDocument(textDocumentId: $textDocumentId) {
id
}
}
Variables
{"textDocumentId": "abc123"}
Response
{
"data": {
"deleteTextDocument": {"id": "4"}
}
}
deleteTimestampLabels
Response
Returns [TimestampLabel!]!
Example
Query
mutation DeleteTimestampLabels(
$documentId: ID!,
$labelIds: [ID!]!
) {
deleteTimestampLabels(
documentId: $documentId,
labelIds: $labelIds
) {
id
documentId
layer
position {
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
}
startTimestampMillis
endTimestampMillis
type
}
}
Variables
{"documentId": 4, "labelIds": ["4"]}
Response
{
"data": {
"deleteTimestampLabels": [
{
"id": "4",
"documentId": 4,
"layer": 987,
"position": TextRange,
"startTimestampMillis": 123,
"endTimestampMillis": 123,
"type": "ARROW"
}
]
}
}
deployLlmEmbeddingModel
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmEmbeddingModel!
Arguments
| Name | Description |
|---|---|
input - LlmModelDeployInput!
|
Example
Query
mutation DeployLlmEmbeddingModel($input: LlmModelDeployInput!) {
deployLlmEmbeddingModel(input: $input) {
id
detail {
status
instanceType
instanceTypeDetail {
...LlmInstanceTypeDetailFragment
}
}
teamId
provider
name
displayName
url
maxTokens
dimensions
deployableModelId
isModelDeployable
createdAt
updatedAt
customDimension
}
}
Variables
{"input": LlmModelDeployInput}
Response
{
"data": {
"deployLlmEmbeddingModel": {
"id": "4",
"detail": LlmModelDetail,
"teamId": 4,
"provider": "AMAZON_BEDROCK",
"name": "abc123",
"displayName": "abc123",
"url": "xyz789",
"maxTokens": 987,
"dimensions": 123,
"deployableModelId": "xyz789",
"isModelDeployable": false,
"createdAt": "abc123",
"updatedAt": "abc123",
"customDimension": false
}
}
}
deployLlmModel
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmModel!
Example
Query
mutation DeployLlmModel(
$id: ID!,
$instanceType: String,
$automatedUndeployHours: Int
) {
deployLlmModel(
id: $id,
instanceType: $instanceType,
automatedUndeployHours: $automatedUndeployHours
) {
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
createdAt
updatedAt
}
}
Variables
{
"id": 4,
"instanceType": "xyz789",
"automatedUndeployHours": 123
}
Response
{
"data": {
"deployLlmModel": {
"id": "4",
"detail": LlmModelDetail,
"teamId": 4,
"provider": "AMAZON_BEDROCK",
"name": "abc123",
"displayName": "xyz789",
"url": "abc123",
"maxTemperature": 123.45,
"maxTopP": 987.65,
"maxTokens": 987,
"maxContextWindow": 987,
"defaultTemperature": 123.45,
"defaultTopP": 987.65,
"defaultMaxTokens": 987,
"llmModelFineTuningJob": LlmModelFineTuningJob,
"deployableModelId": "abc123",
"isModelDeployable": false,
"forceAnonymization": true,
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
disableUserTotpAuthentication
Description
Requires either totpCode or recoveryCode.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
totpCode - TotpCodeInput!
|
Example
Query
mutation DisableUserTotpAuthentication($totpCode: TotpCodeInput!) {
disableUserTotpAuthentication(totpCode: $totpCode)
}
Variables
{"totpCode": TotpCodeInput}
Response
{"data": {"disableUserTotpAuthentication": false}}
disconnectTeamExternalApiKey
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a TeamExternalApiKey!
Arguments
| Name | Description |
|---|---|
input - TeamExternalApiKeyDisconnectInput!
|
Example
Query
mutation DisconnectTeamExternalApiKey($input: TeamExternalApiKeyDisconnectInput!) {
disconnectTeamExternalApiKey(input: $input) {
id
teamId
credentials {
provider
isConnected
openAIKey
azureOpenAIKey
azureOpenAIEndpoint
azureAITenantId
azureAISubscriptionId
azureAIResourceGroupName
azureAIAccountName
awsSagemakerRegion
awsSagemakerExternalId
awsSagemakerRoleArn
awsBedrockRegion
awsBedrockExternalId
awsBedrockRoleArn
}
createdAt
updatedAt
}
}
Variables
{"input": TeamExternalApiKeyDisconnectInput}
Response
{
"data": {
"disconnectTeamExternalApiKey": {
"id": 4,
"teamId": "4",
"credentials": [TeamExternalApiKeyCredential],
"createdAt": "abc123",
"updatedAt": "xyz789"
}
}
}
duplicateLlmApplicationPlaygroundRagConfig
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplicationPlaygroundRagConfig!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation DuplicateLlmApplicationPlaygroundRagConfig($id: ID!) {
duplicateLlmApplicationPlaygroundRagConfig(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": {
"duplicateLlmApplicationPlaygroundRagConfig": {
"id": "4",
"llmApplicationId": 4,
"llmRagConfig": LlmRagConfig,
"name": "xyz789",
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
editComment
Example
Query
mutation EditComment(
$commentId: ID!,
$message: String!
) {
editComment(
commentId: $commentId,
message: $message
) {
id
parentId
documentId
originDocumentId
userId
user {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
message
resolved
resolvedAt
resolvedBy {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
repliesCount
createdAt
updatedAt
lastEditedAt
hashCode
commentedContent {
hashCodeType
contexts {
...CommentedContentContextValueFragment
}
currentValue {
...CommentedContentCurrentValueFragment
}
}
}
}
Variables
{
"commentId": "4",
"message": "abc123"
}
Response
{
"data": {
"editComment": {
"id": "4",
"parentId": "4",
"documentId": "4",
"originDocumentId": "4",
"userId": 987,
"user": User,
"message": "xyz789",
"resolved": false,
"resolvedAt": "abc123",
"resolvedBy": User,
"repliesCount": 123,
"createdAt": "xyz789",
"updatedAt": "abc123",
"lastEditedAt": "xyz789",
"hashCode": "xyz789",
"commentedContent": CommentedContent
}
}
}
editCustomModel
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmModel!
Arguments
| Name | Description |
|---|---|
input - EditLlmCustomModelInput!
|
Example
Query
mutation EditCustomModel($input: EditLlmCustomModelInput!) {
editCustomModel(input: $input) {
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
createdAt
updatedAt
}
}
Variables
{"input": EditLlmCustomModelInput}
Response
{
"data": {
"editCustomModel": {
"id": "4",
"detail": LlmModelDetail,
"teamId": 4,
"provider": "AMAZON_BEDROCK",
"name": "abc123",
"displayName": "abc123",
"url": "abc123",
"maxTemperature": 987.65,
"maxTopP": 987.65,
"maxTokens": 987,
"maxContextWindow": 123,
"defaultTemperature": 987.65,
"defaultTopP": 123.45,
"defaultMaxTokens": 987,
"llmModelFineTuningJob": LlmModelFineTuningJob,
"deployableModelId": "xyz789",
"isModelDeployable": false,
"forceAnonymization": false,
"createdAt": "abc123",
"updatedAt": "xyz789"
}
}
}
editSentence
Response
Returns an EditSentenceResult!
Arguments
| Name | Description |
|---|---|
input - EditSentenceInput!
|
Example
Query
mutation EditSentence($input: EditSentenceInput!) {
editSentence(input: $input) {
document {
id
chunks {
...TextChunkFragment
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
...TextDocumentSettingsFragment
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
...TextSentenceFragment
}
settings {
...SettingsFragment
}
statistic {
...TextDocumentStatisticFragment
}
type
updatedChunks {
...TextChunkFragment
}
updatedTokenLabels {
...TextLabelFragment
}
url
version
workspaceState {
...WorkspaceStateFragment
}
originId
signature
part
}
updatedCell {
line
index
content
tokens
metadata {
...CellMetadataFragment
}
conversationalMetadata {
...ConversationalMetadataFragment
}
status
conflict
conflicts {
...CellConflictFragment
}
originCell {
...CellFragment
}
}
addedLabels {
id
documentId
labeledBy
type
hashCode
labeledByUserId
acceptedByUserId
rejectedByUserId
}
deletedLabels {
id
documentId
labeledBy
type
hashCode
labeledByUserId
acceptedByUserId
rejectedByUserId
}
previousSentences {
id
documentId
userId
status
content
tokens
posLabels {
...TextLabelFragment
}
nerLabels {
...TextLabelFragment
}
docLabels {
...DocLabelObjectFragment
}
docLabelsString
conflicts {
...ConflictTextLabelFragment
}
conflictAnswers {
...ConflictAnswerFragment
}
answers {
...AnswerFragment
}
sentenceConflict {
...SentenceConflictFragment
}
conflictAnswerResolved
metadata {
...CellMetadataFragment
}
}
addedBoundingBoxLabels {
id
documentId
coordinates {
...CoordinateFragment
}
counter
pageIndex
layer
position {
...TextRangeFragment
}
hashCode
type
labeledBy
}
deletedBoundingBoxLabels {
id
documentId
coordinates {
...CoordinateFragment
}
counter
pageIndex
layer
position {
...TextRangeFragment
}
hashCode
type
labeledBy
}
}
}
Variables
{"input": EditSentenceInput}
Response
{
"data": {
"editSentence": {
"document": TextDocument,
"updatedCell": Cell,
"addedLabels": [GqlConflictable],
"deletedLabels": [GqlConflictable],
"previousSentences": [TextSentence],
"addedBoundingBoxLabels": [BoundingBoxLabel],
"deletedBoundingBoxLabels": [BoundingBoxLabel]
}
}
}
enableProjectExtensionElements
Response
Returns a ProjectExtension
Arguments
| Name | Description |
|---|---|
input - EnableProjectExtensionElementsInput!
|
Example
Query
mutation EnableProjectExtensionElements($input: EnableProjectExtensionElementsInput!) {
enableProjectExtensionElements(input: $input) {
id
cabinetId
elements {
id
enabled
extension {
...ExtensionFragment
}
height
order
setting {
...ExtensionElementSettingFragment
}
}
width
}
}
Variables
{"input": EnableProjectExtensionElementsInput}
Response
{
"data": {
"enableProjectExtensionElements": {
"id": "4",
"cabinetId": "4",
"elements": [ExtensionElement],
"width": 987
}
}
}
enableUserTotpAuthentication
Response
Returns a TotpRecoveryCodes!
Example
Query
mutation EnableUserTotpAuthentication(
$totpCode: String!,
$totpSecret: String!
) {
enableUserTotpAuthentication(
totpCode: $totpCode,
totpSecret: $totpSecret
) {
recoveryCodes
}
}
Variables
{
"totpCode": "abc123",
"totpSecret": "abc123"
}
Response
{
"data": {
"enableUserTotpAuthentication": {
"recoveryCodes": ["xyz789"]
}
}
}
enforceReviewerAutoLabelSettings
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - EnforceReviewerAutoLabelSettingsInput!
|
Example
Query
mutation EnforceReviewerAutoLabelSettings($input: EnforceReviewerAutoLabelSettingsInput!) {
enforceReviewerAutoLabelSettings(input: $input)
}
Variables
{"input": EnforceReviewerAutoLabelSettingsInput}
Response
{"data": {"enforceReviewerAutoLabelSettings": false}}
executeLlmEvaluationAutomated
Breaking changes may be introduced anytime in the future without prior notice.
Description
Executes an automated LLM evaluation.
Response
Returns a LlmEvaluationExecution!
Example
Query
mutation ExecuteLlmEvaluationAutomated(
$teamId: ID!,
$llmEvaluationId: ID!,
$llmExecutionId: ID
) {
executeLlmEvaluationAutomated(
teamId: $teamId,
llmEvaluationId: $llmEvaluationId,
llmExecutionId: $llmExecutionId
) {
id
llmEvaluationId
status
errorMessage
createdAt
updatedAt
isDeleted
}
}
Variables
{
"teamId": 4,
"llmEvaluationId": "4",
"llmExecutionId": 4
}
Response
{
"data": {
"executeLlmEvaluationAutomated": {
"id": 4,
"llmEvaluationId": "4",
"status": "PREPARING",
"errorMessage": "abc123",
"createdAt": "xyz789",
"updatedAt": "xyz789",
"isDeleted": true
}
}
}
finishTeamOnboarding
Response
Returns a TeamOnboarding!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
mutation FinishTeamOnboarding($teamId: ID!) {
finishTeamOnboarding(teamId: $teamId) {
id
teamId
state
version
tasks {
id
name
reward
completedAt
}
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"finishTeamOnboarding": {
"id": 4,
"teamId": "4",
"state": "NOT_OPENED",
"version": 987,
"tasks": [TeamOnboardingTask]
}
}
}
generateTotpAuthQRCode
Response
Returns a TotpAuthSecret!
Example
Query
mutation GenerateTotpAuthQRCode {
generateTotpAuthQRCode {
secret
otpAuthUrl
qrCode
}
}
Response
{
"data": {
"generateTotpAuthQRCode": {
"secret": "abc123",
"otpAuthUrl": "xyz789",
"qrCode": "abc123"
}
}
}
getOrCreateLabelErrorDetectionRowBased
Response
Returns a LabelErrorDetectionRowBased!
Arguments
| Name | Description |
|---|---|
input - GetOrCreateLabelErrorDetectionRowBasedInput!
|
Example
Query
mutation GetOrCreateLabelErrorDetectionRowBased($input: GetOrCreateLabelErrorDetectionRowBasedInput!) {
getOrCreateLabelErrorDetectionRowBased(input: $input) {
id
cabinetId
inputColumnIds
questionColumnId
jobId
createdAt
updatedAt
}
}
Variables
{"input": GetOrCreateLabelErrorDetectionRowBasedInput}
Response
{
"data": {
"getOrCreateLabelErrorDetectionRowBased": {
"id": "4",
"cabinetId": "4",
"inputColumnIds": [123],
"questionColumnId": 123,
"jobId": "4",
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
importTextDocument
Response
Returns a TextDocument!
Arguments
| Name | Description |
|---|---|
input - ImportTextDocumentInput!
|
Example
Query
mutation ImportTextDocument($input: ImportTextDocumentInput!) {
importTextDocument(input: $input) {
id
chunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
kinds
sentenceSeparator
tokenizer
editSentenceTokenizer
displayedRows
mediaDisplayStrategy
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
fileTransformerId
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
id
documentId
userId
status
content
tokens
posLabels {
...TextLabelFragment
}
nerLabels {
...TextLabelFragment
}
docLabels {
...DocLabelObjectFragment
}
docLabelsString
conflicts {
...ConflictTextLabelFragment
}
conflictAnswers {
...ConflictAnswerFragment
}
answers {
...AnswerFragment
}
sentenceConflict {
...SentenceConflictFragment
}
conflictAnswerResolved
metadata {
...CellMetadataFragment
}
}
settings {
textLang
}
statistic {
documentId
numberOfChunks
numberOfSentences
numberOfTokens
effectiveTimeSpent
touchedSentences
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
}
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
}
url
version
workspaceState {
id
chunkId
sentenceStart
sentenceEnd
touchedChunks
touchedSentences
}
originId
signature
part
}
}
Variables
{"input": ImportTextDocumentInput}
Response
{
"data": {
"importTextDocument": {
"id": "4",
"chunks": [TextChunk],
"createdAt": "xyz789",
"currentSentenceCursor": 123,
"lastLabeledLine": 987,
"documentSettings": TextDocumentSettings,
"fileName": "xyz789",
"isCompleted": false,
"lastSavedAt": "xyz789",
"mimeType": "abc123",
"name": "xyz789",
"projectId": "4",
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "abc123",
"version": 123,
"workspaceState": WorkspaceState,
"originId": "4",
"signature": "xyz789",
"part": 123
}
}
}
insertMultiRowAnswers
Description
Appends the answers at the specified lines
Response
Returns an InsertMultiRowAnswersResult!
Arguments
| Name | Description |
|---|---|
input - UpdateMultiRowAnswersInput!
|
|
questionSetSignature - String
|
Example
Query
mutation InsertMultiRowAnswers(
$input: UpdateMultiRowAnswersInput!,
$questionSetSignature: String
) {
insertMultiRowAnswers(
input: $input,
questionSetSignature: $questionSetSignature
) {
document {
id
chunks {
...TextChunkFragment
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
...TextDocumentSettingsFragment
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
...TextSentenceFragment
}
settings {
...SettingsFragment
}
statistic {
...TextDocumentStatisticFragment
}
type
updatedChunks {
...TextChunkFragment
}
updatedTokenLabels {
...TextLabelFragment
}
url
version
workspaceState {
...WorkspaceStateFragment
}
originId
signature
part
}
previousAnswers {
documentId
line
answers
metadata {
...AnswerMetadataFragment
}
updatedAt
}
updatedAnswers {
documentId
line
answers
metadata {
...AnswerMetadataFragment
}
updatedAt
}
}
}
Variables
{
"input": UpdateMultiRowAnswersInput,
"questionSetSignature": "xyz789"
}
Response
{
"data": {
"insertMultiRowAnswers": {
"document": TextDocument,
"previousAnswers": [RowAnswer],
"updatedAnswers": [RowAnswer]
}
}
}
insertSentence
Response
Returns a Cell!
Arguments
| Name | Description |
|---|---|
documentId - String!
|
|
signature - String!
|
|
insertTarget - InsertTargetInput!
|
|
content - String!
|
|
tokenizationMethod - TokenizationMethod
|
|
metadata - [CellMetadataInput!]
|
Deprecated. The value provided will be ignored. |
Example
Query
mutation InsertSentence(
$documentId: String!,
$signature: String!,
$insertTarget: InsertTargetInput!,
$content: String!,
$tokenizationMethod: TokenizationMethod,
$metadata: [CellMetadataInput!]
) {
insertSentence(
documentId: $documentId,
signature: $signature,
insertTarget: $insertTarget,
content: $content,
tokenizationMethod: $tokenizationMethod,
metadata: $metadata
) {
line
index
content
tokens
metadata {
key
value
type
pinned
config {
...TextMetadataConfigFragment
}
}
conversationalMetadata {
speaker
indent
alignment
color
}
status
conflict
conflicts {
documentId
labelerId
cell {
...CellFragment
}
labels {
...TextLabelFragment
}
}
originCell {
line
index
content
tokens
metadata {
...CellMetadataFragment
}
conversationalMetadata {
...ConversationalMetadataFragment
}
status
conflict
conflicts {
...CellConflictFragment
}
originCell {
...CellFragment
}
}
}
}
Variables
{
"documentId": "xyz789",
"signature": "xyz789",
"insertTarget": InsertTargetInput,
"content": "xyz789",
"tokenizationMethod": "WINK",
"metadata": [CellMetadataInput]
}
Response
{
"data": {
"insertSentence": {
"line": 123,
"index": 123,
"content": "abc123",
"tokens": ["xyz789"],
"metadata": [CellMetadata],
"conversationalMetadata": ConversationalMetadata,
"status": "DISPLAYED",
"conflict": false,
"conflicts": [CellConflict],
"originCell": Cell
}
}
}
inviteTeamMembers
Response
Returns [TeamMember!]!
Arguments
| Name | Description |
|---|---|
input - InviteTeamMembersInput!
|
|
datasaurApp - DatasaurApp
|
Example
Query
mutation InviteTeamMembers(
$input: InviteTeamMembersInput!,
$datasaurApp: DatasaurApp
) {
inviteTeamMembers(
input: $input,
datasaurApp: $datasaurApp
) {
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": InviteTeamMembersInput, "datasaurApp": "NLP"}
Response
{
"data": {
"inviteTeamMembers": [
{
"id": 4,
"user": User,
"role": TeamRole,
"invitationEmail": "xyz789",
"invitationStatus": "abc123",
"invitationKey": "xyz789",
"isDeleted": true,
"joinedDate": "xyz789",
"performance": TeamMemberPerformance
}
]
}
}
launchTextProject
Please use
createProject
Description
Superseded by createProject.
For more information regarding migrating to the new mutation, please see here
Mutation will be removed after June 30th, 2024
Response
Returns a Project!
Arguments
| Name | Description |
|---|---|
input - LaunchTextProjectInput!
|
Example
Query
mutation LaunchTextProject($input: LaunchTextProjectInput!) {
launchTextProject(input: $input) {
id
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
teamId
owner {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
createdAt
updatedAt
}
name
tags {
id
name
globalTag
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
autoMarkDocumentAsComplete
consensus
conflictResolution {
...ConflictResolutionFragment
}
dynamicReviewMethod
dynamicReviewMemberId
enableEditLabelSet
enableReviewerEditSentence
enableReviewerInsertSentence
enableReviewerDeleteSentence
enableEditSentence
enableInsertSentence
enableDeleteSentence
enableDirectBBoxEditing
enableEnforceAutoLabelReviewerSettings
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
shouldConfirmUnusedLabelSetItems
spotChecking {
...SpotCheckingFragment
}
}
workspaceSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
asrProvider
kinds
sentenceSeparator
displayedRows
mediaDisplayStrategy
tokenizer
firstRowAsHeader
transcriptMethod
ocrProvider
customScriptId
fileTransformerId
customTextExtractionAPIId
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
}
reviewingStatus {
isCompleted
statistic {
...ReviewingStatusStatisticFragment
}
}
labelingStatus {
labeler {
...TeamMemberFragment
}
isCompleted
isStarted
statistic {
...LabelingStatusStatisticFragment
}
statisticsToShow {
...StatisticItemFragment
}
}
status
performance {
project {
...ProjectFragment
}
projectId
totalTimeSpent
effectiveTotalTimeSpent
conflicts
totalLabelApplied
numberOfAcceptedLabels
numberOfDocuments
numberOfTokens
numberOfLines
}
selfLabelingStatus
purpose
rootCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
reviewCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
labelerCabinets {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
guideline {
id
name
content
project {
...ProjectFragment
}
}
isArchived
projectMetadataItems {
id
teamId
creatorId
key
value
createdAt
updatedAt
}
}
}
Variables
{"input": LaunchTextProjectInput}
Response
{
"data": {
"launchTextProject": {
"id": 4,
"team": Team,
"teamId": "4",
"owner": User,
"externalObjectStorageId": "abc123",
"rootDocumentId": "4",
"assignees": [ProjectAssignment],
"name": "abc123",
"tags": [Tag],
"type": "abc123",
"createdDate": "xyz789",
"completedDate": "abc123",
"exportedDate": "xyz789",
"updatedDate": "abc123",
"isOwnerMe": true,
"isReviewByMeAllowed": true,
"settings": ProjectSettings,
"workspaceSettings": WorkspaceSettings,
"reviewingStatus": ReviewingStatus,
"labelingStatus": [LabelingStatus],
"status": "CREATED",
"performance": ProjectPerformance,
"selfLabelingStatus": "NOT_STARTED",
"purpose": "LABELING",
"rootCabinet": Cabinet,
"reviewCabinet": Cabinet,
"labelerCabinets": [Cabinet],
"guideline": Guideline,
"isArchived": true,
"projectMetadataItems": [ProjectMetadataItem]
}
}
}
launchTextProjectAsync
Please use
createProject
Description
Create a new project based on the specified configuration. The response is a job, not the actual project since it's an asynchronous request. See the more detailed explanation here.
Superseded by createProject.
For more information regarding migrating to the new mutation, please see here
Support and bug-fixes will continue to be provided for this mutation until March 31st, 2024.
Mutation will be removed after June 30th, 2024
Response
Returns a ProjectLaunchJob!
Arguments
| Name | Description |
|---|---|
input - LaunchTextProjectInput!
|
Example
Query
mutation LaunchTextProjectAsync($input: LaunchTextProjectInput!) {
launchTextProjectAsync(input: $input) {
job {
id
status
progress
errors {
...JobErrorFragment
}
resultId
result
createdAt
updatedAt
additionalData {
...JobAdditionalDataFragment
}
}
name
}
}
Variables
{"input": LaunchTextProjectInput}
Response
{
"data": {
"launchTextProjectAsync": {
"job": Job,
"name": "xyz789"
}
}
}
loadLlmApplicationConfigurationToPlayground
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplicationConfiguration!
Arguments
| Name | Description |
|---|---|
input - LoadLlmApplicationConfigurationInput!
|
Example
Query
mutation LoadLlmApplicationConfigurationToPlayground($input: LoadLlmApplicationConfigurationInput!) {
loadLlmApplicationConfigurationToPlayground(input: $input) {
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
{"input": LoadLlmApplicationConfigurationInput}
Response
{
"data": {
"loadLlmApplicationConfigurationToPlayground": {
"id": 4,
"name": "abc123",
"teamId": 4,
"createdByUserId": 4,
"createdByUser": User,
"updatedByUserId": "4",
"updatedByUser": User,
"llmRagConfigId": "4",
"llmRagConfig": LlmRagConfig,
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
login
Response
Returns a LoginResult!
Arguments
| Name | Description |
|---|---|
loginInput - LoginInput!
|
|
datasaurApp - DatasaurApp
|
Example
Query
mutation Login(
$loginInput: LoginInput!,
$datasaurApp: DatasaurApp
) {
login(
loginInput: $loginInput,
datasaurApp: $datasaurApp
) {
type
successData {
user {
...UserFragment
}
redirect
}
}
}
Variables
{"loginInput": LoginInput, "datasaurApp": "NLP"}
Response
{
"data": {
"login": {
"type": "SUCCESS",
"successData": LoginSuccess
}
}
}
logout
Response
Returns a String
Example
Query
mutation Logout {
logout
}
Response
{"data": {"logout": "abc123"}}
markAllDocumentsAsComplete
Response
Returns [TextDocument!]!
Arguments
| Name | Description |
|---|---|
cabinetId - ID!
|
Example
Query
mutation MarkAllDocumentsAsComplete($cabinetId: ID!) {
markAllDocumentsAsComplete(cabinetId: $cabinetId) {
id
chunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
kinds
sentenceSeparator
tokenizer
editSentenceTokenizer
displayedRows
mediaDisplayStrategy
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
fileTransformerId
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
id
documentId
userId
status
content
tokens
posLabels {
...TextLabelFragment
}
nerLabels {
...TextLabelFragment
}
docLabels {
...DocLabelObjectFragment
}
docLabelsString
conflicts {
...ConflictTextLabelFragment
}
conflictAnswers {
...ConflictAnswerFragment
}
answers {
...AnswerFragment
}
sentenceConflict {
...SentenceConflictFragment
}
conflictAnswerResolved
metadata {
...CellMetadataFragment
}
}
settings {
textLang
}
statistic {
documentId
numberOfChunks
numberOfSentences
numberOfTokens
effectiveTimeSpent
touchedSentences
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
}
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
}
url
version
workspaceState {
id
chunkId
sentenceStart
sentenceEnd
touchedChunks
touchedSentences
}
originId
signature
part
}
}
Variables
{"cabinetId": 4}
Response
{
"data": {
"markAllDocumentsAsComplete": [
{
"id": 4,
"chunks": [TextChunk],
"createdAt": "xyz789",
"currentSentenceCursor": 123,
"lastLabeledLine": 987,
"documentSettings": TextDocumentSettings,
"fileName": "xyz789",
"isCompleted": false,
"lastSavedAt": "xyz789",
"mimeType": "xyz789",
"name": "abc123",
"projectId": "4",
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "xyz789",
"version": 123,
"workspaceState": WorkspaceState,
"originId": "4",
"signature": "xyz789",
"part": 987
}
]
}
}
markAllUnusedLabelClasses
Description
Mark all unused label classes in a document
markDocumentAsComplete
Response
Returns a TextDocument!
Example
Query
mutation MarkDocumentAsComplete(
$documentId: ID!,
$skipValidation: Boolean
) {
markDocumentAsComplete(
documentId: $documentId,
skipValidation: $skipValidation
) {
id
chunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
kinds
sentenceSeparator
tokenizer
editSentenceTokenizer
displayedRows
mediaDisplayStrategy
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
fileTransformerId
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
id
documentId
userId
status
content
tokens
posLabels {
...TextLabelFragment
}
nerLabels {
...TextLabelFragment
}
docLabels {
...DocLabelObjectFragment
}
docLabelsString
conflicts {
...ConflictTextLabelFragment
}
conflictAnswers {
...ConflictAnswerFragment
}
answers {
...AnswerFragment
}
sentenceConflict {
...SentenceConflictFragment
}
conflictAnswerResolved
metadata {
...CellMetadataFragment
}
}
settings {
textLang
}
statistic {
documentId
numberOfChunks
numberOfSentences
numberOfTokens
effectiveTimeSpent
touchedSentences
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
}
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
}
url
version
workspaceState {
id
chunkId
sentenceStart
sentenceEnd
touchedChunks
touchedSentences
}
originId
signature
part
}
}
Variables
{"documentId": 4, "skipValidation": false}
Response
{
"data": {
"markDocumentAsComplete": {
"id": 4,
"chunks": [TextChunk],
"createdAt": "xyz789",
"currentSentenceCursor": 987,
"lastLabeledLine": 987,
"documentSettings": TextDocumentSettings,
"fileName": "xyz789",
"isCompleted": false,
"lastSavedAt": "abc123",
"mimeType": "xyz789",
"name": "abc123",
"projectId": 4,
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "abc123",
"version": 987,
"workspaceState": WorkspaceState,
"originId": 4,
"signature": "xyz789",
"part": 123
}
}
}
markDocumentAsInProgress
Response
Returns a TextDocument!
Example
Query
mutation MarkDocumentAsInProgress(
$documentId: ID!,
$skipValidation: Boolean
) {
markDocumentAsInProgress(
documentId: $documentId,
skipValidation: $skipValidation
) {
id
chunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
kinds
sentenceSeparator
tokenizer
editSentenceTokenizer
displayedRows
mediaDisplayStrategy
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
fileTransformerId
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
id
documentId
userId
status
content
tokens
posLabels {
...TextLabelFragment
}
nerLabels {
...TextLabelFragment
}
docLabels {
...DocLabelObjectFragment
}
docLabelsString
conflicts {
...ConflictTextLabelFragment
}
conflictAnswers {
...ConflictAnswerFragment
}
answers {
...AnswerFragment
}
sentenceConflict {
...SentenceConflictFragment
}
conflictAnswerResolved
metadata {
...CellMetadataFragment
}
}
settings {
textLang
}
statistic {
documentId
numberOfChunks
numberOfSentences
numberOfTokens
effectiveTimeSpent
touchedSentences
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
}
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
}
url
version
workspaceState {
id
chunkId
sentenceStart
sentenceEnd
touchedChunks
touchedSentences
}
originId
signature
part
}
}
Variables
{"documentId": 4, "skipValidation": false}
Response
{
"data": {
"markDocumentAsInProgress": {
"id": 4,
"chunks": [TextChunk],
"createdAt": "xyz789",
"currentSentenceCursor": 987,
"lastLabeledLine": 123,
"documentSettings": TextDocumentSettings,
"fileName": "abc123",
"isCompleted": true,
"lastSavedAt": "xyz789",
"mimeType": "xyz789",
"name": "abc123",
"projectId": 4,
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "xyz789",
"version": 123,
"workspaceState": WorkspaceState,
"originId": "4",
"signature": "abc123",
"part": 123
}
}
}
markRemovePaymentMethod
Breaking changes may be introduced anytime in the future without prior notice.
markUnusedLabelClass
Description
Mark a label class as N/A
Response
Returns an UnusedLabelClass!
Arguments
| Name | Description |
|---|---|
input - MarkUnusedLabelClassInput!
|
Example
Query
mutation MarkUnusedLabelClass($input: MarkUnusedLabelClassInput!) {
markUnusedLabelClass(input: $input) {
documentId
labelSetId
labelClassId
isMarked
}
}
Variables
{"input": MarkUnusedLabelClassInput}
Response
{
"data": {
"markUnusedLabelClass": {
"documentId": "4",
"labelSetId": 4,
"labelClassId": "abc123",
"isMarked": false
}
}
}
migrateUserDataToHubspot
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
userIds - [String!]!
|
Example
Query
mutation MigrateUserDataToHubspot($userIds: [String!]!) {
migrateUserDataToHubspot(userIds: $userIds)
}
Variables
{"userIds": ["xyz789"]}
Response
{"data": {"migrateUserDataToHubspot": true}}
modifyDocumentQuestions
Response
Returns [Question!]!
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
|
input - [ModifyQuestionInput!]!
|
|
signature - String
|
Example
Query
mutation ModifyDocumentQuestions(
$projectId: ID!,
$input: [ModifyQuestionInput!]!,
$signature: String
) {
modifyDocumentQuestions(
projectId: $projectId,
input: $input,
signature: $signature
) {
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,
"input": [ModifyQuestionInput],
"signature": "xyz789"
}
Response
{
"data": {
"modifyDocumentQuestions": [
{
"id": 123,
"internalId": "abc123",
"type": "DROPDOWN",
"name": "abc123",
"label": "xyz789",
"required": true,
"config": QuestionConfig,
"bindToColumn": "xyz789",
"activationConditionLogic": "xyz789"
}
]
}
}
modifyRowQuestions
Response
Returns [Question!]!
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
|
input - [ModifyQuestionInput!]!
|
|
signature - String
|
Example
Query
mutation ModifyRowQuestions(
$projectId: ID!,
$input: [ModifyQuestionInput!]!,
$signature: String
) {
modifyRowQuestions(
projectId: $projectId,
input: $input,
signature: $signature
) {
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",
"input": [ModifyQuestionInput],
"signature": "xyz789"
}
Response
{
"data": {
"modifyRowQuestions": [
{
"id": 123,
"internalId": "xyz789",
"type": "DROPDOWN",
"name": "abc123",
"label": "abc123",
"required": true,
"config": QuestionConfig,
"bindToColumn": "abc123",
"activationConditionLogic": "xyz789"
}
]
}
}
overrideSentences
Response
Returns an UpdateSentenceResult!
Arguments
| Name | Description |
|---|---|
input - OverrideSentencesInput!
|
Example
Query
mutation OverrideSentences($input: OverrideSentencesInput!) {
overrideSentences(input: $input) {
document {
id
chunks {
...TextChunkFragment
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
...TextDocumentSettingsFragment
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
...TextSentenceFragment
}
settings {
...SettingsFragment
}
statistic {
...TextDocumentStatisticFragment
}
type
updatedChunks {
...TextChunkFragment
}
updatedTokenLabels {
...TextLabelFragment
}
url
version
workspaceState {
...WorkspaceStateFragment
}
originId
signature
part
}
updatedSentences {
id
documentId
userId
status
content
tokens
posLabels {
...TextLabelFragment
}
nerLabels {
...TextLabelFragment
}
docLabels {
...DocLabelObjectFragment
}
docLabelsString
conflicts {
...ConflictTextLabelFragment
}
conflictAnswers {
...ConflictAnswerFragment
}
answers {
...AnswerFragment
}
sentenceConflict {
...SentenceConflictFragment
}
conflictAnswerResolved
metadata {
...CellMetadataFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
}
previousTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
}
addedLabels {
id
documentId
labeledBy
type
hashCode
labeledByUserId
acceptedByUserId
rejectedByUserId
}
deletedLabels {
id
documentId
labeledBy
type
hashCode
labeledByUserId
acceptedByUserId
rejectedByUserId
}
updatedCells {
line
index
content
tokens
metadata {
...CellMetadataFragment
}
conversationalMetadata {
...ConversationalMetadataFragment
}
status
conflict
conflicts {
...CellConflictFragment
}
originCell {
...CellFragment
}
}
addedBoundingBoxLabels {
id
documentId
coordinates {
...CoordinateFragment
}
counter
pageIndex
layer
position {
...TextRangeFragment
}
hashCode
type
labeledBy
}
deletedBoundingBoxLabels {
id
documentId
coordinates {
...CoordinateFragment
}
counter
pageIndex
layer
position {
...TextRangeFragment
}
hashCode
type
labeledBy
}
}
}
Variables
{"input": OverrideSentencesInput}
Response
{
"data": {
"overrideSentences": {
"document": TextDocument,
"updatedSentences": [TextSentence],
"updatedTokenLabels": [TextLabel],
"previousTokenLabels": [TextLabel],
"addedLabels": [GqlConflictable],
"deletedLabels": [GqlConflictable],
"updatedCells": [Cell],
"addedBoundingBoxLabels": [BoundingBoxLabel],
"deletedBoundingBoxLabels": [BoundingBoxLabel]
}
}
}
recalculateBBoxLabelsShapesHash
Response
Returns a Job!
Arguments
| Name | Description |
|---|---|
input - RecalculateBBoxLabelsShapesHashInput!
|
Example
Query
mutation RecalculateBBoxLabelsShapesHash($input: RecalculateBBoxLabelsShapesHashInput!) {
recalculateBBoxLabelsShapesHash(input: $input) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
}
}
}
Variables
{"input": RecalculateBBoxLabelsShapesHashInput}
Response
{
"data": {
"recalculateBBoxLabelsShapesHash": {
"id": "xyz789",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "abc123",
"additionalData": JobAdditionalData
}
}
}
redactCells
Description
Redact Cells' content and tokens. The content and tokens will be replaced by asterisks (*).
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
|
input - RedactCellsInput!
|
Example
Query
mutation RedactCells(
$projectId: ID!,
$input: RedactCellsInput!
) {
redactCells(
projectId: $projectId,
input: $input
)
}
Variables
{"projectId": 4, "input": RedactCellsInput}
Response
{"data": {"redactCells": false}}
redactTextDocuments
Description
Redact data related to Text Document:
- Cells
- File that is stored in Datasaur's file storage
Example
Query
mutation RedactTextDocuments(
$projectId: ID!,
$originDocumentIds: [ID!]!
) {
redactTextDocuments(
projectId: $projectId,
originDocumentIds: $originDocumentIds
)
}
Variables
{"projectId": 4, "originDocumentIds": ["4"]}
Response
{"data": {"redactTextDocuments": true}}
redeployLlmEmbeddingModel
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmEmbeddingModel!
Example
Query
mutation RedeployLlmEmbeddingModel(
$id: ID!,
$instanceType: String!
) {
redeployLlmEmbeddingModel(
id: $id,
instanceType: $instanceType
) {
id
detail {
status
instanceType
instanceTypeDetail {
...LlmInstanceTypeDetailFragment
}
}
teamId
provider
name
displayName
url
maxTokens
dimensions
deployableModelId
isModelDeployable
createdAt
updatedAt
customDimension
}
}
Variables
{
"id": "4",
"instanceType": "xyz789"
}
Response
{
"data": {
"redeployLlmEmbeddingModel": {
"id": "4",
"detail": LlmModelDetail,
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "abc123",
"displayName": "xyz789",
"url": "xyz789",
"maxTokens": 987,
"dimensions": 987,
"deployableModelId": "abc123",
"isModelDeployable": true,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"customDimension": false
}
}
}
regenerateUserTotpRecoveryCodes
Response
Returns a TotpRecoveryCodes!
Arguments
| Name | Description |
|---|---|
totpCode - TotpCodeInput!
|
Example
Query
mutation RegenerateUserTotpRecoveryCodes($totpCode: TotpCodeInput!) {
regenerateUserTotpRecoveryCodes(totpCode: $totpCode) {
recoveryCodes
}
}
Variables
{"totpCode": TotpCodeInput}
Response
{
"data": {
"regenerateUserTotpRecoveryCodes": {
"recoveryCodes": ["abc123"]
}
}
}
rejectBoundingBoxConflict
Response
Returns [BoundingBoxLabel!]!
Example
Query
mutation RejectBoundingBoxConflict(
$documentId: ID!,
$boundingBoxLabelIds: [ID!]!
) {
rejectBoundingBoxConflict(
documentId: $documentId,
boundingBoxLabelIds: $boundingBoxLabelIds
) {
id
documentId
coordinates {
x
y
}
counter
pageIndex
layer
position {
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
}
hashCode
type
labeledBy
}
}
Variables
{"documentId": 4, "boundingBoxLabelIds": [4]}
Response
{
"data": {
"rejectBoundingBoxConflict": [
{
"id": "4",
"documentId": 4,
"coordinates": [Coordinate],
"counter": 123,
"pageIndex": 987,
"layer": 987,
"position": TextRange,
"hashCode": "xyz789",
"type": "ARROW",
"labeledBy": "PRELABELED"
}
]
}
}
rejectTimestampLabelConflicts
Response
Returns [TimestampLabel!]!
Example
Query
mutation RejectTimestampLabelConflicts(
$documentId: ID!,
$labelIds: [ID!]!
) {
rejectTimestampLabelConflicts(
documentId: $documentId,
labelIds: $labelIds
) {
id
documentId
layer
position {
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
}
startTimestampMillis
endTimestampMillis
type
}
}
Variables
{
"documentId": "4",
"labelIds": ["4"]
}
Response
{
"data": {
"rejectTimestampLabelConflicts": [
{
"id": "4",
"documentId": "4",
"layer": 987,
"position": TextRange,
"startTimestampMillis": 987,
"endTimestampMillis": 123,
"type": "ARROW"
}
]
}
}
removeFileTransformer
Response
Returns a FileTransformer!
Arguments
| Name | Description |
|---|---|
fileTransformerId - ID!
|
Example
Query
mutation RemoveFileTransformer($fileTransformerId: ID!) {
removeFileTransformer(fileTransformerId: $fileTransformerId) {
id
name
content
transpiled
createdAt
updatedAt
language
purpose
readonly
externalId
warmup
}
}
Variables
{"fileTransformerId": 4}
Response
{
"data": {
"removeFileTransformer": {
"id": 4,
"name": "abc123",
"content": "xyz789",
"transpiled": "xyz789",
"createdAt": "abc123",
"updatedAt": "abc123",
"language": "TYPESCRIPT",
"purpose": "IMPORT",
"readonly": false,
"externalId": "xyz789",
"warmup": true
}
}
}
removePersonalTags
Response
Returns [RemoveTagsResult!]!
Arguments
| Name | Description |
|---|---|
input - RemovePersonalTagsInput!
|
Example
Query
mutation RemovePersonalTags($input: RemovePersonalTagsInput!) {
removePersonalTags(input: $input) {
tagId
}
}
Variables
{"input": RemovePersonalTagsInput}
Response
{"data": {"removePersonalTags": [{"tagId": 4}]}}
removeProjectMetadata
Description
Removes specified metadata from a project. If the specified metadata doesn't exist, mutation will throw an error.
Response
Returns a Project!
Arguments
| Name | Description |
|---|---|
input - ProjectMetadataInput!
|
Example
Query
mutation RemoveProjectMetadata($input: ProjectMetadataInput!) {
removeProjectMetadata(input: $input) {
id
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
teamId
owner {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
createdAt
updatedAt
}
name
tags {
id
name
globalTag
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
autoMarkDocumentAsComplete
consensus
conflictResolution {
...ConflictResolutionFragment
}
dynamicReviewMethod
dynamicReviewMemberId
enableEditLabelSet
enableReviewerEditSentence
enableReviewerInsertSentence
enableReviewerDeleteSentence
enableEditSentence
enableInsertSentence
enableDeleteSentence
enableDirectBBoxEditing
enableEnforceAutoLabelReviewerSettings
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
shouldConfirmUnusedLabelSetItems
spotChecking {
...SpotCheckingFragment
}
}
workspaceSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
asrProvider
kinds
sentenceSeparator
displayedRows
mediaDisplayStrategy
tokenizer
firstRowAsHeader
transcriptMethod
ocrProvider
customScriptId
fileTransformerId
customTextExtractionAPIId
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
}
reviewingStatus {
isCompleted
statistic {
...ReviewingStatusStatisticFragment
}
}
labelingStatus {
labeler {
...TeamMemberFragment
}
isCompleted
isStarted
statistic {
...LabelingStatusStatisticFragment
}
statisticsToShow {
...StatisticItemFragment
}
}
status
performance {
project {
...ProjectFragment
}
projectId
totalTimeSpent
effectiveTotalTimeSpent
conflicts
totalLabelApplied
numberOfAcceptedLabels
numberOfDocuments
numberOfTokens
numberOfLines
}
selfLabelingStatus
purpose
rootCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
reviewCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
labelerCabinets {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
guideline {
id
name
content
project {
...ProjectFragment
}
}
isArchived
projectMetadataItems {
id
teamId
creatorId
key
value
createdAt
updatedAt
}
}
}
Variables
{"input": ProjectMetadataInput}
Response
{
"data": {
"removeProjectMetadata": {
"id": "4",
"team": Team,
"teamId": "4",
"owner": User,
"externalObjectStorageId": "abc123",
"rootDocumentId": 4,
"assignees": [ProjectAssignment],
"name": "abc123",
"tags": [Tag],
"type": "xyz789",
"createdDate": "abc123",
"completedDate": "abc123",
"exportedDate": "abc123",
"updatedDate": "abc123",
"isOwnerMe": true,
"isReviewByMeAllowed": false,
"settings": ProjectSettings,
"workspaceSettings": WorkspaceSettings,
"reviewingStatus": ReviewingStatus,
"labelingStatus": [LabelingStatus],
"status": "CREATED",
"performance": ProjectPerformance,
"selfLabelingStatus": "NOT_STARTED",
"purpose": "LABELING",
"rootCabinet": Cabinet,
"reviewCabinet": Cabinet,
"labelerCabinets": [Cabinet],
"guideline": Guideline,
"isArchived": false,
"projectMetadataItems": [ProjectMetadataItem]
}
}
}
removeQuestionSetTemplate
removeSearchKeyword
Response
Returns a SearchHistoryKeyword!
Arguments
| Name | Description |
|---|---|
keyword - String!
|
Example
Query
mutation RemoveSearchKeyword($keyword: String!) {
removeSearchKeyword(keyword: $keyword) {
id
keyword
}
}
Variables
{"keyword": "xyz789"}
Response
{
"data": {
"removeSearchKeyword": {
"id": 4,
"keyword": "abc123"
}
}
}
removeTags
Response
Returns [RemoveTagsResult!]!
Arguments
| Name | Description |
|---|---|
input - RemoveTagsInput!
|
Example
Query
mutation RemoveTags($input: RemoveTagsInput!) {
removeTags(input: $input) {
tagId
}
}
Variables
{"input": RemoveTagsInput}
Response
{"data": {"removeTags": [{"tagId": 4}]}}
removeTeamMember
Please use removeTeamMembers instead
Response
Returns a TeamMember
Arguments
| Name | Description |
|---|---|
input - RemoveTeamMemberInput!
|
Example
Query
mutation RemoveTeamMember($input: RemoveTeamMemberInput!) {
removeTeamMember(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": RemoveTeamMemberInput}
Response
{
"data": {
"removeTeamMember": {
"id": 4,
"user": User,
"role": TeamRole,
"invitationEmail": "abc123",
"invitationStatus": "abc123",
"invitationKey": "abc123",
"isDeleted": true,
"joinedDate": "abc123",
"performance": TeamMemberPerformance
}
}
}
removeTeamMembers
Response
Returns [TeamMember]
Arguments
| Name | Description |
|---|---|
input - RemoveTeamMembersInput!
|
Example
Query
mutation RemoveTeamMembers($input: RemoveTeamMembersInput!) {
removeTeamMembers(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": RemoveTeamMembersInput}
Response
{
"data": {
"removeTeamMembers": [
{
"id": 4,
"user": User,
"role": TeamRole,
"invitationEmail": "abc123",
"invitationStatus": "abc123",
"invitationKey": "abc123",
"isDeleted": false,
"joinedDate": "abc123",
"performance": TeamMemberPerformance
}
]
}
}
replaceProjectAssignees
Response
Returns a Project!
Arguments
| Name | Description |
|---|---|
input - AssignProjectInput!
|
Example
Query
mutation ReplaceProjectAssignees($input: AssignProjectInput!) {
replaceProjectAssignees(input: $input) {
id
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
teamId
owner {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
createdAt
updatedAt
}
name
tags {
id
name
globalTag
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
autoMarkDocumentAsComplete
consensus
conflictResolution {
...ConflictResolutionFragment
}
dynamicReviewMethod
dynamicReviewMemberId
enableEditLabelSet
enableReviewerEditSentence
enableReviewerInsertSentence
enableReviewerDeleteSentence
enableEditSentence
enableInsertSentence
enableDeleteSentence
enableDirectBBoxEditing
enableEnforceAutoLabelReviewerSettings
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
shouldConfirmUnusedLabelSetItems
spotChecking {
...SpotCheckingFragment
}
}
workspaceSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
asrProvider
kinds
sentenceSeparator
displayedRows
mediaDisplayStrategy
tokenizer
firstRowAsHeader
transcriptMethod
ocrProvider
customScriptId
fileTransformerId
customTextExtractionAPIId
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
}
reviewingStatus {
isCompleted
statistic {
...ReviewingStatusStatisticFragment
}
}
labelingStatus {
labeler {
...TeamMemberFragment
}
isCompleted
isStarted
statistic {
...LabelingStatusStatisticFragment
}
statisticsToShow {
...StatisticItemFragment
}
}
status
performance {
project {
...ProjectFragment
}
projectId
totalTimeSpent
effectiveTotalTimeSpent
conflicts
totalLabelApplied
numberOfAcceptedLabels
numberOfDocuments
numberOfTokens
numberOfLines
}
selfLabelingStatus
purpose
rootCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
reviewCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
labelerCabinets {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
guideline {
id
name
content
project {
...ProjectFragment
}
}
isArchived
projectMetadataItems {
id
teamId
creatorId
key
value
createdAt
updatedAt
}
}
}
Variables
{"input": AssignProjectInput}
Response
{
"data": {
"replaceProjectAssignees": {
"id": "4",
"team": Team,
"teamId": "4",
"owner": User,
"externalObjectStorageId": "xyz789",
"rootDocumentId": 4,
"assignees": [ProjectAssignment],
"name": "xyz789",
"tags": [Tag],
"type": "abc123",
"createdDate": "abc123",
"completedDate": "abc123",
"exportedDate": "xyz789",
"updatedDate": "abc123",
"isOwnerMe": true,
"isReviewByMeAllowed": true,
"settings": ProjectSettings,
"workspaceSettings": WorkspaceSettings,
"reviewingStatus": ReviewingStatus,
"labelingStatus": [LabelingStatus],
"status": "CREATED",
"performance": ProjectPerformance,
"selfLabelingStatus": "NOT_STARTED",
"purpose": "LABELING",
"rootCabinet": Cabinet,
"reviewCabinet": Cabinet,
"labelerCabinets": [Cabinet],
"guideline": Guideline,
"isArchived": true,
"projectMetadataItems": [ProjectMetadataItem]
}
}
}
replaceProjectMetadata
Description
Replaces metadata in a project.
Response
Returns a Project!
Arguments
| Name | Description |
|---|---|
input - ProjectMetadataInput!
|
Example
Query
mutation ReplaceProjectMetadata($input: ProjectMetadataInput!) {
replaceProjectMetadata(input: $input) {
id
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
teamId
owner {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
createdAt
updatedAt
}
name
tags {
id
name
globalTag
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
autoMarkDocumentAsComplete
consensus
conflictResolution {
...ConflictResolutionFragment
}
dynamicReviewMethod
dynamicReviewMemberId
enableEditLabelSet
enableReviewerEditSentence
enableReviewerInsertSentence
enableReviewerDeleteSentence
enableEditSentence
enableInsertSentence
enableDeleteSentence
enableDirectBBoxEditing
enableEnforceAutoLabelReviewerSettings
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
shouldConfirmUnusedLabelSetItems
spotChecking {
...SpotCheckingFragment
}
}
workspaceSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
asrProvider
kinds
sentenceSeparator
displayedRows
mediaDisplayStrategy
tokenizer
firstRowAsHeader
transcriptMethod
ocrProvider
customScriptId
fileTransformerId
customTextExtractionAPIId
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
}
reviewingStatus {
isCompleted
statistic {
...ReviewingStatusStatisticFragment
}
}
labelingStatus {
labeler {
...TeamMemberFragment
}
isCompleted
isStarted
statistic {
...LabelingStatusStatisticFragment
}
statisticsToShow {
...StatisticItemFragment
}
}
status
performance {
project {
...ProjectFragment
}
projectId
totalTimeSpent
effectiveTotalTimeSpent
conflicts
totalLabelApplied
numberOfAcceptedLabels
numberOfDocuments
numberOfTokens
numberOfLines
}
selfLabelingStatus
purpose
rootCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
reviewCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
labelerCabinets {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
guideline {
id
name
content
project {
...ProjectFragment
}
}
isArchived
projectMetadataItems {
id
teamId
creatorId
key
value
createdAt
updatedAt
}
}
}
Variables
{"input": ProjectMetadataInput}
Response
{
"data": {
"replaceProjectMetadata": {
"id": 4,
"team": Team,
"teamId": 4,
"owner": User,
"externalObjectStorageId": "abc123",
"rootDocumentId": 4,
"assignees": [ProjectAssignment],
"name": "abc123",
"tags": [Tag],
"type": "abc123",
"createdDate": "xyz789",
"completedDate": "xyz789",
"exportedDate": "abc123",
"updatedDate": "abc123",
"isOwnerMe": true,
"isReviewByMeAllowed": true,
"settings": ProjectSettings,
"workspaceSettings": WorkspaceSettings,
"reviewingStatus": ReviewingStatus,
"labelingStatus": [LabelingStatus],
"status": "CREATED",
"performance": ProjectPerformance,
"selfLabelingStatus": "NOT_STARTED",
"purpose": "LABELING",
"rootCabinet": Cabinet,
"reviewCabinet": Cabinet,
"labelerCabinets": [Cabinet],
"guideline": Guideline,
"isArchived": false,
"projectMetadataItems": [ProjectMetadataItem]
}
}
}
replyComment
Example
Query
mutation ReplyComment(
$commentId: ID!,
$message: String!
) {
replyComment(
commentId: $commentId,
message: $message
) {
id
parentId
documentId
originDocumentId
userId
user {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
message
resolved
resolvedAt
resolvedBy {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
repliesCount
createdAt
updatedAt
lastEditedAt
hashCode
commentedContent {
hashCodeType
contexts {
...CommentedContentContextValueFragment
}
currentValue {
...CommentedContentCurrentValueFragment
}
}
}
}
Variables
{"commentId": 4, "message": "xyz789"}
Response
{
"data": {
"replyComment": {
"id": 4,
"parentId": 4,
"documentId": "4",
"originDocumentId": "4",
"userId": 123,
"user": User,
"message": "xyz789",
"resolved": true,
"resolvedAt": "xyz789",
"resolvedBy": User,
"repliesCount": 987,
"createdAt": "abc123",
"updatedAt": "xyz789",
"lastEditedAt": "abc123",
"hashCode": "abc123",
"commentedContent": CommentedContent
}
}
}
requestDemo
Response
Returns a RequestDemo!
Arguments
| Name | Description |
|---|---|
requestDemoInput - RequestDemoInput!
|
Example
Query
mutation RequestDemo($requestDemoInput: RequestDemoInput!) {
requestDemo(requestDemoInput: $requestDemoInput) {
email
givenName
surname
company
numberOfLabelers
name
gclid
fbclid
utmSource
desiredLabelingFeature
}
}
Variables
{"requestDemoInput": RequestDemoInput}
Response
{
"data": {
"requestDemo": {
"email": "abc123",
"givenName": "abc123",
"surname": "xyz789",
"company": "xyz789",
"numberOfLabelers": 987,
"name": "abc123",
"gclid": "xyz789",
"fbclid": "xyz789",
"utmSource": "abc123",
"desiredLabelingFeature": "xyz789"
}
}
}
requestResetPasswordByScript
Response
Returns a String
Arguments
| Name | Description |
|---|---|
input - RequestResetPasswordInput!
|
Example
Query
mutation RequestResetPasswordByScript($input: RequestResetPasswordInput!) {
requestResetPasswordByScript(input: $input)
}
Variables
{"input": RequestResetPasswordInput}
Response
{
"data": {
"requestResetPasswordByScript": "abc123"
}
}
requestResetPasswordLink
Response
Returns a String
Arguments
| Name | Description |
|---|---|
input - RequestResetPasswordInput!
|
|
datasaurApp - DatasaurApp
|
Example
Query
mutation RequestResetPasswordLink(
$input: RequestResetPasswordInput!,
$datasaurApp: DatasaurApp
) {
requestResetPasswordLink(
input: $input,
datasaurApp: $datasaurApp
)
}
Variables
{"input": RequestResetPasswordInput, "datasaurApp": "NLP"}
Response
{
"data": {
"requestResetPasswordLink": "abc123"
}
}
resetDefaultExtensions
Response
Returns [DefaultExtension!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
mutation ResetDefaultExtensions($teamId: ID!) {
resetDefaultExtensions(teamId: $teamId) {
kind
labelerExtensions {
extensionId
}
reviewerExtensions {
extensionId
}
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"resetDefaultExtensions": [
{
"kind": "DOCUMENT_BASED",
"labelerExtensions": [DefaultExtensionElement],
"reviewerExtensions": [DefaultExtensionElement]
}
]
}
}
resetLabelingWork
Breaking changes may be introduced anytime in the future without prior notice.
Description
Clears all label from a labelers' document. Will fail if called with a reviewer's document ID.
Response
Returns a ResetLabelingWorkResult!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
Example
Query
mutation ResetLabelingWork($documentId: ID!) {
resetLabelingWork(documentId: $documentId) {
job {
id
status
progress
errors {
...JobErrorFragment
}
resultId
result
createdAt
updatedAt
additionalData {
...JobAdditionalDataFragment
}
}
}
}
Variables
{"documentId": 4}
Response
{"data": {"resetLabelingWork": {"job": Job}}}
resetPassword
Response
Returns a LoginSuccess
Arguments
| Name | Description |
|---|---|
resetPasswordInput - ResetPasswordInput!
|
Example
Query
mutation ResetPassword($resetPasswordInput: ResetPasswordInput!) {
resetPassword(resetPasswordInput: $resetPasswordInput) {
user {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
redirect
}
}
Variables
{"resetPasswordInput": ResetPasswordInput}
Response
{
"data": {
"resetPassword": {
"user": User,
"redirect": "xyz789"
}
}
}
retryLlmVectorStoreAsync
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmVectorStoreLaunchJob!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation RetryLlmVectorStoreAsync($id: ID!) {
retryLlmVectorStoreAsync(id: $id) {
job {
id
status
progress
errors {
...JobErrorFragment
}
resultId
result
createdAt
updatedAt
additionalData {
...JobAdditionalDataFragment
}
}
name
}
}
Variables
{"id": "4"}
Response
{
"data": {
"retryLlmVectorStoreAsync": {
"job": Job,
"name": "abc123"
}
}
}
runAction
Description
Run a specific Action according to the following parameters: type: ActionType!: The type of the Action (e.g. project-creation), actionId: ID: The ID of the Action
Returns a Job object, which indicates the status of the automation process.
Response
Returns a Job!
Arguments
| Name | Description |
|---|---|
type - ActionType!
|
|
actionId - ID!
|
Example
Query
mutation RunAction(
$type: ActionType!,
$actionId: ID!
) {
runAction(
type: $type,
actionId: $actionId
) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
}
}
}
Variables
{"type": "CREATE_PROJECT", "actionId": 4}
Response
{
"data": {
"runAction": {
"id": "xyz789",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "abc123",
"additionalData": JobAdditionalData
}
}
}
runPlaygroundRagConfig
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplicationRagRunnerJob!
Example
Query
mutation RunPlaygroundRagConfig(
$llmApplicationId: ID!,
$promptIds: [ID!],
$ragConfigIds: [ID!]
) {
runPlaygroundRagConfig(
llmApplicationId: $llmApplicationId,
promptIds: $promptIds,
ragConfigIds: $ragConfigIds
) {
job {
id
status
progress
errors {
...JobErrorFragment
}
resultId
result
createdAt
updatedAt
additionalData {
...JobAdditionalDataFragment
}
}
name
}
}
Variables
{
"llmApplicationId": "4",
"promptIds": [4],
"ragConfigIds": [4]
}
Response
{
"data": {
"runPlaygroundRagConfig": {
"job": Job,
"name": "abc123"
}
}
}
saveGeneralWorkspaceSettings
Response
Returns a GeneralWorkspaceSettings!
Arguments
| Name | Description |
|---|---|
input - SaveGeneralWorkspaceSettingsInput!
|
Example
Query
mutation SaveGeneralWorkspaceSettings($input: SaveGeneralWorkspaceSettingsInput!) {
saveGeneralWorkspaceSettings(input: $input) {
id
editorFontType
editorFontSize
editorLineSpacing
editorLineSpacingRatio
showIndexBar
showLabels
keepLabelBoxOpenAfterRelabel
jumpToNextDocumentOnSubmit
jumpToNextDocumentOnDocumentCompleted
jumpToNextSpanOnSubmit
multipleSelectLabels
}
}
Variables
{"input": SaveGeneralWorkspaceSettingsInput}
Response
{
"data": {
"saveGeneralWorkspaceSettings": {
"id": 4,
"editorFontType": "SANS_SERIF",
"editorFontSize": "SMALL",
"editorLineSpacing": "DENSE",
"editorLineSpacingRatio": 123.45,
"showIndexBar": false,
"showLabels": "ALWAYS",
"keepLabelBoxOpenAfterRelabel": false,
"jumpToNextDocumentOnSubmit": true,
"jumpToNextDocumentOnDocumentCompleted": true,
"jumpToNextSpanOnSubmit": true,
"multipleSelectLabels": false
}
}
}
saveOCRContentPositionMaps
Response
Returns an OCRContentPositionMapsResult!
Arguments
| Name | Description |
|---|---|
input - SaveOCRContentPositionMapsInput!
|
Example
Query
mutation SaveOCRContentPositionMaps($input: SaveOCRContentPositionMapsInput!) {
saveOCRContentPositionMaps(input: $input) {
documentId
maps {
mediaToTranscript
transcriptToMedia
}
}
}
Variables
{"input": SaveOCRContentPositionMapsInput}
Response
{
"data": {
"saveOCRContentPositionMaps": {
"documentId": 4,
"maps": OCRContentPositionMaps
}
}
}
saveProjectWorkspaceSettings
Response
Returns a TextDocumentSettings!
Arguments
| Name | Description |
|---|---|
input - SaveProjectWorkspaceSettingsInput!
|
Example
Query
mutation SaveProjectWorkspaceSettings($input: SaveProjectWorkspaceSettingsInput!) {
saveProjectWorkspaceSettings(input: $input) {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
kinds
sentenceSeparator
tokenizer
editSentenceTokenizer
displayedRows
mediaDisplayStrategy
viewer
viewerConfig {
urlColumnNames
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
name
pattern
flags
}
fileTransformerId
}
}
Variables
{"input": SaveProjectWorkspaceSettingsInput}
Response
{
"data": {
"saveProjectWorkspaceSettings": {
"id": 4,
"textLabelMaxTokenLength": 123,
"allTokensMustBeLabeled": false,
"autoScrollWhenLabeling": false,
"allowArcDrawing": false,
"allowCharacterBasedLabeling": false,
"allowMultiLabels": true,
"kinds": ["DOCUMENT_BASED"],
"sentenceSeparator": "xyz789",
"tokenizer": "xyz789",
"editSentenceTokenizer": "abc123",
"displayedRows": 987,
"mediaDisplayStrategy": "NONE",
"viewer": "TOKEN",
"viewerConfig": TextDocumentViewerConfig,
"hideBoundingBoxIfNoSpanOrArrowLabel": true,
"enableTabularMarkdownParsing": false,
"enableAnonymization": true,
"anonymizationEntityTypes": [
"xyz789"
],
"anonymizationMaskingMethod": "abc123",
"anonymizationRegExps": [RegularExpression],
"fileTransformerId": "xyz789"
}
}
}
saveSearchKeyword
Response
Returns a SearchHistoryKeyword!
Arguments
| Name | Description |
|---|---|
keyword - String!
|
Example
Query
mutation SaveSearchKeyword($keyword: String!) {
saveSearchKeyword(keyword: $keyword) {
id
keyword
}
}
Variables
{"keyword": "xyz789"}
Response
{
"data": {
"saveSearchKeyword": {
"id": "4",
"keyword": "abc123"
}
}
}
scheduleDeleteProjects
Response
Returns [Project!]!
Arguments
| Name | Description |
|---|---|
projectIds - [String!]!
|
|
dueInDays - Int!
|
Example
Query
mutation ScheduleDeleteProjects(
$projectIds: [String!]!,
$dueInDays: Int!
) {
scheduleDeleteProjects(
projectIds: $projectIds,
dueInDays: $dueInDays
) {
id
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
teamId
owner {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
createdAt
updatedAt
}
name
tags {
id
name
globalTag
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
autoMarkDocumentAsComplete
consensus
conflictResolution {
...ConflictResolutionFragment
}
dynamicReviewMethod
dynamicReviewMemberId
enableEditLabelSet
enableReviewerEditSentence
enableReviewerInsertSentence
enableReviewerDeleteSentence
enableEditSentence
enableInsertSentence
enableDeleteSentence
enableDirectBBoxEditing
enableEnforceAutoLabelReviewerSettings
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
shouldConfirmUnusedLabelSetItems
spotChecking {
...SpotCheckingFragment
}
}
workspaceSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
asrProvider
kinds
sentenceSeparator
displayedRows
mediaDisplayStrategy
tokenizer
firstRowAsHeader
transcriptMethod
ocrProvider
customScriptId
fileTransformerId
customTextExtractionAPIId
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
}
reviewingStatus {
isCompleted
statistic {
...ReviewingStatusStatisticFragment
}
}
labelingStatus {
labeler {
...TeamMemberFragment
}
isCompleted
isStarted
statistic {
...LabelingStatusStatisticFragment
}
statisticsToShow {
...StatisticItemFragment
}
}
status
performance {
project {
...ProjectFragment
}
projectId
totalTimeSpent
effectiveTotalTimeSpent
conflicts
totalLabelApplied
numberOfAcceptedLabels
numberOfDocuments
numberOfTokens
numberOfLines
}
selfLabelingStatus
purpose
rootCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
reviewCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
labelerCabinets {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
guideline {
id
name
content
project {
...ProjectFragment
}
}
isArchived
projectMetadataItems {
id
teamId
creatorId
key
value
createdAt
updatedAt
}
}
}
Variables
{"projectIds": ["xyz789"], "dueInDays": 123}
Response
{
"data": {
"scheduleDeleteProjects": [
{
"id": 4,
"team": Team,
"teamId": "4",
"owner": User,
"externalObjectStorageId": "abc123",
"rootDocumentId": "4",
"assignees": [ProjectAssignment],
"name": "abc123",
"tags": [Tag],
"type": "xyz789",
"createdDate": "abc123",
"completedDate": "abc123",
"exportedDate": "abc123",
"updatedDate": "xyz789",
"isOwnerMe": false,
"isReviewByMeAllowed": true,
"settings": ProjectSettings,
"workspaceSettings": WorkspaceSettings,
"reviewingStatus": ReviewingStatus,
"labelingStatus": [LabelingStatus],
"status": "CREATED",
"performance": ProjectPerformance,
"selfLabelingStatus": "NOT_STARTED",
"purpose": "LABELING",
"rootCabinet": Cabinet,
"reviewCabinet": Cabinet,
"labelerCabinets": [Cabinet],
"guideline": Guideline,
"isArchived": true,
"projectMetadataItems": [ProjectMetadataItem]
}
]
}
}
selfAssign
Response
Returns a ProjectAssignment!
Example
Query
mutation SelfAssign(
$projectId: ID!,
$documentAmount: Int
) {
selfAssign(
projectId: $projectId,
documentAmount: $documentAmount
) {
teamMember {
id
user {
...UserFragment
}
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
}
documentIds
documents {
id
chunks {
...TextChunkFragment
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
...TextDocumentSettingsFragment
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
...TextSentenceFragment
}
settings {
...SettingsFragment
}
statistic {
...TextDocumentStatisticFragment
}
type
updatedChunks {
...TextChunkFragment
}
updatedTokenLabels {
...TextLabelFragment
}
url
version
workspaceState {
...WorkspaceStateFragment
}
originId
signature
part
}
role
createdAt
updatedAt
}
}
Variables
{"projectId": "4", "documentAmount": 123}
Response
{
"data": {
"selfAssign": {
"teamMember": TeamMember,
"documentIds": ["abc123"],
"documents": [TextDocument],
"role": "LABELER",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
setCabinetStatus
Description
Set a project cabinet to COMPLETE or IN_PROGRESS. If done with the role=REVIEWER, it will also impact LABELERs' cabinet.
Response
Returns a Cabinet!
Arguments
| Name | Description |
|---|---|
cabinetMatcher - CabinetMatcherInput!
|
|
targetStatus - CabinetStatus!
|
|
skipValidation - Boolean
|
Example
Query
mutation SetCabinetStatus(
$cabinetMatcher: CabinetMatcherInput!,
$targetStatus: CabinetStatus!,
$skipValidation: Boolean
) {
setCabinetStatus(
cabinetMatcher: $cabinetMatcher,
targetStatus: $targetStatus,
skipValidation: $skipValidation
) {
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
{
"cabinetMatcher": CabinetMatcherInput,
"targetStatus": "IN_PROGRESS",
"skipValidation": false
}
Response
{
"data": {
"setCabinetStatus": {
"id": 4,
"documents": [TextDocumentScalar],
"role": "REVIEWER",
"status": "IN_PROGRESS",
"lastOpenedDocumentId": 4,
"statistic": CabinetStatistic,
"owner": User,
"createdAt": "2007-12-03T10:15:30Z"
}
}
}
setCommentResolved
Example
Query
mutation SetCommentResolved(
$commentId: ID!,
$resolved: Boolean!
) {
setCommentResolved(
commentId: $commentId,
resolved: $resolved
) {
id
parentId
documentId
originDocumentId
userId
user {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
message
resolved
resolvedAt
resolvedBy {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
repliesCount
createdAt
updatedAt
lastEditedAt
hashCode
commentedContent {
hashCodeType
contexts {
...CommentedContentContextValueFragment
}
currentValue {
...CommentedContentCurrentValueFragment
}
}
}
}
Variables
{"commentId": 4, "resolved": true}
Response
{
"data": {
"setCommentResolved": {
"id": "4",
"parentId": "4",
"documentId": 4,
"originDocumentId": "4",
"userId": 987,
"user": User,
"message": "xyz789",
"resolved": false,
"resolvedAt": "abc123",
"resolvedBy": User,
"repliesCount": 123,
"createdAt": "abc123",
"updatedAt": "xyz789",
"lastEditedAt": "xyz789",
"hashCode": "xyz789",
"commentedContent": CommentedContent
}
}
}
signUp
Response
Returns a LoginSuccess
Arguments
| Name | Description |
|---|---|
createUserInput - CreateUserInput!
|
|
datasaurApp - DatasaurApp
|
Example
Query
mutation SignUp(
$createUserInput: CreateUserInput!,
$datasaurApp: DatasaurApp
) {
signUp(
createUserInput: $createUserInput,
datasaurApp: $datasaurApp
) {
user {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
redirect
}
}
Variables
{"createUserInput": CreateUserInput, "datasaurApp": "NLP"}
Response
{
"data": {
"signUp": {
"user": User,
"redirect": "abc123"
}
}
}
skipTeamOnboarding
Response
Returns a TeamOnboarding!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
mutation SkipTeamOnboarding($teamId: ID!) {
skipTeamOnboarding(teamId: $teamId) {
id
teamId
state
version
tasks {
id
name
reward
completedAt
}
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"skipTeamOnboarding": {
"id": 4,
"teamId": "4",
"state": "NOT_OPENED",
"version": 987,
"tasks": [TeamOnboardingTask]
}
}
}
startDatasaurDinamicRowBasedTrainingJob
Response
Returns a Job!
Arguments
| Name | Description |
|---|---|
input - StartDatasaurDinamicRowBasedTrainingJobInput!
|
Example
Query
mutation StartDatasaurDinamicRowBasedTrainingJob($input: StartDatasaurDinamicRowBasedTrainingJobInput!) {
startDatasaurDinamicRowBasedTrainingJob(input: $input) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
}
}
}
Variables
{"input": StartDatasaurDinamicRowBasedTrainingJobInput}
Response
{
"data": {
"startDatasaurDinamicRowBasedTrainingJob": {
"id": "xyz789",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "abc123",
"additionalData": JobAdditionalData
}
}
}
startDatasaurDinamicTokenBasedTrainingJob
Response
Returns a Job!
Arguments
| Name | Description |
|---|---|
input - StartDatasaurDinamicTokenBasedTrainingJobInput!
|
Example
Query
mutation StartDatasaurDinamicTokenBasedTrainingJob($input: StartDatasaurDinamicTokenBasedTrainingJobInput!) {
startDatasaurDinamicTokenBasedTrainingJob(input: $input) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
}
}
}
Variables
{"input": StartDatasaurDinamicTokenBasedTrainingJobInput}
Response
{
"data": {
"startDatasaurDinamicTokenBasedTrainingJob": {
"id": "abc123",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "abc123",
"additionalData": JobAdditionalData
}
}
}
startDatasaurPredictiveTrainingJob
Response
Returns a Job!
Arguments
| Name | Description |
|---|---|
input - StartDatasaurPredictiveTrainingJobInput!
|
Example
Query
mutation StartDatasaurPredictiveTrainingJob($input: StartDatasaurPredictiveTrainingJobInput!) {
startDatasaurPredictiveTrainingJob(input: $input) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
}
}
}
Variables
{"input": StartDatasaurPredictiveTrainingJobInput}
Response
{
"data": {
"startDatasaurPredictiveTrainingJob": {
"id": "abc123",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "abc123",
"additionalData": JobAdditionalData
}
}
}
startExtensionTrial
Response
Returns a TeamSetting!
Arguments
| Name | Description |
|---|---|
input - StartExtensionTrialInput!
|
Example
Query
mutation StartExtensionTrial($input: StartExtensionTrialInput!) {
startExtensionTrial(input: $input) {
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedASRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enableActions
enableAddDocumentsToProject
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurDinamicTokenBased
enableDatasaurPredictiveRowBased
enableWipeData
enableExportTeamOverview
enableTransferOwnership
enableLabelErrorDetectionRowBased
allowedExtraAutoLabelProviders
enableLLMProject
enableRegexSentenceSeparator
enableTeamRoleSupervisor
endExtensionTrialAt
allowInvalidPaymentMethod
enableExternalKnowledgeBase
enableForceAnonymization
}
}
Variables
{"input": StartExtensionTrialInput}
Response
{
"data": {
"startExtensionTrial": {
"allowedAdminExportMethods": ["FILE_STORAGE"],
"allowedLabelerExportMethods": ["FILE_STORAGE"],
"allowedOCRProviders": ["APACHE_TIKA"],
"allowedASRProviders": ["OPENAI_WHISPER"],
"allowedReviewerExportMethods": ["FILE_STORAGE"],
"commentNotificationType": "OFF",
"customAPICreationLimit": 987,
"defaultCustomTextExtractionAPIId": "4",
"defaultExternalObjectStorageId": "4",
"enableActions": false,
"enableAddDocumentsToProject": false,
"enableDemo": true,
"enableDataProgramming": false,
"enableLabelingFunctionMultipleLabel": true,
"enableDatasaurAssistRowBased": true,
"enableDatasaurDinamicTokenBased": true,
"enableDatasaurPredictiveRowBased": false,
"enableWipeData": false,
"enableExportTeamOverview": false,
"enableTransferOwnership": false,
"enableLabelErrorDetectionRowBased": true,
"allowedExtraAutoLabelProviders": ["CUSTOM"],
"enableLLMProject": false,
"enableRegexSentenceSeparator": true,
"enableTeamRoleSupervisor": false,
"endExtensionTrialAt": "2007-12-03T10:15:30Z",
"allowInvalidPaymentMethod": true,
"enableExternalKnowledgeBase": true,
"enableForceAnonymization": false
}
}
}
startFineTuningJob
Breaking changes may be introduced anytime in the future without prior notice.
Description
Creates a new fine tuned Model.
Response
Returns a LlmModel!
Arguments
| Name | Description |
|---|---|
input - LlmModelFineTuningInput!
|
Example
Query
mutation StartFineTuningJob($input: LlmModelFineTuningInput!) {
startFineTuningJob(input: $input) {
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
createdAt
updatedAt
}
}
Variables
{"input": LlmModelFineTuningInput}
Response
{
"data": {
"startFineTuningJob": {
"id": "4",
"detail": LlmModelDetail,
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "abc123",
"displayName": "xyz789",
"url": "abc123",
"maxTemperature": 987.65,
"maxTopP": 987.65,
"maxTokens": 987,
"maxContextWindow": 123,
"defaultTemperature": 123.45,
"defaultTopP": 987.65,
"defaultMaxTokens": 123,
"llmModelFineTuningJob": LlmModelFineTuningJob,
"deployableModelId": "xyz789",
"isModelDeployable": false,
"forceAnonymization": false,
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
startLabelErrorDetectionRowBasedJob
Response
Returns a Job!
Arguments
| Name | Description |
|---|---|
input - StartLabelErrorDetectionRowBasedJobInput!
|
Example
Query
mutation StartLabelErrorDetectionRowBasedJob($input: StartLabelErrorDetectionRowBasedJobInput!) {
startLabelErrorDetectionRowBasedJob(input: $input) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
}
}
}
Variables
{"input": StartLabelErrorDetectionRowBasedJobInput}
Response
{
"data": {
"startLabelErrorDetectionRowBasedJob": {
"id": "xyz789",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "xyz789",
"additionalData": JobAdditionalData
}
}
}
startTeamOnboarding
Response
Returns a TeamOnboarding!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
mutation StartTeamOnboarding($teamId: ID!) {
startTeamOnboarding(teamId: $teamId) {
id
teamId
state
version
tasks {
id
name
reward
completedAt
}
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"startTeamOnboarding": {
"id": "4",
"teamId": "4",
"state": "NOT_OPENED",
"version": 987,
"tasks": [TeamOnboardingTask]
}
}
}
stopFineTuningJob
Breaking changes may be introduced anytime in the future without prior notice.
Description
Stops a fine tuning model training job.
Example
Query
mutation StopFineTuningJob($llmModelId: ID!) {
stopFineTuningJob(llmModelId: $llmModelId) {
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
createdAt
updatedAt
}
}
Variables
{"llmModelId": "4"}
Response
{
"data": {
"stopFineTuningJob": {
"id": 4,
"detail": LlmModelDetail,
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "xyz789",
"displayName": "abc123",
"url": "abc123",
"maxTemperature": 123.45,
"maxTopP": 987.65,
"maxTokens": 123,
"maxContextWindow": 123,
"defaultTemperature": 123.45,
"defaultTopP": 123.45,
"defaultMaxTokens": 987,
"llmModelFineTuningJob": LlmModelFineTuningJob,
"deployableModelId": "abc123",
"isModelDeployable": false,
"forceAnonymization": false,
"createdAt": "abc123",
"updatedAt": "xyz789"
}
}
}
submitEmail
Response
Returns a WelcomeEmail!
Arguments
| Name | Description |
|---|---|
welcomeEmailInput - WelcomeEmailInput!
|
Example
Query
mutation SubmitEmail($welcomeEmailInput: WelcomeEmailInput!) {
submitEmail(welcomeEmailInput: $welcomeEmailInput) {
email
}
}
Variables
{"welcomeEmailInput": WelcomeEmailInput}
Response
{
"data": {
"submitEmail": {"email": "xyz789"}
}
}
submitTrialSurvey
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - TrialSurveyInput!
|
Example
Query
mutation SubmitTrialSurvey($input: TrialSurveyInput!) {
submitTrialSurvey(input: $input)
}
Variables
{"input": TrialSurveyInput}
Response
{"data": {"submitTrialSurvey": true}}
syncLlmEmbeddingModels
Breaking changes may be introduced anytime in the future without prior notice.
syncLlmModels
Breaking changes may be introduced anytime in the future without prior notice.
toggleArchiveProjects
Response
Returns [Project!]!
Arguments
| Name | Description |
|---|---|
projectIds - [String!]!
|
Example
Query
mutation ToggleArchiveProjects($projectIds: [String!]!) {
toggleArchiveProjects(projectIds: $projectIds) {
id
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
teamId
owner {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
createdAt
updatedAt
}
name
tags {
id
name
globalTag
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
autoMarkDocumentAsComplete
consensus
conflictResolution {
...ConflictResolutionFragment
}
dynamicReviewMethod
dynamicReviewMemberId
enableEditLabelSet
enableReviewerEditSentence
enableReviewerInsertSentence
enableReviewerDeleteSentence
enableEditSentence
enableInsertSentence
enableDeleteSentence
enableDirectBBoxEditing
enableEnforceAutoLabelReviewerSettings
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
shouldConfirmUnusedLabelSetItems
spotChecking {
...SpotCheckingFragment
}
}
workspaceSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
asrProvider
kinds
sentenceSeparator
displayedRows
mediaDisplayStrategy
tokenizer
firstRowAsHeader
transcriptMethod
ocrProvider
customScriptId
fileTransformerId
customTextExtractionAPIId
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
}
reviewingStatus {
isCompleted
statistic {
...ReviewingStatusStatisticFragment
}
}
labelingStatus {
labeler {
...TeamMemberFragment
}
isCompleted
isStarted
statistic {
...LabelingStatusStatisticFragment
}
statisticsToShow {
...StatisticItemFragment
}
}
status
performance {
project {
...ProjectFragment
}
projectId
totalTimeSpent
effectiveTotalTimeSpent
conflicts
totalLabelApplied
numberOfAcceptedLabels
numberOfDocuments
numberOfTokens
numberOfLines
}
selfLabelingStatus
purpose
rootCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
reviewCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
labelerCabinets {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
guideline {
id
name
content
project {
...ProjectFragment
}
}
isArchived
projectMetadataItems {
id
teamId
creatorId
key
value
createdAt
updatedAt
}
}
}
Variables
{"projectIds": ["xyz789"]}
Response
{
"data": {
"toggleArchiveProjects": [
{
"id": 4,
"team": Team,
"teamId": 4,
"owner": User,
"externalObjectStorageId": "abc123",
"rootDocumentId": "4",
"assignees": [ProjectAssignment],
"name": "abc123",
"tags": [Tag],
"type": "abc123",
"createdDate": "abc123",
"completedDate": "abc123",
"exportedDate": "abc123",
"updatedDate": "abc123",
"isOwnerMe": true,
"isReviewByMeAllowed": false,
"settings": ProjectSettings,
"workspaceSettings": WorkspaceSettings,
"reviewingStatus": ReviewingStatus,
"labelingStatus": [LabelingStatus],
"status": "CREATED",
"performance": ProjectPerformance,
"selfLabelingStatus": "NOT_STARTED",
"purpose": "LABELING",
"rootCabinet": Cabinet,
"reviewCabinet": Cabinet,
"labelerCabinets": [Cabinet],
"guideline": Guideline,
"isArchived": false,
"projectMetadataItems": [ProjectMetadataItem]
}
]
}
}
toggleCabinetStatus
Please use setCabinetStatus instead.
Description
Deprecated. Please use setCabinetStatusinstead.
Response
Returns a Cabinet!
Example
Query
mutation ToggleCabinetStatus(
$projectId: ID!,
$role: Role!,
$skipValidation: Boolean
) {
toggleCabinetStatus(
projectId: $projectId,
role: $role,
skipValidation: $skipValidation
) {
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",
"skipValidation": false
}
Response
{
"data": {
"toggleCabinetStatus": {
"id": "4",
"documents": [TextDocumentScalar],
"role": "REVIEWER",
"status": "IN_PROGRESS",
"lastOpenedDocumentId": 4,
"statistic": CabinetStatistic,
"owner": User,
"createdAt": "2007-12-03T10:15:30Z"
}
}
}
toggleDocumentStatus
Please use markDocumentAsComplete and markDocumentAsInProgress instead.
Description
Deprecated. Please use markDocumentAsComplete and markDocumentAsInProgress instead.
Response
Returns a TextDocument!
Example
Query
mutation ToggleDocumentStatus(
$documentId: ID!,
$skipValidation: Boolean
) {
toggleDocumentStatus(
documentId: $documentId,
skipValidation: $skipValidation
) {
id
chunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
kinds
sentenceSeparator
tokenizer
editSentenceTokenizer
displayedRows
mediaDisplayStrategy
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
fileTransformerId
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
id
documentId
userId
status
content
tokens
posLabels {
...TextLabelFragment
}
nerLabels {
...TextLabelFragment
}
docLabels {
...DocLabelObjectFragment
}
docLabelsString
conflicts {
...ConflictTextLabelFragment
}
conflictAnswers {
...ConflictAnswerFragment
}
answers {
...AnswerFragment
}
sentenceConflict {
...SentenceConflictFragment
}
conflictAnswerResolved
metadata {
...CellMetadataFragment
}
}
settings {
textLang
}
statistic {
documentId
numberOfChunks
numberOfSentences
numberOfTokens
effectiveTimeSpent
touchedSentences
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
}
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
}
url
version
workspaceState {
id
chunkId
sentenceStart
sentenceEnd
touchedChunks
touchedSentences
}
originId
signature
part
}
}
Variables
{"documentId": 4, "skipValidation": true}
Response
{
"data": {
"toggleDocumentStatus": {
"id": 4,
"chunks": [TextChunk],
"createdAt": "xyz789",
"currentSentenceCursor": 123,
"lastLabeledLine": 987,
"documentSettings": TextDocumentSettings,
"fileName": "xyz789",
"isCompleted": false,
"lastSavedAt": "abc123",
"mimeType": "abc123",
"name": "xyz789",
"projectId": "4",
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "xyz789",
"version": 123,
"workspaceState": WorkspaceState,
"originId": "4",
"signature": "xyz789",
"part": 987
}
}
}
trackMeetWithSales
Response
Returns a Boolean
Example
Query
mutation TrackMeetWithSales(
$userEmail: String!,
$fieldId: String!,
$value: String!
) {
trackMeetWithSales(
userEmail: $userEmail,
fieldId: $fieldId,
value: $value
)
}
Variables
{
"userEmail": "xyz789",
"fieldId": "abc123",
"value": "abc123"
}
Response
{"data": {"trackMeetWithSales": true}}
triggerTaskCompleted
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
input - TaskCompletedInput!
|
Example
Query
mutation TriggerTaskCompleted($input: TaskCompletedInput!) {
triggerTaskCompleted(input: $input)
}
Variables
{"input": TaskCompletedInput}
Response
{"data": {"triggerTaskCompleted": false}}
undeployLlmEmbeddingModel
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmEmbeddingModel!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation UndeployLlmEmbeddingModel($id: ID!) {
undeployLlmEmbeddingModel(id: $id) {
id
detail {
status
instanceType
instanceTypeDetail {
...LlmInstanceTypeDetailFragment
}
}
teamId
provider
name
displayName
url
maxTokens
dimensions
deployableModelId
isModelDeployable
createdAt
updatedAt
customDimension
}
}
Variables
{"id": 4}
Response
{
"data": {
"undeployLlmEmbeddingModel": {
"id": 4,
"detail": LlmModelDetail,
"teamId": 4,
"provider": "AMAZON_BEDROCK",
"name": "abc123",
"displayName": "xyz789",
"url": "xyz789",
"maxTokens": 123,
"dimensions": 987,
"deployableModelId": "xyz789",
"isModelDeployable": false,
"createdAt": "abc123",
"updatedAt": "abc123",
"customDimension": true
}
}
}
undeployLlmModel
Breaking changes may be introduced anytime in the future without prior notice.
Example
Query
mutation UndeployLlmModel($id: ID!) {
undeployLlmModel(id: $id) {
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
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"undeployLlmModel": {
"id": "4",
"detail": LlmModelDetail,
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "xyz789",
"displayName": "xyz789",
"url": "abc123",
"maxTemperature": 987.65,
"maxTopP": 123.45,
"maxTokens": 123,
"maxContextWindow": 987,
"defaultTemperature": 123.45,
"defaultTopP": 987.65,
"defaultMaxTokens": 987,
"llmModelFineTuningJob": LlmModelFineTuningJob,
"deployableModelId": "abc123",
"isModelDeployable": false,
"forceAnonymization": true,
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
unmarkUnusedLabelClass
Description
Unmark a label class as N/A
Response
Returns an UnusedLabelClass!
Arguments
| Name | Description |
|---|---|
input - MarkUnusedLabelClassInput!
|
Example
Query
mutation UnmarkUnusedLabelClass($input: MarkUnusedLabelClassInput!) {
unmarkUnusedLabelClass(input: $input) {
documentId
labelSetId
labelClassId
isMarked
}
}
Variables
{"input": MarkUnusedLabelClassInput}
Response
{
"data": {
"unmarkUnusedLabelClass": {
"documentId": "4",
"labelSetId": 4,
"labelClassId": "xyz789",
"isMarked": false
}
}
}
updateCabinetDocumentMeta
Response
Returns [DocumentMeta!]!
Arguments
| Name | Description |
|---|---|
cabinetId - ID!
|
|
input - [DocumentMetaInput!]!
|
Example
Query
mutation UpdateCabinetDocumentMeta(
$cabinetId: ID!,
$input: [DocumentMetaInput!]!
) {
updateCabinetDocumentMeta(
cabinetId: $cabinetId,
input: $input
) {
id
cabinetId
name
width
displayed
labelerRestricted
rowQuestionIndex
}
}
Variables
{
"cabinetId": "4",
"input": [DocumentMetaInput]
}
Response
{
"data": {
"updateCabinetDocumentMeta": [
{
"id": 987,
"cabinetId": 987,
"name": "xyz789",
"width": "xyz789",
"displayed": false,
"labelerRestricted": true,
"rowQuestionIndex": 123
}
]
}
}
updateConflicts
Response
Returns an UpdateConflictsResult!
Arguments
| Name | Description |
|---|---|
textDocumentId - ID!
|
|
input - [UpdateConflictsInput!]!
|
Example
Query
mutation UpdateConflicts(
$textDocumentId: ID!,
$input: [UpdateConflictsInput!]!
) {
updateConflicts(
textDocumentId: $textDocumentId,
input: $input
) {
document {
id
chunks {
...TextChunkFragment
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
...TextDocumentSettingsFragment
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
...TextSentenceFragment
}
settings {
...SettingsFragment
}
statistic {
...TextDocumentStatisticFragment
}
type
updatedChunks {
...TextChunkFragment
}
updatedTokenLabels {
...TextLabelFragment
}
url
version
workspaceState {
...WorkspaceStateFragment
}
originId
signature
part
}
previousSentences {
id
documentId
userId
status
content
tokens
posLabels {
...TextLabelFragment
}
nerLabels {
...TextLabelFragment
}
docLabels {
...DocLabelObjectFragment
}
docLabelsString
conflicts {
...ConflictTextLabelFragment
}
conflictAnswers {
...ConflictAnswerFragment
}
answers {
...AnswerFragment
}
sentenceConflict {
...SentenceConflictFragment
}
conflictAnswerResolved
metadata {
...CellMetadataFragment
}
}
updatedSentences {
id
documentId
userId
status
content
tokens
posLabels {
...TextLabelFragment
}
nerLabels {
...TextLabelFragment
}
docLabels {
...DocLabelObjectFragment
}
docLabelsString
conflicts {
...ConflictTextLabelFragment
}
conflictAnswers {
...ConflictAnswerFragment
}
answers {
...AnswerFragment
}
sentenceConflict {
...SentenceConflictFragment
}
conflictAnswerResolved
metadata {
...CellMetadataFragment
}
}
}
}
Variables
{
"textDocumentId": "4",
"input": [UpdateConflictsInput]
}
Response
{
"data": {
"updateConflicts": {
"document": TextDocument,
"previousSentences": [TextSentence],
"updatedSentences": [TextSentence]
}
}
}
updateContactFieldByFieldId
Example
Query
mutation UpdateContactFieldByFieldId(
$fieldId: String!,
$value: String!
) {
updateContactFieldByFieldId(
fieldId: $fieldId,
value: $value
)
}
Variables
{
"fieldId": "xyz789",
"value": "xyz789"
}
Response
{"data": {"updateContactFieldByFieldId": false}}
updateCreateProjectAction
Response
Returns a CreateProjectAction
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
|
actionId - ID!
|
|
input - UpdateCreateProjectActionInput!
|
Example
Query
mutation UpdateCreateProjectAction(
$teamId: ID!,
$actionId: ID!,
$input: UpdateCreateProjectActionInput!
) {
updateCreateProjectAction(
teamId: $teamId,
actionId: $actionId,
input: $input
) {
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,
"input": UpdateCreateProjectActionInput
}
Response
{
"data": {
"updateCreateProjectAction": {
"id": "4",
"name": "abc123",
"teamId": "4",
"appVersion": "xyz789",
"creatorId": "4",
"lastRunAt": "abc123",
"lastFinishedAt": "xyz789",
"externalObjectStorageId": "4",
"externalObjectStorage": ExternalObjectStorage,
"externalObjectStoragePathInput": "xyz789",
"externalObjectStoragePathResult": "xyz789",
"projectTemplateId": "4",
"projectTemplate": ProjectTemplate,
"assignments": [CreateProjectActionAssignment],
"additionalTagNames": ["abc123"],
"numberOfLabelersPerProject": 987,
"numberOfReviewersPerProject": 987,
"numberOfLabelersPerDocument": 123,
"conflictResolutionMode": "MANUAL",
"consensus": 987,
"warnings": ["ASSIGNED_LABELER_NOT_MEET_CONSENSUS"]
}
}
}
updateCustomAPI
Response
Returns a CustomAPI!
Arguments
| Name | Description |
|---|---|
customAPIId - ID!
|
|
input - UpdateCustomAPIInput!
|
Example
Query
mutation UpdateCustomAPI(
$customAPIId: ID!,
$input: UpdateCustomAPIInput!
) {
updateCustomAPI(
customAPIId: $customAPIId,
input: $input
) {
id
teamId
endpointURL
name
purpose
}
}
Variables
{
"customAPIId": "4",
"input": UpdateCustomAPIInput
}
Response
{
"data": {
"updateCustomAPI": {
"id": 4,
"teamId": "4",
"endpointURL": "abc123",
"name": "abc123",
"purpose": "ASR_API"
}
}
}
updateDatasaurDinamicRowBased
Response
Returns a DatasaurDinamicRowBased!
Arguments
| Name | Description |
|---|---|
input - UpdateDatasaurDinamicRowBasedInput
|
Example
Query
mutation UpdateDatasaurDinamicRowBased($input: UpdateDatasaurDinamicRowBasedInput) {
updateDatasaurDinamicRowBased(input: $input) {
id
projectId
provider
inputColumnIds
questionColumnId
providerSetting
modelMetadata
trainingJobId
createdAt
updatedAt
}
}
Variables
{"input": UpdateDatasaurDinamicRowBasedInput}
Response
{
"data": {
"updateDatasaurDinamicRowBased": {
"id": "4",
"projectId": 4,
"provider": "HUGGINGFACE",
"inputColumnIds": [987],
"questionColumnId": 987,
"providerSetting": ProviderSetting,
"modelMetadata": ModelMetadata,
"trainingJobId": 4,
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
updateDatasaurDinamicTokenBased
Response
Returns a DatasaurDinamicTokenBased!
Arguments
| Name | Description |
|---|---|
input - UpdateDatasaurDinamicTokenBasedInput
|
Example
Query
mutation UpdateDatasaurDinamicTokenBased($input: UpdateDatasaurDinamicTokenBasedInput) {
updateDatasaurDinamicTokenBased(input: $input) {
id
projectId
provider
targetLabelSetIndex
providerSetting
modelMetadata
trainingJobId
createdAt
updatedAt
}
}
Variables
{"input": UpdateDatasaurDinamicTokenBasedInput}
Response
{
"data": {
"updateDatasaurDinamicTokenBased": {
"id": "4",
"projectId": "4",
"provider": "HUGGINGFACE",
"targetLabelSetIndex": 123,
"providerSetting": ProviderSetting,
"modelMetadata": ModelMetadata,
"trainingJobId": 4,
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
updateDatasaurPredictive
Response
Returns a DatasaurPredictive!
Arguments
| Name | Description |
|---|---|
input - UpdateDatasaurPredictiveInput
|
Example
Query
mutation UpdateDatasaurPredictive($input: UpdateDatasaurPredictiveInput) {
updateDatasaurPredictive(input: $input) {
id
projectId
provider
inputColumnIds
questionColumnId
providerSetting
modelMetadata
trainingJobId
createdAt
updatedAt
}
}
Variables
{"input": UpdateDatasaurPredictiveInput}
Response
{
"data": {
"updateDatasaurPredictive": {
"id": "4",
"projectId": "4",
"provider": "SETFIT",
"inputColumnIds": [123],
"questionColumnId": 123,
"providerSetting": ProviderSetting,
"modelMetadata": ModelMetadata,
"trainingJobId": "4",
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
updateDefaultExtensions
Description
This mutation performs a partial update (patch) You may submit updates for specific kinds only, but the response will return all defaultExtensions for each kind.
Response
Returns [DefaultExtension!]!
Arguments
| Name | Description |
|---|---|
input - UpdateDefaultExtensionInput!
|
Example
Query
mutation UpdateDefaultExtensions($input: UpdateDefaultExtensionInput!) {
updateDefaultExtensions(input: $input) {
kind
labelerExtensions {
extensionId
}
reviewerExtensions {
extensionId
}
}
}
Variables
{"input": UpdateDefaultExtensionInput}
Response
{
"data": {
"updateDefaultExtensions": [
{
"kind": "DOCUMENT_BASED",
"labelerExtensions": [DefaultExtensionElement],
"reviewerExtensions": [DefaultExtensionElement]
}
]
}
}
updateDocumentAnswers
Response
Returns an UpdateDocumentAnswersResult!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
answers - AnswerScalar!
|
|
metadata - [AnswerMetadataInput!]
|
|
questionSetSignature - String
|
Example
Query
mutation UpdateDocumentAnswers(
$documentId: ID!,
$answers: AnswerScalar!,
$metadata: [AnswerMetadataInput!],
$questionSetSignature: String
) {
updateDocumentAnswers(
documentId: $documentId,
answers: $answers,
metadata: $metadata,
questionSetSignature: $questionSetSignature
) {
previousAnswers {
documentId
answers
metadata {
...AnswerMetadataFragment
}
updatedAt
}
}
}
Variables
{
"documentId": "4",
"answers": AnswerScalar,
"metadata": [AnswerMetadataInput],
"questionSetSignature": "abc123"
}
Response
{
"data": {
"updateDocumentAnswers": {
"previousAnswers": DocumentAnswer
}
}
}
updateDocumentMeta
Response
Returns [DocumentMeta!]!
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
|
input - [DocumentMetaInput!]!
|
Example
Query
mutation UpdateDocumentMeta(
$projectId: ID!,
$input: [DocumentMetaInput!]!
) {
updateDocumentMeta(
projectId: $projectId,
input: $input
) {
id
cabinetId
name
width
displayed
labelerRestricted
rowQuestionIndex
}
}
Variables
{"projectId": 4, "input": [DocumentMetaInput]}
Response
{
"data": {
"updateDocumentMeta": [
{
"id": 123,
"cabinetId": 123,
"name": "xyz789",
"width": "xyz789",
"displayed": true,
"labelerRestricted": false,
"rowQuestionIndex": 987
}
]
}
}
updateDocumentMetaDisplayed
Response
Returns a DocumentMeta!
Example
Query
mutation UpdateDocumentMetaDisplayed(
$cabinetId: ID!,
$metaId: Int!,
$displayed: Boolean!
) {
updateDocumentMetaDisplayed(
cabinetId: $cabinetId,
metaId: $metaId,
displayed: $displayed
) {
id
cabinetId
name
width
displayed
labelerRestricted
rowQuestionIndex
}
}
Variables
{"cabinetId": 4, "metaId": 987, "displayed": true}
Response
{
"data": {
"updateDocumentMetaDisplayed": {
"id": 987,
"cabinetId": 987,
"name": "xyz789",
"width": "xyz789",
"displayed": true,
"labelerRestricted": true,
"rowQuestionIndex": 123
}
}
}
updateDocumentMetaLabelerRestricted
Response
Returns a DocumentMeta!
Example
Query
mutation UpdateDocumentMetaLabelerRestricted(
$projectId: ID!,
$metaId: Int!,
$labelerRestricted: Boolean!
) {
updateDocumentMetaLabelerRestricted(
projectId: $projectId,
metaId: $metaId,
labelerRestricted: $labelerRestricted
) {
id
cabinetId
name
width
displayed
labelerRestricted
rowQuestionIndex
}
}
Variables
{
"projectId": "4",
"metaId": 123,
"labelerRestricted": false
}
Response
{
"data": {
"updateDocumentMetaLabelerRestricted": {
"id": 987,
"cabinetId": 123,
"name": "abc123",
"width": "abc123",
"displayed": false,
"labelerRestricted": true,
"rowQuestionIndex": 987
}
}
}
updateDocumentMetas
Response
Returns [DocumentMeta!]!
Arguments
| Name | Description |
|---|---|
input - UpdateDocumentMetasInput
|
Example
Query
mutation UpdateDocumentMetas($input: UpdateDocumentMetasInput) {
updateDocumentMetas(input: $input) {
id
cabinetId
name
width
displayed
labelerRestricted
rowQuestionIndex
}
}
Variables
{"input": UpdateDocumentMetasInput}
Response
{
"data": {
"updateDocumentMetas": [
{
"id": 123,
"cabinetId": 123,
"name": "abc123",
"width": "xyz789",
"displayed": false,
"labelerRestricted": true,
"rowQuestionIndex": 123
}
]
}
}
updateDocumentQuestion
Description
WARNING: This mutation will remove all answers, please treat it carefully. It's recommended to call this mutation only if there are no answers yet on the project.
Response
Returns a Question!
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
|
input - QuestionInput!
|
|
signature - String
|
Example
Query
mutation UpdateDocumentQuestion(
$projectId: ID!,
$input: QuestionInput!,
$signature: String
) {
updateDocumentQuestion(
projectId: $projectId,
input: $input,
signature: $signature
) {
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,
"input": QuestionInput,
"signature": "abc123"
}
Response
{
"data": {
"updateDocumentQuestion": {
"id": 987,
"internalId": "xyz789",
"type": "DROPDOWN",
"name": "xyz789",
"label": "abc123",
"required": true,
"config": QuestionConfig,
"bindToColumn": "abc123",
"activationConditionLogic": "xyz789"
}
}
}
updateDocumentQuestions
Description
WARNING: This mutation will remove all answers, please treat it carefully. It's recommended to call this mutation only if there are no answers yet on the project.
Response
Returns [Question!]!
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
|
input - [QuestionInput!]!
|
|
signature - String
|
Example
Query
mutation UpdateDocumentQuestions(
$projectId: ID!,
$input: [QuestionInput!]!,
$signature: String
) {
updateDocumentQuestions(
projectId: $projectId,
input: $input,
signature: $signature
) {
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",
"input": [QuestionInput],
"signature": "xyz789"
}
Response
{
"data": {
"updateDocumentQuestions": [
{
"id": 123,
"internalId": "xyz789",
"type": "DROPDOWN",
"name": "xyz789",
"label": "xyz789",
"required": true,
"config": QuestionConfig,
"bindToColumn": "xyz789",
"activationConditionLogic": "abc123"
}
]
}
}
updateFileTransformer
Response
Returns a FileTransformer!
Arguments
| Name | Description |
|---|---|
input - UpdateFileTransformerInput!
|
Example
Query
mutation UpdateFileTransformer($input: UpdateFileTransformerInput!) {
updateFileTransformer(input: $input) {
id
name
content
transpiled
createdAt
updatedAt
language
purpose
readonly
externalId
warmup
}
}
Variables
{"input": UpdateFileTransformerInput}
Response
{
"data": {
"updateFileTransformer": {
"id": "4",
"name": "xyz789",
"content": "xyz789",
"transpiled": "abc123",
"createdAt": "abc123",
"updatedAt": "xyz789",
"language": "TYPESCRIPT",
"purpose": "IMPORT",
"readonly": true,
"externalId": "xyz789",
"warmup": false
}
}
}
updateGroundTruth
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a GroundTruth!
Arguments
| Name | Description |
|---|---|
input - UpdateGroundTruthInput!
|
Example
Query
mutation UpdateGroundTruth($input: UpdateGroundTruthInput!) {
updateGroundTruth(input: $input) {
id
groundTruthSetId
prompt
answer
createdAt
updatedAt
}
}
Variables
{"input": UpdateGroundTruthInput}
Response
{
"data": {
"updateGroundTruth": {
"id": 4,
"groundTruthSetId": 4,
"prompt": "abc123",
"answer": "abc123",
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
updateGroundTruthSet
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a GroundTruthSet!
Arguments
| Name | Description |
|---|---|
input - UpdateGroundTruthSetInput!
|
Example
Query
mutation UpdateGroundTruthSet($input: UpdateGroundTruthSetInput!) {
updateGroundTruthSet(input: $input) {
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
{"input": UpdateGroundTruthSetInput}
Response
{
"data": {
"updateGroundTruthSet": {
"id": 4,
"name": "abc123",
"teamId": "4",
"createdByUserId": 4,
"createdByUser": User,
"items": [GroundTruth],
"itemsCount": 987,
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
updateLabelErrorDetectionRowBased
Response
Returns a LabelErrorDetectionRowBased!
Arguments
| Name | Description |
|---|---|
input - UpdateLabelErrorDetectionRowBasedInput!
|
Example
Query
mutation UpdateLabelErrorDetectionRowBased($input: UpdateLabelErrorDetectionRowBasedInput!) {
updateLabelErrorDetectionRowBased(input: $input) {
id
cabinetId
inputColumnIds
questionColumnId
jobId
createdAt
updatedAt
}
}
Variables
{"input": UpdateLabelErrorDetectionRowBasedInput}
Response
{
"data": {
"updateLabelErrorDetectionRowBased": {
"id": "4",
"cabinetId": "4",
"inputColumnIds": [987],
"questionColumnId": 987,
"jobId": 4,
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
updateLabelSetTemplate
Description
Updates the specified labelset template.
Response
Returns a LabelSetTemplate
Arguments
| Name | Description |
|---|---|
input - UpdateLabelSetTemplateInput!
|
Example
Query
mutation UpdateLabelSetTemplate($input: UpdateLabelSetTemplateInput!) {
updateLabelSetTemplate(input: $input) {
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
{"input": UpdateLabelSetTemplateInput}
Response
{
"data": {
"updateLabelSetTemplate": {
"id": 4,
"name": "abc123",
"owner": User,
"type": "QUESTION",
"items": [LabelSetTemplateItem],
"count": 123,
"createdAt": "abc123",
"updatedAt": "xyz789"
}
}
}
updateLabelingFunction
Response
Returns a LabelingFunction!
Arguments
| Name | Description |
|---|---|
input - UpdateLabelingFunctionInput!
|
Example
Query
mutation UpdateLabelingFunction($input: UpdateLabelingFunctionInput!) {
updateLabelingFunction(input: $input) {
id
dataProgrammingId
heuristicArgument
annotatorArgument
name
content
active
createdAt
updatedAt
}
}
Variables
{"input": UpdateLabelingFunctionInput}
Response
{
"data": {
"updateLabelingFunction": {
"id": "4",
"dataProgrammingId": 4,
"heuristicArgument": HeuristicArgumentScalar,
"annotatorArgument": AnnotatorArgumentScalar,
"name": "xyz789",
"content": "abc123",
"active": true,
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
updateLabels
Response
Returns an UpdateLabelsResult!
Arguments
| Name | Description |
|---|---|
input - UpdateTokenLabelsInput!
|
Example
Query
mutation UpdateLabels($input: UpdateTokenLabelsInput!) {
updateLabels(input: $input) {
document {
id
chunks {
...TextChunkFragment
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
...TextDocumentSettingsFragment
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
...TextSentenceFragment
}
settings {
...SettingsFragment
}
statistic {
...TextDocumentStatisticFragment
}
type
updatedChunks {
...TextChunkFragment
}
updatedTokenLabels {
...TextLabelFragment
}
url
version
workspaceState {
...WorkspaceStateFragment
}
originId
signature
part
}
updatedSentences {
id
documentId
userId
status
content
tokens
posLabels {
...TextLabelFragment
}
nerLabels {
...TextLabelFragment
}
docLabels {
...DocLabelObjectFragment
}
docLabelsString
conflicts {
...ConflictTextLabelFragment
}
conflictAnswers {
...ConflictAnswerFragment
}
answers {
...AnswerFragment
}
sentenceConflict {
...SentenceConflictFragment
}
conflictAnswerResolved
metadata {
...CellMetadataFragment
}
}
updatedCellLines
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
}
previousTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
}
rejectedLabels {
label {
...TextLabelFragment
}
reason
}
}
}
Variables
{"input": UpdateTokenLabelsInput}
Response
{
"data": {
"updateLabels": {
"document": TextDocument,
"updatedSentences": [TextSentence],
"updatedCellLines": [987],
"updatedTokenLabels": [TextLabel],
"previousTokenLabels": [TextLabel],
"rejectedLabels": [RejectedLabel]
}
}
}
updateLastOpenedDocument
Example
Query
mutation UpdateLastOpenedDocument(
$cabinetId: ID!,
$documentId: ID!
) {
updateLastOpenedDocument(
cabinetId: $cabinetId,
documentId: $documentId
) {
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
{"cabinetId": "4", "documentId": 4}
Response
{
"data": {
"updateLastOpenedDocument": {
"id": 4,
"documents": [TextDocumentScalar],
"role": "REVIEWER",
"status": "IN_PROGRESS",
"lastOpenedDocumentId": "4",
"statistic": CabinetStatistic,
"owner": User,
"createdAt": "2007-12-03T10:15:30Z"
}
}
}
updateLlmApplication
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplication!
Arguments
| Name | Description |
|---|---|
input - LlmApplicationUpdateInput!
|
Example
Query
mutation UpdateLlmApplication($input: LlmApplicationUpdateInput!) {
updateLlmApplication(input: $input) {
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
{"input": LlmApplicationUpdateInput}
Response
{
"data": {
"updateLlmApplication": {
"id": 4,
"teamId": "4",
"createdByUser": User,
"name": "abc123",
"status": "DEPLOYED",
"createdAt": "abc123",
"updatedAt": "xyz789",
"llmApplicationDeployment": LlmApplicationDeployment
}
}
}
updateLlmApplicationConfiguration
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplicationConfiguration!
Arguments
| Name | Description |
|---|---|
input - UpdateLlmApplicationConfigurationInput!
|
Example
Query
mutation UpdateLlmApplicationConfiguration($input: UpdateLlmApplicationConfigurationInput!) {
updateLlmApplicationConfiguration(input: $input) {
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
{"input": UpdateLlmApplicationConfigurationInput}
Response
{
"data": {
"updateLlmApplicationConfiguration": {
"id": "4",
"name": "xyz789",
"teamId": "4",
"createdByUserId": "4",
"createdByUser": User,
"updatedByUserId": 4,
"updatedByUser": User,
"llmRagConfigId": 4,
"llmRagConfig": LlmRagConfig,
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
updateLlmApplicationPlaygroundPrompt
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplicationPlaygroundPrompt!
Arguments
| Name | Description |
|---|---|
input - LlmApplicationPlaygroundPromptUpdateInput!
|
Example
Query
mutation UpdateLlmApplicationPlaygroundPrompt($input: LlmApplicationPlaygroundPromptUpdateInput!) {
updateLlmApplicationPlaygroundPrompt(input: $input) {
id
llmApplicationId
name
prompt
createdAt
updatedAt
}
}
Variables
{"input": LlmApplicationPlaygroundPromptUpdateInput}
Response
{
"data": {
"updateLlmApplicationPlaygroundPrompt": {
"id": "4",
"llmApplicationId": 4,
"name": "abc123",
"prompt": "xyz789",
"createdAt": "abc123",
"updatedAt": "xyz789"
}
}
}
updateLlmApplicationPlaygroundRagConfig
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplicationPlaygroundRagConfig!
Arguments
| Name | Description |
|---|---|
input - LlmApplicationPlaygroundRagConfigUpdateInput!
|
Example
Query
mutation UpdateLlmApplicationPlaygroundRagConfig($input: LlmApplicationPlaygroundRagConfigUpdateInput!) {
updateLlmApplicationPlaygroundRagConfig(input: $input) {
id
llmApplicationId
llmRagConfig {
id
llmModel {
...LlmModelFragment
}
systemInstruction
userInstruction
raw
temperature
topP
maxTokens
advancedHyperparameters
maxVectorStoreTokens
llmVectorStore {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
createdAt
updatedAt
}
name
createdAt
updatedAt
}
}
Variables
{"input": LlmApplicationPlaygroundRagConfigUpdateInput}
Response
{
"data": {
"updateLlmApplicationPlaygroundRagConfig": {
"id": "4",
"llmApplicationId": "4",
"llmRagConfig": LlmRagConfig,
"name": "xyz789",
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
updateLlmEvaluationAutomatedScheduled
Breaking changes may be introduced anytime in the future without prior notice.
Description
Updates a scheduled automated LLM evaluation.
Response
Returns a LlmEvaluation!
Arguments
| Name | Description |
|---|---|
input - UpdateLlmEvaluationAutomatedInput!
|
Example
Query
mutation UpdateLlmEvaluationAutomatedScheduled($input: UpdateLlmEvaluationAutomatedInput!) {
updateLlmEvaluationAutomatedScheduled(input: $input) {
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
{"input": UpdateLlmEvaluationAutomatedInput}
Response
{
"data": {
"updateLlmEvaluationAutomatedScheduled": {
"id": "4",
"name": "abc123",
"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"
}
}
}
updateLlmVectorStore
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmVectorStore!
Arguments
| Name | Description |
|---|---|
input - UpdateLlmVectorStoreInput!
|
Example
Query
mutation UpdateLlmVectorStore($input: UpdateLlmVectorStoreInput!) {
updateLlmVectorStore(input: $input) {
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
{"input": UpdateLlmVectorStoreInput}
Response
{
"data": {
"updateLlmVectorStore": {
"id": 4,
"teamId": "4",
"createdByUser": User,
"llmEmbeddingModel": LlmEmbeddingModel,
"provider": "DATASAUR",
"collectionId": "abc123",
"name": "abc123",
"status": "CREATED",
"chunkSize": 123,
"overlap": 123,
"documents": [LlmVectorStoreDocumentScalar],
"documentStatusCount": LlmVectorStoreDocumentCountByStatus,
"sourceDocuments": [LlmVectorStoreSourceDocument],
"questions": [Question],
"jobId": "xyz789",
"createdAt": "abc123",
"updatedAt": "abc123",
"dimension": 123
}
}
}
updateLlmVectorStoreAsync
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmVectorStoreLaunchJob!
Arguments
| Name | Description |
|---|---|
input - UpdateLlmVectorStoreAsyncInput!
|
Example
Query
mutation UpdateLlmVectorStoreAsync($input: UpdateLlmVectorStoreAsyncInput!) {
updateLlmVectorStoreAsync(input: $input) {
job {
id
status
progress
errors {
...JobErrorFragment
}
resultId
result
createdAt
updatedAt
additionalData {
...JobAdditionalDataFragment
}
}
name
}
}
Variables
{"input": UpdateLlmVectorStoreAsyncInput}
Response
{
"data": {
"updateLlmVectorStoreAsync": {
"job": Job,
"name": "xyz789"
}
}
}
updateMultiRowAnswers
Description
Replaces the answers at the specified lines
Response
Returns an UpdateMultiRowAnswersResult!
Arguments
| Name | Description |
|---|---|
input - UpdateMultiRowAnswersInput!
|
|
questionSetSignature - String
|
Example
Query
mutation UpdateMultiRowAnswers(
$input: UpdateMultiRowAnswersInput!,
$questionSetSignature: String
) {
updateMultiRowAnswers(
input: $input,
questionSetSignature: $questionSetSignature
) {
document {
id
chunks {
...TextChunkFragment
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
...TextDocumentSettingsFragment
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
...TextSentenceFragment
}
settings {
...SettingsFragment
}
statistic {
...TextDocumentStatisticFragment
}
type
updatedChunks {
...TextChunkFragment
}
updatedTokenLabels {
...TextLabelFragment
}
url
version
workspaceState {
...WorkspaceStateFragment
}
originId
signature
part
}
previousAnswers {
documentId
line
answers
metadata {
...AnswerMetadataFragment
}
updatedAt
}
updatedAnswers {
documentId
line
answers
metadata {
...AnswerMetadataFragment
}
updatedAt
}
updatedLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
}
}
}
Variables
{
"input": UpdateMultiRowAnswersInput,
"questionSetSignature": "abc123"
}
Response
{
"data": {
"updateMultiRowAnswers": {
"document": TextDocument,
"previousAnswers": [RowAnswer],
"updatedAnswers": [RowAnswer],
"updatedLabels": [TextLabel]
}
}
}
updatePinnedProjectTemplates
Response
Returns [ProjectTemplateV2!]!
Example
Query
mutation UpdatePinnedProjectTemplates(
$teamId: ID!,
$projectTemplateIds: [ID!]!
) {
updatePinnedProjectTemplates(
teamId: $teamId,
projectTemplateIds: $projectTemplateIds
) {
id
name
logoURL
projectTemplateProjectSettingId
projectTemplateTextDocumentSettingId
projectTemplateProjectSetting {
autoMarkDocumentAsComplete
enableEditLabelSet
enableEditSentence
enableLabelerProjectCompletionNotificationThreshold
enableReviewerEditSentence
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
}
projectTemplateTextDocumentSetting {
customScriptId
fileTransformerId
customTextExtractionAPIId
sentenceSeparator
mediaDisplayStrategy
enableTabularMarkdownParsing
firstRowAsHeader
displayedRows
kind
kinds
allTokensMustBeLabeled
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
textLabelMaxTokenLength
ocrMethod
transcriptMethod
ocrProvider
autoScrollWhenLabeling
tokenizer
editSentenceTokenizer
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
type
description
imagePreviewURL
videoURL
}
}
Variables
{
"teamId": "4",
"projectTemplateIds": ["4"]
}
Response
{
"data": {
"updatePinnedProjectTemplates": [
{
"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": "abc123"
}
]
}
}
updateProject
Response
Returns a Project!
Arguments
| Name | Description |
|---|---|
input - UpdateProjectInput!
|
Example
Query
mutation UpdateProject($input: UpdateProjectInput!) {
updateProject(input: $input) {
id
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
teamId
owner {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
createdAt
updatedAt
}
name
tags {
id
name
globalTag
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
autoMarkDocumentAsComplete
consensus
conflictResolution {
...ConflictResolutionFragment
}
dynamicReviewMethod
dynamicReviewMemberId
enableEditLabelSet
enableReviewerEditSentence
enableReviewerInsertSentence
enableReviewerDeleteSentence
enableEditSentence
enableInsertSentence
enableDeleteSentence
enableDirectBBoxEditing
enableEnforceAutoLabelReviewerSettings
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
shouldConfirmUnusedLabelSetItems
spotChecking {
...SpotCheckingFragment
}
}
workspaceSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
asrProvider
kinds
sentenceSeparator
displayedRows
mediaDisplayStrategy
tokenizer
firstRowAsHeader
transcriptMethod
ocrProvider
customScriptId
fileTransformerId
customTextExtractionAPIId
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
}
reviewingStatus {
isCompleted
statistic {
...ReviewingStatusStatisticFragment
}
}
labelingStatus {
labeler {
...TeamMemberFragment
}
isCompleted
isStarted
statistic {
...LabelingStatusStatisticFragment
}
statisticsToShow {
...StatisticItemFragment
}
}
status
performance {
project {
...ProjectFragment
}
projectId
totalTimeSpent
effectiveTotalTimeSpent
conflicts
totalLabelApplied
numberOfAcceptedLabels
numberOfDocuments
numberOfTokens
numberOfLines
}
selfLabelingStatus
purpose
rootCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
reviewCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
labelerCabinets {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
guideline {
id
name
content
project {
...ProjectFragment
}
}
isArchived
projectMetadataItems {
id
teamId
creatorId
key
value
createdAt
updatedAt
}
}
}
Variables
{"input": UpdateProjectInput}
Response
{
"data": {
"updateProject": {
"id": 4,
"team": Team,
"teamId": "4",
"owner": User,
"externalObjectStorageId": "xyz789",
"rootDocumentId": "4",
"assignees": [ProjectAssignment],
"name": "abc123",
"tags": [Tag],
"type": "abc123",
"createdDate": "abc123",
"completedDate": "xyz789",
"exportedDate": "abc123",
"updatedDate": "xyz789",
"isOwnerMe": true,
"isReviewByMeAllowed": false,
"settings": ProjectSettings,
"workspaceSettings": WorkspaceSettings,
"reviewingStatus": ReviewingStatus,
"labelingStatus": [LabelingStatus],
"status": "CREATED",
"performance": ProjectPerformance,
"selfLabelingStatus": "NOT_STARTED",
"purpose": "LABELING",
"rootCabinet": Cabinet,
"reviewCabinet": Cabinet,
"labelerCabinets": [Cabinet],
"guideline": Guideline,
"isArchived": true,
"projectMetadataItems": [ProjectMetadataItem]
}
}
}
updateProjectBBoxLabelSet
Description
Replaces existing label set entirely with new input. PUT-like operation
Response
Returns a BBoxLabelSet!
Arguments
| Name | Description |
|---|---|
input - BBoxLabelSetInput!
|
Example
Query
mutation UpdateProjectBBoxLabelSet($input: BBoxLabelSetInput!) {
updateProjectBBoxLabelSet(input: $input) {
id
name
classes {
id
name
color
captionAllowed
captionRequired
questions {
...QuestionFragment
}
}
autoLabelProvider
}
}
Variables
{"input": BBoxLabelSetInput}
Response
{
"data": {
"updateProjectBBoxLabelSet": {
"id": "4",
"name": "xyz789",
"classes": [BBoxLabelClass],
"autoLabelProvider": "TESSERACT"
}
}
}
updateProjectExtension
Response
Returns a ProjectExtension
Arguments
| Name | Description |
|---|---|
input - UpdateProjectExtensionInput!
|
Example
Query
mutation UpdateProjectExtension($input: UpdateProjectExtensionInput!) {
updateProjectExtension(input: $input) {
id
cabinetId
elements {
id
enabled
extension {
...ExtensionFragment
}
height
order
setting {
...ExtensionElementSettingFragment
}
}
width
}
}
Variables
{"input": UpdateProjectExtensionInput}
Response
{
"data": {
"updateProjectExtension": {
"id": "4",
"cabinetId": "4",
"elements": [ExtensionElement],
"width": 123
}
}
}
updateProjectExtensionElementSetting
Response
Returns an ExtensionElement
Arguments
| Name | Description |
|---|---|
input - UpdateProjectExtensionElementSettingInput!
|
Example
Query
mutation UpdateProjectExtensionElementSetting($input: UpdateProjectExtensionElementSettingInput!) {
updateProjectExtensionElementSetting(input: $input) {
id
enabled
extension {
id
title
url
elementType
elementKind
documentType
}
height
order
setting {
extensionId
serviceProvider
apiURL
confidenceScore
locked
modelId
apiToken
systemPrompt
userPrompt
temperature
topP
model
enableLabelingFunctionMultipleLabel
endpointArn
roleArn
endpointAwsSagemakerArn
awsSagemakerRoleArn
externalId
namespace
inputColumns
questionColumn
questionColumns
labelSetIndex
options
bboxLabelSetId
}
}
}
Variables
{"input": UpdateProjectExtensionElementSettingInput}
Response
{
"data": {
"updateProjectExtensionElementSetting": {
"id": "4",
"enabled": true,
"extension": Extension,
"height": 123,
"order": 987,
"setting": ExtensionElementSetting
}
}
}
updateProjectGuideline
Response
Returns a Project!
Arguments
| Name | Description |
|---|---|
input - UpdateProjectGuidelineInput!
|
Example
Query
mutation UpdateProjectGuideline($input: UpdateProjectGuidelineInput!) {
updateProjectGuideline(input: $input) {
id
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
teamId
owner {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
createdAt
updatedAt
}
name
tags {
id
name
globalTag
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
autoMarkDocumentAsComplete
consensus
conflictResolution {
...ConflictResolutionFragment
}
dynamicReviewMethod
dynamicReviewMemberId
enableEditLabelSet
enableReviewerEditSentence
enableReviewerInsertSentence
enableReviewerDeleteSentence
enableEditSentence
enableInsertSentence
enableDeleteSentence
enableDirectBBoxEditing
enableEnforceAutoLabelReviewerSettings
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
shouldConfirmUnusedLabelSetItems
spotChecking {
...SpotCheckingFragment
}
}
workspaceSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
asrProvider
kinds
sentenceSeparator
displayedRows
mediaDisplayStrategy
tokenizer
firstRowAsHeader
transcriptMethod
ocrProvider
customScriptId
fileTransformerId
customTextExtractionAPIId
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
}
reviewingStatus {
isCompleted
statistic {
...ReviewingStatusStatisticFragment
}
}
labelingStatus {
labeler {
...TeamMemberFragment
}
isCompleted
isStarted
statistic {
...LabelingStatusStatisticFragment
}
statisticsToShow {
...StatisticItemFragment
}
}
status
performance {
project {
...ProjectFragment
}
projectId
totalTimeSpent
effectiveTotalTimeSpent
conflicts
totalLabelApplied
numberOfAcceptedLabels
numberOfDocuments
numberOfTokens
numberOfLines
}
selfLabelingStatus
purpose
rootCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
reviewCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
labelerCabinets {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
guideline {
id
name
content
project {
...ProjectFragment
}
}
isArchived
projectMetadataItems {
id
teamId
creatorId
key
value
createdAt
updatedAt
}
}
}
Variables
{"input": UpdateProjectGuidelineInput}
Response
{
"data": {
"updateProjectGuideline": {
"id": 4,
"team": Team,
"teamId": 4,
"owner": User,
"externalObjectStorageId": "abc123",
"rootDocumentId": 4,
"assignees": [ProjectAssignment],
"name": "abc123",
"tags": [Tag],
"type": "xyz789",
"createdDate": "xyz789",
"completedDate": "xyz789",
"exportedDate": "xyz789",
"updatedDate": "abc123",
"isOwnerMe": false,
"isReviewByMeAllowed": true,
"settings": ProjectSettings,
"workspaceSettings": WorkspaceSettings,
"reviewingStatus": ReviewingStatus,
"labelingStatus": [LabelingStatus],
"status": "CREATED",
"performance": ProjectPerformance,
"selfLabelingStatus": "NOT_STARTED",
"purpose": "LABELING",
"rootCabinet": Cabinet,
"reviewCabinet": Cabinet,
"labelerCabinets": [Cabinet],
"guideline": Guideline,
"isArchived": true,
"projectMetadataItems": [ProjectMetadataItem]
}
}
}
updateProjectLabelSet
Description
Updates a specific project's labelset.
Response
Returns a LabelSet!
Arguments
| Name | Description |
|---|---|
input - UpdateProjectLabelSetInput!
|
Example
Query
mutation UpdateProjectLabelSet($input: UpdateProjectLabelSetInput!) {
updateProjectLabelSet(input: $input) {
id
name
index
signature
tagItems {
id
parentId
tagName
desc
color
type
arrowRules {
...LabelClassArrowRuleFragment
}
}
lastUsedBy {
projectId
name
}
arrowLabelRequired
}
}
Variables
{"input": UpdateProjectLabelSetInput}
Response
{
"data": {
"updateProjectLabelSet": {
"id": "4",
"name": "xyz789",
"index": 987,
"signature": "xyz789",
"tagItems": [TagItem],
"lastUsedBy": LastUsedProject,
"arrowLabelRequired": false
}
}
}
updateProjectLabelSetByLabelSetTemplate
Description
Update a project labelset to use labelset template.
Response
Returns a LabelSet!
Arguments
| Name | Description |
|---|---|
input - UpdateProjectLabelSetByLabelSetTemplateInput!
|
Example
Query
mutation UpdateProjectLabelSetByLabelSetTemplate($input: UpdateProjectLabelSetByLabelSetTemplateInput!) {
updateProjectLabelSetByLabelSetTemplate(input: $input) {
id
name
index
signature
tagItems {
id
parentId
tagName
desc
color
type
arrowRules {
...LabelClassArrowRuleFragment
}
}
lastUsedBy {
projectId
name
}
arrowLabelRequired
}
}
Variables
{"input": UpdateProjectLabelSetByLabelSetTemplateInput}
Response
{
"data": {
"updateProjectLabelSetByLabelSetTemplate": {
"id": "4",
"name": "abc123",
"index": 123,
"signature": "xyz789",
"tagItems": [TagItem],
"lastUsedBy": LastUsedProject,
"arrowLabelRequired": true
}
}
}
updateProjectMetadataItem
Description
Updates a specified metadata item by its' ID. Both the key and value can be updated using a single mutation
Response
Returns a ProjectMetadataItem!
Arguments
| Name | Description |
|---|---|
input - UpdateProjectMetadataItemInput!
|
Example
Query
mutation UpdateProjectMetadataItem($input: UpdateProjectMetadataItemInput!) {
updateProjectMetadataItem(input: $input) {
id
teamId
creatorId
key
value
createdAt
updatedAt
}
}
Variables
{"input": UpdateProjectMetadataItemInput}
Response
{
"data": {
"updateProjectMetadataItem": {
"id": "4",
"teamId": 4,
"creatorId": 4,
"key": "xyz789",
"value": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
updateProjectSettings
Response
Returns a Project!
Arguments
| Name | Description |
|---|---|
input - UpdateProjectSettingsInput!
|
Example
Query
mutation UpdateProjectSettings($input: UpdateProjectSettingsInput!) {
updateProjectSettings(input: $input) {
id
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
teamId
owner {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
createdAt
updatedAt
}
name
tags {
id
name
globalTag
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
autoMarkDocumentAsComplete
consensus
conflictResolution {
...ConflictResolutionFragment
}
dynamicReviewMethod
dynamicReviewMemberId
enableEditLabelSet
enableReviewerEditSentence
enableReviewerInsertSentence
enableReviewerDeleteSentence
enableEditSentence
enableInsertSentence
enableDeleteSentence
enableDirectBBoxEditing
enableEnforceAutoLabelReviewerSettings
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
shouldConfirmUnusedLabelSetItems
spotChecking {
...SpotCheckingFragment
}
}
workspaceSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
asrProvider
kinds
sentenceSeparator
displayedRows
mediaDisplayStrategy
tokenizer
firstRowAsHeader
transcriptMethod
ocrProvider
customScriptId
fileTransformerId
customTextExtractionAPIId
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
}
reviewingStatus {
isCompleted
statistic {
...ReviewingStatusStatisticFragment
}
}
labelingStatus {
labeler {
...TeamMemberFragment
}
isCompleted
isStarted
statistic {
...LabelingStatusStatisticFragment
}
statisticsToShow {
...StatisticItemFragment
}
}
status
performance {
project {
...ProjectFragment
}
projectId
totalTimeSpent
effectiveTotalTimeSpent
conflicts
totalLabelApplied
numberOfAcceptedLabels
numberOfDocuments
numberOfTokens
numberOfLines
}
selfLabelingStatus
purpose
rootCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
reviewCabinet {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
labelerCabinets {
id
documents
role
status
lastOpenedDocumentId
statistic {
...CabinetStatisticFragment
}
owner {
...UserFragment
}
createdAt
}
guideline {
id
name
content
project {
...ProjectFragment
}
}
isArchived
projectMetadataItems {
id
teamId
creatorId
key
value
createdAt
updatedAt
}
}
}
Variables
{"input": UpdateProjectSettingsInput}
Response
{
"data": {
"updateProjectSettings": {
"id": 4,
"team": Team,
"teamId": 4,
"owner": User,
"externalObjectStorageId": "xyz789",
"rootDocumentId": 4,
"assignees": [ProjectAssignment],
"name": "xyz789",
"tags": [Tag],
"type": "abc123",
"createdDate": "abc123",
"completedDate": "abc123",
"exportedDate": "abc123",
"updatedDate": "xyz789",
"isOwnerMe": true,
"isReviewByMeAllowed": false,
"settings": ProjectSettings,
"workspaceSettings": WorkspaceSettings,
"reviewingStatus": ReviewingStatus,
"labelingStatus": [LabelingStatus],
"status": "CREATED",
"performance": ProjectPerformance,
"selfLabelingStatus": "NOT_STARTED",
"purpose": "LABELING",
"rootCabinet": Cabinet,
"reviewCabinet": Cabinet,
"labelerCabinets": [Cabinet],
"guideline": Guideline,
"isArchived": false,
"projectMetadataItems": [ProjectMetadataItem]
}
}
}
updateProjectTemplate
Replaced by updateProjectTemplateV2
Description
Updates a project template by id.
Returns the old ProjectTemplate structure.
To update a project template and obtain the new ProjectTemplateV2 structure, use updateProjectTemplateV2 instead.
Response
Returns a ProjectTemplate!
Arguments
| Name | Description |
|---|---|
input - UpdateProjectTemplateInput!
|
Example
Query
mutation UpdateProjectTemplate($input: UpdateProjectTemplateInput!) {
updateProjectTemplate(input: $input) {
id
name
teamId
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
logoURL
projectTemplateProjectSettingId
projectTemplateTextDocumentSettingId
projectTemplateProjectSetting {
autoMarkDocumentAsComplete
enableEditLabelSet
enableEditSentence
enableLabelerProjectCompletionNotificationThreshold
enableReviewerEditSentence
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
}
projectTemplateTextDocumentSetting {
customScriptId
fileTransformerId
customTextExtractionAPIId
sentenceSeparator
mediaDisplayStrategy
enableTabularMarkdownParsing
firstRowAsHeader
displayedRows
kind
kinds
allTokensMustBeLabeled
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
textLabelMaxTokenLength
ocrMethod
transcriptMethod
ocrProvider
autoScrollWhenLabeling
tokenizer
editSentenceTokenizer
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
}
}
Variables
{"input": UpdateProjectTemplateInput}
Response
{
"data": {
"updateProjectTemplate": {
"id": 4,
"name": "abc123",
"teamId": 4,
"team": Team,
"logoURL": "xyz789",
"projectTemplateProjectSettingId": "4",
"projectTemplateTextDocumentSettingId": "4",
"projectTemplateProjectSetting": ProjectTemplateProjectSetting,
"projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
"labelSetTemplates": [LabelSetTemplate],
"questionSets": [QuestionSet],
"createdAt": "abc123",
"updatedAt": "abc123",
"purpose": "LABELING",
"creatorId": 4
}
}
}
updateProjectTemplateV2
Description
Updates a project template by id.
Response
Returns a ProjectTemplateV2!
Arguments
| Name | Description |
|---|---|
input - UpdateProjectTemplateInput!
|
Example
Query
mutation UpdateProjectTemplateV2($input: UpdateProjectTemplateInput!) {
updateProjectTemplateV2(input: $input) {
id
name
logoURL
projectTemplateProjectSettingId
projectTemplateTextDocumentSettingId
projectTemplateProjectSetting {
autoMarkDocumentAsComplete
enableEditLabelSet
enableEditSentence
enableLabelerProjectCompletionNotificationThreshold
enableReviewerEditSentence
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
}
projectTemplateTextDocumentSetting {
customScriptId
fileTransformerId
customTextExtractionAPIId
sentenceSeparator
mediaDisplayStrategy
enableTabularMarkdownParsing
firstRowAsHeader
displayedRows
kind
kinds
allTokensMustBeLabeled
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
textLabelMaxTokenLength
ocrMethod
transcriptMethod
ocrProvider
autoScrollWhenLabeling
tokenizer
editSentenceTokenizer
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
type
description
imagePreviewURL
videoURL
}
}
Variables
{"input": UpdateProjectTemplateInput}
Response
{
"data": {
"updateProjectTemplateV2": {
"id": "4",
"name": "abc123",
"logoURL": "xyz789",
"projectTemplateProjectSettingId": "4",
"projectTemplateTextDocumentSettingId": 4,
"projectTemplateProjectSetting": ProjectTemplateProjectSetting,
"projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
"labelSetTemplates": [LabelSetTemplate],
"questionSets": [QuestionSet],
"createdAt": "xyz789",
"updatedAt": "xyz789",
"purpose": "LABELING",
"creatorId": 4,
"type": "CUSTOM",
"description": "abc123",
"imagePreviewURL": "xyz789",
"videoURL": "xyz789"
}
}
}
updateProjectTemplatesOrdering
Response
Returns [ProjectTemplate!]!
Arguments
| Name | Description |
|---|---|
ids - [ID!]!
|
Example
Query
mutation UpdateProjectTemplatesOrdering($ids: [ID!]!) {
updateProjectTemplatesOrdering(ids: $ids) {
id
name
teamId
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
logoURL
projectTemplateProjectSettingId
projectTemplateTextDocumentSettingId
projectTemplateProjectSetting {
autoMarkDocumentAsComplete
enableEditLabelSet
enableEditSentence
enableLabelerProjectCompletionNotificationThreshold
enableReviewerEditSentence
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
}
projectTemplateTextDocumentSetting {
customScriptId
fileTransformerId
customTextExtractionAPIId
sentenceSeparator
mediaDisplayStrategy
enableTabularMarkdownParsing
firstRowAsHeader
displayedRows
kind
kinds
allTokensMustBeLabeled
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
textLabelMaxTokenLength
ocrMethod
transcriptMethod
ocrProvider
autoScrollWhenLabeling
tokenizer
editSentenceTokenizer
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
}
}
Variables
{"ids": [4]}
Response
{
"data": {
"updateProjectTemplatesOrdering": [
{
"id": "4",
"name": "xyz789",
"teamId": 4,
"team": Team,
"logoURL": "xyz789",
"projectTemplateProjectSettingId": 4,
"projectTemplateTextDocumentSettingId": 4,
"projectTemplateProjectSetting": ProjectTemplateProjectSetting,
"projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
"labelSetTemplates": [LabelSetTemplate],
"questionSets": [QuestionSet],
"createdAt": "xyz789",
"updatedAt": "xyz789",
"purpose": "LABELING",
"creatorId": "4"
}
]
}
}
updateQuestionSet
Response
Returns a QuestionSet!
Arguments
| Name | Description |
|---|---|
input - UpdateQuestionSetInput!
|
Example
Query
mutation UpdateQuestionSet($input: UpdateQuestionSetInput!) {
updateQuestionSet(input: $input) {
name
id
creator {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
items {
id
index
questionSetId
label
type
multipleAnswer
required
bindToColumn
activationConditionLogic
createdAt
updatedAt
options {
...DropdownConfigOptionsFragment
}
leafOptionsOnly
format
defaultValue
max
min
theme
gradientColors
step
hideScaleLabel
multiline
maxLength
minLength
pattern
hint
nestedQuestions {
...QuestionSetItemFragment
}
parentId
}
createdAt
updatedAt
}
}
Variables
{"input": UpdateQuestionSetInput}
Response
{
"data": {
"updateQuestionSet": {
"name": "xyz789",
"id": 4,
"creator": User,
"items": [QuestionSetItem],
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
updateQuestionSetTemplate
Response
Returns a QuestionSetTemplate!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
|
id - ID!
|
|
input - QuestionSetTemplateInput
|
Example
Query
mutation UpdateQuestionSetTemplate(
$teamId: ID!,
$id: ID!,
$input: QuestionSetTemplateInput
) {
updateQuestionSetTemplate(
teamId: $teamId,
id: $id,
input: $input
) {
id
teamId
name
template
createdAt
updatedAt
}
}
Variables
{
"teamId": 4,
"id": "4",
"input": QuestionSetTemplateInput
}
Response
{
"data": {
"updateQuestionSetTemplate": {
"id": 4,
"teamId": "4",
"name": "abc123",
"template": "xyz789",
"createdAt": "abc123",
"updatedAt": "xyz789"
}
}
}
updateReversedLabels
Response
Returns a ReversedLabelsJob!
Arguments
| Name | Description |
|---|---|
input - ReversedLabelsOperationInput!
|
Example
Query
mutation UpdateReversedLabels($input: ReversedLabelsOperationInput!) {
updateReversedLabels(input: $input) {
job {
id
status
progress
errors {
...JobErrorFragment
}
resultId
result
createdAt
updatedAt
additionalData {
...JobAdditionalDataFragment
}
}
}
}
Variables
{"input": ReversedLabelsOperationInput}
Response
{"data": {"updateReversedLabels": {"job": Job}}}
updateReviewDocumentMetas
Response
Returns [DocumentMeta!]!
Arguments
| Name | Description |
|---|---|
input - UpdateReviewDocumentMetasInput
|
Example
Query
mutation UpdateReviewDocumentMetas($input: UpdateReviewDocumentMetasInput) {
updateReviewDocumentMetas(input: $input) {
id
cabinetId
name
width
displayed
labelerRestricted
rowQuestionIndex
}
}
Variables
{"input": UpdateReviewDocumentMetasInput}
Response
{
"data": {
"updateReviewDocumentMetas": [
{
"id": 123,
"cabinetId": 987,
"name": "xyz789",
"width": "xyz789",
"displayed": false,
"labelerRestricted": false,
"rowQuestionIndex": 987
}
]
}
}
updateRowAnswers
Response
Returns an UpdateRowAnswersResult!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
line - Int!
|
|
answers - AnswerScalar!
|
|
questionSetSignature - String
|
Example
Query
mutation UpdateRowAnswers(
$documentId: ID!,
$line: Int!,
$answers: AnswerScalar!,
$questionSetSignature: String
) {
updateRowAnswers(
documentId: $documentId,
line: $line,
answers: $answers,
questionSetSignature: $questionSetSignature
) {
document {
id
chunks {
...TextChunkFragment
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
...TextDocumentSettingsFragment
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
...TextSentenceFragment
}
settings {
...SettingsFragment
}
statistic {
...TextDocumentStatisticFragment
}
type
updatedChunks {
...TextChunkFragment
}
updatedTokenLabels {
...TextLabelFragment
}
url
version
workspaceState {
...WorkspaceStateFragment
}
originId
signature
part
}
previousAnswers {
documentId
line
answers
metadata {
...AnswerMetadataFragment
}
updatedAt
}
updatedAnswers {
documentId
line
answers
metadata {
...AnswerMetadataFragment
}
updatedAt
}
}
}
Variables
{
"documentId": "4",
"line": 123,
"answers": AnswerScalar,
"questionSetSignature": "xyz789"
}
Response
{
"data": {
"updateRowAnswers": {
"document": TextDocument,
"previousAnswers": RowAnswer,
"updatedAnswers": RowAnswer
}
}
}
updateRowQuestion
Description
WARNING: This mutation will remove all answers, please treat it carefully. It's recommended to call this mutation only if there are no answers yet on the project.
Response
Returns a Question!
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
|
input - QuestionInput!
|
|
signature - String
|
Example
Query
mutation UpdateRowQuestion(
$projectId: ID!,
$input: QuestionInput!,
$signature: String
) {
updateRowQuestion(
projectId: $projectId,
input: $input,
signature: $signature
) {
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,
"input": QuestionInput,
"signature": "xyz789"
}
Response
{
"data": {
"updateRowQuestion": {
"id": 123,
"internalId": "abc123",
"type": "DROPDOWN",
"name": "abc123",
"label": "xyz789",
"required": false,
"config": QuestionConfig,
"bindToColumn": "abc123",
"activationConditionLogic": "abc123"
}
}
}
updateRowQuestions
Description
WARNING: This mutation will remove all answers, please treat it carefully. It's recommended to call this mutation only if there are no answers yet on the project.
Response
Returns [Question!]!
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
|
input - [QuestionInput!]!
|
|
signature - String
|
Example
Query
mutation UpdateRowQuestions(
$projectId: ID!,
$input: [QuestionInput!]!,
$signature: String
) {
updateRowQuestions(
projectId: $projectId,
input: $input,
signature: $signature
) {
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,
"input": [QuestionInput],
"signature": "xyz789"
}
Response
{
"data": {
"updateRowQuestions": [
{
"id": 987,
"internalId": "xyz789",
"type": "DROPDOWN",
"name": "abc123",
"label": "abc123",
"required": false,
"config": QuestionConfig,
"bindToColumn": "abc123",
"activationConditionLogic": "abc123"
}
]
}
}
updateScim
Response
Returns a Scim!
Arguments
| Name | Description |
|---|---|
input - UpdateScimInput!
|
Example
Query
mutation UpdateScim($input: UpdateScimInput!) {
updateScim(input: $input) {
id
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
samlTenant {
id
active
companyId
idpIssuer
idpUrl
spIssuer
team {
...TeamFragment
}
allowMembersToSetPassword
}
active
}
}
Variables
{"input": UpdateScimInput}
Response
{
"data": {
"updateScim": {
"id": "4",
"team": Team,
"samlTenant": SamlTenant,
"active": false
}
}
}
updateScimGroups
Response
Returns [ScimGroup!]!
Arguments
| Name | Description |
|---|---|
input - ScimGroupInput!
|
Example
Query
mutation UpdateScimGroups($input: ScimGroupInput!) {
updateScimGroups(input: $input) {
id
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
scim {
id
team {
...TeamFragment
}
samlTenant {
...SamlTenantFragment
}
active
}
groupName
role
}
}
Variables
{"input": ScimGroupInput}
Response
{
"data": {
"updateScimGroups": [
{
"id": 4,
"team": Team,
"scim": Scim,
"groupName": "abc123",
"role": "LABELER"
}
]
}
}
updateSentenceConflict
Response
Returns an UpdateSentenceConflictResult!
Example
Query
mutation UpdateSentenceConflict(
$textDocumentId: ID!,
$signature: String!,
$sentenceId: Int!,
$resolved: Boolean!,
$labelerId: Int
) {
updateSentenceConflict(
textDocumentId: $textDocumentId,
signature: $signature,
sentenceId: $sentenceId,
resolved: $resolved,
labelerId: $labelerId
) {
cell {
line
index
content
tokens
metadata {
...CellMetadataFragment
}
conversationalMetadata {
...ConversationalMetadataFragment
}
status
conflict
conflicts {
...CellConflictFragment
}
originCell {
...CellFragment
}
}
labels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
}
addedLabels {
id
documentId
labeledBy
type
hashCode
labeledByUserId
acceptedByUserId
rejectedByUserId
}
deletedLabels {
id
documentId
labeledBy
type
hashCode
labeledByUserId
acceptedByUserId
rejectedByUserId
}
}
}
Variables
{
"textDocumentId": 4,
"signature": "abc123",
"sentenceId": 987,
"resolved": true,
"labelerId": 123
}
Response
{
"data": {
"updateSentenceConflict": {
"cell": Cell,
"labels": [TextLabel],
"addedLabels": [GqlConflictable],
"deletedLabels": [GqlConflictable]
}
}
}
updateTag
Response
Returns a Tag!
Arguments
| Name | Description |
|---|---|
input - UpdateTagInput!
|
Example
Query
mutation UpdateTag($input: UpdateTagInput!) {
updateTag(input: $input) {
id
name
globalTag
}
}
Variables
{"input": UpdateTagInput}
Response
{
"data": {
"updateTag": {
"id": 4,
"name": "abc123",
"globalTag": true
}
}
}
updateTeam
Response
Returns a Team!
Arguments
| Name | Description |
|---|---|
input - UpdateTeamInput!
|
Example
Query
mutation UpdateTeam($input: UpdateTeamInput!) {
updateTeam(input: $input) {
id
logoURL
members {
id
user {
...UserFragment
}
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
}
membersScalar
name
setting {
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedASRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enableActions
enableAddDocumentsToProject
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurDinamicTokenBased
enableDatasaurPredictiveRowBased
enableWipeData
enableExportTeamOverview
enableTransferOwnership
enableLabelErrorDetectionRowBased
allowedExtraAutoLabelProviders
enableLLMProject
enableRegexSentenceSeparator
enableTeamRoleSupervisor
endExtensionTrialAt
allowInvalidPaymentMethod
enableExternalKnowledgeBase
enableForceAnonymization
}
owner {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
isExpired
expiredAt
}
}
Variables
{"input": UpdateTeamInput}
Response
{
"data": {
"updateTeam": {
"id": 4,
"logoURL": "xyz789",
"members": [TeamMember],
"membersScalar": TeamMembersScalar,
"name": "xyz789",
"setting": TeamSetting,
"owner": User,
"isExpired": false,
"expiredAt": "2007-12-03T10:15:30Z"
}
}
}
updateTeamMemberTeamRole
Response
Returns a TeamMember
Arguments
| Name | Description |
|---|---|
input - UpdateTeamMemberTeamRoleInput!
|
Example
Query
mutation UpdateTeamMemberTeamRole($input: UpdateTeamMemberTeamRoleInput!) {
updateTeamMemberTeamRole(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": UpdateTeamMemberTeamRoleInput}
Response
{
"data": {
"updateTeamMemberTeamRole": {
"id": "4",
"user": User,
"role": TeamRole,
"invitationEmail": "xyz789",
"invitationStatus": "xyz789",
"invitationKey": "abc123",
"isDeleted": true,
"joinedDate": "abc123",
"performance": TeamMemberPerformance
}
}
}
updateTeamSetting
Response
Returns a Team!
Arguments
| Name | Description |
|---|---|
input - UpdateTeamSettingInput!
|
Example
Query
mutation UpdateTeamSetting($input: UpdateTeamSettingInput!) {
updateTeamSetting(input: $input) {
id
logoURL
members {
id
user {
...UserFragment
}
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
}
membersScalar
name
setting {
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedASRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enableActions
enableAddDocumentsToProject
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurDinamicTokenBased
enableDatasaurPredictiveRowBased
enableWipeData
enableExportTeamOverview
enableTransferOwnership
enableLabelErrorDetectionRowBased
allowedExtraAutoLabelProviders
enableLLMProject
enableRegexSentenceSeparator
enableTeamRoleSupervisor
endExtensionTrialAt
allowInvalidPaymentMethod
enableExternalKnowledgeBase
enableForceAnonymization
}
owner {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
isExpired
expiredAt
}
}
Variables
{"input": UpdateTeamSettingInput}
Response
{
"data": {
"updateTeamSetting": {
"id": 4,
"logoURL": "abc123",
"members": [TeamMember],
"membersScalar": TeamMembersScalar,
"name": "abc123",
"setting": TeamSetting,
"owner": User,
"isExpired": false,
"expiredAt": "2007-12-03T10:15:30Z"
}
}
}
updateTenant
Response
Returns a SamlTenant!
Arguments
| Name | Description |
|---|---|
input - UpdateSamlTenantInput!
|
Example
Query
mutation UpdateTenant($input: UpdateSamlTenantInput!) {
updateTenant(input: $input) {
id
active
companyId
idpIssuer
idpUrl
spIssuer
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
allowMembersToSetPassword
}
}
Variables
{"input": UpdateSamlTenantInput}
Response
{
"data": {
"updateTenant": {
"id": "4",
"active": true,
"companyId": 4,
"idpIssuer": "abc123",
"idpUrl": "xyz789",
"spIssuer": "xyz789",
"team": Team,
"allowMembersToSetPassword": false
}
}
}
updateTextDocument
Description
Updates a specific document.
Response
Returns a TextDocument!
Arguments
| Name | Description |
|---|---|
input - UpdateTextDocumentInput!
|
Example
Query
mutation UpdateTextDocument($input: UpdateTextDocumentInput!) {
updateTextDocument(input: $input) {
id
chunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
kinds
sentenceSeparator
tokenizer
editSentenceTokenizer
displayedRows
mediaDisplayStrategy
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
fileTransformerId
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
id
documentId
userId
status
content
tokens
posLabels {
...TextLabelFragment
}
nerLabels {
...TextLabelFragment
}
docLabels {
...DocLabelObjectFragment
}
docLabelsString
conflicts {
...ConflictTextLabelFragment
}
conflictAnswers {
...ConflictAnswerFragment
}
answers {
...AnswerFragment
}
sentenceConflict {
...SentenceConflictFragment
}
conflictAnswerResolved
metadata {
...CellMetadataFragment
}
}
settings {
textLang
}
statistic {
documentId
numberOfChunks
numberOfSentences
numberOfTokens
effectiveTimeSpent
touchedSentences
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
}
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
}
url
version
workspaceState {
id
chunkId
sentenceStart
sentenceEnd
touchedChunks
touchedSentences
}
originId
signature
part
}
}
Variables
{"input": UpdateTextDocumentInput}
Response
{
"data": {
"updateTextDocument": {
"id": "4",
"chunks": [TextChunk],
"createdAt": "abc123",
"currentSentenceCursor": 123,
"lastLabeledLine": 987,
"documentSettings": TextDocumentSettings,
"fileName": "xyz789",
"isCompleted": false,
"lastSavedAt": "xyz789",
"mimeType": "xyz789",
"name": "abc123",
"projectId": 4,
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "abc123",
"version": 123,
"workspaceState": WorkspaceState,
"originId": "4",
"signature": "xyz789",
"part": 987
}
}
}
updateTextDocumentSettings
Response
Returns a TextDocumentSettings!
Arguments
| Name | Description |
|---|---|
input - UpdateTextDocumentSettingsInput
|
Example
Query
mutation UpdateTextDocumentSettings($input: UpdateTextDocumentSettingsInput) {
updateTextDocumentSettings(input: $input) {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
kinds
sentenceSeparator
tokenizer
editSentenceTokenizer
displayedRows
mediaDisplayStrategy
viewer
viewerConfig {
urlColumnNames
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
name
pattern
flags
}
fileTransformerId
}
}
Variables
{"input": UpdateTextDocumentSettingsInput}
Response
{
"data": {
"updateTextDocumentSettings": {
"id": "4",
"textLabelMaxTokenLength": 123,
"allTokensMustBeLabeled": false,
"autoScrollWhenLabeling": true,
"allowArcDrawing": false,
"allowCharacterBasedLabeling": false,
"allowMultiLabels": true,
"kinds": ["DOCUMENT_BASED"],
"sentenceSeparator": "xyz789",
"tokenizer": "abc123",
"editSentenceTokenizer": "abc123",
"displayedRows": 987,
"mediaDisplayStrategy": "NONE",
"viewer": "TOKEN",
"viewerConfig": TextDocumentViewerConfig,
"hideBoundingBoxIfNoSpanOrArrowLabel": true,
"enableTabularMarkdownParsing": true,
"enableAnonymization": false,
"anonymizationEntityTypes": [
"xyz789"
],
"anonymizationMaskingMethod": "abc123",
"anonymizationRegExps": [RegularExpression],
"fileTransformerId": "xyz789"
}
}
}
updateTokenLabels
Response
Returns a TextDocument!
Arguments
| Name | Description |
|---|---|
input - UpdateTokenLabelsInput!
|
Example
Query
mutation UpdateTokenLabels($input: UpdateTokenLabelsInput!) {
updateTokenLabels(input: $input) {
id
chunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
id
textLabelMaxTokenLength
allTokensMustBeLabeled
autoScrollWhenLabeling
allowArcDrawing
allowCharacterBasedLabeling
allowMultiLabels
kinds
sentenceSeparator
tokenizer
editSentenceTokenizer
displayedRows
mediaDisplayStrategy
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
hideBoundingBoxIfNoSpanOrArrowLabel
enableTabularMarkdownParsing
enableAnonymization
anonymizationEntityTypes
anonymizationMaskingMethod
anonymizationRegExps {
...RegularExpressionFragment
}
fileTransformerId
}
fileName
isCompleted
lastSavedAt
mimeType
name
projectId
sentences {
id
documentId
userId
status
content
tokens
posLabels {
...TextLabelFragment
}
nerLabels {
...TextLabelFragment
}
docLabels {
...DocLabelObjectFragment
}
docLabelsString
conflicts {
...ConflictTextLabelFragment
}
conflictAnswers {
...ConflictAnswerFragment
}
answers {
...AnswerFragment
}
sentenceConflict {
...SentenceConflictFragment
}
conflictAnswerResolved
metadata {
...CellMetadataFragment
}
}
settings {
textLang
}
statistic {
documentId
numberOfChunks
numberOfSentences
numberOfTokens
effectiveTimeSpent
touchedSentences
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
}
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
}
url
version
workspaceState {
id
chunkId
sentenceStart
sentenceEnd
touchedChunks
touchedSentences
}
originId
signature
part
}
}
Variables
{"input": UpdateTokenLabelsInput}
Response
{
"data": {
"updateTokenLabels": {
"id": "4",
"chunks": [TextChunk],
"createdAt": "xyz789",
"currentSentenceCursor": 123,
"lastLabeledLine": 987,
"documentSettings": TextDocumentSettings,
"fileName": "abc123",
"isCompleted": true,
"lastSavedAt": "abc123",
"mimeType": "xyz789",
"name": "xyz789",
"projectId": 4,
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "abc123",
"version": 123,
"workspaceState": WorkspaceState,
"originId": 4,
"signature": "xyz789",
"part": 123
}
}
}
updateUserInfo
Response
Returns a User
Arguments
| Name | Description |
|---|---|
input - UpdateUserInfoInput!
|
Example
Query
mutation UpdateUserInfo($input: UpdateUserInfoInput!) {
updateUserInfo(input: $input) {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
utmSource
utmMedium
utmCampaign
}
}
}
Variables
{"input": UpdateUserInfoInput}
Response
{
"data": {
"updateUserInfo": {
"id": "4",
"amazonCustomerId": "xyz789",
"username": "abc123",
"name": "xyz789",
"email": "xyz789",
"package": "ENTERPRISE",
"profilePicture": "xyz789",
"allowedActions": ["CREATE_TEAM"],
"displayName": "abc123",
"teamPackage": "ENTERPRISE",
"emailVerified": false,
"totpAuthEnabled": true,
"companyName": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"signUpParams": SignUpParams
}
}
}
uploadGuideline
Response
Returns a Guideline!
Arguments
| Name | Description |
|---|---|
input - UploadGuidelineInput!
|
Example
Query
mutation UploadGuideline($input: UploadGuidelineInput!) {
uploadGuideline(input: $input) {
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
}
}
}
}
Variables
{"input": UploadGuidelineInput}
Response
{
"data": {
"uploadGuideline": {
"id": 4,
"name": "xyz789",
"content": "xyz789",
"project": Project
}
}
}
upsertBBoxLabels
Response
Returns [BBoxLabel!]!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
labels - [BBoxLabelInput!]!
|
Example
Query
mutation UpsertBBoxLabels(
$documentId: ID!,
$labels: [BBoxLabelInput!]!
) {
upsertBBoxLabels(
documentId: $documentId,
labels: $labels
) {
id
documentId
bboxLabelClassId
deleted
caption
shapes {
pageIndex
points {
...BBoxPointFragment
}
}
answers
}
}
Variables
{
"documentId": "4",
"labels": [BBoxLabelInput]
}
Response
{
"data": {
"upsertBBoxLabels": [
{
"id": "4",
"documentId": 4,
"bboxLabelClassId": "4",
"deleted": false,
"caption": "abc123",
"shapes": [BBoxShape],
"answers": AnswerScalar
}
]
}
}
upsertBoundingBox
Response
Returns [BoundingBoxLabel!]!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
labels - [BoundingBoxLabelInput!]!
|
Example
Query
mutation UpsertBoundingBox(
$documentId: ID!,
$labels: [BoundingBoxLabelInput!]!
) {
upsertBoundingBox(
documentId: $documentId,
labels: $labels
) {
id
documentId
coordinates {
x
y
}
counter
pageIndex
layer
position {
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
}
hashCode
type
labeledBy
}
}
Variables
{
"documentId": "4",
"labels": [BoundingBoxLabelInput]
}
Response
{
"data": {
"upsertBoundingBox": [
{
"id": "4",
"documentId": "4",
"coordinates": [Coordinate],
"counter": 123,
"pageIndex": 987,
"layer": 987,
"position": TextRange,
"hashCode": "abc123",
"type": "ARROW",
"labeledBy": "PRELABELED"
}
]
}
}
upsertLabelErrorDetectionRowBasedSuggestions
Response
Arguments
| Name | Description |
|---|---|
input - UpsertLabelErrorDetectionRowBasedSuggestionInput!
|
Example
Query
mutation UpsertLabelErrorDetectionRowBasedSuggestions($input: UpsertLabelErrorDetectionRowBasedSuggestionInput!) {
upsertLabelErrorDetectionRowBasedSuggestions(input: $input) {
id
documentId
labelErrorDetectionId
line
errorPossibility
suggestedLabel
previousLabel
createdAt
updatedAt
}
}
Variables
{
"input": UpsertLabelErrorDetectionRowBasedSuggestionInput
}
Response
{
"data": {
"upsertLabelErrorDetectionRowBasedSuggestions": [
{
"id": 4,
"documentId": "4",
"labelErrorDetectionId": 4,
"line": 987,
"errorPossibility": 123.45,
"suggestedLabel": "xyz789",
"previousLabel": "abc123",
"createdAt": "abc123",
"updatedAt": "abc123"
}
]
}
}
upsertLlmApplicationDeployment
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplicationDeployment!
Arguments
| Name | Description |
|---|---|
input - LlmApplicationDeploymentInput!
|
Example
Query
mutation UpsertLlmApplicationDeployment($input: LlmApplicationDeploymentInput!) {
upsertLlmApplicationDeployment(input: $input) {
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
{"input": LlmApplicationDeploymentInput}
Response
{
"data": {
"upsertLlmApplicationDeployment": {
"id": 4,
"deployedByUser": User,
"llmApplicationId": "4",
"llmApplication": LlmApplication,
"llmRagConfig": LlmRagConfig,
"numberOfCalls": 987,
"numberOfTokens": 987,
"numberOfInputTokens": 123,
"numberOfOutputTokens": 987,
"deployedAt": "abc123",
"createdAt": "abc123",
"updatedAt": "xyz789",
"apiEndpoints": [
LlmApplicationDeploymentApiEndpoint
]
}
}
}
upsertLlmVectorStoreAnswers
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmVectorStoreAnswer!
Arguments
| Name | Description |
|---|---|
llmVectorStoreDocumentId - ID!
|
|
answers - AnswerScalar!
|
Example
Query
mutation UpsertLlmVectorStoreAnswers(
$llmVectorStoreDocumentId: ID!,
$answers: AnswerScalar!
) {
upsertLlmVectorStoreAnswers(
llmVectorStoreDocumentId: $llmVectorStoreDocumentId,
answers: $answers
) {
llmVectorStoreDocumentId
answers
updatedAt
}
}
Variables
{
"llmVectorStoreDocumentId": "4",
"answers": AnswerScalar
}
Response
{
"data": {
"upsertLlmVectorStoreAnswers": {
"llmVectorStoreDocumentId": 4,
"answers": AnswerScalar,
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
upsertOauthClient
Description
Updates the oauth client.
Response
Returns an UpsertOauthClientResult
Example
Query
mutation UpsertOauthClient {
upsertOauthClient {
id
secret
}
}
Response
{
"data": {
"upsertOauthClient": {
"id": "xyz789",
"secret": "xyz789"
}
}
}
upsertTeamExternalApiKey
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a TeamExternalApiKey!
Arguments
| Name | Description |
|---|---|
input - TeamExternalApiKeyInput!
|
Example
Query
mutation UpsertTeamExternalApiKey($input: TeamExternalApiKeyInput!) {
upsertTeamExternalApiKey(input: $input) {
id
teamId
credentials {
provider
isConnected
openAIKey
azureOpenAIKey
azureOpenAIEndpoint
azureAITenantId
azureAISubscriptionId
azureAIResourceGroupName
azureAIAccountName
awsSagemakerRegion
awsSagemakerExternalId
awsSagemakerRoleArn
awsBedrockRegion
awsBedrockExternalId
awsBedrockRoleArn
}
createdAt
updatedAt
}
}
Variables
{"input": TeamExternalApiKeyInput}
Response
{
"data": {
"upsertTeamExternalApiKey": {
"id": 4,
"teamId": 4,
"credentials": [TeamExternalApiKeyCredential],
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
upsertTimestampLabels
Response
Returns [TimestampLabel!]!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
labels - [TimestampLabelInput!]!
|
Example
Query
mutation UpsertTimestampLabels(
$documentId: ID!,
$labels: [TimestampLabelInput!]!
) {
upsertTimestampLabels(
documentId: $documentId,
labels: $labels
) {
id
documentId
layer
position {
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
}
startTimestampMillis
endTimestampMillis
type
}
}
Variables
{"documentId": 4, "labels": [TimestampLabelInput]}
Response
{
"data": {
"upsertTimestampLabels": [
{
"id": 4,
"documentId": 4,
"layer": 987,
"position": TextRange,
"startTimestampMillis": 123,
"endTimestampMillis": 987,
"type": "ARROW"
}
]
}
}
useVectorStoreInLlmApplication
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns an ID!
Arguments
| Name | Description |
|---|---|
input - UseVectorStoreInLlmApplicationInput!
|
Example
Query
mutation UseVectorStoreInLlmApplication($input: UseVectorStoreInLlmApplicationInput!) {
useVectorStoreInLlmApplication(input: $input)
}
Variables
{"input": UseVectorStoreInLlmApplicationInput}
Response
{"data": {"useVectorStoreInLlmApplication": 4}}
verifyTotp
Response
Returns a LoginSuccess!
Arguments
| Name | Description |
|---|---|
totpCode - TotpCodeInput!
|
Example
Query
mutation VerifyTotp($totpCode: TotpCodeInput!) {
verifyTotp(totpCode: $totpCode) {
user {
id
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
redirect
}
}
Variables
{"totpCode": TotpCodeInput}
Response
{
"data": {
"verifyTotp": {
"user": User,
"redirect": "xyz789"
}
}
}
wipeProject
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - WipeProjectInput!
|
Example
Query
mutation WipeProject($input: WipeProjectInput!) {
wipeProject(input: $input)
}
Variables
{"input": WipeProjectInput}
Response
{"data": {"wipeProject": true}}
wipeProjects
Response
Returns [String!]!
Arguments
| Name | Description |
|---|---|
projectIds - [String!]!
|
Example
Query
mutation WipeProjects($projectIds: [String!]!) {
wipeProjects(projectIds: $projectIds)
}
Variables
{"projectIds": ["xyz789"]}
Response
{"data": {"wipeProjects": ["xyz789"]}}
Types
ASRProvider
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"OPENAI_WHISPER"
Action
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATE_TEAM"
ActionRunDetailStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SUCCESS"
ActionType
Values
| Enum Value | Description |
|---|---|
|
|
Create Project Action using Project Template |
Example
"CREATE_PROJECT"
AddActiveDurationInput
AddDocumentsToProjectInput
Description
Input payload for addDocumentsToProject mutation.
Fields
| Input Field | Description |
|---|---|
projectId - String!
|
Project to be updated. |
documents - [CreateDocumentInput!]!
|
List of new documents to be added. Each new document must have a unique name, and cannot have the same name as an existing document in the project. |
documentAssignments - [DocumentAssignmentInput!]
|
Assignments for the new documents. Optional, can be edited after the documents are added. |
Example
{
"projectId": "xyz789",
"documents": [CreateDocumentInput],
"documentAssignments": [DocumentAssignmentInput]
}
AddDocumentsToProjectJob
AddGroundTruthsToGroundTruthSetInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
items - [CreateGroundTruthInput!]!
|
Example
{
"id": "4",
"items": [CreateGroundTruthInput]
}
AddLabelingFunctionInput
Fields
| Input Field | Description |
|---|---|
dataProgrammingId - ID!
|
|
name - String!
|
|
defaultTemplateType - DefaultLabelingFunctionTemplateType
|
|
content - String
|
|
heuristicArgument - HeuristicArgumentScalar
|
|
annotatorArgument - AnnotatorArgumentScalar
|
Example
{
"dataProgrammingId": "4",
"name": "abc123",
"defaultTemplateType": "WITH_SPECIFIC_TARGET_LABEL",
"content": "xyz789",
"heuristicArgument": HeuristicArgumentScalar,
"annotatorArgument": AnnotatorArgumentScalar
}
AnalyticsDashboardQueryInput
Example
{
"teamId": 4,
"projectId": 4,
"userId": "4",
"labelType": "TOKEN_OR_ROW_BASED",
"calendarDate": "abc123",
"labelSetFilter": ["xyz789"],
"labeledBy": "REVIEWER",
"tagNames": ["abc123"]
}
AnalyticsLabelType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"TOKEN_OR_ROW_BASED"
AnnotatorArgumentScalar
Example
AnnotatorArgumentScalar
AnonymizationConfigInput
Fields
| Input Field | Description |
|---|---|
entityTypes - [String!]!
|
List of entity to masks. |
maskingMethod - String!
|
Masking method for anonymization. One of [RANDOM_CHARACTER, ASTERISK]. |
regularExpressions - [RegularExpressionInput!]
|
Optional. List of regular expressions for getting additional PII entities to anonymize. |
Example
{
"entityTypes": ["xyz789"],
"maskingMethod": "abc123",
"regularExpressions": [RegularExpressionInput]
}
Answer
Fields
| Field Name | Description |
|---|---|
key - ID!
|
|
values - [AnswerObject!]
|
|
nestedAnswers - [Answer!]
|
Example
{
"key": "4",
"values": [AnswerObject],
"nestedAnswers": [Answer]
}
AnswerMetadata
Fields
| Field Name | Description |
|---|---|
path - String!
|
|
labeledBy - LabelPhase!
|
|
createdAt - String
|
|
updatedAt - String
|
Example
{
"path": "abc123",
"labeledBy": "PRELABELED",
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
AnswerMetadataInput
Fields
| Input Field | Description |
|---|---|
path - String!
|
|
labeledBy - LabelPhase
|
Example
{
"path": "xyz789",
"labeledBy": "PRELABELED"
}
AnswerObject
AnswerScalar
Description
Example of AnswerScalar
Given a question set with 13 root questions
- question.index=0 -> text, single answer
- question.index=1 -> text, multiple answer
- question.index=2 -> multiline text, single answer
- question.index=3 -> multiline text, multiple answer
- question.index=4 -> dropdown, multiple answer
- question.index=5 -> dropdown, single answer
- question.index=6 -> hierarchical dropdown, multiple answer
- question.index=7 -> date
- question.index=8 -> time
- question.index=9 -> checkbox
- question.index=10 -> slider
- question.index=11 -> url
- question.index=12 -> grouped attributes with 2 child questions
- question.index=13 -> text, single answer
- question.index=14 -> checkbox
The key for an AnswerScalar object is ('Q' + question.index)
So the AnswerScalar will look like this:
{
"Q0": "Short text",
"Q1": [
"Short text 1",
"Short text 2",
"Short text 3"
],
"Q2": "Longer text at line 1\nMore text at line 2",
"Q3": [
"Longer text at line 1\nMore text at line 2",
"Second longer text",
"Third longer text"
],
"Q4": [
"Option 1",
"Option 2"
],
"Q5": "Option 1",
"Q6": [
"1.2",
"3"
],
"Q7": "2022-03-08",
"Q8": "11:02:50.896",
"Q9": true,
"Q10": "6",
"Q11": "https://datasaur.ai",
"Q12": [
{
"Q13": "Nested short text, group 1",
"Q14": true
},
{
"Q13": "Nested short text, group 2",
"Q14": false
}
]
}
Example
AnswerScalar
AnswerSetConflictStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CONFLICT"
AnswerType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"MULTIPLE"
AppendLabelSetTagItemsInput
Description
Parameters to add new labelset item to existing labelset.
Fields
| Input Field | Description |
|---|---|
labelSetId - ID!
|
Required. The labelset to modify. |
labelSetSignature - String
|
Optional. The labelset's signature. |
tagItems - [AppendTagItemInput!]!
|
Required. List of new items to add. |
arrowLabelRequired - Boolean
|
Optional. Defaults to false. |
Example
{
"labelSetId": 4,
"labelSetSignature": "xyz789",
"tagItems": [AppendTagItemInput],
"arrowLabelRequired": true
}
AppendTagItemInput
Description
Representation of a new labelset item.
Fields
| Input Field | Description |
|---|---|
tagName - String!
|
Required. The labelset item name, shown in web UI. Note that tagName is case-insensitive, i.e. per is treated the same way as PER would. |
desc - String
|
Optional. Description of the labelset item. |
id - ID
|
Optional. Unique identifier of the labelset item. If not supplied, will be generated automatically. |
color - String
|
Optional. The labelset item color when shown in web UI. 6 digit hex string, prefixed by #. Example: #df3920. |
type - LabelClassType
|
Optional. Can be SPAN, ARROW, or ALL. Defaults to ALL. |
arrowRules - [LabelClassArrowRuleInput!]
|
Optional. Only has effect if type is ARROW. |
Example
{
"tagName": "xyz789",
"desc": "xyz789",
"id": "4",
"color": "xyz789",
"type": "SPAN",
"arrowRules": [LabelClassArrowRuleInput]
}
AssignProjectInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
assignees - [ProjectAssignmentInput!]!
|
Example
{
"projectId": "4",
"assignees": [ProjectAssignmentInput]
}
AutoLabelBBoxBasedInput
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
Example
{"documentId": "4"}
AutoLabelBBoxBasedOutput
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
documentId - ID!
|
|
bboxLabelClassId - ID!
|
|
caption - String
|
|
shapes - [BBoxShape!]!
|
|
confidenceScore - Float
|
|
error - AutoLabelError
|
Example
{
"id": 4,
"documentId": "4",
"bboxLabelClassId": "4",
"caption": "abc123",
"shapes": [BBoxShape],
"confidenceScore": 987.65,
"error": AutoLabelError
}
AutoLabelError
AutoLabelModel
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
provider - GqlAutoLabelServiceProvider!
|
|
privacy - GqlAutoLabelModelPrivacy!
|
Example
{
"name": "abc123",
"provider": "CUSTOM",
"privacy": "PUBLIC"
}
AutoLabelModelsInput
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
|
kind - ProjectKind!
|
Example
{
"documentId": "4",
"kind": "DOCUMENT_BASED"
}
AutoLabelProjectOptionsInput
Fields
| Input Field | Description |
|---|---|
serviceProvider - GqlAutoLabelServiceProvider
|
|
numberOfFilesPerRequest - Int!
|
Example
{"serviceProvider": "CUSTOM", "numberOfFilesPerRequest": 987}
AutoLabelReviewTextDocumentBasedOnConsensusInput
Fields
| Input Field | Description |
|---|---|
textDocumentId - ID!
|
Example
{"textDocumentId": "4"}
AutoLabelRowBasedInput
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
|
inputColumns - [Int!]!
|
|
rowIdRange - RangeInput
|
Example
{
"documentId": 4,
"inputColumns": [123],
"rowIdRange": RangeInput
}
AutoLabelRowBasedOutput
Fields
| Field Name | Description |
|---|---|
id - Int!
|
|
label - String!
|
|
error - AutoLabelError
|
Example
{
"id": 123,
"label": "xyz789",
"error": AutoLabelError
}
AutoLabelRowBasedProjectInput
AutoLabelTokenBasedInput
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
|
sentenceIds - [Int!]
|
|
sentenceIdRange - RangeInput
|
Example
{
"documentId": 4,
"sentenceIds": [987],
"sentenceIdRange": RangeInput
}
AutoLabelTokenBasedOutput
Fields
| Field Name | Description |
|---|---|
label - String!
|
|
deleted - Boolean
|
|
layer - Int
|
|
start - TextCursor!
|
|
end - TextCursor!
|
|
confidenceScore - Float
|
|
error - AutoLabelError
|
Example
{
"label": "abc123",
"deleted": false,
"layer": 123,
"start": TextCursor,
"end": TextCursor,
"confidenceScore": 123.45,
"error": AutoLabelError
}
AutoLabelTokenBasedProjectInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
labelerEmail - String!
|
|
role - Role
|
|
targetAPI - TargetApiInput!
|
|
options - AutoLabelProjectOptionsInput!
|
Example
{
"projectId": "4",
"labelerEmail": "xyz789",
"role": "REVIEWER",
"targetAPI": TargetApiInput,
"options": AutoLabelProjectOptionsInput
}
AwsMarketplaceNlpFreeTrialExpiration
AwsMarketplaceSubscriptionInput
BBoxAutoLabelProvider
Values
| Enum Value | Description |
|---|---|
|
|
Example
"TESSERACT"
BBoxLabel
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The hashCode of this label. |
documentId - ID!
|
|
bboxLabelClassId - ID!
|
|
deleted - Boolean!
|
|
caption - String
|
|
shapes - [BBoxShape!]!
|
|
answers - AnswerScalar
|
Example
{
"id": "4",
"documentId": 4,
"bboxLabelClassId": "4",
"deleted": true,
"caption": "xyz789",
"shapes": [BBoxShape],
"answers": AnswerScalar
}
BBoxLabelClass
BBoxLabelInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
Optional. The hashCode of this label. |
documentId - ID!
|
|
bboxLabelClassId - ID!
|
|
caption - String
|
|
shapes - [BBoxShapeInput!]!
|
|
answers - AnswerScalar
|
Example
{
"id": 4,
"documentId": "4",
"bboxLabelClassId": "4",
"caption": "xyz789",
"shapes": [BBoxShapeInput],
"answers": AnswerScalar
}
BBoxLabelSet
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
classes - [BBoxLabelClass!]!
|
|
autoLabelProvider - BBoxAutoLabelProvider
|
Example
{
"id": "4",
"name": "xyz789",
"classes": [BBoxLabelClass],
"autoLabelProvider": "TESSERACT"
}
BBoxLabelSetInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
classes - [UpdateBBoxLabelClassInput!]!
|
|
autoLabelProvider - BBoxAutoLabelProvider
|
Example
{
"id": 4,
"name": "xyz789",
"classes": [UpdateBBoxLabelClassInput],
"autoLabelProvider": "TESSERACT"
}
BBoxLabelSetProjectInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
options - [CreateBBoxLabelClassInput!]!
|
|
autoLabelProvider - BBoxAutoLabelProvider
|
Example
{
"name": "abc123",
"options": [CreateBBoxLabelClassInput],
"autoLabelProvider": "TESSERACT"
}
BBoxPoint
BBoxPointInput
BBoxShape
Fields
| Field Name | Description |
|---|---|
pageIndex - Int!
|
|
points - [BBoxPoint!]!
|
Example
{"pageIndex": 123, "points": [BBoxPoint]}
BBoxShapeInput
Fields
| Input Field | Description |
|---|---|
pageIndex - Int!
|
|
points - [BBoxPointInput!]!
|
Example
{"pageIndex": 987, "points": [BBoxPointInput]}
Boolean
Description
The Boolean scalar type represents true or false.
BoundingBoxLabel
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
documentId - ID!
|
|
coordinates - [Coordinate!]!
|
|
counter - Int!
|
|
pageIndex - Int!
|
|
layer - Int!
|
|
position - TextRange!
|
|
hashCode - String!
|
|
type - LabelEntityType!
|
|
labeledBy - LabelPhase!
|
Example
{
"id": 4,
"documentId": 4,
"coordinates": [Coordinate],
"counter": 987,
"pageIndex": 987,
"layer": 987,
"position": TextRange,
"hashCode": "xyz789",
"type": "ARROW",
"labeledBy": "PRELABELED"
}
BoundingBoxLabelInput
Fields
| Input Field | Description |
|---|---|
coordinates - [CoordinateInput!]!
|
|
counter - Int!
|
|
pageIndex - Int
|
|
layer - Int!
|
|
position - TextRangeInput!
|
|
labeledBy - LabelPhase
|
Example
{
"coordinates": [CoordinateInput],
"counter": 987,
"pageIndex": 987,
"layer": 123,
"position": TextRangeInput,
"labeledBy": "PRELABELED"
}
BoundingBoxPage
Cabinet
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
documents - [TextDocumentScalar!]!
|
|
role - Role!
|
|
status - CabinetStatus!
|
|
lastOpenedDocumentId - ID
|
|
statistic - CabinetStatistic
|
|
owner - User!
|
|
createdAt - DateTime!
|
Example
{
"id": "4",
"documents": [TextDocumentScalar],
"role": "REVIEWER",
"status": "IN_PROGRESS",
"lastOpenedDocumentId": 4,
"statistic": CabinetStatistic,
"owner": User,
"createdAt": "2007-12-03T10:15:30Z"
}
CabinetContributor
CabinetMatcherInput
CabinetStatistic
CabinetStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"IN_PROGRESS"
Cell
Fields
| Field Name | Description |
|---|---|
line - Int!
|
|
index - Int!
|
|
content - String!
|
|
tokens - [String!]!
|
|
metadata - [CellMetadata!]!
|
|
conversationalMetadata - ConversationalMetadata
|
|
status - CellStatus!
|
|
conflict - Boolean!
|
|
conflicts - [CellConflict!]
|
|
originCell - Cell
|
Example
{
"line": 987,
"index": 123,
"content": "xyz789",
"tokens": ["abc123"],
"metadata": [CellMetadata],
"conversationalMetadata": ConversationalMetadata,
"status": "DISPLAYED",
"conflict": false,
"conflicts": [CellConflict],
"originCell": Cell
}
CellConflict
Fields
| Field Name | Description |
|---|---|
documentId - ID!
|
|
labelerId - Int!
|
|
cell - Cell!
|
|
labels - [TextLabel!]!
|
Example
{
"documentId": 4,
"labelerId": 987,
"cell": Cell,
"labels": [TextLabel]
}
CellMetadata
Fields
| Field Name | Description |
|---|---|
key - String!
|
|
value - String!
|
|
type - String
|
|
pinned - Boolean
|
|
config - TextMetadataConfig
|
Example
{
"key": "xyz789",
"value": "abc123",
"type": "xyz789",
"pinned": true,
"config": TextMetadataConfig
}
CellMetadataInput
CellPositionWithOriginDocumentId
CellPositionWithOriginDocumentIdInput
CellScalar
Example
CellScalar
CellStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DISPLAYED"
ChangePasswordInput
Fields
| Input Field | Description |
|---|---|
currentPassword - String!
|
|
newPassword - String!
|
|
confirmNewPassword - String!
|
|
totpCode - TotpCodeInput
|
Example
{
"currentPassword": "abc123",
"newPassword": "xyz789",
"confirmNewPassword": "xyz789",
"totpCode": TotpCodeInput
}
Chart
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
description - String!
|
|
type - ChartType!
|
|
level - ChartLevel!
|
|
set - [ChartSet!]!
|
|
dataTableHeaders - [String!]!
|
|
visualizationParams - VisualizationParams!
|
Example
{
"id": "4",
"name": "abc123",
"description": "abc123",
"type": "GROUPED",
"level": "TEAM",
"set": ["OLD"],
"dataTableHeaders": ["abc123"],
"visualizationParams": VisualizationParams
}
ChartArea
ChartDataRow
Fields
| Field Name | Description |
|---|---|
key - String!
|
|
values - [ChartDataRowValue!]!
|
|
keyPayloadType - KeyPayloadType
|
|
keyPayload - KeyPayload
|
Example
{
"key": "xyz789",
"values": [ChartDataRowValue],
"keyPayloadType": "USER",
"keyPayload": KeyPayload
}
ChartDataRowValue
ChartLevel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"TEAM"
ChartSet
Values
| Enum Value | Description |
|---|---|
|
|
OLD is deprecated because METABASE is no longer supported. Please use ELASTIC. |
|
|
NEW is deprecated because METABASE is no longer supported. Please use ELASTIC. |
|
|
Example
"OLD"
ChartType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"GROUPED"
ClearAllLabelsOnTextDocumentResult
Fields
| Field Name | Description |
|---|---|
affectedChunkIds - [Int!]!
|
|
statistic - TextDocumentStatistic!
|
|
lastSavedAt - String!
|
Example
{
"affectedChunkIds": [987],
"statistic": TextDocumentStatistic,
"lastSavedAt": "abc123"
}
ColorGradient
Comment
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
parentId - ID
|
|
documentId - ID!
|
|
originDocumentId - ID!
|
|
userId - Int!
|
|
user - User!
|
|
message - String!
|
|
resolved - Boolean!
|
|
resolvedAt - String
|
|
resolvedBy - User
|
|
repliesCount - Int!
|
|
createdAt - String!
|
|
updatedAt - String!
|
|
lastEditedAt - String
|
|
hashCode - String
|
|
commentedContent - CommentedContent
|
Example
{
"id": 4,
"parentId": "4",
"documentId": 4,
"originDocumentId": 4,
"userId": 123,
"user": User,
"message": "abc123",
"resolved": true,
"resolvedAt": "abc123",
"resolvedBy": User,
"repliesCount": 987,
"createdAt": "abc123",
"updatedAt": "abc123",
"lastEditedAt": "xyz789",
"hashCode": "abc123",
"commentedContent": CommentedContent
}
CommentNotificationType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"OFF"
CommentedContent
Fields
| Field Name | Description |
|---|---|
hashCodeType - String!
|
|
contexts - [CommentedContentContextValue!]!
|
|
currentValue - [CommentedContentCurrentValue!]
|
Example
{
"hashCodeType": "abc123",
"contexts": [CommentedContentContextValue],
"currentValue": [CommentedContentCurrentValue]
}
CommentedContentContextValue
CommentedContentCurrentValue
ConflictAnswer
Fields
| Field Name | Description |
|---|---|
questionId - ID!
|
|
parentQuestionId - ID
|
|
nestedAnswerIndex - Int
|
|
answers - [ConflictAnswerValue!]!
|
|
type - AnswerType!
|
Example
{
"questionId": 4,
"parentQuestionId": "4",
"nestedAnswerIndex": 123,
"answers": [ConflictAnswerValue],
"type": "MULTIPLE"
}
ConflictAnswerScalar
Example
ConflictAnswerScalar
ConflictAnswerValue
ConflictBoundingBoxLabel
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
documentId - ID!
|
|
coordinates - [Coordinate!]!
|
|
pageIndex - Int!
|
|
layer - Int!
|
|
position - TextRange!
|
|
resolved - Boolean!
|
|
hashCode - String!
|
|
labelerIds - [Int!]!
|
|
text - String!
|
Example
{
"id": 4,
"documentId": 4,
"coordinates": [Coordinate],
"pageIndex": 987,
"layer": 987,
"position": TextRange,
"resolved": false,
"hashCode": "abc123",
"labelerIds": [123],
"text": "abc123"
}
ConflictContributorIds
Fields
| Field Name | Description |
|---|---|
labelHashCode - String!
|
|
contributorIds - [Int!]!
|
Please use contributorInfos |
contributorInfos - [ContributorInfo!]!
|
Example
{
"labelHashCode": "xyz789",
"contributorIds": [123],
"contributorInfos": [ContributorInfo]
}
ConflictResolution
Fields
| Field Name | Description |
|---|---|
mode - ConflictResolutionMode!
|
|
consensus - Int!
|
Example
{"mode": "MANUAL", "consensus": 123}
ConflictResolutionInput
Fields
| Input Field | Description |
|---|---|
mode - ConflictResolutionMode
|
Default to PEER_REVIEW when not provided. MANUAL: all labels must be manually accepted / rejected by REVIEWERs PEER_REVIEW: labels that have met the minimum consensus value are automatically accepted. |
consensus - Int
|
Peer review / labeler consensus. It determines how many consensus so that the label will be automatically accepted. |
Example
{"mode": "MANUAL", "consensus": 123}
ConflictResolutionMode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"MANUAL"
ConflictTextLabel
Example
{
"id": 4,
"l": "abc123",
"layer": 123,
"ref": "abc123",
"labelerIds": [123],
"labelers": [User],
"resolved": false,
"text": "xyz789",
"hashCode": "xyz789",
"documentId": "xyz789",
"start": TextCursor,
"end": TextCursor
}
ConflictTextLabelResolutionStrategy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AUTO"
ConflictTextLabelScalar
Example
ConflictTextLabelScalar
ConfusionMatrixTable
Fields
| Field Name | Description |
|---|---|
matrixClasses - [MatrixClass!]!
|
|
data - [MatrixData!]!
|
Example
{
"matrixClasses": [MatrixClass],
"data": [MatrixData]
}
ContributorInfo
Description
Additional information of each contributor label info.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Labeler's user id |
labelPhase - LabelPhase!
|
Example
{"id": 4, "labelPhase": "PRELABELED"}
ConversationalMetadata
Fields
| Field Name | Description |
|---|---|
speaker - String!
|
|
indent - Int!
|
|
alignment - ConversationalMetadataAlignment!
|
|
color - String
|
Example
{
"speaker": "xyz789",
"indent": 987,
"alignment": "LEFT",
"color": "abc123"
}
ConversationalMetadataAlignment
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"LEFT"
Coordinate
CoordinateInput
CostPredictionResponse
Fields
| Field Name | Description |
|---|---|
costPerPromptTemplate - [PromptTemplateCostPrediction!]!
|
|
totalChars - CostPredictionTotal!
|
|
totalTokens - CostPredictionTotal!
|
|
totalPrice - CostPredictionTotalPrice!
|
Example
{
"costPerPromptTemplate": [PromptTemplateCostPrediction],
"totalChars": CostPredictionTotal,
"totalTokens": CostPredictionTotal,
"totalPrice": CostPredictionTotalPrice
}
CostPredictionTotal
CostPredictionTotalPrice
CreateBBoxLabelClassInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
color - String
|
|
captionAllowed - Boolean!
|
|
captionRequired - Boolean!
|
|
questions - [QuestionInput!]
|
Example
{
"name": "xyz789",
"color": "xyz789",
"captionAllowed": true,
"captionRequired": false,
"questions": [QuestionInput]
}
CreateBBoxLabelSetInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
classes - [CreateBBoxLabelClassInput!]!
|
|
autoLabelProvider - BBoxAutoLabelProvider
|
Example
{
"name": "abc123",
"classes": [CreateBBoxLabelClassInput],
"autoLabelProvider": "TESSERACT"
}
CreateCreateProjectActionInput
Description
Parameters for creating create project Action.
Fields
| Input Field | Description |
|---|---|
name - String!
|
Name of the create project Action object. |
teamId - ID!
|
ID of the team. |
externalObjectStorageId - ID!
|
ID of the external object storage used in this Action. |
externalObjectStoragePathInput - String!
|
The path inside the external object storage to retrieve the documents from. |
externalObjectStoragePathResult - String!
|
The path inside the external object storage to store the results to. |
projectTemplateId - ID!
|
ID of the project template used. |
assignments - [CreateProjectActionAssignmentInput!]!
|
Object that stores the assignment informations for this Action. |
additionalTagNames - [String!]
|
Tag names that will be attached to each of the projects. If the tag doesn't exist, it will be created; otherwise, it will be used. See Tag. |
numberOfLabelersPerProject - Int!
|
The number of labelers assigned per project. |
numberOfReviewersPerProject - Int!
|
The number of reviewers assigned per project. |
numberOfLabelersPerDocument - Int!
|
The number of labelers assigned per document. |
conflictResolutionMode - ConflictResolutionMode!
|
Mode used to handle conflict. MANUAL or PEER_REVIEW |
consensus - Int!
|
The number of consensus needed to resolve a conflict. |
Example
{
"name": "xyz789",
"teamId": 4,
"externalObjectStorageId": "4",
"externalObjectStoragePathInput": "xyz789",
"externalObjectStoragePathResult": "abc123",
"projectTemplateId": "4",
"assignments": [CreateProjectActionAssignmentInput],
"additionalTagNames": ["abc123"],
"numberOfLabelersPerProject": 987,
"numberOfReviewersPerProject": 123,
"numberOfLabelersPerDocument": 987,
"conflictResolutionMode": "MANUAL",
"consensus": 123
}
CreateCustomAPIInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
endpointURL - String!
|
|
purpose - CustomAPIPurpose!
|
|
secret - String!
|
Example
{
"name": "xyz789",
"endpointURL": "xyz789",
"purpose": "ASR_API",
"secret": "xyz789"
}
CreateDocumentInput
Fields
| Input Field | Description |
|---|---|
document - DocumentDetailInput!
|
Required. The main document to be labeled. For OCR / Audio / BBox labeling, this contains the media file. |
extras - [DocumentDetailInput!]
|
Additional info supplementing the main document. For OCR / Audio projects, a transcription is required. For Document or BBox labeling, an answerfile is optional. |
textLanguage - String
|
Optional. Sets the language of the document. |
Example
{
"document": DocumentDetailInput,
"extras": [DocumentDetailInput],
"textLanguage": "xyz789"
}
CreateExternalObjectStorageInput
Fields
| Input Field | Description |
|---|---|
cloudService - ObjectStorageClientName!
|
|
bucketId - String
|
|
bucketName - String!
|
|
credentials - ExternalObjectStorageCredentialsInput!
|
|
securityToken - String
|
Required for Google Cloud Storage only. Security token to authorize access to the bucket when connecting it to another workspace. |
teamId - ID!
|
Example
{
"cloudService": "AWS_S3",
"bucketId": "abc123",
"bucketName": "xyz789",
"credentials": ExternalObjectStorageCredentialsInput,
"securityToken": "xyz789",
"teamId": "4"
}
CreateFileTransformerInput
Fields
| Input Field | Description |
|---|---|
teamId - ID!
|
|
name - String!
|
|
purpose - FileTransformerPurpose!
|
Example
{
"teamId": "4",
"name": "xyz789",
"purpose": "IMPORT"
}
CreateGroundTruthInput
CreateGroundTruthSetInput
CreateLabelSetInput
Fields
| Input Field | Description |
|---|---|
name - String
|
The labelset's name. |
index - Int
|
The labelset's zero-based index in a project. Each project can have up to 5 labelset. |
tagItems - [TagItemInput!]!
|
List of labelset items to be added under the new labelset. |
arrowLabelRequired - Boolean
|
Optional. Defaults to false. |
Example
{
"name": "abc123",
"index": 123,
"tagItems": [TagItemInput],
"arrowLabelRequired": false
}
CreateLabelSetTemplateInput
Description
Representation of a new labelset template.
Fields
| Input Field | Description |
|---|---|
name - String!
|
Required. The labelset template's name. |
teamId - ID
|
Optional. Associate the labelset template to the specified team. See type Team. |
questions - [LabelSetTemplateItemInput!]!
|
Required. The items to be added into the new labelset template. To create a token-based labelset template, put the list of labelset items under questions[0].config.options field. |
Example
{
"name": "xyz789",
"teamId": 4,
"questions": [LabelSetTemplateItemInput]
}
CreateLlmApplicationConfigurationInput
Example
{
"name": "xyz789",
"teamId": "4",
"llmRagConfigId": "4"
}
CreateLlmVectorStoreInput
Description
Configuration parameter for llm vector store creation.
Fields
| Input Field | Description |
|---|---|
name - String!
|
Required. Set the llm vector store name. |
teamId - ID!
|
|
provider - GqlLlmVectorStoreProvider!
|
|
llmEmbeddingModelId - ID
|
|
chunkSize - Int
|
|
overlap - Int
|
|
collectionId - String
|
|
authenticationScheme - GqlLlmVectorStoreAuthenticationScheme
|
|
username - String
|
|
password - String
|
|
questions - [QuestionInput!]
|
Optional. Set the questions for LLM Vector Store. |
dimension - Int
|
Example
{
"name": "xyz789",
"teamId": "4",
"provider": "DATASAUR",
"llmEmbeddingModelId": 4,
"chunkSize": 987,
"overlap": 123,
"collectionId": "abc123",
"authenticationScheme": "BASIC",
"username": "abc123",
"password": "xyz789",
"questions": [QuestionInput],
"dimension": 123
}
CreateNewPasswordInput
Fields
| Input Field | Description |
|---|---|
newPassword - String!
|
|
confirmNewPassword - String!
|
|
totpCode - TotpCodeInput
|
Example
{
"newPassword": "abc123",
"confirmNewPassword": "xyz789",
"totpCode": TotpCodeInput
}
CreatePersonalTagInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
Example
{"name": "xyz789"}
CreateProjectAction
Description
A create project Action object.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the create project Action object. |
name - String!
|
Name of the create project Action object. |
teamId - ID!
|
ID of the team. |
appVersion - String!
|
Version of Datasaur app when create project Action is created. |
creatorId - ID!
|
ID of the user creating this Action. |
lastRunAt - String
|
The time this Action is last ran. |
lastFinishedAt - String
|
The time this Action is last finished. |
externalObjectStorageId - ID
|
ID of the external object storage used in this Action. |
externalObjectStorage - ExternalObjectStorage
|
External object storage object used in this Action. |
externalObjectStoragePathInput - String!
|
The path inside the external object storage to retrieve the documents from. |
externalObjectStoragePathResult - String!
|
The path inside the external object storage to store the results into. |
projectTemplateId - ID!
|
ID of the project template used. |
projectTemplate - ProjectTemplate!
|
The project template object used. |
assignments - [CreateProjectActionAssignment!]!
|
Object that stores the assignment informations for this Action. |
additionalTagNames - [String!]
|
Tag names that will be attached to each of the projects. If the tag doesn't exist, it will be created; otherwise, it will be used. See Tag. |
numberOfLabelersPerProject - Int!
|
The number of labelers assigned per project. |
numberOfReviewersPerProject - Int!
|
The number of reviewers assigned per project. |
numberOfLabelersPerDocument - Int!
|
The number of labelers assigned per document. |
conflictResolutionMode - ConflictResolutionMode!
|
Mode used to handle conflict. MANUAL or PEER_REVIEW |
consensus - Int!
|
The number of consensus needed to resolve a conflict. |
warnings - [CreateProjectActionWarning!]!
|
Warning in case some of the referred entities got deleted, i.e. assignees, external object storage, or project template. |
Example
{
"id": 4,
"name": "abc123",
"teamId": "4",
"appVersion": "xyz789",
"creatorId": "4",
"lastRunAt": "xyz789",
"lastFinishedAt": "xyz789",
"externalObjectStorageId": "4",
"externalObjectStorage": ExternalObjectStorage,
"externalObjectStoragePathInput": "abc123",
"externalObjectStoragePathResult": "xyz789",
"projectTemplateId": "4",
"projectTemplate": ProjectTemplate,
"assignments": [CreateProjectActionAssignment],
"additionalTagNames": ["abc123"],
"numberOfLabelersPerProject": 123,
"numberOfReviewersPerProject": 123,
"numberOfLabelersPerDocument": 987,
"conflictResolutionMode": "MANUAL",
"consensus": 123,
"warnings": ["ASSIGNED_LABELER_NOT_MEET_CONSENSUS"]
}
CreateProjectActionAssignment
Description
A create project Action assignment object.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the create project Action assignment object. |
actionId - ID!
|
ID of the create project Action. |
role - ProjectAssignmentRole!
|
Role of the team member in the project created. |
teamMember - TeamMember!
|
A TeamMember object of a user related to a team. |
teamMemberId - String!
|
ID of the TeamMember object |
totalAssignedAsLabeler - Int!
|
The total number of labelers assigned to the created project |
totalAssignedAsReviewer - Int!
|
The total number of reviewers assigned to the created project |
Example
{
"id": "4",
"actionId": "4",
"role": "LABELER",
"teamMember": TeamMember,
"teamMemberId": "abc123",
"totalAssignedAsLabeler": 123,
"totalAssignedAsReviewer": 123
}
CreateProjectActionAssignmentInput
Description
Parameters for assigning a create project Action.
Fields
| Input Field | Description |
|---|---|
teamMemberId - String!
|
|
role - ProjectAssignmentRole!
|
Example
{
"teamMemberId": "xyz789",
"role": "LABELER"
}
CreateProjectActionPaginationInput
Description
Parameters create project automation paginated query.
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
page - OffsetPageInput
|
|
filter - CreateProjectActionRunFilterInput
|
|
sort - [SortInput!]
|
Example
{
"cursor": "abc123",
"page": OffsetPageInput,
"filter": CreateProjectActionRunFilterInput,
"sort": [SortInput]
}
CreateProjectActionRun
Description
Parameters for a create project Action run.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of create project Action run object. |
actionId - ID!
|
ID of the create project Action. |
status - JobStatus!
|
Status of the job running the Action. |
currentAppVersion - String!
|
Version of Datasaur app when create project Action is ran. |
triggeredByUserId - ID!
|
ID of the user triggering this Action. |
triggeredBy - User!
|
The user triggering this Action. |
startAt - String!
|
Time when the Action is started. |
endAt - String
|
Time when the Action is finished. |
totalSuccess - Int!
|
Total number of projects successfully created |
totalFailure - Int!
|
Total number of projects unsuccessfully created |
externalObjectStorageId - String!
|
ID of the external object storage used in this Action. |
externalObjectStoragePathInput - String!
|
The path inside the external object storage to retrieve the documents from. |
externalObjectStoragePathResult - String!
|
The path inside the external object storage to store the results to. |
projectTemplate - Snapshot!
|
The project template object used. |
assignments - [Snapshot!]!
|
Object that stores the assignment informations for this Action. |
numberOfLabelersPerProject - Int!
|
The number of labelers assigned per project. |
numberOfReviewersPerProject - Int!
|
The number of reviewers assigned per project. |
numberOfLabelersPerDocument - Int!
|
The number of labelers assigned per document. |
conflictResolutionMode - ConflictResolutionMode!
|
Mode used to handle conflict. MANUAL or PEER_REVIEW |
consensus - Int!
|
The number of consensus needed to resolve a conflict. |
Example
{
"id": 4,
"actionId": 4,
"status": "DELIVERED",
"currentAppVersion": "xyz789",
"triggeredByUserId": 4,
"triggeredBy": User,
"startAt": "abc123",
"endAt": "xyz789",
"totalSuccess": 987,
"totalFailure": 123,
"externalObjectStorageId": "abc123",
"externalObjectStoragePathInput": "abc123",
"externalObjectStoragePathResult": "abc123",
"projectTemplate": Snapshot,
"assignments": [Snapshot],
"numberOfLabelersPerProject": 987,
"numberOfReviewersPerProject": 987,
"numberOfLabelersPerDocument": 987,
"conflictResolutionMode": "MANUAL",
"consensus": 987
}
CreateProjectActionRunDetail
Description
Parameters for a create project Action run detail.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the create project Action run detail. |
status - ActionRunDetailStatus!
|
Status of a single project processed in the Action. |
runId - ID!
|
ID of the create project Action run. |
startAt - String!
|
Time when the Action is started. |
endAt - String!
|
Time when the Action is finished. |
error - DatasaurError
|
Error from the failed project creation. |
project - Snapshot
|
The created project object. |
projectPath - String!
|
The created project path. |
documentNames - [String!]!
|
Document names used to create the project. |
Example
{
"id": 4,
"status": "SUCCESS",
"runId": "4",
"startAt": "xyz789",
"endAt": "xyz789",
"error": DatasaurError,
"project": Snapshot,
"projectPath": "abc123",
"documentNames": ["xyz789"]
}
CreateProjectActionRunDetailFilterInput
CreateProjectActionRunDetailPaginatedResponse
Description
Paginated list of create project Action run details.
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [CreateProjectActionRunDetail!]!
|
Example
{
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [CreateProjectActionRunDetail]
}
CreateProjectActionRunDetailPaginationInput
Description
Parameters create project automation paginated query.
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
page - OffsetPageInput
|
|
filter - CreateProjectActionRunDetailFilterInput
|
|
sort - [SortInput!]
|
Example
{
"cursor": "xyz789",
"page": OffsetPageInput,
"filter": CreateProjectActionRunDetailFilterInput,
"sort": [SortInput]
}
CreateProjectActionRunFilterInput
CreateProjectActionRunPaginatedResponse
Description
Paginated list of create project Action activites.
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [CreateProjectActionRun!]!
|
Example
{
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [CreateProjectActionRun]
}
CreateProjectActionWarning
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSIGNED_LABELER_NOT_MEET_CONSENSUS"
CreateProjectMetadataItemInput
CreateProjectTemplateInput
CreateQuestionSetInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
items - [QuestionSetItemInput!]!
|
|
teamId - String
|
Example
{
"name": "abc123",
"items": [QuestionSetItemInput],
"teamId": "abc123"
}
CreateSamlTenantInput
CreateTagInput
CreateTagsIfNotExistInput
Fields
| Input Field | Description |
|---|---|
teamId - ID
|
|
names - [String!]!
|
Example
{
"teamId": "4",
"names": ["xyz789"]
}
CreateTeamInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
members - [TeamMemberInput!]
|
|
logo - Upload
|
Example
{
"name": "xyz789",
"members": [TeamMemberInput],
"logo": Upload
}
CreateTextDocumentInput
Description
To provide the document, choose one of these fields:
filefileUrlexternalImportableUrlexternalObjectStorageFileKeyobjectKey
To provide the answer file (for pre-labeled), choose one of these fields:
answerFileanswerExternalImportableUrlexternalObjectStorageAnswerFileKeyanswerObjectKey
Fields
| Input Field | Description |
|---|---|
fileName - String!
|
Required. File Name. It affects the File Extension and exported file. |
name - String
|
Optional. Document Name. It affects the document title section. |
file - Upload
|
Optional. Fill this one if you want to directly upload a file. |
fileUrl - String
|
Optional. Only for Doc Labeling project. Fill this one if you want to use a publicly accessible file without upload. The user will be able to access the file directly each time the document is loaded through the browser. |
externalImportableUrl - String
|
Optional. Fill this one if you want Datasaur to download your file from the URL. Unlike fileUrl, you can ignore the externalImportableUrl as soon as the project is successfully created since the file will be uploaded to Datasaur's server. |
externalObjectStorageFileKey - String
|
Optional. Fill this one if you want to select a file directly from your own object storage. |
objectKey - String
|
Optional. Fill this with the objectKey returned by uploading the file via upload proxy REST API. |
answerFileName - String
|
Optional. Specific for Doc Labeling. Only if you use a pre-labeled file. |
answerFile - Upload
|
Optional. Specific for Doc Labeling. Fill this one if you want to upload a pre-labeled file. |
answerExternalImportableUrl - String
|
Optional. Specific for Doc Labeling. Fill this one if you want Datasaur to download your pre-labeled file from the URL. You can ignore the answerExternalImportableUrl as soon as the project is successfully created since the pre-labeled data is already processed. |
externalObjectStorageAnswerFileKey - String
|
Optional. Specific for Doc Labeling. Fill this one if you want to select a pre-labeled file directly from your own object storage. |
answerObjectKey - String
|
Optional. Specific for Doc Labeling. Fill this with the objectKey returned by uploading the answer file via upload proxy REST API. |
settings - SettingsInput
|
Optional. Set the configuration of this specific document. |
type - TextDocumentType
|
Optional. It uses the same type as in LaunchTextProjectInput. |
extraFiles - [Upload!]
|
|
docFileOptions - DocFileOptionsInput
|
Only used in Row Based Labeling and Document Based Labeling. |
questionFile - Upload
|
Optional. Only for Row and Doc Labeling. Upload a file containing questions for this document. |
questionFileName - String
|
Optional. Only for Row and Doc Labeling. The name of the question file. |
fileTransformerId - ID
|
Optional. File transformer ID to transform your input file to a format that is accepted by Datasaur. |
customTextExtractionAPIId - ID
|
Optional. Only for Doc Labeling. To extract transcription from the file. |
orderInProject - Int
|
Deprecated. By default, documents will be sorted by filename No longer supported |
customScriptId - ID
|
Deprecated. Please use field fileTransformerId instead. No longer supported
|
Example
{
"fileName": "abc123",
"name": "abc123",
"file": Upload,
"fileUrl": "abc123",
"externalImportableUrl": "xyz789",
"externalObjectStorageFileKey": "xyz789",
"objectKey": "xyz789",
"answerFileName": "abc123",
"answerFile": Upload,
"answerExternalImportableUrl": "abc123",
"externalObjectStorageAnswerFileKey": "abc123",
"answerObjectKey": "abc123",
"settings": SettingsInput,
"type": "POS",
"extraFiles": [Upload],
"docFileOptions": DocFileOptionsInput,
"questionFile": Upload,
"questionFileName": "xyz789",
"fileTransformerId": "4",
"customTextExtractionAPIId": "4",
"orderInProject": 123,
"customScriptId": "4"
}
CreateUserInput
Fields
| Input Field | Description |
|---|---|
name - String
|
|
username - String
|
|
email - String!
|
|
password - String!
|
|
googleId - String
|
|
oktaId - String
|
|
amazonId - String
|
|
phoneNumber - String
|
|
companyName - String
|
|
passwordConfirmation - String!
|
|
redirect - String
|
|
betaKey - String
|
|
invitationKey - String
|
|
recaptcha - String
|
|
signUpParams - SignUpParamsInput
|
Example
{
"name": "abc123",
"username": "abc123",
"email": "xyz789",
"password": "abc123",
"googleId": "abc123",
"oktaId": "xyz789",
"amazonId": "xyz789",
"phoneNumber": "xyz789",
"companyName": "xyz789",
"passwordConfirmation": "xyz789",
"redirect": "abc123",
"betaKey": "abc123",
"invitationKey": "abc123",
"recaptcha": "xyz789",
"signUpParams": SignUpParamsInput
}
CreationSettingsInput
Fields
| Input Field | Description |
|---|---|
viewer - ViewerInput
|
Configures what editor will be used. Required for Token and Row Labeling. |
fileTransformerId - ID
|
|
tokenizer - String
|
|
sentenceSeparator - String
|
For Span labeling, with TXT or TSV IOB files.
|
transcriptConfig - TranscriptConfigInput
|
|
enableTabularMarkdownParsing - Boolean
|
|
firstRowAsHeader - Boolean
|
|
customHeaderColumns - [HeaderColumnInput!]
|
|
anonymizationConfig - AnonymizationConfigInput
|
Optional. When not provided, anonymization is disabled. |
splitDocumentConfig - SplitDocumentOptionInput
|
Optional. Specific for Token and Row Labeling. Set the document splitting behavior. |
Example
{
"viewer": ViewerInput,
"fileTransformerId": 4,
"tokenizer": "xyz789",
"sentenceSeparator": "abc123",
"transcriptConfig": TranscriptConfigInput,
"enableTabularMarkdownParsing": false,
"firstRowAsHeader": false,
"customHeaderColumns": [HeaderColumnInput],
"anonymizationConfig": AnonymizationConfigInput,
"splitDocumentConfig": SplitDocumentOptionInput
}
CronExpression
Example
CronExpression
CursorPageInput
CustomAPI
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
teamId - ID!
|
|
endpointURL - String!
|
|
name - String!
|
|
purpose - CustomAPIPurpose!
|
Example
{
"id": 4,
"teamId": 4,
"endpointURL": "xyz789",
"name": "abc123",
"purpose": "ASR_API"
}
CustomAPIPurpose
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASR_API"
CustomReportBuilderInput
Fields
| Input Field | Description |
|---|---|
metricsGroupId - ID!
|
Required. The metrics group table ID to export. |
selectedSegments - [CustomReportClientSegment!]!
|
Required. The segments to export. See CustomReportClientSegment. |
selectedMetrics - [CustomReportMetric!]!
|
Required. The metrics to export. See CustomReportMetric. |
method - GqlExportMethod
|
Optional. How the export result is delivered. |
filters - [CustomReportFilter!]
|
Optional. The filters. See CustomReportFilter. |
dataSet - CustomReportDataSet
|
Optional. The data set. |
Example
{
"metricsGroupId": 4,
"selectedSegments": ["DATE"],
"selectedMetrics": ["LABELS_ACCURACY"],
"method": "FILE_STORAGE",
"filters": [CustomReportFilter],
"dataSet": "METABASE"
}
CustomReportClientSegment
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DATE"
CustomReportDataSet
Values
| Enum Value | Description |
|---|---|
|
|
METABASE is no longer supported. Please use ELASTIC. |
|
|
Example
"METABASE"
CustomReportFilter
Fields
| Input Field | Description |
|---|---|
strategy - CustomReportFilterStrategy!
|
|
field - CustomReportFilterColumn!
|
|
value - String!
|
Example
{
"strategy": "CONTAINS",
"field": "DATE",
"value": "xyz789"
}
CustomReportFilterColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DATE"
CustomReportFilterStrategy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CONTAINS"
CustomReportMetric
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"LABELS_ACCURACY"
CustomReportMetricsGroupTable
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
description - String
|
|
clientSegments - [CustomReportClientSegment!]!
|
|
metrics - [CustomReportMetric!]!
|
|
filterStrategies - [CustomReportFilterStrategy!]!
|
Example
{
"id": 4,
"name": "abc123",
"description": "xyz789",
"clientSegments": ["DATE"],
"metrics": ["LABELS_ACCURACY"],
"filterStrategies": ["CONTAINS"]
}
CustomReportPreviewData
Fields
| Field Name | Description |
|---|---|
rows - [CustomReportRowScalar!]
|
Example
{"rows": [CustomReportRowScalar]}
CustomReportRowScalar
Example
CustomReportRowScalar
DataProgramming
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
provider - DataProgrammingProvider!
|
|
projectId - ID!
|
|
kind - ProjectKind!
|
|
labelsSignature - String!
|
|
labels - [DataProgrammingLabel!]!
|
|
createdAt - String!
|
|
updatedAt - String!
|
|
lastGetPredictionsAt - String
|
Example
{
"id": "4",
"provider": "SNORKEL",
"projectId": 4,
"kind": "DOCUMENT_BASED",
"labelsSignature": "abc123",
"labels": [DataProgrammingLabel],
"createdAt": "xyz789",
"updatedAt": "xyz789",
"lastGetPredictionsAt": "xyz789"
}
DataProgrammingLabel
DataProgrammingLabelInput
DataProgrammingLabelingFunctionAnalysis
DataProgrammingLibraries
Fields
| Field Name | Description |
|---|---|
libraries - [String!]!
|
Example
{"libraries": ["abc123"]}
DataProgrammingProvider
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SNORKEL"
DatasaurApp
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NLP"
DatasaurDinamicRowBased
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
projectId - ID!
|
|
provider - DatasaurDinamicRowBasedProvider!
|
|
inputColumnIds - [Int!]!
|
|
questionColumnId - Int!
|
|
providerSetting - ProviderSetting
|
|
modelMetadata - ModelMetadata
|
|
trainingJobId - ID
|
|
createdAt - String!
|
|
updatedAt - String!
|
Example
{
"id": "4",
"projectId": "4",
"provider": "HUGGINGFACE",
"inputColumnIds": [987],
"questionColumnId": 987,
"providerSetting": ProviderSetting,
"modelMetadata": ModelMetadata,
"trainingJobId": "4",
"createdAt": "abc123",
"updatedAt": "abc123"
}
DatasaurDinamicRowBasedProvider
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"HUGGINGFACE"
DatasaurDinamicRowBasedProviders
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
provider - DatasaurDinamicRowBasedProvider!
|
Example
{
"name": "abc123",
"provider": "HUGGINGFACE"
}
DatasaurDinamicTokenBased
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
projectId - ID!
|
|
provider - DatasaurDinamicTokenBasedProvider!
|
|
targetLabelSetIndex - Int!
|
|
providerSetting - ProviderSetting
|
|
modelMetadata - ModelMetadata
|
|
trainingJobId - ID
|
|
createdAt - String!
|
|
updatedAt - String!
|
Example
{
"id": 4,
"projectId": "4",
"provider": "HUGGINGFACE",
"targetLabelSetIndex": 987,
"providerSetting": ProviderSetting,
"modelMetadata": ModelMetadata,
"trainingJobId": "4",
"createdAt": "xyz789",
"updatedAt": "abc123"
}
DatasaurDinamicTokenBasedProvider
Values
| Enum Value | Description |
|---|---|
|
|
Example
"HUGGINGFACE"
DatasaurDinamicTokenBasedProviders
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
provider - DatasaurDinamicTokenBasedProvider!
|
Example
{
"name": "abc123",
"provider": "HUGGINGFACE"
}
DatasaurError
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
message - String
|
|
args - DatasaurErrorArgs!
|
Example
{
"code": "xyz789",
"message": "abc123",
"args": DatasaurErrorArgs
}
DatasaurErrorArgs
Example
DatasaurErrorArgs
DatasaurPredictive
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
projectId - ID!
|
|
provider - DatasaurPredictiveProvider!
|
|
inputColumnIds - [Int!]!
|
|
questionColumnId - Int!
|
|
providerSetting - ProviderSetting
|
|
modelMetadata - ModelMetadata
|
|
trainingJobId - ID
|
|
createdAt - String!
|
|
updatedAt - String!
|
Example
{
"id": "4",
"projectId": 4,
"provider": "SETFIT",
"inputColumnIds": [987],
"questionColumnId": 123,
"providerSetting": ProviderSetting,
"modelMetadata": ModelMetadata,
"trainingJobId": "4",
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
DatasaurPredictiveProvider
Values
| Enum Value | Description |
|---|---|
|
|
Example
"SETFIT"
DatasaurPredictiveProviders
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
provider - DatasaurPredictiveProvider!
|
Example
{"name": "xyz789", "provider": "SETFIT"}
DatasaurPredictiveReadyForTrainingInput
DateTime
Example
"2007-12-03T10:15:30Z"
DateTimeDefaultValue
Values
| Enum Value | Description |
|---|---|
|
|
Example
"NOW"
DaysCreatedInput
DefaultExtension
Fields
| Field Name | Description |
|---|---|
kind - ProjectKind!
|
|
labelerExtensions - [DefaultExtensionElement!]!
|
|
reviewerExtensions - [DefaultExtensionElement!]!
|
Example
{
"kind": "DOCUMENT_BASED",
"labelerExtensions": [DefaultExtensionElement],
"reviewerExtensions": [DefaultExtensionElement]
}
DefaultExtensionElement
Fields
| Field Name | Description |
|---|---|
extensionId - ExtensionID!
|
Example
{"extensionId": "AUTO_LABEL_TOKEN_EXTENSION_ID"}
DefaultExtensionElementInput
Fields
| Input Field | Description |
|---|---|
extensionId - ExtensionID!
|
Example
{"extensionId": "AUTO_LABEL_TOKEN_EXTENSION_ID"}
DefaultExtensionInput
Fields
| Input Field | Description |
|---|---|
kind - ProjectKind!
|
|
labelerExtensions - [DefaultExtensionElementInput!]!
|
|
reviewerExtensions - [DefaultExtensionElementInput!]!
|
Example
{
"kind": "DOCUMENT_BASED",
"labelerExtensions": [DefaultExtensionElementInput],
"reviewerExtensions": [DefaultExtensionElementInput]
}
DefaultLabelingFunctionTemplateType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"WITH_SPECIFIC_TARGET_LABEL"
DefinitionEntry
DeleteExtensionElementInput
DeleteLabelErrorDetectionRowBasedSuggestionByIdsInput
Fields
| Input Field | Description |
|---|---|
labelErrorDetectionSuggestionIds - [ID!]!
|
Example
{"labelErrorDetectionSuggestionIds": [4]}
DeleteLabelingFunctionsInput
DeleteLabelsOnTextDocumentInput
DeleteLabelsOnTextDocumentResult
Fields
| Field Name | Description |
|---|---|
affectedChunks - [TextChunk!]!
|
|
deletedTokenLabels - [TextLabel!]!
|
|
statistic - TextDocumentStatistic!
|
|
lastSavedAt - String!
|
Example
{
"affectedChunks": [TextChunk],
"deletedTokenLabels": [TextLabel],
"statistic": TextDocumentStatistic,
"lastSavedAt": "xyz789"
}
DeleteProjectInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
Example
{"projectId": "4"}
DeleteSentenceResult
Fields
| Field Name | Description |
|---|---|
document - TextDocument!
|
|
updatedCell - Cell!
|
|
addedLabels - [TextLabel!]!
|
|
deletedLabels - [TextLabel!]!
|
Example
{
"document": TextDocument,
"updatedCell": Cell,
"addedLabels": [TextLabel],
"deletedLabels": [TextLabel]
}
DeleteTextDocumentResult
Fields
| Field Name | Description |
|---|---|
id - ID
|
Example
{"id": "4"}
DictionaryResult
Fields
| Field Name | Description |
|---|---|
word - String!
|
|
lang - String!
|
|
entries - [DictionaryResultEntry]!
|
Example
{
"word": "abc123",
"lang": "abc123",
"entries": [DictionaryResultEntry]
}
DictionaryResultEntry
Fields
| Field Name | Description |
|---|---|
lexicalCategory - String!
|
|
definitions - [DefinitionEntry!]!
|
Example
{
"lexicalCategory": "abc123",
"definitions": [DefinitionEntry]
}
DocFileOptionsInput
Fields
| Input Field | Description |
|---|---|
customHeaderColumns - [HeaderColumnInput!]
|
Override column headers by using these values. |
firstRowAsHeader - Boolean
|
If the csv or xlsx file has header as the first row. Datasaur will use it as the column header for Row Based Labeling. |
Example
{
"customHeaderColumns": [HeaderColumnInput],
"firstRowAsHeader": false
}
DocLabelObject
Fields
| Field Name | Description |
|---|---|
labels - [String!]!
|
|
subLabels - [DocLabelObject!]
|
|
objectLabels - [LabelObject!]
|
Example
{
"labels": ["abc123"],
"subLabels": [DocLabelObject],
"objectLabels": [LabelObject]
}
DocLabelObjectInput
Fields
| Input Field | Description |
|---|---|
labels - [String!]!
|
|
subLabels - [DocLabelObjectInput!]
|
|
objectLabels - [LabelObjectInput!]
|
Example
{
"labels": ["abc123"],
"subLabels": [DocLabelObjectInput],
"objectLabels": [LabelObjectInput]
}
DocumentAnswer
Fields
| Field Name | Description |
|---|---|
documentId - ID!
|
|
answers - AnswerScalar!
|
|
metadata - [AnswerMetadata!]!
|
|
updatedAt - DateTime
|
Example
{
"documentId": 4,
"answers": AnswerScalar,
"metadata": [AnswerMetadata],
"updatedAt": "2007-12-03T10:15:30Z"
}
DocumentAssignmentInput
Fields
| Input Field | Description |
|---|---|
teamMemberId - ID
|
One of teamMemberId or email must be provided. See query getTeamMembers to get teamMemberIds. |
email - String
|
One of teamMemberId or email must be provided. |
documents - [DocumentFileNameWithPart!]
|
List of documents to be assigned. |
role - ProjectAssignmentRole
|
The team member's role in the document. |
Example
{
"teamMemberId": 4,
"email": "abc123",
"documents": [DocumentFileNameWithPart],
"role": "LABELER"
}
DocumentCompletionState
DocumentDetailInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
Required. Sets the document name in Datasaur. Must be unique within a project. |
externalUrl - String
|
Select this if the document is available via URL publicly. |
objectKey - String
|
Select this if the document is in an object storage. To obtain the correct object key, see generateFileUrls. |
Example
{
"name": "abc123",
"externalUrl": "abc123",
"objectKey": "abc123"
}
DocumentFileNameWithPart
Fields
| Input Field | Description |
|---|---|
fileName - String!
|
Required. The uploaded document filename. |
part - Int!
|
Required. Zero-index numbering up to the limit set in SplitDocumentOptionInput.number. Example: if the limit is 3, part should be 0, 1 and 2. Set this to 0 and SplitDocumentOptionInput to null to skip splitting the document. |
Example
{"fileName": "xyz789", "part": 123}
DocumentFinalReport
Fields
| Field Name | Description |
|---|---|
rowFinalReports - [RowFinalReport!]
|
|
cabinet - Cabinet!
|
|
document - TextDocument!
|
|
finalReport - FinalReport!
|
|
teamMember - TeamMember
|
Example
{
"rowFinalReports": [RowFinalReport],
"cabinet": Cabinet,
"document": TextDocument,
"finalReport": FinalReport,
"teamMember": TeamMember
}
DocumentMeta
Example
{
"id": 123,
"cabinetId": 987,
"name": "abc123",
"width": "xyz789",
"displayed": true,
"labelerRestricted": true,
"rowQuestionIndex": 123
}
DocumentMetaInput
Fields
| Input Field | Description |
|---|---|
id - Int!
|
|
delete - Boolean
|
|
name - String
|
|
description - String
|
Deprecated. The value in this field will be ignored No longer used. The value in this field will be ignored. |
required - Boolean
|
Deprecated. The value in this field will be ignored No longer used. The value in this field will be ignored. |
multipleChoice - Boolean
|
Deprecated. The value in this field will be ignored No longer used. The value in this field will be ignored. |
displayed - Boolean
|
|
labelerRestricted - Boolean
|
|
options - [DocumentMetaOptionInput!]
|
Deprecated. The value in this field will be ignored No longer used. The value in this field will be ignored. |
type - QuestionType
|
Deprecated. The value in this field will be ignored No longer used. The value in this field will be ignored. |
width - String
|
Example
{
"id": 123,
"delete": false,
"name": "abc123",
"description": "abc123",
"required": true,
"multipleChoice": false,
"displayed": true,
"labelerRestricted": false,
"options": [DocumentMetaOptionInput],
"type": "DROPDOWN",
"width": "abc123"
}
DocumentMetaOptionInput
DocumentPredictionInput
DocumentSettingsInput
Fields
| Input Field | Description |
|---|---|
tokenBasedSettings - TokenBasedDocumentSettingsInput
|
|
rowBasedSettings - RowBasedDocumentSettingsInput
|
Example
{
"tokenBasedSettings": TokenBasedDocumentSettingsInput,
"rowBasedSettings": RowBasedDocumentSettingsInput
}
DriftThreshold
DropdownConfigOptions
DropdownConfigOptionsInput
EditLlmCustomModelInput
EditSentenceConflict
EditSentenceInput
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
|
sentenceId - Int!
|
|
signature - String!
|
|
text - String!
|
|
tokenizationMethod - TokenizationMethod
|
Example
{
"documentId": "4",
"sentenceId": 123,
"signature": "abc123",
"text": "xyz789",
"tokenizationMethod": "WINK"
}
EditSentenceResult
Fields
| Field Name | Description |
|---|---|
document - TextDocument!
|
|
updatedCell - Cell!
|
|
addedLabels - [GqlConflictable!]!
|
|
deletedLabels - [GqlConflictable!]!
|
|
previousSentences - [TextSentence!]!
|
|
addedBoundingBoxLabels - [BoundingBoxLabel!]!
|
|
deletedBoundingBoxLabels - [BoundingBoxLabel!]!
|
Example
{
"document": TextDocument,
"updatedCell": Cell,
"addedLabels": [GqlConflictable],
"deletedLabels": [GqlConflictable],
"previousSentences": [TextSentence],
"addedBoundingBoxLabels": [BoundingBoxLabel],
"deletedBoundingBoxLabels": [BoundingBoxLabel]
}
EnableExtensionElementsInput
EnableProjectExtensionElementsInput
Fields
| Input Field | Description |
|---|---|
cabinetId - ID!
|
|
elements - [EnableExtensionElementsInput!]!
|
Example
{
"cabinetId": "4",
"elements": [EnableExtensionElementsInput]
}
EnforceReviewerAutoLabelSettingsInput
EvaluationMetric
EvaluationMetricFilters
ExportChartMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"EMAIL"
ExportCommentType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMMENT"
ExportDeliveryStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DELIVERED"
ExportFileTransformerExecuteResult
Description
interface ExportFileTransformerExecuteResult { document: ExportedDocument! }
Example
ExportFileTransformerExecuteResult
ExportLlmEvaluationAutomatedInput
ExportRequestResult
Description
The result / payload received after initiating an export query.
Fields
| Field Name | Description |
|---|---|
exportId - ID!
|
The export process ID. Used to check the delivery status via getExportDeliveryStatus, getJob or getJobs. |
fileUrl - String
|
Link to download the export result. It should be used when choosing FILE_STORAGE method. If the URL returns 404, it means the export result has not been uploaded. Check the status by requesting getExportDeliveryStatus query. |
fileUrlExpiredAt - String
|
When exactly the fileUrl will be expired. |
queued - Boolean
|
Deprecated. All exports will be done async so it will be queued. No longer supported |
redirect - String
|
Deprecated. Since the DOWNLOAD method is also deprecated. No longer supported
|
Example
{
"exportId": 4,
"fileUrl": "xyz789",
"fileUrlExpiredAt": "xyz789",
"queued": true,
"redirect": "xyz789"
}
ExportTeamOverviewInput
Fields
| Input Field | Description |
|---|---|
teamId - String!
|
Required. The team ID to export. See getAllTeams. |
method - GqlExportMethod!
|
Required. How the export result is delivered. |
url - String
|
Optional. Use this field when you choose method CUSTOM_WEBHOOK. |
secret - String
|
Optional. Use this field when you choose method CUSTOM_WEBHOOK. |
Example
{
"teamId": "xyz789",
"method": "FILE_STORAGE",
"url": "abc123",
"secret": "abc123"
}
ExportTestProjectResultInput
Fields
| Input Field | Description |
|---|---|
projectId - String!
|
Required. The project ID to export. See getProjects. |
method - GqlExportMethod!
|
Required. How the export result is delivered. |
url - String
|
Optional. Use this field when you choose method CUSTOM_WEBHOOK. |
secret - String
|
Optional. Use this field when you choose method CUSTOM_WEBHOOK. |
externalFileStorageParameter - ExternalFileStorageInput
|
Optional. Use this field when you choose method EXTERNAL_FILE_STORAGE. |
externalObjectStorageParameter - ExternalObjectStorageInput
|
Optional. Use this field when you choose method EXTERNAL_OBJECT_STORAGE. |
Example
{
"projectId": "xyz789",
"method": "FILE_STORAGE",
"url": "xyz789",
"secret": "xyz789",
"externalFileStorageParameter": ExternalFileStorageInput,
"externalObjectStorageParameter": ExternalObjectStorageInput
}
ExportTextProjectDocumentInput
Fields
| Input Field | Description |
|---|---|
documentId - String!
|
Required. The document ID to export. See getCabinet. |
customScriptId - ID
|
Deprecated. Please use field fileTransformerId instead. No longer supported
|
fileTransformerId - ID
|
Optional. The file transformer to be used during the export process. Only applicable when format is CUSTOM. Defaults to null. |
format - String!
|
Required. The exported format depends on the project's task, please refer here. Use CUSTOM to export using your team's custom export file transformer, specified in fileTransformerId. |
fileName - String!
|
Required. The filename for the export result. |
method - GqlExportMethod!
|
Required. How the export result is delivered. |
url - String
|
Optional. Use this field when you choose method CUSTOM_WEBHOOK. |
secret - String
|
Optional. Use this field when you choose method CUSTOM_WEBHOOK. |
externalFileStorageParameter - ExternalFileStorageInput
|
Optional. Use this field when you choose method EXTERNAL_FILE_STORAGE. |
externalObjectStorageParameter - ExternalObjectStorageInput
|
Optional. Use this field when you choose method EXTERNAL_OBJECT_STORAGE. |
includedCommentType - [ExportCommentType!]
|
Optional. Use this field when you want to export comment and choose the CommentType which you want to export. |
maskPIIEntities - Boolean
|
Optional. Use this field when you want to export project with masking format. |
gcpMlUse - String
|
Optional. Used for GCP_VERTEX_AI_CSV export format. Available values: TEST, TRAINING, VALIDATION |
includeConflicted - Boolean
|
Optional. Set to true if you want to also include conflicted labels and/or answers. |
includeMediaFiles - Boolean
|
Optional. Set to true if you want to also export the media files. |
Example
{
"documentId": "xyz789",
"customScriptId": 4,
"fileTransformerId": 4,
"format": "xyz789",
"fileName": "xyz789",
"method": "FILE_STORAGE",
"url": "abc123",
"secret": "xyz789",
"externalFileStorageParameter": ExternalFileStorageInput,
"externalObjectStorageParameter": ExternalObjectStorageInput,
"includedCommentType": ["COMMENT"],
"maskPIIEntities": true,
"gcpMlUse": "xyz789",
"includeConflicted": false,
"includeMediaFiles": false
}
ExportTextProjectInput
Fields
| Input Field | Description |
|---|---|
projectIds - [ID!]!
|
Required. The project(s) to be exported. See getProjects. |
customScriptId - ID
|
Deprecated. Please use field fileTransformerId instead. No longer supported
|
fileTransformerId - ID
|
Optional. The file transformer to be used during the export process. Only applicable when format is CUSTOM. Defaults to null. |
role - Role
|
Required. Export project based on specified role. |
format - String!
|
Required. The exported format depends on the project's task, please refer here. Use CUSTOM to export using your team's custom export file transformer, specified in fileTransformerId. |
fileName - String!
|
Required. The filename for the export result. |
method - GqlExportMethod!
|
Required. How the export result is delivered. |
url - String
|
Optional. Use this field when you choose method CUSTOM_WEBHOOK. |
secret - String
|
Optional. Use this field when you choose method CUSTOM_WEBHOOK. |
externalFileStorageParameter - ExternalFileStorageInput
|
Optional. Use this field when you choose method EXTERNAL_FILE_STORAGE. |
externalObjectStorageParameter - ExternalObjectStorageInput
|
Optional. Use this field when you choose method EXTERNAL_OBJECT_STORAGE. |
includedCommentType - [ExportCommentType!]
|
Optional. Use this field when you want to export comment and choose the CommentType which you want to export. |
maskPIIEntities - Boolean
|
Optional. Use this field when you want to export project with masking format. |
filteredCabinetRole - Role
|
Optional. Use this field when you want to export cabinets of specified role |
gcpMlUse - String
|
Optional. Used for GCP_VERTEX_AI_CSV export format. Available values: TEST, TRAINING, VALIDATION |
includeConflicted - Boolean
|
Optional. Set to true if you want to also include conflicted labels and/or answers. |
includeMediaFiles - Boolean
|
Optional. Set to true if you want to also export the media files. |
Example
{
"projectIds": ["4"],
"customScriptId": 4,
"fileTransformerId": 4,
"role": "REVIEWER",
"format": "xyz789",
"fileName": "abc123",
"method": "FILE_STORAGE",
"url": "xyz789",
"secret": "xyz789",
"externalFileStorageParameter": ExternalFileStorageInput,
"externalObjectStorageParameter": ExternalObjectStorageInput,
"includedCommentType": ["COMMENT"],
"maskPIIEntities": false,
"filteredCabinetRole": "REVIEWER",
"gcpMlUse": "abc123",
"includeConflicted": false,
"includeMediaFiles": false
}
ExportableJSON
Example
ExportableJSON
Extension
ExtensionElement
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
enabled - Boolean!
|
|
extension - Extension!
|
|
height - Int!
|
|
order - Int!
|
|
setting - ExtensionElementSetting
|
Example
{
"id": "4",
"enabled": true,
"extension": Extension,
"height": 123,
"order": 123,
"setting": ExtensionElementSetting
}
ExtensionElementSetting
Fields
| Field Name | Description |
|---|---|
extensionId - ID
|
|
serviceProvider - GqlAutoLabelServiceProvider
|
|
apiURL - String
|
|
confidenceScore - Float
|
|
locked - Boolean
|
|
modelId - String
|
No longer supported |
apiToken - String
|
|
systemPrompt - String
|
|
userPrompt - String
|
|
temperature - String
|
|
topP - String
|
|
model - String
|
|
enableLabelingFunctionMultipleLabel - Boolean
|
|
endpointArn - String
|
No longer supported |
roleArn - String
|
No longer supported |
endpointAwsSagemakerArn - String
|
No longer supported |
awsSagemakerRoleArn - String
|
No longer supported |
externalId - String
|
|
namespace - String
|
|
inputColumns - [Int!]
|
|
questionColumn - Int
|
|
questionColumns - [Int!]
|
|
labelSetIndex - Int
|
|
options - ExtensionElementSettingOptions
|
|
bboxLabelSetId - String
|
Example
{
"extensionId": 4,
"serviceProvider": "CUSTOM",
"apiURL": "abc123",
"confidenceScore": 123.45,
"locked": true,
"modelId": "xyz789",
"apiToken": "abc123",
"systemPrompt": "xyz789",
"userPrompt": "xyz789",
"temperature": "xyz789",
"topP": "xyz789",
"model": "abc123",
"enableLabelingFunctionMultipleLabel": false,
"endpointArn": "abc123",
"roleArn": "abc123",
"endpointAwsSagemakerArn": "abc123",
"awsSagemakerRoleArn": "abc123",
"externalId": "xyz789",
"namespace": "xyz789",
"inputColumns": [123],
"questionColumn": 123,
"questionColumns": [123],
"labelSetIndex": 123,
"options": ExtensionElementSettingOptions,
"bboxLabelSetId": "xyz789"
}
ExtensionElementSettingInput
Fields
| Input Field | Description |
|---|---|
extensionId - ID!
|
|
serviceProvider - GqlAutoLabelServiceProvider
|
|
apiURL - String
|
No longer supported |
bboxLabelSetId - String
|
|
confidenceScore - Float
|
No longer supported |
modelId - String
|
No longer supported |
apiToken - String
|
|
systemPrompt - String
|
|
userPrompt - String
|
|
temperature - String
|
|
topP - String
|
|
model - String
|
|
enableLabelingFunctionMultipleLabel - Boolean
|
|
endpointArn - String
|
No longer supported |
roleArn - String
|
No longer supported |
endpointAwsSagemakerArn - String
|
No longer supported |
awsSagemakerRoleArn - String
|
No longer supported |
externalId - String
|
|
namespace - String
|
|
inputColumns - [Int!]
|
|
questionColumn - Int
|
|
questionColumns - [Int!]
|
|
labelSetIndex - Int
|
|
options - ExtensionElementSettingOptions
|
Example
{
"extensionId": "4",
"serviceProvider": "CUSTOM",
"apiURL": "xyz789",
"bboxLabelSetId": "xyz789",
"confidenceScore": 987.65,
"modelId": "xyz789",
"apiToken": "xyz789",
"systemPrompt": "abc123",
"userPrompt": "xyz789",
"temperature": "xyz789",
"topP": "xyz789",
"model": "xyz789",
"enableLabelingFunctionMultipleLabel": true,
"endpointArn": "abc123",
"roleArn": "abc123",
"endpointAwsSagemakerArn": "xyz789",
"awsSagemakerRoleArn": "xyz789",
"externalId": "abc123",
"namespace": "abc123",
"inputColumns": [987],
"questionColumn": 987,
"questionColumns": [123],
"labelSetIndex": 987,
"options": ExtensionElementSettingOptions
}
ExtensionElementSettingOptions
Example
ExtensionElementSettingOptions
ExtensionGroup
Fields
| Field Name | Description |
|---|---|
kind - ProjectKind!
|
|
extensions - [Extension!]!
|
Example
{"kind": "DOCUMENT_BASED", "extensions": [Extension]}
ExtensionID
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AUTO_LABEL_TOKEN_EXTENSION_ID"
ExternalFile
ExternalFileStorageInput
ExternalId
ExternalObjectStorage
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
cloudService - ObjectStorageClientName!
|
|
bucketId - String
|
|
bucketName - String!
|
|
credentials - ExternalObjectStorageCredentials!
|
|
securityToken - String
|
|
team - Team!
|
|
projects - [Project]
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
Example
{
"id": 4,
"cloudService": "AWS_S3",
"bucketId": "abc123",
"bucketName": "abc123",
"credentials": ExternalObjectStorageCredentials,
"securityToken": "abc123",
"team": Team,
"projects": [Project],
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
ExternalObjectStorageCredentials
Fields
| Field Name | Description |
|---|---|
roleArn - String
|
Required for AWS S3 only. Role ARN that has been assigned with policy to access the S3 bucket |
externalId - String
|
Required for AWS S3 only. External ID for the role |
serviceAccount - String
|
Required for Google Cloud Storage only. Service account that has been registered on the cloud storage bucket |
tenantId - String
|
Required for Azure Blob Storage only. Azure Active Directory Tenant ID |
storageContainerUrl - String
|
Required for Azure Blob Storage only. URL of the Blob Storage Container |
region - String
|
Required for OpenText IMS only. Region of the organization |
tenantUsername - String
|
Required for OpenText IMS only. Username of tenant's user/admin |
Example
{
"roleArn": "xyz789",
"externalId": "abc123",
"serviceAccount": "abc123",
"tenantId": "abc123",
"storageContainerUrl": "abc123",
"region": "xyz789",
"tenantUsername": "abc123"
}
ExternalObjectStorageCredentialsInput
Fields
| Input Field | Description |
|---|---|
roleArn - String
|
Required for AWS S3 only. Role ARN that has been assigned with policy to access the S3 bucket |
externalId - String
|
Required for AWS S3 only. External ID for the role |
serviceAccount - String
|
Required for Google Cloud Storage only. Service account that has been registered on the cloud storage bucket |
tenantId - String
|
Required for Azure Blob Storage only. Azure Active Directory Tenant ID |
storageContainerUrl - String
|
Required for Azure Blob Storage only. URL of the Blob Storage Container |
region - String
|
Required for OpenText IMS only. Region of the organization |
clientId - String
|
Required for OpenText IMS only. Service Confidential Client ID of the Application |
clientSecret - String
|
Required for OpenText IMS only. Service Client Secret of the Application |
tenantUsername - String
|
Required for OpenText IMS only. Username of tenant's user/admin |
tenantPassword - String
|
Required for OpenText IMS only. Password of the tenant for that specific user |
refreshToken - String
|
Required for Google Drive only. Refresh Token of the user |
redirectUri - String
|
Required for Google Drive only. Redirect uri that handle user authorization |
Example
{
"roleArn": "abc123",
"externalId": "xyz789",
"serviceAccount": "xyz789",
"tenantId": "xyz789",
"storageContainerUrl": "xyz789",
"region": "xyz789",
"clientId": "abc123",
"clientSecret": "xyz789",
"tenantUsername": "xyz789",
"tenantPassword": "xyz789",
"refreshToken": "xyz789",
"redirectUri": "abc123"
}
ExternalObjectStorageInput
Example
{
"externalObjectStorageId": "abc123",
"prefix": "xyz789"
}
FileTransformer
Example
{
"id": 4,
"name": "xyz789",
"content": "abc123",
"transpiled": "abc123",
"createdAt": "xyz789",
"updatedAt": "xyz789",
"language": "TYPESCRIPT",
"purpose": "IMPORT",
"readonly": false,
"externalId": "abc123",
"warmup": true
}
FileTransformerLanguage
Values
| Enum Value | Description |
|---|---|
|
|
Example
"TYPESCRIPT"
FileTransformerPurpose
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"IMPORT"
FileUrlInfo
FinalReport
Example
{
"totalAppliedLabels": 987,
"totalAcceptedLabels": 123,
"totalRejectedLabels": 987,
"totalResolvedLabels": 987,
"precision": 987.65,
"recall": 987.65
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
FloatOrString
Example
FloatOrString
FontSize
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"SMALL"
FontType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SANS_SERIF"
FreeTrialQuotaResponse
Fields
| Field Name | Description |
|---|---|
runPromptCurrentAmount - Int!
|
|
runPromptMaxAmount - Int!
|
|
runPromptUnit - String!
|
|
embedDocumentCurrentAmount - Int!
|
|
embedDocumentMaxAmount - Int!
|
|
embedDocumentUnit - String!
|
|
embedDocumentUrlCurrentAmount - Int!
|
|
embedDocumentUrlMaxAmount - Int!
|
|
embedDocumentUrlUnit - String!
|
|
llmEvaluationCurrentAmount - Int!
|
|
llmEvaluationMaxAmount - Int!
|
|
llmEvaluationUnit - String!
|
Example
{
"runPromptCurrentAmount": 123,
"runPromptMaxAmount": 123,
"runPromptUnit": "xyz789",
"embedDocumentCurrentAmount": 123,
"embedDocumentMaxAmount": 987,
"embedDocumentUnit": "xyz789",
"embedDocumentUrlCurrentAmount": 987,
"embedDocumentUrlMaxAmount": 987,
"embedDocumentUrlUnit": "xyz789",
"llmEvaluationCurrentAmount": 987,
"llmEvaluationMaxAmount": 123,
"llmEvaluationUnit": "xyz789"
}
GeneralWorkspaceSettings
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
editorFontType - FontType!
|
|
editorFontSize - FontSize!
|
|
editorLineSpacing - GeneralWorkspaceSettingsLineSpacing
|
|
editorLineSpacingRatio - Float!
|
|
showIndexBar - Boolean!
|
|
showLabels - GeneralWorkspaceSettingsShowLabels
|
|
keepLabelBoxOpenAfterRelabel - Boolean
|
|
jumpToNextDocumentOnSubmit - Boolean
|
|
jumpToNextDocumentOnDocumentCompleted - Boolean
|
|
jumpToNextSpanOnSubmit - Boolean
|
|
multipleSelectLabels - Boolean
|
Example
{
"id": "4",
"editorFontType": "SANS_SERIF",
"editorFontSize": "SMALL",
"editorLineSpacing": "DENSE",
"editorLineSpacingRatio": 987.65,
"showIndexBar": false,
"showLabels": "ALWAYS",
"keepLabelBoxOpenAfterRelabel": true,
"jumpToNextDocumentOnSubmit": true,
"jumpToNextDocumentOnDocumentCompleted": false,
"jumpToNextSpanOnSubmit": true,
"multipleSelectLabels": true
}
GeneralWorkspaceSettingsInput
Fields
| Input Field | Description |
|---|---|
editorFontType - FontType
|
|
editorFontSize - FontSize
|
|
editorLineSpacing - GeneralWorkspaceSettingsLineSpacing
|
|
editorLineSpacingRatio - Float
|
|
showIndexBar - Boolean
|
|
showLabels - GeneralWorkspaceSettingsShowLabels
|
|
keepLabelBoxOpenAfterRelabel - Boolean
|
|
jumpToNextDocumentOnSubmit - Boolean
|
|
jumpToNextDocumentOnDocumentCompleted - Boolean
|
|
jumpToNextSpanOnSubmit - Boolean
|
|
multipleSelectLabels - Boolean
|
Example
{
"editorFontType": "SANS_SERIF",
"editorFontSize": "SMALL",
"editorLineSpacing": "DENSE",
"editorLineSpacingRatio": 123.45,
"showIndexBar": true,
"showLabels": "ALWAYS",
"keepLabelBoxOpenAfterRelabel": true,
"jumpToNextDocumentOnSubmit": false,
"jumpToNextDocumentOnDocumentCompleted": true,
"jumpToNextSpanOnSubmit": true,
"multipleSelectLabels": false
}
GeneralWorkspaceSettingsLineSpacing
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DENSE"
GeneralWorkspaceSettingsShowLabels
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ALWAYS"
GenerateFileUrlsInput
Fields
| Input Field | Description |
|---|---|
fileNames - [String!]!
|
Example
{"fileNames": ["abc123"]}
GetAnalyticsPerformanceInput
Fields
| Input Field | Description |
|---|---|
teamId - ID!
|
|
userId - ID!
|
|
projectId - ID
|
|
reviewerDocumentId - ID
|
|
role - ProjectAssignmentRole!
|
Example
{
"teamId": "4",
"userId": 4,
"projectId": 4,
"reviewerDocumentId": 4,
"role": "LABELER"
}
GetBoundingBoxConflictListResult
Fields
| Field Name | Description |
|---|---|
upToDate - Boolean!
|
|
items - [ConflictBoundingBoxLabel!]!
|
Example
{"upToDate": false, "items": [ConflictBoundingBoxLabel]}
GetCellPositionsByMetadataFilter
Fields
| Input Field | Description |
|---|---|
metadata - [CellMetadataInput!]!
|
Filter Cells by metadata. The filtered Cell must have ALL the specified metadata. |
Example
{"metadata": [CellMetadataInput]}
GetCellPositionsByMetadataPaginatedInput
Fields
| Input Field | Description |
|---|---|
page - RangePageInput
|
Filter Cells whose line is within start (inclusive) and end (exclusive). Cell's line is 0-based indexed. |
filter - GetCellPositionsByMetadataFilter
|
Filter Cells by the specified parameters. |
Example
{
"page": RangePageInput,
"filter": GetCellPositionsByMetadataFilter
}
GetCellPositionsByMetadataPaginatedResponse
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
Total number of Cells that matches the applied filter. |
pageInfo - PageInfo!
|
|
nodes - [CellPositionWithOriginDocumentId!]!
|
List of Cell positions along with the origin document ID. See type CellPositionWithOriginDocumentId. |
Example
{
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [CellPositionWithOriginDocumentId]
}
GetCellsFilterInput
Fields
| Input Field | Description |
|---|---|
statuses - [CellStatus!]
|
Example
{"statuses": ["DISPLAYED"]}
GetCellsPaginatedInput
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
page - OffsetPageInput
|
|
filter - GetCellsFilterInput
|
Example
{
"cursor": "abc123",
"page": OffsetPageInput,
"filter": GetCellsFilterInput
}
GetCellsPaginatedResponse
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [CellScalar!]!
|
Example
{
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [CellScalar]
}
GetCommentsFilterInput
GetCommentsInput
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
page - OffsetPageInput
|
|
filter - GetCommentsFilterInput
|
|
sort - [SortInput!]
|
Example
{
"cursor": "abc123",
"page": OffsetPageInput,
"filter": GetCommentsFilterInput,
"sort": [SortInput]
}
GetCommentsResponse
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [Comment!]!
|
Example
{
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [Comment]
}
GetConfusionMatrixTablesInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
projectKinds - [ProjectKind!]!
|
|
caseId - String!
|
|
filters - EvaluationMetricFilters
|
Example
{
"projectId": "4",
"projectKinds": ["DOCUMENT_BASED"],
"caseId": "xyz789",
"filters": EvaluationMetricFilters
}
GetCurrentUserTeamMemberInput
Fields
| Input Field | Description |
|---|---|
teamId - ID!
|
Example
{"teamId": 4}
GetDataProgrammingInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
kind - ProjectKind!
|
|
provider - DataProgrammingProvider
|
|
labels - [DataProgrammingLabelInput!]!
|
Example
{
"projectId": "4",
"kind": "DOCUMENT_BASED",
"provider": "SNORKEL",
"labels": [DataProgrammingLabelInput]
}
GetDataProgrammingLabelingFunctionAnalysisInput
GetDataProgrammingPredictionsInput
Fields
| Input Field | Description |
|---|---|
dataProgrammingId - ID!
|
|
labelingFunctionIds - [ID!]
|
|
documents - [DocumentPredictionInput!]!
|
Example
{
"dataProgrammingId": 4,
"labelingFunctionIds": [4],
"documents": [DocumentPredictionInput]
}
GetDatasaurDinamicRowBasedInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
provider - DatasaurDinamicRowBasedProvider!
|
|
questionColumnId - Int!
|
Example
{
"projectId": "4",
"provider": "HUGGINGFACE",
"questionColumnId": 987
}
GetDatasaurDinamicTokenBasedInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
provider - DatasaurDinamicTokenBasedProvider!
|
|
targetLabelSetIndex - Int!
|
Example
{"projectId": 4, "provider": "HUGGINGFACE", "targetLabelSetIndex": 987}
GetDatasaurPredictiveInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
provider - DatasaurPredictiveProvider!
|
|
questionColumnId - Int!
|
Example
{"projectId": 4, "provider": "SETFIT", "questionColumnId": 123}
GetEvaluationMetricInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
projectKinds - [ProjectKind!]!
|
|
filters - EvaluationMetricFilters
|
Example
{
"projectId": 4,
"projectKinds": ["DOCUMENT_BASED"],
"filters": EvaluationMetricFilters
}
GetExportDeliveryStatusResult
Fields
| Field Name | Description |
|---|---|
deliveryStatus - ExportDeliveryStatus!
|
|
errors - [JobError!]!
|
Example
{"deliveryStatus": "DELIVERED", "errors": [JobError]}
GetExternalFilesByApiInput
GetLabelErrorDetectionRowBasedSuggestionsInput
GetLabelSetTemplatesFilterInput
Fields
| Input Field | Description |
|---|---|
teamId - ID
|
|
keyword - String
|
|
types - [LabelSetTemplateType!]
|
|
ownerIds - [Int]
|
Example
{
"teamId": "4",
"keyword": "abc123",
"types": ["QUESTION"],
"ownerIds": [987]
}
GetLabelSetTemplatesPaginatedInput
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
page - OffsetPageInput
|
|
filter - GetLabelSetTemplatesFilterInput
|
|
sort - [SortInput!]
|
Example
{
"cursor": "abc123",
"page": OffsetPageInput,
"filter": GetLabelSetTemplatesFilterInput,
"sort": [SortInput]
}
GetLabelSetTemplatesResponse
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [LabelSetTemplate!]!
|
Example
{
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [LabelSetTemplate]
}
GetLabelingFunctionInput
Fields
| Input Field | Description |
|---|---|
labelingFunctionId - ID!
|
Example
{"labelingFunctionId": 4}
GetLabelingFunctionsInput
GetLabelingFunctionsPairKappaInput
Fields
| Input Field | Description |
|---|---|
dataProgrammingId - ID!
|
|
labelingFunctionIds - [ID!]!
|
|
kind - ProjectKind!
|
|
role - Role!
|
|
noCache - Boolean
|
Example
{
"dataProgrammingId": "4",
"labelingFunctionIds": [4],
"kind": "DOCUMENT_BASED",
"role": "REVIEWER",
"noCache": true
}
GetLabelingFunctionsPairKappaOutput
Fields
| Field Name | Description |
|---|---|
labelingFunctionPairKappas - [LabelingFunctionPairKappa!]!
|
|
lastCalculatedAt - String!
|
Example
{
"labelingFunctionPairKappas": [
LabelingFunctionPairKappa
],
"lastCalculatedAt": "abc123"
}
GetLabelsPaginatedInput
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
page - OffsetPageInput
|
Example
{
"cursor": "xyz789",
"page": OffsetPageInput
}
GetLabelsPaginatedResponse
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [TextLabelScalar!]!
|
Example
{
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [TextLabelScalar]
}
GetLlmApplicationsFilterInput
Description
Parameters to filter the results
Fields
| Input Field | Description |
|---|---|
teamId - ID!
|
|
keyword - String
|
|
createdByUserIds - [ID!]
|
|
deployedByUserIds - [ID!]
|
|
statuses - [GqlLlmApplicationStatus!]
|
Example
{
"teamId": "4",
"keyword": "abc123",
"createdByUserIds": [4],
"deployedByUserIds": ["4"],
"statuses": ["DEPLOYED"]
}
GetLlmApplicationsPaginatedInput
Description
Parameters for getLlmApplications endpoint.
Fields
| Input Field | Description |
|---|---|
cursor - String
|
Cursor to the current page of result. |
page - OffsetPageInput
|
Offset Pagination controls. skip: The number of results to be skipped. take: The maximum number of results to be returned. |
filter - GetLlmApplicationsFilterInput
|
Filters the results by the specified parameters. |
sort - [SortInput!]
|
Sorts the results by a specified field. field: The field to sort. order: one of [ASC, DESC]. |
Example
{
"cursor": "abc123",
"page": OffsetPageInput,
"filter": GetLlmApplicationsFilterInput,
"sort": [SortInput]
}
GetLlmEvaluationDetailPaginatedInput
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
page - OffsetPageInput
|
|
filter - LlmEvaluationDetailFilterInput
|
|
sort - [SortInput!]
|
Example
{
"cursor": "xyz789",
"page": OffsetPageInput,
"filter": LlmEvaluationDetailFilterInput,
"sort": [SortInput]
}
GetLlmEvaluationsFilterInput
Description
Parameters to filter the results
Fields
| Input Field | Description |
|---|---|
teamId - ID!
|
The team id that the LLM evaluation belongs to. |
llmRagConfigIds - [ID!]
|
The RAG config id. |
types - [GqlLlmEvaluationType!]
|
The project kind. |
statuses - [GqlLlmEvaluationStatus!]
|
The project status. |
keyword - String
|
The keyword to search. |
hasSchedule - Boolean
|
The condition to check if the LLM evaluation has schedule |
schedulingStatuses - [GqlLlmEvaluationSchedulingStatus!]
|
The scheduling status of the LLM evaluation. |
Example
{
"teamId": 4,
"llmRagConfigIds": ["4"],
"types": ["RATING"],
"statuses": ["CREATED"],
"keyword": "xyz789",
"hasSchedule": true,
"schedulingStatuses": ["NOT_STARTED"]
}
GetLlmEvaluationsPaginatedInput
Fields
| Input Field | Description |
|---|---|
cursor - String
|
Cursor to the current page of result. |
page - OffsetPageInput
|
Offset Pagination controls. skip: The number of results to be skipped. take: The maximum number of results to be returned. |
filter - GetLlmEvaluationsFilterInput
|
Filters the results by the specified parameters. |
sort - [SortInput!]
|
Sorts the results by a specified field. field: The field to sort. order: one of [ASC, DESC]. |
Example
{
"cursor": "abc123",
"page": OffsetPageInput,
"filter": GetLlmEvaluationsFilterInput,
"sort": [SortInput]
}
GetLlmGeneratedInstructionInput
Fields
| Input Field | Description |
|---|---|
task - String!
|
|
type - GqlLlmGeneratedInstructionType!
|
|
modelName - String!
|
Example
{
"task": "abc123",
"type": "SYSTEM_INSTRUCTION",
"modelName": "abc123"
}
GetLlmUsagesFilterInput
Description
Parameters to filter the results
Fields
| Input Field | Description |
|---|---|
teamId - ID!
|
|
startDate - String
|
|
endDate - String
|
|
llmModelNames - [String!]
|
|
llmUsageTypes - [GqlLlmUsageType!]
|
Example
{
"teamId": 4,
"startDate": "abc123",
"endDate": "xyz789",
"llmModelNames": ["abc123"],
"llmUsageTypes": ["VECTOR_STORE"]
}
GetLlmUsagesPaginatedInput
Description
Parameters for getLlmUsages endpoint.
Fields
| Input Field | Description |
|---|---|
cursor - String
|
Cursor to the current page of result. |
page - OffsetPageInput
|
Offset Pagination controls. skip: The number of results to be skipped. take: The maximum number of results to be returned. |
filter - GetLlmUsagesFilterInput
|
Filters the results by the specified parameters. |
sort - [SortInput!]
|
Sorts the results by a specified field. field: The field to sort. order: one of [ASC, DESC]. |
Example
{
"cursor": "abc123",
"page": OffsetPageInput,
"filter": GetLlmUsagesFilterInput,
"sort": [SortInput]
}
GetLlmVectorStoreActivityFilter
Example
{
"llmVectorStoreId": "4",
"llmVectorStoreDocumentId": "4",
"fileSource": "xyz789",
"userId": 4,
"startDate": "abc123",
"endDate": "xyz789"
}
GetLlmVectorStoreActivityInput
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
page - CursorPageInput
|
|
filter - GetLlmVectorStoreActivityFilter
|
|
sort - [SortInput!]
|
Example
{
"cursor": "abc123",
"page": CursorPageInput,
"filter": GetLlmVectorStoreActivityFilter,
"sort": [SortInput]
}
GetLlmVectorStoreActivityResponse
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [LlmVectorStoreActivity!]!
|
Example
{
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [LlmVectorStoreActivity]
}
GetLlmVectorStoreDocumentsIncludingDeletedResponse
Fields
| Field Name | Description |
|---|---|
documents - [LlmVectorStoreDocumentScalar!]
|
|
sourceDocuments - [LlmVectorStoreSourceDocument!]
|
Example
{
"documents": [LlmVectorStoreDocumentScalar],
"sourceDocuments": [LlmVectorStoreSourceDocument]
}
GetLlmVectorStoreDocumentsPaginatedInput
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
page - OffsetPageInput
|
|
filter - LlmVectorStoreDocumentsPaginatedFilterInput
|
|
sort - [LlmVectorStoreDocumentsPaginatedSortInput!]
|
Example
{
"cursor": "xyz789",
"page": OffsetPageInput,
"filter": LlmVectorStoreDocumentsPaginatedFilterInput,
"sort": [LlmVectorStoreDocumentsPaginatedSortInput]
}
GetLlmVectorStoresFilterInput
Description
Parameters to filter the results
Fields
| Input Field | Description |
|---|---|
teamId - ID!
|
|
keyword - String
|
|
createdByUserIds - [ID!]
|
|
statuses - [GqlLlmVectorStoreStatus!]
|
Example
{
"teamId": 4,
"keyword": "xyz789",
"createdByUserIds": [4],
"statuses": ["CREATED"]
}
GetLlmVectorStoresPaginatedInput
Description
Parameters for getLlmVectorStores endpoint.
Fields
| Input Field | Description |
|---|---|
cursor - String
|
Cursor to the current page of result. |
page - OffsetPageInput
|
Offset Pagination controls. skip: The number of results to be skipped. take: The maximum number of results to be returned. |
filter - GetLlmVectorStoresFilterInput
|
Filters the results by the specified parameters. |
sort - [SortInput!]
|
Sorts the results by a specified field. field: The field to sort. order: one of [ASC, DESC]. |
Example
{
"cursor": "xyz789",
"page": OffsetPageInput,
"filter": GetLlmVectorStoresFilterInput,
"sort": [SortInput]
}
GetOrCreateLabelErrorDetectionRowBasedInput
GetPaginatedGroundTruthSetFilterInput
GetPaginatedGroundTruthSetInput
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
page - OffsetPageInput
|
|
filter - GetPaginatedGroundTruthSetFilterInput
|
|
sort - [SortInput!]
|
Example
{
"cursor": "xyz789",
"page": OffsetPageInput,
"filter": GetPaginatedGroundTruthSetFilterInput,
"sort": [SortInput]
}
GetPaginatedGroundTruthSetItemsFilterInput
GetPaginatedGroundTruthSetItemsInput
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
page - OffsetPageInput
|
|
filter - GetPaginatedGroundTruthSetItemsFilterInput!
|
|
sort - [SortInput!]
|
Example
{
"cursor": "abc123",
"page": OffsetPageInput,
"filter": GetPaginatedGroundTruthSetItemsFilterInput,
"sort": [SortInput]
}
GetPaginatedGroundTruthSetItemsResponse
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [GroundTruth!]!
|
Example
{
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [GroundTruth]
}
GetPaginatedGroundTruthSetResponse
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [GroundTruthSet!]!
|
Example
{
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [GroundTruthSet]
}
GetPaginatedLlmApplicationConfigurationFilter
GetPaginatedLlmApplicationConfigurationInput
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
page - OffsetPageInput
|
|
filter - GetPaginatedLlmApplicationConfigurationFilter!
|
|
sort - [SortInput!]
|
Example
{
"cursor": "xyz789",
"page": OffsetPageInput,
"filter": GetPaginatedLlmApplicationConfigurationFilter,
"sort": [SortInput]
}
GetPaginatedLlmApplicationConfigurationResponse
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [LlmApplicationConfiguration!]!
|
Example
{
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [LlmApplicationConfiguration]
}
GetPaginatedQuestionSetFilter
GetPaginatedQuestionSetInput
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
page - OffsetPageInput
|
|
filter - GetPaginatedQuestionSetFilter
|
|
sort - [SortInput!]
|
Example
{
"cursor": "xyz789",
"page": OffsetPageInput,
"filter": GetPaginatedQuestionSetFilter,
"sort": [SortInput]
}
GetPaginatedQuestionSetResponse
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [QuestionSet!]!
|
Example
{
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [QuestionSet]
}
GetPaginatedTeamMemberPerformance
Fields
| Field Name | Description |
|---|---|
projectId - ID!
|
|
resourceId - String!
|
|
projectName - String!
|
|
labelingStatus - GqlLabelingStatus
|
|
projectStatus - GqlProjectStatus
|
|
totalLabelApplied - Int
|
|
totalAnswerApplied - Int
|
|
totalConflictResolved - Int
|
|
numberOfAcceptedLabels - Int!
|
|
numberOfRejectedLabels - Int!
|
|
numberOfConflictedLabels - Int!
|
|
numberOfMissingLabels - Int!
|
|
numberOfAcceptedAnswers - Int!
|
|
numberOfRejectedAnswers - Int!
|
|
numberOfConflictedAnswers - Int!
|
|
numberOfAnsweredLines - Int
|
|
activeDurationInMillis - Int!
|
Example
{
"projectId": "4",
"resourceId": "abc123",
"projectName": "abc123",
"labelingStatus": "NOT_STARTED",
"projectStatus": "CREATED",
"totalLabelApplied": 123,
"totalAnswerApplied": 987,
"totalConflictResolved": 987,
"numberOfAcceptedLabels": 123,
"numberOfRejectedLabels": 123,
"numberOfConflictedLabels": 123,
"numberOfMissingLabels": 123,
"numberOfAcceptedAnswers": 123,
"numberOfRejectedAnswers": 123,
"numberOfConflictedAnswers": 987,
"numberOfAnsweredLines": 987,
"activeDurationInMillis": 987
}
GetPaginatedTeamMemberPerformanceInput
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
page - OffsetPageInput
|
|
filter - GetTeamMemberPerformanceFilterInput!
|
|
sort - [SortInput!]
|
Example
{
"cursor": "abc123",
"page": OffsetPageInput,
"filter": GetTeamMemberPerformanceFilterInput,
"sort": [SortInput]
}
GetPaginatedTeamMemberPerformanceResponse
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [GetPaginatedTeamMemberPerformance!]!
|
Example
{
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [GetPaginatedTeamMemberPerformance]
}
GetPersonalTagsInput
Fields
| Input Field | Description |
|---|---|
filter - GetTagsFilterInput
|
Example
{"filter": GetTagsFilterInput}
GetPredictedLabelsInput
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
Example
{"documentId": "4"}
GetProjectInput
GetProjectMetadataItemsFilterInput
Fields
| Input Field | Description |
|---|---|
teamId - ID
|
|
key - String
|
|
value - String
|
|
projectMetadataItems - [ProjectMetadataItemInput!]
|
Example
{
"teamId": 4,
"key": "xyz789",
"value": "xyz789",
"projectMetadataItems": [ProjectMetadataItemInput]
}
GetProjectMetadataItemsInput
Fields
| Input Field | Description |
|---|---|
filter - GetProjectMetadataItemsFilterInput
|
|
cursor - String
|
|
page - OffsetPageInput
|
|
sort - [SortInput!]
|
Example
{
"filter": GetProjectMetadataItemsFilterInput,
"cursor": "abc123",
"page": OffsetPageInput,
"sort": [SortInput]
}
GetProjectsFilterInput
Description
Parameters to filter the projects
Fields
| Input Field | Description |
|---|---|
teamId - ID
|
Optional. Filters projects by teams. Defaults to null, shows all projects under the personal workspace. |
keyword - String
|
Optional. Filters projects by keyword, searches project name and tags. By default shows all projects. |
labelerTeamMemberIds - [ID!]
|
Optional. Filters projects by its labeler. |
reviewerTeamMemberIds - [ID!]
|
Optional. Filters projects by its reviewer. |
ownerUserIds - [ID!]
|
Optional. Filters projects by its owner. |
statuses - [GqlProjectAndLabelingStatus!]
|
Deprecated. Use projectStatuses and labelingStatuses instead. Optional. Filters projects by its status. Use projectStatuses and labelingStatuses instead.
|
projectStatuses - [GqlProjectStatus!]
|
Optional. Filters projects by its project status. |
labelingStatuses - [GqlLabelingStatus!]
|
Optional. Filters projects by its labeling status. |
tags - [String!]
|
Optional. Filters projects by its tag IDs. To filter by tag names, use the keyword field. To see a list of tag IDs, see query getTags and getPersonalTags |
types - [TextDocumentType!]
|
Deprecated. To filter by types (POS, NER, etc), use the tags or keyword option instead. |
kinds - [ProjectKind!]
|
Optional. Filters projects by its kind. |
daysCreatedRange - DaysCreatedInput
|
Optional. Filters projects by its creation date. |
labelSetSignatures - [String!]
|
Optional. Filters projects by its LabelSet. See LabelSet.signature. |
isArchived - Boolean
|
Optional. Filters projects by archived state.
Use If |
projectStates - [ProjectState!]
|
Optional. Filters projects by their
|
Example
{
"teamId": 4,
"keyword": "abc123",
"labelerTeamMemberIds": [4],
"reviewerTeamMemberIds": ["4"],
"ownerUserIds": [4],
"statuses": ["CREATED"],
"projectStatuses": ["CREATED"],
"labelingStatuses": ["NOT_STARTED"],
"tags": ["abc123"],
"types": ["POS"],
"kinds": ["DOCUMENT_BASED"],
"daysCreatedRange": DaysCreatedInput,
"labelSetSignatures": ["xyz789"],
"isArchived": true,
"projectStates": ["ACTIVE"]
}
GetProjectsPaginatedInput
Description
Parameters for getProjects endpoint.
Fields
| Input Field | Description |
|---|---|
cursor - String
|
Cursor to the current page of result. |
page - OffsetPageInput
|
Offset Pagination controls. skip: The number of projects to be skipped. take: The maximum number of projects to be returned. |
filter - GetProjectsFilterInput
|
Filters the projects by the specified parameters. |
sort - [SortInput!]
|
Sorts the projects by a specified field. field: The field to sort. order: one of [ASC, DESC]. |
Example
{
"cursor": "xyz789",
"page": OffsetPageInput,
"filter": GetProjectsFilterInput,
"sort": [SortInput]
}
GetRowAnswerConflictsInput
GetRowAnswersPaginatedInput
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
page - RangePageInput
|
Example
{
"cursor": "abc123",
"page": RangePageInput
}
GetRowAnswersPaginatedResponse
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [RowAnswer!]!
|
Example
{
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [RowAnswer]
}
GetSpanAndArrowConflictsPaginatedInput
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
page - OffsetPageInput
|
Example
{
"cursor": "xyz789",
"page": OffsetPageInput
}
GetSpanAndArrowConflictsPaginatedResponse
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [ConflictTextLabelScalar!]!
|
Example
{
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [ConflictTextLabelScalar]
}
GetSpanAndArrowRejectedLabelsPaginatedInput
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
page - OffsetPageInput
|
Example
{
"cursor": "abc123",
"page": OffsetPageInput
}
GetSpanAndArrowRejectedLabelsPaginatedResponse
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [ConflictTextLabelScalar!]!
|
Example
{
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [ConflictTextLabelScalar]
}
GetTagsFilterInput
Fields
| Input Field | Description |
|---|---|
includeGlobalTag - Boolean!
|
Example
{"includeGlobalTag": false}
GetTagsInput
Fields
| Input Field | Description |
|---|---|
teamId - ID
|
|
filter - GetTagsFilterInput
|
Example
{
"teamId": "4",
"filter": GetTagsFilterInput
}
GetTeamDetailInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
GetTeamMemberPerformanceFilterInput
Fields
| Input Field | Description |
|---|---|
teamId - ID!
|
|
userId - ID!
|
|
role - ProjectAssignmentRole!
|
Example
{
"teamId": "4",
"userId": 4,
"role": "LABELER"
}
GetTeamMembersFilterInput
Fields
| Input Field | Description |
|---|---|
teamId - ID!
|
|
keyword - String
|
|
role - [TeamMemberRoleFilter!]
|
|
roleId - [ID!]
|
Use role instead. When both are provided, role will be prioritized. |
Example
{
"teamId": 4,
"keyword": "abc123",
"role": ["ADMIN"],
"roleId": [4]
}
GetTeamMembersPaginatedInput
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
page - OffsetPageInput
|
|
filter - GetTeamMembersFilterInput
|
|
sort - [SortInput!]
|
Example
{
"cursor": "xyz789",
"page": OffsetPageInput,
"filter": GetTeamMembersFilterInput,
"sort": [SortInput]
}
GetTeamMembersPaginatedResponse
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [TeamMember!]!
|
Example
{
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [TeamMember]
}
GetTeamProjectAssigneesInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
Example
{"projectId": 4}
GetTeamTimelineEventsFilter
GetTeamTimelineEventsInput
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
page - CursorPageInput
|
|
filter - GetTeamTimelineEventsFilter
|
|
sort - [SortInput!]
|
Example
{
"cursor": "abc123",
"page": CursorPageInput,
"filter": GetTeamTimelineEventsFilter,
"sort": [SortInput]
}
GetTeamTimelineEventsResponse
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [TimelineEvent!]!
|
Example
{
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [TimelineEvent]
}
GqlAutoLabelModelPrivacy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PUBLIC"
GqlAutoLabelServiceProvider
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This enum will be removed in the future, please use LLM_ASSISTED_LABELING instead |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CUSTOM"
GqlConflictable
Fields
| Field Name | Description |
|---|---|
id - String
|
|
documentId - String!
|
|
labeledBy - ConflictTextLabelResolutionStrategy!
|
|
type - LabelEntityType!
|
|
hashCode - String!
|
|
labeledByUserId - Int
|
|
acceptedByUserId - Int
|
|
rejectedByUserId - Int
|
Example
{
"id": "abc123",
"documentId": "xyz789",
"labeledBy": "AUTO",
"type": "ARROW",
"hashCode": "abc123",
"labeledByUserId": 123,
"acceptedByUserId": 123,
"rejectedByUserId": 123
}
GqlConflictableInput
Fields
| Input Field | Description |
|---|---|
id - String
|
|
documentId - String!
|
|
labeledBy - ConflictTextLabelResolutionStrategy!
|
|
type - LabelEntityType!
|
|
hashCode - String!
|
|
labeledByUserId - Int
|
|
acceptedByUserId - Int
|
|
rejectedByUserId - Int
|
Example
{
"id": "abc123",
"documentId": "xyz789",
"labeledBy": "AUTO",
"type": "ARROW",
"hashCode": "xyz789",
"labeledByUserId": 123,
"acceptedByUserId": 987,
"rejectedByUserId": 123
}
GqlExportMethod
Values
| Enum Value | Description |
|---|---|
|
|
Return a download link. |
|
|
Sends the download link to the creator's email. |
|
|
Sends the download link to a custom webhook. |
|
|
Directly upload the export result to your bucket via External Object Storage |
|
|
Deprecated. Use FILE_STORAGE instead. No longer supported |
|
|
Deprecated. Use FILE_STORAGE instead. No longer supported |
|
|
Depcreated. Use EXTERNAL_OBJECT_STORAGE instead. No longer supported |
Example
"FILE_STORAGE"
GqlLabelingStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NOT_STARTED"
GqlLlmApplicationStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DEPLOYED"
GqlLlmBaseModelDatasetType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPLETION"
GqlLlmBaseModelHyperparameterField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"epochs"
GqlLlmBaseModelHyperparameterValueType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"INTEGER"
GqlLlmBaseModelMethodType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"FINE_TUNING"
GqlLlmBaseModelProvider
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"AMAZON"
GqlLlmEvaluationRagConfigSourceType
Values
| Enum Value | Description |
|---|---|
|
|
The RAG config is from the application deployment. |
|
|
The RAG config is from the saved application. |
|
|
The RAG config is neither from the application deployment nor from the saved application. |
Example
"APPLICATION_DEPLOYMENT"
GqlLlmEvaluationSchedulingStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NOT_STARTED"
GqlLlmEvaluationStatus
Values
| Enum Value | Description |
|---|---|
|
|
This state indicates that the job has been newly inserted, but the processing has not started yet. |
|
|
This state means that the job is currently being evaluated. |
|
|
This state signifies that the evaluation has been completed. |
|
|
This state signifies that the job has failed. |
Example
"CREATED"
GqlLlmEvaluationType
Values
| Enum Value | Description |
|---|---|
|
|
The type refers to the NLP project LLM Evaluation. |
|
|
The type refers to the NLP project LLM Ranking. |
|
|
The type is automated (python backend) |
Example
"RATING"
GqlLlmGeneratedInstructionType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"SYSTEM_INSTRUCTION"
GqlLlmModelFineTuningStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"IN_PROGRESS"
GqlLlmModelMetadataType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"QUESTION_ANSWERING"
GqlLlmModelProvider
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AMAZON_BEDROCK"
GqlLlmModelStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"AVAILABLE"
GqlLlmModelType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"LLM_MODEL"
GqlLlmUsageType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"VECTOR_STORE"
GqlLlmVectorStoreActivityEvent
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATE_LLM_VECTOR_STORE"
GqlLlmVectorStoreAuthenticationScheme
Values
| Enum Value | Description |
|---|---|
|
|
Example
"BASIC"
GqlLlmVectorStoreDocumentStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"QUEUED"
GqlLlmVectorStoreDocumentType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"FOLDER"
GqlLlmVectorStoreProvider
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DATASAUR"
GqlLlmVectorStoreStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED"
GqlPaymentStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"VALID"
GqlPricingModelUnitPurpose
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DEPLOY"
GqlPricingModelUnitType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"HOUR"
GqlPricingUsageType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CHAR"
GqlProjectAndLabelingStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED"
GqlProjectStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED"
GrammarCheckerInput
Fields
| Input Field | Description |
|---|---|
grammarCheckerProviderId - ID!
|
|
documentId - ID!
|
|
sentenceIds - [Int!]
|
|
sentenceIdRange - RangeInput
|
Example
{
"grammarCheckerProviderId": "4",
"documentId": 4,
"sentenceIds": [123],
"sentenceIdRange": RangeInput
}
GrammarCheckerServiceProvider
GrammarMistake
Fields
| Field Name | Description |
|---|---|
text - String!
|
|
message - String!
|
|
position - TextRange!
|
|
suggestions - [String!]!
|
Example
{
"text": "abc123",
"message": "abc123",
"position": TextRange,
"suggestions": ["abc123"]
}
GroundTruth
GroundTruthSet
Example
{
"id": 4,
"name": "xyz789",
"teamId": "4",
"createdByUserId": 4,
"createdByUser": User,
"items": [GroundTruth],
"itemsCount": 123,
"createdAt": "abc123",
"updatedAt": "abc123"
}
Guideline
HeaderColumnInput
HeuristicArgumentScalar
Example
HeuristicArgumentScalar
IAA
IAAInformation
IAAInput
Fields
| Input Field | Description |
|---|---|
method - IAAMethodName!
|
|
teamId - ID!
|
|
labelSetSignatures - [String!]
|
|
projectIds - [ID!]
|
Example
{
"method": "COHENS_KAPPA",
"teamId": 4,
"labelSetSignatures": ["xyz789"],
"projectIds": ["4"]
}
IAAMethodName
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COHENS_KAPPA"
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
4
ImportFileTransformerExecuteResult
Description
interface ImportFileTransformerExecuteResult { document: ImportedDocument! labelSets: [ImportedLabelSet!]! }
Example
ImportFileTransformerExecuteResult
ImportTextDocumentInput
InfoBar
InputFieldType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"TEXTAREA"
InputKeyType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"API_KEY"
InsertMultiRowAnswersResult
Fields
| Field Name | Description |
|---|---|
document - TextDocument!
|
|
previousAnswers - [RowAnswer!]!
|
|
updatedAnswers - [RowAnswer!]!
|
Example
{
"document": TextDocument,
"previousAnswers": [RowAnswer],
"updatedAnswers": [RowAnswer]
}
InsertTargetInput
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
InvalidAnswerInfo
InvitationVerificationResult
InviteTeamMembersInput
Fields
| Input Field | Description |
|---|---|
teamId - ID!
|
|
members - [TeamMemberInput!]!
|
Example
{"teamId": 4, "members": [TeamMemberInput]}
IsLlmInternalApplicationAvailableInput
Fields
| Input Field | Description |
|---|---|
type - GqlLlmGeneratedInstructionType!
|
|
modelName - String!
|
Example
{
"type": "SYSTEM_INSTRUCTION",
"modelName": "xyz789"
}
Job
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
status - JobStatus!
|
|
progress - Int!
|
|
errors - [JobError!]!
|
|
resultId - String
|
|
result - JobResult
|
|
createdAt - String!
|
|
updatedAt - String!
|
|
additionalData - JobAdditionalData
|
Example
{
"id": "xyz789",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "xyz789",
"additionalData": JobAdditionalData
}
JobAdditionalData
Fields
| Field Name | Description |
|---|---|
actionRunId - ID
|
|
childrenJobIds - [ID!]
|
|
documentIds - [ID!]
|
|
reversedLabels - [UpdateReversedLabelsResult!]
|
Example
{
"actionRunId": 4,
"childrenJobIds": [4],
"documentIds": ["4"],
"reversedLabels": [UpdateReversedLabelsResult]
}
JobError
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
stack - String!
|
|
args - JobErrorArgs
|
|
message - String
|
Example
{
"id": "xyz789",
"stack": "xyz789",
"args": JobErrorArgs,
"message": "xyz789"
}
JobErrorArgs
Example
JobErrorArgs
JobResult
Example
JobResult
JobStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DELIVERED"
KeyPayload
Example
KeyPayload
KeyPayloadType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"USER"
LLMAssistedLabelingProvider
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"OPENAI"
LLMAssistedLabelingProviderInputField
Fields
| Field Name | Description |
|---|---|
key - InputKeyType!
|
|
name - String!
|
|
type - InputFieldType!
|
|
required - Boolean!
|
|
maxValue - Float
|
|
minValue - Float
|
Example
{
"key": "API_KEY",
"name": "abc123",
"type": "TEXTAREA",
"required": false,
"maxValue": 123.45,
"minValue": 123.45
}
LLMAssistedLabelingProvidersInput
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
Example
{"documentId": "4"}
LLMAssistedLabelingProvidersOutput
Fields
| Field Name | Description |
|---|---|
name - LLMAssistedLabelingProvider!
|
|
models - [String!]!
|
|
inputFields - [LLMAssistedLabelingProviderInputField!]!
|
Example
{
"name": "OPENAI",
"models": ["abc123"],
"inputFields": [LLMAssistedLabelingProviderInputField]
}
LabelClassArrowRule
LabelClassArrowRuleInput
LabelClassType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SPAN"
LabelEntityType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ARROW"
LabelErrorDetectionRowBased
Example
{
"id": "4",
"cabinetId": "4",
"inputColumnIds": [123],
"questionColumnId": 123,
"jobId": 4,
"createdAt": "abc123",
"updatedAt": "abc123"
}
LabelErrorDetectionRowBasedSuggestion
Example
{
"id": "4",
"documentId": "4",
"labelErrorDetectionId": "4",
"line": 987,
"errorPossibility": 987.65,
"suggestedLabel": "abc123",
"previousLabel": "abc123",
"createdAt": "abc123",
"updatedAt": "abc123"
}
LabelErrorDetectionRowBasedSuggestionInput
Example
{
"documentId": 4,
"labelErrorDetectionId": 4,
"line": 123,
"errorPossibility": 123.45,
"suggestedLabel": "xyz789",
"previousLabel": "abc123"
}
LabelObject
LabelObjectInput
LabelPhase
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PRELABELED"
LabelPhaseInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PRELABELED"
LabelSet
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier of the labelset. |
name - String!
|
|
index - Int!
|
The labelset's zero-based index in a project. Each project can have up to 5 labelset. |
signature - String
|
A labelset signature. The signature is generated based on the labelset's items. |
tagItems - [TagItem!]!
|
|
lastUsedBy - LastUsedProject
|
|
arrowLabelRequired - Boolean!
|
Example
{
"id": "4",
"name": "xyz789",
"index": 123,
"signature": "abc123",
"tagItems": [TagItem],
"lastUsedBy": LastUsedProject,
"arrowLabelRequired": false
}
LabelSetConfigInput
Fields
| Input Field | Description |
|---|---|
defaultValue - String
|
Applies for DATE, TIME. Possible value NOW |
format - String
|
Applies for DATE, TIME. Possible values for DATE are DD-MM-YYYY, MM-DD-YYYY, YYYY-MM-DD DD/MM/YYYY, MM/DD/YYYY and YYYY/MM/DD. Possible values for TIME are HH:mm:ss, HH:mm, HH.mm.ss, and HH.mm |
multiple - Boolean
|
Applies for TEXT, NESTED, DROPDOWN, HIERARCHICAL_DROPDOWN. Set it as true if you want to have multiple answers for this question. |
multiline - Boolean
|
Applies for TEXT. Set it as true if you want to enter long text. |
options - [LabelSetConfigOptionsInput!]
|
Applies for
|
questions - [LabelSetTemplateItemInput!]
|
Applies for NESTED. |
minLength - Int
|
Applies for TEXT. |
maxLength - Int
|
Applies for TEXT. |
pattern - String
|
Applies for TEXT. This field can contain a regex string, which the browser natively uses for validation. E.g. [0-9]* |
theme - SliderTheme
|
Applies for SLIDER. |
min - Int
|
Applies for SLIDER. |
max - Int
|
Applies for SLIDER. |
step - Int
|
Applies for SLIDER. |
hint - String
|
Applies for CHECKBOX. |
activationConditionLogic - String
|
Example
{
"defaultValue": "abc123",
"format": "xyz789",
"multiple": false,
"multiline": false,
"options": [LabelSetConfigOptionsInput],
"questions": [LabelSetTemplateItemInput],
"minLength": 123,
"maxLength": 123,
"pattern": "abc123",
"theme": "PLAIN",
"min": 123,
"max": 987,
"step": 123,
"hint": "abc123",
"activationConditionLogic": "xyz789"
}
LabelSetConfigOptions
Description
Represents a labelset item.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier of the labelset item. |
label - String!
|
The labelset item name shown in web UI. |
parentId - ID
|
Optional. Use this field if you want to create hierarchical options. Use another option's id to make it as a parent option. |
color - String
|
The labelset item color when shown in web UI. 6 digit hex string, prefixed by #. Example: #df3920. |
type - LabelClassType!
|
Can be SPAN, ARROW, or ALL. Defaults to ALL. |
arrowRules - [LabelClassArrowRule!]
|
Only has effect if type is ARROW. |
Example
{
"id": "4",
"label": "xyz789",
"parentId": 4,
"color": "abc123",
"type": "SPAN",
"arrowRules": [LabelClassArrowRule]
}
LabelSetConfigOptionsInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Required. Unique identifier of the labelset item. |
label - String!
|
Required. The labelset item name shown in web UI. |
parentId - ID
|
Optional. Use this field if you want to create hierarchical options. Use another option's id to make it as a parent option. |
description - String
|
|
color - String
|
Optional. Sets the labelset item color when shown in web UI. Accepts a 6 digit hex string, prefixed by #. Example: #df3920. |
type - LabelClassType
|
Optional. Can be SPAN, ARROW, or ALL. Defaults to ALL. |
arrowRules - [LabelClassArrowRuleInput!]
|
Optional. Only has effect if type is ARROW. |
Example
{
"id": "4",
"label": "abc123",
"parentId": "4",
"description": "abc123",
"color": "xyz789",
"type": "SPAN",
"arrowRules": [LabelClassArrowRuleInput]
}
LabelSetTemplate
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
owner - User
|
|
type - LabelSetTemplateType!
|
|
items - [LabelSetTemplateItem!]
|
|
count - Int!
|
|
createdAt - String!
|
|
updatedAt - String!
|
Example
{
"id": "4",
"name": "abc123",
"owner": User,
"type": "QUESTION",
"items": [LabelSetTemplateItem],
"count": 987,
"createdAt": "abc123",
"updatedAt": "abc123"
}
LabelSetTemplateItem
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
labelSetTemplateId - String!
|
|
index - String
|
|
parentIndex - String
|
|
name - String!
|
|
description - String!
|
|
options - [LabelSetConfigOptions!]
|
For type:
|
arrowLabelRequired - Boolean!
|
|
required - Boolean
|
|
multipleChoice - Boolean
|
|
type - LabelSetTemplateItemType!
|
|
minLength - Int
|
|
maxLength - Int
|
|
pattern - String
|
|
min - Int
|
|
max - Int
|
|
step - Int
|
|
multiline - Boolean
|
|
hint - String
|
|
theme - SliderTheme
|
|
bindToColumn - String
|
|
format - String
|
|
defaultValue - String
|
|
createdAt - String
|
|
updatedAt - String
|
|
activationConditionLogic - String
|
Example
{
"id": "4",
"labelSetTemplateId": "xyz789",
"index": "xyz789",
"parentIndex": "xyz789",
"name": "abc123",
"description": "abc123",
"options": [LabelSetConfigOptions],
"arrowLabelRequired": false,
"required": true,
"multipleChoice": false,
"type": "DROPDOWN",
"minLength": 987,
"maxLength": 987,
"pattern": "abc123",
"min": 987,
"max": 123,
"step": 987,
"multiline": true,
"hint": "xyz789",
"theme": "PLAIN",
"bindToColumn": "xyz789",
"format": "abc123",
"defaultValue": "abc123",
"createdAt": "xyz789",
"updatedAt": "abc123",
"activationConditionLogic": "abc123"
}
LabelSetTemplateItemInput
Fields
| Input Field | Description |
|---|---|
bindToColumn - String
|
Optional. Binds to the specified column |
type - LabelSetTemplateItemType
|
Optional. Type of the question |
name - String
|
Optional. Column name. |
label - String
|
Message shown to Labeler. |
required - Boolean
|
This marks whether the question is required to answer or not. |
config - LabelSetConfigInput
|
Required. Configures the labelset items. |
Example
{
"bindToColumn": "xyz789",
"type": "DROPDOWN",
"name": "abc123",
"label": "xyz789",
"required": true,
"config": LabelSetConfigInput
}
LabelSetTemplateItemType
Values
| Enum Value | Description |
|---|---|
|
|
This type provides a dropdown with multiple options. |
|
|
This type provides a dropdown with hierarchical options. |
|
|
You can create nested questions. Questions inside a question by using this type. |
|
|
This type provides a text area. |
|
|
This type provides a slider with customizeable minimum value and maximum value. |
|
|
This type provides a date picker. |
|
|
This type provides a time picker. |
|
|
This type provides a checkbox. |
|
|
This type provides a URL field. |
|
|
This type provides a token field. |
Example
"DROPDOWN"
LabelSetTemplateType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"QUESTION"
LabelSetTextProjectInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
options - [LabelSetTextProjectOptionInput!]!
|
|
arrowLabelRequired - Boolean
|
Example
{
"name": "abc123",
"options": [LabelSetTextProjectOptionInput],
"arrowLabelRequired": false
}
LabelSetTextProjectOptionInput
Fields
| Input Field | Description |
|---|---|
id - String!
|
|
parentId - String
|
The parent of another label set, indicating hierarchical structure. |
label - String!
|
The name of the label. |
color - String
|
In hex code. |
type - LabelClassType
|
|
arrowRules - [LabelClassArrowRuleInput!]
|
Example
{
"id": "xyz789",
"parentId": "abc123",
"label": "xyz789",
"color": "xyz789",
"type": "SPAN",
"arrowRules": [LabelClassArrowRuleInput]
}
LabelerProjectCompletionNotification
LabelerProjectCompletionNotificationInput
LabelerStatistic
Description
It contains statistical information specific to a labeler's cabinet, isolated from other labeler's work.
Fields
| Field Name | Description |
|---|---|
userId - ID!
|
The user ID of the labeler, not the team member ID. |
areDocumentQuestionsAnswered - Boolean!
|
An indicator to specify whether the labeler has answered the document questions (not including the questions for Row Labeling). |
numberOfAcceptedLabels - Int!
|
The total number of accepted annotations, i.e. Token labels, Bounding Box labels, and answers for both Row and Document questions. |
numberOfAppliedLabelTokens - Int!
|
The total number of accepted labels on Token Labeling. |
numberOfRejectedLabels - Int!
|
The total number of rejected annotations, i.e. Token labels, Bounding Box labels, and answers for both Row and Document questions. |
Example
{
"userId": 4,
"areDocumentQuestionsAnswered": true,
"numberOfAcceptedLabels": 987,
"numberOfAppliedLabelTokens": 123,
"numberOfRejectedLabels": 123
}
LabelingFunction
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
dataProgrammingId - ID!
|
|
heuristicArgument - HeuristicArgumentScalar
|
|
annotatorArgument - AnnotatorArgumentScalar
|
|
name - String!
|
|
content - String
|
|
active - Boolean!
|
|
createdAt - String!
|
|
updatedAt - String!
|
Example
{
"id": 4,
"dataProgrammingId": 4,
"heuristicArgument": HeuristicArgumentScalar,
"annotatorArgument": AnnotatorArgumentScalar,
"name": "abc123",
"content": "xyz789",
"active": false,
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
LabelingFunctionPairKappa
LabelingStatus
Fields
| Field Name | Description |
|---|---|
labeler - TeamMember!
|
|
isCompleted - Boolean!
|
|
isStarted - Boolean!
|
|
statistic - LabelingStatusStatistic!
|
|
statisticsToShow - [StatisticItem!]!
|
Example
{
"labeler": TeamMember,
"isCompleted": false,
"isStarted": false,
"statistic": LabelingStatusStatistic,
"statisticsToShow": [StatisticItem]
}
LabelingStatusStatistic
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
numberOfDocuments - Int!
|
|
numberOfTouchedDocuments - Int!
|
|
numberOfSentences - Int!
|
|
numberOfTouchedSentences - Int!
|
|
documentIds - [ID!]!
|
|
totalLabelsApplied - Int!
|
|
numberOfAcceptedLabels - Int!
|
|
numberOfRejectedLabels - Int!
|
|
numberOfUnresolvedLabels - Int!
|
|
totalTimeSpent - Int!
|
Example
{
"id": 4,
"numberOfDocuments": 123,
"numberOfTouchedDocuments": 987,
"numberOfSentences": 123,
"numberOfTouchedSentences": 123,
"documentIds": ["4"],
"totalLabelsApplied": 123,
"numberOfAcceptedLabels": 987,
"numberOfRejectedLabels": 987,
"numberOfUnresolvedLabels": 987,
"totalTimeSpent": 987
}
LastUsedProject
LaunchProjectInput
Description
Configuration for mutation createProject
Fields
| Input Field | Description |
|---|---|
name - String!
|
Required. Set the project name. |
documents - [CreateDocumentInput!]!
|
Required. Documents associated to the project. |
kinds - [ProjectKind!]!
|
Required. Sets the project kinds. |
creationSettings - CreationSettingsInput!
|
Required. This configuration affect the project creation flow. |
teamId - ID
|
Optional. Default to null, which creates a personal project. |
purpose - ProjectPurpose
|
Optional. Default to LABELING. |
externalObjectStorageId - ID
|
Optional. Set the external object storage to use. Affect how Datasaur resolves DocumentDetailInput.objectKey. When not provided, Datasaur will use it's internal storage bucket. See generateFileUrls. |
documentAssignments - [DocumentAssignmentInput!]
|
Optional. Team projects only. Assign specific document to a specific team member. |
kindsDocumentSettings - DocumentSettingsInput
|
Optional. Per-kind document-related configuration, such as allow arrow drawing. |
projectSettings - ProjectSettingsInput
|
Optional. Set the new project settings. |
tagNames - [String!]
|
Optional. The tag names associated with the project. If the tag doesn't exist, it will be created; otherwise, it will be used. See Tag. |
projectMetadataItems - [ProjectMetadataItemInput!]
|
Optional. The project metadata associated with the project. If the project metadata doesn't exist, it will be created; otherwise, it will be used. See ProjectMetadataItem. |
tokenLabelSets - [LabelSetTextProjectInput!]
|
Optional. Label sets for span labeling. |
bboxLabelSets - [CreateBBoxLabelSetInput!]
|
Optional. Label sets for bounding box labeling. |
rowQuestions - [QuestionInput!]
|
Optional. Questions for row labeling. |
documentQuestions - [QuestionInput!]
|
Optional. Questions for document labeling. |
labelerExtensions - [ExtensionID!]
|
Optional. Set the default Datasaur extensions that will be activated for labelers when opening the project. |
reviewerExtensions - [ExtensionID!]
|
Optional. Set the default Datasaur extensions that will be activated for reviewers when opening the project in Reviewer mode. |
Example
{
"name": "xyz789",
"documents": [CreateDocumentInput],
"kinds": ["DOCUMENT_BASED"],
"creationSettings": CreationSettingsInput,
"teamId": "4",
"purpose": "LABELING",
"externalObjectStorageId": "4",
"documentAssignments": [DocumentAssignmentInput],
"kindsDocumentSettings": DocumentSettingsInput,
"projectSettings": ProjectSettingsInput,
"tagNames": ["xyz789"],
"projectMetadataItems": [ProjectMetadataItemInput],
"tokenLabelSets": [LabelSetTextProjectInput],
"bboxLabelSets": [CreateBBoxLabelSetInput],
"rowQuestions": [QuestionInput],
"documentQuestions": [QuestionInput],
"labelerExtensions": ["AUTO_LABEL_TOKEN_EXTENSION_ID"],
"reviewerExtensions": ["AUTO_LABEL_TOKEN_EXTENSION_ID"]
}
LaunchTextProjectInput
Description
Configuration parameter for project creation.
Fields
| Input Field | Description |
|---|---|
name - String!
|
Required. Set the project name. |
kinds - [ProjectKind!]
|
Required. Set the project kind that will affect how each document is being viewed and labeled. |
documents - [CreateTextDocumentInput!]
|
Required. The documents associated to the project. Please ensure all the documents uploaded are of the same type. |
documentSettings - TextDocumentSettingsInput!
|
Required. Document related configuration, such as token length and custom script. |
teamId - ID
|
Optional. Default to null, which creates a personal project. |
documentAssignments - [DocumentAssignmentInput!]
|
Optional. Team projects only. Assign specific document to a specific team member. |
tagNames - [String!]
|
Optional. The tag names associated with the project. If the tag doesn't exist, it will be created; otherwise, it will be used. See Tag. |
type - TextDocumentType
|
Optional. Specific for Token Labeling with Audio or OCR. |
labelSets - [LabelSetTextProjectInput!]
|
Optional. Specific for Token Labeling. Select this if you want to create and use a new label set for the project. |
labelSetIDs - [ID!]
|
Optional. Specific for Token Labeling. Select this if you want to reuse the existing label set. |
guidelineId - ID
|
Optional. Set the labeling guideline for the project which later can be viewed from the project extension. |
projectCreationId - String
|
Optional. Used as unique identifier for the project creation. |
projectSettings - ProjectSettingsInput
|
Optional. Set the new project settings. |
purpose - ProjectPurpose
|
Optional. Default to LABELING. |
labelerExtensions - [ExtensionID!]
|
Optional. Set the default Datasaur extensions that will be activated for labelers when opening the project. |
reviewerExtensions - [ExtensionID!]
|
Optional. Set the default Datasaur extensions that will be activated for reviewers when opening the project in Reviewer mode. |
splitDocumentOption - SplitDocumentOptionInput
|
Optional. Specific for Token and Row Labeling. Set the document splitting behavior. |
externalObjectStorageId - ID
|
Optional. Set the external object storage to use. |
bboxLabelSets - [BBoxLabelSetProjectInput!]
|
Optional. Label sets for bounding box labeling. |
assignees - [ProjectAssignmentByNameInput!]
|
Deprecated. Please use field documentAssignments instead. Assignment could be specific for each document
|
labelSetId - ID
|
Deprecated. Please use field labelSets instead. Due to multiple label sets
|
Example
{
"name": "abc123",
"kinds": ["DOCUMENT_BASED"],
"documents": [CreateTextDocumentInput],
"documentSettings": TextDocumentSettingsInput,
"teamId": "4",
"documentAssignments": [DocumentAssignmentInput],
"tagNames": ["abc123"],
"type": "POS",
"labelSets": [LabelSetTextProjectInput],
"labelSetIDs": [4],
"guidelineId": "4",
"projectCreationId": "xyz789",
"projectSettings": ProjectSettingsInput,
"purpose": "LABELING",
"labelerExtensions": ["AUTO_LABEL_TOKEN_EXTENSION_ID"],
"reviewerExtensions": ["AUTO_LABEL_TOKEN_EXTENSION_ID"],
"splitDocumentOption": SplitDocumentOptionInput,
"externalObjectStorageId": 4,
"bboxLabelSets": [BBoxLabelSetProjectInput],
"assignees": [ProjectAssignmentByNameInput],
"labelSetId": "4"
}
Legend
Fields
| Field Name | Description |
|---|---|
position - LegendPosition!
|
|
alignment - LegendAlignment!
|
Example
{"position": "BOTTOM", "alignment": "START"}
LegendAlignment
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"START"
LegendPosition
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BOTTOM"
LlmApplication
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
teamId - ID!
|
|
createdByUser - User
|
|
name - String!
|
|
status - GqlLlmApplicationStatus!
|
|
createdAt - String!
|
|
updatedAt - String!
|
|
llmApplicationDeployment - LlmApplicationDeployment
|
Example
{
"id": "4",
"teamId": "4",
"createdByUser": User,
"name": "xyz789",
"status": "DEPLOYED",
"createdAt": "abc123",
"updatedAt": "abc123",
"llmApplicationDeployment": LlmApplicationDeployment
}
LlmApplicationConfiguration
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The LLM application configuration id. |
name - String!
|
The name of the LLM application configuration. |
teamId - ID!
|
The team id that the LLM application configuration belongs to. |
createdByUserId - ID
|
The user id that creates the LLM application configuration. |
createdByUser - User
|
The user that creates the LLM application configuration. |
updatedByUserId - ID
|
The user id that updates the LLM application configuration. |
updatedByUser - User
|
The user that updates the LLM application configuration. |
llmRagConfigId - ID!
|
|
llmRagConfig - LlmRagConfig!
|
|
createdAt - String!
|
Timestamp in ISO 8601 format. |
updatedAt - String!
|
Timestamp in ISO 8601 format. |
Example
{
"id": 4,
"name": "xyz789",
"teamId": 4,
"createdByUserId": "4",
"createdByUser": User,
"updatedByUserId": "4",
"updatedByUser": User,
"llmRagConfigId": "4",
"llmRagConfig": LlmRagConfig,
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
LlmApplicationDeployment
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
deployedByUser - User
|
|
llmApplicationId - ID!
|
|
llmApplication - LlmApplication!
|
|
llmRagConfig - LlmRagConfig!
|
|
numberOfCalls - Int!
|
|
numberOfTokens - Int!
|
|
numberOfInputTokens - Int!
|
|
numberOfOutputTokens - Int!
|
|
deployedAt - String!
|
|
createdAt - String!
|
|
updatedAt - String!
|
|
apiEndpoints - [LlmApplicationDeploymentApiEndpoint!]!
|
Example
{
"id": 4,
"deployedByUser": User,
"llmApplicationId": 4,
"llmApplication": LlmApplication,
"llmRagConfig": LlmRagConfig,
"numberOfCalls": 987,
"numberOfTokens": 123,
"numberOfInputTokens": 987,
"numberOfOutputTokens": 123,
"deployedAt": "abc123",
"createdAt": "abc123",
"updatedAt": "xyz789",
"apiEndpoints": [LlmApplicationDeploymentApiEndpoint]
}
LlmApplicationDeploymentApiEndpoint
LlmApplicationDeploymentInput
Fields
| Input Field | Description |
|---|---|
llmApplicationId - ID!
|
|
llmRagConfigDeploymentInput - LlmRagConfigDeploymentInput!
|
Example
{
"llmApplicationId": 4,
"llmRagConfigDeploymentInput": LlmRagConfigDeploymentInput
}
LlmApplicationPaginatedResponse
Description
Paginated list of results.
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
Total number of results that matches the applied filter |
pageInfo - PageInfo!
|
|
nodes - [LlmApplication!]!
|
List of results. See type LlmApplication. |
Example
{
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [LlmApplication]
}
LlmApplicationPlaygroundPrompt
LlmApplicationPlaygroundPromptCreateInput
LlmApplicationPlaygroundPromptUpdateInput
LlmApplicationPlaygroundRagConfig
LlmApplicationPlaygroundRagConfigCreateInput
Example
{
"name": "xyz789",
"llmApplicationId": "4",
"isCreateDefaultPromptEnable": false,
"defaultSystemInstruction": "xyz789",
"defaultUserInstruction": "abc123",
"defaultModelId": "4",
"defaultModelUrl": "abc123",
"defaultPrompts": ["xyz789"]
}
LlmApplicationPlaygroundRagConfigUpdateInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
name - String
|
|
llmRagConfigInput - LlmRagConfigUpdateInput!
|
Example
{
"id": "4",
"name": "abc123",
"llmRagConfigInput": LlmRagConfigUpdateInput
}
LlmApplicationRagRunnerJob
LlmApplicationUpdateInput
LlmBaseModel
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier for the base model. |
baseModelIdentifier - String!
|
The base model identifier. |
customModelIdentifier - String!
|
The custom model identifier. This is the identifier to submit to the job provider. |
teamId - ID
|
The team id that the base model belongs to. |
name - String!
|
Name of the base model. |
serviceProvider - GqlLlmModelProvider!
|
Fine tuning service provider. |
provider - GqlLlmBaseModelProvider!
|
The provider of the base model. |
region - String!
|
The region of the base model. |
methodTypes - [GqlLlmBaseModelMethodType!]!
|
The method types of the base model. |
supportedDatasetTypes - [GqlLlmBaseModelDatasetType!]!
|
The supported dataset types of the base model. |
supportedHyperparameters - [LlmBaseModelHyperparameter!]!
|
The supported hyperparameters of the base model. |
pricingModels - [LlmBaseModelPricingModel!]!
|
The pricing models of the base model. |
Example
{
"id": "4",
"baseModelIdentifier": "abc123",
"customModelIdentifier": "xyz789",
"teamId": "4",
"name": "xyz789",
"serviceProvider": "AMAZON_BEDROCK",
"provider": "AMAZON",
"region": "xyz789",
"methodTypes": ["FINE_TUNING"],
"supportedDatasetTypes": ["COMPLETION"],
"supportedHyperparameters": [
LlmBaseModelHyperparameter
],
"pricingModels": [LlmBaseModelPricingModel]
}
LlmBaseModelHyperparameter
Fields
| Field Name | Description |
|---|---|
name - GqlLlmBaseModelHyperparameterField!
|
The name of the hyperparameter. |
actualName - String!
|
The actual name of the hyperparameter acknowledged by the service provider. |
type - GqlLlmBaseModelHyperparameterValueType!
|
The type of the hyperparameter. |
minValue - Float!
|
The minimum value of the hyperparameter. |
maxValue - Float!
|
The maximum value of the hyperparameter. |
defaultValue - FloatOrString
|
The default value of the hyperparameter. |
Example
{
"name": "epochs",
"actualName": "xyz789",
"type": "INTEGER",
"minValue": 987.65,
"maxValue": 987.65,
"defaultValue": FloatOrString
}
LlmBaseModelPricingModel
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier for the pricing model. |
llmBaseModelId - ID!
|
The availability id of the pricing model. |
unitPrice - Float!
|
The unit price of the pricing model. |
unitType - GqlPricingModelUnitType!
|
The unit type of the pricing model. |
unitPurpose - GqlPricingModelUnitPurpose!
|
The purpose of the pricing model. |
Example
{
"id": 4,
"llmBaseModelId": "4",
"unitPrice": 123.45,
"unitType": "HOUR",
"unitPurpose": "DEPLOY"
}
LlmCustomModelInput
LlmEmbeddingModel
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
detail - LlmModelDetail!
|
|
teamId - ID
|
|
provider - GqlLlmModelProvider!
|
|
name - String!
|
|
displayName - String!
|
|
url - String!
|
|
maxTokens - Int!
|
|
dimensions - Int!
|
|
deployableModelId - String
|
|
isModelDeployable - Boolean!
|
|
createdAt - String!
|
|
updatedAt - String!
|
|
customDimension - Boolean!
|
Example
{
"id": "4",
"detail": LlmModelDetail,
"teamId": 4,
"provider": "AMAZON_BEDROCK",
"name": "abc123",
"displayName": "xyz789",
"url": "xyz789",
"maxTokens": 987,
"dimensions": 123,
"deployableModelId": "xyz789",
"isModelDeployable": true,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"customDimension": false
}
LlmEvaluation
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The LLM evaluation id. |
name - String!
|
The LLM evaluation name. This will be used as the project's name and the project document's name. |
teamId - ID!
|
The team id that the LLM evaluation belongs to. |
projectId - ID
|
The project id for the LLM evaluation. |
kind - ProjectKind
|
The project kind. Taken from the project. |
status - GqlLlmEvaluationStatus
|
The project's labeling status. Taken from the project. |
creationProgress - LlmEvaluationCreationProgress
|
The LLM evaluation creation progress. |
llmEvaluationRagConfigs - [LlmEvaluationRagConfig!]!
|
The LLM evaluation RAG configs. If the completions are provided, then this will be [] |
llmEvaluationPrompts - [LlmEvaluationPrompt!]!
|
The LLM evaluation prompts. Taken from the provided prompt set. |
llmEvaluationEvaluators - [LlmEvaluationEvaluator!]!
|
The LLM evaluation evaluators. |
llmEvaluationExecutions - [LlmEvaluationExecution!]!
|
The LLM evaluation executions. |
scheduledCommandConfig - ScheduledCommandConfig
|
The LLM evaluation scheduled command config. |
isScheduled - Boolean!
|
The LLM evaluation is scheduled or not. |
createdAt - String!
|
Timestamp in ISO 8601 format. |
updatedAt - String!
|
Timestamp in ISO 8601 format. |
isDeleted - Boolean!
|
The LLM evaluation is deleted or not. |
type - GqlLlmEvaluationType!
|
The LLM evaluation type |
schedulingStatus - GqlLlmEvaluationSchedulingStatus
|
The LLM evaluation scheduling status. |
nextSchedule - String
|
The LLM evaluation next schedule. |
Example
{
"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": false,
"createdAt": "xyz789",
"updatedAt": "abc123",
"isDeleted": true,
"type": "RATING",
"schedulingStatus": "NOT_STARTED",
"nextSchedule": "abc123"
}
LlmEvaluationAnswerScore
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the answer score. |
llmEvaluationEvaluatorId - ID!
|
The ID of the related LLM evaluation evaluator. |
llmEvaluationGeneratedAnswerId - ID!
|
The ID of the related LLM evaluation generated answer. |
score - Float!
|
The score of the answer. |
reason - String
|
The reason of the score. |
alertExpression - String
|
The alert expression of the score. |
createdAt - String!
|
The creation timestamp in ISO 8601 format. |
updatedAt - String!
|
The last update timestamp in ISO 8601 format. |
deletedAt - String
|
The deletion timestamp in ISO 8601 format, if deleted. |
Example
{
"id": "4",
"llmEvaluationEvaluatorId": 4,
"llmEvaluationGeneratedAnswerId": 4,
"score": 987.65,
"reason": "abc123",
"alertExpression": "abc123",
"createdAt": "abc123",
"updatedAt": "abc123",
"deletedAt": "xyz789"
}
LlmEvaluationAutomatedApplicationInput
Example
{
"llmRagConfigIds": ["4"],
"groundTruthId": "4",
"groundTruthFileObjectKey": "abc123"
}
LlmEvaluationAutomatedEvaluatorInput
Fields
| Input Field | Description |
|---|---|
metric - String!
|
TODO: rename to evaluator | Evaluator to use for evaluation. |
provider - String!
|
TODO: Remove this. |
llmModelId - String
|
LLM Model id to use for evaluation. |
llmEmbeddingModelId - String
|
LLM Embedding Model id to use for evaluation. |
alertExpression - String
|
Contains expression similar to question.activationConditionLogic |
Example
{
"metric": "abc123",
"provider": "xyz789",
"llmModelId": "xyz789",
"llmEmbeddingModelId": "xyz789",
"alertExpression": "abc123"
}
LlmEvaluationAutomatedEvaluatorUpdateInput
LlmEvaluationAutomatedInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
The LLM evaluation name. This will be used as the project's name and the project document's name. |
teamId - ID!
|
The team id that the LLM evaluation belongs to. |
applicationInput - LlmEvaluationAutomatedApplicationInput
|
Application input uses llm application as evaluation source |
pregeneratedInput - LlmEvaluationAutomatedPregeneratedInput
|
Pre-generated input uses pre-generated completions as evaluation source |
evaluators - [LlmEvaluationAutomatedEvaluatorInput!]!
|
Evaluator model(s) to use for evaluation. |
schedule - LlmEvaluationAutomatedScheduleInput
|
For scheduled automated evaluation only. |
Example
{
"name": "abc123",
"teamId": "4",
"applicationInput": LlmEvaluationAutomatedApplicationInput,
"pregeneratedInput": LlmEvaluationAutomatedPregeneratedInput,
"evaluators": [LlmEvaluationAutomatedEvaluatorInput],
"schedule": LlmEvaluationAutomatedScheduleInput
}
LlmEvaluationAutomatedPregeneratedInput
Fields
| Input Field | Description |
|---|---|
completionsFileObjectKey - String!
|
TODO: rename to groundTruthWithCompletionFileObjectKey | File containing ground truth with pre-generated completions to evaluate against. |
Example
{"completionsFileObjectKey": "abc123"}
LlmEvaluationAutomatedScheduleInput
Fields
| Input Field | Description |
|---|---|
cronPattern - String!
|
The cron pattern |
runImmediately - Boolean!
|
Evaluate immediately after creating the project |
numberOfRepetition - Int
|
The number of times to repeat the evaluation. Default to infinite. |
endTime - String
|
The end time of the evaluation. |
repeatInterval - Int
|
The repeat interval of the evaluation. |
Example
{
"cronPattern": "xyz789",
"runImmediately": false,
"numberOfRepetition": 987,
"endTime": "abc123",
"repeatInterval": 123
}
LlmEvaluationAutomatedStrategy
Fields
| Field Name | Description |
|---|---|
name - String!
|
TODO: rename this to evaluator | The strategy evaluator. |
displayName - String!
|
TODO: Rename this to metric | The strategy display name. |
provider - String!
|
The strategy provider. |
version - String!
|
The strategy version. |
description - String!
|
The strategy description. |
deprecated - Boolean!
|
The strategy metric deprecation status. |
evaluatorModelTypes - [GqlLlmModelType!]!
|
The evaluator model types supported by the strategy. |
minValue - Float!
|
|
maxValue - Float!
|
|
invertedValue - Boolean!
|
|
requiresContext - Boolean!
|
Example
{
"name": "abc123",
"displayName": "abc123",
"provider": "abc123",
"version": "xyz789",
"description": "abc123",
"deprecated": false,
"evaluatorModelTypes": ["LLM_MODEL"],
"minValue": 123.45,
"maxValue": 987.65,
"invertedValue": true,
"requiresContext": true
}
LlmEvaluationCreationProgress
Fields
| Field Name | Description |
|---|---|
status - LlmEvaluationCreationStatus!
|
The LLM evaluation creation status. |
jobId - String
|
The job id if the current progress is using a job. Will be null if the current progress is not using a job. |
error - String
|
The error message if the current progress is failed. Will be null if the current progress is not failed. |
Example
{
"status": "PREPARING",
"jobId": "xyz789",
"error": "abc123"
}
LlmEvaluationCreationStatus
Values
| Enum Value | Description |
|---|---|
|
|
The LLM evaluation is being created. |
|
|
The input is being prepared for the LLM automated evaluation. |
|
|
The uploaded prompt set is being read. |
|
|
The answer is being generated, if the completions are not provided. |
|
|
The NLP project is being created. |
|
|
The LLM evaluation is being run on python backend. |
|
|
The LLM evaluation creation is done. |
|
|
The LLM evaluation creation is failed. |
Example
"PREPARING"
LlmEvaluationDetail
Fields
| Field Name | Description |
|---|---|
prompt - String!
|
|
expectedCompletion - String
|
|
completions - [LlmEvaluationGeneratedAnswer!]
|
|
scores - [LlmEvaluationAnswerScore!]
|
Example
{
"prompt": "abc123",
"expectedCompletion": "abc123",
"completions": [LlmEvaluationGeneratedAnswer],
"scores": [LlmEvaluationAnswerScore]
}
LlmEvaluationDetailFilterInput
LlmEvaluationDetailPaginatedResponse
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [LlmEvaluationDetail!]!
|
Example
{
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [LlmEvaluationDetail]
}
LlmEvaluationEvaluator
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
llmEvaluationId - ID!
|
|
evaluator - String!
|
|
metric - String!
|
|
provider - String!
|
|
version - String!
|
|
llmModelId - ID
|
|
llmModel - LlmModel
|
|
llmEmbeddingModelId - ID
|
|
llmEmbeddingModel - LlmEmbeddingModel
|
|
alertExpression - String
|
|
createdAt - String!
|
|
updatedAt - String!
|
|
deletedAt - String
|
Example
{
"id": "4",
"llmEvaluationId": 4,
"evaluator": "xyz789",
"metric": "xyz789",
"provider": "xyz789",
"version": "abc123",
"llmModelId": "4",
"llmModel": LlmModel,
"llmEmbeddingModelId": "4",
"llmEmbeddingModel": LlmEmbeddingModel,
"alertExpression": "abc123",
"createdAt": "abc123",
"updatedAt": "xyz789",
"deletedAt": "xyz789"
}
LlmEvaluationEvaluatorSummary
Fields
| Field Name | Description |
|---|---|
llmEvaluationEvaluatorId - ID!
|
|
score - Float!
|
|
driftThreshold - DriftThreshold
|
Example
{
"llmEvaluationEvaluatorId": 4,
"score": 123.45,
"driftThreshold": DriftThreshold
}
LlmEvaluationExecution
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The LLM evaluation execution id. |
llmEvaluationId - ID!
|
The LLM evaluation id that the LLM evaluation execution belongs to. |
status - LlmEvaluationCreationStatus!
|
The LLM evaluation execution status. |
errorMessage - String
|
The LLM evaluation execution error message. |
createdAt - String!
|
Timestamp in ISO 8601 format. |
updatedAt - String!
|
Timestamp in ISO 8601 format. |
isDeleted - Boolean!
|
The LLM evaluation execution is deleted or not. |
Example
{
"id": "4",
"llmEvaluationId": "4",
"status": "PREPARING",
"errorMessage": "xyz789",
"createdAt": "abc123",
"updatedAt": "xyz789",
"isDeleted": true
}
LlmEvaluationGeneratedAnswer
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The LLM evaluation generated answer id. |
llmEvaluationPrompt - LlmEvaluationPrompt
|
The LLM evaluation prompt that the LLM evaluation generated answer belongs to. |
llmRagConfig - LlmRagConfig
|
The RAG config that is used to generate the answer if the answer is generated. Will be null if the answer is provided in the prompt set. |
llmRagConfigId - ID
|
ID of the RAG config that is used to generate the answer if the answer is generated. Will be null if the answer is provided in the prompt set. |
llmEvaluationGeneratedAnswerContexts - [LlmEvaluationGeneratedAnswerContext!]
|
The LLM evaluation generated contexts if the answer is generated. Will be null if the answer is provided in the prompt set. |
answer - String!
|
The answer, either provided in the prompt set or generated. |
llmEvaluationAnswerScores - [LlmEvaluationAnswerScore!]
|
The score of the generated answer. |
processingTime - Float
|
The processing time of the generated answer. |
cost - Float
|
The cost of the generated answer. |
createdAt - String!
|
Timestamp in ISO 8601 format. |
updatedAt - String!
|
Timestamp in ISO 8601 format. |
isDeleted - Boolean!
|
The LLM evaluation generated answer is deleted or not. |
Example
{
"id": "4",
"llmEvaluationPrompt": LlmEvaluationPrompt,
"llmRagConfig": LlmRagConfig,
"llmRagConfigId": 4,
"llmEvaluationGeneratedAnswerContexts": [
LlmEvaluationGeneratedAnswerContext
],
"answer": "abc123",
"llmEvaluationAnswerScores": [LlmEvaluationAnswerScore],
"processingTime": 123.45,
"cost": 987.65,
"createdAt": "abc123",
"updatedAt": "abc123",
"isDeleted": false
}
LlmEvaluationGeneratedAnswerContext
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The LLM evaluation generated answer context id. |
llmEvaluationGeneratedAnswerId - ID!
|
The LLM evaluation generated answer id that the LLM evaluation generated answer context belongs to. |
content - String!
|
The content of the context. |
metadata - String!
|
The metadata of the context. |
score - Float!
|
The score of the generated answer. |
createdAt - String!
|
Timestamp in ISO 8601 format. |
updatedAt - String!
|
Timestamp in ISO 8601 format. |
isDeleted - Boolean!
|
The LLM evaluation generated answer context is deleted or not. |
Example
{
"id": 4,
"llmEvaluationGeneratedAnswerId": 4,
"content": "xyz789",
"metadata": "xyz789",
"score": 123.45,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"isDeleted": false
}
LlmEvaluationInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
The LLM evaluation name. This will be used as the project's name and the project document's name. |
teamId - ID!
|
The team id that the LLM evaluation belongs to. |
llmRagConfigId - ID
|
The RAG config id, used to generate the answers. Required if the completions are not provided, and will be ignored if the completions are provided. |
numberOfCompletions - Int
|
The number of completions to be generated. Must be between 2 and 10 inclusively. Default is 1 for ProjectKind.LLM_EVALUATION and 2 for ProjectKind.LLM_RANKING. |
promptSetObjectKey - String!
|
The uploaded prompt set's object key. |
type - GqlLlmEvaluationType!
|
The evaluation type. |
documentAssignments - [DocumentAssignmentInput!]!
|
The document assignments. This will be used to create NLP project. |
projectSettings - ProjectSettingsInput!
|
The project settings. This will be used to create NLP project. |
Example
{
"name": "abc123",
"teamId": 4,
"llmRagConfigId": "4",
"numberOfCompletions": 123,
"promptSetObjectKey": "abc123",
"type": "RATING",
"documentAssignments": [DocumentAssignmentInput],
"projectSettings": ProjectSettingsInput
}
LlmEvaluationPaginatedResponse
Description
Paginated list of results.
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
Total number of results that matches the applied filter |
pageInfo - PageInfo!
|
|
nodes - [LlmEvaluation!]!
|
List of results. See type LlmEvaluation. |
Example
{
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [LlmEvaluation]
}
LlmEvaluationPrompt
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The LLM evaluation prompt id. |
llmEvaluationId - ID!
|
The LLM evaluation id that the LLM evaluation prompt belongs to. |
prompt - String!
|
The prompt from the uploaded prompt set. |
expectedCompletion - String
|
The expected completion from the uploaded prompt set. |
LlmEvaluationGeneratedAnswer - LlmEvaluationGeneratedAnswer
|
The completions from the uploaded prompt set. |
createdAt - String!
|
Timestamp in ISO 8601 format. |
updatedAt - String!
|
Timestamp in ISO 8601 format. |
isDeleted - Boolean!
|
The LLM evaluation prompt is deleted or not. |
Example
{
"id": "4",
"llmEvaluationId": "4",
"prompt": "abc123",
"expectedCompletion": "abc123",
"LlmEvaluationGeneratedAnswer": LlmEvaluationGeneratedAnswer,
"createdAt": "abc123",
"updatedAt": "xyz789",
"isDeleted": true
}
LlmEvaluationRagConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The LLM evaluation RAG config id. |
llmEvaluationId - ID!
|
The LLM evaluation id that the LLM evaluation RAG config belongs to. |
llmApplication - LlmApplication
|
The LLM application. Used to get the LLM application name. Will be null if deleted. |
llmPlaygroundRagConfig - LlmApplicationPlaygroundRagConfig
|
The LLM playground RAG config, used to get the prompt template name if the RAG config is not deployed yet. Will be null if deleted. |
llmDeploymentRagConfig - LlmApplicationDeployment
|
The LLM deployment RAG config, will be the indicator that the prompt template name should be generated if the RAG config is deployed. Will be null if deleted. |
llmRagConfigId - ID
|
The source of RAG config's id. Will be null if deleted. |
llmSnapshotRagConfig - LlmRagConfig!
|
The snapshot of the RAG config. This will be used to generate the answers. Cannot be deleted. |
llmApplicationConfigurationRagConfig - LlmApplicationConfiguration
|
The LLM application configuration RAG config if evaluation is from saved application. Will be null if evaluation is from deployment. |
ragConfigSourceType - GqlLlmEvaluationRagConfigSourceType!
|
The source of RAG config's id. |
createdAt - String!
|
Timestamp in ISO 8601 format. |
updatedAt - String!
|
Timestamp in ISO 8601 format. |
isDeleted - Boolean!
|
The LLM evaluation rag config is deleted or not. |
Example
{
"id": "4",
"llmEvaluationId": 4,
"llmApplication": LlmApplication,
"llmPlaygroundRagConfig": LlmApplicationPlaygroundRagConfig,
"llmDeploymentRagConfig": LlmApplicationDeployment,
"llmRagConfigId": 4,
"llmSnapshotRagConfig": LlmRagConfig,
"llmApplicationConfigurationRagConfig": LlmApplicationConfiguration,
"ragConfigSourceType": "APPLICATION_DEPLOYMENT",
"createdAt": "abc123",
"updatedAt": "abc123",
"isDeleted": false
}
LlmEvaluationRagConfigSummary
Fields
| Field Name | Description |
|---|---|
llmEvaluationRagConfigId - ID
|
|
cost - Float
|
|
processingTime - Float
|
|
scores - [LlmEvaluationEvaluatorSummary!]
|
Example
{
"llmEvaluationRagConfigId": "4",
"cost": 987.65,
"processingTime": 123.45,
"scores": [LlmEvaluationEvaluatorSummary]
}
LlmEvaluationSummary
Fields
| Field Name | Description |
|---|---|
llmEvaluationId - ID!
|
|
llmEvaluation - LlmEvaluation!
|
|
totalPromptCount - Int!
|
|
totalUnansweredPromptCount - Int!
|
|
totalFailedThresholdCompletionsCount - Int!
|
|
summaries - [LlmEvaluationRagConfigSummary!]!
|
Example
{
"llmEvaluationId": "4",
"llmEvaluation": LlmEvaluation,
"totalPromptCount": 987,
"totalUnansweredPromptCount": 123,
"totalFailedThresholdCompletionsCount": 123,
"summaries": [LlmEvaluationRagConfigSummary]
}
LlmInstanceCostDetail
LlmInstanceTypeDetail
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
cost - LlmInstanceCostDetail
|
|
createdAt - String
|
Example
{
"name": "xyz789",
"cost": LlmInstanceCostDetail,
"createdAt": "abc123"
}
LlmModel
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
detail - LlmModelDetail!
|
|
teamId - ID
|
|
provider - GqlLlmModelProvider!
|
|
name - String!
|
|
displayName - String!
|
|
url - String!
|
|
maxTemperature - Float!
|
|
maxTopP - Float!
|
|
maxTokens - Int!
|
|
maxContextWindow - Int!
|
|
defaultTemperature - Float!
|
|
defaultTopP - Float!
|
|
defaultMaxTokens - Int!
|
|
llmModelFineTuningJob - LlmModelFineTuningJob
|
|
deployableModelId - String
|
|
isModelDeployable - Boolean!
|
|
forceAnonymization - Boolean!
|
|
createdAt - String!
|
|
updatedAt - String!
|
Example
{
"id": "4",
"detail": LlmModelDetail,
"teamId": 4,
"provider": "AMAZON_BEDROCK",
"name": "xyz789",
"displayName": "xyz789",
"url": "abc123",
"maxTemperature": 987.65,
"maxTopP": 987.65,
"maxTokens": 123,
"maxContextWindow": 987,
"defaultTemperature": 987.65,
"defaultTopP": 987.65,
"defaultMaxTokens": 123,
"llmModelFineTuningJob": LlmModelFineTuningJob,
"deployableModelId": "xyz789",
"isModelDeployable": true,
"forceAnonymization": true,
"createdAt": "abc123",
"updatedAt": "abc123"
}
LlmModelDeployInput
Fields
| Input Field | Description |
|---|---|
teamId - ID!
|
|
provider - GqlLlmModelProvider!
|
|
name - String!
|
|
url - String!
|
|
instanceType - String!
|
Example
{
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "xyz789",
"url": "xyz789",
"instanceType": "xyz789"
}
LlmModelDetail
Fields
| Field Name | Description |
|---|---|
status - GqlLlmModelStatus!
|
|
instanceType - String
|
|
instanceTypeDetail - LlmInstanceTypeDetail
|
Example
{
"status": "AVAILABLE",
"instanceType": "abc123",
"instanceTypeDetail": LlmInstanceTypeDetail
}
LlmModelFineTuningCostPredictionInput
Fields
| Input Field | Description |
|---|---|
teamId - ID!
|
The team id that the resource belongs to. |
baseModelId - String
|
The fine tuning job base model name, which is a foundation model's modelId. |
fineTunedJobId - String
|
The previous trained model job entity's id (current model comes from other fine-tuned model) |
epochs - Int!
|
This will be used as iterations for the entire training dataset |
trainingDataset - LlmModelFineTuningTrainingDataset!
|
The training dataset for fine tuning. |
validation - LlmModelFineTuningValidation
|
The Validation dataset for fine tuning. |
Example
{
"teamId": 4,
"baseModelId": "abc123",
"fineTunedJobId": "abc123",
"epochs": 123,
"trainingDataset": LlmModelFineTuningTrainingDataset,
"validation": LlmModelFineTuningValidation
}
LlmModelFineTuningCostPredictionJob
LlmModelFineTuningInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
The fine tuned model name. This will be used as a name for the fine tuned model |
teamId - ID!
|
The team id that the fine tuned model belongs to. |
baseModelId - String
|
The fine tuning job base model name, which is a foundation model's modelId. |
fineTunedJobId - String
|
The previous trained model job entity's id (current model comes from other fine-tuned model) |
trainingDataset - LlmModelFineTuningTrainingDataset!
|
The traing dataset for fine tuning. |
validation - LlmModelFineTuningValidation
|
Will be used to validate training dataset |
epochs - Int!
|
The fine tuning hyperparameters. This will be used as iterations for the entire training dataset |
learningRate - Float
|
The fine tuning hyperparameters. Used as a rate after model paramters are updated after each batch. |
batchSize - Int!
|
The fine tuning hyperparameters. Number of samples processed before updating model parameters. |
earlyStoppingThreshold - Float
|
The fine tuning hyperparameters. Minimum imporvment in loss required to prevent training termination. |
earlyStoppingPatience - Int
|
The fine tuning hyperparameters. Tolerance number for stagnation in the loss metric before stopping the training. |
learningRateWarmUpStep - Int
|
The fine tuning hyperparameters. Number of iterations over which the learning rate is gradually incireased to specified rate. |
learningRateMultiplier - Float
|
Multiplier that influences the learning rate at which model parameters are updated after each batch. |
Example
{
"name": "abc123",
"teamId": 4,
"baseModelId": "xyz789",
"fineTunedJobId": "xyz789",
"trainingDataset": LlmModelFineTuningTrainingDataset,
"validation": LlmModelFineTuningValidation,
"epochs": 123,
"learningRate": 987.65,
"batchSize": 987,
"earlyStoppingThreshold": 123.45,
"earlyStoppingPatience": 987,
"learningRateWarmUpStep": 123,
"learningRateMultiplier": 987.65
}
LlmModelFineTuningJob
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The fine tuning job id. |
name - String!
|
The display name of the fine tuned model. |
teamId - ID!
|
The team id of the fine tuning job. |
status - GqlLlmModelFineTuningStatus!
|
The fine tuning job status. |
errorMessage - String
|
The error message in case the job failed. |
baseModelId - String!
|
The fine tuning job base model name, which is a foundation model's modelId. |
parentId - String
|
The previous trained model job entity's id (current model comes from other fine-tuned model) |
resultModelId - String
|
The ARN of the resulting fine-tuned model. |
trainingJobId - String
|
The training job ARN. |
trainingDataset - GroundTruthSet
|
The fine tuning job training dataset. |
trainingDatasetFilename - String
|
The filename of the training dataset |
validationSize - Int
|
The percentage of the training dataset used as validation, is null when validation dataset is not taken from training dataset. |
validationDataset - GroundTruthSet
|
The fine tuning job validation dataset, is null when validation dataset is taken from a certain percentage of the training dataset. |
validationDatasetFilename - String
|
The filename of the validation dataset |
epochs - Int!
|
The number of iterations through the entire training dataset. |
learningRate - Float
|
The rate at which model parameters are updated after each batch. |
batchSize - Int!
|
The number of samples processed before updating model parameters. |
earlyStoppingThreshold - Float
|
Minimum improvement in validation loss required to prevent premature termination of the training process. |
earlyStoppingPatience - Int
|
Tolerance for stagnation in the validation loss metric before stopping the training process. |
learningRateWarmUpStep - Int
|
The number of iterations over which the learning rate is gradually increased to the specified rate. |
learningRateMultiplier - Float
|
Multiplier that influences the learning rate at which model parameters are updated after each batch. |
createdByUser - User
|
The user who creates the fine tuning job |
createdAt - String!
|
The fine tuning job created at. |
updatedAt - String!
|
The fine tuning job updated at. |
Example
{
"id": "4",
"name": "xyz789",
"teamId": "4",
"status": "IN_PROGRESS",
"errorMessage": "abc123",
"baseModelId": "abc123",
"parentId": "abc123",
"resultModelId": "xyz789",
"trainingJobId": "xyz789",
"trainingDataset": GroundTruthSet,
"trainingDatasetFilename": "abc123",
"validationSize": 123,
"validationDataset": GroundTruthSet,
"validationDatasetFilename": "xyz789",
"epochs": 987,
"learningRate": 987.65,
"batchSize": 123,
"earlyStoppingThreshold": 123.45,
"earlyStoppingPatience": 123,
"learningRateWarmUpStep": 987,
"learningRateMultiplier": 987.65,
"createdByUser": User,
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
LlmModelFineTuningTrainingDataset
Example
{
"groundTruthId": 4,
"fileObjectKey": "abc123",
"filename": "xyz789"
}
LlmModelFineTuningValidation
Fields
| Input Field | Description |
|---|---|
percentage - Int
|
The validation dataset percentage. Percentage of what will be used as validation from the training dataset. |
dataset - LlmModelFineTuningTrainingDataset
|
The validation dataset file object key. Using newly uploaded dataset for validation. |
Example
{
"percentage": 123,
"dataset": LlmModelFineTuningTrainingDataset
}
LlmModelMetadata
Fields
| Field Name | Description |
|---|---|
providers - [GqlLlmModelProvider!]!
|
|
name - String!
|
|
displayName - String!
|
|
description - String!
|
|
type - GqlLlmModelMetadataType!
|
|
status - GqlLlmModelStatus!
|
Example
{
"providers": ["AMAZON_BEDROCK"],
"name": "xyz789",
"displayName": "xyz789",
"description": "abc123",
"type": "QUESTION_ANSWERING",
"status": "AVAILABLE"
}
LlmModelSpec
Fields
| Field Name | Description |
|---|---|
supportedInferenceInstanceTypes - [String!]!
|
|
supportedInferenceInstanceTypeDetails - [LlmInstanceTypeDetail!]!
|
Example
{
"supportedInferenceInstanceTypes": [
"xyz789"
],
"supportedInferenceInstanceTypeDetails": [
LlmInstanceTypeDetail
]
}
LlmRagConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
llmModel - LlmModel
|
|
systemInstruction - String
|
|
userInstruction - String
|
|
raw - String
|
|
temperature - Float!
|
|
topP - Float!
|
|
maxTokens - Int!
|
|
advancedHyperparameters - LlmRagConfigAdvancedHyperparameters!
|
|
maxVectorStoreTokens - Int!
|
|
llmVectorStore - LlmVectorStore
|
|
similarityThreshold - Float
|
|
enableAnonymization - Boolean!
|
|
createdAt - String!
|
|
updatedAt - String!
|
Example
{
"id": "4",
"llmModel": LlmModel,
"systemInstruction": "xyz789",
"userInstruction": "xyz789",
"raw": "abc123",
"temperature": 123.45,
"topP": 987.65,
"maxTokens": 987,
"advancedHyperparameters": LlmRagConfigAdvancedHyperparameters,
"maxVectorStoreTokens": 123,
"llmVectorStore": LlmVectorStore,
"similarityThreshold": 123.45,
"enableAnonymization": true,
"createdAt": "xyz789",
"updatedAt": "abc123"
}
LlmRagConfigAdvancedHyperparameters
Example
LlmRagConfigAdvancedHyperparameters
LlmRagConfigDeploymentInput
Example
{
"llmModelId": "4",
"systemInstruction": "abc123",
"userInstruction": "xyz789",
"temperature": 123.45,
"topP": 123.45,
"maxTokens": 987,
"llmVectorStoreId": "4",
"similarityThreshold": 987.65,
"enableAnonymization": false
}
LlmRagConfigUpdateInput
Fields
| Input Field | Description |
|---|---|
llmModelId - ID
|
|
systemInstruction - String
|
|
userInstruction - String
|
|
temperature - Float
|
|
topP - Float
|
|
maxTokens - Int
|
|
advancedHyperparameters - LlmRagConfigAdvancedHyperparameters
|
|
maxVectorStoreTokens - Int
|
|
llmVectorStoreId - ID
|
|
similarityThreshold - Float
|
|
enableAnonymization - Boolean
|
Example
{
"llmModelId": "4",
"systemInstruction": "xyz789",
"userInstruction": "abc123",
"temperature": 123.45,
"topP": 123.45,
"maxTokens": 123,
"advancedHyperparameters": LlmRagConfigAdvancedHyperparameters,
"maxVectorStoreTokens": 987,
"llmVectorStoreId": 4,
"similarityThreshold": 123.45,
"enableAnonymization": true
}
LlmUsage
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
teamId - ID!
|
|
name - String!
|
|
type - GqlLlmUsageType!
|
|
modelDetail - LlmUsageModelDetail!
|
|
metadata - [LlmUsageMetadata!]
|
|
cost - Float!
|
|
costCurrency - String!
|
|
usage - Int!
|
|
createdAt - String!
|
|
updatedAt - String!
|
Example
{
"id": 4,
"teamId": 4,
"name": "xyz789",
"type": "VECTOR_STORE",
"modelDetail": LlmUsageModelDetail,
"metadata": [LlmUsageMetadata],
"cost": 123.45,
"costCurrency": "abc123",
"usage": 987,
"createdAt": "abc123",
"updatedAt": "abc123"
}
LlmUsageDetail
Fields
| Field Name | Description |
|---|---|
documents - [LlmUsageDocument!]
|
|
sourceDocuments - [LlmUsageSourceDocument!]
|
Example
{
"documents": [LlmUsageDocument],
"sourceDocuments": [LlmUsageSourceDocument]
}
LlmUsageDocument
LlmUsageDocumentScalar
Example
LlmUsageDocumentScalar
LlmUsageExternalSource
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
cloudService - ObjectStorageClientName
|
|
bucketName - String
|
Example
{
"id": 4,
"cloudService": "AWS_S3",
"bucketName": "abc123"
}
LlmUsageMetadata
LlmUsageModelDetail
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
provider - GqlLlmModelProvider!
|
|
unitPrice - Float!
|
|
unitCurrency - String!
|
Example
{
"id": 4,
"name": "abc123",
"provider": "AMAZON_BEDROCK",
"unitPrice": 123.45,
"unitCurrency": "abc123"
}
LlmUsageModelSummary
Fields
| Field Name | Description |
|---|---|
modelName - String!
|
|
modelProvider - GqlLlmModelProvider!
|
|
totalUsage - Int!
|
Example
{
"modelName": "abc123",
"modelProvider": "AMAZON_BEDROCK",
"totalUsage": 987
}
LlmUsagePaginatedResponse
Description
Paginated list of results.
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
Total number of results that matches the applied filter |
pageInfo - PageInfo!
|
|
nodes - [LlmUsage!]!
|
List of results. See type LlmUsage. |
Example
{
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [LlmUsage]
}
LlmUsageSourceDocument
Fields
| Field Name | Description |
|---|---|
source - LlmUsageExternalSource!
|
|
documents - LlmUsageDocumentScalar
|
Example
{
"source": LlmUsageExternalSource,
"documents": LlmUsageDocumentScalar
}
LlmUsageSummary
Fields
| Field Name | Description |
|---|---|
totalCost - Float!
|
|
totalCostCurrency - String!
|
|
modelSummaries - [LlmUsageModelSummary!]!
|
Example
{
"totalCost": 123.45,
"totalCostCurrency": "abc123",
"modelSummaries": [LlmUsageModelSummary]
}
LlmVectorStore
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
teamId - ID!
|
|
createdByUser - User
|
|
llmEmbeddingModel - LlmEmbeddingModel
|
|
provider - GqlLlmVectorStoreProvider!
|
|
collectionId - String!
|
|
name - String!
|
|
status - GqlLlmVectorStoreStatus!
|
|
chunkSize - Int
|
|
overlap - Int
|
|
documents - [LlmVectorStoreDocumentScalar!]
|
|
documentStatusCount - LlmVectorStoreDocumentCountByStatus
|
|
sourceDocuments - [LlmVectorStoreSourceDocument!]
|
|
questions - [Question!]
|
|
jobId - String
|
|
createdAt - String!
|
|
updatedAt - String!
|
|
dimension - Int
|
Example
{
"id": "4",
"teamId": 4,
"createdByUser": User,
"llmEmbeddingModel": LlmEmbeddingModel,
"provider": "DATASAUR",
"collectionId": "xyz789",
"name": "abc123",
"status": "CREATED",
"chunkSize": 987,
"overlap": 987,
"documents": [LlmVectorStoreDocumentScalar],
"documentStatusCount": LlmVectorStoreDocumentCountByStatus,
"sourceDocuments": [LlmVectorStoreSourceDocument],
"questions": [Question],
"jobId": "abc123",
"createdAt": "abc123",
"updatedAt": "xyz789",
"dimension": 123
}
LlmVectorStoreActivity
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
llmVectorStoreId - ID!
|
|
llmVectorStoreName - String!
|
|
llmVectorStoreDocumentId - ID
|
|
llmVectorStoreDocumentName - String
|
|
userId - ID
|
|
userName - String
|
|
event - GqlLlmVectorStoreActivityEvent!
|
|
details - String
|
|
bucketName - String
|
|
bucketSource - String
|
|
createdAt - String!
|
|
updatedAt - String!
|
Example
{
"id": "4",
"llmVectorStoreId": 4,
"llmVectorStoreName": "xyz789",
"llmVectorStoreDocumentId": 4,
"llmVectorStoreDocumentName": "xyz789",
"userId": "4",
"userName": "xyz789",
"event": "CREATE_LLM_VECTOR_STORE",
"details": "xyz789",
"bucketName": "xyz789",
"bucketSource": "xyz789",
"createdAt": "abc123",
"updatedAt": "abc123"
}
LlmVectorStoreAnswer
Fields
| Field Name | Description |
|---|---|
llmVectorStoreDocumentId - ID!
|
|
answers - AnswerScalar!
|
|
updatedAt - DateTime
|
Example
{
"llmVectorStoreDocumentId": 4,
"answers": AnswerScalar,
"updatedAt": "2007-12-03T10:15:30Z"
}
LlmVectorStoreDocument
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
objectKey - String
|
|
path - String!
|
|
previewPath - String!
|
|
type - GqlLlmVectorStoreDocumentType!
|
|
status - GqlLlmVectorStoreDocumentStatus!
|
|
errorMessage - String
|
|
llmVectorStoreSource - LlmVectorStoreSource
|
|
llmVectorStoreSourceId - ID
|
|
createdAt - String!
|
|
updatedAt - String!
|
Example
{
"id": "4",
"name": "xyz789",
"objectKey": "abc123",
"path": "abc123",
"previewPath": "xyz789",
"type": "FOLDER",
"status": "QUEUED",
"errorMessage": "abc123",
"llmVectorStoreSource": LlmVectorStoreSource,
"llmVectorStoreSourceId": 4,
"createdAt": "abc123",
"updatedAt": "abc123"
}
LlmVectorStoreDocumentCountByStatus
Example
{
"totalQueued": 987,
"totalProcessing": 123,
"totalDeleting": 123,
"totalCompleted": 987,
"totalProcessFailed": 123,
"totalDeleteFailed": 123,
"totalDocumentInvalid": 987,
"totalDocuments": 987
}
LlmVectorStoreDocumentInput
Description
To provide the document, choose one of these fields:
filefileUrlexternalImportableUrlexternalObjectStorageFileKeyobjectKey
Fields
| Input Field | Description |
|---|---|
fileName - String!
|
Required. File Name. It affects the File Extension and exported file. |
name - String
|
Optional. Document Name. It affects the document title section. |
file - Upload
|
Optional. Fill this one if you want to directly upload a file. |
fileUrl - String
|
Optional. Fill this one if you want to use a publicly accessible file without upload. The user will be able to access the file directly each time the document is loaded through the browser. |
externalImportableUrl - String
|
Optional. Fill this one if you want Datasaur to download your file from the URL. Unlike fileUrl, you can ignore the externalImportableUrl as soon as the llm vector store is successfully created since the file will be uploaded to Datasaur's server. |
objectKey - String
|
Optional. Fill this with the objectKey returned by uploading the file via upload proxy REST API. |
Example
{
"fileName": "abc123",
"name": "xyz789",
"file": Upload,
"fileUrl": "abc123",
"externalImportableUrl": "abc123",
"objectKey": "xyz789"
}
LlmVectorStoreDocumentPaginatedResponse
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [LlmVectorStoreDocumentPaginationItem!]!
|
Example
{
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [LlmVectorStoreDocumentPaginationItem]
}
LlmVectorStoreDocumentPaginationItem
Example
{
"id": "4",
"name": "xyz789",
"objectKey": "xyz789",
"path": "abc123",
"previewPath": "abc123",
"type": "FOLDER",
"status": "QUEUED",
"errorMessage": "xyz789",
"llmVectorStoreSourceId": "4",
"createdAt": "abc123",
"updatedAt": "xyz789"
}
LlmVectorStoreDocumentScalar
Example
LlmVectorStoreDocumentScalar
LlmVectorStoreDocumentsPaginatedFilterInput
Fields
| Input Field | Description |
|---|---|
llmVectorStoreSourceFilter - LlmVectorStoreDocumentsPaginatedSourceFilterInput
|
Filter by the source. Empty means all sources. |
namePattern - LlmVectorStoreDocumentsPaginatedNamePatternFilterInput
|
Filter by the document's name (including path). |
types - [GqlLlmVectorStoreDocumentType!]
|
Filter by the document types, Empty array means all types. |
statuses - [GqlLlmVectorStoreDocumentStatus!]
|
Filter by the document statuses, Empty array means all statuses except DELETED. |
Example
{
"llmVectorStoreSourceFilter": LlmVectorStoreDocumentsPaginatedSourceFilterInput,
"namePattern": LlmVectorStoreDocumentsPaginatedNamePatternFilterInput,
"types": ["FOLDER"],
"statuses": ["QUEUED"]
}
LlmVectorStoreDocumentsPaginatedNamePatternFilterInput
Fields
| Input Field | Description |
|---|---|
caseSensitive - Boolean
|
Use case sensitive search. This can be slow for large datasets. |
globPattern - String
|
Search for documents with the given glob pattern. Superseeds prefix filter. |
prefixFilter - LlmVectorStoreDocumentsPaginatedPrefixFilterInput
|
Will be ignored if globPattern is provided. Search for documents with the given prefix. |
Example
{
"caseSensitive": false,
"globPattern": "xyz789",
"prefixFilter": LlmVectorStoreDocumentsPaginatedPrefixFilterInput
}
LlmVectorStoreDocumentsPaginatedPrefixFilterInput
Fields
| Input Field | Description |
|---|---|
prefix - String!
|
|
matchAsString - Boolean
|
If true, prefix will be treated as a normal string and will filter documents that start with the prefix,. If false or empty, prefix will be treated as a folder path and only matches if document is in the 'folder' of the prefix. |
depth - Int
|
Will be ignored if matchAsString is true. Sets the depth of the prefix filter, 0 means only return files & folders located directly under the prefix, 1 means return files & folders directly under the prefix and files in the first level of subfolders, and so on. Negative numbers means no limit. Default is 0. |
Example
{
"prefix": "xyz789",
"matchAsString": false,
"depth": 123
}
LlmVectorStoreDocumentsPaginatedSortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"id"
LlmVectorStoreDocumentsPaginatedSortInput
Fields
| Input Field | Description |
|---|---|
field - LlmVectorStoreDocumentsPaginatedSortField!
|
|
order - OrderType!
|
Example
{"field": "id", "order": "ASC"}
LlmVectorStoreDocumentsPaginatedSourceFilterInput
Fields
| Input Field | Description |
|---|---|
includeLocalDocuments - Boolean!
|
Adds local documents to the result. |
llmVectorStoreSourceIds - [ID!]!
|
Source ids to filter, If empty and includeLocalDocuments is true, it will only return local documents. If includeLocalDocuments is false, it will return all documents. |
Example
{
"includeLocalDocuments": false,
"llmVectorStoreSourceIds": ["4"]
}
LlmVectorStoreLaunchJob
LlmVectorStorePaginatedResponse
Description
Paginated list of results.
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
Total number of results that matches the applied filter |
pageInfo - PageInfo!
|
|
nodes - [LlmVectorStore!]!
|
List of results. See type LlmVectorStore. |
Example
{
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [LlmVectorStore]
}
LlmVectorStoreSearchFilterInput
Fields
| Input Field | Description |
|---|---|
fileIds - [ID!]
|
Example
{"fileIds": [4]}
LlmVectorStoreSearchInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
query - String!
|
|
filter - LlmVectorStoreSearchFilterInput
|
|
minScore - Float
|
|
maxSize - Int
|
Example
{
"id": 4,
"query": "xyz789",
"filter": LlmVectorStoreSearchFilterInput,
"minScore": 123.45,
"maxSize": 987
}
LlmVectorStoreSearchResponse
LlmVectorStoreSource
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
llmVectorStoreId - ID!
|
|
externalObjectStorage - ExternalObjectStorage
|
|
rules - LlmVectorStoreSourceRules!
|
|
isDeleting - Boolean!
|
|
createdAt - String!
|
|
updatedAt - String!
|
Example
{
"id": 4,
"llmVectorStoreId": 4,
"externalObjectStorage": ExternalObjectStorage,
"rules": LlmVectorStoreSourceRules,
"isDeleting": false,
"createdAt": "abc123",
"updatedAt": "abc123"
}
LlmVectorStoreSourceCheckRulesResult
Fields
| Field Name | Description |
|---|---|
valid - Boolean!
|
|
invalidRules - LlmVectorStoreSourceInvalidRules
|
Example
{
"valid": true,
"invalidRules": LlmVectorStoreSourceInvalidRules
}
LlmVectorStoreSourceCreateInput
Fields
| Input Field | Description |
|---|---|
externalObjectStorageId - ID!
|
|
rules - LlmVectorStoreSourceRulesInput!
|
|
refresh - Boolean
|
Example
{
"externalObjectStorageId": "4",
"rules": LlmVectorStoreSourceRulesInput,
"refresh": true
}
LlmVectorStoreSourceDocument
Fields
| Field Name | Description |
|---|---|
source - LlmVectorStoreSource!
|
|
documents - LlmVectorStoreDocumentScalar
|
Example
{
"source": LlmVectorStoreSource,
"documents": LlmVectorStoreDocumentScalar
}
LlmVectorStoreSourceDocumentScalar
Description
Example of LlmVectorStoreSourceDocumentScalar
{
"data": {
"getLlmVectorStoreSourceNewDocuments": [
{
"name": "doraemon.pdf",
"status": "NEW"
},
{
"folder nested": [
{
"folder inside": [
{
"name": "tes chunk.txt",
"status": "NEW"
}
]
},
{
"name": "tes chunk.txt",
"status": "NEW"
}
]
},
{
"folder1": [
{
"name": "doraemon.pdf",
"status": "NEW"
},
{
"name": "tes chunk.txt",
"status": "NEW"
},
{
"name": "tes copy.txt",
"status": "NEW"
}
]
},
{
"name": "tes copy.txt",
"status": "NEW"
}
]
}
}
{
"data": {
"getLlmVectorStoreSourceUpdatedDocuments": [
{
"folder1": [
{
"name": "tes chunk.txt",
"status": "NEW"
},
{
"name": "tes copy.txt",
"status": "NEW"
},
{
"name": "tes chunk lama.txt",
"status": "DELETED"
},
{
"name": "tes copy lama.txt",
"status": "DELETED"
}
]
}
]
}
}
{
"data": {
"getLlmVectorStoreSourceDeletedDocuments": [
{
"name": "doraemon.pdf",
"status": "DELETED"
},
{
"folder nested": [
{
"folder inside": [
{
"name": "tes chunk.txt",
"status": "DELETED"
}
]
},
{
"name": "tes chunk.txt",
"status": "DELETED"
}
]
},
{
"folder1": [
{
"name": "doraemon.pdf",
"status": "DELETED"
},
{
"name": "tes chunk lama.txt",
"status": "DELETED"
},
{
"name": "tes copy lama.txt",
"status": "DELETED"
}
]
},
{
"name": "tes copy.txt",
"status": "DELETED"
}
]
}
}
Example
LlmVectorStoreSourceDocumentScalar
LlmVectorStoreSourceInvalidRules
LlmVectorStoreSourceRule
LlmVectorStoreSourceRuleInput
LlmVectorStoreSourceRules
Fields
| Field Name | Description |
|---|---|
includeRule - LlmVectorStoreSourceRule!
|
|
excludeRule - LlmVectorStoreSourceRule!
|
Example
{
"includeRule": LlmVectorStoreSourceRule,
"excludeRule": LlmVectorStoreSourceRule
}
LlmVectorStoreSourceRulesInput
Fields
| Input Field | Description |
|---|---|
includeRule - LlmVectorStoreSourceRuleInput!
|
|
excludeRule - LlmVectorStoreSourceRuleInput!
|
Example
{
"includeRule": LlmVectorStoreSourceRuleInput,
"excludeRule": LlmVectorStoreSourceRuleInput
}
LlmVectorStoreSourceUpdateInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
rules - LlmVectorStoreSourceRulesInput
|
|
refresh - Boolean
|
Example
{
"id": 4,
"rules": LlmVectorStoreSourceRulesInput,
"refresh": false
}
LoadLlmApplicationConfigurationInput
LoginInput
LoginResult
Fields
| Field Name | Description |
|---|---|
type - LoginResultType!
|
|
successData - LoginSuccess!
|
Example
{"type": "SUCCESS", "successData": LoginSuccess}
LoginResultType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SUCCESS"
LoginSuccess
MarkUnusedLabelClassInput
MarkedUnusedLabelClassIds
Fields
| Field Name | Description |
|---|---|
documentId - ID!
|
|
labelSetId - ID!
|
|
labelClassIds - [String!]!
|
Example
{
"documentId": 4,
"labelSetId": 4,
"labelClassIds": ["abc123"]
}
MatrixClass
MatrixData
MediaDisplayStrategy
Description
Determines how media displayed in editor.
Values
| Enum Value | Description |
|---|---|
|
|
Media will be not rendered. |
|
|
Media will be rendered as thumbnail. |
|
|
Media will be rendered with its original size. |
Example
"NONE"
ModelMetadata
Example
ModelMetadata
ModifyQuestionConfigInput
Description
Should have the similar definition as QuestionConfigInput. The difference being:
- The
questionsfield type. Here it is[ModifyQuestionInput!].
Fields
| Input Field | Description |
|---|---|
defaultValue - String
|
|
format - String
|
|
multiple - Boolean
|
|
multiline - Boolean
|
|
options - [QuestionConfigOptionsInput!]
|
|
leafOptionsOnly - Boolean
|
|
questions - [ModifyQuestionInput!]
|
|
minLength - Int
|
|
maxLength - Int
|
|
pattern - String
|
|
theme - SliderTheme
|
Legacy theming config. Please use gradientColors.
|
gradientColors - [String!]
|
|
min - Int
|
|
max - Int
|
|
step - Int
|
|
hideScaleLabel - Boolean
|
|
hint - String
|
Example
{
"defaultValue": "xyz789",
"format": "xyz789",
"multiple": true,
"multiline": true,
"options": [QuestionConfigOptionsInput],
"leafOptionsOnly": true,
"questions": [ModifyQuestionInput],
"minLength": 123,
"maxLength": 123,
"pattern": "xyz789",
"theme": "PLAIN",
"gradientColors": ["xyz789"],
"min": 123,
"max": 123,
"step": 123,
"hideScaleLabel": false,
"hint": "xyz789"
}
ModifyQuestionInput
Description
Should have the similar definition as QuestionInput. The difference being:
- Has extra
internalIdfield. - The
configfield type. Here it isModifyQuestionConfigInput.
Fields
| Input Field | Description |
|---|---|
internalId - String
|
|
id - Int
|
|
label - String
|
|
required - Boolean
|
|
type - QuestionType
|
|
config - ModifyQuestionConfigInput
|
|
bindToColumn - String
|
|
activationConditionLogic - String
|
Example
{
"internalId": "xyz789",
"id": 123,
"label": "xyz789",
"required": true,
"type": "DROPDOWN",
"config": ModifyQuestionConfigInput,
"bindToColumn": "abc123",
"activationConditionLogic": "xyz789"
}
OCRContentPositionMap
Example
OCRContentPositionMap
OCRContentPositionMaps
Fields
| Field Name | Description |
|---|---|
mediaToTranscript - OCRContentPositionMap!
|
|
transcriptToMedia - OCRContentPositionMap!
|
Example
{
"mediaToTranscript": OCRContentPositionMap,
"transcriptToMedia": OCRContentPositionMap
}
OCRContentPositionMapsInput
Fields
| Input Field | Description |
|---|---|
mediaToTranscript - OCRContentPositionMap!
|
|
transcriptToMedia - OCRContentPositionMap!
|
Example
{
"mediaToTranscript": OCRContentPositionMap,
"transcriptToMedia": OCRContentPositionMap
}
OCRContentPositionMapsResult
Fields
| Field Name | Description |
|---|---|
documentId - ID!
|
|
maps - OCRContentPositionMaps
|
Example
{"documentId": 4, "maps": OCRContentPositionMaps}
OCRProvider
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APACHE_TIKA"
ObjectMeta
ObjectStorageClientName
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AWS_S3"
OffsetPageInput
OrderType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
OverallProjectPerformance
OverrideSentencesInput
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
|
sentences - [TextSentenceInput!]!
|
|
labelsToAdd - [GqlConflictableInput!]
|
|
labelsToDelete - [GqlConflictableInput!]
|
Example
{
"documentId": "4",
"sentences": [TextSentenceInput],
"labelsToAdd": [GqlConflictableInput],
"labelsToDelete": [GqlConflictableInput]
}
Package
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ENTERPRISE"
PageInfo
PaginatedAnalyticsDashboardFilterInput
PaginatedAnalyticsDashboardQueryInput
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
page - OffsetPageInput
|
|
sort - [SortInput!]
|
|
filter - PaginatedAnalyticsDashboardFilterInput!
|
Example
{
"cursor": "xyz789",
"page": OffsetPageInput,
"sort": [SortInput],
"filter": PaginatedAnalyticsDashboardFilterInput
}
PaginatedChartDataResponse
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [ChartDataRow!]!
|
Example
{
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [ChartDataRow]
}
PaginatedProjectMetadataItem
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [ProjectMetadataItem!]!
|
Example
{
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [ProjectMetadataItem]
}
PaginatedResponse
Possible Types
| PaginatedResponse Types |
|---|
Example
{"totalCount": 987, "pageInfo": PageInfo}
PairKappa
PaymentMethod
Fields
| Field Name | Description |
|---|---|
hasPaymentMethod - Boolean!
|
|
detail - PaymentMethodDetail
|
Example
{"hasPaymentMethod": true, "detail": PaymentMethodDetail}
PaymentMethodDetail
Example
{
"type": "abc123",
"fundingType": "abc123",
"displayBrand": "xyz789",
"creditCardLastFourNumber": "xyz789",
"creditCardExpiryMonth": 987,
"creditCardExpiryYear": 123,
"markedForRemoval": true,
"status": "VALID",
"createdAt": "abc123",
"updatedAt": "abc123"
}
Project
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
team - Team
|
Please use teamId instead and retrieve Team from separate query |
teamId - ID
|
|
owner - User
|
|
externalObjectStorageId - String
|
|
rootDocumentId - ID!
|
No longer supported |
assignees - [ProjectAssignment!]
|
|
name - String!
|
|
tags - [Tag!]
|
|
type - String!
|
No longer supported |
createdDate - String!
|
|
completedDate - String
|
|
exportedDate - String
|
|
updatedDate - String!
|
|
isOwnerMe - Boolean!
|
|
isReviewByMeAllowed - Boolean!
|
|
settings - ProjectSettings!
|
|
workspaceSettings - WorkspaceSettings!
|
|
reviewingStatus - ReviewingStatus!
|
|
labelingStatus - [LabelingStatus!]
|
|
status - GqlProjectStatus!
|
|
performance - ProjectPerformance
|
|
selfLabelingStatus - GqlLabelingStatus!
|
|
purpose - ProjectPurpose!
|
|
rootCabinet - Cabinet!
|
|
reviewCabinet - Cabinet
|
|
labelerCabinets - [Cabinet!]!
|
|
guideline - Guideline
|
|
isArchived - Boolean
|
|
projectMetadataItems - [ProjectMetadataItem!]
|
Example
{
"id": 4,
"team": Team,
"teamId": "4",
"owner": User,
"externalObjectStorageId": "xyz789",
"rootDocumentId": 4,
"assignees": [ProjectAssignment],
"name": "abc123",
"tags": [Tag],
"type": "abc123",
"createdDate": "xyz789",
"completedDate": "abc123",
"exportedDate": "abc123",
"updatedDate": "abc123",
"isOwnerMe": false,
"isReviewByMeAllowed": false,
"settings": ProjectSettings,
"workspaceSettings": WorkspaceSettings,
"reviewingStatus": ReviewingStatus,
"labelingStatus": [LabelingStatus],
"status": "CREATED",
"performance": ProjectPerformance,
"selfLabelingStatus": "NOT_STARTED",
"purpose": "LABELING",
"rootCabinet": Cabinet,
"reviewCabinet": Cabinet,
"labelerCabinets": [Cabinet],
"guideline": Guideline,
"isArchived": false,
"projectMetadataItems": [ProjectMetadataItem]
}
ProjectAssignment
Fields
| Field Name | Description |
|---|---|
teamMember - TeamMember!
|
|
documentIds - [String!]
|
|
documents - [TextDocument!]
|
|
role - ProjectAssignmentRole!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
Example
{
"teamMember": TeamMember,
"documentIds": ["xyz789"],
"documents": [TextDocument],
"role": "LABELER",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
ProjectAssignmentByNameInput
Description
Deprecated. See LaunchTextProjectInput and use field documentAssignments of type DocumentAssignmentInput instead.
Fields
| Input Field | Description |
|---|---|
teamMemberId - ID
|
We only require one between teamMemberId and email. Use teamMember query to retrieve the teamMemberId. |
email - String
|
We only require one between teamMemberId and email. Use email for simplicity. |
documentNames - [String!]
|
Document's name to be assigned. |
role - ProjectAssignmentRole
|
Example
{
"teamMemberId": 4,
"email": "abc123",
"documentNames": ["abc123"],
"role": "LABELER"
}
ProjectAssignmentInput
Fields
| Input Field | Description |
|---|---|
teamMemberId - ID!
|
|
transferTeamMemberId - ID
|
|
documentIds - [String!]!
|
|
role - ProjectAssignmentRole
|
Example
{
"teamMemberId": "4",
"transferTeamMemberId": 4,
"documentIds": ["xyz789"],
"role": "LABELER"
}
ProjectAssignmentRole
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"LABELER"
ProjectConflictsCountItem
ProjectConfusionMatrixTable
Fields
| Field Name | Description |
|---|---|
projectKind - ProjectKind!
|
|
confusionMatrixTable - ConfusionMatrixTable!
|
Example
{
"projectKind": "DOCUMENT_BASED",
"confusionMatrixTable": ConfusionMatrixTable
}
ProjectDocumentsReviewProgress
ProjectDynamicReviewMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ANY_OTHER_TEAM_MEMBER"
ProjectEvaluationMetric
Fields
| Field Name | Description |
|---|---|
projectKind - ProjectKind!
|
|
metric - EvaluationMetric!
|
Example
{
"projectKind": "DOCUMENT_BASED",
"metric": EvaluationMetric
}
ProjectExtension
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
cabinetId - ID!
|
|
elements - [ExtensionElement!]
|
|
width - Int!
|
Example
{
"id": "4",
"cabinetId": 4,
"elements": [ExtensionElement],
"width": 987
}
ProjectFinalReport
Fields
| Field Name | Description |
|---|---|
project - Project!
|
|
documentFinalReports - [DocumentFinalReport!]!
|
Example
{
"project": Project,
"documentFinalReports": [DocumentFinalReport]
}
ProjectKind
Description
See this documentation.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DOCUMENT_BASED"
ProjectLabelersDocumentStatus
Fields
| Field Name | Description |
|---|---|
originId - ID!
|
|
assignedLabelers - [TeamMember!]!
|
|
completedLabelers - [TeamMember!]!
|
Example
{
"originId": 4,
"assignedLabelers": [TeamMember],
"completedLabelers": [TeamMember]
}
ProjectLaunchJob
ProjectMetadataInput
Fields
| Input Field | Description |
|---|---|
projectMetadataItems - [ProjectMetadataItemInput!]!
|
|
projectId - String!
|
Example
{
"projectMetadataItems": [ProjectMetadataItemInput],
"projectId": "xyz789"
}
ProjectMetadataItem
Example
{
"id": "4",
"teamId": "4",
"creatorId": 4,
"key": "abc123",
"value": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
ProjectMetadataItemInput
ProjectPaginatedResponse
Description
Paginated list of projects.
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
Total number of projects that matches the applied filter |
pageInfo - PageInfo!
|
|
nodes - [Project!]!
|
List of projects. See type Project. |
Example
{
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [Project]
}
ProjectPerformance
Example
{
"project": Project,
"projectId": "4",
"totalTimeSpent": 987,
"effectiveTotalTimeSpent": 987,
"conflicts": 987,
"totalLabelApplied": 123,
"numberOfAcceptedLabels": 123,
"numberOfDocuments": 123,
"numberOfTokens": 123,
"numberOfLines": 123
}
ProjectPurpose
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"LABELING"
ProjectQuestionSet
Fields
| Field Name | Description |
|---|---|
questions - [Question!]!
|
|
signature - String!
|
Example
{
"questions": [Question],
"signature": "abc123"
}
ProjectSample
ProjectSettings
Fields
| Field Name | Description |
|---|---|
autoMarkDocumentAsComplete - Boolean!
|
|
consensus - Int
|
Moved under conflictResolution.consensus
|
conflictResolution - ConflictResolution!
|
|
dynamicReviewMethod - ProjectDynamicReviewMethod
|
|
dynamicReviewMemberId - ID
|
|
enableEditLabelSet - Boolean!
|
|
enableReviewerEditSentence - Boolean!
|
|
enableReviewerInsertSentence - Boolean!
|
|
enableReviewerDeleteSentence - Boolean!
|
|
enableEditSentence - Boolean!
|
|
enableInsertSentence - Boolean!
|
|
enableDeleteSentence - Boolean!
|
|
enableDirectBBoxEditing - Boolean!
|
|
enableEnforceAutoLabelReviewerSettings - Boolean
|
|
hideLabelerNamesDuringReview - Boolean!
|
|
hideLabelsFromInactiveLabelSetDuringReview - Boolean!
|
|
hideOriginalSentencesDuringReview - Boolean!
|
|
hideRejectedLabelsDuringReview - Boolean!
|
|
labelerProjectCompletionNotification - LabelerProjectCompletionNotification!
|
|
shouldConfirmUnusedLabelSetItems - Boolean!
|
|
spotChecking - SpotChecking!
|
Example
{
"autoMarkDocumentAsComplete": false,
"consensus": 987,
"conflictResolution": ConflictResolution,
"dynamicReviewMethod": "ANY_OTHER_TEAM_MEMBER",
"dynamicReviewMemberId": "4",
"enableEditLabelSet": true,
"enableReviewerEditSentence": false,
"enableReviewerInsertSentence": false,
"enableReviewerDeleteSentence": true,
"enableEditSentence": true,
"enableInsertSentence": true,
"enableDeleteSentence": true,
"enableDirectBBoxEditing": false,
"enableEnforceAutoLabelReviewerSettings": true,
"hideLabelerNamesDuringReview": false,
"hideLabelsFromInactiveLabelSetDuringReview": false,
"hideOriginalSentencesDuringReview": false,
"hideRejectedLabelsDuringReview": false,
"labelerProjectCompletionNotification": LabelerProjectCompletionNotification,
"shouldConfirmUnusedLabelSetItems": false,
"spotChecking": SpotChecking
}
ProjectSettingsInput
Fields
| Input Field | Description |
|---|---|
autoMarkDocumentAsComplete - Boolean
|
Enables automated mark document as complete. |
consensus - Int
|
Peer review / labeler consensus. It determines how many consensus so that the label will be automatically accepted. Moved under conflictResolution.consensus
|
conflictResolution - ConflictResolutionInput
|
|
dynamicReviewMethod - ProjectDynamicReviewMethod
|
|
dynamicReviewMemberId - ID
|
|
enableEditLabelSet - Boolean
|
Labelers will be restricted from adding or removing labels from the label set while labeling. |
enableReviewerEditSentence - Boolean
|
Reviewers will be able to edit the original text. If this is false, enableEditSentence will be forced to be false. Setting only this will populate enableReviewerInsertSentence & enableReviewerDeleteSentence with the same value. |
enableReviewerInsertSentence - Boolean
|
Reviewers will be able to add new sentences. |
enableReviewerDeleteSentence - Boolean
|
Reviewers will be able to delete sentences. |
enableEditSentence - Boolean
|
Same as enableReviewerEditSentence, but for labeler only. Setting only this will populate enableInsertSentence & enableDeleteSentence with the same value. |
enableInsertSentence - Boolean
|
Labelers will be able to add new sentences from labeler mode. |
enableDeleteSentence - Boolean
|
Labelers will be able to delete sentences from labeler mode. |
enableDirectBBoxEditing - Boolean
|
|
hideLabelerNamesDuringReview - Boolean
|
|
hideLabelsFromInactiveLabelSetDuringReview - Boolean
|
|
hideOriginalSentencesDuringReview - Boolean
|
|
hideRejectedLabelsDuringReview - Boolean
|
|
labelerProjectCompletionNotification - LabelerProjectCompletionNotificationInput
|
|
shouldConfirmUnusedLabelSetItems - Boolean
|
Skip checking for unused label set item when marking document as complete |
spotChecking - SpotCheckingInput
|
If enabled, spot checking sets a minimum percentage of the labeler's work that needs to be reviewed by the reviewer. Only available if conflictResolution.mode: "MANUAL". |
enableEnforceAutoLabelReviewerSettings - Boolean
|
Example
{
"autoMarkDocumentAsComplete": true,
"consensus": 123,
"conflictResolution": ConflictResolutionInput,
"dynamicReviewMethod": "ANY_OTHER_TEAM_MEMBER",
"dynamicReviewMemberId": 4,
"enableEditLabelSet": true,
"enableReviewerEditSentence": false,
"enableReviewerInsertSentence": true,
"enableReviewerDeleteSentence": false,
"enableEditSentence": true,
"enableInsertSentence": false,
"enableDeleteSentence": false,
"enableDirectBBoxEditing": true,
"hideLabelerNamesDuringReview": false,
"hideLabelsFromInactiveLabelSetDuringReview": false,
"hideOriginalSentencesDuringReview": false,
"hideRejectedLabelsDuringReview": false,
"labelerProjectCompletionNotification": LabelerProjectCompletionNotificationInput,
"shouldConfirmUnusedLabelSetItems": true,
"spotChecking": SpotCheckingInput,
"enableEnforceAutoLabelReviewerSettings": false
}
ProjectState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
ProjectSummaryMetric
Fields
| Field Name | Description |
|---|---|
key - ProjectSummaryMetricKey!
|
|
value - String!
|
Example
{
"key": "EFFECTIVE_TIME_SPENT",
"value": "xyz789"
}
ProjectSummaryMetricKey
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EFFECTIVE_TIME_SPENT"
ProjectSummaryReport
Fields
| Field Name | Description |
|---|---|
projectId - ID!
|
|
metrics - [ProjectSummaryMetric!]!
|
Example
{"projectId": 4, "metrics": [ProjectSummaryMetric]}
ProjectTemplate
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
teamId - ID!
|
|
team - Team!
|
Will be removed in a future release. Please use teamId field and query getTeamDetail instead |
logoURL - String
|
|
projectTemplateProjectSettingId - ID!
|
|
projectTemplateTextDocumentSettingId - ID!
|
|
projectTemplateProjectSetting - ProjectTemplateProjectSetting!
|
|
projectTemplateTextDocumentSetting - ProjectTemplateTextDocumentSetting!
|
|
labelSetTemplates - [LabelSetTemplate]!
|
|
questionSets - [QuestionSet!]!
|
|
createdAt - String!
|
|
updatedAt - String!
|
|
purpose - ProjectPurpose!
|
|
creatorId - ID
|
Example
{
"id": 4,
"name": "xyz789",
"teamId": 4,
"team": Team,
"logoURL": "abc123",
"projectTemplateProjectSettingId": "4",
"projectTemplateTextDocumentSettingId": "4",
"projectTemplateProjectSetting": ProjectTemplateProjectSetting,
"projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
"labelSetTemplates": [LabelSetTemplate],
"questionSets": [QuestionSet],
"createdAt": "xyz789",
"updatedAt": "xyz789",
"purpose": "LABELING",
"creatorId": 4
}
ProjectTemplateProjectSetting
Fields
| Field Name | Description |
|---|---|
autoMarkDocumentAsComplete - Boolean!
|
|
enableEditLabelSet - Boolean!
|
|
enableEditSentence - Boolean!
|
|
enableLabelerProjectCompletionNotificationThreshold - Boolean!
|
|
enableReviewerEditSentence - Boolean!
|
|
hideLabelerNamesDuringReview - Boolean!
|
|
hideLabelsFromInactiveLabelSetDuringReview - Boolean!
|
|
hideOriginalSentencesDuringReview - Boolean!
|
|
hideRejectedLabelsDuringReview - Boolean!
|
|
shouldConfirmUnusedLabelSetItems - Boolean!
|
|
labelerProjectCompletionNotificationThreshold - Int
|
Example
{
"autoMarkDocumentAsComplete": true,
"enableEditLabelSet": true,
"enableEditSentence": true,
"enableLabelerProjectCompletionNotificationThreshold": false,
"enableReviewerEditSentence": false,
"hideLabelerNamesDuringReview": false,
"hideLabelsFromInactiveLabelSetDuringReview": true,
"hideOriginalSentencesDuringReview": true,
"hideRejectedLabelsDuringReview": false,
"shouldConfirmUnusedLabelSetItems": true,
"labelerProjectCompletionNotificationThreshold": 123
}
ProjectTemplateTextDocumentSetting
Fields
| Field Name | Description |
|---|---|
customScriptId - ID
|
Deprecated. Please use field fileTransformerId instead. No longer supported
|
fileTransformerId - ID
|
|
customTextExtractionAPIId - ID
|
|
sentenceSeparator - String!
|
|
mediaDisplayStrategy - MediaDisplayStrategy!
|
|
enableTabularMarkdownParsing - Boolean!
|
|
firstRowAsHeader - Boolean
|
|
displayedRows - Int!
|
|
kind - ProjectKind!
|
|
kinds - [ProjectKind!]
|
|
allTokensMustBeLabeled - Boolean!
|
|
allowArcDrawing - Boolean!
|
|
allowCharacterBasedLabeling - Boolean!
|
|
allowMultiLabels - Boolean!
|
|
textLabelMaxTokenLength - Int!
|
|
ocrMethod - TranscriptMethod
|
Please use field transcriptMethod instead.
|
transcriptMethod - TranscriptMethod
|
|
ocrProvider - OCRProvider
|
|
autoScrollWhenLabeling - Boolean!
|
|
tokenizer - String!
|
|
editSentenceTokenizer - String!
|
|
viewer - TextDocumentViewer
|
|
viewerConfig - TextDocumentViewerConfig
|
|
hideBoundingBoxIfNoSpanOrArrowLabel - Boolean!
|
|
enableAnonymization - Boolean!
|
|
anonymizationEntityTypes - [String!]
|
|
anonymizationMaskingMethod - String
|
|
anonymizationRegExps - [RegularExpression!]
|
Example
{
"customScriptId": 4,
"fileTransformerId": 4,
"customTextExtractionAPIId": "4",
"sentenceSeparator": "xyz789",
"mediaDisplayStrategy": "NONE",
"enableTabularMarkdownParsing": true,
"firstRowAsHeader": true,
"displayedRows": 987,
"kind": "DOCUMENT_BASED",
"kinds": ["DOCUMENT_BASED"],
"allTokensMustBeLabeled": true,
"allowArcDrawing": true,
"allowCharacterBasedLabeling": false,
"allowMultiLabels": false,
"textLabelMaxTokenLength": 123,
"ocrMethod": "TRANSCRIPTION",
"transcriptMethod": "TRANSCRIPTION",
"ocrProvider": "APACHE_TIKA",
"autoScrollWhenLabeling": true,
"tokenizer": "xyz789",
"editSentenceTokenizer": "xyz789",
"viewer": "TOKEN",
"viewerConfig": TextDocumentViewerConfig,
"hideBoundingBoxIfNoSpanOrArrowLabel": false,
"enableAnonymization": true,
"anonymizationEntityTypes": ["abc123"],
"anonymizationMaskingMethod": "abc123",
"anonymizationRegExps": [RegularExpression]
}
ProjectTemplateType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CUSTOM"
ProjectTemplateV2
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
logoURL - String
|
|
projectTemplateProjectSettingId - ID!
|
|
projectTemplateTextDocumentSettingId - ID!
|
|
projectTemplateProjectSetting - ProjectTemplateProjectSetting!
|
|
projectTemplateTextDocumentSetting - ProjectTemplateTextDocumentSetting!
|
|
labelSetTemplates - [LabelSetTemplate]!
|
|
questionSets - [QuestionSet!]!
|
|
createdAt - String!
|
|
updatedAt - String!
|
|
purpose - ProjectPurpose!
|
|
creatorId - ID
|
|
type - ProjectTemplateType!
|
|
description - String
|
|
imagePreviewURL - String
|
|
videoURL - String
|
Example
{
"id": 4,
"name": "xyz789",
"logoURL": "abc123",
"projectTemplateProjectSettingId": "4",
"projectTemplateTextDocumentSettingId": "4",
"projectTemplateProjectSetting": ProjectTemplateProjectSetting,
"projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
"labelSetTemplates": [LabelSetTemplate],
"questionSets": [QuestionSet],
"createdAt": "xyz789",
"updatedAt": "xyz789",
"purpose": "LABELING",
"creatorId": "4",
"type": "CUSTOM",
"description": "xyz789",
"imagePreviewURL": "abc123",
"videoURL": "abc123"
}
ProjectTopLabels
Fields
| Field Name | Description |
|---|---|
labelType - ProjectTopLabelsLabelType!
|
|
metrics - [ProjectTopLabelsMetric!]!
|
Example
{
"labelType": "SPAN_AND_ARROW",
"metrics": [ProjectTopLabelsMetric]
}
ProjectTopLabelsLabelType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SPAN_AND_ARROW"
ProjectTopLabelsMetric
ProjectTopLabelsReport
Fields
| Field Name | Description |
|---|---|
projectId - ID!
|
|
topLabels - [ProjectTopLabels!]!
|
Example
{
"projectId": "4",
"topLabels": [ProjectTopLabels]
}
ProjectUnusedLabelClassScalar
Example
ProjectUnusedLabelClassScalar
PromptTemplateCostPrediction
Fields
| Field Name | Description |
|---|---|
promptTemplateId - ID!
|
|
promptTemplateName - String!
|
|
modelName - String!
|
|
tokens - TokenUsages!
|
|
tokenUnitPrices - TokenUnitPrices!
|
|
tokenPrices - TokenPrices!
|
|
coveredByDatasaur - Boolean!
|
|
pricingUsageType - GqlPricingUsageType!
|
Example
{
"promptTemplateId": "4",
"promptTemplateName": "abc123",
"modelName": "abc123",
"tokens": TokenUsages,
"tokenUnitPrices": TokenUnitPrices,
"tokenPrices": TokenPrices,
"coveredByDatasaur": false,
"pricingUsageType": "CHAR"
}
ProviderSetting
Example
ProviderSetting
ProviderSettingInput
Example
ProviderSettingInput
Question
Fields
| Field Name | Description |
|---|---|
id - Int!
|
|
internalId - String!
|
|
type - QuestionType!
|
|
name - String
|
Deprecated. Use label instead. Use label instead.
|
label - String!
|
|
required - Boolean!
|
|
config - QuestionConfig!
|
|
bindToColumn - String
|
|
activationConditionLogic - String
|
Example
{
"id": 123,
"internalId": "xyz789",
"type": "DROPDOWN",
"name": "abc123",
"label": "abc123",
"required": true,
"config": QuestionConfig,
"bindToColumn": "abc123",
"activationConditionLogic": "abc123"
}
QuestionConfig
Fields
| Field Name | Description |
|---|---|
defaultValue - String
|
|
format - String
|
|
multiple - Boolean
|
|
multiline - Boolean
|
|
options - [QuestionConfigOptions!]
|
|
leafOptionsOnly - Boolean
|
|
questions - [Question!]
|
|
minLength - Int
|
|
maxLength - Int
|
|
pattern - String
|
|
theme - SliderTheme
|
Legacy theming config. Please use gradientColors.
|
gradientColors - [String!]
|
|
min - Int
|
|
max - Int
|
|
step - Int
|
|
hint - String
|
|
hideScaleLabel - Boolean
|
Example
{
"defaultValue": "xyz789",
"format": "xyz789",
"multiple": false,
"multiline": true,
"options": [QuestionConfigOptions],
"leafOptionsOnly": true,
"questions": [Question],
"minLength": 987,
"maxLength": 987,
"pattern": "abc123",
"theme": "PLAIN",
"gradientColors": ["abc123"],
"min": 987,
"max": 987,
"step": 123,
"hint": "abc123",
"hideScaleLabel": false
}
QuestionConfigInput
Fields
| Input Field | Description |
|---|---|
defaultValue - String
|
Applies for DATE, TIME. Possible value NOW |
format - String
|
Applies for DATE, TIME. Possible values for DATE are DD-MM-YYYY, MM-DD-YYYY, YYYY-MM-DD DD/MM/YYYY, MM/DD/YYYY and YYYY/MM/DD. Possible values for TIME are HH:mm:ss, HH:mm, HH.mm.ss, and HH.mm |
multiple - Boolean
|
Applies for TEXT, NESTED, DROPDOWN, HIERARCHICAL_DROPDOWN. Set it as true if you want to have multiple answers for this question. |
multiline - Boolean
|
Applies for TEXT. Set it as true if you want to enter long text. |
options - [QuestionConfigOptionsInput!]
|
Applies for Dropdown, HIERARCHICAL_DROPDOWN. |
leafOptionsOnly - Boolean
|
Applies for HIERARCHICAL_DROPDOWN. |
questions - [QuestionInput!]
|
Applies for NESTED. |
minLength - Int
|
Applies for TEXT. |
maxLength - Int
|
Applies for TEXT. |
pattern - String
|
Applies for TEXT. This field could have contain a regex string, which the browser natively uses for validation. E.g. [0-9]* |
theme - SliderTheme
|
Applies for SLIDER. Legacy theming config. Please use gradientColors.
|
gradientColors - [String!]
|
Applies for SLIDER. When defined, determines the gradation color for the slider track. |
min - Int
|
Applies for SLIDER. |
max - Int
|
Applies for SLIDER. |
step - Int
|
Applies for SLIDER. |
hideScaleLabel - Boolean
|
Applies for SLIDER. If true, hides the slider scale label in labeler mode. |
hint - String
|
Applies for CHECKBOX, RADIO |
Example
{
"defaultValue": "abc123",
"format": "xyz789",
"multiple": true,
"multiline": true,
"options": [QuestionConfigOptionsInput],
"leafOptionsOnly": false,
"questions": [QuestionInput],
"minLength": 123,
"maxLength": 987,
"pattern": "xyz789",
"theme": "PLAIN",
"gradientColors": ["abc123"],
"min": 123,
"max": 987,
"step": 987,
"hideScaleLabel": true,
"hint": "abc123"
}
QuestionConfigOptions
QuestionConfigOptionsInput
QuestionInput
Fields
| Input Field | Description |
|---|---|
id - Int
|
Only for update. |
name - String
|
Deprecated. Use label instead. Use label instead.
|
label - String
|
The question title or description that will be shown to the labeler. |
required - Boolean
|
This marks whether the question is required to be answered or not. |
delete - Boolean
|
DEPRECATED: No longer used. This value will be ignored. No longer used. This value will be ignored. |
type - QuestionType
|
How a question will be asked. |
config - QuestionConfigInput
|
Detail configuration based on the question type. |
bindToColumn - String
|
Specific for Row Labeling. Bind the answer to a specific column from the input file. |
activationConditionLogic - String
|
Conditional for dynamic question set. For example, "questionAnswer[0]==='true'" will make this question only shown if the first question is true. |
Example
{
"id": 987,
"name": "abc123",
"label": "abc123",
"required": true,
"delete": false,
"type": "DROPDOWN",
"config": QuestionConfigInput,
"bindToColumn": "xyz789",
"activationConditionLogic": "xyz789"
}
QuestionSet
QuestionSetItem
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
index - Int!
|
|
questionSetId - String!
|
|
label - String!
|
|
type - QuestionType!
|
|
multipleAnswer - Boolean
|
|
required - Boolean!
|
|
bindToColumn - String
|
|
activationConditionLogic - String
|
|
createdAt - String!
|
|
updatedAt - String!
|
|
options - [DropdownConfigOptions!]
|
|
leafOptionsOnly - Boolean
|
|
format - String
|
|
defaultValue - DateTimeDefaultValue
|
|
max - Int
|
|
min - Int
|
|
theme - SliderTheme
|
Legacy theming config. Please use gradientColors.
|
gradientColors - [String!]
|
|
step - Int
|
|
hideScaleLabel - Boolean
|
|
multiline - Boolean
|
|
maxLength - Int
|
|
minLength - Int
|
|
pattern - String
|
|
hint - String
|
|
nestedQuestions - [QuestionSetItem!]
|
|
parentId - ID
|
Example
{
"id": "4",
"index": 987,
"questionSetId": "abc123",
"label": "xyz789",
"type": "DROPDOWN",
"multipleAnswer": true,
"required": false,
"bindToColumn": "abc123",
"activationConditionLogic": "xyz789",
"createdAt": "xyz789",
"updatedAt": "abc123",
"options": [DropdownConfigOptions],
"leafOptionsOnly": true,
"format": "xyz789",
"defaultValue": "NOW",
"max": 987,
"min": 123,
"theme": "PLAIN",
"gradientColors": ["abc123"],
"step": 987,
"hideScaleLabel": true,
"multiline": true,
"maxLength": 123,
"minLength": 123,
"pattern": "xyz789",
"hint": "abc123",
"nestedQuestions": [QuestionSetItem],
"parentId": 4
}
QuestionSetItemInput
Fields
| Input Field | Description |
|---|---|
label - String!
|
|
type - QuestionType!
|
|
required - Boolean
|
|
activationConditionLogic - String
|
|
config - QuestionSetItemInputConfig!
|
Example
{
"label": "abc123",
"type": "DROPDOWN",
"required": true,
"activationConditionLogic": "abc123",
"config": QuestionSetItemInputConfig
}
QuestionSetItemInputConfig
Fields
| Input Field | Description |
|---|---|
options - [DropdownConfigOptionsInput!]
|
|
leafOptionsOnly - Boolean
|
|
questions - [QuestionSetItemInput!]
|
|
format - String
|
|
defaultValue - String
|
|
max - Int
|
|
min - Int
|
|
theme - SliderTheme
|
Legacy theming config. Please use gradientColors.
|
gradientColors - [String!]
|
|
step - Int
|
|
hideScaleLabel - Boolean
|
|
multiline - Boolean
|
|
maxLength - Int
|
|
minLength - Int
|
|
pattern - String
|
|
hint - String
|
|
multiple - Boolean
|
Example
{
"options": [DropdownConfigOptionsInput],
"leafOptionsOnly": true,
"questions": [QuestionSetItemInput],
"format": "abc123",
"defaultValue": "abc123",
"max": 987,
"min": 987,
"theme": "PLAIN",
"gradientColors": ["abc123"],
"step": 987,
"hideScaleLabel": true,
"multiline": true,
"maxLength": 123,
"minLength": 123,
"pattern": "abc123",
"hint": "xyz789",
"multiple": false
}
QuestionSetTemplate
QuestionSetTemplateInput
QuestionType
Description
See this documentation for further information.
Values
| Enum Value | Description |
|---|---|
|
|
This type provides a dropdown with multiple options. |
|
|
This type provides a dropdown with hierarchical options. |
|
|
You can create nested questions. Questions inside a question by using this type. |
|
|
This type provides a text area. |
|
|
This type provides a slider with customizeable minimum value and maximum value. |
|
|
|
|
|
This type provides a date picker. |
|
|
This type provides a time picker. |
|
|
This type provides a checkbox. |
|
|
This type provides a URL field. |
|
|
This type provides a token field. |
|
|
This type provides a radio. |
Example
"DROPDOWN"
RangeInput
RangePageInput
RecalculateBBoxLabelsShapesHashInput
RedactCellsInput
Fields
| Input Field | Description |
|---|---|
cellPositions - [CellPositionWithOriginDocumentIdInput!]!
|
Example
{"cellPositions": [CellPositionWithOriginDocumentIdInput]}
RegularExpression
RegularExpressionInput
RejectedLabel
Fields
| Field Name | Description |
|---|---|
label - TextLabel!
|
|
reason - String!
|
Example
{
"label": TextLabel,
"reason": "abc123"
}
RemainingFilesStatistic
RemovePersonalTagsInput
Fields
| Input Field | Description |
|---|---|
tagIds - [ID!]!
|
Example
{"tagIds": [4]}
RemoveTagsInput
RemoveTagsResult
Fields
| Field Name | Description |
|---|---|
tagId - ID!
|
Example
{"tagId": 4}
RemoveTeamMemberInput
Description
Deprecated. Please use RemoveTeamMembersInput instead
Fields
| Input Field | Description |
|---|---|
teamMemberId - ID!
|
Example
{"teamMemberId": "4"}
RemoveTeamMembersInput
RequestDemo
Example
{
"email": "xyz789",
"givenName": "xyz789",
"surname": "xyz789",
"company": "abc123",
"numberOfLabelers": 987,
"name": "xyz789",
"gclid": "xyz789",
"fbclid": "abc123",
"utmSource": "abc123",
"desiredLabelingFeature": "abc123"
}
RequestDemoInput
Fields
| Input Field | Description |
|---|---|
email - String!
|
|
givenName - String!
|
|
surname - String!
|
|
company - String!
|
|
numberOfLabelers - Int!
|
|
name - String
|
Please use givenName and surname instead. |
recaptcha - String
|
|
gclid - String
|
|
fbclid - String
|
|
utmSource - String
|
|
desiredLabelingFeature - String
|
|
requireCaptcha - Boolean!
|
Example
{
"email": "xyz789",
"givenName": "xyz789",
"surname": "abc123",
"company": "abc123",
"numberOfLabelers": 987,
"name": "xyz789",
"recaptcha": "abc123",
"gclid": "xyz789",
"fbclid": "xyz789",
"utmSource": "xyz789",
"desiredLabelingFeature": "xyz789",
"requireCaptcha": true
}
RequestResetPasswordInput
ResetLabelingWorkResult
Fields
| Field Name | Description |
|---|---|
job - Job!
|
Example
{"job": Job}
ResetPasswordInput
Fields
| Input Field | Description |
|---|---|
signature - String!
|
|
password - String!
|
|
passwordConfirmation - String!
|
|
totpCode - TotpCodeInput
|
Example
{
"signature": "abc123",
"password": "xyz789",
"passwordConfirmation": "xyz789",
"totpCode": TotpCodeInput
}
ReversedLabels
Fields
| Field Name | Description |
|---|---|
document - TextDocumentScalar!
|
|
reversedLabels - [TextLabelScalar!]!
|
|
reversedLabelsCount - Int!
|
|
replacedReversedLabels - [TextLabelScalar!]!
|
|
replacedReversedLabelsCount - Int!
|
|
replacementLabels - [TextLabelScalar!]!
|
|
replacementLabelsCount - Int!
|
Example
{
"document": TextDocumentScalar,
"reversedLabels": [TextLabelScalar],
"reversedLabelsCount": 987,
"replacedReversedLabels": [TextLabelScalar],
"replacedReversedLabelsCount": 987,
"replacementLabels": [TextLabelScalar],
"replacementLabelsCount": 123
}
ReversedLabelsJob
Fields
| Field Name | Description |
|---|---|
job - Job!
|
Example
{"job": Job}
ReversedLabelsOperationInput
ReviewingStatus
Fields
| Field Name | Description |
|---|---|
isCompleted - Boolean!
|
|
statistic - ReviewingStatusStatistic!
|
Example
{
"isCompleted": true,
"statistic": ReviewingStatusStatistic
}
ReviewingStatusStatistic
Role
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"REVIEWER"
RowAnalyticEvent
Fields
| Field Name | Description |
|---|---|
cell - RowAnalyticEventCell!
|
|
createdAt - String!
|
|
event - RowAnalyticEventType!
|
|
id - String!
|
|
user - RowAnalyticEventUser!
|
Example
{
"cell": RowAnalyticEventCell,
"createdAt": "abc123",
"event": "ROW_HIGHLIGHTED",
"id": "xyz789",
"user": RowAnalyticEventUser
}
RowAnalyticEventCell
Fields
| Field Name | Description |
|---|---|
line - Int!
|
|
index - Int!
|
|
content - String!
|
|
status - CellStatus!
|
|
conflict - Boolean!
|
|
document - RowAnalyticEventDocument!
|
Example
{
"line": 987,
"index": 123,
"content": "xyz789",
"status": "DISPLAYED",
"conflict": false,
"document": RowAnalyticEventDocument
}
RowAnalyticEventDocument
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
fileName - String!
|
|
project - RowAnalyticEventProject!
|
Example
{
"id": "4",
"fileName": "xyz789",
"project": RowAnalyticEventProject
}
RowAnalyticEventInput
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
page - CursorPageInput
|
|
filter - RowAnalyticEventInputFilter!
|
|
sort - [SortInput!]
|
Example
{
"cursor": "xyz789",
"page": CursorPageInput,
"filter": RowAnalyticEventInputFilter,
"sort": [SortInput]
}
RowAnalyticEventInputFilter
RowAnalyticEventPaginatedResponse
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
|
nodes - [RowAnalyticEvent!]!
|
Example
{
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [RowAnalyticEvent]
}
RowAnalyticEventProject
RowAnalyticEventType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ROW_HIGHLIGHTED"
RowAnalyticEventUser
RowAnswer
Fields
| Field Name | Description |
|---|---|
documentId - ID!
|
|
line - Int!
|
|
answers - AnswerScalar!
|
|
metadata - [AnswerMetadata!]!
|
|
updatedAt - DateTime
|
Example
{
"documentId": 4,
"line": 987,
"answers": AnswerScalar,
"metadata": [AnswerMetadata],
"updatedAt": "2007-12-03T10:15:30Z"
}
RowAnswerConflicts
Fields
| Field Name | Description |
|---|---|
line - Int!
|
|
conflicts - [ConflictAnswerScalar!]!
|
|
conflictStatus - AnswerSetConflictStatus!
|
Example
{
"line": 987,
"conflicts": [ConflictAnswerScalar],
"conflictStatus": "CONFLICT"
}
RowAnswersInput
Fields
| Input Field | Description |
|---|---|
line - Int!
|
|
answers - AnswerScalar!
|
|
metadata - [AnswerMetadataInput!]
|
Example
{
"line": 987,
"answers": AnswerScalar,
"metadata": [AnswerMetadataInput]
}
RowBasedDocumentSettingsInput
Description
Configuration for Row Labeling projects.
Fields
| Input Field | Description |
|---|---|
mediaDisplayStrategy - MediaDisplayStrategy
|
Default to NONE. |
displayedRows - Int
|
Default to -1, to display all rows in editor. |
Example
{"mediaDisplayStrategy": "NONE", "displayedRows": 987}
RowFinalReport
Fields
| Field Name | Description |
|---|---|
line - Int!
|
|
finalReport - FinalReport!
|
Example
{"line": 987, "finalReport": FinalReport}
SCIMGroupMapRole
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"LABELER"
SamlRedirectResult
Fields
| Field Name | Description |
|---|---|
samlTenant - SamlTenant!
|
|
redirectUrl - String!
|
Example
{
"samlTenant": SamlTenant,
"redirectUrl": "xyz789"
}
SamlTenant
Example
{
"id": "4",
"active": true,
"companyId": "4",
"idpIssuer": "xyz789",
"idpUrl": "xyz789",
"spIssuer": "xyz789",
"team": Team,
"allowMembersToSetPassword": false
}
SaveGeneralWorkspaceSettingsInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
settings - GeneralWorkspaceSettingsInput!
|
Example
{
"projectId": "4",
"settings": GeneralWorkspaceSettingsInput
}
SaveOCRContentPositionMapsInput
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
|
maps - OCRContentPositionMapsInput!
|
Example
{"documentId": 4, "maps": OCRContentPositionMapsInput}
SaveProjectWorkspaceSettingsInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
settings - TextDocumentSettingsInput!
|
Example
{
"projectId": "4",
"settings": TextDocumentSettingsInput
}
ScheduledCommandConfig
Example
{
"id": "4",
"cronPattern": CronExpression,
"repeatInterval": 123,
"runImmediately": true,
"endTime": "xyz789",
"numberOfRepetition": 987,
"isNeverEnding": false,
"isPeriodic": true,
"updatedAt": "xyz789"
}
Scim
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
team - Team!
|
|
samlTenant - SamlTenant!
|
|
active - Boolean!
|
Example
{
"id": 4,
"team": Team,
"samlTenant": SamlTenant,
"active": true
}
ScimGroup
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
team - Team!
|
|
scim - Scim!
|
|
groupName - String!
|
|
role - SCIMGroupMapRole!
|
Example
{
"id": "4",
"team": Team,
"scim": Scim,
"groupName": "abc123",
"role": "LABELER"
}
ScimGroupInput
Fields
| Input Field | Description |
|---|---|
teamId - ID!
|
|
scimId - ID!
|
|
mapping - [ScimGroupMapping!]!
|
Example
{
"teamId": "4",
"scimId": "4",
"mapping": [ScimGroupMapping]
}
ScimGroupMapping
Fields
| Input Field | Description |
|---|---|
groupName - String!
|
|
role - SCIMGroupMapRole!
|
Example
{"groupName": "xyz789", "role": "LABELER"}
SearchHistoryKeyword
SentenceConflict
Fields
| Field Name | Description |
|---|---|
resolved - Boolean!
|
|
resolvingLabelerId - Int
|
|
sentences - [SentenceConflictObject!]!
|
Example
{
"resolved": false,
"resolvingLabelerId": 987,
"sentences": [SentenceConflictObject]
}
SentenceConflictObject
Fields
| Field Name | Description |
|---|---|
labelerId - Int!
|
|
status - TextSentenceStatus
|
|
content - String!
|
|
tokens - [String!]!
|
|
posLabels - [TextLabel!]!
|
|
docLabels - [DocLabelObject!]
|
Example
{
"labelerId": 123,
"status": "DELETED",
"content": "abc123",
"tokens": ["xyz789"],
"posLabels": [TextLabel],
"docLabels": [DocLabelObject]
}
Settings
Fields
| Field Name | Description |
|---|---|
textLang - String
|
Example
{"textLang": "abc123"}
SettingsInput
Fields
| Input Field | Description |
|---|---|
textLang - String
|
Optional. Default is en. |
documentMeta - [DocumentMetaInput!]
|
Optional |
questions - [QuestionInput!]
|
Required |
Example
{
"textLang": "xyz789",
"documentMeta": [DocumentMetaInput],
"questions": [QuestionInput]
}
SignUpMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EMAIL_PASSWORD"
SignUpParams
SignUpParamsInput
Fields
| Input Field | Description |
|---|---|
signUpApp - DatasaurApp
|
Optional. For campaign tracking purposes only. Used to track the application from which the user signed up, either the NLP or the LLM app. |
utmSource - String
|
Optional. For campaign tracking purposes only. Identifies the source of the traffic, such as search engines or newsletters. |
utmMedium - String
|
Optional. For campaign tracking purposes only. Identifies the medium in which the link was used. |
utmCampaign - String
|
Optional. For campaign tracking purposes only. Identifies the name of the campaign. |
linkSource - String
|
Optional. For campaign tracking purposes only. Identifies sign up link sources. |
Example
{
"signUpApp": "NLP",
"utmSource": "xyz789",
"utmMedium": "abc123",
"utmCampaign": "xyz789",
"linkSource": "abc123"
}
SliderTheme
Values
| Enum Value | Description |
|---|---|
|
|
Default slider theme |
|
|
Slider with multiple colors theme; Red, yellow, green |
Example
"PLAIN"
Snapshot
Description
Read-only copy of relevant data captured during action execution
Example
Snapshot
SortInput
Fields
| Input Field | Description |
|---|---|
field - String!
|
|
order - OrderType!
|
Example
{"field": "abc123", "order": "ASC"}
SplitDocumentOptionInput
Fields
| Input Field | Description |
|---|---|
strategy - SplitDocumentStrategy!
|
Required. The split strategy. |
number - Int!
|
Required. Depends on strategy. If
|
Example
{"strategy": "BY_PARTS", "number": 123}
SplitDocumentStrategy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"BY_PARTS"
SpotChecking
SpotCheckingInput
Description
Spot checking configuration. Only available if the project's settings have conflictResolution.mode: "MANUAL".
Example
{"enabled": false, "percentageThreshold": 123.45}
StartDatasaurDinamicRowBasedTrainingJobInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
documentId - ID!
|
|
questionColumnId - Int!
|
|
inputColumnIds - [Int!]!
|
|
provider - DatasaurDinamicRowBasedProvider!
|
|
providerSetting - ProviderSettingInput!
|
|
role - Role!
|
Example
{
"projectId": 4,
"documentId": 4,
"questionColumnId": 987,
"inputColumnIds": [987],
"provider": "HUGGINGFACE",
"providerSetting": ProviderSettingInput,
"role": "REVIEWER"
}
StartDatasaurDinamicTokenBasedTrainingJobInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
documentId - ID!
|
|
targetLabelSetIndex - Int!
|
|
provider - DatasaurDinamicTokenBasedProvider!
|
|
providerSetting - ProviderSettingInput!
|
|
role - Role!
|
Example
{
"projectId": "4",
"documentId": "4",
"targetLabelSetIndex": 123,
"provider": "HUGGINGFACE",
"providerSetting": ProviderSettingInput,
"role": "REVIEWER"
}
StartDatasaurPredictiveTrainingJobInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
documentId - ID!
|
|
questionColumnId - Int!
|
|
inputColumnIds - [Int!]!
|
|
provider - DatasaurPredictiveProvider!
|
|
providerSetting - ProviderSettingInput
|
|
role - Role!
|
Example
{
"projectId": 4,
"documentId": "4",
"questionColumnId": 123,
"inputColumnIds": [987],
"provider": "SETFIT",
"providerSetting": ProviderSettingInput,
"role": "REVIEWER"
}
StartExtensionTrialInput
Fields
| Input Field | Description |
|---|---|
teamId - ID!
|
|
extensionId - ExtensionID!
|
Example
{"teamId": 4, "extensionId": "AUTO_LABEL_TOKEN_EXTENSION_ID"}
StartLabelErrorDetectionRowBasedJobInput
StatisticItem
Fields
| Field Name | Description |
|---|---|
key - String!
|
|
values - [StatisticItemValue!]!
|
Example
{
"key": "abc123",
"values": [StatisticItemValue]
}
StatisticItemValue
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
Tag
TagItem
Fields
| Field Name | Description |
|---|---|
id - String!
|
Unique identifier of the labelset item. |
parentId - ID
|
Parent item ID. Used in hierarchical labelsets. |
tagName - String!
|
Labelset item name, displayed in web UI. Case insensitive. |
desc - String
|
|
color - String
|
6 digit hex string, prefixed by #. Example: #df3920. |
type - LabelClassType!
|
Can be SPAN, ARROW, or ALL. Defaults to ALL. |
arrowRules - [LabelClassArrowRule!]
|
Only has effect if type is ARROW. |
Example
{
"id": "abc123",
"parentId": 4,
"tagName": "abc123",
"desc": "abc123",
"color": "xyz789",
"type": "SPAN",
"arrowRules": [LabelClassArrowRule]
}
TagItemInput
Fields
| Input Field | Description |
|---|---|
id - String!
|
Required. Unique identifier for the labelset item. |
parentId - ID
|
Optional. Parent item's ID. Used in hierarchical labelsets. |
tagName - String!
|
Required. The text to be displayed in the web UI. |
desc - String
|
Optional. Description of the labelset item. |
color - String
|
Optional. 6 digit hex string, prefixed by #. Example: #df3920. |
type - LabelClassType
|
Optional. Can be SPAN, ARROW, or ALL. Defaults to ALL. |
arrowRules - [LabelClassArrowRuleInput!]
|
Optional. Only has effect if type is ARROW. |
Example
{
"id": "xyz789",
"parentId": 4,
"tagName": "xyz789",
"desc": "xyz789",
"color": "xyz789",
"type": "SPAN",
"arrowRules": [LabelClassArrowRuleInput]
}
TargetApiInput
TaskCompletedInput
Team
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Team.id can be seen in web UI, visible in the URL (https://datasaur.ai/teams/{teamId}/...), or obtained via getAllTeams.
|
logoURL - String
|
|
members - [TeamMember!]
|
Please use membersScalar instead |
membersScalar - TeamMembersScalar
|
|
name - String!
|
|
setting - TeamSetting
|
|
owner - User
|
|
isExpired - Boolean!
|
|
expiredAt - DateTime
|
Example
{
"id": "4",
"logoURL": "xyz789",
"members": [TeamMember],
"membersScalar": TeamMembersScalar,
"name": "abc123",
"setting": TeamSetting,
"owner": User,
"isExpired": false,
"expiredAt": "2007-12-03T10:15:30Z"
}
TeamActionNames
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"MANAGE_EXTERNAL_PROVIDER"
TeamApiKey
TeamApiKeyInput
TeamExternalApiKey
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
teamId - ID!
|
|
credentials - [TeamExternalApiKeyCredential!]!
|
|
createdAt - String!
|
|
updatedAt - String!
|
Example
{
"id": "4",
"teamId": 4,
"credentials": [TeamExternalApiKeyCredential],
"createdAt": "xyz789",
"updatedAt": "abc123"
}
TeamExternalApiKeyCredential
Fields
| Field Name | Description |
|---|---|
provider - GqlLlmModelProvider!
|
|
isConnected - Boolean!
|
|
openAIKey - String
|
|
azureOpenAIKey - String
|
Use the new Azure AI Integration instead |
azureOpenAIEndpoint - String
|
Use the new Azure AI Integration instead |
azureAITenantId - String
|
|
azureAISubscriptionId - String
|
|
azureAIResourceGroupName - String
|
|
azureAIAccountName - String
|
|
awsSagemakerRegion - String
|
|
awsSagemakerExternalId - String
|
|
awsSagemakerRoleArn - String
|
|
awsBedrockRegion - String
|
|
awsBedrockExternalId - String
|
|
awsBedrockRoleArn - String
|
Example
{
"provider": "AMAZON_BEDROCK",
"isConnected": false,
"openAIKey": "xyz789",
"azureOpenAIKey": "xyz789",
"azureOpenAIEndpoint": "xyz789",
"azureAITenantId": "abc123",
"azureAISubscriptionId": "xyz789",
"azureAIResourceGroupName": "abc123",
"azureAIAccountName": "xyz789",
"awsSagemakerRegion": "xyz789",
"awsSagemakerExternalId": "xyz789",
"awsSagemakerRoleArn": "xyz789",
"awsBedrockRegion": "xyz789",
"awsBedrockExternalId": "xyz789",
"awsBedrockRoleArn": "xyz789"
}
TeamExternalApiKeyDisconnectInput
Fields
| Input Field | Description |
|---|---|
teamId - ID!
|
|
provider - GqlLlmModelProvider!
|
|
undeployModels - Boolean
|
Example
{"teamId": 4, "provider": "AMAZON_BEDROCK", "undeployModels": false}
TeamExternalApiKeyInput
Fields
| Input Field | Description |
|---|---|
teamId - ID!
|
|
openAIKey - String
|
|
provider - GqlLlmModelProvider!
|
|
azureOpenAIKey - String
|
Use the new Azure AI Integration instead |
azureOpenAIEndpoint - String
|
Use the new Azure AI Integration instead |
azureAITenantId - String
|
|
azureAISubscriptionId - String
|
|
azureAIResourceGroupName - String
|
|
azureAIAccountName - String
|
|
awsSagemakerRegion - String
|
|
awsSagemakerExternalId - String
|
|
awsSagemakerRoleArn - String
|
|
awsBedrockRegion - String
|
|
awsBedrockExternalId - String
|
|
awsBedrockRoleArn - String
|
Example
{
"teamId": "4",
"openAIKey": "abc123",
"provider": "AMAZON_BEDROCK",
"azureOpenAIKey": "xyz789",
"azureOpenAIEndpoint": "xyz789",
"azureAITenantId": "abc123",
"azureAISubscriptionId": "abc123",
"azureAIResourceGroupName": "abc123",
"azureAIAccountName": "xyz789",
"awsSagemakerRegion": "xyz789",
"awsSagemakerExternalId": "xyz789",
"awsSagemakerRoleArn": "abc123",
"awsBedrockRegion": "abc123",
"awsBedrockExternalId": "xyz789",
"awsBedrockRoleArn": "abc123"
}
TeamMember
Example
{
"id": 4,
"user": User,
"role": TeamRole,
"invitationEmail": "xyz789",
"invitationStatus": "abc123",
"invitationKey": "abc123",
"isDeleted": true,
"joinedDate": "xyz789",
"performance": TeamMemberPerformance
}
TeamMemberInput
Fields
| Input Field | Description |
|---|---|
email - String!
|
Example
{"email": "xyz789"}
TeamMemberPerformance
Example
{
"id": "4",
"userId": 123,
"projectStatistic": TeamMemberProjectStatistic,
"totalTimeSpent": 123,
"effectiveTotalTimeSpent": 123,
"accuracy": 123.45
}
TeamMemberProjectStatistic
TeamMemberRole
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ADMIN"
TeamMemberRoleFilter
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADMIN"
TeamMembersScalar
Example
TeamMembersScalar
TeamOnboarding
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
teamId - ID!
|
|
state - TeamOnboardingState!
|
|
version - Int!
|
|
tasks - [TeamOnboardingTask!]
|
Example
{
"id": "4",
"teamId": 4,
"state": "NOT_OPENED",
"version": 987,
"tasks": [TeamOnboardingTask]
}
TeamOnboardingState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NOT_OPENED"
TeamOnboardingTask
TeamRole
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - TeamMemberRole!
|
Example
{"id": "4", "name": "ADMIN"}
TeamSetting
Fields
| Field Name | Description |
|---|---|
allowedAdminExportMethods - [GqlExportMethod!]!
|
No longer supported |
allowedLabelerExportMethods - [GqlExportMethod!]!
|
|
allowedOCRProviders - [OCRProvider!]!
|
|
allowedASRProviders - [ASRProvider!]!
|
|
allowedReviewerExportMethods - [GqlExportMethod!]!
|
|
commentNotificationType - CommentNotificationType!
|
|
customAPICreationLimit - Int!
|
|
defaultCustomTextExtractionAPIId - ID
|
|
defaultExternalObjectStorageId - ID
|
|
enableActions - Boolean!
|
|
enableAddDocumentsToProject - Boolean!
|
|
enableDemo - Boolean!
|
|
enableDataProgramming - Boolean!
|
|
enableLabelingFunctionMultipleLabel - Boolean!
|
No longer supported |
enableDatasaurAssistRowBased - Boolean!
|
|
enableDatasaurDinamicTokenBased - Boolean!
|
|
enableDatasaurPredictiveRowBased - Boolean!
|
|
enableWipeData - Boolean!
|
|
enableExportTeamOverview - Boolean!
|
|
enableTransferOwnership - Boolean!
|
|
enableLabelErrorDetectionRowBased - Boolean!
|
|
allowedExtraAutoLabelProviders - [GqlAutoLabelServiceProvider]!
|
|
enableLLMProject - Boolean
|
|
enableRegexSentenceSeparator - Boolean!
|
|
enableTeamRoleSupervisor - Boolean!
|
|
endExtensionTrialAt - DateTime
|
|
allowInvalidPaymentMethod - Boolean!
|
|
enableExternalKnowledgeBase - Boolean
|
|
enableForceAnonymization - Boolean!
|
Example
{
"allowedAdminExportMethods": ["FILE_STORAGE"],
"allowedLabelerExportMethods": ["FILE_STORAGE"],
"allowedOCRProviders": ["APACHE_TIKA"],
"allowedASRProviders": ["OPENAI_WHISPER"],
"allowedReviewerExportMethods": ["FILE_STORAGE"],
"commentNotificationType": "OFF",
"customAPICreationLimit": 987,
"defaultCustomTextExtractionAPIId": "4",
"defaultExternalObjectStorageId": 4,
"enableActions": true,
"enableAddDocumentsToProject": true,
"enableDemo": true,
"enableDataProgramming": true,
"enableLabelingFunctionMultipleLabel": true,
"enableDatasaurAssistRowBased": false,
"enableDatasaurDinamicTokenBased": false,
"enableDatasaurPredictiveRowBased": false,
"enableWipeData": true,
"enableExportTeamOverview": false,
"enableTransferOwnership": true,
"enableLabelErrorDetectionRowBased": false,
"allowedExtraAutoLabelProviders": ["CUSTOM"],
"enableLLMProject": true,
"enableRegexSentenceSeparator": false,
"enableTeamRoleSupervisor": false,
"endExtensionTrialAt": "2007-12-03T10:15:30Z",
"allowInvalidPaymentMethod": false,
"enableExternalKnowledgeBase": true,
"enableForceAnonymization": false
}
TextChunk
Fields
| Field Name | Description |
|---|---|
id - Int!
|
|
documentId - ID
|
|
sentenceIndexStart - Int!
|
|
sentenceIndexEnd - Int!
|
|
sentences - [TextSentence!]!
|
Example
{
"id": 987,
"documentId": "4",
"sentenceIndexStart": 987,
"sentenceIndexEnd": 123,
"sentences": [TextSentence]
}
TextChunkInput
Fields
| Input Field | Description |
|---|---|
id - Int!
|
|
sentenceIndexStart - Int!
|
|
sentenceIndexEnd - Int!
|
|
sentences - [TextSentenceInput]!
|
Example
{
"id": 987,
"sentenceIndexStart": 987,
"sentenceIndexEnd": 987,
"sentences": [TextSentenceInput]
}
TextCursor
TextCursorInput
TextDocument
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
chunks - [TextChunk!]!
|
|
createdAt - String!
|
|
currentSentenceCursor - Int!
|
|
lastLabeledLine - Int
|
|
documentSettings - TextDocumentSettings
|
|
fileName - String!
|
|
isCompleted - Boolean!
|
|
lastSavedAt - String!
|
|
mimeType - String!
|
|
name - String!
|
|
projectId - ID
|
|
sentences - [TextSentence!]!
|
Deprecated. Please use getRowAnswers. Deprecated. Please use getRowAnswers.
|
settings - Settings!
|
|
statistic - TextDocumentStatistic!
|
|
type - TextDocumentType!
|
|
updatedChunks - [TextChunk!]!
|
|
updatedTokenLabels - [TextLabel!]!
|
|
url - String
|
|
version - Int!
|
|
workspaceState - WorkspaceState
|
|
originId - ID
|
|
signature - String!
|
|
part - Int!
|
|
Example
{
"id": "4",
"chunks": [TextChunk],
"createdAt": "abc123",
"currentSentenceCursor": 987,
"lastLabeledLine": 987,
"documentSettings": TextDocumentSettings,
"fileName": "abc123",
"isCompleted": true,
"lastSavedAt": "xyz789",
"mimeType": "abc123",
"name": "abc123",
"projectId": 4,
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "xyz789",
"version": 123,
"workspaceState": WorkspaceState,
"originId": "4",
"signature": "xyz789",
"part": 123
}
TextDocumentScalar
Example
TextDocumentScalar
TextDocumentSettings
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
textLabelMaxTokenLength - Int!
|
Number of token that can be covered by one label. |
allTokensMustBeLabeled - Boolean!
|
Specific for Span labeling. True will force every token to have at least one label. |
autoScrollWhenLabeling - Boolean!
|
|
allowArcDrawing - Boolean!
|
Enables drawing arrows between labels in Span labeling. |
allowCharacterBasedLabeling - Boolean
|
Enables character span labeling. |
allowMultiLabels - Boolean!
|
Enables placing multiple labels on one character / token span. |
kinds - [ProjectKind!]!
|
The project kinds associated with the document. |
sentenceSeparator - String!
|
The sentence separator of the document. See the input type for more details TextDocumentSettingsInput or CreationSettingsInput |
tokenizer - String!
|
The tokenizer of the document. One of [WINK, WHITE_SPACE]. |
editSentenceTokenizer - String!
|
The tokenizer of the document. One of [WINK, WHITE_SPACE]. |
displayedRows - Int!
|
How many rows are displayed at once. -1 displays all rows. |
mediaDisplayStrategy - MediaDisplayStrategy!
|
|
viewer - TextDocumentViewer!
|
Sets how the Changes accordingly with the task type and/or document type |
viewerConfig - TextDocumentViewerConfig
|
|
hideBoundingBoxIfNoSpanOrArrowLabel - Boolean
|
Hide if the bounding box does not have span label corresponded with it |
enableTabularMarkdownParsing - Boolean
|
|
enableAnonymization - Boolean!
|
|
anonymizationEntityTypes - [String!]
|
|
anonymizationMaskingMethod - String
|
Masking method for anonymization. One of [RANDOM_CHARACTER, ASTERISK]. |
anonymizationRegExps - [RegularExpression!]
|
Optional. List of regular expressions for getting additional PII entities to anonymize. |
fileTransformerId - String
|
Example
{
"id": "4",
"textLabelMaxTokenLength": 987,
"allTokensMustBeLabeled": false,
"autoScrollWhenLabeling": false,
"allowArcDrawing": true,
"allowCharacterBasedLabeling": true,
"allowMultiLabels": true,
"kinds": ["DOCUMENT_BASED"],
"sentenceSeparator": "abc123",
"tokenizer": "xyz789",
"editSentenceTokenizer": "xyz789",
"displayedRows": 123,
"mediaDisplayStrategy": "NONE",
"viewer": "TOKEN",
"viewerConfig": TextDocumentViewerConfig,
"hideBoundingBoxIfNoSpanOrArrowLabel": true,
"enableTabularMarkdownParsing": true,
"enableAnonymization": false,
"anonymizationEntityTypes": ["abc123"],
"anonymizationMaskingMethod": "xyz789",
"anonymizationRegExps": [RegularExpression],
"fileTransformerId": "xyz789"
}
TextDocumentSettingsInput
Description
Configuration parameter for new documents. Used in project creation via mutation launchTextProjectAsync. Span refers to both character and token.
Fields
| Input Field | Description |
|---|---|
textLabelMaxTokenLength - Int
|
Specific for Span labeling. Determine how many spans that can be covered by one label. Default to 999999. |
allTokensMustBeLabeled - Boolean
|
Specific for Span labeling. True will force every span to have at least one label. Default to false. |
autoScrollWhenLabeling - Boolean
|
Enables autoscrolling in the web UI. Default to false. |
allowArcDrawing - Boolean
|
Specific for Span labeling. True will enable drawing arrows between labels. Default to false. |
allowCharacterBasedLabeling - Boolean
|
Specific for Span labeling. True will enable character span labeling. Default to false. |
allowMultiLabels - Boolean
|
Specific for Span labeling. True will allow span to have multiple labels. |
sentenceSeparator - String
|
For Span labeling, with TXT or TSV IOB files.
|
tokenizer - String
|
Specific for Span labeling. One of [WINK, WHITE_SPACE]. Default to WINK. |
editSentenceTokenizer - String
|
Specific for Span labeling. One of [WINK, WHITE_SPACE]. Default to WINK. |
displayedRows - Int
|
Specific for Row Labeling, Determines how many rows are displayed in the editor. Default to -1, showing all rows. |
mediaDisplayStrategy - MediaDisplayStrategy
|
Specific for Row Labeling. Default to NONE. |
ocrMethod - TranscriptMethod
|
Deprecated. Please use field transcriptMethod instead. |
transcriptMethod - TranscriptMethod
|
Required for transcription tasks. |
ocrProvider - OCRProvider
|
Optional. For OCR tasks when transcriptMethod is set to INTERNAL. Default to null. |
asrProvider - ASRProvider
|
Optional. For ASR tasks when transcriptMethod is set to INTERNAL. Default to null. |
viewer - TextDocumentViewer
|
Required for Token and Row Labeling. TOKEN view for Span labeling. TABULAR view for Row Labeling with spreadsheet-like interface. URL view for Row Labeling with URL viewer. Configurable via the viewerConfig field. |
viewerConfig - TextDocumentViewerConfigInput
|
|
customScriptId - ID
|
Deprecated. Please use field fileTransformerId instead. No longer supported
|
fileTransformerId - ID
|
Optional. Sets the file transformer to be used in the project. Default to null. |
customTextExtractionAPIId - ID
|
Optional. Default to null. |
firstRowAsHeader - Boolean
|
Required for .csv files / Row Labeling. Sets the first row of data as header rows. Default to null. |
enableTabularMarkdownParsing - Boolean
|
For .csv files / Row Labeling. Enables markdown parsing. Default to false |
enableAnonymization - Boolean
|
Optional. Set to true to enable anonymization |
anonymizationEntityTypes - [String!]
|
Optional. List of PII entity types to anonymize |
anonymizationMaskingMethod - String
|
Optional. Masking method for anonymization. One of [RANDOM_CHARACTER, ASTERISK]. |
anonymizationRegExps - [RegularExpressionInput!]
|
Optional. List of regular expressions for getting additional PII entities to anonymize. |
kind - ProjectKind
|
Deprecated. Use kinds to support mixed labeling. Use kinds to support mixed labeling |
Example
{
"textLabelMaxTokenLength": 987,
"allTokensMustBeLabeled": true,
"autoScrollWhenLabeling": true,
"allowArcDrawing": false,
"allowCharacterBasedLabeling": true,
"allowMultiLabels": false,
"sentenceSeparator": "xyz789",
"tokenizer": "xyz789",
"editSentenceTokenizer": "abc123",
"displayedRows": 987,
"mediaDisplayStrategy": "NONE",
"ocrMethod": "TRANSCRIPTION",
"transcriptMethod": "TRANSCRIPTION",
"ocrProvider": "APACHE_TIKA",
"asrProvider": "OPENAI_WHISPER",
"viewer": "TOKEN",
"viewerConfig": TextDocumentViewerConfigInput,
"customScriptId": 4,
"fileTransformerId": "4",
"customTextExtractionAPIId": "4",
"firstRowAsHeader": true,
"enableTabularMarkdownParsing": false,
"enableAnonymization": false,
"anonymizationEntityTypes": ["abc123"],
"anonymizationMaskingMethod": "abc123",
"anonymizationRegExps": [RegularExpressionInput],
"kind": "DOCUMENT_BASED"
}
TextDocumentStatistic
Fields
| Field Name | Description |
|---|---|
documentId - ID
|
|
numberOfChunks - Int!
|
|
numberOfSentences - Int!
|
|
numberOfTokens - Int!
|
|
effectiveTimeSpent - Int!
|
Effective time spent is the time in millisecond(s) that the assignee spent on a text document. |
touchedSentences - [Int!]
|
|
nonDisplayedLines - [Int!]!
|
|
numberOfEntitiesLabeled - Int
|
|
numberOfNonDocumentEntitiesLabeled - Int
|
|
maxLabeledLine - Int!
|
|
labelerStatistic - [LabelerStatistic!]
|
|
documentTouched - Boolean
|
Example
{
"documentId": "4",
"numberOfChunks": 987,
"numberOfSentences": 987,
"numberOfTokens": 123,
"effectiveTimeSpent": 123,
"touchedSentences": [987],
"nonDisplayedLines": [123],
"numberOfEntitiesLabeled": 123,
"numberOfNonDocumentEntitiesLabeled": 123,
"maxLabeledLine": 123,
"labelerStatistic": [LabelerStatistic],
"documentTouched": true
}
TextDocumentStatisticInput
TextDocumentType
Description
More complete explanation can be found here in this page
Values
| Enum Value | Description |
|---|---|
|
|
Part of Speech |
|
|
Named Entity Recognition |
|
|
Dependency |
|
|
Document Labeling |
|
|
Deprecated. Aspect Based Sentiment Analysis No longer supported |
|
|
Coreference |
|
|
Optical Character Recognition |
|
|
Audio Speech Recognition |
|
|
|
|
|
|
|
|
|
|
|
Example
"POS"
TextDocumentViewer
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"TOKEN"
TextDocumentViewerConfig
Fields
| Field Name | Description |
|---|---|
urlColumnNames - [String!]
|
Example
{"urlColumnNames": ["abc123"]}
TextDocumentViewerConfigInput
Fields
| Input Field | Description |
|---|---|
urlColumnNames - [String!]
|
Example
{"urlColumnNames": ["abc123"]}
TextLabel
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
l - String!
|
|
layer - Int!
|
|
deleted - Boolean
|
|
hashCode - String!
|
|
labeledBy - ConflictTextLabelResolutionStrategy
|
|
labeledByUser - User
|
|
labeledByUserId - Int
|
|
createdAt - String
|
|
updatedAt - String
|
|
documentId - String
|
|
start - TextCursor!
|
|
end - TextCursor!
|
|
confidenceScore - Float
|
Example
{
"id": "abc123",
"l": "xyz789",
"layer": 123,
"deleted": false,
"hashCode": "abc123",
"labeledBy": "AUTO",
"labeledByUser": User,
"labeledByUserId": 987,
"createdAt": "abc123",
"updatedAt": "abc123",
"documentId": "abc123",
"start": TextCursor,
"end": TextCursor,
"confidenceScore": 987.65
}
TextLabelInput
Fields
| Input Field | Description |
|---|---|
id - String!
|
|
l - String!
|
|
start - TextCursorInput!
|
|
end - TextCursorInput!
|
|
layer - Int!
|
|
deleted - Boolean
|
|
labeledBy - ConflictTextLabelResolutionStrategy
|
|
confidenceScore - Float
|
Example
{
"id": "abc123",
"l": "xyz789",
"start": TextCursorInput,
"end": TextCursorInput,
"layer": 987,
"deleted": false,
"labeledBy": "AUTO",
"confidenceScore": 987.65
}
TextLabelScalar
Example
TextLabelScalar
TextMetadataConfig
TextRange
Fields
| Field Name | Description |
|---|---|
start - TextCursor!
|
|
end - TextCursor!
|
Example
{
"start": TextCursor,
"end": TextCursor
}
TextRangeInput
Fields
| Input Field | Description |
|---|---|
start - TextCursorInput!
|
|
end - TextCursorInput!
|
Example
{
"start": TextCursorInput,
"end": TextCursorInput
}
TextSentence
Fields
| Field Name | Description |
|---|---|
id - Int!
|
|
documentId - ID
|
|
userId - ID
|
|
status - TextSentenceStatus!
|
|
content - String!
|
|
tokens - [String!]!
|
|
posLabels - [TextLabel!]!
|
|
nerLabels - [TextLabel!]!
|
|
docLabels - [DocLabelObject!]
|
|
docLabelsString - String
|
|
conflicts - [ConflictTextLabel!]
|
|
conflictAnswers - [ConflictAnswer!]
|
|
answers - [Answer!]
|
|
sentenceConflict - SentenceConflict
|
|
conflictAnswerResolved - ConflictTextLabelResolutionStrategy
|
|
metadata - [CellMetadata!]
|
Example
{
"id": 987,
"documentId": 4,
"userId": "4",
"status": "DELETED",
"content": "xyz789",
"tokens": ["abc123"],
"posLabels": [TextLabel],
"nerLabels": [TextLabel],
"docLabels": [DocLabelObject],
"docLabelsString": "xyz789",
"conflicts": [ConflictTextLabel],
"conflictAnswers": [ConflictAnswer],
"answers": [Answer],
"sentenceConflict": SentenceConflict,
"conflictAnswerResolved": "AUTO",
"metadata": [CellMetadata]
}
TextSentenceInput
Fields
| Input Field | Description |
|---|---|
id - Int!
|
|
content - String!
|
|
tokens - [String!]
|
|
posLabels - [TextLabelInput!]
|
|
nerLabels - [TextLabelInput!]
|
|
docLabels - [DocLabelObjectInput!]
|
|
docLabelsString - String
|
|
metadata - [CellMetadataInput!]
|
Example
{
"id": 123,
"content": "xyz789",
"tokens": ["xyz789"],
"posLabels": [TextLabelInput],
"nerLabels": [TextLabelInput],
"docLabels": [DocLabelObjectInput],
"docLabelsString": "xyz789",
"metadata": [CellMetadataInput]
}
TextSentenceStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DELETED"
TimelineDocument
TimelineEvent
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
user - User
|
|
event - String!
|
|
targetProject - TimelineProject
|
|
targetDocument - TimelineDocument
|
|
targetUser - User
|
|
created - String!
|
Example
{
"id": 4,
"user": User,
"event": "xyz789",
"targetProject": TimelineProject,
"targetDocument": TimelineDocument,
"targetUser": User,
"created": "xyz789"
}
TimelineProject
TimestampLabel
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
documentId - ID!
|
|
layer - Int!
|
|
position - TextRange!
|
|
startTimestampMillis - Int!
|
|
endTimestampMillis - Int!
|
|
type - LabelEntityType!
|
Example
{
"id": 4,
"documentId": 4,
"layer": 987,
"position": TextRange,
"startTimestampMillis": 987,
"endTimestampMillis": 987,
"type": "ARROW"
}
TimestampLabelInput
Fields
| Input Field | Description |
|---|---|
layer - Int!
|
|
position - TextRangeInput!
|
|
counter - Int!
|
|
startTimestampMillis - Int!
|
|
endTimestampMillis - Int!
|
|
labeledBy - LabelPhase
|
Example
{
"layer": 123,
"position": TextRangeInput,
"counter": 987,
"startTimestampMillis": 987,
"endTimestampMillis": 123,
"labeledBy": "PRELABELED"
}
TokenBasedDocumentSettingsInput
Description
Configuration for Token Labeling projects.
Fields
| Input Field | Description |
|---|---|
textLabelMaxTokenLength - Int
|
Determine how many spans that can be covered by one label. Default to 999999. |
allTokensMustBeLabeled - Boolean
|
Set to true to force every span to have at least one label. Default to false. |
autoScrollWhenLabeling - Boolean
|
Enables autoscrolling in the web UI. Default to false. |
allowArcDrawing - Boolean
|
Set to true to enable drawing arrows between labels. Default to false. |
allowCharacterBasedLabeling - Boolean
|
Set to true to enable character span labeling. Default to false, which means token span labeling |
allowMultiLabels - Boolean
|
Set to true to allow span to have multiple labels. Default to false. |
editSentenceTokenizer - String
|
Sets the default tokenizer for sentence editing. One of [WINK, WHITE_SPACE]. Default to WINK. |
Example
{
"textLabelMaxTokenLength": 987,
"allTokensMustBeLabeled": false,
"autoScrollWhenLabeling": true,
"allowArcDrawing": true,
"allowCharacterBasedLabeling": false,
"allowMultiLabels": false,
"editSentenceTokenizer": "xyz789"
}
TokenPrices
Fields
| Field Name | Description |
|---|---|
inputCharPrice - Float
|
|
inputTokenPrice - Float!
|
|
outputCharPrice - Float
|
|
outputTokenPrice - Float!
|
|
totalCharPrice - Float
|
|
totalTokenPrice - Float!
|
|
promptCharPrice - Float
|
|
promptTokenPrice - Float
|
|
imageTokenPrice - Float
|
|
promptEmbeddingTokenPrice - Float
|
|
contextCharPrice - Float
|
|
contextTokenPrice - Float
|
|
systemInstructionCharPrice - Float
|
|
systemInstructionTokenPrice - Float
|
|
userInstructionCharPrice - Float
|
|
userInstructionTokenPrice - Float
|
Example
{
"inputCharPrice": 123.45,
"inputTokenPrice": 123.45,
"outputCharPrice": 987.65,
"outputTokenPrice": 987.65,
"totalCharPrice": 123.45,
"totalTokenPrice": 987.65,
"promptCharPrice": 123.45,
"promptTokenPrice": 123.45,
"imageTokenPrice": 123.45,
"promptEmbeddingTokenPrice": 987.65,
"contextCharPrice": 987.65,
"contextTokenPrice": 987.65,
"systemInstructionCharPrice": 987.65,
"systemInstructionTokenPrice": 123.45,
"userInstructionCharPrice": 123.45,
"userInstructionTokenPrice": 123.45
}
TokenUnitPriceInput
Fields
| Input Field | Description |
|---|---|
provider - GqlLlmModelProvider!
|
|
modelName - String!
|
|
embeddingProvider - GqlLlmModelProvider
|
|
embeddingModelName - String
|
Example
{
"provider": "AMAZON_BEDROCK",
"modelName": "xyz789",
"embeddingProvider": "AMAZON_BEDROCK",
"embeddingModelName": "xyz789"
}
TokenUnitPriceResponse
TokenUnitPrices
TokenUsages
Fields
| Field Name | Description |
|---|---|
inputChars - Int
|
|
inputTokens - Int!
|
|
outputChars - Int
|
|
outputTokens - Int!
|
|
totalChars - Int
|
|
totalTokens - Int!
|
|
promptChars - Int
|
|
promptTokens - Int
|
|
imageTokens - Int
|
|
promptEmbeddingTokens - Int
|
|
contextChars - Int
|
|
contextTokens - Int
|
|
systemInstructionChars - Int
|
|
systemInstructionTokens - Int
|
|
userInstructionChars - Int
|
|
userInstructionTokens - Int
|
Example
{
"inputChars": 987,
"inputTokens": 123,
"outputChars": 123,
"outputTokens": 123,
"totalChars": 987,
"totalTokens": 123,
"promptChars": 987,
"promptTokens": 123,
"imageTokens": 123,
"promptEmbeddingTokens": 123,
"contextChars": 123,
"contextTokens": 123,
"systemInstructionChars": 123,
"systemInstructionTokens": 123,
"userInstructionChars": 123,
"userInstructionTokens": 987
}
TokenizationMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"WINK"
TotpAuthSecret
TotpCodeInput
Fields
| Input Field | Description |
|---|---|
type - TotpCodeType!
|
|
code - String!
|
Example
{"type": "RECOVERY", "code": "xyz789"}
TotpCodeType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"RECOVERY"
TotpRecoveryCodes
Fields
| Field Name | Description |
|---|---|
recoveryCodes - [String!]!
|
Recovery codes in array of string. Can return empty array if user has used up all of the recovery codes. |
Example
{"recoveryCodes": ["abc123"]}
TranscriptConfigInput
Description
Required for transcription tasks - for token labeling with Audio or OCR.
Fields
| Input Field | Description |
|---|---|
method - TranscriptMethod!
|
Required. Sets the transcription method. |
ocrProvider - OCRProvider
|
Required for method=INTERNAL. This value will be used for OCR projects, and ignored for audio projects |
asrProvider - ASRProvider
|
Required for method=INTERNAL. This value will be used for audio projects, and ignored for OCR projects |
customAPIId - ID
|
Required for method=CUSTOM_API |
Example
{
"method": "TRANSCRIPTION",
"ocrProvider": "APACHE_TIKA",
"asrProvider": "OPENAI_WHISPER",
"customAPIId": 4
}
TranscriptMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"TRANSCRIPTION"
TrialSurveyInput
UnusedLabelClass
UnusedLabelSetItemInfo
Fields
| Field Name | Description |
|---|---|
labelSetId - ID!
|
|
labelSetName - String!
|
|
items - [TagItem!]!
|
Example
{
"labelSetId": "4",
"labelSetName": "abc123",
"items": [TagItem]
}
UpdateBBoxLabelClassInput
Example
{
"id": "4",
"name": "abc123",
"color": "abc123",
"captionAllowed": true,
"captionRequired": true,
"questions": [ModifyQuestionInput]
}
UpdateConflictsInput
UpdateConflictsResult
Fields
| Field Name | Description |
|---|---|
document - TextDocument!
|
|
previousSentences - [TextSentence!]!
|
|
updatedSentences - [TextSentence!]!
|
Example
{
"document": TextDocument,
"previousSentences": [TextSentence],
"updatedSentences": [TextSentence]
}
UpdateCreateProjectActionInput
Description
Parameters for updating create project Action.
Fields
| Input Field | Description |
|---|---|
name - String!
|
Name of the create project Action object. |
externalObjectStorageId - ID!
|
ID of the external object storage used in this Action. |
externalObjectStoragePathInput - String!
|
The path inside the external object storage to retrieve the documents from. |
externalObjectStoragePathResult - String!
|
The path inside the external object storage to store the results to. |
projectTemplateId - ID!
|
ID of the project template used. |
assignments - [CreateProjectActionAssignmentInput!]!
|
Object that stores the assignment informations for this Action. |
additionalTagNames - [String!]
|
Tag names that will be attached to each of the projects. If the tag doesn't exist, it will be created; otherwise, it will be used. See Tag. |
numberOfLabelersPerProject - Int!
|
The number of labelers assigned per project. |
numberOfReviewersPerProject - Int!
|
The number of reviewers assigned per project. |
numberOfLabelersPerDocument - Int!
|
The number of labelers assigned per document. |
conflictResolutionMode - ConflictResolutionMode!
|
Mode used to handle conflict. MANUAL or PEER_REVIEW |
consensus - Int!
|
The number of consensus needed to resolve a conflict. |
Example
{
"name": "abc123",
"externalObjectStorageId": 4,
"externalObjectStoragePathInput": "abc123",
"externalObjectStoragePathResult": "xyz789",
"projectTemplateId": "4",
"assignments": [CreateProjectActionAssignmentInput],
"additionalTagNames": ["abc123"],
"numberOfLabelersPerProject": 987,
"numberOfReviewersPerProject": 123,
"numberOfLabelersPerDocument": 987,
"conflictResolutionMode": "MANUAL",
"consensus": 123
}
UpdateCustomAPIInput
UpdateDatasaurDinamicRowBasedInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
inputColumnIds - [Int!]
|
|
questionColumnId - Int
|
|
providerSetting - ProviderSettingInput
|
Example
{
"id": "4",
"inputColumnIds": [987],
"questionColumnId": 123,
"providerSetting": ProviderSettingInput
}
UpdateDatasaurDinamicTokenBasedInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
targetLabelSetIndex - Int
|
|
providerSetting - ProviderSettingInput
|
Example
{
"id": 4,
"targetLabelSetIndex": 123,
"providerSetting": ProviderSettingInput
}
UpdateDatasaurPredictiveInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
inputColumnIds - [Int!]
|
|
questionColumnId - Int
|
|
providerSetting - ProviderSettingInput
|
Example
{
"id": "4",
"inputColumnIds": [987],
"questionColumnId": 987,
"providerSetting": ProviderSettingInput
}
UpdateDefaultExtensionInput
Fields
| Input Field | Description |
|---|---|
teamId - ID!
|
|
defaultExtensions - [DefaultExtensionInput!]!
|
Example
{
"teamId": 4,
"defaultExtensions": [DefaultExtensionInput]
}
UpdateDocumentAnswersResult
Fields
| Field Name | Description |
|---|---|
previousAnswers - DocumentAnswer!
|
Example
{"previousAnswers": DocumentAnswer}
UpdateDocumentMetasInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
documentMeta - [DocumentMetaInput!]!
|
Example
{"projectId": 4, "documentMeta": [DocumentMetaInput]}
UpdateExtensionElementInput
UpdateFileTransformerInput
Fields
| Input Field | Description |
|---|---|
fileTransformerId - ID!
|
|
name - String
|
|
content - String
|
|
language - FileTransformerLanguage
|
Example
{
"fileTransformerId": 4,
"name": "xyz789",
"content": "abc123",
"language": "TYPESCRIPT"
}
UpdateGroundTruthInput
UpdateGroundTruthSetInput
UpdateLabelErrorDetectionRowBasedInput
UpdateLabelSetTemplateInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
name - String
|
|
questions - [LabelSetTemplateItemInput!]
|
Example
{
"id": 4,
"name": "abc123",
"questions": [LabelSetTemplateItemInput]
}
UpdateLabelingFunctionInput
Fields
| Input Field | Description |
|---|---|
labelingFunctionId - ID!
|
|
name - String
|
|
content - String
|
|
active - Boolean
|
|
heuristicArgument - HeuristicArgumentScalar
|
|
annotatorArgument - AnnotatorArgumentScalar
|
Example
{
"labelingFunctionId": 4,
"name": "abc123",
"content": "abc123",
"active": false,
"heuristicArgument": HeuristicArgumentScalar,
"annotatorArgument": AnnotatorArgumentScalar
}
UpdateLabelsResult
Fields
| Field Name | Description |
|---|---|
document - TextDocument!
|
|
updatedSentences - [TextSentence!]!
|
|
updatedCellLines - [Int!]!
|
|
updatedTokenLabels - [TextLabel!]!
|
|
previousTokenLabels - [TextLabel!]!
|
|
rejectedLabels - [RejectedLabel!]!
|
Example
{
"document": TextDocument,
"updatedSentences": [TextSentence],
"updatedCellLines": [987],
"updatedTokenLabels": [TextLabel],
"previousTokenLabels": [TextLabel],
"rejectedLabels": [RejectedLabel]
}
UpdateLlmApplicationConfigurationInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The LLM application configuration id. |
name - String
|
The name of the LLM application configuration. |
teamId - ID!
|
The team id that the LLM application configuration belongs to. |
llmRagConfigId - ID
|
The saved RAG config will be copied from the provided RAG config. |
Example
{
"id": 4,
"name": "abc123",
"teamId": "4",
"llmRagConfigId": 4
}
UpdateLlmEvaluationAutomatedInput
Fields
| Input Field | Description |
|---|---|
llmEvaluationId - ID!
|
The LLM evaluation id. |
evaluators - [LlmEvaluationAutomatedEvaluatorUpdateInput!]
|
Evaluator model(s) to use for evaluation. |
schedule - LlmEvaluationAutomatedScheduleInput
|
If schedule is null, the scheduled automated evaluation will be stopped. |
Example
{
"llmEvaluationId": "4",
"evaluators": [
LlmEvaluationAutomatedEvaluatorUpdateInput
],
"schedule": LlmEvaluationAutomatedScheduleInput
}
UpdateLlmVectorStoreAsyncInput
Description
Configuration parameter for llm vector store update.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Required. Set the llm vector store id. |
name - String
|
Optional. Set the llm vector store name if changed. |
documents - [LlmVectorStoreDocumentInput!]
|
Optional. The newly added documents associated to the llm vector store. |
deletedDocumentIds - [ID!]
|
Optional. The deleted document ids from the llm vector store. |
llmEmbeddingModelId - ID
|
|
chunkSize - Int
|
|
overlap - Int
|
|
authenticationScheme - GqlLlmVectorStoreAuthenticationScheme
|
|
collectionId - String
|
|
username - String
|
|
password - String
|
|
addedSources - [LlmVectorStoreSourceCreateInput!]
|
Optional. The newly added sources. |
updatedSources - [LlmVectorStoreSourceUpdateInput!]
|
Optional. The updated sources. |
deletedSourceIds - [ID!]
|
Optional. The deleted source ids. |
questions - [QuestionInput!]
|
Optional. Set the questions for LLM Vector Store. |
Example
{
"id": "4",
"name": "xyz789",
"documents": [LlmVectorStoreDocumentInput],
"deletedDocumentIds": [4],
"llmEmbeddingModelId": "4",
"chunkSize": 987,
"overlap": 987,
"authenticationScheme": "BASIC",
"collectionId": "abc123",
"username": "abc123",
"password": "abc123",
"addedSources": [LlmVectorStoreSourceCreateInput],
"updatedSources": [LlmVectorStoreSourceUpdateInput],
"deletedSourceIds": ["4"],
"questions": [QuestionInput]
}
UpdateLlmVectorStoreInput
Description
Configuration parameter for llm vector store update (non async).
Example
{
"id": 4,
"name": "xyz789",
"collectionId": "xyz789",
"username": "xyz789",
"password": "xyz789"
}
UpdateMultiRowAnswersInput
Fields
| Input Field | Description |
|---|---|
textDocumentId - String!
|
|
rowAnswers - [RowAnswersInput!]!
|
|
labeledBy - LabelPhaseInput
|
Example
{
"textDocumentId": "abc123",
"rowAnswers": [RowAnswersInput],
"labeledBy": "PRELABELED"
}
UpdateMultiRowAnswersResult
Fields
| Field Name | Description |
|---|---|
document - TextDocument!
|
|
previousAnswers - [RowAnswer!]!
|
|
updatedAnswers - [RowAnswer!]!
|
|
updatedLabels - [TextLabel!]!
|
Example
{
"document": TextDocument,
"previousAnswers": [RowAnswer],
"updatedAnswers": [RowAnswer],
"updatedLabels": [TextLabel]
}
UpdateProjectExtensionElementSettingInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
setting - ExtensionElementSettingInput!
|
Example
{"id": 4, "setting": ExtensionElementSettingInput}
UpdateProjectExtensionInput
Fields
| Input Field | Description |
|---|---|
cabinetId - String!
|
|
width - Int
|
|
elements - [UpdateExtensionElementInput!]
|
Example
{
"cabinetId": "xyz789",
"width": 123,
"elements": [UpdateExtensionElementInput]
}
UpdateProjectGuidelineInput
UpdateProjectInput
UpdateProjectLabelSetByLabelSetTemplateInput
Example
{
"index": 123,
"labelSetTemplateId": 4,
"projectId": "4"
}
UpdateProjectLabelSetInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Required. The labelset id to modify. |
projectId - ID!
|
Required. The project where the labelset is used. |
name - String
|
Optional. New value for the labelset name. If not supplied, the labelset's name is not changed. |
tagItems - [TagItemInput!]
|
Optional. New items to replace the labelset items. If not supplied, the items are not replaced. |
labelSetSignature - String
|
Optional. The labelset signature to modify. |
arrowLabelRequired - Boolean
|
Optional. Defaults to false. |
Example
{
"id": 4,
"projectId": "4",
"name": "abc123",
"tagItems": [TagItemInput],
"labelSetSignature": "abc123",
"arrowLabelRequired": true
}
UpdateProjectMetadataItemInput
UpdateProjectSettingsInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
autoMarkDocumentAsComplete - Boolean
|
|
consensus - Int
|
Moved under conflictResolution.consensus
|
conflictResolution - ConflictResolutionInput
|
|
enableEditLabelSet - Boolean
|
|
enableReviewerEditSentence - Boolean
|
|
enableReviewerInsertSentence - Boolean
|
|
enableReviewerDeleteSentence - Boolean
|
|
enableEditSentence - Boolean
|
|
enableInsertSentence - Boolean
|
|
enableDeleteSentence - Boolean
|
|
enableDirectBBoxEditing - Boolean
|
|
enableEnforceAutoLabelReviewerSettings - Boolean
|
|
hideLabelerNamesDuringReview - Boolean
|
|
hideLabelsFromInactiveLabelSetDuringReview - Boolean
|
|
hideOriginalSentencesDuringReview - Boolean
|
|
hideRejectedLabelsDuringReview - Boolean
|
|
dynamicReviewMethod - ProjectDynamicReviewMethod
|
|
dynamicReviewMemberId - ID
|
|
labelerProjectCompletionNotification - LabelerProjectCompletionNotificationInput
|
|
shouldConfirmUnusedLabelSetItems - Boolean
|
|
spotChecking - SpotCheckingInput
|
Example
{
"projectId": 4,
"autoMarkDocumentAsComplete": true,
"consensus": 123,
"conflictResolution": ConflictResolutionInput,
"enableEditLabelSet": true,
"enableReviewerEditSentence": true,
"enableReviewerInsertSentence": false,
"enableReviewerDeleteSentence": false,
"enableEditSentence": false,
"enableInsertSentence": false,
"enableDeleteSentence": true,
"enableDirectBBoxEditing": false,
"enableEnforceAutoLabelReviewerSettings": true,
"hideLabelerNamesDuringReview": true,
"hideLabelsFromInactiveLabelSetDuringReview": true,
"hideOriginalSentencesDuringReview": false,
"hideRejectedLabelsDuringReview": true,
"dynamicReviewMethod": "ANY_OTHER_TEAM_MEMBER",
"dynamicReviewMemberId": 4,
"labelerProjectCompletionNotification": LabelerProjectCompletionNotificationInput,
"shouldConfirmUnusedLabelSetItems": true,
"spotChecking": SpotCheckingInput
}
UpdateProjectTemplateInput
Description
Payload to update a project template. See updateProjectTemplate and updateProjectTemplateV2
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Template to update |
name - String
|
|
description - String
|
|
preview - Upload
|
Screenshot / image preview of the project template. Provide a null value to delete current image. Omit to keep current preview. |
logo - Upload
|
Logo / icon of the project template. Provide a null value to delete current logo. Omit to keep current logo. |
Example
{
"id": 4,
"name": "xyz789",
"description": "abc123",
"preview": Upload,
"logo": Upload
}
UpdateQuestionSetInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
name - String
|
|
items - [QuestionSetItemInput!]
|
Example
{
"id": 4,
"name": "abc123",
"items": [QuestionSetItemInput]
}
UpdateReversedLabelsResult
Fields
| Field Name | Description |
|---|---|
document - TextDocumentScalar!
|
|
deletedLabels - [TextLabelScalar!]!
|
|
updatedLabels - [TextLabelScalar!]!
|
Example
{
"document": TextDocumentScalar,
"deletedLabels": [TextLabelScalar],
"updatedLabels": [TextLabelScalar]
}
UpdateReviewDocumentMetasInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
documentMeta - [DocumentMetaInput!]!
|
Example
{"projectId": 4, "documentMeta": [DocumentMetaInput]}
UpdateRowAnswersResult
Fields
| Field Name | Description |
|---|---|
document - TextDocument!
|
|
previousAnswers - RowAnswer!
|
|
updatedAnswers - RowAnswer!
|
Example
{
"document": TextDocument,
"previousAnswers": RowAnswer,
"updatedAnswers": RowAnswer
}
UpdateSamlTenantInput
Example
{
"companyId": "4",
"idpIssuer": "abc123",
"idpUrl": "xyz789",
"spIssuer": "xyz789",
"certificate": "xyz789",
"active": true,
"allowMembersToSetPassword": false,
"teamId": 4
}
UpdateScimInput
UpdateSentenceConflictResult
Fields
| Field Name | Description |
|---|---|
cell - Cell!
|
|
labels - [TextLabel!]!
|
|
addedLabels - [GqlConflictable!]!
|
|
deletedLabels - [GqlConflictable!]!
|
Example
{
"cell": Cell,
"labels": [TextLabel],
"addedLabels": [GqlConflictable],
"deletedLabels": [GqlConflictable]
}
UpdateSentenceResult
Fields
| Field Name | Description |
|---|---|
document - TextDocument!
|
|
updatedSentences - [TextSentence!]!
|
Use updatedCells
|
updatedTokenLabels - [TextLabel!]!
|
Use addedLabels and deletedLabels
|
previousTokenLabels - [TextLabel!]!
|
Use addedLabels and deletedLabels
|
addedLabels - [GqlConflictable!]!
|
|
deletedLabels - [GqlConflictable!]!
|
|
updatedCells - [Cell!]!
|
|
addedBoundingBoxLabels - [BoundingBoxLabel!]!
|
|
deletedBoundingBoxLabels - [BoundingBoxLabel!]!
|
Example
{
"document": TextDocument,
"updatedSentences": [TextSentence],
"updatedTokenLabels": [TextLabel],
"previousTokenLabels": [TextLabel],
"addedLabels": [GqlConflictable],
"deletedLabels": [GqlConflictable],
"updatedCells": [Cell],
"addedBoundingBoxLabels": [BoundingBoxLabel],
"deletedBoundingBoxLabels": [BoundingBoxLabel]
}
UpdateTagInput
UpdateTeamInput
UpdateTeamMemberTeamRoleInput
Fields
| Input Field | Description |
|---|---|
teamMemberId - ID!
|
|
teamRoleId - ID
|
Use teamRole instead. When both are provided, teamRole will be prioritized. |
teamRole - TeamMemberRole
|
Example
{"teamMemberId": 4, "teamRoleId": 4, "teamRole": "ADMIN"}
UpdateTeamSettingInput
Fields
| Input Field | Description |
|---|---|
allowedReviewerExportMethods - [GqlExportMethod!]
|
|
allowedLabelerExportMethods - [GqlExportMethod!]
|
|
teamId - ID!
|
|
commentNotificationType - CommentNotificationType
|
|
defaultExternalObjectStorageId - ID
|
|
enableActions - Boolean
|
|
enableDataProgramming - Boolean
|
|
enableDatasaurAssistRowBased - Boolean
|
|
enableDatasaurDinamicTokenBased - Boolean
|
|
enableDatasaurPredictiveRowBased - Boolean
|
|
enableLabelErrorDetectionRowBased - Boolean
|
|
enableWipeData - Boolean
|
Example
{
"allowedReviewerExportMethods": ["FILE_STORAGE"],
"allowedLabelerExportMethods": ["FILE_STORAGE"],
"teamId": 4,
"commentNotificationType": "OFF",
"defaultExternalObjectStorageId": "4",
"enableActions": true,
"enableDataProgramming": false,
"enableDatasaurAssistRowBased": false,
"enableDatasaurDinamicTokenBased": false,
"enableDatasaurPredictiveRowBased": true,
"enableLabelErrorDetectionRowBased": true,
"enableWipeData": true
}
UpdateTextDocumentInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Required. The document ID to be updated. See getCabinet |
name - String
|
|
fileName - String
|
|
chunks - [TextChunkInput!]
|
|
statistic - TextDocumentStatisticInput
|
|
settings - SettingsInput
|
Optional. The updated settings value for the document. |
type - TextDocumentType
|
|
currentSentenceCursor - Int
|
|
workspaceState - WorkspaceStateInput
|
|
isCompleted - Boolean
|
|
touchedSentences - [Int!]
|
Example
{
"id": "4",
"name": "abc123",
"fileName": "abc123",
"chunks": [TextChunkInput],
"statistic": TextDocumentStatisticInput,
"settings": SettingsInput,
"type": "POS",
"currentSentenceCursor": 123,
"workspaceState": WorkspaceStateInput,
"isCompleted": true,
"touchedSentences": [987]
}
UpdateTextDocumentSettingsInput
Description
Configuration parameter for updating documents.
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
lang - String
|
|
textLabelMaxTokenLength - Int
|
Determines how many token that can be covered by one label. 999999 is usually fine as a default value. |
allTokensMustBeLabeled - Boolean
|
Specific for Span labeling. True will force every token to have at least one label. |
autoScrollWhenLabeling - Boolean
|
|
allowArcDrawing - Boolean
|
Allow arrows to be drawn between labels in Span labeling. |
allowCharacterBasedLabeling - Boolean
|
Enables character span labeling. |
allowMultiLabels - Boolean
|
Enables placing multiple labels on one character / token span. |
kind - ProjectKind
|
|
sentenceSeparator - String
|
Possible values are and . |
Example
{
"projectId": 4,
"lang": "abc123",
"textLabelMaxTokenLength": 123,
"allTokensMustBeLabeled": false,
"autoScrollWhenLabeling": false,
"allowArcDrawing": false,
"allowCharacterBasedLabeling": true,
"allowMultiLabels": false,
"kind": "DOCUMENT_BASED",
"sentenceSeparator": "abc123"
}
UpdateTokenLabelsAction
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"LABEL"
UpdateTokenLabelsInput
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
|
labels - [TextLabelInput!]!
|
|
action - UpdateTokenLabelsAction!
|
|
type - UpdateTokenLabelsInputType
|
|
signature - String!
|
Example
{
"documentId": "4",
"labels": [TextLabelInput],
"action": "LABEL",
"type": "SEARCH_LABEL_ALL",
"signature": "xyz789"
}
UpdateTokenLabelsInputType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SEARCH_LABEL_ALL"
UpdateUserInfoInput
Upload
Example
Upload
UploadGuidelineInput
UpsertLabelErrorDetectionRowBasedSuggestionInput
Fields
| Input Field | Description |
|---|---|
suggestions - [LabelErrorDetectionRowBasedSuggestionInput!]!
|
Example
{
"suggestions": [
LabelErrorDetectionRowBasedSuggestionInput
]
}
UpsertOauthClientResult
UseVectorStoreInLlmApplicationInput
Fields
| Input Field | Description |
|---|---|
teamId - ID!
|
ID of the team. |
llmVectorStoreId - ID!
|
ID of the vector store to be used in the LLM application. |
llmApplicationId - ID
|
ID of the LLM application, if not provided, a new LLM application will be created. |
llmApplicationPlaygroundRagConfigIds - [ID!]
|
ID of the LLM application playground RAG config. |
createNewApplicationPlaygroundRagConfig - Boolean
|
If true, a new LLM application playground RAG config will be created. |
Example
{
"teamId": "4",
"llmVectorStoreId": "4",
"llmApplicationId": 4,
"llmApplicationPlaygroundRagConfigIds": [4],
"createNewApplicationPlaygroundRagConfig": true
}
User
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
amazonCustomerId - String
|
|
username - String
|
|
name - String
|
|
email - String!
|
|
package - Package!
|
|
profilePicture - String
|
|
allowedActions - [Action!]
|
|
displayName - String!
|
|
teamPackage - Package
|
|
emailVerified - Boolean
|
|
totpAuthEnabled - Boolean
|
|
companyName - String
|
|
createdAt - DateTime
|
|
signUpParams - SignUpParams
|
Example
{
"id": "4",
"amazonCustomerId": "abc123",
"username": "xyz789",
"name": "abc123",
"email": "xyz789",
"package": "ENTERPRISE",
"profilePicture": "xyz789",
"allowedActions": ["CREATE_TEAM"],
"displayName": "xyz789",
"teamPackage": "ENTERPRISE",
"emailVerified": false,
"totpAuthEnabled": false,
"companyName": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"signUpParams": SignUpParams
}
UserAccountDetails
Fields
| Field Name | Description |
|---|---|
hasPassword - Boolean!
|
|
signUpMethod - SignUpMethod
|
Example
{"hasPassword": false, "signUpMethod": "EMAIL_PASSWORD"}
ValidateLLMAssistedLabelingSettingsInput
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
|
provider - LLMAssistedLabelingProvider!
|
|
options - ExtensionElementSettingOptions!
|
Example
{
"documentId": 4,
"provider": "OPENAI",
"options": ExtensionElementSettingOptions
}
ValidateLLMAssistedLabelingSettingsOutput
ViewerInput
Description
Labeling interface configuration
Fields
| Input Field | Description |
|---|---|
mode - TextDocumentViewer!
|
TOKEN for Token Labeling, and TABULAR or URL for Row Labeling. For URL, configure which column should be rendered via urlColumnNames.
|
urlColumnNames - [String!]
|
Additional configuration for TextDocumentViewer.URL. Required. |
Example
{
"mode": "TOKEN",
"urlColumnNames": ["abc123"]
}
Visualization
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PIE_CHART"
VisualizationParams
Fields
| Field Name | Description |
|---|---|
visualization - Visualization!
|
|
vAxisTitle - String
|
|
hAxisTitle - String
|
|
pieHoleText - String
|
|
chartArea - ChartArea
|
|
legend - Legend
|
|
colorGradient - ColorGradient
|
|
isStacked - Boolean
|
|
itemsPerPage - Int
|
|
colors - [String!]
|
|
abbreviateKey - Boolean
|
|
showTable - Boolean
|
|
unit - String
|
Example
{
"visualization": "PIE_CHART",
"vAxisTitle": "xyz789",
"hAxisTitle": "xyz789",
"pieHoleText": "abc123",
"chartArea": ChartArea,
"legend": Legend,
"colorGradient": ColorGradient,
"isStacked": true,
"itemsPerPage": 123,
"colors": ["abc123"],
"abbreviateKey": false,
"showTable": false,
"unit": "abc123"
}
WaveformPeaks
Fields
| Field Name | Description |
|---|---|
peaks - [Float!]!
|
Generated audiowaveform data in Float. The peaks value is normalized ranging from 0 - 1. 1 denotes the max value (the loudest point in the audio input) |
pixelPerSecond - Int!
|
The number of output waveform data points to generate for each second of audio input |
Example
{"peaks": [123.45], "pixelPerSecond": 123}
WelcomeEmail
Fields
| Field Name | Description |
|---|---|
email - String!
|
Example
{"email": "xyz789"}
WelcomeEmailInput
Fields
| Input Field | Description |
|---|---|
email - String!
|
Example
{"email": "xyz789"}
WipeProjectInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
Example
{"projectId": 4}
WorkspaceSettings
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
textLabelMaxTokenLength - Int!
|
|
allTokensMustBeLabeled - Boolean!
|
|
autoScrollWhenLabeling - Boolean!
|
|
allowArcDrawing - Boolean!
|
|
allowCharacterBasedLabeling - Boolean
|
|
allowMultiLabels - Boolean!
|
|
asrProvider - ASRProvider
|
|
kinds - [ProjectKind!]!
|
|
sentenceSeparator - String!
|
|
displayedRows - Int!
|
|
mediaDisplayStrategy - MediaDisplayStrategy!
|
|
tokenizer - String!
|
|
firstRowAsHeader - Boolean
|
|
transcriptMethod - TranscriptMethod
|
|
ocrProvider - OCRProvider
|
|
customScriptId - ID
|
Deprecated. Please use field fileTransformerId instead. No longer supported
|
fileTransformerId - ID
|
|
customTextExtractionAPIId - ID
|
|
enableTabularMarkdownParsing - Boolean
|
|
enableAnonymization - Boolean!
|
|
anonymizationEntityTypes - [String!]
|
|
anonymizationMaskingMethod - String
|
|
anonymizationRegExps - [RegularExpression!]
|
|
viewer - TextDocumentViewer
|
|
viewerConfig - TextDocumentViewerConfig
|
Example
{
"id": "4",
"textLabelMaxTokenLength": 987,
"allTokensMustBeLabeled": false,
"autoScrollWhenLabeling": true,
"allowArcDrawing": true,
"allowCharacterBasedLabeling": false,
"allowMultiLabels": false,
"asrProvider": "OPENAI_WHISPER",
"kinds": ["DOCUMENT_BASED"],
"sentenceSeparator": "abc123",
"displayedRows": 123,
"mediaDisplayStrategy": "NONE",
"tokenizer": "abc123",
"firstRowAsHeader": true,
"transcriptMethod": "TRANSCRIPTION",
"ocrProvider": "APACHE_TIKA",
"customScriptId": 4,
"fileTransformerId": 4,
"customTextExtractionAPIId": "4",
"enableTabularMarkdownParsing": true,
"enableAnonymization": false,
"anonymizationEntityTypes": ["abc123"],
"anonymizationMaskingMethod": "abc123",
"anonymizationRegExps": [RegularExpression],
"viewer": "TOKEN",
"viewerConfig": TextDocumentViewerConfig
}