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 CheckConnectionResult!
Arguments
| Name | Description |
|---|---|
externalObjectStorageId - ID!
|
Example
Query
query CheckExternalObjectStorageConnection($externalObjectStorageId: ID!) {
checkExternalObjectStorageConnection(externalObjectStorageId: $externalObjectStorageId) {
readOnly
}
}
Variables
{"externalObjectStorageId": "4"}
Response
{"data": {"checkExternalObjectStorageConnection": {"readOnly": 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
}
}
}
checkNewExternalObjectStorageCredentials
Response
Returns a CheckConnectionResult!
Arguments
| Name | Description |
|---|---|
input - CreateExternalObjectStorageInput!
|
Example
Query
query CheckNewExternalObjectStorageCredentials($input: CreateExternalObjectStorageInput!) {
checkNewExternalObjectStorageCredentials(input: $input) {
readOnly
}
}
Variables
{"input": CreateExternalObjectStorageInput}
Response
{"data": {"checkNewExternalObjectStorageCredentials": {"readOnly": false}}}
checkS3BucketForbidden
Breaking changes may be introduced anytime in the future without prior notice.
Example
Query
query CheckS3BucketForbidden(
$teamId: ID!,
$bucketName: String!
) {
checkS3BucketForbidden(
teamId: $teamId,
bucketName: $bucketName
)
}
Variables
{"teamId": 4, "bucketName": "abc123"}
Response
{"data": {"checkS3BucketForbidden": true}}
countProjectsByExternalObjectStorageId
diagnoseCreateProjectActionStorage
Description
Probe the configured input/destination buckets and prefixes for the permissions the selected mode needs (immutable: input read; move: input + destination read/write/delete).
Response
Arguments
| Name | Description |
|---|---|
input - DiagnoseCreateProjectActionStorageInput!
|
Example
Query
query DiagnoseCreateProjectActionStorage($input: DiagnoseCreateProjectActionStorageInput!) {
diagnoseCreateProjectActionStorage(input: $input) {
ok
hasWarning
buckets {
label
ok
checks {
...StoragePermissionCheckFragment
}
}
}
}
Variables
{"input": DiagnoseCreateProjectActionStorageInput}
Response
{
"data": {
"diagnoseCreateProjectActionStorage": {
"ok": false,
"hasWarning": true,
"buckets": [StoragePermissionBucket]
}
}
}
diagnoseExternalObjectStorage
Response
Returns an DiagnoseEOSResult!
Arguments
| Name | Description |
|---|---|
externalObjectStorageId - ID!
|
Example
Query
query DiagnoseExternalObjectStorage($externalObjectStorageId: ID!) {
diagnoseExternalObjectStorage(externalObjectStorageId: $externalObjectStorageId) {
listObjects {
success
key
message
}
sampledObjects {
key
sizeInBytes
headObjectSuccess
headObjectMessage
getObjectSuccess
getObjectMessage
}
writeObject {
success
key
message
}
deleteObject {
success
key
message
}
versioningCheck {
supported
enabled
hasDeleteMarkers
versionCount
message
}
}
}
Variables
{"externalObjectStorageId": "4"}
Response
{
"data": {
"diagnoseExternalObjectStorage": {
"listObjects": DiagnoseCheckResult,
"sampledObjects": [DiagnoseObjectReadResult],
"writeObject": DiagnoseCheckResult,
"deleteObject": DiagnoseCheckResult,
"versioningCheck": DiagnoseVersioningResult
}
}
}
dictionaryLookup
Response
Returns a DictionaryResult!
Example
Query
query DictionaryLookup(
$word: String!,
$lang: String
) {
dictionaryLookup(
word: $word,
lang: $lang
) {
word
lang
entries {
lexicalCategory
definitions {
...DefinitionEntryFragment
}
}
}
}
Variables
{
"word": "xyz789",
"lang": "abc123"
}
Response
{
"data": {
"dictionaryLookup": {
"word": "xyz789",
"lang": "abc123",
"entries": [DictionaryResultEntry]
}
}
}
dictionaryLookupBatch
Response
Returns [DictionaryResult!]!
Arguments
| Name | Description |
|---|---|
words - [String!]!
|
|
lang - String!
|
Example
Query
query DictionaryLookupBatch(
$words: [String!]!,
$lang: String!
) {
dictionaryLookupBatch(
words: $words,
lang: $lang
) {
word
lang
entries {
lexicalCategory
definitions {
...DefinitionEntryFragment
}
}
}
}
Variables
{
"words": ["xyz789"],
"lang": "xyz789"
}
Response
{
"data": {
"dictionaryLookupBatch": [
{
"word": "xyz789",
"lang": "xyz789",
"entries": [DictionaryResultEntry]
}
]
}
}
executeExportFileTransformer
Description
Simulates what an export file transformer will do to a document in a project, or to a project sample One of documentId or projectSampleId is required
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
}
}
exportActivities
Response
Returns an ExportRequestResult!
Arguments
| Name | Description |
|---|---|
input - ExportActivitiesInput!
|
Example
Query
query ExportActivities($input: ExportActivitiesInput!) {
exportActivities(input: $input) {
exportId
fileUrl
fileUrlExpiredAt
key
queued
redirect
}
}
Variables
{"input": ExportActivitiesInput}
Response
{
"data": {
"exportActivities": {
"exportId": 4,
"fileUrl": "abc123",
"fileUrlExpiredAt": "xyz789",
"key": "abc123",
"queued": false,
"redirect": "xyz789"
}
}
}
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
key
queued
redirect
}
}
Variables
{
"id": "4",
"input": AnalyticsDashboardQueryInput,
"method": "EMAIL"
}
Response
{
"data": {
"exportChart": {
"exportId": "4",
"fileUrl": "abc123",
"fileUrlExpiredAt": "xyz789",
"key": "abc123",
"queued": true,
"redirect": "xyz789"
}
}
}
exportCustomReport
Description
Exports custom report.
Response
Returns an ExportRequestResult!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
|
input - CustomReportBuilderInput!
|
|
debugMode - Boolean
|
Example
Query
query ExportCustomReport(
$teamId: ID!,
$input: CustomReportBuilderInput!,
$debugMode: Boolean
) {
exportCustomReport(
teamId: $teamId,
input: $input,
debugMode: $debugMode
) {
exportId
fileUrl
fileUrlExpiredAt
key
queued
redirect
}
}
Variables
{
"teamId": 4,
"input": CustomReportBuilderInput,
"debugMode": false
}
Response
{
"data": {
"exportCustomReport": {
"exportId": "4",
"fileUrl": "abc123",
"fileUrlExpiredAt": "abc123",
"key": "abc123",
"queued": false,
"redirect": "abc123"
}
}
}
exportLlmApplicationDeploymentLog
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns an ExportRequestResult!
Arguments
| Name | Description |
|---|---|
input - ExportLlmApplicationDeploymentLogInput!
|
Example
Query
query ExportLlmApplicationDeploymentLog($input: ExportLlmApplicationDeploymentLogInput!) {
exportLlmApplicationDeploymentLog(input: $input) {
exportId
fileUrl
fileUrlExpiredAt
key
queued
redirect
}
}
Variables
{"input": ExportLlmApplicationDeploymentLogInput}
Response
{
"data": {
"exportLlmApplicationDeploymentLog": {
"exportId": 4,
"fileUrl": "xyz789",
"fileUrlExpiredAt": "abc123",
"key": "xyz789",
"queued": true,
"redirect": "xyz789"
}
}
}
exportLlmApplicationPlaygroundRagConfig
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplicationPlaygroundRagConfigExport!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query ExportLlmApplicationPlaygroundRagConfig($id: ID!) {
exportLlmApplicationPlaygroundRagConfig(id: $id) {
schemaVersion
name
ragConfig {
systemInstruction
userInstruction
temperature
topP
maxTokens
advancedHyperparameters
maxVectorStoreTokens
similarityThreshold
enableAnonymization
maxChunkSize
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"exportLlmApplicationPlaygroundRagConfig": {
"schemaVersion": "xyz789",
"name": "xyz789",
"ragConfig": LlmApplicationPlaygroundRagConfigExportRagConfig
}
}
}
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
key
queued
redirect
}
}
Variables
{"input": ExportLlmEvaluationAutomatedInput}
Response
{
"data": {
"exportLlmEvaluationAutomated": {
"exportId": "4",
"fileUrl": "xyz789",
"fileUrlExpiredAt": "xyz789",
"key": "xyz789",
"queued": false,
"redirect": "xyz789"
}
}
}
exportLlmEvaluationManual
Breaking changes may be introduced anytime in the future without prior notice.
Description
Exports the LLM manual evaluation.
Response
Returns an ExportRequestResult!
Arguments
| Name | Description |
|---|---|
input - ExportLlmEvaluationManualInput!
|
Example
Query
query ExportLlmEvaluationManual($input: ExportLlmEvaluationManualInput!) {
exportLlmEvaluationManual(input: $input) {
exportId
fileUrl
fileUrlExpiredAt
key
queued
redirect
}
}
Variables
{"input": ExportLlmEvaluationManualInput}
Response
{
"data": {
"exportLlmEvaluationManual": {
"exportId": "4",
"fileUrl": "abc123",
"fileUrlExpiredAt": "xyz789",
"key": "abc123",
"queued": false,
"redirect": "xyz789"
}
}
}
exportTeamIAA
Please use exportTeamIAAV2 instead.
Description
Exports team IAA.
Response
Returns an ExportRequestResult!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
|
labelSetSignatures - [String!]
|
|
method - IAAMethodName
|
|
projectIds - [ID!]
|
Example
Query
query ExportTeamIAA(
$teamId: ID!,
$labelSetSignatures: [String!],
$method: IAAMethodName,
$projectIds: [ID!]
) {
exportTeamIAA(
teamId: $teamId,
labelSetSignatures: $labelSetSignatures,
method: $method,
projectIds: $projectIds
) {
exportId
fileUrl
fileUrlExpiredAt
key
queued
redirect
}
}
Variables
{
"teamId": "4",
"labelSetSignatures": ["xyz789"],
"method": "COHENS_KAPPA",
"projectIds": ["4"]
}
Response
{
"data": {
"exportTeamIAA": {
"exportId": "4",
"fileUrl": "xyz789",
"fileUrlExpiredAt": "xyz789",
"key": "xyz789",
"queued": false,
"redirect": "abc123"
}
}
}
exportTeamIAAV2
Description
Exports team IAA.
Response
Returns an ExportRequestResult!
Arguments
| Name | Description |
|---|---|
input - IAAInput!
|
Example
Query
query ExportTeamIAAV2($input: IAAInput!) {
exportTeamIAAV2(input: $input) {
exportId
fileUrl
fileUrlExpiredAt
key
queued
redirect
}
}
Variables
{"input": IAAInput}
Response
{
"data": {
"exportTeamIAAV2": {
"exportId": "4",
"fileUrl": "abc123",
"fileUrlExpiredAt": "abc123",
"key": "xyz789",
"queued": false,
"redirect": "xyz789"
}
}
}
exportTeamOverview
Description
Exports team overview.
Response
Returns an ExportRequestResult!
Arguments
| Name | Description |
|---|---|
input - ExportTeamOverviewInput!
|
Example
Query
query ExportTeamOverview($input: ExportTeamOverviewInput!) {
exportTeamOverview(input: $input) {
exportId
fileUrl
fileUrlExpiredAt
key
queued
redirect
}
}
Variables
{"input": ExportTeamOverviewInput}
Response
{
"data": {
"exportTeamOverview": {
"exportId": "4",
"fileUrl": "xyz789",
"fileUrlExpiredAt": "xyz789",
"key": "abc123",
"queued": false,
"redirect": "abc123"
}
}
}
exportTestProjectResult
Description
Exports test project result.
Response
Returns an ExportRequestResult!
Arguments
| Name | Description |
|---|---|
input - ExportTestProjectResultInput!
|
Example
Query
query ExportTestProjectResult($input: ExportTestProjectResultInput!) {
exportTestProjectResult(input: $input) {
exportId
fileUrl
fileUrlExpiredAt
key
queued
redirect
}
}
Variables
{"input": ExportTestProjectResultInput}
Response
{
"data": {
"exportTestProjectResult": {
"exportId": "4",
"fileUrl": "abc123",
"fileUrlExpiredAt": "xyz789",
"key": "xyz789",
"queued": false,
"redirect": "xyz789"
}
}
}
exportTextProject
Description
Exports all files in a project.
Response
Returns an ExportRequestResult!
Arguments
| Name | Description |
|---|---|
input - ExportTextProjectInput!
|
Example
Query
query ExportTextProject($input: ExportTextProjectInput!) {
exportTextProject(input: $input) {
exportId
fileUrl
fileUrlExpiredAt
key
queued
redirect
}
}
Variables
{"input": ExportTextProjectInput}
Response
{
"data": {
"exportTextProject": {
"exportId": 4,
"fileUrl": "xyz789",
"fileUrlExpiredAt": "xyz789",
"key": "abc123",
"queued": true,
"redirect": "abc123"
}
}
}
exportTextProjectDocument
Description
Exports a single document / file.
Response
Returns an ExportRequestResult!
Arguments
| Name | Description |
|---|---|
input - ExportTextProjectDocumentInput!
|
Example
Query
query ExportTextProjectDocument($input: ExportTextProjectDocumentInput!) {
exportTextProjectDocument(input: $input) {
exportId
fileUrl
fileUrlExpiredAt
key
queued
redirect
}
}
Variables
{"input": ExportTextProjectDocumentInput}
Response
{
"data": {
"exportTextProjectDocument": {
"exportId": 4,
"fileUrl": "abc123",
"fileUrlExpiredAt": "abc123",
"key": "xyz789",
"queued": true,
"redirect": "abc123"
}
}
}
findAllDomainClaimsInTeam
Response
Returns [DomainClaim!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query FindAllDomainClaimsInTeam($teamId: ID!) {
findAllDomainClaimsInTeam(teamId: $teamId) {
id
teamId
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
domain
verificationSecret
verificationDnsHost
status
encryptionVersion
createdAt
updatedAt
lastVerifyAttemptAt
verificationStartedAt
claimedAt
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"findAllDomainClaimsInTeam": [
{
"id": 4,
"teamId": "4",
"team": Team,
"domain": "abc123",
"verificationSecret": "abc123",
"verificationDnsHost": "xyz789",
"status": "UNCLAIMED",
"encryptionVersion": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"lastVerifyAttemptAt": "2007-12-03T10:15:30Z",
"verificationStartedAt": "2007-12-03T10:15:30Z",
"claimedAt": "2007-12-03T10:15:30Z"
}
]
}
}
generateFileUrls
Response
Returns [FileUrlInfo!]!
Arguments
| Name | Description |
|---|---|
input - GenerateFileUrlsInput!
|
Example
Query
query GenerateFileUrls($input: GenerateFileUrlsInput!) {
generateFileUrls(input: $input) {
uploadUrl
downloadUrl
fileName
}
}
Variables
{"input": GenerateFileUrlsInput}
Response
{
"data": {
"generateFileUrls": [
{
"uploadUrl": "abc123",
"downloadUrl": "xyz789",
"fileName": "abc123"
}
]
}
}
getActivities
Response
Returns a GetActivitiesResponse!
Arguments
| Name | Description |
|---|---|
input - GetActivitiesInput!
|
Example
Query
query GetActivities($input: GetActivitiesInput!) {
getActivities(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
event
visibility
teamId
userId
userDisplayName
createdAt
projectId
projectName
documentId
documentType
documentName
labelAddressHashCode
labelType
bulkId
additionalData {
...ActivityAdditionalDataFragment
}
}
}
}
Variables
{"input": GetActivitiesInput}
Response
{
"data": {
"getActivities": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [ActivityEvent]
}
}
}
getActivitiesSuggestion
Response
Returns a GetActivitiesSuggestionResponse!
Arguments
| Name | Description |
|---|---|
input - GetActivitiesSuggestionInput!
|
Example
Query
query GetActivitiesSuggestion($input: GetActivitiesSuggestionInput!) {
getActivitiesSuggestion(input: $input) {
suggestions {
displayName
id
groupId
}
}
}
Variables
{"input": GetActivitiesSuggestionInput}
Response
{
"data": {
"getActivitiesSuggestion": {
"suggestions": [ActivitySuggestion]
}
}
}
getAllExtensions
Response
Returns [ExtensionGroup!]!
Example
Query
query GetAllExtensions {
getAllExtensions {
kind
extensions {
id
title
url
elementType
elementKind
documentType
}
}
}
Response
{
"data": {
"getAllExtensions": [
{
"kind": "DOCUMENT_BASED",
"extensions": [Extension]
}
]
}
}
getAllTeams
Response
Returns [Team!]!
Example
Query
query GetAllTeams {
getAllTeams {
id
logoURL
members {
id
user {
...UserFragment
}
userId
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
labelingAgent {
...LabelingAgentFragment
}
labelingAgentId
}
membersScalar
name
setting {
activitySettings {
...TeamActivitySettingsFragment
}
additionalSetting {
...AdditionalTeamSettingFragment
}
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedASRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enabledCustomObjectStorage
enableActions
enableAddDocumentsToProject
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurDinamicTokenBased
enableDatasaurPredictiveRowBased
enableLabelingAgentSpanBased
enableLabelingAgentRowBased
enableLabelingAgentArrowBased
enableWipeData
enableExportTeamOverview
enableSelfAssignment
enableWebhookSelfService
enableOauthApplicationSelfService
enableTransferOwnership
enableLabelErrorDetectionRowBased
allowedExtraAutoLabelProviders
enableLLMProject
enableRegexSentenceSeparator
enableTeamRoleSupervisor
endExtensionTrialAt
allowInvalidPaymentMethod
enableExternalKnowledgeBase
enableForceAnonymization
enableReviewIndicator
enableValidationScript
enableSpanLabelingWithRowQuestions
llmFreeTrialDailyLimitsConfig {
...LlmFreeTrialDailyLimitsConfigFragment
}
enableScriptGeneratedQuestion
rowModification {
...RowModificationSettingFragment
}
enableDeployedApplicationLogging
enableRealTimeAssistedLabelingSpanBased
enableLabelsAndAnswersExportFormat
enableGoogleDriveExternalObjectStorage
enableMLAssistedOptimizationByDefault
}
owner {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
isExpired
expiredAt
}
}
Response
{
"data": {
"getAllTeams": [
{
"id": "4",
"logoURL": "xyz789",
"members": [TeamMember],
"membersScalar": TeamMembersScalar,
"name": "xyz789",
"setting": TeamSetting,
"owner": User,
"isExpired": 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
Returns a GetAnalyticsPerformanceResult!
Arguments
| Name | Description |
|---|---|
input - GetAnalyticsPerformanceInput!
|
Example
Query
query GetAnalyticsPerformance($input: GetAnalyticsPerformanceInput!) {
getAnalyticsPerformance(input: $input) {
documentStatus {
documentId
status
}
numberOfMissedLabels
numberOfAnsweredLines
activeDurationInMillis
projectStatisticsPerLabelType {
kind
labelEntityType
applied
conflicted
accepted
rejected
totalPrelabeled
acceptedPrelabeled
rejectedPrelabeled
}
}
}
Variables
{"input": GetAnalyticsPerformanceInput}
Response
{
"data": {
"getAnalyticsPerformance": {
"documentStatus": [DocumentStatus],
"numberOfMissedLabels": 987,
"numberOfAnsweredLines": 987,
"activeDurationInMillis": 123.45,
"projectStatisticsPerLabelType": [
ProjectStatisticPerLabelType
]
}
}
}
getAppSettingValue
getAudioLabelConflictContributorIds
Description
Resolves, for each of the given (or all) conflicting labels, which labelers contributed a candidate.
Response
Returns [ConflictContributorIds!]!
Example
Query
query GetAudioLabelConflictContributorIds(
$documentId: ID!,
$labelIds: [ID!]
) {
getAudioLabelConflictContributorIds(
documentId: $documentId,
labelIds: $labelIds
) {
labelHashCode
contributorIds
contributorInfos {
id
labelPhase
acceptedByUserId
rejectedByUserId
userId
teamMemberId
}
}
}
Variables
{"documentId": 4, "labelIds": ["4"]}
Response
{
"data": {
"getAudioLabelConflictContributorIds": [
{
"labelHashCode": "abc123",
"contributorIds": [987],
"contributorInfos": [ContributorInfo]
}
]
}
}
getAudioLabelConflictsPaginated
Description
Lists the review document's audio label conflicts, paginated, including already-resolved ones.
Response
Returns a GetAudioLabelConflictsPaginatedResponse!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
input - GetAudioLabelConflictsPaginatedInput!
|
Example
Query
query GetAudioLabelConflictsPaginated(
$documentId: ID!,
$input: GetAudioLabelConflictsPaginatedInput!
) {
getAudioLabelConflictsPaginated(
documentId: $documentId,
input: $input
) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
label {
...AudioLabelFragment
}
resolved
labelers {
...UserFragment
}
}
}
}
Variables
{
"documentId": 4,
"input": GetAudioLabelConflictsPaginatedInput
}
Response
{
"data": {
"getAudioLabelConflictsPaginated": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [AudioLabelConflict]
}
}
}
getAudioLabelRejectedLabels
Description
Lists labeler-submitted audio labels that were rejected during conflict resolution, paginated.
Response
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
input - GetAudioLabelRejectedLabelsPaginatedInput!
|
Example
Query
query GetAudioLabelRejectedLabels(
$documentId: ID!,
$input: GetAudioLabelRejectedLabelsPaginatedInput!
) {
getAudioLabelRejectedLabels(
documentId: $documentId,
input: $input
) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
label {
...AudioLabelFragment
}
resolved
labelers {
...UserFragment
}
}
}
}
Variables
{
"documentId": "4",
"input": GetAudioLabelRejectedLabelsPaginatedInput
}
Response
{
"data": {
"getAudioLabelRejectedLabels": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [AudioLabelConflict]
}
}
}
getAudioLabelsPaginated
Description
Lists the document's audio labels, paginated.
Response
Returns a GetAudioLabelsPaginatedResponse!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
input - GetAudioLabelsPaginatedInput!
|
Example
Query
query GetAudioLabelsPaginated(
$documentId: ID!,
$input: GetAudioLabelsPaginatedInput!
) {
getAudioLabelsPaginated(
documentId: $documentId,
input: $input
) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
hashCode
documentId
labelSetIndex
labelSetItemId
counter
startTimestampMillis
endTimestampMillis
customAttribute
labeledBy
labeledByUserId
status
type
}
}
}
Variables
{"documentId": 4, "input": GetAudioLabelsPaginatedInput}
Response
{
"data": {
"getAudioLabelsPaginated": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [AudioLabel]
}
}
}
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
}
providerRawResponse {
provider
completionChoices {
...ExtendedChatCompletionChoiceFragment
}
responseId
tokenPrices {
...TokenPricesFragment
}
}
}
}
Variables
{"input": AutoLabelTokenBasedInput}
Response
{
"data": {
"getAutoLabel": [
{
"label": "abc123",
"deleted": false,
"layer": 123,
"start": TextCursor,
"end": TextCursor,
"confidenceScore": 987.65,
"error": AutoLabelError,
"providerRawResponse": LLMLabsResponse
}
]
}
}
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
}
providerRawResponse {
provider
completionChoices {
...ExtendedChatCompletionChoiceFragment
}
responseId
tokenPrices {
...TokenPricesFragment
}
}
}
}
Variables
{"input": AutoLabelBBoxBasedInput}
Response
{
"data": {
"getAutoLabelBBoxBased": [
{
"id": "4",
"documentId": 4,
"bboxLabelClassId": "4",
"caption": "xyz789",
"shapes": [BBoxShape],
"confidenceScore": 123.45,
"error": AutoLabelError,
"providerRawResponse": LLMLabsResponse
}
]
}
}
getAutoLabelDocBased
Response
Returns an AutoLabelDocBasedOutput!
Arguments
| Name | Description |
|---|---|
input - AutoLabelDocBasedInput
|
Example
Query
query GetAutoLabelDocBased($input: AutoLabelDocBasedInput) {
getAutoLabelDocBased(input: $input) {
documentId
answers
providerRawResponse {
provider
completionChoices {
...ExtendedChatCompletionChoiceFragment
}
responseId
tokenPrices {
...TokenPricesFragment
}
}
}
}
Variables
{"input": AutoLabelDocBasedInput}
Response
{
"data": {
"getAutoLabelDocBased": {
"documentId": "4",
"answers": AnswerScalar,
"providerRawResponse": LLMLabsResponse
}
}
}
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
}
providerRawResponse {
provider
completionChoices {
...ExtendedChatCompletionChoiceFragment
}
responseId
tokenPrices {
...TokenPricesFragment
}
}
}
}
Variables
{"input": AutoLabelRowBasedInput}
Response
{
"data": {
"getAutoLabelRowBased": [
{
"id": 987,
"label": "abc123",
"error": AutoLabelError,
"providerRawResponse": LLMLabsResponse
}
]
}
}
getAvailableLlmVectorStoreFilePropertiesExtractors
Response
Example
Query
query GetAvailableLlmVectorStoreFilePropertiesExtractors {
getAvailableLlmVectorStoreFilePropertiesExtractors {
type
configurationSchema
}
}
Response
{
"data": {
"getAvailableLlmVectorStoreFilePropertiesExtractors": [
{
"type": "abc123",
"configurationSchema": LlmVectorStoreFilePropertiesExtractorConfigurationSchema
}
]
}
}
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": false
}
}
}
getBBoxArrowLabelsPaginated
Response
Returns a GetBBoxArrowLabelsPaginatedResponse!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
input - GetBBoxArrowLabelsPaginatedInput!
|
Example
Query
query GetBBoxArrowLabelsPaginated(
$documentId: ID!,
$input: GetBBoxArrowLabelsPaginatedInput!
) {
getBBoxArrowLabelsPaginated(
documentId: $documentId,
input: $input
) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
documentId
originBBoxLabelId
destinationBBoxLabelId
type
arrowLabelClassId
originShapeIndex
destinationShapeIndex
status
labeledBy
labeledByUserId
acceptedByUserId
rejectedByUserId
updatedAt
}
}
}
Variables
{
"documentId": 4,
"input": GetBBoxArrowLabelsPaginatedInput
}
Response
{
"data": {
"getBBoxArrowLabelsPaginated": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [BBoxArrowLabel]
}
}
}
getBBoxLabelConflictContributorIds
Response
Returns [ConflictContributorIds!]!
Example
Query
query GetBBoxLabelConflictContributorIds(
$documentId: ID!,
$labelHashCodes: [String!]
) {
getBBoxLabelConflictContributorIds(
documentId: $documentId,
labelHashCodes: $labelHashCodes
) {
labelHashCode
contributorIds
contributorInfos {
id
labelPhase
acceptedByUserId
rejectedByUserId
userId
teamMemberId
}
}
}
Variables
{
"documentId": 4,
"labelHashCodes": ["abc123"]
}
Response
{
"data": {
"getBBoxLabelConflictContributorIds": [
{
"labelHashCode": "xyz789",
"contributorIds": [123],
"contributorInfos": [ContributorInfo]
}
]
}
}
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
labeledBy
labeledByUserId
}
}
Variables
{"documentId": 4}
Response
{
"data": {
"getBBoxLabelsByDocument": [
{
"id": 4,
"documentId": "4",
"bboxLabelClassId": "4",
"deleted": false,
"caption": "abc123",
"shapes": [BBoxShape],
"answers": AnswerScalar,
"labeledBy": "PRELABELED",
"labeledByUserId": "4"
}
]
}
}
getBBoxLabelsPaginated
Response
Returns a GetBBoxLabelsPaginatedResponse!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
input - GetBBoxLabelsPaginatedInput!
|
Example
Query
query GetBBoxLabelsPaginated(
$documentId: ID!,
$input: GetBBoxLabelsPaginatedInput!
) {
getBBoxLabelsPaginated(
documentId: $documentId,
input: $input
) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
documentId
bboxLabelClassId
deleted
caption
shapes {
...BBoxShapeFragment
}
answers
labeledBy
labeledByUserId
}
}
}
Variables
{
"documentId": "4",
"input": GetBBoxLabelsPaginatedInput
}
Response
{
"data": {
"getBBoxLabelsPaginated": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [BBoxLabel]
}
}
}
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": false,
"items": [ConflictBoundingBoxLabel]
}
}
}
getBoundingBoxLabels
Response
Returns [BoundingBoxLabel!]!
Example
Query
query GetBoundingBoxLabels(
$documentId: ID!,
$startCellLine: Int,
$endCellLine: Int
) {
getBoundingBoxLabels(
documentId: $documentId,
startCellLine: $startCellLine,
endCellLine: $endCellLine
) {
id
documentId
coordinates {
x
y
}
counter
pageIndex
layer
position {
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
}
hashCode
type
labeledBy
}
}
Variables
{"documentId": 4, "startCellLine": 123, "endCellLine": 123}
Response
{
"data": {
"getBoundingBoxLabels": [
{
"id": "4",
"documentId": 4,
"coordinates": [Coordinate],
"counter": 123,
"pageIndex": 987,
"layer": 987,
"position": TextRange,
"hashCode": "xyz789",
"type": "AUDIO",
"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
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
}
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
}
anonymizationMaskedColumnNames
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
leafOnlyOption
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
kinds
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
type
description
imagePreviewURL
videoURL
}
}
Response
{
"data": {
"getBuiltInProjectTemplates": [
{
"id": 4,
"name": "abc123",
"logoURL": "xyz789",
"projectTemplateProjectSettingId": 4,
"projectTemplateTextDocumentSettingId": 4,
"projectTemplateProjectSetting": ProjectTemplateProjectSetting,
"projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
"labelSetTemplates": [LabelSetTemplate],
"questionSets": [QuestionSet],
"createdAt": "abc123",
"updatedAt": "xyz789",
"purpose": "LABELING",
"creatorId": 4,
"type": "CUSTOM",
"description": "abc123",
"imagePreviewURL": "xyz789",
"videoURL": "xyz789"
}
]
}
}
getCabinet
Description
Returns the specified project's cabinet. Contains list of documents. To get a project's ID, see getProjects.
Example
Query
query GetCabinet(
$projectId: ID!,
$role: Role!,
$visit: Boolean
) {
getCabinet(
projectId: $projectId,
role: $role,
visit: $visit
) {
id
documents
role
status
lastOpenedDocumentId
statistic {
id
numberOfTokens
numberOfLines
}
owner {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
createdAt
}
}
Variables
{
"projectId": "4",
"role": "REVIEWER",
"visit": false
}
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
completedByUserId
status
statusUpdatedByUserId
}
}
Variables
{"cabinetId": 4}
Response
{
"data": {
"getCabinetDocumentCompletionStates": [
{
"id": 4,
"isCompleted": true,
"completedByUserId": 4,
"status": "NOT_STARTED",
"statusUpdatedByUserId": "4"
}
]
}
}
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": "xyz789",
"lines": [123]
}
]
}
}
getCabinetLabelSetsById
Response
Returns [LabelSet!]!
Arguments
| Name | Description |
|---|---|
cabinetId - ID!
|
Example
Query
query GetCabinetLabelSetsById($cabinetId: ID!) {
getCabinetLabelSetsById(cabinetId: $cabinetId) {
id
name
index
signature
tagItems {
id
parentId
tagName
desc
color
type
arrowRules {
...LabelClassArrowRuleFragment
}
allowCustomAttribute
}
lastUsedBy {
projectId
name
}
arrowLabelRequired
leafOnlyOption
}
}
Variables
{"cabinetId": 4}
Response
{
"data": {
"getCabinetLabelSetsById": [
{
"id": 4,
"name": "abc123",
"index": 123,
"signature": "xyz789",
"tagItems": [TagItem],
"lastUsedBy": LastUsedProject,
"arrowLabelRequired": false,
"leafOnlyOption": true
}
]
}
}
getCellMetadataKeys
Response
Returns [String!]!
Example
Query
query GetCellMetadataKeys(
$documentId: ID!,
$signature: String
) {
getCellMetadataKeys(
documentId: $documentId,
signature: $signature
)
}
Variables
{"documentId": 4, "signature": "xyz789"}
Response
{
"data": {
"getCellMetadataKeys": ["abc123"]
}
}
getCellPositionsByMetadata
Description
Returns a paginated list of Cell positions along with its origin document ID.
Response
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
|
input - GetCellPositionsByMetadataPaginatedInput!
|
Example
Query
query GetCellPositionsByMetadata(
$projectId: ID!,
$input: GetCellPositionsByMetadataPaginatedInput!
) {
getCellPositionsByMetadata(
projectId: $projectId,
input: $input
) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
originDocumentId
line
index
}
}
}
Variables
{
"projectId": "4",
"input": GetCellPositionsByMetadataPaginatedInput
}
Response
{
"data": {
"getCellPositionsByMetadata": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [CellPositionWithOriginDocumentId]
}
}
}
getCells
Response
Returns a GetCellsPaginatedResponse!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
input - GetCellsPaginatedInput!
|
|
signature - String
|
|
textContent - TextContent
|
Example
Query
query GetCells(
$documentId: ID!,
$input: GetCellsPaginatedInput!,
$signature: String,
$textContent: TextContent
) {
getCells(
documentId: $documentId,
input: $input,
signature: $signature,
textContent: $textContent
) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes
}
}
Variables
{
"documentId": 4,
"input": GetCellsPaginatedInput,
"signature": "abc123",
"textContent": "CONTENT"
}
Response
{
"data": {
"getCells": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [CellScalar]
}
}
}
getCellsPaginatedByLine
Description
Fetch cells by document ID and line number range. This enables progressive/lazy loading of cells for large documents.
Response
Returns a GetCellsPaginatedResponse!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
input - GetCellsPaginatedByLineInput!
|
|
signature - String
|
|
textContent - TextContent
|
Example
Query
query GetCellsPaginatedByLine(
$documentId: ID!,
$input: GetCellsPaginatedByLineInput!,
$signature: String,
$textContent: TextContent
) {
getCellsPaginatedByLine(
documentId: $documentId,
input: $input,
signature: $signature,
textContent: $textContent
) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes
}
}
Variables
{
"documentId": "4",
"input": GetCellsPaginatedByLineInput,
"signature": "xyz789",
"textContent": "CONTENT"
}
Response
{
"data": {
"getCellsPaginatedByLine": {
"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": "xyz789",
"values": [ChartDataRowValue],
"keyPayloadType": "USER",
"keyPayload": KeyPayload
}
]
}
}
getCharts
Response
Returns [Chart!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
|
level - ChartLevel!
|
|
set - ChartSet!
|
Example
Query
query GetCharts(
$teamId: ID!,
$level: ChartLevel!,
$set: ChartSet!
) {
getCharts(
teamId: $teamId,
level: $level,
set: $set
) {
id
name
description
type
level
set
dataTableHeaders
visualizationParams {
visualization
vAxisTitle
hAxisTitle
pieHoleText
chartArea {
...ChartAreaFragment
}
legend {
...LegendFragment
}
colorGradient {
...ColorGradientFragment
}
isStacked
itemsPerPage
colors
abbreviateKey
showTable
unit
}
}
}
Variables
{
"teamId": "4",
"level": "TEAM",
"set": "OLD"
}
Response
{
"data": {
"getCharts": [
{
"id": 4,
"name": "xyz789",
"description": "xyz789",
"type": "GROUPED",
"level": "TEAM",
"set": ["OLD"],
"dataTableHeaders": ["abc123"],
"visualizationParams": VisualizationParams
}
]
}
}
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": "xyz789"
}
}
getClearCustomAttributeJobs
Example
Query
query GetClearCustomAttributeJobs($projectId: ID!) {
getClearCustomAttributeJobs(projectId: $projectId) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"projectId": "4"}
Response
{
"data": {
"getClearCustomAttributeJobs": [
{
"id": "abc123",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "abc123",
"retryCount": 987,
"maxRetry": 123,
"additionalData": JobAdditionalData
}
]
}
}
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
name
effectiveName
credentials {
...ExternalObjectStorageCredentialsFragment
}
securityToken
team {
...TeamFragment
}
projects {
...ProjectFragment
}
readOnly
createdAt
updatedAt
}
externalObjectStorageIdOutput
externalObjectStorageOutput {
id
cloudService
bucketId
bucketName
name
effectiveName
credentials {
...ExternalObjectStorageCredentialsFragment
}
securityToken
team {
...TeamFragment
}
projects {
...ProjectFragment
}
readOnly
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
immutableInput
ingestMode
skipDeduplication
}
}
Variables
{"teamId": "4", "actionId": 4}
Response
{
"data": {
"getCreateProjectAction": {
"id": 4,
"name": "abc123",
"teamId": "4",
"appVersion": "xyz789",
"creatorId": "4",
"lastRunAt": "abc123",
"lastFinishedAt": "xyz789",
"externalObjectStorageId": "4",
"externalObjectStorage": ExternalObjectStorage,
"externalObjectStorageIdOutput": "4",
"externalObjectStorageOutput": ExternalObjectStorage,
"externalObjectStoragePathInput": "xyz789",
"externalObjectStoragePathResult": "abc123",
"projectTemplateId": 4,
"projectTemplate": ProjectTemplate,
"assignments": [CreateProjectActionAssignment],
"additionalTagNames": ["xyz789"],
"numberOfLabelersPerProject": 123,
"numberOfReviewersPerProject": 123,
"numberOfLabelersPerDocument": 123,
"conflictResolutionMode": "MANUAL",
"consensus": 123,
"warnings": ["ASSIGNED_LABELER_NOT_MEET_CONSENSUS"],
"immutableInput": true,
"ingestMode": "PRESIGNED",
"skipDeduplication": true
}
}
}
getCreateProjectActionRun
Description
Get a single create project Action run by id. Parameters: teamId: ID of the team (used for permission scoping) runId: ID of the run
Response
Returns a CreateProjectActionRun!
Example
Query
query GetCreateProjectActionRun(
$teamId: ID!,
$runId: ID!
) {
getCreateProjectActionRun(
teamId: $teamId,
runId: $runId
) {
id
actionId
status
currentAppVersion
triggeredByUserId
triggeredBy {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
startAt
endAt
totalSuccess
totalWarnings
totalFailure
error {
code
message
args
}
notice {
code
message
args
}
externalObjectStorageId
externalObjectStorageIdOutput
externalObjectStoragePathInput
externalObjectStoragePathResult
projectTemplate
assignments
numberOfLabelersPerProject
numberOfReviewersPerProject
numberOfLabelersPerDocument
conflictResolutionMode
consensus
}
}
Variables
{"teamId": "4", "runId": 4}
Response
{
"data": {
"getCreateProjectActionRun": {
"id": 4,
"actionId": "4",
"status": "DELIVERED",
"currentAppVersion": "abc123",
"triggeredByUserId": 4,
"triggeredBy": User,
"startAt": "abc123",
"endAt": "xyz789",
"totalSuccess": 987,
"totalWarnings": 123,
"totalFailure": 123,
"error": DatasaurError,
"notice": DatasaurError,
"externalObjectStorageId": "xyz789",
"externalObjectStorageIdOutput": "xyz789",
"externalObjectStoragePathInput": "abc123",
"externalObjectStoragePathResult": "abc123",
"projectTemplate": Snapshot,
"assignments": [Snapshot],
"numberOfLabelersPerProject": 987,
"numberOfReviewersPerProject": 987,
"numberOfLabelersPerDocument": 123,
"conflictResolutionMode": "MANUAL",
"consensus": 123
}
}
}
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
totalWarnings
totalFailure
error {
...DatasaurErrorFragment
}
notice {
...DatasaurErrorFragment
}
externalObjectStorageId
externalObjectStorageIdOutput
externalObjectStoragePathInput
externalObjectStoragePathResult
projectTemplate
assignments
numberOfLabelersPerProject
numberOfReviewersPerProject
numberOfLabelersPerDocument
conflictResolutionMode
consensus
}
}
}
Variables
{"input": CreateProjectActionPaginationInput}
Response
{
"data": {
"getCreateProjectActionRuns": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [CreateProjectActionRun]
}
}
}
getCreateProjectActions
Description
Get all create project Actions 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
name
effectiveName
credentials {
...ExternalObjectStorageCredentialsFragment
}
securityToken
team {
...TeamFragment
}
projects {
...ProjectFragment
}
readOnly
createdAt
updatedAt
}
externalObjectStorageIdOutput
externalObjectStorageOutput {
id
cloudService
bucketId
bucketName
name
effectiveName
credentials {
...ExternalObjectStorageCredentialsFragment
}
securityToken
team {
...TeamFragment
}
projects {
...ProjectFragment
}
readOnly
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
immutableInput
ingestMode
skipDeduplication
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getCreateProjectActions": [
{
"id": 4,
"name": "xyz789",
"teamId": 4,
"appVersion": "xyz789",
"creatorId": 4,
"lastRunAt": "abc123",
"lastFinishedAt": "xyz789",
"externalObjectStorageId": "4",
"externalObjectStorage": ExternalObjectStorage,
"externalObjectStorageIdOutput": "4",
"externalObjectStorageOutput": ExternalObjectStorage,
"externalObjectStoragePathInput": "abc123",
"externalObjectStoragePathResult": "abc123",
"projectTemplateId": 4,
"projectTemplate": ProjectTemplate,
"assignments": [CreateProjectActionAssignment],
"additionalTagNames": ["xyz789"],
"numberOfLabelersPerProject": 123,
"numberOfReviewersPerProject": 123,
"numberOfLabelersPerDocument": 123,
"conflictResolutionMode": "MANUAL",
"consensus": 987,
"warnings": ["ASSIGNED_LABELER_NOT_MEET_CONSENSUS"],
"immutableInput": true,
"ingestMode": "PRESIGNED",
"skipDeduplication": true
}
]
}
}
getCurrentUserTeamMember
Response
Returns a TeamMember!
Arguments
| Name | Description |
|---|---|
input - GetCurrentUserTeamMemberInput!
|
Example
Query
query GetCurrentUserTeamMember($input: GetCurrentUserTeamMemberInput!) {
getCurrentUserTeamMember(input: $input) {
id
user {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
userId
role {
id
name
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
id
userId
projectStatistic {
...TeamMemberProjectStatisticFragment
}
totalTimeSpent
effectiveTotalTimeSpent
accuracy
}
labelingAgent {
id
agentId
agentType
name
}
labelingAgentId
}
}
Variables
{"input": GetCurrentUserTeamMemberInput}
Response
{
"data": {
"getCurrentUserTeamMember": {
"id": 4,
"user": User,
"userId": "4",
"role": TeamRole,
"invitationEmail": "abc123",
"invitationStatus": "abc123",
"invitationKey": "abc123",
"isDeleted": true,
"joinedDate": "abc123",
"performance": TeamMemberPerformance,
"labelingAgent": LabelingAgent,
"labelingAgentId": 4
}
}
}
getCustomAPI
Response
Returns a CustomAPI!
Arguments
| Name | Description |
|---|---|
customAPIId - ID!
|
Example
Query
query GetCustomAPI($customAPIId: ID!) {
getCustomAPI(customAPIId: $customAPIId) {
id
teamId
endpointURL
name
purpose
}
}
Variables
{"customAPIId": "4"}
Response
{
"data": {
"getCustomAPI": {
"id": 4,
"teamId": 4,
"endpointURL": "xyz789",
"name": "abc123",
"purpose": "ASR_API"
}
}
}
getCustomAPIs
Response
Returns [CustomAPI!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
|
purpose - CustomAPIPurpose
|
Example
Query
query GetCustomAPIs(
$teamId: ID!,
$purpose: CustomAPIPurpose
) {
getCustomAPIs(
teamId: $teamId,
purpose: $purpose
) {
id
teamId
endpointURL
name
purpose
}
}
Variables
{"teamId": "4", "purpose": "ASR_API"}
Response
{
"data": {
"getCustomAPIs": [
{
"id": "4",
"teamId": "4",
"endpointURL": "abc123",
"name": "abc123",
"purpose": "ASR_API"
}
]
}
}
getCustomEmbeddingModelDefaultData
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a CustomEmbeddingModelDefaultData!
Arguments
| Name | Description |
|---|---|
input - GetCustomEmbeddingDefaultDataInput!
|
Example
Query
query GetCustomEmbeddingModelDefaultData($input: GetCustomEmbeddingDefaultDataInput!) {
getCustomEmbeddingModelDefaultData(input: $input) {
name
dimension
}
}
Variables
{"input": GetCustomEmbeddingDefaultDataInput}
Response
{
"data": {
"getCustomEmbeddingModelDefaultData": {
"name": "abc123",
"dimension": 987
}
}
}
getCustomModelDefaultData
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a CustomModelDefaultData!
Arguments
| Name | Description |
|---|---|
input - GetCustomModelDefaultDataInput!
|
Example
Query
query GetCustomModelDefaultData($input: GetCustomModelDefaultDataInput!) {
getCustomModelDefaultData(input: $input) {
name
maxContextWindow
maxTokens
maxTemperature
maxTopP
}
}
Variables
{"input": GetCustomModelDefaultDataInput}
Response
{
"data": {
"getCustomModelDefaultData": {
"name": "xyz789",
"maxContextWindow": 987,
"maxTokens": 987,
"maxTemperature": 987.65,
"maxTopP": 987.65
}
}
}
getCustomReportFilterFieldSuggestions
Response
Returns a CustomReportSuggestions!
Arguments
| Name | Description |
|---|---|
input - CustomReportFilterFieldSuggestionsInput!
|
Example
Query
query GetCustomReportFilterFieldSuggestions($input: CustomReportFilterFieldSuggestionsInput!) {
getCustomReportFilterFieldSuggestions(input: $input) {
column
suggestions {
id
label
groupId
}
}
}
Variables
{"input": CustomReportFilterFieldSuggestionsInput}
Response
{
"data": {
"getCustomReportFilterFieldSuggestions": {
"column": "DATE",
"suggestions": [CustomReportSuggestion]
}
}
}
getCustomReportFilterSuggestions
Response
Returns [CustomReportSuggestions!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetCustomReportFilterSuggestions($teamId: ID!) {
getCustomReportFilterSuggestions(teamId: $teamId) {
column
suggestions {
id
label
groupId
}
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getCustomReportFilterSuggestions": [
{
"column": "DATE",
"suggestions": [CustomReportSuggestion]
}
]
}
}
getCustomReportMetricsGroupTables
Description
Returns custom report metrics group tables.
Response
Arguments
| Name | Description |
|---|---|
dataSet - CustomReportDataSet
|
|
debugMode - Boolean
|
Example
Query
query GetCustomReportMetricsGroupTables(
$dataSet: CustomReportDataSet,
$debugMode: Boolean
) {
getCustomReportMetricsGroupTables(
dataSet: $dataSet,
debugMode: $debugMode
) {
id
name
description
clientSegments
metrics
filterStrategies
hiddenFilters
}
}
Variables
{"dataSet": "METABASE", "debugMode": false}
Response
{
"data": {
"getCustomReportMetricsGroupTables": [
{
"id": 4,
"name": "abc123",
"description": "xyz789",
"clientSegments": ["DATE"],
"metrics": ["LABELS_ACCURACY"],
"filterStrategies": ["CONTAINS"],
"hiddenFilters": ["DATE"]
}
]
}
}
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]
}
}
}
getCustomReportPreviewFromExport
Response
Returns a CustomReportPreviewResponse!
Arguments
| Name | Description |
|---|---|
input - CustomReportPreviewInput!
|
Example
Query
query GetCustomReportPreviewFromExport($input: CustomReportPreviewInput!) {
getCustomReportPreviewFromExport(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes
}
}
Variables
{"input": CustomReportPreviewInput}
Response
{
"data": {
"getCustomReportPreviewFromExport": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [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": "xyz789",
"labels": [DataProgrammingLabel],
"createdAt": "xyz789",
"updatedAt": "xyz789",
"lastGetPredictionsAt": "abc123"
}
}
}
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": 123.45,
"coverage": 987.65,
"overlap": 123.45,
"polarity": [123]
}
]
}
}
getDataProgrammingLibraries
Response
Returns a DataProgrammingLibraries!
Example
Query
query GetDataProgrammingLibraries {
getDataProgrammingLibraries {
libraries
}
}
Response
{
"data": {
"getDataProgrammingLibraries": {
"libraries": ["xyz789"]
}
}
}
getDataProgrammingPredictions
Response
Returns a Job!
Arguments
| Name | Description |
|---|---|
input - GetDataProgrammingPredictionsInput!
|
Example
Query
query GetDataProgrammingPredictions($input: GetDataProgrammingPredictionsInput!) {
getDataProgrammingPredictions(input: $input) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"input": GetDataProgrammingPredictionsInput}
Response
{
"data": {
"getDataProgrammingPredictions": {
"id": "xyz789",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "xyz789",
"retryCount": 123,
"maxRetry": 987,
"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": [987],
"questionColumnId": 123,
"providerSetting": ProviderSetting,
"modelMetadata": ModelMetadata,
"trainingJobId": "4",
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
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": 123,
"providerSetting": ProviderSetting,
"modelMetadata": ModelMetadata,
"trainingJobId": "4",
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
getDatasaurDinamicTokenBasedProviders
Response
Example
Query
query GetDatasaurDinamicTokenBasedProviders {
getDatasaurDinamicTokenBasedProviders {
name
provider
}
}
Response
{
"data": {
"getDatasaurDinamicTokenBasedProviders": [
{
"name": "xyz789",
"provider": "HUGGINGFACE"
}
]
}
}
getDatasaurPredictive
Response
Returns a DatasaurPredictive
Arguments
| Name | Description |
|---|---|
input - GetDatasaurPredictiveInput!
|
Example
Query
query GetDatasaurPredictive($input: GetDatasaurPredictiveInput!) {
getDatasaurPredictive(input: $input) {
id
projectId
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]
}
]
}
}
getDocumentAnonymizedSpansByLine
Breaking changes may be introduced anytime in the future without prior notice.
Response
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
input - GetDocumentAnonymizedSpansByLineInput!
|
Example
Query
query GetDocumentAnonymizedSpansByLine(
$documentId: ID!,
$input: GetDocumentAnonymizedSpansByLineInput!
) {
getDocumentAnonymizedSpansByLine(
documentId: $documentId,
input: $input
) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
line
type
startTokenIndex
endTokenIndex
}
}
}
Variables
{
"documentId": "4",
"input": GetDocumentAnonymizedSpansByLineInput
}
Response
{
"data": {
"getDocumentAnonymizedSpansByLine": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [AnonymizedSpan]
}
}
}
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
}
contributorInfos {
...ContributorInfoFragment
}
labelPhase
acceptedByUserId
rejectedByUserId
}
type
}
}
Variables
{"documentId": 4}
Response
{
"data": {
"getDocumentAnswerConflicts": [
{
"questionId": "4",
"parentQuestionId": 4,
"nestedAnswerIndex": 123,
"answers": [ConflictAnswerValue],
"type": "MULTIPLE"
}
]
}
}
getDocumentAnswers
Response
Returns a DocumentAnswer!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
Example
Query
query GetDocumentAnswers($documentId: ID!) {
getDocumentAnswers(documentId: $documentId) {
documentId
answers
metadata {
path
labeledBy
labeledByUserId
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": "abc123",
"width": "abc123",
"displayed": false,
"labelerRestricted": false,
"rowQuestionIndex": 123
}
]
}
}
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": ["abc123"]}}
getDocumentPredictedAnswers
Response
Returns a DocumentAnswer!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
Example
Query
query GetDocumentPredictedAnswers($documentId: ID!) {
getDocumentPredictedAnswers(documentId: $documentId) {
documentId
answers
metadata {
path
labeledBy
labeledByUserId
createdAt
updatedAt
}
updatedAt
}
}
Variables
{"documentId": 4}
Response
{
"data": {
"getDocumentPredictedAnswers": {
"documentId": 4,
"answers": AnswerScalar,
"metadata": [AnswerMetadata],
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
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
customScript {
...CustomScriptFragment
}
}
bindToColumn
activationConditionLogic
targetEntity
}
}
Variables
{"projectId": 4}
Response
{
"data": {
"getDocumentQuestions": [
{
"id": 987,
"internalId": "abc123",
"type": "DROPDOWN",
"name": "xyz789",
"label": "xyz789",
"required": false,
"config": QuestionConfig,
"bindToColumn": "xyz789",
"activationConditionLogic": "abc123",
"targetEntity": "abc123"
}
]
}
}
getDocumentSignature
getDocumentsDeletionPreview
Response
Returns [DocumentDeletionPreviewItem!]!
Example
Query
query GetDocumentsDeletionPreview(
$projectId: ID!,
$documentIds: [ID!]!
) {
getDocumentsDeletionPreview(
projectId: $projectId,
documentIds: $documentIds
) {
documentId
fileName
analytics {
projectKind
totalAppliedByLabelers
totalAcceptedByReviewers
}
}
}
Variables
{
"projectId": "4",
"documentIds": ["4"]
}
Response
{
"data": {
"getDocumentsDeletionPreview": [
{
"documentId": "4",
"fileName": "abc123",
"analytics": [DocumentDeletionAnalytic]
}
]
}
}
getEditSentenceConflicts
Response
Returns an EditSentenceConflict!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
Example
Query
query GetEditSentenceConflicts($documentId: ID!) {
getEditSentenceConflicts(documentId: $documentId) {
documentId
fileName
lines
}
}
Variables
{"documentId": "4"}
Response
{
"data": {
"getEditSentenceConflicts": {
"documentId": "xyz789",
"fileName": "xyz789",
"lines": [123]
}
}
}
getEvaluationMetric
Response
Returns [ProjectEvaluationMetric!]!
Arguments
| Name | Description |
|---|---|
input - GetEvaluationMetricInput!
|
Example
Query
query GetEvaluationMetric($input: GetEvaluationMetricInput!) {
getEvaluationMetric(input: $input) {
projectKind
metric {
accuracy
precision
recall
f1Score
lastUpdatedTime
}
}
}
Variables
{"input": GetEvaluationMetricInput}
Response
{
"data": {
"getEvaluationMetric": [
{
"projectKind": "DOCUMENT_BASED",
"metric": EvaluationMetric
}
]
}
}
getEvaluationRagConfigsByTeamId
Description
Retrieves the LLM evaluation RAG configs by the team id.
Response
Returns [LlmEvaluationRagConfig!]!
Example
Query
query GetEvaluationRagConfigsByTeamId(
$teamId: ID!,
$withDeleted: Boolean
) {
getEvaluationRagConfigsByTeamId(
teamId: $teamId,
withDeleted: $withDeleted
) {
id
llmEvaluationId
llmApplication {
id
teamId
createdByUser {
...UserFragment
}
name
status
createdAt
updatedAt
llmApplicationDeployment {
...LlmApplicationDeploymentFragment
}
totalRagConfigs
}
llmPlaygroundRagConfig {
id
llmApplicationId
llmRagConfig {
...LlmRagConfigFragment
}
name
createdAt
updatedAt
}
llmDeploymentRagConfig {
id
deployedByUser {
...UserFragment
}
llmApplicationId
llmApplication {
...LlmApplicationFragment
}
llmRagConfig {
...LlmRagConfigFragment
}
numberOfCalls
numberOfTokens
numberOfInputTokens
numberOfOutputTokens
deployedAt
name
status
createdAt
updatedAt
apiEndpoints {
...LlmApplicationDeploymentApiEndpointFragment
}
isDeleted
}
llmRagConfigId
llmSnapshotRagConfig {
id
llmModel {
...LlmModelFragment
}
systemInstruction
userInstruction
raw
temperature
topP
maxTokens
advancedHyperparameters
maxVectorStoreTokens
llmVectorStore {
...LlmVectorStoreFragment
}
llmVectorStores {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
maxChunkSize
createdAt
updatedAt
}
llmApplicationConfigurationRagConfig {
id
name
teamId
createdByUserId
updatedByUserId
updatedByUser {
...UserFragment
}
llmRagConfigId
llmRagConfig {
...LlmRagConfigFragment
}
createdAt
updatedAt
isDeleted
}
llmEvaluationExecutionId
ragConfigSourceType
createdAt
updatedAt
isDeleted
applicationName
}
}
Variables
{"teamId": 4, "withDeleted": false}
Response
{
"data": {
"getEvaluationRagConfigsByTeamId": [
{
"id": 4,
"llmEvaluationId": "4",
"llmApplication": LlmApplication,
"llmPlaygroundRagConfig": LlmApplicationPlaygroundRagConfig,
"llmDeploymentRagConfig": LlmApplicationDeployment,
"llmRagConfigId": "4",
"llmSnapshotRagConfig": LlmRagConfig,
"llmApplicationConfigurationRagConfig": LlmApplicationConfiguration,
"llmEvaluationExecutionId": "4",
"ragConfigSourceType": "APPLICATION_DEPLOYMENT",
"createdAt": "abc123",
"updatedAt": "abc123",
"isDeleted": true,
"applicationName": "xyz789"
}
]
}
}
getExportDeliveryStatus
Description
Return the export job information, specifically whether it succeed or failed, since all exports are done asynchronously.
Response
Returns a GetExportDeliveryStatusResult!
Arguments
| Name | Description |
|---|---|
exportId - ID!
|
Example
Query
query GetExportDeliveryStatus($exportId: ID!) {
getExportDeliveryStatus(exportId: $exportId) {
deliveryStatus
errors {
id
stack
args
message
}
}
}
Variables
{"exportId": 4}
Response
{
"data": {
"getExportDeliveryStatus": {
"deliveryStatus": "DELIVERED",
"errors": [JobError]
}
}
}
getExportable
Response
Returns an ExportableJSON!
Arguments
| Name | Description |
|---|---|
documentId - ID
|
Example
Query
query GetExportable($documentId: ID) {
getExportable(documentId: $documentId)
}
Variables
{"documentId": 4}
Response
{"data": {"getExportable": ExportableJSON}}
getExtensions
Response
Returns [Extension!]
Arguments
| Name | Description |
|---|---|
cabinetId - String!
|
Example
Query
query GetExtensions($cabinetId: String!) {
getExtensions(cabinetId: $cabinetId) {
id
title
url
elementType
elementKind
documentType
}
}
Variables
{"cabinetId": "xyz789"}
Response
{
"data": {
"getExtensions": [
{
"id": "abc123",
"title": "xyz789",
"url": "xyz789",
"elementType": "abc123",
"elementKind": "xyz789",
"documentType": "abc123"
}
]
}
}
getExternalFilesByApi
Unused query for older creation flows.
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": "xyz789",
"timeLimit": 987
}
}
}
getExternalObjectMeta
Response
Returns [ObjectMeta!]!
Arguments
| Name | Description |
|---|---|
externalObjectStorageId - ID!
|
|
objectKeys - [String!]!
|
Example
Query
query GetExternalObjectMeta(
$externalObjectStorageId: ID!,
$objectKeys: [String!]!
) {
getExternalObjectMeta(
externalObjectStorageId: $externalObjectStorageId,
objectKeys: $objectKeys
) {
createdAt
key
sizeInBytes
}
}
Variables
{
"externalObjectStorageId": "4",
"objectKeys": ["xyz789"]
}
Response
{
"data": {
"getExternalObjectMeta": [
{
"createdAt": "xyz789",
"key": "xyz789",
"sizeInBytes": 123
}
]
}
}
getExternalObjectStorages
Response
Returns [ExternalObjectStorage!]
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetExternalObjectStorages($teamId: ID!) {
getExternalObjectStorages(teamId: $teamId) {
id
cloudService
bucketId
bucketName
name
effectiveName
credentials {
roleArn
externalId
serviceAccount
tenantId
storageContainerUrl
region
tenantUsername
}
securityToken
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
projects {
id
team {
...TeamFragment
}
teamId
owner {
...UserFragment
}
externalObjectStorageId
rootDocumentId
assignees {
...ProjectAssignmentFragment
}
name
tags {
...TagFragment
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
...ProjectSettingsFragment
}
workspaceSettings {
...WorkspaceSettingsFragment
}
reviewingStatus {
...ReviewingStatusFragment
}
labelingStatus {
...LabelingStatusFragment
}
status
performance {
...ProjectPerformanceFragment
}
selfLabelingStatus
purpose
rootCabinet {
...CabinetFragment
}
reviewCabinet {
...CabinetFragment
}
labelerCabinets {
...CabinetFragment
}
guideline {
...GuidelineFragment
}
isArchived
projectMetadataItems {
...ProjectMetadataItemFragment
}
availableDocumentsCount
}
readOnly
createdAt
updatedAt
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getExternalObjectStorages": [
{
"id": "4",
"cloudService": "AWS_S3",
"bucketId": "abc123",
"bucketName": "abc123",
"name": "xyz789",
"effectiveName": "abc123",
"credentials": ExternalObjectStorageCredentials,
"securityToken": "abc123",
"team": Team,
"projects": [Project],
"readOnly": false,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
getFileTransformer
Response
Returns a FileTransformer!
Arguments
| Name | Description |
|---|---|
fileTransformerId - ID!
|
Example
Query
query GetFileTransformer($fileTransformerId: ID!) {
getFileTransformer(fileTransformerId: $fileTransformerId) {
id
name
content
transpiled
createdAt
updatedAt
language
purpose
readonly
externalId
warmup
}
}
Variables
{"fileTransformerId": 4}
Response
{
"data": {
"getFileTransformer": {
"id": 4,
"name": "abc123",
"content": "abc123",
"transpiled": "xyz789",
"createdAt": "abc123",
"updatedAt": "abc123",
"language": "TYPESCRIPT",
"purpose": "IMPORT",
"readonly": false,
"externalId": "xyz789",
"warmup": false
}
}
}
getFileTransformers
Response
Returns [FileTransformer!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
|
purpose - FileTransformerPurpose
|
Example
Query
query GetFileTransformers(
$teamId: ID!,
$purpose: FileTransformerPurpose
) {
getFileTransformers(
teamId: $teamId,
purpose: $purpose
) {
id
name
content
transpiled
createdAt
updatedAt
language
purpose
readonly
externalId
warmup
}
}
Variables
{"teamId": 4, "purpose": "IMPORT"}
Response
{
"data": {
"getFileTransformers": [
{
"id": "4",
"name": "abc123",
"content": "abc123",
"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
teamId
provider
name
displayName
url
region
maxTemperature
maxTopP
maxTokens
maxContextWindow
defaultTemperature
defaultTopP
defaultMaxTokens
minTemperature
minTopP
llmModelFineTuningJob {
id
name
teamId
status
errorMessage
baseModelId
parentId
resultModelId
trainingJobId
trainingDataset {
...GroundTruthSetFragment
}
trainingDatasetFilename
validationSize
validationDataset {
...GroundTruthSetFragment
}
validationDatasetFilename
epochs
learningRate
batchSize
earlyStoppingThreshold
earlyStoppingPatience
learningRateWarmUpStep
learningRateMultiplier
instanceType
trainingVolumeSize
trainingBucketName
optionalHyperparameters
createdByUser {
...UserFragment
}
createdAt
updatedAt
}
deployableModelId
isModelDeployable
forceAnonymization
hasVisionCapability
variant
createdAt
updatedAt
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getFineTunedLlmModels": [
{
"id": "4",
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "xyz789",
"displayName": "xyz789",
"url": "abc123",
"region": ["abc123"],
"maxTemperature": 987.65,
"maxTopP": 123.45,
"maxTokens": 123,
"maxContextWindow": 123,
"defaultTemperature": 987.65,
"defaultTopP": 987.65,
"defaultMaxTokens": 987,
"minTemperature": 987.65,
"minTopP": 123.45,
"llmModelFineTuningJob": LlmModelFineTuningJob,
"deployableModelId": "abc123",
"isModelDeployable": false,
"forceAnonymization": true,
"hasVisionCapability": true,
"variant": "META",
"createdAt": "abc123",
"updatedAt": "abc123"
}
]
}
}
getFineTunedModelResultUrl
Breaking changes may be introduced anytime in the future without prior notice.
Description
Get the URL of the fine-tuned model result
getFineTuningBaseCost
Breaking changes may be introduced anytime in the future without prior notice.
Description
Get fine tuning training cost
Response
Returns [LlmPricingModel!]!
Arguments
| Name | Description |
|---|---|
input - LlmFineTuningBaseCostInput!
|
Example
Query
query GetFineTuningBaseCost($input: LlmFineTuningBaseCostInput!) {
getFineTuningBaseCost(input: $input) {
unitPrice
unitType
unitPurpose
}
}
Variables
{"input": LlmFineTuningBaseCostInput}
Response
{
"data": {
"getFineTuningBaseCost": [
{"unitPrice": 987.65, "unitType": "HOUR", "unitPurpose": "DEPLOY"}
]
}
}
getFineTuningEstimatedDuration
Breaking changes may be introduced anytime in the future without prior notice.
Description
Get estimated remaining duration of the fine tuning job in seconds
getFineTuningPerformanceMetrics
Breaking changes may be introduced anytime in the future without prior notice.
Description
Get fine tuning performance metrics
Response
Returns a FineTuningPerformanceMetrics!
Arguments
| Name | Description |
|---|---|
llmModelId - ID!
|
Example
Query
query GetFineTuningPerformanceMetrics($llmModelId: ID!) {
getFineTuningPerformanceMetrics(llmModelId: $llmModelId) {
fineTunedJobId
loggingStrategy {
type
loggingSteps
}
trainingMetrics {
sequence
loss
accuracy
}
evaluationMetrics {
sequence
loss
accuracy
}
}
}
Variables
{"llmModelId": 4}
Response
{
"data": {
"getFineTuningPerformanceMetrics": {
"fineTunedJobId": 4,
"loggingStrategy": LoggingStrategy,
"trainingMetrics": [PerformanceMetric],
"evaluationMetrics": [PerformanceMetric]
}
}
}
getFineTuningResourceMetrics
Breaking changes may be introduced anytime in the future without prior notice.
Description
Get fine tuning resource metrics
Response
Returns a FineTuningResourceMetric!
Arguments
| Name | Description |
|---|---|
llmModelId - ID!
|
Example
Query
query GetFineTuningResourceMetrics($llmModelId: ID!) {
getFineTuningResourceMetrics(llmModelId: $llmModelId) {
fineTunedJobId
resourceMetrics {
timestamp
hostName
gpuUtilization
memoryUtilization
cpuUtilization
}
}
}
Variables
{"llmModelId": "4"}
Response
{
"data": {
"getFineTuningResourceMetrics": {
"fineTunedJobId": "4",
"resourceMetrics": [ResourceMetric]
}
}
}
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
llmFineTuningCreationCurrentAmount
llmFineTuningCreationMaxAmount
llmFineTuningCreationUnit
llmFineTuningDeploymentCurrentAmount
llmFineTuningDeploymentMaxAmount
llmFineTuningDeploymentUnit
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getFreeTrialQuota": {
"runPromptCurrentAmount": 123,
"runPromptMaxAmount": 987,
"runPromptUnit": "abc123",
"embedDocumentCurrentAmount": 987.65,
"embedDocumentMaxAmount": 987.65,
"embedDocumentUnit": "abc123",
"embedDocumentUrlCurrentAmount": 123,
"embedDocumentUrlMaxAmount": 987,
"embedDocumentUrlUnit": "xyz789",
"llmEvaluationCurrentAmount": 123,
"llmEvaluationMaxAmount": 123,
"llmEvaluationUnit": "abc123",
"llmFineTuningCreationCurrentAmount": 123,
"llmFineTuningCreationMaxAmount": 987,
"llmFineTuningCreationUnit": "xyz789",
"llmFineTuningDeploymentCurrentAmount": 987,
"llmFineTuningDeploymentMaxAmount": 987,
"llmFineTuningDeploymentUnit": "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
syncTimestampToTokenSelector
}
}
Variables
{"projectId": "4"}
Response
{
"data": {
"getGeneralWorkspaceSettings": {
"id": "4",
"editorFontType": "SANS_SERIF",
"editorFontSize": "SMALL",
"editorLineSpacing": "DENSE",
"editorLineSpacingRatio": 987.65,
"showIndexBar": false,
"showLabels": "ALWAYS",
"keepLabelBoxOpenAfterRelabel": true,
"jumpToNextDocumentOnSubmit": false,
"jumpToNextDocumentOnDocumentCompleted": true,
"jumpToNextSpanOnSubmit": false,
"multipleSelectLabels": false,
"syncTimestampToTokenSelector": true
}
}
}
getGlobalWorkspacePermissionsSettings
Response
Returns a GlobalWorkspacePermissionsSettings!
Example
Query
query GetGlobalWorkspacePermissionsSettings {
getGlobalWorkspacePermissionsSettings {
allowCreateWorkspaces
allowInviteTeamMembers
allowChangeTeamMemberRoles
allowRemoveTeamMembers
}
}
Response
{
"data": {
"getGlobalWorkspacePermissionsSettings": {
"allowCreateWorkspaces": true,
"allowInviteTeamMembers": false,
"allowChangeTeamMemberRoles": true,
"allowRemoveTeamMembers": 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": "xyz789",
"position": TextRange,
"suggestions": ["abc123"]
}
]
}
}
getGroundTruthSet
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a GroundTruthSet!
Arguments
| Name | Description |
|---|---|
input - GetGroundTruthSetInput!
|
Example
Query
query GetGroundTruthSet($input: GetGroundTruthSetInput!) {
getGroundTruthSet(input: $input) {
id
name
teamId
createdByUserId
createdByUser {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
items {
id
groundTruthSetId
systemInstruction
prompt
answer
createdAt
updatedAt
}
itemsCount
createdAt
updatedAt
}
}
Variables
{"input": GetGroundTruthSetInput}
Response
{
"data": {
"getGroundTruthSet": {
"id": "4",
"name": "xyz789",
"teamId": 4,
"createdByUserId": "4",
"createdByUser": User,
"items": [GroundTruth],
"itemsCount": 123,
"createdAt": "abc123",
"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
}
availableDocumentsCount
}
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getGuidelines": [
{
"id": "4",
"name": "xyz789",
"content": "abc123",
"project": Project
}
]
}
}
getIAAInformation
Response
Returns an IAAInformation!
Arguments
| Name | Description |
|---|---|
input - IAAInput!
|
Example
Query
query GetIAAInformation($input: IAAInput!) {
getIAAInformation(input: $input) {
agreements {
userId1
userId2
teamMemberId1
teamMemberId2
agreement
}
lastUpdatedTime
}
}
Variables
{"input": IAAInput}
Response
{
"data": {
"getIAAInformation": {
"agreements": [IAA],
"lastUpdatedTime": "xyz789"
}
}
}
getIAALabelerLabelerStatus
Response
Returns an IAALabelerLabelerStatus!
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
Example
Query
query GetIAALabelerLabelerStatus($projectId: ID!) {
getIAALabelerLabelerStatus(projectId: $projectId) {
labelerLabelerSkipped
totalPairs
threshold
calculatedAt
selectedPairs {
teamMemberId1
teamMemberId2
status
}
}
}
Variables
{"projectId": "4"}
Response
{
"data": {
"getIAALabelerLabelerStatus": {
"labelerLabelerSkipped": false,
"totalPairs": 987,
"threshold": 987,
"calculatedAt": "abc123",
"selectedPairs": [IAASelectedPairStatus]
}
}
}
getIAALastUpdatedAt
Please use getIAAInformation instead.
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
|
labelSetSignatures - [String!]
|
|
method - IAAMethodName
|
|
projectIds - [ID!]
|
Example
Query
query GetIAALastUpdatedAt(
$teamId: ID!,
$labelSetSignatures: [String!],
$method: IAAMethodName,
$projectIds: [ID!]
) {
getIAALastUpdatedAt(
teamId: $teamId,
labelSetSignatures: $labelSetSignatures,
method: $method,
projectIds: $projectIds
)
}
Variables
{
"teamId": "4",
"labelSetSignatures": ["abc123"],
"method": "COHENS_KAPPA",
"projectIds": [4]
}
Response
{"data": {"getIAALastUpdatedAt": "xyz789"}}
getInvalidDocumentAnswerInfos
Response
Returns [InvalidAnswerInfo!]!
Arguments
| Name | Description |
|---|---|
cabinetId - ID!
|
Example
Query
query GetInvalidDocumentAnswerInfos($cabinetId: ID!) {
getInvalidDocumentAnswerInfos(cabinetId: $cabinetId) {
documentId
fileName
lines
}
}
Variables
{"cabinetId": "4"}
Response
{
"data": {
"getInvalidDocumentAnswerInfos": [
{
"documentId": "4",
"fileName": "abc123",
"lines": [123]
}
]
}
}
getInvalidRowAnswerInfos
Response
Returns [InvalidAnswerInfo!]!
Arguments
| Name | Description |
|---|---|
cabinetId - ID!
|
Example
Query
query GetInvalidRowAnswerInfos($cabinetId: ID!) {
getInvalidRowAnswerInfos(cabinetId: $cabinetId) {
documentId
fileName
lines
}
}
Variables
{"cabinetId": "4"}
Response
{
"data": {
"getInvalidRowAnswerInfos": [
{
"documentId": "4",
"fileName": "xyz789",
"lines": [123]
}
]
}
}
getInvoiceUrl
Breaking changes may be introduced anytime in the future without prior notice.
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
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"jobId": "xyz789"}
Response
{
"data": {
"getJob": {
"id": "xyz789",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "abc123",
"retryCount": 123,
"maxRetry": 123,
"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
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"jobIds": ["abc123"]}
Response
{
"data": {
"getJobs": [
{
"id": "xyz789",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "abc123",
"retryCount": 123,
"maxRetry": 123,
"additionalData": JobAdditionalData
}
]
}
}
getLLMAssistedLabelingProviders
Response
Arguments
| Name | Description |
|---|---|
input - LLMAssistedLabelingProvidersInput!
|
Example
Query
query GetLLMAssistedLabelingProviders($input: LLMAssistedLabelingProvidersInput!) {
getLLMAssistedLabelingProviders(input: $input) {
name
models {
model
maxTokens
}
inputFields {
key
name
type
required
maxValue
minValue
}
}
}
Variables
{"input": LLMAssistedLabelingProvidersInput}
Response
{
"data": {
"getLLMAssistedLabelingProviders": [
{
"name": "OPENAI",
"models": [LLMAssistedLabelingProviderModel],
"inputFields": [
LLMAssistedLabelingProviderInputField
]
}
]
}
}
getLabelDistribution
Description
Distribution of applied labels and answers across a project, optionally narrowed to one document.
Response
Returns a GetLabelDistributionResponse!
Arguments
| Name | Description |
|---|---|
input - GetLabelDistributionInput!
|
Example
Query
query GetLabelDistribution($input: GetLabelDistributionInput!) {
getLabelDistribution(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
labelClass
labelSet
labelSetId
count
accepted
rejected
kind
color
totalOptions
}
kinds
hasEligibleQuestionTypes
}
}
Variables
{"input": GetLabelDistributionInput}
Response
{
"data": {
"getLabelDistribution": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [LabelDistributionRow],
"kinds": ["DOCUMENT_BASED"],
"hasEligibleQuestionTypes": true
}
}
}
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": 987,
"errorPossibility": 123.45,
"suggestedLabel": "abc123",
"previousLabel": "abc123",
"createdAt": "abc123",
"updatedAt": "xyz789"
}
]
}
}
getLabelSetTemplate
Description
Returns a single labelset template.
Response
Returns a LabelSetTemplate
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetLabelSetTemplate($id: ID!) {
getLabelSetTemplate(id: $id) {
id
name
owner {
id
samlId
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
leafOnlyOption
}
}
Variables
{"id": 4}
Response
{
"data": {
"getLabelSetTemplate": {
"id": 4,
"name": "xyz789",
"owner": User,
"type": "QUESTION",
"items": [LabelSetTemplateItem],
"count": 123,
"createdAt": "xyz789",
"updatedAt": "abc123",
"leafOnlyOption": false
}
}
}
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
leafOnlyOption
}
}
}
Variables
{"input": GetLabelSetTemplatesPaginatedInput}
Response
{
"data": {
"getLabelSetTemplates": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [LabelSetTemplate]
}
}
}
getLabelSetsByTeamId
Response
Returns [LabelSet!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetLabelSetsByTeamId($teamId: ID!) {
getLabelSetsByTeamId(teamId: $teamId) {
id
name
index
signature
tagItems {
id
parentId
tagName
desc
color
type
arrowRules {
...LabelClassArrowRuleFragment
}
allowCustomAttribute
}
lastUsedBy {
projectId
name
}
arrowLabelRequired
leafOnlyOption
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getLabelSetsByTeamId": [
{
"id": "4",
"name": "abc123",
"index": 987,
"signature": "xyz789",
"tagItems": [TagItem],
"lastUsedBy": LastUsedProject,
"arrowLabelRequired": true,
"leafOnlyOption": false
}
]
}
}
getLabelerLastSavedAt
Description
Returns the UNIX timestamp (as a string) of the most recent labeling activity for the given document.
- For review documents: the timestamp of the last label applied by any labeler. Returns null if no labeler is assigned or none has started work.
- For non-review documents: the timestamp of the document's last update.
getLabelingAgentJobs
Response
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
Example
Query
query GetLabelingAgentJobs($projectId: ID!) {
getLabelingAgentJobs(projectId: $projectId) {
parentJobId
jobId
projectId
projectName
projectResourceId
labelingAgentId
labelingAgent {
id
agentId
agentType
name
}
jobType
jobStatus
progress
errors {
id
stack
args
message
}
taskScope {
spanTask {
...SpanTaskScopeFragment
}
rowTask {
...RowTaskScopeFragment
}
}
}
}
Variables
{"projectId": "4"}
Response
{
"data": {
"getLabelingAgentJobs": [
{
"parentJobId": "abc123",
"jobId": "abc123",
"projectId": "abc123",
"projectName": "abc123",
"projectResourceId": "abc123",
"labelingAgentId": "abc123",
"labelingAgent": LabelingAgent,
"jobType": "CABINET_CREATION",
"jobStatus": "DELIVERED",
"progress": 987,
"errors": [JobError],
"taskScope": TaskScope
}
]
}
}
getLabelingAgentTeamMembers
Response
Returns [TeamMember!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetLabelingAgentTeamMembers($teamId: ID!) {
getLabelingAgentTeamMembers(teamId: $teamId) {
id
user {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
userId
role {
id
name
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
id
userId
projectStatistic {
...TeamMemberProjectStatisticFragment
}
totalTimeSpent
effectiveTotalTimeSpent
accuracy
}
labelingAgent {
id
agentId
agentType
name
}
labelingAgentId
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getLabelingAgentTeamMembers": [
{
"id": "4",
"user": User,
"userId": 4,
"role": TeamRole,
"invitationEmail": "abc123",
"invitationStatus": "abc123",
"invitationKey": "xyz789",
"isDeleted": false,
"joinedDate": "xyz789",
"performance": TeamMemberPerformance,
"labelingAgent": LabelingAgent,
"labelingAgentId": "4"
}
]
}
}
getLabelingAgents
Response
Returns [LabelingAgent!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetLabelingAgents($teamId: ID!) {
getLabelingAgents(teamId: $teamId) {
id
agentId
agentType
name
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getLabelingAgents": [
{
"id": "4",
"agentId": "abc123",
"agentType": "LLM_LABS",
"name": "abc123"
}
]
}
}
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
cached
}
}
Variables
{"input": GetLabelingFunctionInput}
Response
{
"data": {
"getLabelingFunction": {
"id": 4,
"dataProgrammingId": 4,
"heuristicArgument": HeuristicArgumentScalar,
"annotatorArgument": AnnotatorArgumentScalar,
"name": "xyz789",
"content": "xyz789",
"active": true,
"createdAt": "xyz789",
"updatedAt": "abc123",
"cached": false
}
}
}
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
cached
}
}
Variables
{"input": GetLabelingFunctionsInput}
Response
{
"data": {
"getLabelingFunctions": [
{
"id": "4",
"dataProgrammingId": "4",
"heuristicArgument": HeuristicArgumentScalar,
"annotatorArgument": AnnotatorArgumentScalar,
"name": "abc123",
"content": "abc123",
"active": false,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"cached": true
}
]
}
}
getLabelingFunctionsPairKappa
Response
Returns a GetLabelingFunctionsPairKappaOutput!
Arguments
| Name | Description |
|---|---|
input - GetLabelingFunctionsPairKappaInput!
|
Example
Query
query GetLabelingFunctionsPairKappa($input: GetLabelingFunctionsPairKappaInput!) {
getLabelingFunctionsPairKappa(input: $input) {
labelingFunctionPairKappas {
labelingFunctionId1
labelingFunctionId2
kappa
}
lastCalculatedAt
}
}
Variables
{"input": GetLabelingFunctionsPairKappaInput}
Response
{
"data": {
"getLabelingFunctionsPairKappa": {
"labelingFunctionPairKappas": [
LabelingFunctionPairKappa
],
"lastCalculatedAt": "xyz789"
}
}
}
getLabelingStatusForCabinet
Response
Returns a LabelingStatus!
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
Example
Query
query GetLabelingStatusForCabinet($projectId: ID!) {
getLabelingStatusForCabinet(projectId: $projectId) {
labeler {
id
user {
...UserFragment
}
userId
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
labelingAgent {
...LabelingAgentFragment
}
labelingAgentId
}
isCompleted
isStarted
statistic {
id
numberOfDocuments
numberOfTouchedDocuments
numberOfCompletedDocuments
numberOfSentences
numberOfTouchedSentences
documentIds
completedDocumentIds
touchedDocumentIds
totalLabelsApplied
numberOfAcceptedLabels
numberOfRejectedLabels
numberOfUnresolvedLabels
totalTimeSpent
}
statisticsToShow {
key
values {
...StatisticItemValueFragment
}
}
}
}
Variables
{"projectId": "4"}
Response
{
"data": {
"getLabelingStatusForCabinet": {
"labeler": TeamMember,
"isCompleted": false,
"isStarted": true,
"statistic": LabelingStatusStatistic,
"statisticsToShow": [StatisticItem]
}
}
}
getLabelsPaginated
Description
Fetch span and arrow labels by document ID. totalCount is only calculated on the first page (skip: 0).
Response
Returns a GetLabelsPaginatedResponse!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
input - GetLabelsPaginatedInput!
|
|
signature - String
|
Example
Query
query GetLabelsPaginated(
$documentId: ID!,
$input: GetLabelsPaginatedInput!,
$signature: String
) {
getLabelsPaginated(
documentId: $documentId,
input: $input,
signature: $signature
) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes
}
}
Variables
{
"documentId": 4,
"input": GetLabelsPaginatedInput,
"signature": "abc123"
}
Response
{
"data": {
"getLabelsPaginated": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [TextLabelScalar]
}
}
}
getLabelsPaginatedByLine
Breaking changes may be introduced anytime in the future without prior notice.
Description
Fetch span and arrow labels by document ID and line number.
Response
Returns a GetLabelsPaginatedResponse!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
input - GetLabelsPaginatedByLineInput!
|
|
signature - String
|
Example
Query
query GetLabelsPaginatedByLine(
$documentId: ID!,
$input: GetLabelsPaginatedByLineInput!,
$signature: String
) {
getLabelsPaginatedByLine(
documentId: $documentId,
input: $input,
signature: $signature
) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes
}
}
Variables
{
"documentId": 4,
"input": GetLabelsPaginatedByLineInput,
"signature": "xyz789"
}
Response
{
"data": {
"getLabelsPaginatedByLine": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [TextLabelScalar]
}
}
}
getLastLlmApplicationDeployment
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplicationDeployment
Arguments
| Name | Description |
|---|---|
llmApplicationId - ID!
|
Example
Query
query GetLastLlmApplicationDeployment($llmApplicationId: ID!) {
getLastLlmApplicationDeployment(llmApplicationId: $llmApplicationId) {
id
deployedByUser {
id
samlId
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
}
totalRagConfigs
}
llmRagConfig {
id
llmModel {
...LlmModelFragment
}
systemInstruction
userInstruction
raw
temperature
topP
maxTokens
advancedHyperparameters
maxVectorStoreTokens
llmVectorStore {
...LlmVectorStoreFragment
}
llmVectorStores {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
maxChunkSize
createdAt
updatedAt
}
numberOfCalls
numberOfTokens
numberOfInputTokens
numberOfOutputTokens
deployedAt
name
status
createdAt
updatedAt
apiEndpoints {
type
endpoint
}
isDeleted
}
}
Variables
{"llmApplicationId": 4}
Response
{
"data": {
"getLastLlmApplicationDeployment": {
"id": 4,
"deployedByUser": User,
"llmApplicationId": "4",
"llmApplication": LlmApplication,
"llmRagConfig": LlmRagConfig,
"numberOfCalls": 123,
"numberOfTokens": 987,
"numberOfInputTokens": 123,
"numberOfOutputTokens": 123,
"deployedAt": "xyz789",
"name": "xyz789",
"status": "SUSPENDED",
"createdAt": "abc123",
"updatedAt": "abc123",
"apiEndpoints": [
LlmApplicationDeploymentApiEndpoint
],
"isDeleted": true
}
}
}
getLatestAccessedTeam
Response
Returns a Team
Example
Query
query GetLatestAccessedTeam {
getLatestAccessedTeam {
id
logoURL
members {
id
user {
...UserFragment
}
userId
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
labelingAgent {
...LabelingAgentFragment
}
labelingAgentId
}
membersScalar
name
setting {
activitySettings {
...TeamActivitySettingsFragment
}
additionalSetting {
...AdditionalTeamSettingFragment
}
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedASRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enabledCustomObjectStorage
enableActions
enableAddDocumentsToProject
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurDinamicTokenBased
enableDatasaurPredictiveRowBased
enableLabelingAgentSpanBased
enableLabelingAgentRowBased
enableLabelingAgentArrowBased
enableWipeData
enableExportTeamOverview
enableSelfAssignment
enableWebhookSelfService
enableOauthApplicationSelfService
enableTransferOwnership
enableLabelErrorDetectionRowBased
allowedExtraAutoLabelProviders
enableLLMProject
enableRegexSentenceSeparator
enableTeamRoleSupervisor
endExtensionTrialAt
allowInvalidPaymentMethod
enableExternalKnowledgeBase
enableForceAnonymization
enableReviewIndicator
enableValidationScript
enableSpanLabelingWithRowQuestions
llmFreeTrialDailyLimitsConfig {
...LlmFreeTrialDailyLimitsConfigFragment
}
enableScriptGeneratedQuestion
rowModification {
...RowModificationSettingFragment
}
enableDeployedApplicationLogging
enableRealTimeAssistedLabelingSpanBased
enableLabelsAndAnswersExportFormat
enableGoogleDriveExternalObjectStorage
enableMLAssistedOptimizationByDefault
}
owner {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
isExpired
expiredAt
}
}
Response
{
"data": {
"getLatestAccessedTeam": {
"id": 4,
"logoURL": "xyz789",
"members": [TeamMember],
"membersScalar": TeamMembersScalar,
"name": "abc123",
"setting": TeamSetting,
"owner": User,
"isExpired": false,
"expiredAt": "2007-12-03T10:15:30Z"
}
}
}
getLatestInfoBar
Response
Returns an InfoBar
Example
Query
query GetLatestInfoBar {
getLatestInfoBar {
id
content
isVisible
createdAt
updatedAt
}
}
Response
{
"data": {
"getLatestInfoBar": {
"id": 4,
"content": "abc123",
"isVisible": true,
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
getLatestJoinedTeam
Response
Returns a Team
Example
Query
query GetLatestJoinedTeam {
getLatestJoinedTeam {
id
logoURL
members {
id
user {
...UserFragment
}
userId
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
labelingAgent {
...LabelingAgentFragment
}
labelingAgentId
}
membersScalar
name
setting {
activitySettings {
...TeamActivitySettingsFragment
}
additionalSetting {
...AdditionalTeamSettingFragment
}
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedASRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enabledCustomObjectStorage
enableActions
enableAddDocumentsToProject
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurDinamicTokenBased
enableDatasaurPredictiveRowBased
enableLabelingAgentSpanBased
enableLabelingAgentRowBased
enableLabelingAgentArrowBased
enableWipeData
enableExportTeamOverview
enableSelfAssignment
enableWebhookSelfService
enableOauthApplicationSelfService
enableTransferOwnership
enableLabelErrorDetectionRowBased
allowedExtraAutoLabelProviders
enableLLMProject
enableRegexSentenceSeparator
enableTeamRoleSupervisor
endExtensionTrialAt
allowInvalidPaymentMethod
enableExternalKnowledgeBase
enableForceAnonymization
enableReviewIndicator
enableValidationScript
enableSpanLabelingWithRowQuestions
llmFreeTrialDailyLimitsConfig {
...LlmFreeTrialDailyLimitsConfigFragment
}
enableScriptGeneratedQuestion
rowModification {
...RowModificationSettingFragment
}
enableDeployedApplicationLogging
enableRealTimeAssistedLabelingSpanBased
enableLabelsAndAnswersExportFormat
enableGoogleDriveExternalObjectStorage
enableMLAssistedOptimizationByDefault
}
owner {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
isExpired
expiredAt
}
}
Response
{
"data": {
"getLatestJoinedTeam": {
"id": 4,
"logoURL": "xyz789",
"members": [TeamMember],
"membersScalar": TeamMembersScalar,
"name": "abc123",
"setting": TeamSetting,
"owner": User,
"isExpired": 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 |
|---|---|
input - GetLlmApplicationInput!
|
Example
Query
query GetLlmApplication($input: GetLlmApplicationInput!) {
getLlmApplication(input: $input) {
id
teamId
createdByUser {
id
samlId
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
name
status
createdAt
updatedAt
apiEndpoints {
...LlmApplicationDeploymentApiEndpointFragment
}
isDeleted
}
totalRagConfigs
}
}
Variables
{"input": GetLlmApplicationInput}
Response
{
"data": {
"getLlmApplication": {
"id": 4,
"teamId": 4,
"createdByUser": User,
"name": "xyz789",
"status": "DEPLOYED",
"createdAt": "abc123",
"updatedAt": "xyz789",
"llmApplicationDeployment": LlmApplicationDeployment,
"totalRagConfigs": 123
}
}
}
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
updatedByUserId
updatedByUser {
id
samlId
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
}
llmVectorStores {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
maxChunkSize
createdAt
updatedAt
}
createdAt
updatedAt
isDeleted
}
}
Variables
{"id": 4}
Response
{
"data": {
"getLlmApplicationConfiguration": {
"id": "4",
"name": "xyz789",
"teamId": 4,
"createdByUserId": 4,
"updatedByUserId": "4",
"updatedByUser": User,
"llmRagConfigId": 4,
"llmRagConfig": LlmRagConfig,
"createdAt": "xyz789",
"updatedAt": "abc123",
"isDeleted": true
}
}
}
getLlmApplicationConfigurations
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns [LlmApplicationConfiguration!]!
Example
Query
query GetLlmApplicationConfigurations(
$teamId: ID!,
$withDeleted: Boolean
) {
getLlmApplicationConfigurations(
teamId: $teamId,
withDeleted: $withDeleted
) {
id
name
teamId
createdByUserId
updatedByUserId
updatedByUser {
id
samlId
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
}
llmVectorStores {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
maxChunkSize
createdAt
updatedAt
}
createdAt
updatedAt
isDeleted
}
}
Variables
{"teamId": "4", "withDeleted": false}
Response
{
"data": {
"getLlmApplicationConfigurations": [
{
"id": "4",
"name": "abc123",
"teamId": 4,
"createdByUserId": "4",
"updatedByUserId": "4",
"updatedByUser": User,
"llmRagConfigId": "4",
"llmRagConfig": LlmRagConfig,
"createdAt": "xyz789",
"updatedAt": "abc123",
"isDeleted": false
}
]
}
}
getLlmApplicationDeployment
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplicationDeployment
Arguments
| Name | Description |
|---|---|
input - GetLlmApplicationDeploymentInput!
|
Example
Query
query GetLlmApplicationDeployment($input: GetLlmApplicationDeploymentInput!) {
getLlmApplicationDeployment(input: $input) {
id
deployedByUser {
id
samlId
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
}
totalRagConfigs
}
llmRagConfig {
id
llmModel {
...LlmModelFragment
}
systemInstruction
userInstruction
raw
temperature
topP
maxTokens
advancedHyperparameters
maxVectorStoreTokens
llmVectorStore {
...LlmVectorStoreFragment
}
llmVectorStores {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
maxChunkSize
createdAt
updatedAt
}
numberOfCalls
numberOfTokens
numberOfInputTokens
numberOfOutputTokens
deployedAt
name
status
createdAt
updatedAt
apiEndpoints {
type
endpoint
}
isDeleted
}
}
Variables
{"input": GetLlmApplicationDeploymentInput}
Response
{
"data": {
"getLlmApplicationDeployment": {
"id": "4",
"deployedByUser": User,
"llmApplicationId": 4,
"llmApplication": LlmApplication,
"llmRagConfig": LlmRagConfig,
"numberOfCalls": 123,
"numberOfTokens": 987,
"numberOfInputTokens": 987,
"numberOfOutputTokens": 123,
"deployedAt": "abc123",
"name": "abc123",
"status": "SUSPENDED",
"createdAt": "xyz789",
"updatedAt": "xyz789",
"apiEndpoints": [
LlmApplicationDeploymentApiEndpoint
],
"isDeleted": true
}
}
}
getLlmApplicationDeploymentUsageTotalCost
Response
Returns a Float!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
|
type - GqlLlmUsageType!
|
|
sourceId - ID!
|
Example
Query
query GetLlmApplicationDeploymentUsageTotalCost(
$teamId: ID!,
$type: GqlLlmUsageType!,
$sourceId: ID!
) {
getLlmApplicationDeploymentUsageTotalCost(
teamId: $teamId,
type: $type,
sourceId: $sourceId
)
}
Variables
{
"teamId": 4,
"type": "VECTOR_STORE",
"sourceId": "4"
}
Response
{"data": {"getLlmApplicationDeploymentUsageTotalCost": 987.65}}
getLlmApplicationDeployments
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns [LlmApplicationDeployment!]!
Example
Query
query GetLlmApplicationDeployments(
$teamId: ID!,
$withDeleted: Boolean
) {
getLlmApplicationDeployments(
teamId: $teamId,
withDeleted: $withDeleted
) {
id
deployedByUser {
id
samlId
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
}
totalRagConfigs
}
llmRagConfig {
id
llmModel {
...LlmModelFragment
}
systemInstruction
userInstruction
raw
temperature
topP
maxTokens
advancedHyperparameters
maxVectorStoreTokens
llmVectorStore {
...LlmVectorStoreFragment
}
llmVectorStores {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
maxChunkSize
createdAt
updatedAt
}
numberOfCalls
numberOfTokens
numberOfInputTokens
numberOfOutputTokens
deployedAt
name
status
createdAt
updatedAt
apiEndpoints {
type
endpoint
}
isDeleted
}
}
Variables
{"teamId": "4", "withDeleted": false}
Response
{
"data": {
"getLlmApplicationDeployments": [
{
"id": "4",
"deployedByUser": User,
"llmApplicationId": "4",
"llmApplication": LlmApplication,
"llmRagConfig": LlmRagConfig,
"numberOfCalls": 123,
"numberOfTokens": 987,
"numberOfInputTokens": 987,
"numberOfOutputTokens": 123,
"deployedAt": "xyz789",
"name": "xyz789",
"status": "SUSPENDED",
"createdAt": "xyz789",
"updatedAt": "xyz789",
"apiEndpoints": [
LlmApplicationDeploymentApiEndpoint
],
"isDeleted": true
}
]
}
}
getLlmApplicationDeploymentsPaginated
Breaking changes may be introduced anytime in the future without prior notice.
Response
Arguments
| Name | Description |
|---|---|
input - GetLlmApplicationDeploymentsPaginatedInput!
|
Example
Query
query GetLlmApplicationDeploymentsPaginated($input: GetLlmApplicationDeploymentsPaginatedInput!) {
getLlmApplicationDeploymentsPaginated(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
id
deployedByUser {
...UserFragment
}
llmApplicationId
llmApplication {
...LlmApplicationFragment
}
llmRagConfig {
...LlmRagConfigFragment
}
numberOfCalls
numberOfTokens
numberOfInputTokens
numberOfOutputTokens
deployedAt
name
status
createdAt
updatedAt
apiEndpoints {
...LlmApplicationDeploymentApiEndpointFragment
}
isDeleted
}
}
}
Variables
{"input": GetLlmApplicationDeploymentsPaginatedInput}
Response
{
"data": {
"getLlmApplicationDeploymentsPaginated": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [LlmApplicationDeployment]
}
}
}
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
createdAt
updatedAt
lastPromptMessage {
id
llmApplicationPlaygroundPromptId
content
role
attachments {
...LlmApplicationPlaygroundPromptAttachmentFragment
}
createdAt
updatedAt
}
totalPromptMessages
}
}
Variables
{"id": 4}
Response
{
"data": {
"getLlmApplicationPlaygroundPrompt": {
"id": 4,
"llmApplicationId": "4",
"name": "abc123",
"createdAt": "abc123",
"updatedAt": "abc123",
"lastPromptMessage": LlmApplicationPlaygroundPromptMessage,
"totalPromptMessages": 123
}
}
}
getLlmApplicationPlaygroundPromptMessages
Breaking changes may be introduced anytime in the future without prior notice.
Response
Arguments
| Name | Description |
|---|---|
llmApplicationPlaygroundPromptId - ID!
|
Example
Query
query GetLlmApplicationPlaygroundPromptMessages($llmApplicationPlaygroundPromptId: ID!) {
getLlmApplicationPlaygroundPromptMessages(llmApplicationPlaygroundPromptId: $llmApplicationPlaygroundPromptId) {
id
llmApplicationPlaygroundPromptId
content
role
attachments {
id
llmFileId
llmFile {
...LlmFileFragment
}
createdAt
updatedAt
llmApplicationPlaygroundPromptMessageId
}
createdAt
updatedAt
}
}
Variables
{"llmApplicationPlaygroundPromptId": 4}
Response
{
"data": {
"getLlmApplicationPlaygroundPromptMessages": [
{
"id": "4",
"llmApplicationPlaygroundPromptId": "4",
"content": "abc123",
"role": "USER",
"attachments": [
LlmApplicationPlaygroundPromptAttachment
],
"createdAt": "abc123",
"updatedAt": "xyz789"
}
]
}
}
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
createdAt
updatedAt
lastPromptMessage {
id
llmApplicationPlaygroundPromptId
content
role
attachments {
...LlmApplicationPlaygroundPromptAttachmentFragment
}
createdAt
updatedAt
}
totalPromptMessages
}
}
Variables
{"llmApplicationId": 4}
Response
{
"data": {
"getLlmApplicationPlaygroundPrompts": [
{
"id": 4,
"llmApplicationId": 4,
"name": "abc123",
"createdAt": "xyz789",
"updatedAt": "xyz789",
"lastPromptMessage": LlmApplicationPlaygroundPromptMessage,
"totalPromptMessages": 123
}
]
}
}
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
}
llmVectorStores {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
maxChunkSize
createdAt
updatedAt
}
name
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"getLlmApplicationPlaygroundRagConfig": {
"id": 4,
"llmApplicationId": 4,
"llmRagConfig": LlmRagConfig,
"name": "abc123",
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
getLlmApplicationPlaygroundRagConfigModelDetails
Breaking changes may be introduced anytime in the future without prior notice.
Response
Arguments
| Name | Description |
|---|---|
llmApplicationId - ID!
|
Example
Query
query GetLlmApplicationPlaygroundRagConfigModelDetails($llmApplicationId: ID!) {
getLlmApplicationPlaygroundRagConfigModelDetails(llmApplicationId: $llmApplicationId) {
llmModelDetails {
modelId
modelType
status
instanceType
instanceTypeDetail {
...LlmInstanceTypeDetailFragment
}
}
llmEmbeddingModelDetails {
modelId
modelType
status
instanceType
instanceTypeDetail {
...LlmInstanceTypeDetailFragment
}
}
}
}
Variables
{"llmApplicationId": 4}
Response
{
"data": {
"getLlmApplicationPlaygroundRagConfigModelDetails": {
"llmModelDetails": [LlmModelDetail],
"llmEmbeddingModelDetails": [LlmModelDetail]
}
}
}
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
}
llmVectorStores {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
maxChunkSize
createdAt
updatedAt
}
name
createdAt
updatedAt
}
}
Variables
{"llmApplicationId": 4}
Response
{
"data": {
"getLlmApplicationPlaygroundRagConfigs": [
{
"id": "4",
"llmApplicationId": "4",
"llmRagConfig": LlmRagConfig,
"name": "abc123",
"createdAt": "abc123",
"updatedAt": "abc123"
}
]
}
}
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
}
totalRagConfigs
}
}
}
Variables
{"input": GetLlmApplicationsPaginatedInput}
Response
{
"data": {
"getLlmApplications": {
"totalCount": 987,
"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
samlId
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
name
status
createdAt
updatedAt
apiEndpoints {
...LlmApplicationDeploymentApiEndpointFragment
}
isDeleted
}
totalRagConfigs
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getLlmApplicationsByTeam": [
{
"id": 4,
"teamId": "4",
"createdByUser": User,
"name": "xyz789",
"status": "DEPLOYED",
"createdAt": "abc123",
"updatedAt": "abc123",
"llmApplicationDeployment": LlmApplicationDeployment,
"totalRagConfigs": 123
}
]
}
}
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
variant
region
methodTypes
supportedDatasetTypes
supportedHyperparameters {
name
actualName
type
minValue
maxValue
defaultValue
}
pricingModels {
id
llmBaseModelId
unitPrice
unitType
unitPurpose
}
deployable
requireSubscriptionPlan
supportsValidationDataset
instanceTypes {
name
gpuMemoryCapability
storageSizeCapability
}
defaultTrainingInstanceType {
name
gpuMemoryCapability
storageSizeCapability
}
trainingVolumeSize
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getLlmBaseModels": [
{
"id": 4,
"baseModelIdentifier": "xyz789",
"customModelIdentifier": "abc123",
"teamId": "4",
"name": "xyz789",
"serviceProvider": "AMAZON_BEDROCK",
"provider": "AMAZON",
"variant": "META",
"region": "xyz789",
"methodTypes": ["FINE_TUNING"],
"supportedDatasetTypes": ["COMPLETION"],
"supportedHyperparameters": [
LlmBaseModelHyperparameter
],
"pricingModels": [LlmBaseModelPricingModel],
"deployable": false,
"requireSubscriptionPlan": true,
"supportsValidationDataset": true,
"instanceTypes": [FineTuningInstanceType],
"defaultTrainingInstanceType": FineTuningInstanceType,
"trainingVolumeSize": 987.65
}
]
}
}
getLlmEmbeddingModelDetails
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns [LlmModelDetail!]!
Example
Query
query GetLlmEmbeddingModelDetails(
$teamId: ID!,
$ids: [ID!]
) {
getLlmEmbeddingModelDetails(
teamId: $teamId,
ids: $ids
) {
modelId
modelType
status
instanceType
instanceTypeDetail {
name
cost {
...LlmInstanceCostDetailFragment
}
createdAt
}
}
}
Variables
{
"teamId": "4",
"ids": ["4"]
}
Response
{
"data": {
"getLlmEmbeddingModelDetails": [
{
"modelId": 4,
"modelType": "LLM_MODEL",
"status": "AVAILABLE",
"instanceType": "xyz789",
"instanceTypeDetail": LlmInstanceTypeDetail
}
]
}
}
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": "abc123",
"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
teamId
provider
name
displayName
url
maxTokens
dimensions
deployableModelId
isModelDeployable
createdAt
updatedAt
variant
customDimension
}
}
Variables
{"teamId": 4, "includeDefault": true}
Response
{
"data": {
"getLlmEmbeddingModels": [
{
"id": 4,
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "abc123",
"displayName": "abc123",
"url": "xyz789",
"maxTokens": 123,
"dimensions": 123,
"deployableModelId": "xyz789",
"isModelDeployable": true,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"variant": "META",
"customDimension": true
}
]
}
}
getLlmEvaluation
Breaking changes may be introduced anytime in the future without prior notice.
Description
Retrieves one LlmEvaluation based on the provided id.
Response
Returns a LlmEvaluation!
Arguments
| Name | Description |
|---|---|
input - GetLlmEvaluationInput!
|
Example
Query
query GetLlmEvaluation($input: GetLlmEvaluationInput!) {
getLlmEvaluation(input: $input) {
id
name
teamId
projectId
kind
status
creationProgress {
status
jobId
error
}
scheduledCommandConfig {
id
cronPattern
repeatInterval
runImmediately
endTime
numberOfRepetition
isNeverEnding
isPeriodic
updatedAt
}
isScheduled
createdAt
updatedAt
isDeleted
type
schedulingStatus
nextSchedule
createdByUser {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
lastScoredByUser {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
totalPrompts
lastLlmEvaluationExecution {
id
llmEvaluationId
status
errorMessage
createdAt
updatedAt
isDeleted
}
}
}
Variables
{"input": GetLlmEvaluationInput}
Response
{
"data": {
"getLlmEvaluation": {
"id": 4,
"name": "xyz789",
"teamId": 4,
"projectId": 4,
"kind": "DOCUMENT_BASED",
"status": "CREATING",
"creationProgress": LlmEvaluationCreationProgress,
"scheduledCommandConfig": ScheduledCommandConfig,
"isScheduled": true,
"createdAt": "abc123",
"updatedAt": "abc123",
"isDeleted": true,
"type": "RATING",
"schedulingStatus": "NOT_STARTED",
"nextSchedule": "xyz789",
"createdByUser": User,
"lastScoredByUser": User,
"totalPrompts": 123,
"lastLlmEvaluationExecution": LlmEvaluationExecution
}
}
}
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": "abc123",
"displayName": "abc123",
"provider": "xyz789",
"version": "abc123",
"description": "abc123",
"deprecated": true,
"evaluatorModelTypes": ["LLM_MODEL"],
"minValue": 987.65,
"maxValue": 123.45,
"invertedValue": true,
"requiresContext": true
}
]
}
}
getLlmEvaluationCreationProgress
Breaking changes may be introduced anytime in the future without prior notice.
Description
Retrieves the LLM evaluation creation progress.
Response
Returns a LlmEvaluationCreationProgress!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetLlmEvaluationCreationProgress($id: ID!) {
getLlmEvaluationCreationProgress(id: $id) {
status
jobId
error
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getLlmEvaluationCreationProgress": {
"status": "PREPARING",
"jobId": "abc123",
"error": "xyz789"
}
}
}
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
externalRagConfig
completions {
...LlmEvaluationGeneratedAnswerFragment
}
scores {
...LlmEvaluationAnswerScoreFragment
}
}
}
}
Variables
{"input": GetLlmEvaluationDetailPaginatedInput}
Response
{
"data": {
"getLlmEvaluationDetail": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [LlmEvaluationDetail]
}
}
}
getLlmEvaluationEvaluatorsByLlmEvaluationId
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns [LlmEvaluationEvaluator!]!
Arguments
| Name | Description |
|---|---|
llmEvaluationId - ID!
|
Example
Query
query GetLlmEvaluationEvaluatorsByLlmEvaluationId($llmEvaluationId: ID!) {
getLlmEvaluationEvaluatorsByLlmEvaluationId(llmEvaluationId: $llmEvaluationId) {
id
llmEvaluationId
evaluator
metric
provider
version
llmModelId
llmModel {
id
teamId
provider
name
displayName
url
region
maxTemperature
maxTopP
maxTokens
maxContextWindow
defaultTemperature
defaultTopP
defaultMaxTokens
minTemperature
minTopP
llmModelFineTuningJob {
...LlmModelFineTuningJobFragment
}
deployableModelId
isModelDeployable
forceAnonymization
hasVisionCapability
variant
createdAt
updatedAt
}
llmEmbeddingModelId
llmEmbeddingModel {
id
teamId
provider
name
displayName
url
maxTokens
dimensions
deployableModelId
isModelDeployable
createdAt
updatedAt
variant
customDimension
}
alertExpression
minimumScore
maximumScore
prompt
customName
createdAt
updatedAt
isDeleted
}
}
Variables
{"llmEvaluationId": 4}
Response
{
"data": {
"getLlmEvaluationEvaluatorsByLlmEvaluationId": [
{
"id": "4",
"llmEvaluationId": "4",
"evaluator": "abc123",
"metric": "abc123",
"provider": "xyz789",
"version": "abc123",
"llmModelId": "4",
"llmModel": LlmModel,
"llmEmbeddingModelId": 4,
"llmEmbeddingModel": LlmEmbeddingModel,
"alertExpression": "xyz789",
"minimumScore": 987,
"maximumScore": 123,
"prompt": "xyz789",
"customName": "abc123",
"createdAt": "xyz789",
"updatedAt": "abc123",
"isDeleted": false
}
]
}
}
getLlmEvaluationExecutionsByLlmEvaluationId
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns [LlmEvaluationExecution!]!
Arguments
| Name | Description |
|---|---|
llmEvaluationId - ID!
|
Example
Query
query GetLlmEvaluationExecutionsByLlmEvaluationId($llmEvaluationId: ID!) {
getLlmEvaluationExecutionsByLlmEvaluationId(llmEvaluationId: $llmEvaluationId) {
id
llmEvaluationId
status
errorMessage
createdAt
updatedAt
isDeleted
}
}
Variables
{"llmEvaluationId": 4}
Response
{
"data": {
"getLlmEvaluationExecutionsByLlmEvaluationId": [
{
"id": 4,
"llmEvaluationId": 4,
"status": "PREPARING",
"errorMessage": "xyz789",
"createdAt": "abc123",
"updatedAt": "abc123",
"isDeleted": true
}
]
}
}
getLlmEvaluationGeneratedAnswerContextsByLlmEvaluationId
Response
Arguments
| Name | Description |
|---|---|
llmEvaluationId - ID!
|
Example
Query
query GetLlmEvaluationGeneratedAnswerContextsByLlmEvaluationId($llmEvaluationId: ID!) {
getLlmEvaluationGeneratedAnswerContextsByLlmEvaluationId(llmEvaluationId: $llmEvaluationId) {
id
llmEvaluationGeneratedAnswerId
content
metadata
score
createdAt
updatedAt
isDeleted
}
}
Variables
{"llmEvaluationId": "4"}
Response
{
"data": {
"getLlmEvaluationGeneratedAnswerContextsByLlmEvaluationId": [
{
"id": 4,
"llmEvaluationGeneratedAnswerId": 4,
"content": "xyz789",
"metadata": "xyz789",
"score": 987.65,
"createdAt": "abc123",
"updatedAt": "abc123",
"isDeleted": false
}
]
}
}
getLlmEvaluationGeneratedAnswersByLlmEvaluationId
Description
Finds the LLM evaluation generated answers by evaluation id.
Response
Returns [LlmEvaluationGeneratedAnswer!]!
Arguments
| Name | Description |
|---|---|
llmEvaluationId - ID!
|
Example
Query
query GetLlmEvaluationGeneratedAnswersByLlmEvaluationId($llmEvaluationId: ID!) {
getLlmEvaluationGeneratedAnswersByLlmEvaluationId(llmEvaluationId: $llmEvaluationId) {
id
llmEvaluationPromptId
llmRagConfig {
id
llmModel {
...LlmModelFragment
}
systemInstruction
userInstruction
raw
temperature
topP
maxTokens
advancedHyperparameters
maxVectorStoreTokens
llmVectorStore {
...LlmVectorStoreFragment
}
llmVectorStores {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
maxChunkSize
createdAt
updatedAt
}
llmRagConfigId
answer
llmEvaluationAnswerScores {
id
llmEvaluationEvaluatorId
llmEvaluationGeneratedAnswerId
score
reason
alertExpression
createdAt
updatedAt
isDeleted
}
processingTime
cost
createdAt
updatedAt
isDeleted
}
}
Variables
{"llmEvaluationId": 4}
Response
{
"data": {
"getLlmEvaluationGeneratedAnswersByLlmEvaluationId": [
{
"id": "4",
"llmEvaluationPromptId": "4",
"llmRagConfig": LlmRagConfig,
"llmRagConfigId": 4,
"answer": "abc123",
"llmEvaluationAnswerScores": [
LlmEvaluationAnswerScore
],
"processingTime": 123.45,
"cost": 123.45,
"createdAt": "abc123",
"updatedAt": "xyz789",
"isDeleted": true
}
]
}
}
getLlmEvaluationPromptsByLlmEvaluationId
Description
Retrieves the LLM evaluation prompts by the LLM evaluation id.
Response
Returns [LlmEvaluationPrompt!]!
Arguments
| Name | Description |
|---|---|
llmEvaluationId - ID!
|
Example
Query
query GetLlmEvaluationPromptsByLlmEvaluationId($llmEvaluationId: ID!) {
getLlmEvaluationPromptsByLlmEvaluationId(llmEvaluationId: $llmEvaluationId) {
id
llmEvaluationId
prompt
expectedCompletion
externalRagConfig
externalSources
createdAt
updatedAt
isDeleted
}
}
Variables
{"llmEvaluationId": "4"}
Response
{
"data": {
"getLlmEvaluationPromptsByLlmEvaluationId": [
{
"id": 4,
"llmEvaluationId": 4,
"prompt": "xyz789",
"expectedCompletion": "abc123",
"externalRagConfig": "abc123",
"externalSources": "xyz789",
"createdAt": "xyz789",
"updatedAt": "xyz789",
"isDeleted": false
}
]
}
}
getLlmEvaluationRagConfigsByLlmEvaluationId
Breaking changes may be introduced anytime in the future without prior notice.
Description
Retrieves the LLM evaluation RAG configs by the LLM evaluation id.
Response
Returns [LlmEvaluationRagConfig!]!
Arguments
| Name | Description |
|---|---|
llmEvaluationId - ID!
|
Example
Query
query GetLlmEvaluationRagConfigsByLlmEvaluationId($llmEvaluationId: ID!) {
getLlmEvaluationRagConfigsByLlmEvaluationId(llmEvaluationId: $llmEvaluationId) {
id
llmEvaluationId
llmApplication {
id
teamId
createdByUser {
...UserFragment
}
name
status
createdAt
updatedAt
llmApplicationDeployment {
...LlmApplicationDeploymentFragment
}
totalRagConfigs
}
llmPlaygroundRagConfig {
id
llmApplicationId
llmRagConfig {
...LlmRagConfigFragment
}
name
createdAt
updatedAt
}
llmDeploymentRagConfig {
id
deployedByUser {
...UserFragment
}
llmApplicationId
llmApplication {
...LlmApplicationFragment
}
llmRagConfig {
...LlmRagConfigFragment
}
numberOfCalls
numberOfTokens
numberOfInputTokens
numberOfOutputTokens
deployedAt
name
status
createdAt
updatedAt
apiEndpoints {
...LlmApplicationDeploymentApiEndpointFragment
}
isDeleted
}
llmRagConfigId
llmSnapshotRagConfig {
id
llmModel {
...LlmModelFragment
}
systemInstruction
userInstruction
raw
temperature
topP
maxTokens
advancedHyperparameters
maxVectorStoreTokens
llmVectorStore {
...LlmVectorStoreFragment
}
llmVectorStores {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
maxChunkSize
createdAt
updatedAt
}
llmApplicationConfigurationRagConfig {
id
name
teamId
createdByUserId
updatedByUserId
updatedByUser {
...UserFragment
}
llmRagConfigId
llmRagConfig {
...LlmRagConfigFragment
}
createdAt
updatedAt
isDeleted
}
llmEvaluationExecutionId
ragConfigSourceType
createdAt
updatedAt
isDeleted
applicationName
}
}
Variables
{"llmEvaluationId": 4}
Response
{
"data": {
"getLlmEvaluationRagConfigsByLlmEvaluationId": [
{
"id": "4",
"llmEvaluationId": "4",
"llmApplication": LlmApplication,
"llmPlaygroundRagConfig": LlmApplicationPlaygroundRagConfig,
"llmDeploymentRagConfig": LlmApplicationDeployment,
"llmRagConfigId": "4",
"llmSnapshotRagConfig": LlmRagConfig,
"llmApplicationConfigurationRagConfig": LlmApplicationConfiguration,
"llmEvaluationExecutionId": "4",
"ragConfigSourceType": "APPLICATION_DEPLOYMENT",
"createdAt": "abc123",
"updatedAt": "abc123",
"isDeleted": false,
"applicationName": "xyz789"
}
]
}
}
getLlmEvaluationRagConfigsByLlmEvaluationIds
Breaking changes may be introduced anytime in the future without prior notice.
Description
Retrieves the LLM evaluation RAG configs by the LLM evaluation ids.
Response
Returns [LlmEvaluationRagConfig!]!
Example
Query
query GetLlmEvaluationRagConfigsByLlmEvaluationIds(
$llmEvaluationIds: [ID!]!,
$withDeleted: Boolean
) {
getLlmEvaluationRagConfigsByLlmEvaluationIds(
llmEvaluationIds: $llmEvaluationIds,
withDeleted: $withDeleted
) {
id
llmEvaluationId
llmApplication {
id
teamId
createdByUser {
...UserFragment
}
name
status
createdAt
updatedAt
llmApplicationDeployment {
...LlmApplicationDeploymentFragment
}
totalRagConfigs
}
llmPlaygroundRagConfig {
id
llmApplicationId
llmRagConfig {
...LlmRagConfigFragment
}
name
createdAt
updatedAt
}
llmDeploymentRagConfig {
id
deployedByUser {
...UserFragment
}
llmApplicationId
llmApplication {
...LlmApplicationFragment
}
llmRagConfig {
...LlmRagConfigFragment
}
numberOfCalls
numberOfTokens
numberOfInputTokens
numberOfOutputTokens
deployedAt
name
status
createdAt
updatedAt
apiEndpoints {
...LlmApplicationDeploymentApiEndpointFragment
}
isDeleted
}
llmRagConfigId
llmSnapshotRagConfig {
id
llmModel {
...LlmModelFragment
}
systemInstruction
userInstruction
raw
temperature
topP
maxTokens
advancedHyperparameters
maxVectorStoreTokens
llmVectorStore {
...LlmVectorStoreFragment
}
llmVectorStores {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
maxChunkSize
createdAt
updatedAt
}
llmApplicationConfigurationRagConfig {
id
name
teamId
createdByUserId
updatedByUserId
updatedByUser {
...UserFragment
}
llmRagConfigId
llmRagConfig {
...LlmRagConfigFragment
}
createdAt
updatedAt
isDeleted
}
llmEvaluationExecutionId
ragConfigSourceType
createdAt
updatedAt
isDeleted
applicationName
}
}
Variables
{
"llmEvaluationIds": ["4"],
"withDeleted": true
}
Response
{
"data": {
"getLlmEvaluationRagConfigsByLlmEvaluationIds": [
{
"id": "4",
"llmEvaluationId": 4,
"llmApplication": LlmApplication,
"llmPlaygroundRagConfig": LlmApplicationPlaygroundRagConfig,
"llmDeploymentRagConfig": LlmApplicationDeployment,
"llmRagConfigId": "4",
"llmSnapshotRagConfig": LlmRagConfig,
"llmApplicationConfigurationRagConfig": LlmApplicationConfiguration,
"llmEvaluationExecutionId": 4,
"ragConfigSourceType": "APPLICATION_DEPLOYMENT",
"createdAt": "xyz789",
"updatedAt": "abc123",
"isDeleted": true,
"applicationName": "xyz789"
}
]
}
}
getLlmEvaluationReport
Example
Query
query GetLlmEvaluationReport($projectId: String!) {
getLlmEvaluationReport(projectId: $projectId) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"projectId": "xyz789"}
Response
{
"data": {
"getLlmEvaluationReport": {
"id": "abc123",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "xyz789",
"retryCount": 987,
"maxRetry": 987,
"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
}
scheduledCommandConfig {
...ScheduledCommandConfigFragment
}
isScheduled
createdAt
updatedAt
isDeleted
type
schedulingStatus
nextSchedule
createdByUser {
...UserFragment
}
lastScoredByUser {
...UserFragment
}
totalPrompts
lastLlmEvaluationExecution {
...LlmEvaluationExecutionFragment
}
}
totalPromptCount
totalUnansweredPromptCount
totalFailedThresholdCompletionsCount
summaries {
llmEvaluationRagConfigId
cost
processingTime
scores {
...LlmEvaluationEvaluatorSummaryFragment
}
}
}
}
Variables
{"id": "4", "llmEvaluationExecutionId": 4}
Response
{
"data": {
"getLlmEvaluationSummary": {
"llmEvaluationId": 4,
"llmEvaluation": LlmEvaluation,
"totalPromptCount": 987,
"totalUnansweredPromptCount": 123,
"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
}
scheduledCommandConfig {
...ScheduledCommandConfigFragment
}
isScheduled
createdAt
updatedAt
isDeleted
type
schedulingStatus
nextSchedule
createdByUser {
...UserFragment
}
lastScoredByUser {
...UserFragment
}
totalPrompts
lastLlmEvaluationExecution {
...LlmEvaluationExecutionFragment
}
}
}
}
Variables
{"input": GetLlmEvaluationsPaginatedInput}
Response
{
"data": {
"getLlmEvaluations": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [LlmEvaluation]
}
}
}
getLlmGeneratedInstruction
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - GetLlmGeneratedInstructionInput!
|
Example
Query
query GetLlmGeneratedInstruction($input: GetLlmGeneratedInstructionInput!) {
getLlmGeneratedInstruction(input: $input)
}
Variables
{"input": GetLlmGeneratedInstructionInput}
Response
{
"data": {
"getLlmGeneratedInstruction": "abc123"
}
}
getLlmManualEvaluationSummary
Breaking changes may be introduced anytime in the future without prior notice.
Description
Retrieves the LLM manual evaluation summary based on the provided id.
Response
Returns a LlmManualEvaluationSummary!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetLlmManualEvaluationSummary($id: ID!) {
getLlmManualEvaluationSummary(id: $id) {
llmEvaluationId
totalPromptCount
totalScoredPromptCount
averageScore
applicationSummaries {
llmEvaluationRagConfigId
totalCost
averageProcessingTime
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"getLlmManualEvaluationSummary": {
"llmEvaluationId": "4",
"totalPromptCount": 123,
"totalScoredPromptCount": 987,
"averageScore": 123.45,
"applicationSummaries": [
LlmManualEvaluationApplicationSummary
]
}
}
}
getLlmModelDetails
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns [LlmModelDetail!]!
Example
Query
query GetLlmModelDetails(
$teamId: ID!,
$ids: [ID!]
) {
getLlmModelDetails(
teamId: $teamId,
ids: $ids
) {
modelId
modelType
status
instanceType
instanceTypeDetail {
name
cost {
...LlmInstanceCostDetailFragment
}
createdAt
}
}
}
Variables
{"teamId": "4", "ids": [4]}
Response
{
"data": {
"getLlmModelDetails": [
{
"modelId": "4",
"modelType": "LLM_MODEL",
"status": "AVAILABLE",
"instanceType": "abc123",
"instanceTypeDetail": LlmInstanceTypeDetail
}
]
}
}
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
retryCount
maxRetry
additionalData {
...JobAdditionalDataFragment
}
}
name
}
}
Variables
{"input": LlmModelFineTuningCostPredictionInput}
Response
{
"data": {
"getLlmModelFineTuningCostPredictionAsync": {
"job": Job,
"name": "xyz789"
}
}
}
getLlmModelMetadatas
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns [LlmModelMetadata!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetLlmModelMetadatas($teamId: ID!) {
getLlmModelMetadatas(teamId: $teamId) {
providers
name
displayName
description
type
status
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getLlmModelMetadatas": [
{
"providers": ["AMAZON_BEDROCK"],
"name": "xyz789",
"displayName": "xyz789",
"description": "xyz789",
"type": "QUESTION_ANSWERING",
"status": "AVAILABLE"
}
]
}
}
getLlmModelSpec
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmModelSpec!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
|
provider - GqlLlmModelProvider!
|
|
name - String!
|
Example
Query
query GetLlmModelSpec(
$teamId: ID!,
$provider: GqlLlmModelProvider!,
$name: String!
) {
getLlmModelSpec(
teamId: $teamId,
provider: $provider,
name: $name
) {
supportedInferenceInstanceTypes
supportedInferenceInstanceTypeDetails {
name
cost {
...LlmInstanceCostDetailFragment
}
createdAt
}
}
}
Variables
{
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "abc123"
}
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
teamId
provider
name
displayName
url
region
maxTemperature
maxTopP
maxTokens
maxContextWindow
defaultTemperature
defaultTopP
defaultMaxTokens
minTemperature
minTopP
llmModelFineTuningJob {
id
name
teamId
status
errorMessage
baseModelId
parentId
resultModelId
trainingJobId
trainingDataset {
...GroundTruthSetFragment
}
trainingDatasetFilename
validationSize
validationDataset {
...GroundTruthSetFragment
}
validationDatasetFilename
epochs
learningRate
batchSize
earlyStoppingThreshold
earlyStoppingPatience
learningRateWarmUpStep
learningRateMultiplier
instanceType
trainingVolumeSize
trainingBucketName
optionalHyperparameters
createdByUser {
...UserFragment
}
createdAt
updatedAt
}
deployableModelId
isModelDeployable
forceAnonymization
hasVisionCapability
variant
createdAt
updatedAt
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getLlmModels": [
{
"id": "4",
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "xyz789",
"displayName": "xyz789",
"url": "xyz789",
"region": ["abc123"],
"maxTemperature": 987.65,
"maxTopP": 987.65,
"maxTokens": 123,
"maxContextWindow": 123,
"defaultTemperature": 123.45,
"defaultTopP": 987.65,
"defaultMaxTokens": 987,
"minTemperature": 987.65,
"minTopP": 123.45,
"llmModelFineTuningJob": LlmModelFineTuningJob,
"deployableModelId": "abc123",
"isModelDeployable": false,
"forceAnonymization": false,
"hasVisionCapability": false,
"variant": "META",
"createdAt": "xyz789",
"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 |
|---|---|
input - GetLlmVectorStoreInput!
|
Example
Query
query GetLlmVectorStore($input: GetLlmVectorStoreInput!) {
getLlmVectorStore(input: $input) {
id
teamId
createdByUser {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
llmEmbeddingModel {
id
teamId
provider
name
displayName
url
maxTokens
dimensions
deployableModelId
isModelDeployable
createdAt
updatedAt
variant
customDimension
}
provider
collectionId
name
status
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
targetEntity
}
jobId
chunkConfiguration
filePropertiesExtractorConfiguration {
type
configuration
syncedFilePropertiesJsonSchema
}
urlSyncScheduledCommandConfig {
id
cronPattern
repeatInterval
runImmediately
endTime
numberOfRepetition
isNeverEnding
isPeriodic
updatedAt
}
urlSyncNextSchedule
urlSyncLastSyncedAt
createdAt
updatedAt
dimension
}
}
Variables
{"input": GetLlmVectorStoreInput}
Response
{
"data": {
"getLlmVectorStore": {
"id": 4,
"teamId": 4,
"createdByUser": User,
"llmEmbeddingModel": LlmEmbeddingModel,
"provider": "DATASAUR",
"collectionId": "xyz789",
"name": "xyz789",
"status": "CREATED",
"documents": [LlmVectorStoreDocumentScalar],
"documentStatusCount": LlmVectorStoreDocumentCountByStatus,
"sourceDocuments": [LlmVectorStoreSourceDocument],
"questions": [Question],
"jobId": "abc123",
"chunkConfiguration": ChunkConfiguration,
"filePropertiesExtractorConfiguration": LlmVectorStoreFilePropertiesExtractorConfiguration,
"urlSyncScheduledCommandConfig": ScheduledCommandConfig,
"urlSyncNextSchedule": "abc123",
"urlSyncLastSyncedAt": "xyz789",
"createdAt": "xyz789",
"updatedAt": "abc123",
"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
updateLlmVectorStoreDocumentInput {
...UpdateLlmVectorStoreDocumentFragment
}
createdAt
updatedAt
}
}
}
Variables
{"input": GetLlmVectorStoreActivityInput}
Response
{
"data": {
"getLlmVectorStoreActivities": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [LlmVectorStoreActivity]
}
}
}
getLlmVectorStoreAnswers
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmVectorStoreAnswer!
Arguments
| Name | Description |
|---|---|
llmVectorStoreDocumentId - ID!
|
Example
Query
query GetLlmVectorStoreAnswers($llmVectorStoreDocumentId: ID!) {
getLlmVectorStoreAnswers(llmVectorStoreDocumentId: $llmVectorStoreDocumentId) {
llmVectorStoreDocumentId
answers
updatedAt
}
}
Variables
{"llmVectorStoreDocumentId": 4}
Response
{
"data": {
"getLlmVectorStoreAnswers": {
"llmVectorStoreDocumentId": "4",
"answers": AnswerScalar,
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
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
previewFileName
type
status
errorMessage
llmVectorStoreSource {
id
llmVectorStoreId
externalObjectStorage {
...ExternalObjectStorageFragment
}
rules {
...LlmVectorStoreSourceRulesFragment
}
scheduledCommandConfig {
...ScheduledCommandConfigFragment
}
nextSchedule
lastSyncedAt
isDeleting
createdAt
updatedAt
}
llmVectorStoreSourceId
chunkConfiguration
transcriptionPath
processingPriority
version
createdAt
updatedAt
}
}
Variables
{"id": 4, "fileId": "4"}
Response
{
"data": {
"getLlmVectorStoreDocument": {
"id": "4",
"name": "xyz789",
"objectKey": "xyz789",
"path": "abc123",
"previewPath": "xyz789",
"previewFileName": "abc123",
"type": "FOLDER",
"status": "QUEUED",
"errorMessage": "xyz789",
"llmVectorStoreSource": LlmVectorStoreSource,
"llmVectorStoreSourceId": "4",
"chunkConfiguration": ChunkConfiguration,
"transcriptionPath": "abc123",
"processingPriority": 987,
"version": "abc123",
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
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
previewFileName
type
status
errorMessage
llmVectorStoreSourceId
chunkConfiguration
previewObjectKey
transcriptionPath
processingPriority
createdAt
updatedAt
}
}
}
Variables
{
"llmVectorStoreId": 4,
"input": GetLlmVectorStoreDocumentsPaginatedInput,
"disableFetchCount": false
}
Response
{
"data": {
"getLlmVectorStoreDocumentsPaginated": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [LlmVectorStoreDocumentPaginationItem]
}
}
}
getLlmVectorStoreLocalDocumentNames
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns [String!]!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetLlmVectorStoreLocalDocumentNames($id: ID!) {
getLlmVectorStoreLocalDocumentNames(id: $id)
}
Variables
{"id": "4"}
Response
{
"data": {
"getLlmVectorStoreLocalDocumentNames": [
"abc123"
]
}
}
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
}
}
getLlmVectorStoreSourceDocumentPreviewPath
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - GetLlmVectorStoreSourceDocumentPreviewPathInput!
|
Example
Query
query GetLlmVectorStoreSourceDocumentPreviewPath($input: GetLlmVectorStoreSourceDocumentPreviewPathInput!) {
getLlmVectorStoreSourceDocumentPreviewPath(input: $input)
}
Variables
{"input": GetLlmVectorStoreSourceDocumentPreviewPathInput}
Response
{
"data": {
"getLlmVectorStoreSourceDocumentPreviewPath": "abc123"
}
}
getLlmVectorStoreSourceNewDocuments
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmVectorStoreSourceDocumentScalar!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
|
provider - String!
|
|
input - LlmVectorStoreSourceCreateInput!
|
Example
Query
query GetLlmVectorStoreSourceNewDocuments(
$teamId: ID!,
$provider: String!,
$input: LlmVectorStoreSourceCreateInput!
) {
getLlmVectorStoreSourceNewDocuments(
teamId: $teamId,
provider: $provider,
input: $input
)
}
Variables
{
"teamId": 4,
"provider": "abc123",
"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
name
effectiveName
credentials {
...ExternalObjectStorageCredentialsFragment
}
securityToken
team {
...TeamFragment
}
projects {
...ProjectFragment
}
readOnly
createdAt
updatedAt
}
rules {
includeRule {
...LlmVectorStoreSourceRuleFragment
}
excludeRule {
...LlmVectorStoreSourceRuleFragment
}
}
scheduledCommandConfig {
id
cronPattern
repeatInterval
runImmediately
endTime
numberOfRepetition
isNeverEnding
isPeriodic
updatedAt
}
nextSchedule
lastSyncedAt
isDeleting
createdAt
updatedAt
}
}
Variables
{"llmVectorStoreId": 4}
Response
{
"data": {
"getLlmVectorStoreSources": [
{
"id": 4,
"llmVectorStoreId": "4",
"externalObjectStorage": ExternalObjectStorage,
"rules": LlmVectorStoreSourceRules,
"scheduledCommandConfig": ScheduledCommandConfig,
"nextSchedule": "abc123",
"lastSyncedAt": "xyz789",
"isDeleting": false,
"createdAt": "abc123",
"updatedAt": "xyz789"
}
]
}
}
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
documents
documentStatusCount {
...LlmVectorStoreDocumentCountByStatusFragment
}
sourceDocuments {
...LlmVectorStoreSourceDocumentFragment
}
questions {
...QuestionFragment
}
jobId
chunkConfiguration
filePropertiesExtractorConfiguration {
...LlmVectorStoreFilePropertiesExtractorConfigurationFragment
}
urlSyncScheduledCommandConfig {
...ScheduledCommandConfigFragment
}
urlSyncNextSchedule
urlSyncLastSyncedAt
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}}
getMultiChannelWaveformPeaks
Description
Generate audiowaveform data for a multichannel audio project. Waveform data generated by using https://github.com/bbc/audiowaveform
Response
Returns [WaveformPeaks!]!
Example
Query
query GetMultiChannelWaveformPeaks(
$documentId: String!,
$pixelPerSecond: Int,
$regenerateIfEmpty: Boolean
) {
getMultiChannelWaveformPeaks(
documentId: $documentId,
pixelPerSecond: $pixelPerSecond,
regenerateIfEmpty: $regenerateIfEmpty
) {
channel
peaks
pixelPerSecond
}
}
Variables
{
"documentId": "xyz789",
"pixelPerSecond": 987,
"regenerateIfEmpty": true
}
Response
{
"data": {
"getMultiChannelWaveformPeaks": [
{"channel": 123, "peaks": [123.45], "pixelPerSecond": 987}
]
}
}
getMyOauthConnectedApplications
Response
Returns [OauthConnectedApplication!]!
Example
Query
query GetMyOauthConnectedApplications {
getMyOauthConnectedApplications {
clientId
name
scopes
teamName
connectedAt
}
}
Response
{
"data": {
"getMyOauthConnectedApplications": [
{
"clientId": "4",
"name": "abc123",
"scopes": ["abc123"],
"teamName": "xyz789",
"connectedAt": "2007-12-03T10:15:30Z"
}
]
}
}
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
}
}
}
getOauthAuthorizationRequest
Response
Returns an OauthAuthorizationRequest!
Example
Query
query GetOauthAuthorizationRequest(
$clientId: ID!,
$scope: [String!],
$redirectUri: String
) {
getOauthAuthorizationRequest(
clientId: $clientId,
scope: $scope,
redirectUri: $redirectUri
) {
appName
scopes {
scopeKey
label
mcpUrl
}
isTeamMember
teamName
redirectUri
}
}
Variables
{
"clientId": "4",
"scope": ["abc123"],
"redirectUri": "abc123"
}
Response
{
"data": {
"getOauthAuthorizationRequest": {
"appName": "abc123",
"scopes": [OauthAuthorizationScope],
"isTeamMember": false,
"teamName": "abc123",
"redirectUri": "xyz789"
}
}
}
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": ["xyz789"]}
Response
{
"data": {
"getOverallProjectPerformance": {
"total": 123,
"completed": 987,
"inReview": 123,
"reviewReady": 123,
"inProgress": 123,
"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": 123,
"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
systemInstruction
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
updatedByUserId
updatedByUser {
...UserFragment
}
llmRagConfigId
llmRagConfig {
...LlmRagConfigFragment
}
createdAt
updatedAt
isDeleted
}
}
}
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
}
kinds
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": ["xyz789"],
"method": "COHENS_KAPPA",
"projectIds": [4]
}
Response
{"data": {"getPairKappas": [{"userId1": 123, "userId2": 123, "kappa": 123.45}]}}
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
throttledUntil
detail {
type
fundingType
displayBrand
creditCardLastFourNumber
creditCardExpiryMonth
creditCardExpiryYear
markedForRemoval
status
invalidStatusReason
createdAt
updatedAt
}
}
}
Variables
{
"teamId": 4,
"stripePaymentMethodId": "abc123"
}
Response
{
"data": {
"getPaymentMethod": {
"hasPaymentMethod": true,
"throttledUntil": "abc123",
"detail": PaymentMethodDetail
}
}
}
getPaymentMethodTemporaryChargeConfiguration
Breaking changes may be introduced anytime in the future without prior notice.
Response
Example
Query
query GetPaymentMethodTemporaryChargeConfiguration {
getPaymentMethodTemporaryChargeConfiguration {
amountCents
currencyISO
currencySymbol
}
}
Response
{
"data": {
"getPaymentMethodTemporaryChargeConfiguration": {
"amountCents": 987,
"currencyISO": "xyz789",
"currencySymbol": "xyz789"
}
}
}
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
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
}
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
}
anonymizationMaskedColumnNames
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
leafOnlyOption
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
kinds
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
type
description
imagePreviewURL
videoURL
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getPinnedProjectTemplates": [
{
"id": "4",
"name": "abc123",
"logoURL": "xyz789",
"projectTemplateProjectSettingId": 4,
"projectTemplateTextDocumentSettingId": 4,
"projectTemplateProjectSetting": ProjectTemplateProjectSetting,
"projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
"labelSetTemplates": [LabelSetTemplate],
"questionSets": [QuestionSet],
"createdAt": "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!],
$withAttachments: Boolean
) {
getPlaygroundCostPrediction(
llmApplicationId: $llmApplicationId,
promptId: $promptId,
playgroundRagConfigIds: $playgroundRagConfigIds,
withAttachments: $withAttachments
) {
costPerPromptTemplate {
promptTemplateId
promptTemplateName
modelName
tokens {
...TokenUsagesFragment
}
tokenUnitPrices {
...TokenUnitPricesFragment
}
tokenPrices {
...TokenPricesFragment
}
coveredByDatasaur
pricingUsageType
embeddingPricingUsageType
}
totalChars {
coveredByDatasaur
notCoveredByDatasaur
total
}
totalTokens {
coveredByDatasaur
notCoveredByDatasaur
total
}
totalPrice {
coveredByDatasaur
notCoveredByDatasaur
total
}
}
}
Variables
{
"llmApplicationId": 4,
"promptId": 4,
"playgroundRagConfigIds": [4],
"withAttachments": true
}
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": 987}}
getPredictedLabels
Response
Returns [TextLabel!]!
Arguments
| Name | Description |
|---|---|
input - GetPredictedLabelsInput!
|
Example
Query
query GetPredictedLabels($input: GetPredictedLabelsInput!) {
getPredictedLabels(input: $input) {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
labeledByUserId
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
sentenceId
tokenId
charId
}
end {
sentenceId
tokenId
charId
}
confidenceScore
status
customAttribute
}
}
Variables
{"input": GetPredictedLabelsInput}
Response
{
"data": {
"getPredictedLabels": [
{
"id": "xyz789",
"l": "xyz789",
"layer": 987,
"deleted": false,
"hashCode": "xyz789",
"labeledBy": "AUTO",
"labeledByUser": User,
"labeledByUserId": 987,
"acceptedByUserId": "4",
"rejectedByUserId": "4",
"createdAt": "abc123",
"updatedAt": "abc123",
"documentId": "abc123",
"start": TextCursor,
"end": TextCursor,
"confidenceScore": 123.45,
"status": "LABELED",
"customAttribute": "abc123"
}
]
}
}
getPredictedLabelsPaginated
Response
Returns a GetLabelsPaginatedResponse!
Arguments
| Name | Description |
|---|---|
input - GetPredictedLabelsPaginatedInput!
|
Example
Query
query GetPredictedLabelsPaginated($input: GetPredictedLabelsPaginatedInput!) {
getPredictedLabelsPaginated(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes
}
}
Variables
{"input": GetPredictedLabelsPaginatedInput}
Response
{
"data": {
"getPredictedLabelsPaginated": {
"totalCount": 123,
"pageInfo": PageInfo,
"nodes": [TextLabelScalar]
}
}
}
getPredictedRowAnswers
Response
Returns [RowAnswer!]!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
Example
Query
query GetPredictedRowAnswers($documentId: ID!) {
getPredictedRowAnswers(documentId: $documentId) {
documentId
line
answers
metadata {
path
labeledBy
labeledByUserId
createdAt
updatedAt
}
updatedAt
}
}
Variables
{"documentId": 4}
Response
{
"data": {
"getPredictedRowAnswers": [
{
"documentId": "4",
"line": 987,
"answers": AnswerScalar,
"metadata": [AnswerMetadata],
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
getPredictedRowAnswersPaginated
Response
Returns a GetRowAnswersPaginatedResponse!
Arguments
| Name | Description |
|---|---|
input - GetPredictedRowAnswersPaginatedInput!
|
Example
Query
query GetPredictedRowAnswersPaginated($input: GetPredictedRowAnswersPaginatedInput!) {
getPredictedRowAnswersPaginated(input: $input) {
totalCount
pageInfo {
prevCursor
nextCursor
}
nodes {
documentId
line
answers
metadata {
...AnswerMetadataFragment
}
updatedAt
}
}
}
Variables
{"input": GetPredictedRowAnswersPaginatedInput}
Response
{
"data": {
"getPredictedRowAnswersPaginated": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [RowAnswer]
}
}
}
getProcessingConfigurationSchema
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a ProcessingConfigurationSchema
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetProcessingConfigurationSchema($id: ID!) {
getProcessingConfigurationSchema(id: $id)
}
Variables
{"id": "4"}
Response
{
"data": {
"getProcessingConfigurationSchema": ProcessingConfigurationSchema
}
}
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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
taskScope {
...TaskScopeFragment
}
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
enableRapidLabelingFeedback
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
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
}
anonymizationMaskedColumnIds
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
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
}
availableDocumentsCount
}
}
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": "abc123",
"exportedDate": "xyz789",
"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],
"availableDocumentsCount": 987
}
}
}
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
samlId
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": "abc123",
"numberOfConflicts": 987
}
]
}
}
getProjectContributors
Response
Returns [CabinetContributor!]!
Example
Query
query GetProjectContributors(
$teamId: ID!,
$projectId: ID!
) {
getProjectContributors(
teamId: $teamId,
projectId: $projectId
) {
cabinetId
cabinetOwnerId
contributors {
id
samlId
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": 123,
"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
targetEntity
}
signature
}
}
Variables
{"projectId": "4"}
Response
{
"data": {
"getProjectDocumentQuestionSet": {
"questions": [Question],
"signature": "xyz789"
}
}
}
getProjectExtension
Response
Returns a ProjectExtension
Arguments
| Name | Description |
|---|---|
cabinetId - ID!
|
Example
Query
query GetProjectExtension($cabinetId: ID!) {
getProjectExtension(cabinetId: $cabinetId) {
id
cabinetId
elements {
id
enabled
extension {
...ExtensionFragment
}
height
order
setting {
...ExtensionElementSettingFragment
}
}
width
}
}
Variables
{"cabinetId": "4"}
Response
{
"data": {
"getProjectExtension": {
"id": 4,
"cabinetId": "4",
"elements": [ExtensionElement],
"width": 987
}
}
}
getProjectLabelersDocumentStatus
Response
Arguments
| Name | Description |
|---|---|
input - GetProjectInput
|
Example
Query
query GetProjectLabelersDocumentStatus($input: GetProjectInput) {
getProjectLabelersDocumentStatus(input: $input) {
originId
assignedLabelers {
id
user {
...UserFragment
}
userId
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
labelingAgent {
...LabelingAgentFragment
}
labelingAgentId
}
startedLabelers {
id
user {
...UserFragment
}
userId
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
labelingAgent {
...LabelingAgentFragment
}
labelingAgentId
}
completedLabelers {
id
user {
...UserFragment
}
userId
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
labelingAgent {
...LabelingAgentFragment
}
labelingAgentId
}
}
}
Variables
{"input": GetProjectInput}
Response
{
"data": {
"getProjectLabelersDocumentStatus": [
{
"originId": 4,
"assignedLabelers": [TeamMember],
"startedLabelers": [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": 987,
"pageInfo": PageInfo,
"nodes": [ProjectMetadataItem]
}
}
}
getProjectPrelabeledCounts
Description
Returns prelabeled label counts per kind for a project, or for a single document (any cabinet's copy) when documentId is given. Independent of any specific labeler.
Response
Returns [PrelabeledCountItem!]!
Example
Query
query GetProjectPrelabeledCounts(
$projectId: ID!,
$documentId: ID
) {
getProjectPrelabeledCounts(
projectId: $projectId,
documentId: $documentId
) {
kind
labelEntityType
count
}
}
Variables
{"projectId": 4, "documentId": "4"}
Response
{
"data": {
"getProjectPrelabeledCounts": [
{"kind": "DOCUMENT_BASED", "labelEntityType": "AUDIO", "count": 123}
]
}
}
getProjectReviewingStatus
Description
Returns reviewing status for a single project.
Response
Returns a ReviewingStatus!
Arguments
| Name | Description |
|---|---|
input - GetProjectInput!
|
Example
Query
query GetProjectReviewingStatus($input: GetProjectInput!) {
getProjectReviewingStatus(input: $input) {
isCompleted
statistic {
numberOfDocuments
numberOfLabeledDocuments
}
}
}
Variables
{"input": GetProjectInput}
Response
{
"data": {
"getProjectReviewingStatus": {
"isCompleted": true,
"statistic": ReviewingStatusStatistic
}
}
}
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
targetEntity
}
signature
}
}
Variables
{"projectId": 4}
Response
{
"data": {
"getProjectRowQuestionSet": {
"questions": [Question],
"signature": "abc123"
}
}
}
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": "abc123"
}
}
}
getProjectSamples
Description
Returns a list of ProjectSample matching the given name
Response
Returns [ProjectSample!]!
Arguments
| Name | Description |
|---|---|
displayName - String
|
Example
Query
query GetProjectSamples($displayName: String) {
getProjectSamples(displayName: $displayName) {
id
displayName
exportableJSON
}
}
Variables
{"displayName": "abc123"}
Response
{
"data": {
"getProjectSamples": [
{
"id": "4",
"displayName": "xyz789",
"exportableJSON": "xyz789"
}
]
}
}
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
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
}
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
}
anonymizationMaskedColumnNames
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
leafOnlyOption
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
kinds
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getProjectTemplate": {
"id": 4,
"name": "abc123",
"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
}
}
}
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
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
}
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
}
anonymizationMaskedColumnNames
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
leafOnlyOption
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
kinds
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
type
description
imagePreviewURL
videoURL
}
}
Variables
{"id": 4}
Response
{
"data": {
"getProjectTemplateV2": {
"id": 4,
"name": "xyz789",
"logoURL": "xyz789",
"projectTemplateProjectSettingId": 4,
"projectTemplateTextDocumentSettingId": 4,
"projectTemplateProjectSetting": ProjectTemplateProjectSetting,
"projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
"labelSetTemplates": [LabelSetTemplate],
"questionSets": [QuestionSet],
"createdAt": "xyz789",
"updatedAt": "xyz789",
"purpose": "LABELING",
"creatorId": 4,
"type": "CUSTOM",
"description": "abc123",
"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
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
}
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
}
anonymizationMaskedColumnNames
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
leafOnlyOption
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
kinds
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getProjectTemplates": [
{
"id": "4",
"name": "abc123",
"teamId": "4",
"team": Team,
"logoURL": "xyz789",
"projectTemplateProjectSettingId": "4",
"projectTemplateTextDocumentSettingId": "4",
"projectTemplateProjectSetting": ProjectTemplateProjectSetting,
"projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
"labelSetTemplates": [LabelSetTemplate],
"questionSets": [QuestionSet],
"createdAt": "abc123",
"updatedAt": "xyz789",
"purpose": "LABELING",
"creatorId": "4"
}
]
}
}
getProjectTemplatesV2
Response
Returns [ProjectTemplateV2!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetProjectTemplatesV2($teamId: ID!) {
getProjectTemplatesV2(teamId: $teamId) {
id
name
logoURL
projectTemplateProjectSettingId
projectTemplateTextDocumentSettingId
projectTemplateProjectSetting {
autoMarkDocumentAsComplete
enableEditLabelSet
enableEditSentence
enableLabelerProjectCompletionNotificationThreshold
enableReviewerEditSentence
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
}
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
}
anonymizationMaskedColumnNames
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
leafOnlyOption
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
kinds
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
type
description
imagePreviewURL
videoURL
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getProjectTemplatesV2": [
{
"id": "4",
"name": "xyz789",
"logoURL": "xyz789",
"projectTemplateProjectSettingId": "4",
"projectTemplateTextDocumentSettingId": 4,
"projectTemplateProjectSetting": ProjectTemplateProjectSetting,
"projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
"labelSetTemplates": [LabelSetTemplate],
"questionSets": [QuestionSet],
"createdAt": "abc123",
"updatedAt": "xyz789",
"purpose": "LABELING",
"creatorId": 4,
"type": "CUSTOM",
"description": "abc123",
"imagePreviewURL": "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
}
availableDocumentsCount
}
}
}
Variables
{"input": GetProjectsPaginatedInput}
Response
{
"data": {
"getProjects": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [Project]
}
}
}
getProjectsFinalReport
Response
Returns [ProjectFinalReport!]!
Arguments
| Name | Description |
|---|---|
projectIds - [ID!]!
|
Example
Query
query GetProjectsFinalReport($projectIds: [ID!]!) {
getProjectsFinalReport(projectIds: $projectIds) {
project {
id
team {
...TeamFragment
}
teamId
owner {
...UserFragment
}
externalObjectStorageId
rootDocumentId
assignees {
...ProjectAssignmentFragment
}
name
tags {
...TagFragment
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
...ProjectSettingsFragment
}
workspaceSettings {
...WorkspaceSettingsFragment
}
reviewingStatus {
...ReviewingStatusFragment
}
labelingStatus {
...LabelingStatusFragment
}
status
performance {
...ProjectPerformanceFragment
}
selfLabelingStatus
purpose
rootCabinet {
...CabinetFragment
}
reviewCabinet {
...CabinetFragment
}
labelerCabinets {
...CabinetFragment
}
guideline {
...GuidelineFragment
}
isArchived
projectMetadataItems {
...ProjectMetadataItemFragment
}
availableDocumentsCount
}
documentFinalReports {
rowFinalReports {
...RowFinalReportFragment
}
cabinet {
...CabinetFragment
}
document {
...TextDocumentFragment
}
finalReport {
...FinalReportFragment
}
teamMember {
...TeamMemberFragment
}
}
}
}
Variables
{"projectIds": ["4"]}
Response
{
"data": {
"getProjectsFinalReport": [
{
"project": Project,
"documentFinalReports": [DocumentFinalReport]
}
]
}
}
getProjectsLabelingStatuses
Description
Returns labeling status for several projects.
Response
Returns [ProjectLabelingStatusResult!]!
Arguments
| Name | Description |
|---|---|
input - GetMultipleProjectsInput!
|
Example
Query
query GetProjectsLabelingStatuses($input: GetMultipleProjectsInput!) {
getProjectsLabelingStatuses(input: $input) {
projectId
labelingStatus {
labeler {
...TeamMemberFragment
}
isCompleted
isStarted
statistic {
...LabelingStatusStatisticFragment
}
statisticsToShow {
...StatisticItemFragment
}
}
}
}
Variables
{"input": GetMultipleProjectsInput}
Response
{
"data": {
"getProjectsLabelingStatuses": [
{"projectId": 4, "labelingStatus": [LabelingStatus]}
]
}
}
getProjectsMinimumLabelingStatuses
Description
Returns labeling status for several projects except statistics.
Response
Arguments
| Name | Description |
|---|---|
input - GetMultipleProjectsInput!
|
Example
Query
query GetProjectsMinimumLabelingStatuses($input: GetMultipleProjectsInput!) {
getProjectsMinimumLabelingStatuses(input: $input) {
projectId
labelingStatus {
labeler {
...TeamMemberFragment
}
isCompleted
isStarted
}
}
}
Variables
{"input": GetMultipleProjectsInput}
Response
{
"data": {
"getProjectsMinimumLabelingStatuses": [
{
"projectId": 4,
"labelingStatus": [MinimumLabelingStatus]
}
]
}
}
getProjectsPerformances
Description
Returns performance metrics for a specific project.
Response
Returns [ProjectPerformanceResult!]!
Arguments
| Name | Description |
|---|---|
input - GetMultipleProjectsInput!
|
Example
Query
query GetProjectsPerformances($input: GetMultipleProjectsInput!) {
getProjectsPerformances(input: $input) {
projectId
performance {
project {
...ProjectFragment
}
projectId
totalTimeSpent
effectiveTotalTimeSpent
conflicts
totalLabelApplied
numberOfAcceptedLabels
numberOfDocuments
numberOfTokens
numberOfLines
}
}
}
Variables
{"input": GetMultipleProjectsInput}
Response
{
"data": {
"getProjectsPerformances": [
{"projectId": 4, "performance": ProjectPerformance}
]
}
}
getProjectsReviewingStatuses
Description
Returns reviewing status for several projects.
Response
Returns [ProjectReviewingStatusResult!]!
Arguments
| Name | Description |
|---|---|
input - GetMultipleProjectsInput!
|
Example
Query
query GetProjectsReviewingStatuses($input: GetMultipleProjectsInput!) {
getProjectsReviewingStatuses(input: $input) {
projectId
reviewingStatus {
isCompleted
statistic {
...ReviewingStatusStatisticFragment
}
}
}
}
Variables
{"input": GetMultipleProjectsInput}
Response
{
"data": {
"getProjectsReviewingStatuses": [
{
"projectId": "4",
"reviewingStatus": ReviewingStatus
}
]
}
}
getQuestionSet
Response
Returns a QuestionSet!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetQuestionSet($id: ID!) {
getQuestionSet(id: $id) {
name
id
creator {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
items {
id
index
questionSetId
label
type
hint
multipleAnswer
required
bindToColumn
activationConditionLogic
createdAt
updatedAt
options {
...DropdownConfigOptionsFragment
}
leafOptionsOnly
format
defaultValue
max
min
theme
gradientColors
step
hideScaleLabel
multiline
maxLength
minLength
pattern
customScript {
...CustomScriptFragment
}
nestedQuestions {
...QuestionSetItemFragment
}
parentId
}
kinds
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getQuestionSet": {
"name": "xyz789",
"id": "4",
"creator": User,
"items": [QuestionSetItem],
"kinds": ["DOCUMENT_BASED"],
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
getQuestionSetTemplate
Response
Returns a QuestionSetTemplate!
Example
Query
query GetQuestionSetTemplate(
$teamId: ID!,
$id: ID!
) {
getQuestionSetTemplate(
teamId: $teamId,
id: $id
) {
id
teamId
name
template
createdAt
updatedAt
}
}
Variables
{
"teamId": "4",
"id": "4"
}
Response
{
"data": {
"getQuestionSetTemplate": {
"id": 4,
"teamId": 4,
"name": "abc123",
"template": "abc123",
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
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": "xyz789",
"createdAt": "xyz789",
"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": 987,
"inReview": 123,
"reviewReady": 987,
"inProgress": 123,
"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": 987,
"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": 123,
"pageInfo": PageInfo,
"nodes": [RowAnalyticEvent]
}
}
}
getRowAnswerConflicts
Response
Returns [RowAnswerConflicts!]!
Arguments
| Name | Description |
|---|---|
input - GetRowAnswerConflictsInput
|
Example
Query
query GetRowAnswerConflicts($input: GetRowAnswerConflictsInput) {
getRowAnswerConflicts(input: $input) {
line
conflicts
conflictStatus
}
}
Variables
{"input": GetRowAnswerConflictsInput}
Response
{
"data": {
"getRowAnswerConflicts": [
{
"line": 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
customScript {
...CustomScriptFragment
}
}
bindToColumn
activationConditionLogic
targetEntity
}
}
Variables
{"projectId": "4"}
Response
{
"data": {
"getRowQuestions": [
{
"id": 123,
"internalId": "xyz789",
"type": "DROPDOWN",
"name": "abc123",
"label": "abc123",
"required": false,
"config": QuestionConfig,
"bindToColumn": "xyz789",
"activationConditionLogic": "abc123",
"targetEntity": "abc123"
}
]
}
}
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
logoutUrl
simpleLogoutRedirect
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getSamlTenantByTeamId": {
"id": "4",
"active": false,
"companyId": 4,
"idpIssuer": "abc123",
"idpUrl": "abc123",
"spIssuer": "abc123",
"team": Team,
"allowMembersToSetPassword": false,
"logoutUrl": "xyz789",
"simpleLogoutRedirect": true
}
}
}
getSavedSearch
Response
Returns a SavedSearch
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetSavedSearch($id: ID!) {
getSavedSearch(id: $id) {
id
owner {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
lastModifiedBy {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
name
description
type
conditions
projectId
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"getSavedSearch": {
"id": 4,
"owner": User,
"lastModifiedBy": User,
"name": "abc123",
"description": "xyz789",
"type": "STANDARD",
"conditions": "abc123",
"projectId": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
getSavedSearches
Response
Returns a GetSavedSearchResponse!
Arguments
| Name | Description |
|---|---|
input - GetSavedSearchPaginatedInput!
|
Example
Query
query GetSavedSearches($input: GetSavedSearchPaginatedInput!) {
getSavedSearches(input: $input) {
totalCount
nodes {
id
owner {
...UserFragment
}
lastModifiedBy {
...UserFragment
}
name
description
type
conditions
projectId
createdAt
updatedAt
}
pageInfo {
prevCursor
nextCursor
}
}
}
Variables
{"input": GetSavedSearchPaginatedInput}
Response
{
"data": {
"getSavedSearches": {
"totalCount": 987,
"nodes": [SavedSearch],
"pageInfo": PageInfo
}
}
}
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
logoutUrl
simpleLogoutRedirect
}
active
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getScimByTeamId": {
"id": 4,
"team": Team,
"samlTenant": SamlTenant,
"active": false
}
}
}
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!]!
Example
Query
query GetSpanAndArrowConflictContributorIds(
$documentId: ID!,
$labelHashCodes: [String!]
) {
getSpanAndArrowConflictContributorIds(
documentId: $documentId,
labelHashCodes: $labelHashCodes
) {
labelHashCode
contributorIds
contributorInfos {
id
labelPhase
acceptedByUserId
rejectedByUserId
userId
teamMemberId
}
}
}
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": "xyz789"
}
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]
}
}
}
getSpendingThresholdStatuses
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns [SpendingThresholdStatus!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetSpendingThresholdStatuses($teamId: ID!) {
getSpendingThresholdStatuses(teamId: $teamId) {
isExceeded
spendingThreshold {
id
teamId
amount
currency
thresholdType
thresholdEvent
createdAt
updatedAt
}
currentSpendingAmount
currentSpendingCurrency
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getSpendingThresholdStatuses": [
{
"isExceeded": false,
"spendingThreshold": SpendingThreshold,
"currentSpendingAmount": 123.45,
"currentSpendingCurrency": "abc123"
}
]
}
}
getSynchronizeJobs
Example
Query
query GetSynchronizeJobs($projectId: ID!) {
getSynchronizeJobs(projectId: $projectId) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"projectId": "4"}
Response
{
"data": {
"getSynchronizeJobs": [
{
"id": "xyz789",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "abc123",
"retryCount": 123,
"maxRetry": 123,
"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": "xyz789",
"globalTag": true
}
]
}
}
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
}
userId
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
labelingAgent {
...LabelingAgentFragment
}
labelingAgentId
}
membersScalar
name
setting {
activitySettings {
...TeamActivitySettingsFragment
}
additionalSetting {
...AdditionalTeamSettingFragment
}
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedASRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enabledCustomObjectStorage
enableActions
enableAddDocumentsToProject
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurDinamicTokenBased
enableDatasaurPredictiveRowBased
enableLabelingAgentSpanBased
enableLabelingAgentRowBased
enableLabelingAgentArrowBased
enableWipeData
enableExportTeamOverview
enableSelfAssignment
enableWebhookSelfService
enableOauthApplicationSelfService
enableTransferOwnership
enableLabelErrorDetectionRowBased
allowedExtraAutoLabelProviders
enableLLMProject
enableRegexSentenceSeparator
enableTeamRoleSupervisor
endExtensionTrialAt
allowInvalidPaymentMethod
enableExternalKnowledgeBase
enableForceAnonymization
enableReviewIndicator
enableValidationScript
enableSpanLabelingWithRowQuestions
llmFreeTrialDailyLimitsConfig {
...LlmFreeTrialDailyLimitsConfigFragment
}
enableScriptGeneratedQuestion
rowModification {
...RowModificationSettingFragment
}
enableDeployedApplicationLogging
enableRealTimeAssistedLabelingSpanBased
enableLabelsAndAnswersExportFormat
enableGoogleDriveExternalObjectStorage
enableMLAssistedOptimizationByDefault
}
owner {
id
samlId
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
azureAIClientId
azureAICertificate
azureAITenantId
azureAISubscriptionId
azureAIResourceGroupName
azureAIAccountName
awsSagemakerRegion
awsSagemakerExternalId
awsSagemakerRoleArn
awsBedrockRegion
awsBedrockExternalId
awsBedrockRoleArn
vertexAiClientEmail
vertexAiPrivateKey
vertexAiProjectId
vertexAiRegion
}
createdAt
updatedAt
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getTeamExternalApiKey": {
"id": 4,
"teamId": "4",
"credentials": [TeamExternalApiKeyCredential],
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
getTeamMemberDetail
Response
Returns a TeamMember!
Example
Query
query GetTeamMemberDetail(
$teamId: ID!,
$memberId: ID!
) {
getTeamMemberDetail(
teamId: $teamId,
memberId: $memberId
) {
id
user {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
userId
role {
id
name
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
id
userId
projectStatistic {
...TeamMemberProjectStatisticFragment
}
totalTimeSpent
effectiveTotalTimeSpent
accuracy
}
labelingAgent {
id
agentId
agentType
name
}
labelingAgentId
}
}
Variables
{
"teamId": "4",
"memberId": "4"
}
Response
{
"data": {
"getTeamMemberDetail": {
"id": 4,
"user": User,
"userId": "4",
"role": TeamRole,
"invitationEmail": "xyz789",
"invitationStatus": "xyz789",
"invitationKey": "abc123",
"isDeleted": true,
"joinedDate": "abc123",
"performance": TeamMemberPerformance,
"labelingAgent": LabelingAgent,
"labelingAgentId": "4"
}
}
}
getTeamMemberLabelingStatus
Response
Returns a LabelingStatus!
Arguments
| Name | Description |
|---|---|
input - GetTeamMemberLabelingStatusInput!
|
Example
Query
query GetTeamMemberLabelingStatus($input: GetTeamMemberLabelingStatusInput!) {
getTeamMemberLabelingStatus(input: $input) {
labeler {
id
user {
...UserFragment
}
userId
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
labelingAgent {
...LabelingAgentFragment
}
labelingAgentId
}
isCompleted
isStarted
statistic {
id
numberOfDocuments
numberOfTouchedDocuments
numberOfCompletedDocuments
numberOfSentences
numberOfTouchedSentences
documentIds
completedDocumentIds
touchedDocumentIds
totalLabelsApplied
numberOfAcceptedLabels
numberOfRejectedLabels
numberOfUnresolvedLabels
totalTimeSpent
}
statisticsToShow {
key
values {
...StatisticItemValueFragment
}
}
}
}
Variables
{"input": GetTeamMemberLabelingStatusInput}
Response
{
"data": {
"getTeamMemberLabelingStatus": {
"labeler": TeamMember,
"isCompleted": true,
"isStarted": true,
"statistic": LabelingStatusStatistic,
"statisticsToShow": [StatisticItem]
}
}
}
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
documentStatus {
...DocumentStatusFragment
}
projectStatus
totalLabelApplied
totalAnswerApplied
totalConflictResolved
numberOfAcceptedLabels
numberOfRejectedLabels
numberOfConflictedLabels
numberOfMissingLabels
numberOfMissedLabels
numberOfAcceptedAnswers
numberOfRejectedAnswers
numberOfConflictedAnswers
numberOfAnsweredLines
activeDurationInMillis
projectStatisticsPerLabelType {
...ProjectStatisticPerLabelTypeFragment
}
}
}
}
Variables
{"input": GetPaginatedTeamMemberPerformanceInput}
Response
{
"data": {
"getTeamMemberPerformance": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [GetPaginatedTeamMemberPerformance]
}
}
}
getTeamMembers
Description
Returns the specified team's members. teamId can be seen in web UI, visible in the URL (https://datasaur.ai/teams/{teamId}/...) , or obtained via getAllTeams.
Response
Returns [TeamMember!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetTeamMembers($teamId: ID!) {
getTeamMembers(teamId: $teamId) {
id
user {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
userId
role {
id
name
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
id
userId
projectStatistic {
...TeamMemberProjectStatisticFragment
}
totalTimeSpent
effectiveTotalTimeSpent
accuracy
}
labelingAgent {
id
agentId
agentType
name
}
labelingAgentId
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"getTeamMembers": [
{
"id": "4",
"user": User,
"userId": 4,
"role": TeamRole,
"invitationEmail": "xyz789",
"invitationStatus": "abc123",
"invitationKey": "xyz789",
"isDeleted": true,
"joinedDate": "abc123",
"performance": TeamMemberPerformance,
"labelingAgent": LabelingAgent,
"labelingAgentId": 4
}
]
}
}
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
}
userId
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
labelingAgent {
...LabelingAgentFragment
}
labelingAgentId
}
}
}
Variables
{"input": GetTeamMembersPaginatedInput}
Response
{
"data": {
"getTeamMembersPaginated": {
"totalCount": 987,
"pageInfo": PageInfo,
"nodes": [TeamMember]
}
}
}
getTeamOauthApplications
Response
Returns [OauthApplication!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetTeamOauthApplications($teamId: ID!) {
getTeamOauthApplications(teamId: $teamId) {
id
name
redirectUris
allowedScopes
isEnabled
createdAt
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getTeamOauthApplications": [
{
"id": 4,
"name": "xyz789",
"redirectUris": ["abc123"],
"allowedScopes": ["abc123"],
"isEnabled": false,
"createdAt": "2007-12-03T10:15:30Z"
}
]
}
}
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": 987,
"tasks": [TeamOnboardingTask]
}
}
}
getTeamProjectAssignees
Response
Returns [ProjectAssignment!]!
Arguments
| Name | Description |
|---|---|
input - GetTeamProjectAssigneesInput!
|
Example
Query
query GetTeamProjectAssignees($input: GetTeamProjectAssigneesInput!) {
getTeamProjectAssignees(input: $input) {
teamMember {
id
user {
...UserFragment
}
userId
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
labelingAgent {
...LabelingAgentFragment
}
labelingAgentId
}
documentIds
documents {
id
chunks {
...TextChunkFragment
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
...TextDocumentSettingsFragment
}
fileName
isCompleted
completedByUserId
lastSavedAt
mimeType
name
projectId
sentences {
...TextSentenceFragment
}
settings {
...SettingsFragment
}
statistic {
...TextDocumentStatisticFragment
}
status
statusUpdatedByUserId
timeLimit
timeLimitScheduledCommandId
type
updatedChunks {
...TextChunkFragment
}
updatedTokenLabels {
...TextLabelFragment
}
url
version
workspaceState {
...WorkspaceStateFragment
}
originId
signature
part
}
role
taskScope {
spanTask {
...SpanTaskScopeFragment
}
rowTask {
...RowTaskScopeFragment
}
}
createdAt
updatedAt
}
}
Variables
{"input": GetTeamProjectAssigneesInput}
Response
{
"data": {
"getTeamProjectAssignees": [
{
"teamMember": TeamMember,
"documentIds": ["xyz789"],
"documents": [TextDocument],
"role": "LABELER",
"taskScope": TaskScope,
"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
samlId
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
samlId
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]
}
}
}
getTeamWebhooks
Response
Returns [Webhook!]!
Arguments
| Name | Description |
|---|---|
teamId - ID!
|
Example
Query
query GetTeamWebhooks($teamId: ID!) {
getTeamWebhooks(teamId: $teamId) {
id
teamId
url
events
customHeaders
isEnabled
enabledAt
disabledAt
createdBy
updatedBy
lastDeliveryAt
lastDeliveryStatus
createdAt
updatedAt
}
}
Variables
{"teamId": 4}
Response
{
"data": {
"getTeamWebhooks": [
{
"id": 4,
"teamId": "4",
"url": "abc123",
"events": ["PROJECT_CREATED"],
"customHeaders": {},
"isEnabled": true,
"enabledAt": "abc123",
"disabledAt": "xyz789",
"createdBy": 4,
"updatedBy": "4",
"lastDeliveryAt": "abc123",
"lastDeliveryStatus": 987,
"createdAt": "abc123",
"updatedAt": "xyz789"
}
]
}
}
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
logoutUrl
simpleLogoutRedirect
}
redirectUrl
}
}
Variables
{"companyId": 4}
Response
{
"data": {
"getTenantRedirectUrlFromCompanyId": {
"samlTenant": SamlTenant,
"redirectUrl": "abc123"
}
}
}
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
}
anonymizationMaskedColumnIds
fileTransformerId
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
fileName
isCompleted
completedByUserId
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
labeledLines
answeredLines
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
prelabeledLines
}
status
statusUpdatedByUserId
timeLimit
timeLimitScheduledCommandId
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
status
customAttribute
}
url
version
workspaceState {
id
chunkId
sentenceStart
sentenceEnd
touchedChunks
touchedSentences
}
originId
signature
part
}
}
Variables
{
"fileId": "4",
"signature": "abc123"
}
Response
{
"data": {
"getTextDocument": {
"id": 4,
"chunks": [TextChunk],
"createdAt": "abc123",
"currentSentenceCursor": 987,
"lastLabeledLine": 987,
"documentSettings": TextDocumentSettings,
"fileName": "xyz789",
"isCompleted": false,
"completedByUserId": "4",
"lastSavedAt": "abc123",
"mimeType": "xyz789",
"name": "abc123",
"projectId": "4",
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"status": "NOT_STARTED",
"statusUpdatedByUserId": "4",
"timeLimit": "2007-12-03T10:15:30Z",
"timeLimitScheduledCommandId": "4",
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "xyz789",
"version": 987,
"workspaceState": WorkspaceState,
"originId": 4,
"signature": "abc123",
"part": 987
}
}
}
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
}
anonymizationMaskedColumnIds
fileTransformerId
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
}
Variables
{"projectId": "4"}
Response
{
"data": {
"getTextDocumentSettings": {
"id": 4,
"textLabelMaxTokenLength": 123,
"allTokensMustBeLabeled": true,
"autoScrollWhenLabeling": false,
"allowArcDrawing": false,
"allowCharacterBasedLabeling": true,
"allowMultiLabels": true,
"kinds": ["DOCUMENT_BASED"],
"sentenceSeparator": "abc123",
"tokenizer": "abc123",
"editSentenceTokenizer": "xyz789",
"displayedRows": 987,
"mediaDisplayStrategy": "NONE",
"viewer": "TOKEN",
"viewerConfig": TextDocumentViewerConfig,
"hideBoundingBoxIfNoSpanOrArrowLabel": false,
"enableTabularMarkdownParsing": true,
"enableAnonymization": true,
"anonymizationEntityTypes": [
"abc123"
],
"anonymizationMaskingMethod": "abc123",
"anonymizationRegExps": [RegularExpression],
"anonymizationMaskedColumnIds": [123],
"fileTransformerId": "abc123",
"rowQuestionsFormValidationScriptId": "4",
"enableRowQuestionsFormValidationScript": true
}
}
}
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
labeledLines
answeredLines
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
userId
areDocumentQuestionsAnswered
numberOfAcceptedLabels
numberOfAppliedLabelTokens
numberOfRejectedLabels
}
documentTouched
prelabeledLines
}
}
Variables
{"documentId": 4}
Response
{
"data": {
"getTextDocumentStatistic": {
"documentId": "4",
"numberOfChunks": 123,
"numberOfSentences": 123,
"numberOfTokens": 123,
"effectiveTimeSpent": 987.65,
"touchedSentences": [987],
"labeledLines": [123],
"answeredLines": [123],
"nonDisplayedLines": [987],
"numberOfEntitiesLabeled": 123,
"numberOfNonDocumentEntitiesLabeled": 987,
"maxLabeledLine": 987,
"labelerStatistic": [LabelerStatistic],
"documentTouched": false,
"prelabeledLines": [987]
}
}
}
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
counter
type
}
}
Variables
{"documentId": 4, "fromTimestampMillis": 987}
Response
{
"data": {
"getTimestampLabels": [
{
"id": 4,
"documentId": "4",
"layer": 987,
"position": TextRange,
"startTimestampMillis": 987,
"endTimestampMillis": 987,
"counter": 123,
"type": "AUDIO"
}
]
}
}
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
counter
type
}
}
Variables
{"documentId": "4", "timestampMillis": 123}
Response
{
"data": {
"getTimestampLabelsAtTimestamp": [
{
"id": 4,
"documentId": 4,
"layer": 123,
"position": TextRange,
"startTimestampMillis": 123,
"endTimestampMillis": 123,
"counter": 987,
"type": "AUDIO"
}
]
}
}
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": 123.45,
"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!],
$withAttachments: Boolean
) {
getTotalPlaygroundCostPrediction(
llmApplicationId: $llmApplicationId,
promptIds: $promptIds,
playgroundRagConfigIds: $playgroundRagConfigIds,
withAttachments: $withAttachments
) {
coveredByDatasaur
notCoveredByDatasaur
total
}
}
Variables
{
"llmApplicationId": 4,
"promptIds": ["4"],
"playgroundRagConfigIds": ["4"],
"withAttachments": false
}
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
}
allowCustomAttribute
}
}
}
Variables
{"documentId": 4}
Response
{
"data": {
"getUnusedLabelSetItemInfos": [
{
"labelSetId": "4",
"labelSetName": "xyz789",
"items": [TagItem]
}
]
}
}
getUserAccountDetails
Response
Returns a UserAccountDetails!
Example
Query
query GetUserAccountDetails {
getUserAccountDetails {
hasPassword
signUpMethod
}
}
Response
{
"data": {
"getUserAccountDetails": {
"hasPassword": true,
"signUpMethod": "EMAIL_PASSWORD"
}
}
}
getUserHotkeyOverrides
Response
Returns [UserHotkeyOverride!]!
Arguments
| Name | Description |
|---|---|
platform - Platform!
|
Example
Query
query GetUserHotkeyOverrides($platform: Platform!) {
getUserHotkeyOverrides(platform: $platform) {
actionId
keys
platform
}
}
Variables
{"platform": "LINUX"}
Response
{
"data": {
"getUserHotkeyOverrides": [
{
"actionId": 4,
"keys": "abc123",
"platform": "LINUX"
}
]
}
}
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": ["xyz789"]
}
}
}
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,
$regenerateIfEmpty: Boolean
) {
getWaveformPeaks(
documentId: $documentId,
pixelPerSecond: $pixelPerSecond,
regenerateIfEmpty: $regenerateIfEmpty
) {
channel
peaks
pixelPerSecond
}
}
Variables
{
"documentId": "abc123",
"pixelPerSecond": 123,
"regenerateIfEmpty": true
}
Response
{
"data": {
"getWaveformPeaks": {
"channel": 123,
"peaks": [987.65],
"pixelPerSecond": 987
}
}
}
hasAWSMarketplaceSession
Response
Returns a Boolean!
Example
Query
query HasAWSMarketplaceSession {
hasAWSMarketplaceSession
}
Response
{"data": {"hasAWSMarketplaceSession": true}}
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": false}}
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": false}}
labelingAgentHasLabels
Example
Query
query LabelingAgentHasLabels(
$projectId: ID!,
$labelingAgentId: ID!
) {
labelingAgentHasLabels(
projectId: $projectId,
labelingAgentId: $labelingAgentId
)
}
Variables
{
"projectId": "4",
"labelingAgentId": "4"
}
Response
{"data": {"labelingAgentHasLabels": false}}
latestStorageDiagnosticRun
Description
Resumability entry point: the most recently started diagnostic run for this action, or null if the action has never had one. The frontend uses this on open (useOpenStorageDiagnosticDialog) to resume into the progress/results view instead of always starting fresh at config, and on the "already in progress" submit guard to recover into the progress view for the in-flight run.
Response
Returns a StorageDiagnosticRun
Arguments
| Name | Description |
|---|---|
actionId - ID!
|
Example
Query
query LatestStorageDiagnosticRun($actionId: ID!) {
latestStorageDiagnosticRun(actionId: $actionId) {
id
actionId
status
total
processed
passed
failed
skipped
startedAt
endedAt
progress {
total
processed
passed
failed
currentKey
currentOp
currentFileBytesDownloaded
currentFileBytesTotal
startedAt
}
}
}
Variables
{"actionId": 4}
Response
{
"data": {
"latestStorageDiagnosticRun": {
"id": 4,
"actionId": "4",
"status": "QUEUED",
"total": 123,
"processed": 987,
"passed": 123,
"failed": 987,
"skipped": 987,
"startedAt": "xyz789",
"endedAt": "abc123",
"progress": StorageDiagnosticProgress
}
}
}
listChunks
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns [DocumentChunk!]!
Arguments
| Name | Description |
|---|---|
input - ListChunksInput!
|
Example
Query
query ListChunks($input: ListChunksInput!) {
listChunks(input: $input) {
text
metadata
embedding
}
}
Variables
{"input": ListChunksInput}
Response
{
"data": {
"listChunks": [
{
"text": "abc123",
"metadata": DocumentChunkMetadata,
"embedding": [987.65]
}
]
}
}
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": "abc123",
"metadata": "abc123",
"score": 123.45
}
]
}
}
me
Response
Returns a User
Example
Query
query Me {
me {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
utmSource
utmMedium
utmCampaign
}
}
}
Response
{
"data": {
"me": {
"id": 4,
"samlId": "abc123",
"amazonCustomerId": "xyz789",
"username": "abc123",
"name": "xyz789",
"email": "xyz789",
"package": "ENTERPRISE",
"profilePicture": "xyz789",
"allowedActions": ["AUTOMATED_TEST"],
"displayName": "xyz789",
"teamPackage": "ENTERPRISE",
"emailVerified": true,
"totpAuthEnabled": false,
"companyName": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"signUpParams": SignUpParams
}
}
}
readChunk
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a DocumentChunk!
Arguments
| Name | Description |
|---|---|
input - ReadChunkInput!
|
Example
Query
query ReadChunk($input: ReadChunkInput!) {
readChunk(input: $input) {
text
metadata
embedding
}
}
Variables
{"input": ReadChunkInput}
Response
{
"data": {
"readChunk": {
"text": "xyz789",
"metadata": DocumentChunkMetadata,
"embedding": [123.45]
}
}
}
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
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"projectId": "4", "role": "REVIEWER"}
Response
{
"data": {
"replicateCabinet": {
"id": "xyz789",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"retryCount": 987,
"maxRetry": 987,
"additionalData": JobAdditionalData
}
}
}
storageDiagnosticFileResults
Description
Paginated/filterable file results — a separate top-level query (not a field resolver on StorageDiagnosticRun, per repo convention against ResolveField/ResolveProperty).
Response
Returns a StorageDiagnosticFileResultPage!
Arguments
| Name | Description |
|---|---|
actionId - ID!
|
|
runId - ID!
|
|
status - StorageDiagnosticCheckStatus
|
|
errorClass - StorageDiagnosticErrorClass
|
|
page - Int
|
|
pageSize - Int
|
Example
Query
query StorageDiagnosticFileResults(
$actionId: ID!,
$runId: ID!,
$status: StorageDiagnosticCheckStatus,
$errorClass: StorageDiagnosticErrorClass,
$page: Int,
$pageSize: Int
) {
storageDiagnosticFileResults(
actionId: $actionId,
runId: $runId,
status: $status,
errorClass: $errorClass,
page: $page,
pageSize: $pageSize
) {
totalCount
results {
id
key
sizeInBytes
getObjectStatus
getObjectErrorClass
getObjectRaw
presignedStatus
presignedErrorClass
presignedRaw
deniedResource
requestId
overallStatus
errorClass
}
}
}
Variables
{
"actionId": "4",
"runId": 4,
"status": "pass",
"errorClass": "EXPLICIT_DENY_RESOURCE_POLICY",
"page": 123,
"pageSize": 123
}
Response
{
"data": {
"storageDiagnosticFileResults": {
"totalCount": 123,
"results": [StorageDiagnosticFileResult]
}
}
}
storageDiagnosticRun
Response
Returns a StorageDiagnosticRun
Example
Query
query StorageDiagnosticRun(
$actionId: ID!,
$runId: ID!
) {
storageDiagnosticRun(
actionId: $actionId,
runId: $runId
) {
id
actionId
status
total
processed
passed
failed
skipped
startedAt
endedAt
progress {
total
processed
passed
failed
currentKey
currentOp
currentFileBytesDownloaded
currentFileBytesTotal
startedAt
}
}
}
Variables
{
"actionId": "4",
"runId": "4"
}
Response
{
"data": {
"storageDiagnosticRun": {
"id": "4",
"actionId": 4,
"status": "QUEUED",
"total": 123,
"processed": 123,
"passed": 987,
"failed": 123,
"skipped": 987,
"startedAt": "xyz789",
"endedAt": "xyz789",
"progress": StorageDiagnosticProgress
}
}
}
validateCabinet
Description
Checks whether the cabinet can be safely mark as completed or not. Returns true if valid, causes error otherwise
Example
Query
query ValidateCabinet(
$projectId: ID!,
$role: Role!
) {
validateCabinet(
projectId: $projectId,
role: $role
)
}
Variables
{"projectId": "4", "role": "REVIEWER"}
Response
{"data": {"validateCabinet": false}}
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": "xyz789",
"invitationKey": "xyz789"
}
Response
{
"data": {
"verifyInvitationLink": {
"isValid": false,
"userIsRegistered": true,
"email": "xyz789",
"teamId": "4",
"companyName": "abc123"
}
}
}
verifyPassword
verifyResetPasswordSignature
verifyTeamInvitationLink
Response
Returns a TeamInvitationLinkVerificationResult!
Arguments
| Name | Description |
|---|---|
invitationKey - String!
|
Example
Query
query VerifyTeamInvitationLink($invitationKey: String!) {
verifyTeamInvitationLink(invitationKey: $invitationKey) {
isValid
teamId
teamName
createdByUser
expiredAt
}
}
Variables
{"invitationKey": "abc123"}
Response
{
"data": {
"verifyTeamInvitationLink": {
"isValid": false,
"teamId": 4,
"teamName": "abc123",
"createdByUser": "abc123",
"expiredAt": "abc123"
}
}
}
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
acceptAllPredictedLabels
Response
Returns a Job!
Arguments
| Name | Description |
|---|---|
input - AcceptAllPredictedLabelsInput!
|
Example
Query
mutation AcceptAllPredictedLabels($input: AcceptAllPredictedLabelsInput!) {
acceptAllPredictedLabels(input: $input) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"input": AcceptAllPredictedLabelsInput}
Response
{
"data": {
"acceptAllPredictedLabels": {
"id": "abc123",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "xyz789",
"retryCount": 987,
"maxRetry": 123,
"additionalData": JobAdditionalData
}
}
}
acceptAudioLabelConflicts
Description
Accepts the given conflict candidates as the resolved labels, replacing the competing candidates on the review document.
Response
Returns [AudioLabel!]!
Example
Query
mutation AcceptAudioLabelConflicts(
$documentId: ID!,
$labelIds: [ID!]!
) {
acceptAudioLabelConflicts(
documentId: $documentId,
labelIds: $labelIds
) {
id
hashCode
documentId
labelSetIndex
labelSetItemId
counter
startTimestampMillis
endTimestampMillis
customAttribute
labeledBy
labeledByUserId
status
type
}
}
Variables
{"documentId": 4, "labelIds": [4]}
Response
{
"data": {
"acceptAudioLabelConflicts": [
{
"id": 4,
"hashCode": "xyz789",
"documentId": "4",
"labelSetIndex": 123,
"labelSetItemId": 4,
"counter": 123,
"startTimestampMillis": 987,
"endTimestampMillis": 987,
"customAttribute": "abc123",
"labeledBy": "PRELABELED",
"labeledByUserId": "4",
"status": "LABELED",
"type": "AUDIO"
}
]
}
}
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": 987,
"pageIndex": 123,
"layer": 123,
"position": TextRange,
"hashCode": "abc123",
"type": "AUDIO",
"labeledBy": "PRELABELED"
}
]
}
}
acceptInvitation
Example
Query
mutation AcceptInvitation($invitationKey: String!) {
acceptInvitation(invitationKey: $invitationKey) {
id
logoURL
members {
id
user {
...UserFragment
}
userId
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
labelingAgent {
...LabelingAgentFragment
}
labelingAgentId
}
membersScalar
name
setting {
activitySettings {
...TeamActivitySettingsFragment
}
additionalSetting {
...AdditionalTeamSettingFragment
}
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedASRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enabledCustomObjectStorage
enableActions
enableAddDocumentsToProject
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurDinamicTokenBased
enableDatasaurPredictiveRowBased
enableLabelingAgentSpanBased
enableLabelingAgentRowBased
enableLabelingAgentArrowBased
enableWipeData
enableExportTeamOverview
enableSelfAssignment
enableWebhookSelfService
enableOauthApplicationSelfService
enableTransferOwnership
enableLabelErrorDetectionRowBased
allowedExtraAutoLabelProviders
enableLLMProject
enableRegexSentenceSeparator
enableTeamRoleSupervisor
endExtensionTrialAt
allowInvalidPaymentMethod
enableExternalKnowledgeBase
enableForceAnonymization
enableReviewIndicator
enableValidationScript
enableSpanLabelingWithRowQuestions
llmFreeTrialDailyLimitsConfig {
...LlmFreeTrialDailyLimitsConfigFragment
}
enableScriptGeneratedQuestion
rowModification {
...RowModificationSettingFragment
}
enableDeployedApplicationLogging
enableRealTimeAssistedLabelingSpanBased
enableLabelsAndAnswersExportFormat
enableGoogleDriveExternalObjectStorage
enableMLAssistedOptimizationByDefault
}
owner {
id
samlId
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": "xyz789",
"members": [TeamMember],
"membersScalar": TeamMembersScalar,
"name": "xyz789",
"setting": TeamSetting,
"owner": User,
"isExpired": true,
"expiredAt": "2007-12-03T10:15:30Z"
}
}
}
acceptTeamInvitationLink
Response
Returns a Team!
Arguments
| Name | Description |
|---|---|
input - AcceptTeamInvitationLinkInput!
|
Example
Query
mutation AcceptTeamInvitationLink($input: AcceptTeamInvitationLinkInput!) {
acceptTeamInvitationLink(input: $input) {
id
logoURL
members {
id
user {
...UserFragment
}
userId
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
labelingAgent {
...LabelingAgentFragment
}
labelingAgentId
}
membersScalar
name
setting {
activitySettings {
...TeamActivitySettingsFragment
}
additionalSetting {
...AdditionalTeamSettingFragment
}
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedASRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enabledCustomObjectStorage
enableActions
enableAddDocumentsToProject
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurDinamicTokenBased
enableDatasaurPredictiveRowBased
enableLabelingAgentSpanBased
enableLabelingAgentRowBased
enableLabelingAgentArrowBased
enableWipeData
enableExportTeamOverview
enableSelfAssignment
enableWebhookSelfService
enableOauthApplicationSelfService
enableTransferOwnership
enableLabelErrorDetectionRowBased
allowedExtraAutoLabelProviders
enableLLMProject
enableRegexSentenceSeparator
enableTeamRoleSupervisor
endExtensionTrialAt
allowInvalidPaymentMethod
enableExternalKnowledgeBase
enableForceAnonymization
enableReviewIndicator
enableValidationScript
enableSpanLabelingWithRowQuestions
llmFreeTrialDailyLimitsConfig {
...LlmFreeTrialDailyLimitsConfigFragment
}
enableScriptGeneratedQuestion
rowModification {
...RowModificationSettingFragment
}
enableDeployedApplicationLogging
enableRealTimeAssistedLabelingSpanBased
enableLabelsAndAnswersExportFormat
enableGoogleDriveExternalObjectStorage
enableMLAssistedOptimizationByDefault
}
owner {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
isExpired
expiredAt
}
}
Variables
{"input": AcceptTeamInvitationLinkInput}
Response
{
"data": {
"acceptTeamInvitationLink": {
"id": "4",
"logoURL": "xyz789",
"members": [TeamMember],
"membersScalar": TeamMembersScalar,
"name": "abc123",
"setting": TeamSetting,
"owner": User,
"isExpired": false,
"expiredAt": "2007-12-03T10:15:30Z"
}
}
}
acceptTimestampLabelConflicts
Response
Returns [TimestampLabel!]!
Example
Query
mutation AcceptTimestampLabelConflicts(
$documentId: ID!,
$labelIds: [ID!]!
) {
acceptTimestampLabelConflicts(
documentId: $documentId,
labelIds: $labelIds
) {
id
documentId
layer
position {
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
}
startTimestampMillis
endTimestampMillis
counter
type
}
}
Variables
{"documentId": 4, "labelIds": ["4"]}
Response
{
"data": {
"acceptTimestampLabelConflicts": [
{
"id": 4,
"documentId": 4,
"layer": 987,
"position": TextRange,
"startTimestampMillis": 987,
"endTimestampMillis": 987,
"counter": 987,
"type": "AUDIO"
}
]
}
}
activateUser
Response
Returns a LoginSuccess
Example
Query
mutation ActivateUser(
$email: String!,
$activationCode: String!
) {
activateUser(
email: $email,
activationCode: $activationCode
) {
user {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
redirect
}
}
Variables
{
"email": "abc123",
"activationCode": "xyz789"
}
Response
{
"data": {
"activateUser": {
"user": User,
"redirect": "abc123"
}
}
}
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}}
addCustomEmbeddingModel
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmEmbeddingModel!
Arguments
| Name | Description |
|---|---|
input - AddCustomEmbeddingModelInput!
|
Example
Query
mutation AddCustomEmbeddingModel($input: AddCustomEmbeddingModelInput!) {
addCustomEmbeddingModel(input: $input) {
id
teamId
provider
name
displayName
url
maxTokens
dimensions
deployableModelId
isModelDeployable
createdAt
updatedAt
variant
customDimension
}
}
Variables
{"input": AddCustomEmbeddingModelInput}
Response
{
"data": {
"addCustomEmbeddingModel": {
"id": "4",
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "abc123",
"displayName": "abc123",
"url": "abc123",
"maxTokens": 987,
"dimensions": 987,
"deployableModelId": "abc123",
"isModelDeployable": false,
"createdAt": "xyz789",
"updatedAt": "abc123",
"variant": "META",
"customDimension": false
}
}
}
addCustomModel
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmModel!
Arguments
| Name | Description |
|---|---|
input - AddLlmCustomModelInput!
|
Example
Query
mutation AddCustomModel($input: AddLlmCustomModelInput!) {
addCustomModel(input: $input) {
id
teamId
provider
name
displayName
url
region
maxTemperature
maxTopP
maxTokens
maxContextWindow
defaultTemperature
defaultTopP
defaultMaxTokens
minTemperature
minTopP
llmModelFineTuningJob {
id
name
teamId
status
errorMessage
baseModelId
parentId
resultModelId
trainingJobId
trainingDataset {
...GroundTruthSetFragment
}
trainingDatasetFilename
validationSize
validationDataset {
...GroundTruthSetFragment
}
validationDatasetFilename
epochs
learningRate
batchSize
earlyStoppingThreshold
earlyStoppingPatience
learningRateWarmUpStep
learningRateMultiplier
instanceType
trainingVolumeSize
trainingBucketName
optionalHyperparameters
createdByUser {
...UserFragment
}
createdAt
updatedAt
}
deployableModelId
isModelDeployable
forceAnonymization
hasVisionCapability
variant
createdAt
updatedAt
}
}
Variables
{"input": AddLlmCustomModelInput}
Response
{
"data": {
"addCustomModel": {
"id": "4",
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "abc123",
"displayName": "abc123",
"url": "xyz789",
"region": ["xyz789"],
"maxTemperature": 987.65,
"maxTopP": 123.45,
"maxTokens": 123,
"maxContextWindow": 123,
"defaultTemperature": 987.65,
"defaultTopP": 987.65,
"defaultMaxTokens": 987,
"minTemperature": 123.45,
"minTopP": 123.45,
"llmModelFineTuningJob": LlmModelFineTuningJob,
"deployableModelId": "xyz789",
"isModelDeployable": true,
"forceAnonymization": true,
"hasVisionCapability": true,
"variant": "META",
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
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
retryCount
maxRetry
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
systemInstruction
prompt
answer
createdAt
updatedAt
}
}
Variables
{"input": AddGroundTruthsToGroundTruthSetInput}
Response
{
"data": {
"addGroundTruthsToGroundTruthSet": [
{
"id": "4",
"groundTruthSetId": 4,
"systemInstruction": "xyz789",
"prompt": "abc123",
"answer": "xyz789",
"createdAt": "xyz789",
"updatedAt": "abc123"
}
]
}
}
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
cached
}
}
Variables
{"input": AddLabelingFunctionInput}
Response
{
"data": {
"addLabelingFunction": {
"id": "4",
"dataProgrammingId": "4",
"heuristicArgument": HeuristicArgumentScalar,
"annotatorArgument": AnnotatorArgumentScalar,
"name": "xyz789",
"content": "abc123",
"active": false,
"createdAt": "abc123",
"updatedAt": "abc123",
"cached": false
}
}
}
addProjectKinds
Description
Adds one or more project kinds to an existing project. Validates that the resulting combination of kinds is supported. Requires project owner permissions. Returns true on success.
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - AddProjectKindsInput!
|
Example
Query
mutation AddProjectKinds($input: AddProjectKindsInput!) {
addProjectKinds(input: $input)
}
Variables
{"input": AddProjectKindsInput}
Response
{"data": {"addProjectKinds": false}}
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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
taskScope {
...TaskScopeFragment
}
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
enableRapidLabelingFeedback
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
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
}
anonymizationMaskedColumnIds
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
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
}
availableDocumentsCount
}
}
Variables
{"input": ProjectMetadataInput}
Response
{
"data": {
"addProjectMetadata": {
"id": 4,
"team": Team,
"teamId": "4",
"owner": User,
"externalObjectStorageId": "abc123",
"rootDocumentId": "4",
"assignees": [ProjectAssignment],
"name": "xyz789",
"tags": [Tag],
"type": "xyz789",
"createdDate": "xyz789",
"completedDate": "xyz789",
"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": false,
"projectMetadataItems": [ProjectMetadataItem],
"availableDocumentsCount": 987
}
}
}
addUserHotkeyOverrides
Response
Returns [UserHotkeyOverride!]!
Arguments
| Name | Description |
|---|---|
input - AddUserHotkeyOverrideInput!
|
Example
Query
mutation AddUserHotkeyOverrides($input: AddUserHotkeyOverrideInput!) {
addUserHotkeyOverrides(input: $input) {
actionId
keys
platform
}
}
Variables
{"input": AddUserHotkeyOverrideInput}
Response
{
"data": {
"addUserHotkeyOverrides": [
{
"actionId": "4",
"keys": "abc123",
"platform": "LINUX"
}
]
}
}
allowIPs
Response
Returns [String!]!
Arguments
| Name | Description |
|---|---|
allowedIPs - [String!]!
|
Example
Query
mutation AllowIPs($allowedIPs: [String!]!) {
allowIPs(allowedIPs: $allowedIPs)
}
Variables
{"allowedIPs": ["abc123"]}
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
}
allowCustomAttribute
}
}
Variables
{"input": AppendLabelSetTagItemsInput}
Response
{
"data": {
"appendLabelSetTagItems": [
{
"id": "xyz789",
"parentId": 4,
"tagName": "abc123",
"desc": "xyz789",
"color": "xyz789",
"type": "SPAN",
"arrowRules": [LabelClassArrowRule],
"allowCustomAttribute": true
}
]
}
}
approveOauthAuthorization
Response
Returns an OauthAuthorizationApproval!
Arguments
| Name | Description |
|---|---|
clientId - ID!
|
|
scope - [String!]!
|
|
redirectUri - String!
|
|
codeChallenge - String!
|
|
state - String
|
Example
Query
mutation ApproveOauthAuthorization(
$clientId: ID!,
$scope: [String!]!,
$redirectUri: String!,
$codeChallenge: String!,
$state: String
) {
approveOauthAuthorization(
clientId: $clientId,
scope: $scope,
redirectUri: $redirectUri,
codeChallenge: $codeChallenge,
state: $state
) {
redirectUrl
}
}
Variables
{
"clientId": 4,
"scope": ["abc123"],
"redirectUri": "xyz789",
"codeChallenge": "abc123",
"state": "abc123"
}
Response
{
"data": {
"approveOauthAuthorization": {
"redirectUrl": "abc123"
}
}
}
autoLabelDocBasedProject
Response
Returns a Job!
Arguments
| Name | Description |
|---|---|
input - AutoLabelDocBasedProjectInput!
|
Example
Query
mutation AutoLabelDocBasedProject($input: AutoLabelDocBasedProjectInput!) {
autoLabelDocBasedProject(input: $input) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"input": AutoLabelDocBasedProjectInput}
Response
{
"data": {
"autoLabelDocBasedProject": {
"id": "xyz789",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "xyz789",
"retryCount": 123,
"maxRetry": 987,
"additionalData": JobAdditionalData
}
}
}
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
}
anonymizationMaskedColumnIds
fileTransformerId
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
fileName
isCompleted
completedByUserId
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
labeledLines
answeredLines
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
prelabeledLines
}
status
statusUpdatedByUserId
timeLimit
timeLimitScheduledCommandId
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
status
customAttribute
}
url
version
workspaceState {
id
chunkId
sentenceStart
sentenceEnd
touchedChunks
touchedSentences
}
originId
signature
part
}
}
Variables
{
"input": AutoLabelReviewTextDocumentBasedOnConsensusInput
}
Response
{
"data": {
"autoLabelReviewTextDocumentBasedOnConsensus": {
"id": 4,
"chunks": [TextChunk],
"createdAt": "xyz789",
"currentSentenceCursor": 123,
"lastLabeledLine": 123,
"documentSettings": TextDocumentSettings,
"fileName": "xyz789",
"isCompleted": true,
"completedByUserId": "4",
"lastSavedAt": "abc123",
"mimeType": "abc123",
"name": "abc123",
"projectId": "4",
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"status": "NOT_STARTED",
"statusUpdatedByUserId": 4,
"timeLimit": "2007-12-03T10:15:30Z",
"timeLimitScheduledCommandId": 4,
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "abc123",
"version": 987,
"workspaceState": WorkspaceState,
"originId": 4,
"signature": "xyz789",
"part": 123
}
}
}
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
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"input": AutoLabelRowBasedProjectInput}
Response
{
"data": {
"autoLabelRowBasedProject": {
"id": "abc123",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "abc123",
"retryCount": 123,
"maxRetry": 987,
"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
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"input": AutoLabelTokenBasedProjectInput}
Response
{
"data": {
"autoLabelTokenBasedProject": {
"id": "xyz789",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"retryCount": 123,
"maxRetry": 987,
"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": false}}
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
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"projectId": "4"}
Response
{
"data": {
"calculateAgreementTables": {
"id": "xyz789",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "abc123",
"retryCount": 987,
"maxRetry": 123,
"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"]}}
calculateLabelerPairIAA
Response
Returns a Job!
Example
Query
mutation CalculateLabelerPairIAA(
$projectId: ID!,
$teamMemberId1: ID!,
$teamMemberId2: ID!
) {
calculateLabelerPairIAA(
projectId: $projectId,
teamMemberId1: $teamMemberId1,
teamMemberId2: $teamMemberId2
) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{
"projectId": 4,
"teamMemberId1": "4",
"teamMemberId2": "4"
}
Response
{
"data": {
"calculateLabelerPairIAA": {
"id": "abc123",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "abc123",
"retryCount": 987,
"maxRetry": 987,
"additionalData": JobAdditionalData
}
}
}
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": ["xyz789"]
}
}
cancelAutoLabelProjectJob
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
input - CancelAutoLabelProjectJobInput!
|
Example
Query
mutation CancelAutoLabelProjectJob($input: CancelAutoLabelProjectJobInput!) {
cancelAutoLabelProjectJob(input: $input)
}
Variables
{"input": CancelAutoLabelProjectJobInput}
Response
{"data": {"cancelAutoLabelProjectJob": false}}
cancelCreateProjectActionRun
Description
Request cancellation of an in-progress create project Action run. The run stops as soon as it next checks for a cancellation request — typically before starting its next folder or page of work — so any projects already created up to that point are kept. actionId is required so the request can be authorized against that action (the same permission required to edit it), and is verified to actually own the given run.
Example
Query
mutation CancelCreateProjectActionRun(
$actionId: ID!,
$runId: ID!
) {
cancelCreateProjectActionRun(
actionId: $actionId,
runId: $runId
)
}
Variables
{"actionId": "4", "runId": 4}
Response
{"data": {"cancelCreateProjectActionRun": true}}
cancelDatasaurPredictiveTrainingJob
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - CancelDatasaurPredictiveTrainingJobInput!
|
Example
Query
mutation CancelDatasaurPredictiveTrainingJob($input: CancelDatasaurPredictiveTrainingJobInput!) {
cancelDatasaurPredictiveTrainingJob(input: $input)
}
Variables
{"input": CancelDatasaurPredictiveTrainingJobInput}
Response
{"data": {"cancelDatasaurPredictiveTrainingJob": true}}
cancelRealTimeAssistedLabelingJob
Response
Returns a Job
Arguments
| Name | Description |
|---|---|
input - CancelRealTimeAssistedLabelingJobInput!
|
Example
Query
mutation CancelRealTimeAssistedLabelingJob($input: CancelRealTimeAssistedLabelingJobInput!) {
cancelRealTimeAssistedLabelingJob(input: $input) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"input": CancelRealTimeAssistedLabelingJobInput}
Response
{
"data": {
"cancelRealTimeAssistedLabelingJob": {
"id": "abc123",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "abc123",
"retryCount": 123,
"maxRetry": 987,
"additionalData": JobAdditionalData
}
}
}
cancelStorageDiagnostic
Description
actionId is required for authorization scoping (same guard as editing the action/EOS).
Example
Query
mutation CancelStorageDiagnostic(
$actionId: ID!,
$runId: ID!
) {
cancelStorageDiagnostic(
actionId: $actionId,
runId: $runId
)
}
Variables
{"actionId": 4, "runId": "4"}
Response
{"data": {"cancelStorageDiagnostic": false}}
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"}}
chunkFile
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a CreateDocumentChunkResult!
Arguments
| Name | Description |
|---|---|
input - CreateDocumentChunkInput!
|
Example
Query
mutation ChunkFile($input: CreateDocumentChunkInput!) {
chunkFile(input: $input) {
chunks {
text
metadata
embedding
}
defaultChunkMetadata
}
}
Variables
{"input": CreateDocumentChunkInput}
Response
{
"data": {
"chunkFile": {
"chunks": [DocumentChunk],
"defaultChunkMetadata": DefaultChunkMetadata
}
}
}
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
labeledLines
answeredLines
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
prelabeledLines
}
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
labeledLines
answeredLines
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
prelabeledLines
}
lastSavedAt
}
}
Variables
{"documentId": "4"}
Response
{
"data": {
"clearAllSpanAndArrowLabels": {
"affectedChunkIds": [123],
"statistic": TextDocumentStatistic,
"lastSavedAt": "abc123"
}
}
}
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
teamId
provider
name
displayName
url
region
maxTemperature
maxTopP
maxTokens
maxContextWindow
defaultTemperature
defaultTopP
defaultMaxTokens
minTemperature
minTopP
llmModelFineTuningJob {
id
name
teamId
status
errorMessage
baseModelId
parentId
resultModelId
trainingJobId
trainingDataset {
...GroundTruthSetFragment
}
trainingDatasetFilename
validationSize
validationDataset {
...GroundTruthSetFragment
}
validationDatasetFilename
epochs
learningRate
batchSize
earlyStoppingThreshold
earlyStoppingPatience
learningRateWarmUpStep
learningRateMultiplier
instanceType
trainingVolumeSize
trainingBucketName
optionalHyperparameters
createdByUser {
...UserFragment
}
createdAt
updatedAt
}
deployableModelId
isModelDeployable
forceAnonymization
hasVisionCapability
variant
createdAt
updatedAt
}
}
Variables
{"input": LlmModelDeployInput}
Response
{
"data": {
"createAndDeployLlmModel": {
"id": 4,
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "xyz789",
"displayName": "xyz789",
"url": "abc123",
"region": ["abc123"],
"maxTemperature": 987.65,
"maxTopP": 987.65,
"maxTokens": 123,
"maxContextWindow": 123,
"defaultTemperature": 123.45,
"defaultTopP": 987.65,
"defaultMaxTokens": 987,
"minTemperature": 987.65,
"minTopP": 123.45,
"llmModelFineTuningJob": LlmModelFineTuningJob,
"deployableModelId": "abc123",
"isModelDeployable": true,
"forceAnonymization": true,
"hasVisionCapability": true,
"variant": "META",
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
createChunk
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a CreateChunkResponse!
Arguments
| Name | Description |
|---|---|
input - CreateChunkInput!
|
Example
Query
mutation CreateChunk($input: CreateChunkInput!) {
createChunk(input: $input) {
createdChunk {
text
metadata
embedding
}
previousChunk {
text
metadata
embedding
}
nextChunk {
text
metadata
embedding
}
}
}
Variables
{"input": CreateChunkInput}
Response
{
"data": {
"createChunk": {
"createdChunk": DocumentChunk,
"previousChunk": DocumentChunk,
"nextChunk": DocumentChunk
}
}
}
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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
message
resolved
resolvedAt
resolvedBy {
id
samlId
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": "abc123",
"hashCode": "abc123"
}
Response
{
"data": {
"createComment": {
"id": 4,
"parentId": 4,
"documentId": 4,
"originDocumentId": "4",
"userId": 123,
"user": User,
"message": "xyz789",
"resolved": false,
"resolvedAt": "xyz789",
"resolvedBy": User,
"repliesCount": 123,
"createdAt": "abc123",
"updatedAt": "abc123",
"lastEditedAt": "xyz789",
"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
name
effectiveName
credentials {
...ExternalObjectStorageCredentialsFragment
}
securityToken
team {
...TeamFragment
}
projects {
...ProjectFragment
}
readOnly
createdAt
updatedAt
}
externalObjectStorageIdOutput
externalObjectStorageOutput {
id
cloudService
bucketId
bucketName
name
effectiveName
credentials {
...ExternalObjectStorageCredentialsFragment
}
securityToken
team {
...TeamFragment
}
projects {
...ProjectFragment
}
readOnly
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
immutableInput
ingestMode
skipDeduplication
}
}
Variables
{"input": CreateCreateProjectActionInput}
Response
{
"data": {
"createCreateProjectAction": {
"id": "4",
"name": "abc123",
"teamId": "4",
"appVersion": "abc123",
"creatorId": "4",
"lastRunAt": "xyz789",
"lastFinishedAt": "abc123",
"externalObjectStorageId": "4",
"externalObjectStorage": ExternalObjectStorage,
"externalObjectStorageIdOutput": 4,
"externalObjectStorageOutput": ExternalObjectStorage,
"externalObjectStoragePathInput": "xyz789",
"externalObjectStoragePathResult": "abc123",
"projectTemplateId": 4,
"projectTemplate": ProjectTemplate,
"assignments": [CreateProjectActionAssignment],
"additionalTagNames": ["xyz789"],
"numberOfLabelersPerProject": 987,
"numberOfReviewersPerProject": 123,
"numberOfLabelersPerDocument": 987,
"conflictResolutionMode": "MANUAL",
"consensus": 123,
"warnings": ["ASSIGNED_LABELER_NOT_MEET_CONSENSUS"],
"immutableInput": false,
"ingestMode": "PRESIGNED",
"skipDeduplication": false
}
}
}
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": "abc123",
"name": "xyz789",
"purpose": "ASR_API"
}
}
}
createDomainClaim
Response
Returns a DomainClaim!
Arguments
| Name | Description |
|---|---|
input - CreateDomainClaimInput!
|
Example
Query
mutation CreateDomainClaim($input: CreateDomainClaimInput!) {
createDomainClaim(input: $input) {
id
teamId
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
domain
verificationSecret
verificationDnsHost
status
encryptionVersion
createdAt
updatedAt
lastVerifyAttemptAt
verificationStartedAt
claimedAt
}
}
Variables
{"input": CreateDomainClaimInput}
Response
{
"data": {
"createDomainClaim": {
"id": 4,
"teamId": 4,
"team": Team,
"domain": "abc123",
"verificationSecret": "abc123",
"verificationDnsHost": "xyz789",
"status": "UNCLAIMED",
"encryptionVersion": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"lastVerifyAttemptAt": "2007-12-03T10:15:30Z",
"verificationStartedAt": "2007-12-03T10:15:30Z",
"claimedAt": "2007-12-03T10:15:30Z"
}
}
}
createExternalObjectStorage
Response
Returns an ExternalObjectStorage!
Arguments
| Name | Description |
|---|---|
input - CreateExternalObjectStorageInput!
|
Example
Query
mutation CreateExternalObjectStorage($input: CreateExternalObjectStorageInput!) {
createExternalObjectStorage(input: $input) {
id
cloudService
bucketId
bucketName
name
effectiveName
credentials {
roleArn
externalId
serviceAccount
tenantId
storageContainerUrl
region
tenantUsername
}
securityToken
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
projects {
id
team {
...TeamFragment
}
teamId
owner {
...UserFragment
}
externalObjectStorageId
rootDocumentId
assignees {
...ProjectAssignmentFragment
}
name
tags {
...TagFragment
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
...ProjectSettingsFragment
}
workspaceSettings {
...WorkspaceSettingsFragment
}
reviewingStatus {
...ReviewingStatusFragment
}
labelingStatus {
...LabelingStatusFragment
}
status
performance {
...ProjectPerformanceFragment
}
selfLabelingStatus
purpose
rootCabinet {
...CabinetFragment
}
reviewCabinet {
...CabinetFragment
}
labelerCabinets {
...CabinetFragment
}
guideline {
...GuidelineFragment
}
isArchived
projectMetadataItems {
...ProjectMetadataItemFragment
}
availableDocumentsCount
}
readOnly
createdAt
updatedAt
}
}
Variables
{"input": CreateExternalObjectStorageInput}
Response
{
"data": {
"createExternalObjectStorage": {
"id": "4",
"cloudService": "AWS_S3",
"bucketId": "abc123",
"bucketName": "abc123",
"name": "abc123",
"effectiveName": "xyz789",
"credentials": ExternalObjectStorageCredentials,
"securityToken": "abc123",
"team": Team,
"projects": [Project],
"readOnly": true,
"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": "xyz789",
"content": "abc123",
"transpiled": "xyz789",
"createdAt": "abc123",
"updatedAt": "abc123",
"language": "TYPESCRIPT",
"purpose": "IMPORT",
"readonly": false,
"externalId": "abc123",
"warmup": true
}
}
}
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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
items {
id
groundTruthSetId
systemInstruction
prompt
answer
createdAt
updatedAt
}
itemsCount
createdAt
updatedAt
}
}
Variables
{"input": CreateGroundTruthSetInput}
Response
{
"data": {
"createGroundTruthSet": {
"id": 4,
"name": "xyz789",
"teamId": "4",
"createdByUserId": "4",
"createdByUser": User,
"items": [GroundTruth],
"itemsCount": 123,
"createdAt": "abc123",
"updatedAt": "xyz789"
}
}
}
createGroundTruthSetForFineTuning
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a GroundTruthSet!
Arguments
| Name | Description |
|---|---|
input - CreateGroundTruthSetForFineTuningInput!
|
Example
Query
mutation CreateGroundTruthSetForFineTuning($input: CreateGroundTruthSetForFineTuningInput!) {
createGroundTruthSetForFineTuning(input: $input) {
id
name
teamId
createdByUserId
createdByUser {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
items {
id
groundTruthSetId
systemInstruction
prompt
answer
createdAt
updatedAt
}
itemsCount
createdAt
updatedAt
}
}
Variables
{"input": CreateGroundTruthSetForFineTuningInput}
Response
{
"data": {
"createGroundTruthSetForFineTuning": {
"id": 4,
"name": "xyz789",
"teamId": "4",
"createdByUserId": "4",
"createdByUser": User,
"items": [GroundTruth],
"itemsCount": 987,
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
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
}
availableDocumentsCount
}
}
}
Variables
{
"name": "abc123",
"content": "xyz789",
"teamId": 4
}
Response
{
"data": {
"createGuideline": {
"id": 4,
"name": "abc123",
"content": "abc123",
"project": Project
}
}
}
createLLMApplicationDocBased
Response
Returns an CreateLLMApplicationDocBasedOutput!
Arguments
| Name | Description |
|---|---|
input - CreateLLMApplicationDocBasedInput!
|
Example
Query
mutation CreateLLMApplicationDocBased($input: CreateLLMApplicationDocBasedInput!) {
createLLMApplicationDocBased(input: $input) {
llmApplicationId
}
}
Variables
{"input": CreateLLMApplicationDocBasedInput}
Response
{
"data": {
"createLLMApplicationDocBased": {
"llmApplicationId": "4"
}
}
}
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
}
allowCustomAttribute
}
lastUsedBy {
projectId
name
}
arrowLabelRequired
leafOnlyOption
}
}
Variables
{"input": CreateLabelSetInput, "projectId": 4}
Response
{
"data": {
"createLabelSet": {
"id": "4",
"name": "xyz789",
"index": 987,
"signature": "abc123",
"tagItems": [TagItem],
"lastUsedBy": LastUsedProject,
"arrowLabelRequired": false,
"leafOnlyOption": false
}
}
}
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
samlId
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
leafOnlyOption
}
}
Variables
{"input": CreateLabelSetTemplateInput}
Response
{
"data": {
"createLabelSetTemplate": {
"id": "4",
"name": "abc123",
"owner": User,
"type": "QUESTION",
"items": [LabelSetTemplateItem],
"count": 987,
"createdAt": "abc123",
"updatedAt": "xyz789",
"leafOnlyOption": false
}
}
}
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
samlId
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
name
status
createdAt
updatedAt
apiEndpoints {
...LlmApplicationDeploymentApiEndpointFragment
}
isDeleted
}
totalRagConfigs
}
}
Variables
{"teamId": "4"}
Response
{
"data": {
"createLlmApplication": {
"id": "4",
"teamId": "4",
"createdByUser": User,
"name": "abc123",
"status": "DEPLOYED",
"createdAt": "xyz789",
"updatedAt": "abc123",
"llmApplicationDeployment": LlmApplicationDeployment,
"totalRagConfigs": 987
}
}
}
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
updatedByUserId
updatedByUser {
id
samlId
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
}
llmVectorStores {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
maxChunkSize
createdAt
updatedAt
}
createdAt
updatedAt
isDeleted
}
}
Variables
{"input": CreateLlmApplicationConfigurationInput}
Response
{
"data": {
"createLlmApplicationConfiguration": {
"id": "4",
"name": "abc123",
"teamId": 4,
"createdByUserId": 4,
"updatedByUserId": 4,
"updatedByUser": User,
"llmRagConfigId": 4,
"llmRagConfig": LlmRagConfig,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"isDeleted": false
}
}
}
createLlmApplicationPlaygroundPromptAttachments
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplicationPlaygroundPrompt!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - [LlmApplicationPlaygroundPromptNewAttachmentInput!]!
|
Example
Query
mutation CreateLlmApplicationPlaygroundPromptAttachments(
$id: ID!,
$input: [LlmApplicationPlaygroundPromptNewAttachmentInput!]!
) {
createLlmApplicationPlaygroundPromptAttachments(
id: $id,
input: $input
) {
id
llmApplicationId
name
createdAt
updatedAt
lastPromptMessage {
id
llmApplicationPlaygroundPromptId
content
role
attachments {
...LlmApplicationPlaygroundPromptAttachmentFragment
}
createdAt
updatedAt
}
totalPromptMessages
}
}
Variables
{
"id": 4,
"input": [
LlmApplicationPlaygroundPromptNewAttachmentInput
]
}
Response
{
"data": {
"createLlmApplicationPlaygroundPromptAttachments": {
"id": "4",
"llmApplicationId": "4",
"name": "xyz789",
"createdAt": "xyz789",
"updatedAt": "abc123",
"lastPromptMessage": LlmApplicationPlaygroundPromptMessage,
"totalPromptMessages": 123
}
}
}
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
createdAt
updatedAt
lastPromptMessage {
id
llmApplicationPlaygroundPromptId
content
role
attachments {
...LlmApplicationPlaygroundPromptAttachmentFragment
}
createdAt
updatedAt
}
totalPromptMessages
}
}
Variables
{"input": LlmApplicationPlaygroundPromptCreateInput}
Response
{
"data": {
"createLlmApplicationPlaygroundPrompts": [
{
"id": 4,
"llmApplicationId": "4",
"name": "xyz789",
"createdAt": "xyz789",
"updatedAt": "xyz789",
"lastPromptMessage": LlmApplicationPlaygroundPromptMessage,
"totalPromptMessages": 987
}
]
}
}
createLlmApplicationPlaygroundPromptsFromDataset
Breaking changes may be introduced anytime in the future without prior notice.
Response
Arguments
| Name | Description |
|---|---|
input - LlmApplicationPlaygroundPromptCreateFromDatasetInput
|
Example
Query
mutation CreateLlmApplicationPlaygroundPromptsFromDataset($input: LlmApplicationPlaygroundPromptCreateFromDatasetInput) {
createLlmApplicationPlaygroundPromptsFromDataset(input: $input) {
id
llmApplicationId
name
createdAt
updatedAt
lastPromptMessage {
id
llmApplicationPlaygroundPromptId
content
role
attachments {
...LlmApplicationPlaygroundPromptAttachmentFragment
}
createdAt
updatedAt
}
totalPromptMessages
}
}
Variables
{
"input": LlmApplicationPlaygroundPromptCreateFromDatasetInput
}
Response
{
"data": {
"createLlmApplicationPlaygroundPromptsFromDataset": [
{
"id": "4",
"llmApplicationId": 4,
"name": "abc123",
"createdAt": "abc123",
"updatedAt": "xyz789",
"lastPromptMessage": LlmApplicationPlaygroundPromptMessage,
"totalPromptMessages": 123
}
]
}
}
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
}
llmVectorStores {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
maxChunkSize
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 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
}
scheduledCommandConfig {
id
cronPattern
repeatInterval
runImmediately
endTime
numberOfRepetition
isNeverEnding
isPeriodic
updatedAt
}
isScheduled
createdAt
updatedAt
isDeleted
type
schedulingStatus
nextSchedule
createdByUser {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
lastScoredByUser {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
totalPrompts
lastLlmEvaluationExecution {
id
llmEvaluationId
status
errorMessage
createdAt
updatedAt
isDeleted
}
}
}
Variables
{"input": LlmEvaluationInput}
Response
{
"data": {
"createLlmEvaluation": {
"id": "4",
"name": "abc123",
"teamId": "4",
"projectId": "4",
"kind": "DOCUMENT_BASED",
"status": "CREATING",
"creationProgress": LlmEvaluationCreationProgress,
"scheduledCommandConfig": ScheduledCommandConfig,
"isScheduled": true,
"createdAt": "xyz789",
"updatedAt": "abc123",
"isDeleted": false,
"type": "RATING",
"schedulingStatus": "NOT_STARTED",
"nextSchedule": "abc123",
"createdByUser": User,
"lastScoredByUser": User,
"totalPrompts": 987,
"lastLlmEvaluationExecution": LlmEvaluationExecution
}
}
}
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
}
scheduledCommandConfig {
id
cronPattern
repeatInterval
runImmediately
endTime
numberOfRepetition
isNeverEnding
isPeriodic
updatedAt
}
isScheduled
createdAt
updatedAt
isDeleted
type
schedulingStatus
nextSchedule
createdByUser {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
lastScoredByUser {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
totalPrompts
lastLlmEvaluationExecution {
id
llmEvaluationId
status
errorMessage
createdAt
updatedAt
isDeleted
}
}
}
Variables
{"input": LlmEvaluationAutomatedInput}
Response
{
"data": {
"createLlmEvaluationAutomated": {
"id": "4",
"name": "xyz789",
"teamId": "4",
"projectId": 4,
"kind": "DOCUMENT_BASED",
"status": "CREATING",
"creationProgress": LlmEvaluationCreationProgress,
"scheduledCommandConfig": ScheduledCommandConfig,
"isScheduled": true,
"createdAt": "abc123",
"updatedAt": "abc123",
"isDeleted": true,
"type": "RATING",
"schedulingStatus": "NOT_STARTED",
"nextSchedule": "abc123",
"createdByUser": User,
"lastScoredByUser": User,
"totalPrompts": 123,
"lastLlmEvaluationExecution": LlmEvaluationExecution
}
}
}
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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
llmEmbeddingModel {
id
teamId
provider
name
displayName
url
maxTokens
dimensions
deployableModelId
isModelDeployable
createdAt
updatedAt
variant
customDimension
}
provider
collectionId
name
status
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
targetEntity
}
jobId
chunkConfiguration
filePropertiesExtractorConfiguration {
type
configuration
syncedFilePropertiesJsonSchema
}
urlSyncScheduledCommandConfig {
id
cronPattern
repeatInterval
runImmediately
endTime
numberOfRepetition
isNeverEnding
isPeriodic
updatedAt
}
urlSyncNextSchedule
urlSyncLastSyncedAt
createdAt
updatedAt
dimension
}
}
Variables
{"input": CreateLlmVectorStoreInput}
Response
{
"data": {
"createLlmVectorStore": {
"id": 4,
"teamId": 4,
"createdByUser": User,
"llmEmbeddingModel": LlmEmbeddingModel,
"provider": "DATASAUR",
"collectionId": "abc123",
"name": "xyz789",
"status": "CREATED",
"documents": [LlmVectorStoreDocumentScalar],
"documentStatusCount": LlmVectorStoreDocumentCountByStatus,
"sourceDocuments": [LlmVectorStoreSourceDocument],
"questions": [Question],
"jobId": "xyz789",
"chunkConfiguration": ChunkConfiguration,
"filePropertiesExtractorConfiguration": LlmVectorStoreFilePropertiesExtractorConfiguration,
"urlSyncScheduledCommandConfig": ScheduledCommandConfig,
"urlSyncNextSchedule": "xyz789",
"urlSyncLastSyncedAt": "xyz789",
"createdAt": "xyz789",
"updatedAt": "xyz789",
"dimension": 987
}
}
}
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": "xyz789"}}
createOnboardingLlmApplication
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplication!
Example
Query
mutation CreateOnboardingLlmApplication(
$teamId: ID!,
$llmModelIds: [ID!]
) {
createOnboardingLlmApplication(
teamId: $teamId,
llmModelIds: $llmModelIds
) {
id
teamId
createdByUser {
id
samlId
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
name
status
createdAt
updatedAt
apiEndpoints {
...LlmApplicationDeploymentApiEndpointFragment
}
isDeleted
}
totalRagConfigs
}
}
Variables
{
"teamId": "4",
"llmModelIds": ["4"]
}
Response
{
"data": {
"createOnboardingLlmApplication": {
"id": "4",
"teamId": 4,
"createdByUser": User,
"name": "abc123",
"status": "DEPLOYED",
"createdAt": "abc123",
"updatedAt": "xyz789",
"llmApplicationDeployment": LlmApplicationDeployment,
"totalRagConfigs": 123
}
}
}
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": "xyz789",
"globalTag": false
}
}
}
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
retryCount
maxRetry
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": "abc123",
"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": "abc123",
"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
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
}
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
}
anonymizationMaskedColumnNames
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
leafOnlyOption
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
kinds
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": "xyz789",
"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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
items {
id
index
questionSetId
label
type
hint
multipleAnswer
required
bindToColumn
activationConditionLogic
createdAt
updatedAt
options {
...DropdownConfigOptionsFragment
}
leafOptionsOnly
format
defaultValue
max
min
theme
gradientColors
step
hideScaleLabel
multiline
maxLength
minLength
pattern
customScript {
...CustomScriptFragment
}
nestedQuestions {
...QuestionSetItemFragment
}
parentId
}
kinds
createdAt
updatedAt
}
}
Variables
{"input": CreateQuestionSetInput}
Response
{
"data": {
"createQuestionSet": {
"name": "xyz789",
"id": "4",
"creator": User,
"items": [QuestionSetItem],
"kinds": ["DOCUMENT_BASED"],
"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": "xyz789",
"template": "xyz789",
"createdAt": "xyz789",
"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
logoutUrl
simpleLogoutRedirect
}
active
}
}
Variables
{
"teamId": "4",
"samlTenantId": "4"
}
Response
{
"data": {
"createScim": {
"id": 4,
"team": Team,
"samlTenant": SamlTenant,
"active": false
}
}
}
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": "xyz789",
"globalTag": false
}
}
}
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": true
}
]
}
}
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
}
userId
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
labelingAgent {
...LabelingAgentFragment
}
labelingAgentId
}
membersScalar
name
setting {
activitySettings {
...TeamActivitySettingsFragment
}
additionalSetting {
...AdditionalTeamSettingFragment
}
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedASRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enabledCustomObjectStorage
enableActions
enableAddDocumentsToProject
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurDinamicTokenBased
enableDatasaurPredictiveRowBased
enableLabelingAgentSpanBased
enableLabelingAgentRowBased
enableLabelingAgentArrowBased
enableWipeData
enableExportTeamOverview
enableSelfAssignment
enableWebhookSelfService
enableOauthApplicationSelfService
enableTransferOwnership
enableLabelErrorDetectionRowBased
allowedExtraAutoLabelProviders
enableLLMProject
enableRegexSentenceSeparator
enableTeamRoleSupervisor
endExtensionTrialAt
allowInvalidPaymentMethod
enableExternalKnowledgeBase
enableForceAnonymization
enableReviewIndicator
enableValidationScript
enableSpanLabelingWithRowQuestions
llmFreeTrialDailyLimitsConfig {
...LlmFreeTrialDailyLimitsConfigFragment
}
enableScriptGeneratedQuestion
rowModification {
...RowModificationSettingFragment
}
enableDeployedApplicationLogging
enableRealTimeAssistedLabelingSpanBased
enableLabelsAndAnswersExportFormat
enableGoogleDriveExternalObjectStorage
enableMLAssistedOptimizationByDefault
}
owner {
id
samlId
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": "xyz789",
"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": "xyz789",
"key": "abc123",
"lastUsedAt": "abc123",
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
createTeamOauthApplication
Response
Returns an OauthApplicationSecretResult!
Arguments
| Name | Description |
|---|---|
input - CreateOauthApplicationInput!
|
Example
Query
mutation CreateTeamOauthApplication($input: CreateOauthApplicationInput!) {
createTeamOauthApplication(input: $input) {
id
secret
}
}
Variables
{"input": CreateOauthApplicationInput}
Response
{
"data": {
"createTeamOauthApplication": {
"id": "4",
"secret": "abc123"
}
}
}
createTeamWebhook
Response
Returns a Webhook!
Arguments
| Name | Description |
|---|---|
input - CreateWebhookInput!
|
Example
Query
mutation CreateTeamWebhook($input: CreateWebhookInput!) {
createTeamWebhook(input: $input) {
id
teamId
url
events
customHeaders
isEnabled
enabledAt
disabledAt
createdBy
updatedBy
lastDeliveryAt
lastDeliveryStatus
createdAt
updatedAt
}
}
Variables
{"input": CreateWebhookInput}
Response
{
"data": {
"createTeamWebhook": {
"id": 4,
"teamId": "4",
"url": "xyz789",
"events": ["PROJECT_CREATED"],
"customHeaders": {},
"isEnabled": true,
"enabledAt": "abc123",
"disabledAt": "abc123",
"createdBy": "4",
"updatedBy": 4,
"lastDeliveryAt": "xyz789",
"lastDeliveryStatus": 987,
"createdAt": "abc123",
"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
logoutUrl
simpleLogoutRedirect
}
}
Variables
{"input": CreateSamlTenantInput}
Response
{
"data": {
"createTenant": {
"id": 4,
"active": false,
"companyId": "4",
"idpIssuer": "abc123",
"idpUrl": "xyz789",
"spIssuer": "abc123",
"team": Team,
"allowMembersToSetPassword": true,
"logoutUrl": "abc123",
"simpleLogoutRedirect": false
}
}
}
deleteAudioLabels
Description
Deletes the given audio labels from the document.
Response
Returns [AudioLabel!]!
Example
Query
mutation DeleteAudioLabels(
$documentId: ID!,
$labelIds: [ID!]!
) {
deleteAudioLabels(
documentId: $documentId,
labelIds: $labelIds
) {
id
hashCode
documentId
labelSetIndex
labelSetItemId
counter
startTimestampMillis
endTimestampMillis
customAttribute
labeledBy
labeledByUserId
status
type
}
}
Variables
{"documentId": "4", "labelIds": [4]}
Response
{
"data": {
"deleteAudioLabels": [
{
"id": "4",
"hashCode": "abc123",
"documentId": "4",
"labelSetIndex": 123,
"labelSetItemId": 4,
"counter": 987,
"startTimestampMillis": 123,
"endTimestampMillis": 123,
"customAttribute": "xyz789",
"labeledBy": "PRELABELED",
"labeledByUserId": "4",
"status": "LABELED",
"type": "AUDIO"
}
]
}
}
deleteBBoxArrowLabels
Response
Returns [BBoxArrowLabel!]!
Example
Query
mutation DeleteBBoxArrowLabels(
$documentId: ID!,
$arrowLabelIds: [ID!]!
) {
deleteBBoxArrowLabels(
documentId: $documentId,
arrowLabelIds: $arrowLabelIds
) {
id
documentId
originBBoxLabelId
destinationBBoxLabelId
type
arrowLabelClassId
originShapeIndex
destinationShapeIndex
status
labeledBy
labeledByUserId
acceptedByUserId
rejectedByUserId
updatedAt
}
}
Variables
{
"documentId": "4",
"arrowLabelIds": ["4"]
}
Response
{
"data": {
"deleteBBoxArrowLabels": [
{
"id": "4",
"documentId": "4",
"originBBoxLabelId": 4,
"destinationBBoxLabelId": "4",
"type": "abc123",
"arrowLabelClassId": 4,
"originShapeIndex": 123,
"destinationShapeIndex": 123,
"status": "LABELED",
"labeledBy": "PRELABELED",
"labeledByUserId": "4",
"acceptedByUserId": "4",
"rejectedByUserId": "4",
"updatedAt": "xyz789"
}
]
}
}
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
labeledBy
labeledByUserId
}
}
Variables
{"documentId": 4, "labelIds": ["4"]}
Response
{
"data": {
"deleteBBoxLabels": [
{
"id": 4,
"documentId": 4,
"bboxLabelClassId": 4,
"deleted": false,
"caption": "xyz789",
"shapes": [BBoxShape],
"answers": AnswerScalar,
"labeledBy": "PRELABELED",
"labeledByUserId": 4
}
]
}
}
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": 123,
"pageIndex": 987,
"layer": 987,
"position": TextRange,
"hashCode": "xyz789",
"type": "AUDIO",
"labeledBy": "PRELABELED"
}
]
}
}
deleteChunk
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a DeleteChunkResponse!
Arguments
| Name | Description |
|---|---|
input - DeleteChunkInput!
|
Example
Query
mutation DeleteChunk($input: DeleteChunkInput!) {
deleteChunk(input: $input) {
deletedChunk {
text
metadata
embedding
}
previousChunk {
text
metadata
embedding
}
nextChunk {
text
metadata
embedding
}
}
}
Variables
{"input": DeleteChunkInput}
Response
{
"data": {
"deleteChunk": {
"deletedChunk": DocumentChunk,
"previousChunk": DocumentChunk,
"nextChunk": DocumentChunk
}
}
}
deleteComment
deleteCreateProjectAction
Example
Query
mutation DeleteCreateProjectAction(
$teamId: ID!,
$actionId: ID!
) {
deleteCreateProjectAction(
teamId: $teamId,
actionId: $actionId
)
}
Variables
{"teamId": 4, "actionId": "4"}
Response
{"data": {"deleteCreateProjectAction": false}}
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": "xyz789",
"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": "xyz789"
}
Response
{"data": {"deleteDocumentAnswers": false}}
deleteDomainClaim
Example
Query
mutation DeleteDomainClaim(
$teamId: ID!,
$domain: String!
) {
deleteDomainClaim(
teamId: $teamId,
domain: $domain
)
}
Variables
{
"teamId": "4",
"domain": "xyz789"
}
Response
{"data": {"deleteDomainClaim": true}}
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
name
effectiveName
credentials {
roleArn
externalId
serviceAccount
tenantId
storageContainerUrl
region
tenantUsername
}
securityToken
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
projects {
id
team {
...TeamFragment
}
teamId
owner {
...UserFragment
}
externalObjectStorageId
rootDocumentId
assignees {
...ProjectAssignmentFragment
}
name
tags {
...TagFragment
}
type
createdDate
completedDate
exportedDate
updatedDate
isOwnerMe
isReviewByMeAllowed
settings {
...ProjectSettingsFragment
}
workspaceSettings {
...WorkspaceSettingsFragment
}
reviewingStatus {
...ReviewingStatusFragment
}
labelingStatus {
...LabelingStatusFragment
}
status
performance {
...ProjectPerformanceFragment
}
selfLabelingStatus
purpose
rootCabinet {
...CabinetFragment
}
reviewCabinet {
...CabinetFragment
}
labelerCabinets {
...CabinetFragment
}
guideline {
...GuidelineFragment
}
isArchived
projectMetadataItems {
...ProjectMetadataItemFragment
}
availableDocumentsCount
}
readOnly
createdAt
updatedAt
}
}
Variables
{"externalObjectStorageId": 4}
Response
{
"data": {
"deleteExternalObjectStorage": {
"id": 4,
"cloudService": "AWS_S3",
"bucketId": "xyz789",
"bucketName": "abc123",
"name": "abc123",
"effectiveName": "abc123",
"credentials": ExternalObjectStorageCredentials,
"securityToken": "abc123",
"team": Team,
"projects": [Project],
"readOnly": false,
"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": ["abc123"]
}
}
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": 123,
"errorPossibility": 987.65,
"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
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
status
customAttribute
}
statistic {
documentId
numberOfChunks
numberOfSentences
numberOfTokens
effectiveTimeSpent
touchedSentences
labeledLines
answeredLines
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
prelabeledLines
}
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
updatedByUserId
updatedByUser {
id
samlId
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
}
llmVectorStores {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
maxChunkSize
createdAt
updatedAt
}
createdAt
updatedAt
isDeleted
}
}
Variables
{"ids": ["4"]}
Response
{
"data": {
"deleteLlmApplicationConfigurations": [
{
"id": 4,
"name": "xyz789",
"teamId": "4",
"createdByUserId": "4",
"updatedByUserId": "4",
"updatedByUser": User,
"llmRagConfigId": 4,
"llmRagConfig": LlmRagConfig,
"createdAt": "xyz789",
"updatedAt": "abc123",
"isDeleted": true
}
]
}
}
deleteLlmApplicationDeployment
Breaking changes may be introduced anytime in the future without prior notice.
deleteLlmApplicationDeployments
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.
deleteLlmApplicationPlaygroundPromptAttachments
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplicationPlaygroundPrompt!
Example
Query
mutation DeleteLlmApplicationPlaygroundPromptAttachments(
$id: ID!,
$llmApplicationPlaygroundPromptAttachmentIds: [ID!]!
) {
deleteLlmApplicationPlaygroundPromptAttachments(
id: $id,
llmApplicationPlaygroundPromptAttachmentIds: $llmApplicationPlaygroundPromptAttachmentIds
) {
id
llmApplicationId
name
createdAt
updatedAt
lastPromptMessage {
id
llmApplicationPlaygroundPromptId
content
role
attachments {
...LlmApplicationPlaygroundPromptAttachmentFragment
}
createdAt
updatedAt
}
totalPromptMessages
}
}
Variables
{
"id": "4",
"llmApplicationPlaygroundPromptAttachmentIds": [
"4"
]
}
Response
{
"data": {
"deleteLlmApplicationPlaygroundPromptAttachments": {
"id": 4,
"llmApplicationId": 4,
"name": "abc123",
"createdAt": "abc123",
"updatedAt": "xyz789",
"lastPromptMessage": LlmApplicationPlaygroundPromptMessage,
"totalPromptMessages": 987
}
}
}
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.
deleteLlmEmbeddingModel
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmEmbeddingModel!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation DeleteLlmEmbeddingModel($id: ID!) {
deleteLlmEmbeddingModel(id: $id) {
id
teamId
provider
name
displayName
url
maxTokens
dimensions
deployableModelId
isModelDeployable
createdAt
updatedAt
variant
customDimension
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteLlmEmbeddingModel": {
"id": 4,
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "abc123",
"displayName": "xyz789",
"url": "xyz789",
"maxTokens": 987,
"dimensions": 987,
"deployableModelId": "abc123",
"isModelDeployable": false,
"createdAt": "abc123",
"updatedAt": "xyz789",
"variant": "META",
"customDimension": false
}
}
}
deleteLlmEvaluationGeneratedAnswersByIds
Example
Query
mutation DeleteLlmEvaluationGeneratedAnswersByIds(
$llmEvaluationId: ID!,
$ids: [ID!]!
) {
deleteLlmEvaluationGeneratedAnswersByIds(
llmEvaluationId: $llmEvaluationId,
ids: $ids
)
}
Variables
{
"llmEvaluationId": "4",
"ids": ["4"]
}
Response
{"data": {"deleteLlmEvaluationGeneratedAnswersByIds": [4]}}
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
}
scheduledCommandConfig {
id
cronPattern
repeatInterval
runImmediately
endTime
numberOfRepetition
isNeverEnding
isPeriodic
updatedAt
}
isScheduled
createdAt
updatedAt
isDeleted
type
schedulingStatus
nextSchedule
createdByUser {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
lastScoredByUser {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
totalPrompts
lastLlmEvaluationExecution {
id
llmEvaluationId
status
errorMessage
createdAt
updatedAt
isDeleted
}
}
}
Variables
{"ids": ["4"]}
Response
{
"data": {
"deleteLlmEvaluations": [
{
"id": "4",
"name": "xyz789",
"teamId": 4,
"projectId": 4,
"kind": "DOCUMENT_BASED",
"status": "CREATING",
"creationProgress": LlmEvaluationCreationProgress,
"scheduledCommandConfig": ScheduledCommandConfig,
"isScheduled": true,
"createdAt": "abc123",
"updatedAt": "abc123",
"isDeleted": false,
"type": "RATING",
"schedulingStatus": "NOT_STARTED",
"nextSchedule": "abc123",
"createdByUser": User,
"lastScoredByUser": User,
"totalPrompts": 123,
"lastLlmEvaluationExecution": LlmEvaluationExecution
}
]
}
}
deleteLlmModel
Breaking changes may be introduced anytime in the future without prior notice.
Example
Query
mutation DeleteLlmModel($id: ID!) {
deleteLlmModel(id: $id) {
id
teamId
provider
name
displayName
url
region
maxTemperature
maxTopP
maxTokens
maxContextWindow
defaultTemperature
defaultTopP
defaultMaxTokens
minTemperature
minTopP
llmModelFineTuningJob {
id
name
teamId
status
errorMessage
baseModelId
parentId
resultModelId
trainingJobId
trainingDataset {
...GroundTruthSetFragment
}
trainingDatasetFilename
validationSize
validationDataset {
...GroundTruthSetFragment
}
validationDatasetFilename
epochs
learningRate
batchSize
earlyStoppingThreshold
earlyStoppingPatience
learningRateWarmUpStep
learningRateMultiplier
instanceType
trainingVolumeSize
trainingBucketName
optionalHyperparameters
createdByUser {
...UserFragment
}
createdAt
updatedAt
}
deployableModelId
isModelDeployable
forceAnonymization
hasVisionCapability
variant
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteLlmModel": {
"id": "4",
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "xyz789",
"displayName": "xyz789",
"url": "xyz789",
"region": ["xyz789"],
"maxTemperature": 123.45,
"maxTopP": 123.45,
"maxTokens": 987,
"maxContextWindow": 987,
"defaultTemperature": 123.45,
"defaultTopP": 123.45,
"defaultMaxTokens": 123,
"minTemperature": 123.45,
"minTopP": 987.65,
"llmModelFineTuningJob": LlmModelFineTuningJob,
"deployableModelId": "xyz789",
"isModelDeployable": false,
"forceAnonymization": true,
"hasVisionCapability": false,
"variant": "META",
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
deleteLlmVectorStoreUrlSyncSchedule
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmVectorStore!
Arguments
| Name | Description |
|---|---|
input - DeleteLlmVectorStoreUrlSyncScheduleInput!
|
Example
Query
mutation DeleteLlmVectorStoreUrlSyncSchedule($input: DeleteLlmVectorStoreUrlSyncScheduleInput!) {
deleteLlmVectorStoreUrlSyncSchedule(input: $input) {
id
teamId
createdByUser {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
llmEmbeddingModel {
id
teamId
provider
name
displayName
url
maxTokens
dimensions
deployableModelId
isModelDeployable
createdAt
updatedAt
variant
customDimension
}
provider
collectionId
name
status
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
targetEntity
}
jobId
chunkConfiguration
filePropertiesExtractorConfiguration {
type
configuration
syncedFilePropertiesJsonSchema
}
urlSyncScheduledCommandConfig {
id
cronPattern
repeatInterval
runImmediately
endTime
numberOfRepetition
isNeverEnding
isPeriodic
updatedAt
}
urlSyncNextSchedule
urlSyncLastSyncedAt
createdAt
updatedAt
dimension
}
}
Variables
{"input": DeleteLlmVectorStoreUrlSyncScheduleInput}
Response
{
"data": {
"deleteLlmVectorStoreUrlSyncSchedule": {
"id": 4,
"teamId": 4,
"createdByUser": User,
"llmEmbeddingModel": LlmEmbeddingModel,
"provider": "DATASAUR",
"collectionId": "abc123",
"name": "abc123",
"status": "CREATED",
"documents": [LlmVectorStoreDocumentScalar],
"documentStatusCount": LlmVectorStoreDocumentCountByStatus,
"sourceDocuments": [LlmVectorStoreSourceDocument],
"questions": [Question],
"jobId": "xyz789",
"chunkConfiguration": ChunkConfiguration,
"filePropertiesExtractorConfiguration": LlmVectorStoreFilePropertiesExtractorConfiguration,
"urlSyncScheduledCommandConfig": ScheduledCommandConfig,
"urlSyncNextSchedule": "xyz789",
"urlSyncLastSyncedAt": "xyz789",
"createdAt": "xyz789",
"updatedAt": "abc123",
"dimension": 987
}
}
}
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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
taskScope {
...TaskScopeFragment
}
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
enableRapidLabelingFeedback
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
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
}
anonymizationMaskedColumnIds
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
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
}
availableDocumentsCount
}
}
Variables
{"input": DeleteProjectInput}
Response
{
"data": {
"deleteProject": {
"id": 4,
"team": Team,
"teamId": 4,
"owner": User,
"externalObjectStorageId": "xyz789",
"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": true,
"projectMetadataItems": [ProjectMetadataItem],
"availableDocumentsCount": 123
}
}
}
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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
taskScope {
...TaskScopeFragment
}
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
enableRapidLabelingFeedback
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
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
}
anonymizationMaskedColumnIds
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
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
}
availableDocumentsCount
}
}
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": "abc123",
"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],
"availableDocumentsCount": 123
}
]
}
}
deletePromptConversationHistory
Breaking changes may be introduced anytime in the future without prior notice.
deleteQuestionSet
deleteQuestionSets
deleteRow
Response
Returns a DeleteRowResult!
Example
Query
mutation DeleteRow(
$documentId: String!,
$signature: String!,
$rowId: Int!
) {
deleteRow(
documentId: $documentId,
signature: $signature,
rowId: $rowId
) {
document {
id
chunks {
...TextChunkFragment
}
createdAt
currentSentenceCursor
lastLabeledLine
documentSettings {
...TextDocumentSettingsFragment
}
fileName
isCompleted
completedByUserId
lastSavedAt
mimeType
name
projectId
sentences {
...TextSentenceFragment
}
settings {
...SettingsFragment
}
statistic {
...TextDocumentStatisticFragment
}
status
statusUpdatedByUserId
timeLimit
timeLimitScheduledCommandId
type
updatedChunks {
...TextChunkFragment
}
updatedTokenLabels {
...TextLabelFragment
}
url
version
workspaceState {
...WorkspaceStateFragment
}
originId
signature
part
}
deletedCells {
line
index
content
tokens
metadata {
...CellMetadataFragment
}
conversationalMetadata {
...ConversationalMetadataFragment
}
status
conflict
conflicts {
...CellConflictFragment
}
originCell {
...CellFragment
}
}
}
}
Variables
{
"documentId": "abc123",
"signature": "abc123",
"rowId": 987
}
Response
{
"data": {
"deleteRow": {
"document": TextDocument,
"deletedCells": [Cell]
}
}
}
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": 987,
"questionSetSignature": "abc123"
}
Response
{"data": {"deleteRowAnswers": false}}
deleteSavedSearch
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
completedByUserId
lastSavedAt
mimeType
name
projectId
sentences {
...TextSentenceFragment
}
settings {
...SettingsFragment
}
statistic {
...TextDocumentStatisticFragment
}
status
statusUpdatedByUserId
timeLimit
timeLimitScheduledCommandId
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
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
status
customAttribute
}
deletedLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
status
customAttribute
}
}
}
Variables
{
"documentId": "abc123",
"signature": "xyz789",
"sentenceId": 987
}
Response
{
"data": {
"deleteSentence": {
"document": TextDocument,
"updatedCell": Cell,
"addedLabels": [TextLabel],
"deletedLabels": [TextLabel]
}
}
}
deleteTeamApiKey
deleteTeamOauthApplication
Example
Query
mutation DeleteTeamOauthApplication(
$id: ID!,
$teamId: ID!
) {
deleteTeamOauthApplication(
id: $id,
teamId: $teamId
)
}
Variables
{"id": 4, "teamId": "4"}
Response
{"data": {"deleteTeamOauthApplication": false}}
deleteTeamWebhook
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
counter
type
}
}
Variables
{
"documentId": "4",
"labelIds": ["4"]
}
Response
{
"data": {
"deleteTimestampLabels": [
{
"id": 4,
"documentId": 4,
"layer": 123,
"position": TextRange,
"startTimestampMillis": 123,
"endTimestampMillis": 123,
"counter": 987,
"type": "AUDIO"
}
]
}
}
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
teamId
provider
name
displayName
url
maxTokens
dimensions
deployableModelId
isModelDeployable
createdAt
updatedAt
variant
customDimension
}
}
Variables
{"input": LlmModelDeployInput}
Response
{
"data": {
"deployLlmEmbeddingModel": {
"id": 4,
"teamId": 4,
"provider": "AMAZON_BEDROCK",
"name": "xyz789",
"displayName": "xyz789",
"url": "abc123",
"maxTokens": 987,
"dimensions": 123,
"deployableModelId": "xyz789",
"isModelDeployable": true,
"createdAt": "abc123",
"updatedAt": "abc123",
"variant": "META",
"customDimension": true
}
}
}
deployLlmModel
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmModel!
Example
Query
mutation DeployLlmModel(
$id: ID!,
$teamId: ID!,
$instanceType: String,
$automatedUndeployHours: Int
) {
deployLlmModel(
id: $id,
teamId: $teamId,
instanceType: $instanceType,
automatedUndeployHours: $automatedUndeployHours
) {
id
teamId
provider
name
displayName
url
region
maxTemperature
maxTopP
maxTokens
maxContextWindow
defaultTemperature
defaultTopP
defaultMaxTokens
minTemperature
minTopP
llmModelFineTuningJob {
id
name
teamId
status
errorMessage
baseModelId
parentId
resultModelId
trainingJobId
trainingDataset {
...GroundTruthSetFragment
}
trainingDatasetFilename
validationSize
validationDataset {
...GroundTruthSetFragment
}
validationDatasetFilename
epochs
learningRate
batchSize
earlyStoppingThreshold
earlyStoppingPatience
learningRateWarmUpStep
learningRateMultiplier
instanceType
trainingVolumeSize
trainingBucketName
optionalHyperparameters
createdByUser {
...UserFragment
}
createdAt
updatedAt
}
deployableModelId
isModelDeployable
forceAnonymization
hasVisionCapability
variant
createdAt
updatedAt
}
}
Variables
{
"id": "4",
"teamId": "4",
"instanceType": "xyz789",
"automatedUndeployHours": 987
}
Response
{
"data": {
"deployLlmModel": {
"id": 4,
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "xyz789",
"displayName": "abc123",
"url": "xyz789",
"region": ["abc123"],
"maxTemperature": 987.65,
"maxTopP": 987.65,
"maxTokens": 123,
"maxContextWindow": 987,
"defaultTemperature": 123.45,
"defaultTopP": 987.65,
"defaultMaxTokens": 123,
"minTemperature": 987.65,
"minTopP": 123.45,
"llmModelFineTuningJob": LlmModelFineTuningJob,
"deployableModelId": "abc123",
"isModelDeployable": false,
"forceAnonymization": false,
"hasVisionCapability": false,
"variant": "META",
"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
azureAIClientId
azureAICertificate
azureAITenantId
azureAISubscriptionId
azureAIResourceGroupName
azureAIAccountName
awsSagemakerRegion
awsSagemakerExternalId
awsSagemakerRoleArn
awsBedrockRegion
awsBedrockExternalId
awsBedrockRoleArn
vertexAiClientEmail
vertexAiPrivateKey
vertexAiProjectId
vertexAiRegion
}
createdAt
updatedAt
}
}
Variables
{"input": TeamExternalApiKeyDisconnectInput}
Response
{
"data": {
"disconnectTeamExternalApiKey": {
"id": "4",
"teamId": 4,
"credentials": [TeamExternalApiKeyCredential],
"createdAt": "abc123",
"updatedAt": "xyz789"
}
}
}
duplicateLlmApplicationPlaygroundPrompt
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplicationPlaygroundPrompt!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation DuplicateLlmApplicationPlaygroundPrompt($id: ID!) {
duplicateLlmApplicationPlaygroundPrompt(id: $id) {
id
llmApplicationId
name
createdAt
updatedAt
lastPromptMessage {
id
llmApplicationPlaygroundPromptId
content
role
attachments {
...LlmApplicationPlaygroundPromptAttachmentFragment
}
createdAt
updatedAt
}
totalPromptMessages
}
}
Variables
{"id": "4"}
Response
{
"data": {
"duplicateLlmApplicationPlaygroundPrompt": {
"id": 4,
"llmApplicationId": "4",
"name": "xyz789",
"createdAt": "xyz789",
"updatedAt": "xyz789",
"lastPromptMessage": LlmApplicationPlaygroundPromptMessage,
"totalPromptMessages": 123
}
}
}
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
}
llmVectorStores {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
maxChunkSize
createdAt
updatedAt
}
name
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"duplicateLlmApplicationPlaygroundRagConfig": {
"id": 4,
"llmApplicationId": 4,
"llmRagConfig": LlmRagConfig,
"name": "abc123",
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
editComment
Example
Query
mutation EditComment(
$commentId: ID!,
$message: String!
) {
editComment(
commentId: $commentId,
message: $message
) {
id
parentId
documentId
originDocumentId
userId
user {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
message
resolved
resolvedAt
resolvedBy {
id
samlId
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": 123,
"user": User,
"message": "abc123",
"resolved": true,
"resolvedAt": "xyz789",
"resolvedBy": User,
"repliesCount": 987,
"createdAt": "xyz789",
"updatedAt": "abc123",
"lastEditedAt": "xyz789",
"hashCode": "xyz789",
"commentedContent": CommentedContent
}
}
}
editCustomEmbeddingModel
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmEmbeddingModel!
Arguments
| Name | Description |
|---|---|
input - EditCustomEmbeddingModelInput!
|
Example
Query
mutation EditCustomEmbeddingModel($input: EditCustomEmbeddingModelInput!) {
editCustomEmbeddingModel(input: $input) {
id
teamId
provider
name
displayName
url
maxTokens
dimensions
deployableModelId
isModelDeployable
createdAt
updatedAt
variant
customDimension
}
}
Variables
{"input": EditCustomEmbeddingModelInput}
Response
{
"data": {
"editCustomEmbeddingModel": {
"id": "4",
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "abc123",
"displayName": "xyz789",
"url": "xyz789",
"maxTokens": 987,
"dimensions": 123,
"deployableModelId": "abc123",
"isModelDeployable": false,
"createdAt": "xyz789",
"updatedAt": "abc123",
"variant": "META",
"customDimension": false
}
}
}
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
teamId
provider
name
displayName
url
region
maxTemperature
maxTopP
maxTokens
maxContextWindow
defaultTemperature
defaultTopP
defaultMaxTokens
minTemperature
minTopP
llmModelFineTuningJob {
id
name
teamId
status
errorMessage
baseModelId
parentId
resultModelId
trainingJobId
trainingDataset {
...GroundTruthSetFragment
}
trainingDatasetFilename
validationSize
validationDataset {
...GroundTruthSetFragment
}
validationDatasetFilename
epochs
learningRate
batchSize
earlyStoppingThreshold
earlyStoppingPatience
learningRateWarmUpStep
learningRateMultiplier
instanceType
trainingVolumeSize
trainingBucketName
optionalHyperparameters
createdByUser {
...UserFragment
}
createdAt
updatedAt
}
deployableModelId
isModelDeployable
forceAnonymization
hasVisionCapability
variant
createdAt
updatedAt
}
}
Variables
{"input": EditLlmCustomModelInput}
Response
{
"data": {
"editCustomModel": {
"id": 4,
"teamId": 4,
"provider": "AMAZON_BEDROCK",
"name": "abc123",
"displayName": "abc123",
"url": "xyz789",
"region": ["xyz789"],
"maxTemperature": 123.45,
"maxTopP": 987.65,
"maxTokens": 987,
"maxContextWindow": 123,
"defaultTemperature": 987.65,
"defaultTopP": 987.65,
"defaultMaxTokens": 987,
"minTemperature": 123.45,
"minTopP": 123.45,
"llmModelFineTuningJob": LlmModelFineTuningJob,
"deployableModelId": "abc123",
"isModelDeployable": false,
"forceAnonymization": true,
"hasVisionCapability": false,
"variant": "META",
"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
completedByUserId
lastSavedAt
mimeType
name
projectId
sentences {
...TextSentenceFragment
}
settings {
...SettingsFragment
}
statistic {
...TextDocumentStatisticFragment
}
status
statusUpdatedByUserId
timeLimit
timeLimitScheduledCommandId
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": 123
}
}
}
enableUserTotpAuthentication
Response
Returns a TotpRecoveryCodes!
Example
Query
mutation EnableUserTotpAuthentication(
$totpCode: String!,
$totpSecret: String!
) {
enableUserTotpAuthentication(
totpCode: $totpCode,
totpSecret: $totpSecret
) {
recoveryCodes
}
}
Variables
{
"totpCode": "xyz789",
"totpSecret": "xyz789"
}
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": true}}
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": "abc123",
"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": "abc123",
"qrCode": "xyz789"
}
}
}
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"
}
}
}
getOrCreateTeamInvitationLink
Response
Returns a TeamInvitationLink!
Arguments
| Name | Description |
|---|---|
input - GetOrCreateTeamInvitationLinkInput!
|
Example
Query
mutation GetOrCreateTeamInvitationLink($input: GetOrCreateTeamInvitationLinkInput!) {
getOrCreateTeamInvitationLink(input: $input) {
id
teamId
createdByUserId
invitationKey
expiredAt
createdAt
updatedAt
}
}
Variables
{"input": GetOrCreateTeamInvitationLinkInput}
Response
{
"data": {
"getOrCreateTeamInvitationLink": {
"id": 4,
"teamId": "4",
"createdByUserId": "4",
"invitationKey": "xyz789",
"expiredAt": "xyz789",
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
importLlmApplicationPlaygroundRagConfig
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplicationPlaygroundRagConfig!
Arguments
| Name | Description |
|---|---|
input - LlmApplicationPlaygroundRagConfigImportInput!
|
Example
Query
mutation ImportLlmApplicationPlaygroundRagConfig($input: LlmApplicationPlaygroundRagConfigImportInput!) {
importLlmApplicationPlaygroundRagConfig(input: $input) {
id
llmApplicationId
llmRagConfig {
id
llmModel {
...LlmModelFragment
}
systemInstruction
userInstruction
raw
temperature
topP
maxTokens
advancedHyperparameters
maxVectorStoreTokens
llmVectorStore {
...LlmVectorStoreFragment
}
llmVectorStores {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
maxChunkSize
createdAt
updatedAt
}
name
createdAt
updatedAt
}
}
Variables
{"input": LlmApplicationPlaygroundRagConfigImportInput}
Response
{
"data": {
"importLlmApplicationPlaygroundRagConfig": {
"id": 4,
"llmApplicationId": 4,
"llmRagConfig": LlmRagConfig,
"name": "xyz789",
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
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
}
anonymizationMaskedColumnIds
fileTransformerId
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
fileName
isCompleted
completedByUserId
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
labeledLines
answeredLines
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
prelabeledLines
}
status
statusUpdatedByUserId
timeLimit
timeLimitScheduledCommandId
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
status
customAttribute
}
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": 987,
"lastLabeledLine": 123,
"documentSettings": TextDocumentSettings,
"fileName": "xyz789",
"isCompleted": false,
"completedByUserId": "4",
"lastSavedAt": "xyz789",
"mimeType": "abc123",
"name": "xyz789",
"projectId": 4,
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"status": "NOT_STARTED",
"statusUpdatedByUserId": "4",
"timeLimit": "2007-12-03T10:15:30Z",
"timeLimitScheduledCommandId": "4",
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "xyz789",
"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
completedByUserId
lastSavedAt
mimeType
name
projectId
sentences {
...TextSentenceFragment
}
settings {
...SettingsFragment
}
statistic {
...TextDocumentStatisticFragment
}
status
statusUpdatedByUserId
timeLimit
timeLimitScheduledCommandId
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]
}
}
}
insertRow
Response
Returns an InsertRowResult!
Arguments
| Name | Description |
|---|---|
documentId - String!
|
|
signature - String!
|
|
rowCells - [RowCellInput!]!
|
|
insertTarget - InsertTargetInput!
|
|
tokenizationMethod - TokenizationMethod
|
Example
Query
mutation InsertRow(
$documentId: String!,
$signature: String!,
$rowCells: [RowCellInput!]!,
$insertTarget: InsertTargetInput!,
$tokenizationMethod: TokenizationMethod
) {
insertRow(
documentId: $documentId,
signature: $signature,
rowCells: $rowCells,
insertTarget: $insertTarget,
tokenizationMethod: $tokenizationMethod
) {
line
cells {
line
index
content
tokens
metadata {
...CellMetadataFragment
}
conversationalMetadata {
...ConversationalMetadataFragment
}
status
conflict
conflicts {
...CellConflictFragment
}
originCell {
...CellFragment
}
}
}
}
Variables
{
"documentId": "xyz789",
"signature": "abc123",
"rowCells": [RowCellInput],
"insertTarget": InsertTargetInput,
"tokenizationMethod": "WINK"
}
Response
{"data": {"insertRow": {"line": 123, "cells": [Cell]}}}
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
labelerTeamMemberId
cell {
...CellFragment
}
labels {
...TextLabelFragment
}
}
originCell {
line
index
content
tokens
metadata {
...CellMetadataFragment
}
conversationalMetadata {
...ConversationalMetadataFragment
}
status
conflict
conflicts {
...CellConflictFragment
}
originCell {
...CellFragment
}
}
}
}
Variables
{
"documentId": "xyz789",
"signature": "abc123",
"insertTarget": InsertTargetInput,
"content": "abc123",
"tokenizationMethod": "WINK",
"metadata": [CellMetadataInput]
}
Response
{
"data": {
"insertSentence": {
"line": 987,
"index": 123,
"content": "abc123",
"tokens": ["abc123"],
"metadata": [CellMetadata],
"conversationalMetadata": ConversationalMetadata,
"status": "DISPLAYED",
"conflict": true,
"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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
userId
role {
id
name
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
id
userId
projectStatistic {
...TeamMemberProjectStatisticFragment
}
totalTimeSpent
effectiveTotalTimeSpent
accuracy
}
labelingAgent {
id
agentId
agentType
name
}
labelingAgentId
}
}
Variables
{"input": InviteTeamMembersInput, "datasaurApp": "NLP"}
Response
{
"data": {
"inviteTeamMembers": [
{
"id": "4",
"user": User,
"userId": 4,
"role": TeamRole,
"invitationEmail": "xyz789",
"invitationStatus": "xyz789",
"invitationKey": "xyz789",
"isDeleted": true,
"joinedDate": "xyz789",
"performance": TeamMemberPerformance,
"labelingAgent": LabelingAgent,
"labelingAgentId": 4
}
]
}
}
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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
taskScope {
...TaskScopeFragment
}
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
enableRapidLabelingFeedback
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
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
}
anonymizationMaskedColumnIds
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
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
}
availableDocumentsCount
}
}
Variables
{"input": LaunchTextProjectInput}
Response
{
"data": {
"launchTextProject": {
"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": 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],
"availableDocumentsCount": 987
}
}
}
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
retryCount
maxRetry
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 LoadLlmApplicationConfigurationToPlaygroundResponse!
Arguments
| Name | Description |
|---|---|
input - LoadLlmApplicationConfigurationInput!
|
Example
Query
mutation LoadLlmApplicationConfigurationToPlayground($input: LoadLlmApplicationConfigurationInput!) {
loadLlmApplicationConfigurationToPlayground(input: $input) {
llmApplicationPlaygroundRagConfigId
llmApplicationConfigurationId
}
}
Variables
{"input": LoadLlmApplicationConfigurationInput}
Response
{
"data": {
"loadLlmApplicationConfigurationToPlayground": {
"llmApplicationPlaygroundRagConfigId": "4",
"llmApplicationConfigurationId": "4"
}
}
}
logToggleRealTimeAssistedLabeling
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
input - ToggleRealTimeAssistedActivityInput!
|
Example
Query
mutation LogToggleRealTimeAssistedLabeling($input: ToggleRealTimeAssistedActivityInput!) {
logToggleRealTimeAssistedLabeling(input: $input)
}
Variables
{"input": ToggleRealTimeAssistedActivityInput}
Response
{"data": {"logToggleRealTimeAssistedLabeling": false}}
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": "xyz789"}}
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
}
anonymizationMaskedColumnIds
fileTransformerId
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
fileName
isCompleted
completedByUserId
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
labeledLines
answeredLines
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
prelabeledLines
}
status
statusUpdatedByUserId
timeLimit
timeLimitScheduledCommandId
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
status
customAttribute
}
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": "abc123",
"isCompleted": true,
"completedByUserId": 4,
"lastSavedAt": "abc123",
"mimeType": "xyz789",
"name": "xyz789",
"projectId": 4,
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"status": "NOT_STARTED",
"statusUpdatedByUserId": "4",
"timeLimit": "2007-12-03T10:15:30Z",
"timeLimitScheduledCommandId": "4",
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "xyz789",
"version": 123,
"workspaceState": WorkspaceState,
"originId": "4",
"signature": "abc123",
"part": 123
}
]
}
}
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
}
anonymizationMaskedColumnIds
fileTransformerId
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
fileName
isCompleted
completedByUserId
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
labeledLines
answeredLines
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
prelabeledLines
}
status
statusUpdatedByUserId
timeLimit
timeLimitScheduledCommandId
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
status
customAttribute
}
url
version
workspaceState {
id
chunkId
sentenceStart
sentenceEnd
touchedChunks
touchedSentences
}
originId
signature
part
}
}
Variables
{"documentId": 4, "skipValidation": true}
Response
{
"data": {
"markDocumentAsComplete": {
"id": "4",
"chunks": [TextChunk],
"createdAt": "abc123",
"currentSentenceCursor": 987,
"lastLabeledLine": 987,
"documentSettings": TextDocumentSettings,
"fileName": "xyz789",
"isCompleted": false,
"completedByUserId": "4",
"lastSavedAt": "abc123",
"mimeType": "xyz789",
"name": "xyz789",
"projectId": 4,
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"status": "NOT_STARTED",
"statusUpdatedByUserId": "4",
"timeLimit": "2007-12-03T10:15:30Z",
"timeLimitScheduledCommandId": 4,
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "xyz789",
"version": 987,
"workspaceState": WorkspaceState,
"originId": "4",
"signature": "abc123",
"part": 123
}
}
}
markDocumentAsFavorite
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns an ID!
Arguments
| Name | Description |
|---|---|
input - MarkDocumentAsFavoriteInput!
|
Example
Query
mutation MarkDocumentAsFavorite($input: MarkDocumentAsFavoriteInput!) {
markDocumentAsFavorite(input: $input)
}
Variables
{"input": MarkDocumentAsFavoriteInput}
Response
{"data": {"markDocumentAsFavorite": "4"}}
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
}
anonymizationMaskedColumnIds
fileTransformerId
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
fileName
isCompleted
completedByUserId
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
labeledLines
answeredLines
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
prelabeledLines
}
status
statusUpdatedByUserId
timeLimit
timeLimitScheduledCommandId
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
status
customAttribute
}
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": "abc123",
"currentSentenceCursor": 987,
"lastLabeledLine": 987,
"documentSettings": TextDocumentSettings,
"fileName": "abc123",
"isCompleted": false,
"completedByUserId": "4",
"lastSavedAt": "abc123",
"mimeType": "xyz789",
"name": "abc123",
"projectId": "4",
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"status": "NOT_STARTED",
"statusUpdatedByUserId": "4",
"timeLimit": "2007-12-03T10:15:30Z",
"timeLimitScheduledCommandId": 4,
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "abc123",
"version": 987,
"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": "xyz789",
"isMarked": false
}
}
}
migrateUserDataToHubspot
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
userIds - [String!]!
|
Example
Query
mutation MigrateUserDataToHubspot($userIds: [String!]!) {
migrateUserDataToHubspot(userIds: $userIds)
}
Variables
{"userIds": ["abc123"]}
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
customScript {
...CustomScriptFragment
}
}
bindToColumn
activationConditionLogic
targetEntity
}
}
Variables
{
"projectId": 4,
"input": [ModifyQuestionInput],
"signature": "xyz789"
}
Response
{
"data": {
"modifyDocumentQuestions": [
{
"id": 123,
"internalId": "xyz789",
"type": "DROPDOWN",
"name": "xyz789",
"label": "abc123",
"required": false,
"config": QuestionConfig,
"bindToColumn": "abc123",
"activationConditionLogic": "abc123",
"targetEntity": "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
customScript {
...CustomScriptFragment
}
}
bindToColumn
activationConditionLogic
targetEntity
}
}
Variables
{
"projectId": 4,
"input": [ModifyQuestionInput],
"signature": "abc123"
}
Response
{
"data": {
"modifyRowQuestions": [
{
"id": 987,
"internalId": "xyz789",
"type": "DROPDOWN",
"name": "xyz789",
"label": "xyz789",
"required": false,
"config": QuestionConfig,
"bindToColumn": "abc123",
"activationConditionLogic": "abc123",
"targetEntity": "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
completedByUserId
lastSavedAt
mimeType
name
projectId
sentences {
...TextSentenceFragment
}
settings {
...SettingsFragment
}
statistic {
...TextDocumentStatisticFragment
}
status
statusUpdatedByUserId
timeLimit
timeLimitScheduledCommandId
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
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
status
customAttribute
}
previousTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
status
customAttribute
}
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
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"input": RecalculateBBoxLabelsShapesHashInput}
Response
{
"data": {
"recalculateBBoxLabelsShapesHash": {
"id": "abc123",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "abc123",
"retryCount": 123,
"maxRetry": 987,
"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": true}}
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": false}}
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
teamId
provider
name
displayName
url
maxTokens
dimensions
deployableModelId
isModelDeployable
createdAt
updatedAt
variant
customDimension
}
}
Variables
{"id": 4, "instanceType": "xyz789"}
Response
{
"data": {
"redeployLlmEmbeddingModel": {
"id": "4",
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "abc123",
"displayName": "xyz789",
"url": "abc123",
"maxTokens": 987,
"dimensions": 123,
"deployableModelId": "abc123",
"isModelDeployable": true,
"createdAt": "abc123",
"updatedAt": "xyz789",
"variant": "META",
"customDimension": false
}
}
}
regenerateTeamOauthApplicationSecret
Response
Returns an OauthApplicationSecretResult!
Example
Query
mutation RegenerateTeamOauthApplicationSecret(
$id: ID!,
$teamId: ID!
) {
regenerateTeamOauthApplicationSecret(
id: $id,
teamId: $teamId
) {
id
secret
}
}
Variables
{"id": 4, "teamId": "4"}
Response
{
"data": {
"regenerateTeamOauthApplicationSecret": {
"id": "4",
"secret": "xyz789"
}
}
}
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"]
}
}
}
rejectAllPredictedLabels
Response
Returns a Job!
Arguments
| Name | Description |
|---|---|
input - RejectAllPredictedLabelsInput!
|
Example
Query
mutation RejectAllPredictedLabels($input: RejectAllPredictedLabelsInput!) {
rejectAllPredictedLabels(input: $input) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"input": RejectAllPredictedLabelsInput}
Response
{
"data": {
"rejectAllPredictedLabels": {
"id": "abc123",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "xyz789",
"retryCount": 987,
"maxRetry": 123,
"additionalData": JobAdditionalData
}
}
}
rejectAudioLabelConflicts
Description
Rejects the given conflict candidates, removing them as review-document candidates.
Response
Returns [AudioLabel!]!
Example
Query
mutation RejectAudioLabelConflicts(
$documentId: ID!,
$labelIds: [ID!]!
) {
rejectAudioLabelConflicts(
documentId: $documentId,
labelIds: $labelIds
) {
id
hashCode
documentId
labelSetIndex
labelSetItemId
counter
startTimestampMillis
endTimestampMillis
customAttribute
labeledBy
labeledByUserId
status
type
}
}
Variables
{"documentId": "4", "labelIds": [4]}
Response
{
"data": {
"rejectAudioLabelConflicts": [
{
"id": 4,
"hashCode": "xyz789",
"documentId": 4,
"labelSetIndex": 123,
"labelSetItemId": 4,
"counter": 123,
"startTimestampMillis": 987,
"endTimestampMillis": 123,
"customAttribute": "xyz789",
"labeledBy": "PRELABELED",
"labeledByUserId": 4,
"status": "LABELED",
"type": "AUDIO"
}
]
}
}
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": 987,
"pageIndex": 987,
"layer": 987,
"position": TextRange,
"hashCode": "xyz789",
"type": "AUDIO",
"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
counter
type
}
}
Variables
{"documentId": 4, "labelIds": [4]}
Response
{
"data": {
"rejectTimestampLabelConflicts": [
{
"id": 4,
"documentId": 4,
"layer": 987,
"position": TextRange,
"startTimestampMillis": 123,
"endTimestampMillis": 987,
"counter": 987,
"type": "AUDIO"
}
]
}
}
removeDocumentFromFavorite
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns an ID!
Arguments
| Name | Description |
|---|---|
input - MarkDocumentAsFavoriteInput!
|
Example
Query
mutation RemoveDocumentFromFavorite($input: MarkDocumentAsFavoriteInput!) {
removeDocumentFromFavorite(input: $input)
}
Variables
{"input": MarkDocumentAsFavoriteInput}
Response
{"data": {"removeDocumentFromFavorite": 4}}
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": "abc123",
"createdAt": "abc123",
"updatedAt": "xyz789",
"language": "TYPESCRIPT",
"purpose": "IMPORT",
"readonly": false,
"externalId": "abc123",
"warmup": false
}
}
}
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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
taskScope {
...TaskScopeFragment
}
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
enableRapidLabelingFeedback
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
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
}
anonymizationMaskedColumnIds
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
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
}
availableDocumentsCount
}
}
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": "abc123",
"createdDate": "xyz789",
"completedDate": "abc123",
"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],
"availableDocumentsCount": 123
}
}
}
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": "xyz789"
}
}
}
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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
userId
role {
id
name
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
id
userId
projectStatistic {
...TeamMemberProjectStatisticFragment
}
totalTimeSpent
effectiveTotalTimeSpent
accuracy
}
labelingAgent {
id
agentId
agentType
name
}
labelingAgentId
}
}
Variables
{"input": RemoveTeamMemberInput}
Response
{
"data": {
"removeTeamMember": {
"id": 4,
"user": User,
"userId": 4,
"role": TeamRole,
"invitationEmail": "xyz789",
"invitationStatus": "xyz789",
"invitationKey": "xyz789",
"isDeleted": false,
"joinedDate": "xyz789",
"performance": TeamMemberPerformance,
"labelingAgent": LabelingAgent,
"labelingAgentId": "4"
}
}
}
removeTeamMembers
Response
Returns [TeamMember]
Arguments
| Name | Description |
|---|---|
input - RemoveTeamMembersInput!
|
Example
Query
mutation RemoveTeamMembers($input: RemoveTeamMembersInput!) {
removeTeamMembers(input: $input) {
id
user {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
userId
role {
id
name
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
id
userId
projectStatistic {
...TeamMemberProjectStatisticFragment
}
totalTimeSpent
effectiveTotalTimeSpent
accuracy
}
labelingAgent {
id
agentId
agentType
name
}
labelingAgentId
}
}
Variables
{"input": RemoveTeamMembersInput}
Response
{
"data": {
"removeTeamMembers": [
{
"id": "4",
"user": User,
"userId": 4,
"role": TeamRole,
"invitationEmail": "abc123",
"invitationStatus": "xyz789",
"invitationKey": "xyz789",
"isDeleted": false,
"joinedDate": "abc123",
"performance": TeamMemberPerformance,
"labelingAgent": LabelingAgent,
"labelingAgentId": "4"
}
]
}
}
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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
taskScope {
...TaskScopeFragment
}
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
enableRapidLabelingFeedback
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
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
}
anonymizationMaskedColumnIds
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
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
}
availableDocumentsCount
}
}
Variables
{"input": AssignProjectInput}
Response
{
"data": {
"replaceProjectAssignees": {
"id": "4",
"team": Team,
"teamId": 4,
"owner": User,
"externalObjectStorageId": "abc123",
"rootDocumentId": "4",
"assignees": [ProjectAssignment],
"name": "xyz789",
"tags": [Tag],
"type": "abc123",
"createdDate": "xyz789",
"completedDate": "abc123",
"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],
"availableDocumentsCount": 123
}
}
}
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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
taskScope {
...TaskScopeFragment
}
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
enableRapidLabelingFeedback
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
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
}
anonymizationMaskedColumnIds
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
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
}
availableDocumentsCount
}
}
Variables
{"input": ProjectMetadataInput}
Response
{
"data": {
"replaceProjectMetadata": {
"id": 4,
"team": Team,
"teamId": "4",
"owner": User,
"externalObjectStorageId": "abc123",
"rootDocumentId": "4",
"assignees": [ProjectAssignment],
"name": "xyz789",
"tags": [Tag],
"type": "xyz789",
"createdDate": "abc123",
"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": true,
"projectMetadataItems": [ProjectMetadataItem],
"availableDocumentsCount": 123
}
}
}
replicateTeamProject
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a Project!
Arguments
| Name | Description |
|---|---|
input - ReplicateTeamProjectInput!
|
Example
Query
mutation ReplicateTeamProject($input: ReplicateTeamProjectInput!) {
replicateTeamProject(input: $input) {
id
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
teamId
owner {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
taskScope {
...TaskScopeFragment
}
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
enableRapidLabelingFeedback
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
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
}
anonymizationMaskedColumnIds
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
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
}
availableDocumentsCount
}
}
Variables
{"input": ReplicateTeamProjectInput}
Response
{
"data": {
"replicateTeamProject": {
"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": "abc123",
"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],
"availableDocumentsCount": 987
}
}
}
replyComment
Example
Query
mutation ReplyComment(
$commentId: ID!,
$message: String!
) {
replyComment(
commentId: $commentId,
message: $message
) {
id
parentId
documentId
originDocumentId
userId
user {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
message
resolved
resolvedAt
resolvedBy {
id
samlId
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": "abc123",
"resolvedBy": User,
"repliesCount": 123,
"createdAt": "xyz789",
"updatedAt": "abc123",
"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": "xyz789",
"givenName": "abc123",
"surname": "xyz789",
"company": "xyz789",
"numberOfLabelers": 987,
"name": "xyz789",
"gclid": "xyz789",
"fbclid": "abc123",
"utmSource": "abc123",
"desiredLabelingFeature": "abc123"
}
}
}
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": "xyz789"
}
}
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": "xyz789"
}
}
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]
}
]
}
}
resetLabelingAgentLabels
Description
Clears all labels predicted by a labeling agent for a project (or a specific document). Only accessible by reviewers, supervisors, and admins.
Response
Returns a ResetLabelingAgentLabelsResult!
Arguments
| Name | Description |
|---|---|
input - ResetLabelingAgentLabelsInput!
|
Example
Query
mutation ResetLabelingAgentLabels($input: ResetLabelingAgentLabelsInput!) {
resetLabelingAgentLabels(input: $input) {
job {
id
status
progress
errors {
...JobErrorFragment
}
resultId
result
createdAt
updatedAt
retryCount
maxRetry
additionalData {
...JobAdditionalDataFragment
}
}
}
}
Variables
{"input": ResetLabelingAgentLabelsInput}
Response
{"data": {"resetLabelingAgentLabels": {"job": Job}}}
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
retryCount
maxRetry
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
samlId
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": "abc123"
}
}
}
resetUserHotkeyOverrides
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
retryCount
maxRetry
additionalData {
...JobAdditionalDataFragment
}
}
name
isProcessing
}
}
Variables
{"id": "4"}
Response
{
"data": {
"retryLlmVectorStoreAsync": {
"job": Job,
"name": "abc123",
"isProcessing": false
}
}
}
revokeMyOauthConnectedApplication
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
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"type": "CREATE_PROJECT", "actionId": 4}
Response
{
"data": {
"runAction": {
"id": "abc123",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"retryCount": 123,
"maxRetry": 987,
"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
retryCount
maxRetry
additionalData {
...JobAdditionalDataFragment
}
}
name
}
}
Variables
{
"llmApplicationId": 4,
"promptIds": [4],
"ragConfigIds": ["4"]
}
Response
{
"data": {
"runPlaygroundRagConfig": {
"job": Job,
"name": "xyz789"
}
}
}
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
syncTimestampToTokenSelector
}
}
Variables
{"input": SaveGeneralWorkspaceSettingsInput}
Response
{
"data": {
"saveGeneralWorkspaceSettings": {
"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": false,
"syncTimestampToTokenSelector": true
}
}
}
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
}
anonymizationMaskedColumnIds
fileTransformerId
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
}
Variables
{"input": SaveProjectWorkspaceSettingsInput}
Response
{
"data": {
"saveProjectWorkspaceSettings": {
"id": 4,
"textLabelMaxTokenLength": 123,
"allTokensMustBeLabeled": true,
"autoScrollWhenLabeling": true,
"allowArcDrawing": true,
"allowCharacterBasedLabeling": false,
"allowMultiLabels": true,
"kinds": ["DOCUMENT_BASED"],
"sentenceSeparator": "xyz789",
"tokenizer": "abc123",
"editSentenceTokenizer": "abc123",
"displayedRows": 987,
"mediaDisplayStrategy": "NONE",
"viewer": "TOKEN",
"viewerConfig": TextDocumentViewerConfig,
"hideBoundingBoxIfNoSpanOrArrowLabel": false,
"enableTabularMarkdownParsing": true,
"enableAnonymization": false,
"anonymizationEntityTypes": [
"abc123"
],
"anonymizationMaskingMethod": "abc123",
"anonymizationRegExps": [RegularExpression],
"anonymizationMaskedColumnIds": [987],
"fileTransformerId": "xyz789",
"rowQuestionsFormValidationScriptId": "4",
"enableRowQuestionsFormValidationScript": true
}
}
}
saveSearch
Response
Returns a SavedSearch!
Arguments
| Name | Description |
|---|---|
input - SaveSearchInput!
|
Example
Query
mutation SaveSearch($input: SaveSearchInput!) {
saveSearch(input: $input) {
id
owner {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
lastModifiedBy {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
name
description
type
conditions
projectId
createdAt
updatedAt
}
}
Variables
{"input": SaveSearchInput}
Response
{
"data": {
"saveSearch": {
"id": "4",
"owner": User,
"lastModifiedBy": User,
"name": "xyz789",
"description": "abc123",
"type": "STANDARD",
"conditions": "abc123",
"projectId": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
saveSearchKeyword
Response
Returns a SearchHistoryKeyword!
Arguments
| Name | Description |
|---|---|
keyword - String!
|
Example
Query
mutation SaveSearchKeyword($keyword: String!) {
saveSearchKeyword(keyword: $keyword) {
id
keyword
}
}
Variables
{"keyword": "abc123"}
Response
{
"data": {
"saveSearchKeyword": {
"id": 4,
"keyword": "xyz789"
}
}
}
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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
taskScope {
...TaskScopeFragment
}
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
enableRapidLabelingFeedback
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
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
}
anonymizationMaskedColumnIds
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
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
}
availableDocumentsCount
}
}
Variables
{"projectIds": ["xyz789"], "dueInDays": 123}
Response
{
"data": {
"scheduleDeleteProjects": [
{
"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": "xyz789",
"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": true,
"projectMetadataItems": [ProjectMetadataItem],
"availableDocumentsCount": 987
}
]
}
}
selfAssign
Response
Returns a ProjectSelfAssignment!
Arguments
| Name | Description |
|---|---|
input - SelfAssignInput!
|
Example
Query
mutation SelfAssign($input: SelfAssignInput!) {
selfAssign(input: $input) {
updatedAssignment {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
taskScope {
...TaskScopeFragment
}
createdAt
updatedAt
}
assignedDocumentsCount
status
}
}
Variables
{"input": SelfAssignInput}
Response
{
"data": {
"selfAssign": {
"updatedAssignment": ProjectAssignment,
"assignedDocumentsCount": 987,
"status": "PARTIAL"
}
}
}
selfUnassign
Response
Returns a ProjectSelfUnassignment!
Arguments
| Name | Description |
|---|---|
input - SelfUnassignInput!
|
Example
Query
mutation SelfUnassign($input: SelfUnassignInput!) {
selfUnassign(input: $input) {
updatedAssignment {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
taskScope {
...TaskScopeFragment
}
createdAt
updatedAt
}
unassignedDocumentsCount
}
}
Variables
{"input": SelfUnassignInput}
Response
{
"data": {
"selfUnassign": {
"updatedAssignment": ProjectAssignment,
"unassignedDocumentsCount": 123
}
}
}
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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
createdAt
}
}
Variables
{
"cabinetMatcher": CabinetMatcherInput,
"targetStatus": "IN_PROGRESS",
"skipValidation": true
}
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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
message
resolved
resolvedAt
resolvedBy {
id
samlId
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": "xyz789",
"resolvedBy": User,
"repliesCount": 123,
"createdAt": "abc123",
"updatedAt": "abc123",
"lastEditedAt": "abc123",
"hashCode": "xyz789",
"commentedContent": CommentedContent
}
}
}
setGlobalWorkspacePermissionsSettings
Response
Returns a GlobalWorkspacePermissionsSettings
Arguments
| Name | Description |
|---|---|
input - GlobalWorkspacePermissionsSettingsInput!
|
Example
Query
mutation SetGlobalWorkspacePermissionsSettings($input: GlobalWorkspacePermissionsSettingsInput!) {
setGlobalWorkspacePermissionsSettings(input: $input) {
allowCreateWorkspaces
allowInviteTeamMembers
allowChangeTeamMemberRoles
allowRemoveTeamMembers
}
}
Variables
{"input": GlobalWorkspacePermissionsSettingsInput}
Response
{
"data": {
"setGlobalWorkspacePermissionsSettings": {
"allowCreateWorkspaces": false,
"allowInviteTeamMembers": true,
"allowChangeTeamMemberRoles": true,
"allowRemoveTeamMembers": true
}
}
}
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
samlId
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": "xyz789"
}
}
}
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]
}
}
}
splitChunk
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a SplitChunkResponse!
Arguments
| Name | Description |
|---|---|
input - SplitChunkInput!
|
Example
Query
mutation SplitChunk($input: SplitChunkInput!) {
splitChunk(input: $input) {
splitChunks {
text
metadata
embedding
}
previousChunk {
text
metadata
embedding
}
nextChunk {
text
metadata
embedding
}
}
}
Variables
{"input": SplitChunkInput}
Response
{
"data": {
"splitChunk": {
"splitChunks": [DocumentChunk],
"previousChunk": DocumentChunk,
"nextChunk": DocumentChunk
}
}
}
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
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"input": StartDatasaurDinamicRowBasedTrainingJobInput}
Response
{
"data": {
"startDatasaurDinamicRowBasedTrainingJob": {
"id": "xyz789",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"retryCount": 987,
"maxRetry": 123,
"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
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"input": StartDatasaurDinamicTokenBasedTrainingJobInput}
Response
{
"data": {
"startDatasaurDinamicTokenBasedTrainingJob": {
"id": "abc123",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "abc123",
"retryCount": 123,
"maxRetry": 123,
"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
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"input": StartDatasaurPredictiveTrainingJobInput}
Response
{
"data": {
"startDatasaurPredictiveTrainingJob": {
"id": "abc123",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "abc123",
"retryCount": 123,
"maxRetry": 123,
"additionalData": JobAdditionalData
}
}
}
startExtensionTrial
Response
Returns a TeamSetting!
Arguments
| Name | Description |
|---|---|
input - StartExtensionTrialInput!
|
Example
Query
mutation StartExtensionTrial($input: StartExtensionTrialInput!) {
startExtensionTrial(input: $input) {
activitySettings {
readSource
writeTargets
}
additionalSetting {
customUploadSetting {
...CustomUploadSettingFragment
}
enableGeneratedInvitationLink
enablePerDocumentConflictableRecalculation
}
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedASRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enabledCustomObjectStorage
enableActions
enableAddDocumentsToProject
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurDinamicTokenBased
enableDatasaurPredictiveRowBased
enableLabelingAgentSpanBased
enableLabelingAgentRowBased
enableLabelingAgentArrowBased
enableWipeData
enableExportTeamOverview
enableSelfAssignment
enableWebhookSelfService
enableOauthApplicationSelfService
enableTransferOwnership
enableLabelErrorDetectionRowBased
allowedExtraAutoLabelProviders
enableLLMProject
enableRegexSentenceSeparator
enableTeamRoleSupervisor
endExtensionTrialAt
allowInvalidPaymentMethod
enableExternalKnowledgeBase
enableForceAnonymization
enableReviewIndicator
enableValidationScript
enableSpanLabelingWithRowQuestions
llmFreeTrialDailyLimitsConfig {
deployedApiRunPrompt
sandboxRunPrompt
}
enableScriptGeneratedQuestion
rowModification {
insertRow
deleteRow
editRow
}
enableDeployedApplicationLogging
enableRealTimeAssistedLabelingSpanBased
enableLabelsAndAnswersExportFormat
enableGoogleDriveExternalObjectStorage
enableMLAssistedOptimizationByDefault
}
}
Variables
{"input": StartExtensionTrialInput}
Response
{
"data": {
"startExtensionTrial": {
"activitySettings": TeamActivitySettings,
"additionalSetting": AdditionalTeamSetting,
"allowedAdminExportMethods": ["FILE_STORAGE"],
"allowedLabelerExportMethods": ["FILE_STORAGE"],
"allowedOCRProviders": ["APACHE_TIKA"],
"allowedASRProviders": ["OPENAI_WHISPER"],
"allowedReviewerExportMethods": ["FILE_STORAGE"],
"commentNotificationType": "OFF",
"customAPICreationLimit": 987,
"defaultCustomTextExtractionAPIId": 4,
"defaultExternalObjectStorageId": "4",
"enabledCustomObjectStorage": ["AWS_S3"],
"enableActions": true,
"enableAddDocumentsToProject": false,
"enableDemo": false,
"enableDataProgramming": false,
"enableLabelingFunctionMultipleLabel": false,
"enableDatasaurAssistRowBased": true,
"enableDatasaurDinamicTokenBased": true,
"enableDatasaurPredictiveRowBased": false,
"enableLabelingAgentSpanBased": true,
"enableLabelingAgentRowBased": true,
"enableLabelingAgentArrowBased": true,
"enableWipeData": false,
"enableExportTeamOverview": false,
"enableSelfAssignment": false,
"enableWebhookSelfService": false,
"enableOauthApplicationSelfService": false,
"enableTransferOwnership": true,
"enableLabelErrorDetectionRowBased": true,
"allowedExtraAutoLabelProviders": ["CUSTOM"],
"enableLLMProject": true,
"enableRegexSentenceSeparator": true,
"enableTeamRoleSupervisor": false,
"endExtensionTrialAt": "2007-12-03T10:15:30Z",
"allowInvalidPaymentMethod": false,
"enableExternalKnowledgeBase": true,
"enableForceAnonymization": false,
"enableReviewIndicator": false,
"enableValidationScript": true,
"enableSpanLabelingWithRowQuestions": false,
"llmFreeTrialDailyLimitsConfig": LlmFreeTrialDailyLimitsConfig,
"enableScriptGeneratedQuestion": true,
"rowModification": RowModificationSetting,
"enableDeployedApplicationLogging": false,
"enableRealTimeAssistedLabelingSpanBased": false,
"enableLabelsAndAnswersExportFormat": true,
"enableGoogleDriveExternalObjectStorage": true,
"enableMLAssistedOptimizationByDefault": true
}
}
}
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
teamId
provider
name
displayName
url
region
maxTemperature
maxTopP
maxTokens
maxContextWindow
defaultTemperature
defaultTopP
defaultMaxTokens
minTemperature
minTopP
llmModelFineTuningJob {
id
name
teamId
status
errorMessage
baseModelId
parentId
resultModelId
trainingJobId
trainingDataset {
...GroundTruthSetFragment
}
trainingDatasetFilename
validationSize
validationDataset {
...GroundTruthSetFragment
}
validationDatasetFilename
epochs
learningRate
batchSize
earlyStoppingThreshold
earlyStoppingPatience
learningRateWarmUpStep
learningRateMultiplier
instanceType
trainingVolumeSize
trainingBucketName
optionalHyperparameters
createdByUser {
...UserFragment
}
createdAt
updatedAt
}
deployableModelId
isModelDeployable
forceAnonymization
hasVisionCapability
variant
createdAt
updatedAt
}
}
Variables
{"input": LlmModelFineTuningInput}
Response
{
"data": {
"startFineTuningJob": {
"id": "4",
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "abc123",
"displayName": "xyz789",
"url": "abc123",
"region": ["abc123"],
"maxTemperature": 123.45,
"maxTopP": 123.45,
"maxTokens": 987,
"maxContextWindow": 123,
"defaultTemperature": 987.65,
"defaultTopP": 123.45,
"defaultMaxTokens": 987,
"minTemperature": 123.45,
"minTopP": 987.65,
"llmModelFineTuningJob": LlmModelFineTuningJob,
"deployableModelId": "abc123",
"isModelDeployable": true,
"forceAnonymization": true,
"hasVisionCapability": true,
"variant": "META",
"createdAt": "abc123",
"updatedAt": "xyz789"
}
}
}
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
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"input": StartLabelErrorDetectionRowBasedJobInput}
Response
{
"data": {
"startLabelErrorDetectionRowBasedJob": {
"id": "xyz789",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "xyz789",
"retryCount": 123,
"maxRetry": 987,
"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
teamId
provider
name
displayName
url
region
maxTemperature
maxTopP
maxTokens
maxContextWindow
defaultTemperature
defaultTopP
defaultMaxTokens
minTemperature
minTopP
llmModelFineTuningJob {
id
name
teamId
status
errorMessage
baseModelId
parentId
resultModelId
trainingJobId
trainingDataset {
...GroundTruthSetFragment
}
trainingDatasetFilename
validationSize
validationDataset {
...GroundTruthSetFragment
}
validationDatasetFilename
epochs
learningRate
batchSize
earlyStoppingThreshold
earlyStoppingPatience
learningRateWarmUpStep
learningRateMultiplier
instanceType
trainingVolumeSize
trainingBucketName
optionalHyperparameters
createdByUser {
...UserFragment
}
createdAt
updatedAt
}
deployableModelId
isModelDeployable
forceAnonymization
hasVisionCapability
variant
createdAt
updatedAt
}
}
Variables
{"llmModelId": "4"}
Response
{
"data": {
"stopFineTuningJob": {
"id": 4,
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "abc123",
"displayName": "abc123",
"url": "abc123",
"region": ["xyz789"],
"maxTemperature": 987.65,
"maxTopP": 123.45,
"maxTokens": 987,
"maxContextWindow": 987,
"defaultTemperature": 987.65,
"defaultTopP": 987.65,
"defaultMaxTokens": 987,
"minTemperature": 987.65,
"minTopP": 123.45,
"llmModelFineTuningJob": LlmModelFineTuningJob,
"deployableModelId": "xyz789",
"isModelDeployable": true,
"forceAnonymization": false,
"hasVisionCapability": false,
"variant": "META",
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
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"}
}
}
submitStorageDiagnostic
Description
Returns the new run's id. Only one diagnostic run may be active per action at a time; submitting while a run is already in progress is rejected.
Response
Returns an ID!
Arguments
| Name | Description |
|---|---|
input - StorageDiagnosticConfigInput!
|
Example
Query
mutation SubmitStorageDiagnostic($input: StorageDiagnosticConfigInput!) {
submitStorageDiagnostic(input: $input)
}
Variables
{"input": StorageDiagnosticConfigInput}
Response
{"data": {"submitStorageDiagnostic": 4}}
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": false}}
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.
syncLlmVectorStoreUrlDocuments
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmVectorStore!
Arguments
| Name | Description |
|---|---|
input - SyncLlmVectorStoreUrlDocumentsInput!
|
Example
Query
mutation SyncLlmVectorStoreUrlDocuments($input: SyncLlmVectorStoreUrlDocumentsInput!) {
syncLlmVectorStoreUrlDocuments(input: $input) {
id
teamId
createdByUser {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
llmEmbeddingModel {
id
teamId
provider
name
displayName
url
maxTokens
dimensions
deployableModelId
isModelDeployable
createdAt
updatedAt
variant
customDimension
}
provider
collectionId
name
status
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
targetEntity
}
jobId
chunkConfiguration
filePropertiesExtractorConfiguration {
type
configuration
syncedFilePropertiesJsonSchema
}
urlSyncScheduledCommandConfig {
id
cronPattern
repeatInterval
runImmediately
endTime
numberOfRepetition
isNeverEnding
isPeriodic
updatedAt
}
urlSyncNextSchedule
urlSyncLastSyncedAt
createdAt
updatedAt
dimension
}
}
Variables
{"input": SyncLlmVectorStoreUrlDocumentsInput}
Response
{
"data": {
"syncLlmVectorStoreUrlDocuments": {
"id": "4",
"teamId": "4",
"createdByUser": User,
"llmEmbeddingModel": LlmEmbeddingModel,
"provider": "DATASAUR",
"collectionId": "xyz789",
"name": "abc123",
"status": "CREATED",
"documents": [LlmVectorStoreDocumentScalar],
"documentStatusCount": LlmVectorStoreDocumentCountByStatus,
"sourceDocuments": [LlmVectorStoreSourceDocument],
"questions": [Question],
"jobId": "abc123",
"chunkConfiguration": ChunkConfiguration,
"filePropertiesExtractorConfiguration": LlmVectorStoreFilePropertiesExtractorConfiguration,
"urlSyncScheduledCommandConfig": ScheduledCommandConfig,
"urlSyncNextSchedule": "abc123",
"urlSyncLastSyncedAt": "abc123",
"createdAt": "xyz789",
"updatedAt": "xyz789",
"dimension": 123
}
}
}
testTeamWebhook
Response
Returns a TestWebhookResult!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation TestTeamWebhook($id: ID!) {
testTeamWebhook(id: $id) {
statusCode
latencyMs
error
}
}
Variables
{"id": "4"}
Response
{
"data": {
"testTeamWebhook": {
"statusCode": 987,
"latencyMs": 123,
"error": "abc123"
}
}
}
testTeamWebhookConfig
Response
Returns a TestWebhookResult!
Arguments
| Name | Description |
|---|---|
input - TestWebhookConfigInput!
|
Example
Query
mutation TestTeamWebhookConfig($input: TestWebhookConfigInput!) {
testTeamWebhookConfig(input: $input) {
statusCode
latencyMs
error
}
}
Variables
{"input": TestWebhookConfigInput}
Response
{
"data": {
"testTeamWebhookConfig": {
"statusCode": 123,
"latencyMs": 987,
"error": "xyz789"
}
}
}
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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
taskScope {
...TaskScopeFragment
}
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
enableRapidLabelingFeedback
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
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
}
anonymizationMaskedColumnIds
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
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
}
availableDocumentsCount
}
}
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": "xyz789",
"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": true,
"projectMetadataItems": [ProjectMetadataItem],
"availableDocumentsCount": 123
}
]
}
}
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
samlId
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
}
anonymizationMaskedColumnIds
fileTransformerId
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
fileName
isCompleted
completedByUserId
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
labeledLines
answeredLines
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
prelabeledLines
}
status
statusUpdatedByUserId
timeLimit
timeLimitScheduledCommandId
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
status
customAttribute
}
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": "abc123",
"currentSentenceCursor": 123,
"lastLabeledLine": 123,
"documentSettings": TextDocumentSettings,
"fileName": "abc123",
"isCompleted": false,
"completedByUserId": "4",
"lastSavedAt": "xyz789",
"mimeType": "abc123",
"name": "abc123",
"projectId": 4,
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"status": "NOT_STARTED",
"statusUpdatedByUserId": 4,
"timeLimit": "2007-12-03T10:15:30Z",
"timeLimitScheduledCommandId": 4,
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "xyz789",
"version": 123,
"workspaceState": WorkspaceState,
"originId": "4",
"signature": "xyz789",
"part": 123
}
}
}
trackMeetWithSales
Response
Returns a Boolean
Example
Query
mutation TrackMeetWithSales(
$userEmail: String!,
$fieldId: String!,
$value: String!
) {
trackMeetWithSales(
userEmail: $userEmail,
fieldId: $fieldId,
value: $value
)
}
Variables
{
"userEmail": "abc123",
"fieldId": "abc123",
"value": "xyz789"
}
Response
{"data": {"trackMeetWithSales": true}}
triggerDomainVerification
Response
Returns a DomainClaim!
Example
Query
mutation TriggerDomainVerification(
$teamId: ID!,
$domain: String!
) {
triggerDomainVerification(
teamId: $teamId,
domain: $domain
) {
id
teamId
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
domain
verificationSecret
verificationDnsHost
status
encryptionVersion
createdAt
updatedAt
lastVerifyAttemptAt
verificationStartedAt
claimedAt
}
}
Variables
{
"teamId": "4",
"domain": "xyz789"
}
Response
{
"data": {
"triggerDomainVerification": {
"id": "4",
"teamId": 4,
"team": Team,
"domain": "abc123",
"verificationSecret": "abc123",
"verificationDnsHost": "xyz789",
"status": "UNCLAIMED",
"encryptionVersion": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"lastVerifyAttemptAt": "2007-12-03T10:15:30Z",
"verificationStartedAt": "2007-12-03T10:15:30Z",
"claimedAt": "2007-12-03T10:15:30Z"
}
}
}
triggerLabelingAgentLabelPredictionJob
Response
Returns a Job!
Arguments
| Name | Description |
|---|---|
input - TriggerLabelingAgentLabelPredictionJobInput!
|
Example
Query
mutation TriggerLabelingAgentLabelPredictionJob($input: TriggerLabelingAgentLabelPredictionJobInput!) {
triggerLabelingAgentLabelPredictionJob(input: $input) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"input": TriggerLabelingAgentLabelPredictionJobInput}
Response
{
"data": {
"triggerLabelingAgentLabelPredictionJob": {
"id": "abc123",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "abc123",
"retryCount": 987,
"maxRetry": 123,
"additionalData": JobAdditionalData
}
}
}
triggerLabelingAgentsLabelPredictionJob
Response
Returns a Job!
Arguments
| Name | Description |
|---|---|
input - TriggerLabelingAgentsLabelPredictionJobInput!
|
Example
Query
mutation TriggerLabelingAgentsLabelPredictionJob($input: TriggerLabelingAgentsLabelPredictionJobInput!) {
triggerLabelingAgentsLabelPredictionJob(input: $input) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"input": TriggerLabelingAgentsLabelPredictionJobInput}
Response
{
"data": {
"triggerLabelingAgentsLabelPredictionJob": {
"id": "xyz789",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "abc123",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "abc123",
"retryCount": 123,
"maxRetry": 123,
"additionalData": JobAdditionalData
}
}
}
triggerRealTimeAssistedLabelingSpanBasedDocumentJob
Response
Returns a Job
Arguments
| Name | Description |
|---|---|
input - TriggerRealTimeAssistedLabelingSpanBasedDocumentInput!
|
Example
Query
mutation TriggerRealTimeAssistedLabelingSpanBasedDocumentJob($input: TriggerRealTimeAssistedLabelingSpanBasedDocumentInput!) {
triggerRealTimeAssistedLabelingSpanBasedDocumentJob(input: $input) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{
"input": TriggerRealTimeAssistedLabelingSpanBasedDocumentInput
}
Response
{
"data": {
"triggerRealTimeAssistedLabelingSpanBasedDocumentJob": {
"id": "xyz789",
"status": "DELIVERED",
"progress": 987,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "abc123",
"retryCount": 123,
"maxRetry": 123,
"additionalData": JobAdditionalData
}
}
}
triggerRealTimeAssistedLabelingSpanBasedJob
Response
Returns a Job
Arguments
| Name | Description |
|---|---|
input - TriggerRealTimeAssistedLabelingSpanBasedInput!
|
Example
Query
mutation TriggerRealTimeAssistedLabelingSpanBasedJob($input: TriggerRealTimeAssistedLabelingSpanBasedInput!) {
triggerRealTimeAssistedLabelingSpanBasedJob(input: $input) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{"input": TriggerRealTimeAssistedLabelingSpanBasedInput}
Response
{
"data": {
"triggerRealTimeAssistedLabelingSpanBasedJob": {
"id": "xyz789",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "abc123",
"updatedAt": "xyz789",
"retryCount": 123,
"maxRetry": 987,
"additionalData": JobAdditionalData
}
}
}
triggerRealTimeAssistedLabelingSpanBasedJobPerLines
Response
Returns a Job
Arguments
| Name | Description |
|---|---|
input - TriggerRealTimeAssistedLabelingSpanBasedJobPerLinesInput!
|
Example
Query
mutation TriggerRealTimeAssistedLabelingSpanBasedJobPerLines($input: TriggerRealTimeAssistedLabelingSpanBasedJobPerLinesInput!) {
triggerRealTimeAssistedLabelingSpanBasedJobPerLines(input: $input) {
id
status
progress
errors {
id
stack
args
message
}
resultId
result
createdAt
updatedAt
retryCount
maxRetry
additionalData {
actionRunId
childrenJobIds
documentIds
reversedLabels {
...UpdateReversedLabelsResultFragment
}
labelingAgentsJobId
labelingAgentsResults
}
}
}
Variables
{
"input": TriggerRealTimeAssistedLabelingSpanBasedJobPerLinesInput
}
Response
{
"data": {
"triggerRealTimeAssistedLabelingSpanBasedJobPerLines": {
"id": "abc123",
"status": "DELIVERED",
"progress": 123,
"errors": [JobError],
"resultId": "xyz789",
"result": JobResult,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"retryCount": 987,
"maxRetry": 123,
"additionalData": JobAdditionalData
}
}
}
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
teamId
provider
name
displayName
url
maxTokens
dimensions
deployableModelId
isModelDeployable
createdAt
updatedAt
variant
customDimension
}
}
Variables
{"id": 4}
Response
{
"data": {
"undeployLlmEmbeddingModel": {
"id": "4",
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "abc123",
"displayName": "xyz789",
"url": "abc123",
"maxTokens": 987,
"dimensions": 123,
"deployableModelId": "abc123",
"isModelDeployable": false,
"createdAt": "abc123",
"updatedAt": "abc123",
"variant": "META",
"customDimension": false
}
}
}
undeployLlmModel
Breaking changes may be introduced anytime in the future without prior notice.
Example
Query
mutation UndeployLlmModel($id: ID!) {
undeployLlmModel(id: $id) {
id
teamId
provider
name
displayName
url
region
maxTemperature
maxTopP
maxTokens
maxContextWindow
defaultTemperature
defaultTopP
defaultMaxTokens
minTemperature
minTopP
llmModelFineTuningJob {
id
name
teamId
status
errorMessage
baseModelId
parentId
resultModelId
trainingJobId
trainingDataset {
...GroundTruthSetFragment
}
trainingDatasetFilename
validationSize
validationDataset {
...GroundTruthSetFragment
}
validationDatasetFilename
epochs
learningRate
batchSize
earlyStoppingThreshold
earlyStoppingPatience
learningRateWarmUpStep
learningRateMultiplier
instanceType
trainingVolumeSize
trainingBucketName
optionalHyperparameters
createdByUser {
...UserFragment
}
createdAt
updatedAt
}
deployableModelId
isModelDeployable
forceAnonymization
hasVisionCapability
variant
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"undeployLlmModel": {
"id": 4,
"teamId": "4",
"provider": "AMAZON_BEDROCK",
"name": "abc123",
"displayName": "xyz789",
"url": "xyz789",
"region": ["xyz789"],
"maxTemperature": 123.45,
"maxTopP": 987.65,
"maxTokens": 123,
"maxContextWindow": 987,
"defaultTemperature": 987.65,
"defaultTopP": 987.65,
"defaultMaxTokens": 123,
"minTemperature": 987.65,
"minTopP": 123.45,
"llmModelFineTuningJob": LlmModelFineTuningJob,
"deployableModelId": "abc123",
"isModelDeployable": false,
"forceAnonymization": true,
"hasVisionCapability": false,
"variant": "META",
"createdAt": "abc123",
"updatedAt": "xyz789"
}
}
}
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": 123,
"cabinetId": 987,
"name": "xyz789",
"width": "abc123",
"displayed": true,
"labelerRestricted": false,
"rowQuestionIndex": 123
}
]
}
}
updateCellConflicts
Response
Returns an UpdateCellConflictsResult!
Example
Query
mutation UpdateCellConflicts(
$textDocumentId: ID!,
$signature: String!,
$cellLine: Int!,
$resolved: Boolean!,
$labelerId: Int
) {
updateCellConflicts(
textDocumentId: $textDocumentId,
signature: $signature,
cellLine: $cellLine,
resolved: $resolved,
labelerId: $labelerId
) {
cells {
line
index
content
tokens
metadata {
...CellMetadataFragment
}
conversationalMetadata {
...ConversationalMetadataFragment
}
status
conflict
conflicts {
...CellConflictFragment
}
originCell {
...CellFragment
}
}
labels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
status
customAttribute
}
addedLabels {
id
documentId
labeledBy
type
hashCode
labeledByUserId
acceptedByUserId
rejectedByUserId
}
deletedLabels {
id
documentId
labeledBy
type
hashCode
labeledByUserId
acceptedByUserId
rejectedByUserId
}
}
}
Variables
{
"textDocumentId": 4,
"signature": "xyz789",
"cellLine": 987,
"resolved": false,
"labelerId": 123
}
Response
{
"data": {
"updateCellConflicts": {
"cells": [Cell],
"labels": [TextLabel],
"addedLabels": [GqlConflictable],
"deletedLabels": [GqlConflictable]
}
}
}
updateChunk
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a DocumentChunk!
Arguments
| Name | Description |
|---|---|
input - UpdateChunkInput!
|
Example
Query
mutation UpdateChunk($input: UpdateChunkInput!) {
updateChunk(input: $input) {
text
metadata
embedding
}
}
Variables
{"input": UpdateChunkInput}
Response
{
"data": {
"updateChunk": {
"text": "abc123",
"metadata": DocumentChunkMetadata,
"embedding": [123.45]
}
}
}
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
completedByUserId
lastSavedAt
mimeType
name
projectId
sentences {
...TextSentenceFragment
}
settings {
...SettingsFragment
}
statistic {
...TextDocumentStatisticFragment
}
status
statusUpdatedByUserId
timeLimit
timeLimitScheduledCommandId
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": "abc123",
"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
name
effectiveName
credentials {
...ExternalObjectStorageCredentialsFragment
}
securityToken
team {
...TeamFragment
}
projects {
...ProjectFragment
}
readOnly
createdAt
updatedAt
}
externalObjectStorageIdOutput
externalObjectStorageOutput {
id
cloudService
bucketId
bucketName
name
effectiveName
credentials {
...ExternalObjectStorageCredentialsFragment
}
securityToken
team {
...TeamFragment
}
projects {
...ProjectFragment
}
readOnly
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
immutableInput
ingestMode
skipDeduplication
}
}
Variables
{
"teamId": 4,
"actionId": "4",
"input": UpdateCreateProjectActionInput
}
Response
{
"data": {
"updateCreateProjectAction": {
"id": 4,
"name": "xyz789",
"teamId": 4,
"appVersion": "abc123",
"creatorId": 4,
"lastRunAt": "xyz789",
"lastFinishedAt": "xyz789",
"externalObjectStorageId": "4",
"externalObjectStorage": ExternalObjectStorage,
"externalObjectStorageIdOutput": 4,
"externalObjectStorageOutput": 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"],
"immutableInput": false,
"ingestMode": "PRESIGNED",
"skipDeduplication": false
}
}
}
updateCurrentSentenceCursor
Response
Returns a TextDocument!
Arguments
| Name | Description |
|---|---|
input - UpdateCurrentSentenceCursorInput!
|
Example
Query
mutation UpdateCurrentSentenceCursor($input: UpdateCurrentSentenceCursorInput!) {
updateCurrentSentenceCursor(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
}
anonymizationMaskedColumnIds
fileTransformerId
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
fileName
isCompleted
completedByUserId
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
labeledLines
answeredLines
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
prelabeledLines
}
status
statusUpdatedByUserId
timeLimit
timeLimitScheduledCommandId
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
status
customAttribute
}
url
version
workspaceState {
id
chunkId
sentenceStart
sentenceEnd
touchedChunks
touchedSentences
}
originId
signature
part
}
}
Variables
{"input": UpdateCurrentSentenceCursorInput}
Response
{
"data": {
"updateCurrentSentenceCursor": {
"id": "4",
"chunks": [TextChunk],
"createdAt": "abc123",
"currentSentenceCursor": 987,
"lastLabeledLine": 987,
"documentSettings": TextDocumentSettings,
"fileName": "abc123",
"isCompleted": true,
"completedByUserId": "4",
"lastSavedAt": "abc123",
"mimeType": "xyz789",
"name": "xyz789",
"projectId": "4",
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"status": "NOT_STARTED",
"statusUpdatedByUserId": 4,
"timeLimit": "2007-12-03T10:15:30Z",
"timeLimitScheduledCommandId": "4",
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "abc123",
"version": 123,
"workspaceState": WorkspaceState,
"originId": "4",
"signature": "abc123",
"part": 123
}
}
}
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": "xyz789",
"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": "abc123",
"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": 987,
"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": [987],
"questionColumnId": 987,
"providerSetting": ProviderSetting,
"modelMetadata": ModelMetadata,
"trainingJobId": "4",
"createdAt": "abc123",
"updatedAt": "xyz789"
}
}
}
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": 987,
"cabinetId": 123,
"name": "xyz789",
"width": "xyz789",
"displayed": false,
"labelerRestricted": true,
"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": 123,
"displayed": true
}
Response
{
"data": {
"updateDocumentMetaDisplayed": {
"id": 987,
"cabinetId": 123,
"name": "abc123",
"width": "xyz789",
"displayed": true,
"labelerRestricted": false,
"rowQuestionIndex": 987
}
}
}
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": 987,
"labelerRestricted": false
}
Response
{
"data": {
"updateDocumentMetaLabelerRestricted": {
"id": 123,
"cabinetId": 123,
"name": "abc123",
"width": "abc123",
"displayed": true,
"labelerRestricted": false,
"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": 987,
"cabinetId": 987,
"name": "abc123",
"width": "abc123",
"displayed": true,
"labelerRestricted": true,
"rowQuestionIndex": 987
}
]
}
}
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
customScript {
...CustomScriptFragment
}
}
bindToColumn
activationConditionLogic
targetEntity
}
}
Variables
{
"projectId": 4,
"input": QuestionInput,
"signature": "abc123"
}
Response
{
"data": {
"updateDocumentQuestion": {
"id": 987,
"internalId": "xyz789",
"type": "DROPDOWN",
"name": "xyz789",
"label": "xyz789",
"required": true,
"config": QuestionConfig,
"bindToColumn": "abc123",
"activationConditionLogic": "abc123",
"targetEntity": "abc123"
}
}
}
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
customScript {
...CustomScriptFragment
}
}
bindToColumn
activationConditionLogic
targetEntity
}
}
Variables
{
"projectId": 4,
"input": [QuestionInput],
"signature": "abc123"
}
Response
{
"data": {
"updateDocumentQuestions": [
{
"id": 123,
"internalId": "abc123",
"type": "DROPDOWN",
"name": "abc123",
"label": "xyz789",
"required": true,
"config": QuestionConfig,
"bindToColumn": "xyz789",
"activationConditionLogic": "abc123",
"targetEntity": "abc123"
}
]
}
}
updateDocumentStatus
Response
Returns a TextDocument!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
status - TextDocumentStatus
|
|
skipValidation - Boolean
|
Example
Query
mutation UpdateDocumentStatus(
$documentId: ID!,
$status: TextDocumentStatus,
$skipValidation: Boolean
) {
updateDocumentStatus(
documentId: $documentId,
status: $status,
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
}
anonymizationMaskedColumnIds
fileTransformerId
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
fileName
isCompleted
completedByUserId
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
labeledLines
answeredLines
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
prelabeledLines
}
status
statusUpdatedByUserId
timeLimit
timeLimitScheduledCommandId
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
status
customAttribute
}
url
version
workspaceState {
id
chunkId
sentenceStart
sentenceEnd
touchedChunks
touchedSentences
}
originId
signature
part
}
}
Variables
{
"documentId": "4",
"status": "NOT_STARTED",
"skipValidation": false
}
Response
{
"data": {
"updateDocumentStatus": {
"id": 4,
"chunks": [TextChunk],
"createdAt": "xyz789",
"currentSentenceCursor": 987,
"lastLabeledLine": 123,
"documentSettings": TextDocumentSettings,
"fileName": "abc123",
"isCompleted": true,
"completedByUserId": 4,
"lastSavedAt": "xyz789",
"mimeType": "xyz789",
"name": "xyz789",
"projectId": 4,
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"status": "NOT_STARTED",
"statusUpdatedByUserId": "4",
"timeLimit": "2007-12-03T10:15:30Z",
"timeLimitScheduledCommandId": "4",
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "xyz789",
"version": 987,
"workspaceState": WorkspaceState,
"originId": "4",
"signature": "abc123",
"part": 987
}
}
}
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": "abc123",
"transpiled": "xyz789",
"createdAt": "abc123",
"updatedAt": "abc123",
"language": "TYPESCRIPT",
"purpose": "IMPORT",
"readonly": true,
"externalId": "xyz789",
"warmup": true
}
}
}
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
systemInstruction
prompt
answer
createdAt
updatedAt
}
}
Variables
{"input": UpdateGroundTruthInput}
Response
{
"data": {
"updateGroundTruth": {
"id": "4",
"groundTruthSetId": 4,
"systemInstruction": "abc123",
"prompt": "abc123",
"answer": "abc123",
"createdAt": "xyz789",
"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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
items {
id
groundTruthSetId
systemInstruction
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": "abc123"
}
}
}
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": 123,
"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
samlId
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
leafOnlyOption
}
}
Variables
{"input": UpdateLabelSetTemplateInput}
Response
{
"data": {
"updateLabelSetTemplate": {
"id": "4",
"name": "abc123",
"owner": User,
"type": "QUESTION",
"items": [LabelSetTemplateItem],
"count": 987,
"createdAt": "abc123",
"updatedAt": "abc123",
"leafOnlyOption": false
}
}
}
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
cached
}
}
Variables
{"input": UpdateLabelingFunctionInput}
Response
{
"data": {
"updateLabelingFunction": {
"id": 4,
"dataProgrammingId": 4,
"heuristicArgument": HeuristicArgumentScalar,
"annotatorArgument": AnnotatorArgumentScalar,
"name": "xyz789",
"content": "xyz789",
"active": true,
"createdAt": "abc123",
"updatedAt": "abc123",
"cached": false
}
}
}
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
completedByUserId
lastSavedAt
mimeType
name
projectId
sentences {
...TextSentenceFragment
}
settings {
...SettingsFragment
}
statistic {
...TextDocumentStatisticFragment
}
status
statusUpdatedByUserId
timeLimit
timeLimitScheduledCommandId
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
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
status
customAttribute
}
previousTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
status
customAttribute
}
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
samlId
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
samlId
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
name
status
createdAt
updatedAt
apiEndpoints {
...LlmApplicationDeploymentApiEndpointFragment
}
isDeleted
}
totalRagConfigs
}
}
Variables
{"input": LlmApplicationUpdateInput}
Response
{
"data": {
"updateLlmApplication": {
"id": 4,
"teamId": "4",
"createdByUser": User,
"name": "abc123",
"status": "DEPLOYED",
"createdAt": "abc123",
"updatedAt": "xyz789",
"llmApplicationDeployment": LlmApplicationDeployment,
"totalRagConfigs": 987
}
}
}
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
updatedByUserId
updatedByUser {
id
samlId
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
}
llmVectorStores {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
maxChunkSize
createdAt
updatedAt
}
createdAt
updatedAt
isDeleted
}
}
Variables
{"input": UpdateLlmApplicationConfigurationInput}
Response
{
"data": {
"updateLlmApplicationConfiguration": {
"id": 4,
"name": "xyz789",
"teamId": 4,
"createdByUserId": "4",
"updatedByUserId": "4",
"updatedByUser": User,
"llmRagConfigId": "4",
"llmRagConfig": LlmRagConfig,
"createdAt": "abc123",
"updatedAt": "abc123",
"isDeleted": false
}
}
}
updateLlmApplicationDeployment
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplicationDeployment!
Arguments
| Name | Description |
|---|---|
input - LlmApplicationDeploymentUpdateInput!
|
Example
Query
mutation UpdateLlmApplicationDeployment($input: LlmApplicationDeploymentUpdateInput!) {
updateLlmApplicationDeployment(input: $input) {
id
deployedByUser {
id
samlId
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
}
totalRagConfigs
}
llmRagConfig {
id
llmModel {
...LlmModelFragment
}
systemInstruction
userInstruction
raw
temperature
topP
maxTokens
advancedHyperparameters
maxVectorStoreTokens
llmVectorStore {
...LlmVectorStoreFragment
}
llmVectorStores {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
maxChunkSize
createdAt
updatedAt
}
numberOfCalls
numberOfTokens
numberOfInputTokens
numberOfOutputTokens
deployedAt
name
status
createdAt
updatedAt
apiEndpoints {
type
endpoint
}
isDeleted
}
}
Variables
{"input": LlmApplicationDeploymentUpdateInput}
Response
{
"data": {
"updateLlmApplicationDeployment": {
"id": 4,
"deployedByUser": User,
"llmApplicationId": 4,
"llmApplication": LlmApplication,
"llmRagConfig": LlmRagConfig,
"numberOfCalls": 987,
"numberOfTokens": 987,
"numberOfInputTokens": 123,
"numberOfOutputTokens": 123,
"deployedAt": "xyz789",
"name": "abc123",
"status": "SUSPENDED",
"createdAt": "xyz789",
"updatedAt": "abc123",
"apiEndpoints": [
LlmApplicationDeploymentApiEndpoint
],
"isDeleted": false
}
}
}
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
createdAt
updatedAt
lastPromptMessage {
id
llmApplicationPlaygroundPromptId
content
role
attachments {
...LlmApplicationPlaygroundPromptAttachmentFragment
}
createdAt
updatedAt
}
totalPromptMessages
}
}
Variables
{"input": LlmApplicationPlaygroundPromptUpdateInput}
Response
{
"data": {
"updateLlmApplicationPlaygroundPrompt": {
"id": 4,
"llmApplicationId": "4",
"name": "xyz789",
"createdAt": "xyz789",
"updatedAt": "xyz789",
"lastPromptMessage": LlmApplicationPlaygroundPromptMessage,
"totalPromptMessages": 987
}
}
}
updateLlmApplicationPlaygroundPromptMessage
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmApplicationPlaygroundPromptMessage!
Arguments
| Name | Description |
|---|---|
input - LlmApplicationPlaygroundPromptMessageItemInput!
|
Example
Query
mutation UpdateLlmApplicationPlaygroundPromptMessage($input: LlmApplicationPlaygroundPromptMessageItemInput!) {
updateLlmApplicationPlaygroundPromptMessage(input: $input) {
id
llmApplicationPlaygroundPromptId
content
role
attachments {
id
llmFileId
llmFile {
...LlmFileFragment
}
createdAt
updatedAt
llmApplicationPlaygroundPromptMessageId
}
createdAt
updatedAt
}
}
Variables
{"input": LlmApplicationPlaygroundPromptMessageItemInput}
Response
{
"data": {
"updateLlmApplicationPlaygroundPromptMessage": {
"id": 4,
"llmApplicationPlaygroundPromptId": "4",
"content": "abc123",
"role": "USER",
"attachments": [
LlmApplicationPlaygroundPromptAttachment
],
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
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
}
llmVectorStores {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
maxChunkSize
createdAt
updatedAt
}
name
createdAt
updatedAt
}
}
Variables
{"input": LlmApplicationPlaygroundRagConfigUpdateInput}
Response
{
"data": {
"updateLlmApplicationPlaygroundRagConfig": {
"id": "4",
"llmApplicationId": 4,
"llmRagConfig": LlmRagConfig,
"name": "xyz789",
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
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
}
scheduledCommandConfig {
id
cronPattern
repeatInterval
runImmediately
endTime
numberOfRepetition
isNeverEnding
isPeriodic
updatedAt
}
isScheduled
createdAt
updatedAt
isDeleted
type
schedulingStatus
nextSchedule
createdByUser {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
lastScoredByUser {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
totalPrompts
lastLlmEvaluationExecution {
id
llmEvaluationId
status
errorMessage
createdAt
updatedAt
isDeleted
}
}
}
Variables
{"input": UpdateLlmEvaluationAutomatedInput}
Response
{
"data": {
"updateLlmEvaluationAutomatedScheduled": {
"id": "4",
"name": "abc123",
"teamId": "4",
"projectId": "4",
"kind": "DOCUMENT_BASED",
"status": "CREATING",
"creationProgress": LlmEvaluationCreationProgress,
"scheduledCommandConfig": ScheduledCommandConfig,
"isScheduled": true,
"createdAt": "xyz789",
"updatedAt": "abc123",
"isDeleted": false,
"type": "RATING",
"schedulingStatus": "NOT_STARTED",
"nextSchedule": "xyz789",
"createdByUser": User,
"lastScoredByUser": User,
"totalPrompts": 123,
"lastLlmEvaluationExecution": LlmEvaluationExecution
}
}
}
updateLlmManualEvaluationStatus
Breaking changes may be introduced anytime in the future without prior notice.
Description
Updates the LLM evaluation status.
Response
Returns a LlmEvaluation!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
status - GqlLlmEvaluationStatus!
|
Example
Query
mutation UpdateLlmManualEvaluationStatus(
$id: ID!,
$status: GqlLlmEvaluationStatus!
) {
updateLlmManualEvaluationStatus(
id: $id,
status: $status
) {
id
name
teamId
projectId
kind
status
creationProgress {
status
jobId
error
}
scheduledCommandConfig {
id
cronPattern
repeatInterval
runImmediately
endTime
numberOfRepetition
isNeverEnding
isPeriodic
updatedAt
}
isScheduled
createdAt
updatedAt
isDeleted
type
schedulingStatus
nextSchedule
createdByUser {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
lastScoredByUser {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
totalPrompts
lastLlmEvaluationExecution {
id
llmEvaluationId
status
errorMessage
createdAt
updatedAt
isDeleted
}
}
}
Variables
{"id": "4", "status": "CREATING"}
Response
{
"data": {
"updateLlmManualEvaluationStatus": {
"id": "4",
"name": "abc123",
"teamId": "4",
"projectId": "4",
"kind": "DOCUMENT_BASED",
"status": "CREATING",
"creationProgress": LlmEvaluationCreationProgress,
"scheduledCommandConfig": ScheduledCommandConfig,
"isScheduled": true,
"createdAt": "abc123",
"updatedAt": "xyz789",
"isDeleted": true,
"type": "RATING",
"schedulingStatus": "NOT_STARTED",
"nextSchedule": "abc123",
"createdByUser": User,
"lastScoredByUser": User,
"totalPrompts": 123,
"lastLlmEvaluationExecution": LlmEvaluationExecution
}
}
}
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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
llmEmbeddingModel {
id
teamId
provider
name
displayName
url
maxTokens
dimensions
deployableModelId
isModelDeployable
createdAt
updatedAt
variant
customDimension
}
provider
collectionId
name
status
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
targetEntity
}
jobId
chunkConfiguration
filePropertiesExtractorConfiguration {
type
configuration
syncedFilePropertiesJsonSchema
}
urlSyncScheduledCommandConfig {
id
cronPattern
repeatInterval
runImmediately
endTime
numberOfRepetition
isNeverEnding
isPeriodic
updatedAt
}
urlSyncNextSchedule
urlSyncLastSyncedAt
createdAt
updatedAt
dimension
}
}
Variables
{"input": UpdateLlmVectorStoreInput}
Response
{
"data": {
"updateLlmVectorStore": {
"id": "4",
"teamId": "4",
"createdByUser": User,
"llmEmbeddingModel": LlmEmbeddingModel,
"provider": "DATASAUR",
"collectionId": "xyz789",
"name": "xyz789",
"status": "CREATED",
"documents": [LlmVectorStoreDocumentScalar],
"documentStatusCount": LlmVectorStoreDocumentCountByStatus,
"sourceDocuments": [LlmVectorStoreSourceDocument],
"questions": [Question],
"jobId": "xyz789",
"chunkConfiguration": ChunkConfiguration,
"filePropertiesExtractorConfiguration": LlmVectorStoreFilePropertiesExtractorConfiguration,
"urlSyncScheduledCommandConfig": ScheduledCommandConfig,
"urlSyncNextSchedule": "xyz789",
"urlSyncLastSyncedAt": "abc123",
"createdAt": "abc123",
"updatedAt": "abc123",
"dimension": 987
}
}
}
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
retryCount
maxRetry
additionalData {
...JobAdditionalDataFragment
}
}
name
isProcessing
}
}
Variables
{"input": UpdateLlmVectorStoreAsyncInput}
Response
{
"data": {
"updateLlmVectorStoreAsync": {
"job": Job,
"name": "abc123",
"isProcessing": false
}
}
}
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
completedByUserId
lastSavedAt
mimeType
name
projectId
sentences {
...TextSentenceFragment
}
settings {
...SettingsFragment
}
statistic {
...TextDocumentStatisticFragment
}
status
statusUpdatedByUserId
timeLimit
timeLimitScheduledCommandId
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
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
status
customAttribute
}
}
}
Variables
{
"input": UpdateMultiRowAnswersInput,
"questionSetSignature": "xyz789"
}
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
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
}
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
}
anonymizationMaskedColumnNames
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
leafOnlyOption
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
kinds
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
type
description
imagePreviewURL
videoURL
}
}
Variables
{"teamId": "4", "projectTemplateIds": [4]}
Response
{
"data": {
"updatePinnedProjectTemplates": [
{
"id": "4",
"name": "xyz789",
"logoURL": "xyz789",
"projectTemplateProjectSettingId": "4",
"projectTemplateTextDocumentSettingId": 4,
"projectTemplateProjectSetting": ProjectTemplateProjectSetting,
"projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
"labelSetTemplates": [LabelSetTemplate],
"questionSets": [QuestionSet],
"createdAt": "xyz789",
"updatedAt": "xyz789",
"purpose": "LABELING",
"creatorId": 4,
"type": "CUSTOM",
"description": "xyz789",
"imagePreviewURL": "abc123",
"videoURL": "xyz789"
}
]
}
}
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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
taskScope {
...TaskScopeFragment
}
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
enableRapidLabelingFeedback
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
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
}
anonymizationMaskedColumnIds
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
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
}
availableDocumentsCount
}
}
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": "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],
"availableDocumentsCount": 123
}
}
}
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": 987
}
}
}
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
pageRange
}
}
}
Variables
{"input": UpdateProjectExtensionElementSettingInput}
Response
{
"data": {
"updateProjectExtensionElementSetting": {
"id": 4,
"enabled": true,
"extension": Extension,
"height": 123,
"order": 123,
"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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
taskScope {
...TaskScopeFragment
}
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
enableRapidLabelingFeedback
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
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
}
anonymizationMaskedColumnIds
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
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
}
availableDocumentsCount
}
}
Variables
{"input": UpdateProjectGuidelineInput}
Response
{
"data": {
"updateProjectGuideline": {
"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": 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],
"availableDocumentsCount": 987
}
}
}
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
}
allowCustomAttribute
}
lastUsedBy {
projectId
name
}
arrowLabelRequired
leafOnlyOption
}
}
Variables
{"input": UpdateProjectLabelSetInput}
Response
{
"data": {
"updateProjectLabelSet": {
"id": 4,
"name": "abc123",
"index": 987,
"signature": "xyz789",
"tagItems": [TagItem],
"lastUsedBy": LastUsedProject,
"arrowLabelRequired": false,
"leafOnlyOption": 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
}
allowCustomAttribute
}
lastUsedBy {
projectId
name
}
arrowLabelRequired
leafOnlyOption
}
}
Variables
{"input": UpdateProjectLabelSetByLabelSetTemplateInput}
Response
{
"data": {
"updateProjectLabelSetByLabelSetTemplate": {
"id": "4",
"name": "xyz789",
"index": 123,
"signature": "xyz789",
"tagItems": [TagItem],
"lastUsedBy": LastUsedProject,
"arrowLabelRequired": true,
"leafOnlyOption": false
}
}
}
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": "xyz789",
"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
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
taskScope {
...TaskScopeFragment
}
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
enableRapidLabelingFeedback
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
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
}
anonymizationMaskedColumnIds
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
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
}
availableDocumentsCount
}
}
Variables
{"input": UpdateProjectSettingsInput}
Response
{
"data": {
"updateProjectSettings": {
"id": 4,
"team": Team,
"teamId": 4,
"owner": User,
"externalObjectStorageId": "abc123",
"rootDocumentId": "4",
"assignees": [ProjectAssignment],
"name": "xyz789",
"tags": [Tag],
"type": "abc123",
"createdDate": "xyz789",
"completedDate": "xyz789",
"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],
"availableDocumentsCount": 123
}
}
}
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
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
}
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
}
anonymizationMaskedColumnNames
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
leafOnlyOption
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
kinds
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": "xyz789",
"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
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
}
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
}
anonymizationMaskedColumnNames
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
leafOnlyOption
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
kinds
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
type
description
imagePreviewURL
videoURL
}
}
Variables
{"input": UpdateProjectTemplateInput}
Response
{
"data": {
"updateProjectTemplateV2": {
"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": "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
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
shouldConfirmUnusedLabelSetItems
labelerProjectCompletionNotificationThreshold
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
}
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
}
anonymizationMaskedColumnNames
}
labelSetTemplates {
id
name
owner {
...UserFragment
}
type
items {
...LabelSetTemplateItemFragment
}
count
createdAt
updatedAt
leafOnlyOption
}
questionSets {
name
id
creator {
...UserFragment
}
items {
...QuestionSetItemFragment
}
kinds
createdAt
updatedAt
}
createdAt
updatedAt
purpose
creatorId
}
}
Variables
{"ids": ["4"]}
Response
{
"data": {
"updateProjectTemplatesOrdering": [
{
"id": 4,
"name": "xyz789",
"teamId": "4",
"team": Team,
"logoURL": "abc123",
"projectTemplateProjectSettingId": "4",
"projectTemplateTextDocumentSettingId": 4,
"projectTemplateProjectSetting": ProjectTemplateProjectSetting,
"projectTemplateTextDocumentSetting": ProjectTemplateTextDocumentSetting,
"labelSetTemplates": [LabelSetTemplate],
"questionSets": [QuestionSet],
"createdAt": "abc123",
"updatedAt": "abc123",
"purpose": "LABELING",
"creatorId": "4"
}
]
}
}
updateProjectsTags
Response
Returns [Project!]!
Arguments
| Name | Description |
|---|---|
input - [UpdateProjectTagsInput!]!
|
Example
Query
mutation UpdateProjectsTags($input: [UpdateProjectTagsInput!]!) {
updateProjectsTags(input: $input) {
id
team {
id
logoURL
members {
...TeamMemberFragment
}
membersScalar
name
setting {
...TeamSettingFragment
}
owner {
...UserFragment
}
isExpired
expiredAt
}
teamId
owner {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
externalObjectStorageId
rootDocumentId
assignees {
teamMember {
...TeamMemberFragment
}
documentIds
documents {
...TextDocumentFragment
}
role
taskScope {
...TaskScopeFragment
}
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
enableRapidLabelingFeedback
enablePrelabeledDraft
enableReviewerAddLabel
hideLabelerNamesDuringReview
hideLabelsFromInactiveLabelSetDuringReview
hideOriginalSentencesDuringReview
hideRejectedLabelsDuringReview
labelerProjectCompletionNotification {
...LabelerProjectCompletionNotificationFragment
}
selfAssignmentLimit {
...SelfAssignmentLimitFragment
}
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
}
anonymizationMaskedColumnIds
viewer
viewerConfig {
...TextDocumentViewerConfigFragment
}
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
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
}
availableDocumentsCount
}
}
Variables
{"input": [UpdateProjectTagsInput]}
Response
{
"data": {
"updateProjectsTags": [
{
"id": "4",
"team": Team,
"teamId": "4",
"owner": User,
"externalObjectStorageId": "abc123",
"rootDocumentId": 4,
"assignees": [ProjectAssignment],
"name": "xyz789",
"tags": [Tag],
"type": "xyz789",
"createdDate": "abc123",
"completedDate": "xyz789",
"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],
"availableDocumentsCount": 987
}
]
}
}
updateQuestionSet
Response
Returns a QuestionSet!
Arguments
| Name | Description |
|---|---|
input - UpdateQuestionSetInput!
|
Example
Query
mutation UpdateQuestionSet($input: UpdateQuestionSetInput!) {
updateQuestionSet(input: $input) {
name
id
creator {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
items {
id
index
questionSetId
label
type
hint
multipleAnswer
required
bindToColumn
activationConditionLogic
createdAt
updatedAt
options {
...DropdownConfigOptionsFragment
}
leafOptionsOnly
format
defaultValue
max
min
theme
gradientColors
step
hideScaleLabel
multiline
maxLength
minLength
pattern
customScript {
...CustomScriptFragment
}
nestedQuestions {
...QuestionSetItemFragment
}
parentId
}
kinds
createdAt
updatedAt
}
}
Variables
{"input": UpdateQuestionSetInput}
Response
{
"data": {
"updateQuestionSet": {
"name": "xyz789",
"id": 4,
"creator": User,
"items": [QuestionSetItem],
"kinds": ["DOCUMENT_BASED"],
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
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": "xyz789",
"template": "xyz789",
"createdAt": "xyz789",
"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
retryCount
maxRetry
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": true,
"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
completedByUserId
lastSavedAt
mimeType
name
projectId
sentences {
...TextSentenceFragment
}
settings {
...SettingsFragment
}
statistic {
...TextDocumentStatisticFragment
}
status
statusUpdatedByUserId
timeLimit
timeLimitScheduledCommandId
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": 987,
"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
customScript {
...CustomScriptFragment
}
}
bindToColumn
activationConditionLogic
targetEntity
}
}
Variables
{
"projectId": 4,
"input": QuestionInput,
"signature": "xyz789"
}
Response
{
"data": {
"updateRowQuestion": {
"id": 987,
"internalId": "xyz789",
"type": "DROPDOWN",
"name": "abc123",
"label": "xyz789",
"required": true,
"config": QuestionConfig,
"bindToColumn": "abc123",
"activationConditionLogic": "abc123",
"targetEntity": "xyz789"
}
}
}
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
customScript {
...CustomScriptFragment
}
}
bindToColumn
activationConditionLogic
targetEntity
}
}
Variables
{
"projectId": 4,
"input": [QuestionInput],
"signature": "abc123"
}
Response
{
"data": {
"updateRowQuestions": [
{
"id": 987,
"internalId": "abc123",
"type": "DROPDOWN",
"name": "xyz789",
"label": "abc123",
"required": true,
"config": QuestionConfig,
"bindToColumn": "xyz789",
"activationConditionLogic": "abc123",
"targetEntity": "abc123"
}
]
}
}
updateSavedSearch
Response
Returns a SavedSearch!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - SaveSearchInput!
|
Example
Query
mutation UpdateSavedSearch(
$id: ID!,
$input: SaveSearchInput!
) {
updateSavedSearch(
id: $id,
input: $input
) {
id
owner {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
lastModifiedBy {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
name
description
type
conditions
projectId
createdAt
updatedAt
}
}
Variables
{"id": 4, "input": SaveSearchInput}
Response
{
"data": {
"updateSavedSearch": {
"id": "4",
"owner": User,
"lastModifiedBy": User,
"name": "xyz789",
"description": "abc123",
"type": "STANDARD",
"conditions": "abc123",
"projectId": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
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
logoutUrl
simpleLogoutRedirect
}
active
}
}
Variables
{"input": UpdateScimInput}
Response
{
"data": {
"updateScim": {
"id": "4",
"team": Team,
"samlTenant": SamlTenant,
"active": true
}
}
}
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": "xyz789",
"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
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
status
customAttribute
}
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
}
userId
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
labelingAgent {
...LabelingAgentFragment
}
labelingAgentId
}
membersScalar
name
setting {
activitySettings {
...TeamActivitySettingsFragment
}
additionalSetting {
...AdditionalTeamSettingFragment
}
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedASRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enabledCustomObjectStorage
enableActions
enableAddDocumentsToProject
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurDinamicTokenBased
enableDatasaurPredictiveRowBased
enableLabelingAgentSpanBased
enableLabelingAgentRowBased
enableLabelingAgentArrowBased
enableWipeData
enableExportTeamOverview
enableSelfAssignment
enableWebhookSelfService
enableOauthApplicationSelfService
enableTransferOwnership
enableLabelErrorDetectionRowBased
allowedExtraAutoLabelProviders
enableLLMProject
enableRegexSentenceSeparator
enableTeamRoleSupervisor
endExtensionTrialAt
allowInvalidPaymentMethod
enableExternalKnowledgeBase
enableForceAnonymization
enableReviewIndicator
enableValidationScript
enableSpanLabelingWithRowQuestions
llmFreeTrialDailyLimitsConfig {
...LlmFreeTrialDailyLimitsConfigFragment
}
enableScriptGeneratedQuestion
rowModification {
...RowModificationSettingFragment
}
enableDeployedApplicationLogging
enableRealTimeAssistedLabelingSpanBased
enableLabelsAndAnswersExportFormat
enableGoogleDriveExternalObjectStorage
enableMLAssistedOptimizationByDefault
}
owner {
id
samlId
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": "abc123",
"members": [TeamMember],
"membersScalar": TeamMembersScalar,
"name": "xyz789",
"setting": TeamSetting,
"owner": User,
"isExpired": true,
"expiredAt": "2007-12-03T10:15:30Z"
}
}
}
updateTeamMemberLastAccessedAt
updateTeamMemberTeamRole
Response
Returns a TeamMember
Arguments
| Name | Description |
|---|---|
input - UpdateTeamMemberTeamRoleInput!
|
Example
Query
mutation UpdateTeamMemberTeamRole($input: UpdateTeamMemberTeamRoleInput!) {
updateTeamMemberTeamRole(input: $input) {
id
user {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
userId
role {
id
name
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
id
userId
projectStatistic {
...TeamMemberProjectStatisticFragment
}
totalTimeSpent
effectiveTotalTimeSpent
accuracy
}
labelingAgent {
id
agentId
agentType
name
}
labelingAgentId
}
}
Variables
{"input": UpdateTeamMemberTeamRoleInput}
Response
{
"data": {
"updateTeamMemberTeamRole": {
"id": "4",
"user": User,
"userId": "4",
"role": TeamRole,
"invitationEmail": "abc123",
"invitationStatus": "abc123",
"invitationKey": "abc123",
"isDeleted": true,
"joinedDate": "abc123",
"performance": TeamMemberPerformance,
"labelingAgent": LabelingAgent,
"labelingAgentId": "4"
}
}
}
updateTeamOauthApplication
Response
Returns an OauthApplication!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
teamId - ID!
|
|
input - UpdateOauthApplicationInput!
|
Example
Query
mutation UpdateTeamOauthApplication(
$id: ID!,
$teamId: ID!,
$input: UpdateOauthApplicationInput!
) {
updateTeamOauthApplication(
id: $id,
teamId: $teamId,
input: $input
) {
id
name
redirectUris
allowedScopes
isEnabled
createdAt
}
}
Variables
{
"id": 4,
"teamId": 4,
"input": UpdateOauthApplicationInput
}
Response
{
"data": {
"updateTeamOauthApplication": {
"id": 4,
"name": "abc123",
"redirectUris": ["abc123"],
"allowedScopes": ["xyz789"],
"isEnabled": true,
"createdAt": "2007-12-03T10:15:30Z"
}
}
}
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
}
userId
role {
...TeamRoleFragment
}
invitationEmail
invitationStatus
invitationKey
isDeleted
joinedDate
performance {
...TeamMemberPerformanceFragment
}
labelingAgent {
...LabelingAgentFragment
}
labelingAgentId
}
membersScalar
name
setting {
activitySettings {
...TeamActivitySettingsFragment
}
additionalSetting {
...AdditionalTeamSettingFragment
}
allowedAdminExportMethods
allowedLabelerExportMethods
allowedOCRProviders
allowedASRProviders
allowedReviewerExportMethods
commentNotificationType
customAPICreationLimit
defaultCustomTextExtractionAPIId
defaultExternalObjectStorageId
enabledCustomObjectStorage
enableActions
enableAddDocumentsToProject
enableDemo
enableDataProgramming
enableLabelingFunctionMultipleLabel
enableDatasaurAssistRowBased
enableDatasaurDinamicTokenBased
enableDatasaurPredictiveRowBased
enableLabelingAgentSpanBased
enableLabelingAgentRowBased
enableLabelingAgentArrowBased
enableWipeData
enableExportTeamOverview
enableSelfAssignment
enableWebhookSelfService
enableOauthApplicationSelfService
enableTransferOwnership
enableLabelErrorDetectionRowBased
allowedExtraAutoLabelProviders
enableLLMProject
enableRegexSentenceSeparator
enableTeamRoleSupervisor
endExtensionTrialAt
allowInvalidPaymentMethod
enableExternalKnowledgeBase
enableForceAnonymization
enableReviewIndicator
enableValidationScript
enableSpanLabelingWithRowQuestions
llmFreeTrialDailyLimitsConfig {
...LlmFreeTrialDailyLimitsConfigFragment
}
enableScriptGeneratedQuestion
rowModification {
...RowModificationSettingFragment
}
enableDeployedApplicationLogging
enableRealTimeAssistedLabelingSpanBased
enableLabelsAndAnswersExportFormat
enableGoogleDriveExternalObjectStorage
enableMLAssistedOptimizationByDefault
}
owner {
id
samlId
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": "xyz789",
"members": [TeamMember],
"membersScalar": TeamMembersScalar,
"name": "abc123",
"setting": TeamSetting,
"owner": User,
"isExpired": true,
"expiredAt": "2007-12-03T10:15:30Z"
}
}
}
updateTeamWebhook
Response
Returns a Webhook!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateWebhookInput!
|
Example
Query
mutation UpdateTeamWebhook(
$id: ID!,
$input: UpdateWebhookInput!
) {
updateTeamWebhook(
id: $id,
input: $input
) {
id
teamId
url
events
customHeaders
isEnabled
enabledAt
disabledAt
createdBy
updatedBy
lastDeliveryAt
lastDeliveryStatus
createdAt
updatedAt
}
}
Variables
{
"id": "4",
"input": UpdateWebhookInput
}
Response
{
"data": {
"updateTeamWebhook": {
"id": "4",
"teamId": 4,
"url": "abc123",
"events": ["PROJECT_CREATED"],
"customHeaders": {},
"isEnabled": false,
"enabledAt": "abc123",
"disabledAt": "xyz789",
"createdBy": "4",
"updatedBy": 4,
"lastDeliveryAt": "xyz789",
"lastDeliveryStatus": 987,
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
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
logoutUrl
simpleLogoutRedirect
}
}
Variables
{"input": UpdateSamlTenantInput}
Response
{
"data": {
"updateTenant": {
"id": 4,
"active": true,
"companyId": "4",
"idpIssuer": "xyz789",
"idpUrl": "abc123",
"spIssuer": "xyz789",
"team": Team,
"allowMembersToSetPassword": true,
"logoutUrl": "abc123",
"simpleLogoutRedirect": 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
}
anonymizationMaskedColumnIds
fileTransformerId
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
fileName
isCompleted
completedByUserId
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
labeledLines
answeredLines
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
prelabeledLines
}
status
statusUpdatedByUserId
timeLimit
timeLimitScheduledCommandId
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
status
customAttribute
}
url
version
workspaceState {
id
chunkId
sentenceStart
sentenceEnd
touchedChunks
touchedSentences
}
originId
signature
part
}
}
Variables
{"input": UpdateTextDocumentInput}
Response
{
"data": {
"updateTextDocument": {
"id": "4",
"chunks": [TextChunk],
"createdAt": "xyz789",
"currentSentenceCursor": 123,
"lastLabeledLine": 123,
"documentSettings": TextDocumentSettings,
"fileName": "abc123",
"isCompleted": true,
"completedByUserId": "4",
"lastSavedAt": "xyz789",
"mimeType": "xyz789",
"name": "abc123",
"projectId": "4",
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"status": "NOT_STARTED",
"statusUpdatedByUserId": "4",
"timeLimit": "2007-12-03T10:15:30Z",
"timeLimitScheduledCommandId": 4,
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "abc123",
"version": 123,
"workspaceState": WorkspaceState,
"originId": "4",
"signature": "abc123",
"part": 123
}
}
}
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
}
anonymizationMaskedColumnIds
fileTransformerId
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
}
Variables
{"input": UpdateTextDocumentSettingsInput}
Response
{
"data": {
"updateTextDocumentSettings": {
"id": 4,
"textLabelMaxTokenLength": 987,
"allTokensMustBeLabeled": false,
"autoScrollWhenLabeling": false,
"allowArcDrawing": true,
"allowCharacterBasedLabeling": true,
"allowMultiLabels": true,
"kinds": ["DOCUMENT_BASED"],
"sentenceSeparator": "abc123",
"tokenizer": "xyz789",
"editSentenceTokenizer": "abc123",
"displayedRows": 987,
"mediaDisplayStrategy": "NONE",
"viewer": "TOKEN",
"viewerConfig": TextDocumentViewerConfig,
"hideBoundingBoxIfNoSpanOrArrowLabel": true,
"enableTabularMarkdownParsing": false,
"enableAnonymization": false,
"anonymizationEntityTypes": [
"xyz789"
],
"anonymizationMaskingMethod": "xyz789",
"anonymizationRegExps": [RegularExpression],
"anonymizationMaskedColumnIds": [987],
"fileTransformerId": "xyz789",
"rowQuestionsFormValidationScriptId": 4,
"enableRowQuestionsFormValidationScript": false
}
}
}
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
}
anonymizationMaskedColumnIds
fileTransformerId
rowQuestionsFormValidationScriptId
enableRowQuestionsFormValidationScript
}
fileName
isCompleted
completedByUserId
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
labeledLines
answeredLines
nonDisplayedLines
numberOfEntitiesLabeled
numberOfNonDocumentEntitiesLabeled
maxLabeledLine
labelerStatistic {
...LabelerStatisticFragment
}
documentTouched
prelabeledLines
}
status
statusUpdatedByUserId
timeLimit
timeLimitScheduledCommandId
type
updatedChunks {
id
documentId
sentenceIndexStart
sentenceIndexEnd
sentences {
...TextSentenceFragment
}
}
updatedTokenLabels {
id
l
layer
deleted
hashCode
labeledBy
labeledByUser {
...UserFragment
}
labeledByUserId
acceptedByUserId
rejectedByUserId
createdAt
updatedAt
documentId
start {
...TextCursorFragment
}
end {
...TextCursorFragment
}
confidenceScore
status
customAttribute
}
url
version
workspaceState {
id
chunkId
sentenceStart
sentenceEnd
touchedChunks
touchedSentences
}
originId
signature
part
}
}
Variables
{"input": UpdateTokenLabelsInput}
Response
{
"data": {
"updateTokenLabels": {
"id": 4,
"chunks": [TextChunk],
"createdAt": "abc123",
"currentSentenceCursor": 987,
"lastLabeledLine": 987,
"documentSettings": TextDocumentSettings,
"fileName": "abc123",
"isCompleted": false,
"completedByUserId": "4",
"lastSavedAt": "xyz789",
"mimeType": "abc123",
"name": "xyz789",
"projectId": 4,
"sentences": [TextSentence],
"settings": Settings,
"statistic": TextDocumentStatistic,
"status": "NOT_STARTED",
"statusUpdatedByUserId": 4,
"timeLimit": "2007-12-03T10:15:30Z",
"timeLimitScheduledCommandId": "4",
"type": "POS",
"updatedChunks": [TextChunk],
"updatedTokenLabels": [TextLabel],
"url": "abc123",
"version": 987,
"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
samlId
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",
"samlId": "xyz789",
"amazonCustomerId": "xyz789",
"username": "abc123",
"name": "xyz789",
"email": "abc123",
"package": "ENTERPRISE",
"profilePicture": "abc123",
"allowedActions": ["AUTOMATED_TEST"],
"displayName": "xyz789",
"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
}
availableDocumentsCount
}
}
}
Variables
{"input": UploadGuidelineInput}
Response
{
"data": {
"uploadGuideline": {
"id": "4",
"name": "abc123",
"content": "xyz789",
"project": Project
}
}
}
uploadLlmApplicationPlaygroundPromptMessages
Breaking changes may be introduced anytime in the future without prior notice.
Response
Arguments
| Name | Description |
|---|---|
input - UploadLlmApplicationPlaygroundPromptMessagesInput!
|
Example
Query
mutation UploadLlmApplicationPlaygroundPromptMessages($input: UploadLlmApplicationPlaygroundPromptMessagesInput!) {
uploadLlmApplicationPlaygroundPromptMessages(input: $input) {
id
llmApplicationPlaygroundPromptId
content
role
attachments {
id
llmFileId
llmFile {
...LlmFileFragment
}
createdAt
updatedAt
llmApplicationPlaygroundPromptMessageId
}
createdAt
updatedAt
}
}
Variables
{
"input": UploadLlmApplicationPlaygroundPromptMessagesInput
}
Response
{
"data": {
"uploadLlmApplicationPlaygroundPromptMessages": [
{
"id": 4,
"llmApplicationPlaygroundPromptId": "4",
"content": "abc123",
"role": "USER",
"attachments": [
LlmApplicationPlaygroundPromptAttachment
],
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
]
}
}
upsertAudioLabels
Description
Creates or replaces (by id) audio labels on the document.
Response
Returns [AudioLabel!]!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
labels - [AudioLabelInput!]!
|
Example
Query
mutation UpsertAudioLabels(
$documentId: ID!,
$labels: [AudioLabelInput!]!
) {
upsertAudioLabels(
documentId: $documentId,
labels: $labels
) {
id
hashCode
documentId
labelSetIndex
labelSetItemId
counter
startTimestampMillis
endTimestampMillis
customAttribute
labeledBy
labeledByUserId
status
type
}
}
Variables
{
"documentId": "4",
"labels": [AudioLabelInput]
}
Response
{
"data": {
"upsertAudioLabels": [
{
"id": "4",
"hashCode": "abc123",
"documentId": 4,
"labelSetIndex": 987,
"labelSetItemId": "4",
"counter": 987,
"startTimestampMillis": 987,
"endTimestampMillis": 987,
"customAttribute": "xyz789",
"labeledBy": "PRELABELED",
"labeledByUserId": "4",
"status": "LABELED",
"type": "AUDIO"
}
]
}
}
upsertBBoxArrowLabels
Response
Returns [BBoxArrowLabel!]!
Arguments
| Name | Description |
|---|---|
documentId - ID!
|
|
inputs - [BBoxArrowLabelInput!]!
|
Example
Query
mutation UpsertBBoxArrowLabels(
$documentId: ID!,
$inputs: [BBoxArrowLabelInput!]!
) {
upsertBBoxArrowLabels(
documentId: $documentId,
inputs: $inputs
) {
id
documentId
originBBoxLabelId
destinationBBoxLabelId
type
arrowLabelClassId
originShapeIndex
destinationShapeIndex
status
labeledBy
labeledByUserId
acceptedByUserId
rejectedByUserId
updatedAt
}
}
Variables
{
"documentId": "4",
"inputs": [BBoxArrowLabelInput]
}
Response
{
"data": {
"upsertBBoxArrowLabels": [
{
"id": "4",
"documentId": 4,
"originBBoxLabelId": "4",
"destinationBBoxLabelId": "4",
"type": "abc123",
"arrowLabelClassId": "4",
"originShapeIndex": 987,
"destinationShapeIndex": 123,
"status": "LABELED",
"labeledBy": "PRELABELED",
"labeledByUserId": 4,
"acceptedByUserId": "4",
"rejectedByUserId": "4",
"updatedAt": "xyz789"
}
]
}
}
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
labeledBy
labeledByUserId
}
}
Variables
{"documentId": 4, "labels": [BBoxLabelInput]}
Response
{
"data": {
"upsertBBoxLabels": [
{
"id": "4",
"documentId": 4,
"bboxLabelClassId": 4,
"deleted": true,
"caption": "abc123",
"shapes": [BBoxShape],
"answers": AnswerScalar,
"labeledBy": "PRELABELED",
"labeledByUserId": 4
}
]
}
}
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": 987,
"pageIndex": 987,
"layer": 987,
"position": TextRange,
"hashCode": "xyz789",
"type": "AUDIO",
"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": "abc123",
"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
samlId
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
}
totalRagConfigs
}
llmRagConfig {
id
llmModel {
...LlmModelFragment
}
systemInstruction
userInstruction
raw
temperature
topP
maxTokens
advancedHyperparameters
maxVectorStoreTokens
llmVectorStore {
...LlmVectorStoreFragment
}
llmVectorStores {
...LlmVectorStoreFragment
}
similarityThreshold
enableAnonymization
maxChunkSize
createdAt
updatedAt
}
numberOfCalls
numberOfTokens
numberOfInputTokens
numberOfOutputTokens
deployedAt
name
status
createdAt
updatedAt
apiEndpoints {
type
endpoint
}
isDeleted
}
}
Variables
{"input": LlmApplicationDeploymentInput}
Response
{
"data": {
"upsertLlmApplicationDeployment": {
"id": "4",
"deployedByUser": User,
"llmApplicationId": "4",
"llmApplication": LlmApplication,
"llmRagConfig": LlmRagConfig,
"numberOfCalls": 123,
"numberOfTokens": 123,
"numberOfInputTokens": 123,
"numberOfOutputTokens": 123,
"deployedAt": "abc123",
"name": "abc123",
"status": "SUSPENDED",
"createdAt": "xyz789",
"updatedAt": "abc123",
"apiEndpoints": [
LlmApplicationDeploymentApiEndpoint
],
"isDeleted": true
}
}
}
upsertLlmApplicationPlaygroundPromptMessages
Breaking changes may be introduced anytime in the future without prior notice.
Response
Arguments
| Name | Description |
|---|---|
input - UpsertLlmApplicationPlaygroundPromptMessageInput!
|
Example
Query
mutation UpsertLlmApplicationPlaygroundPromptMessages($input: UpsertLlmApplicationPlaygroundPromptMessageInput!) {
upsertLlmApplicationPlaygroundPromptMessages(input: $input) {
id
llmApplicationPlaygroundPromptId
content
role
attachments {
id
llmFileId
llmFile {
...LlmFileFragment
}
createdAt
updatedAt
llmApplicationPlaygroundPromptMessageId
}
createdAt
updatedAt
}
}
Variables
{
"input": UpsertLlmApplicationPlaygroundPromptMessageInput
}
Response
{
"data": {
"upsertLlmApplicationPlaygroundPromptMessages": [
{
"id": 4,
"llmApplicationPlaygroundPromptId": 4,
"content": "abc123",
"role": "USER",
"attachments": [
LlmApplicationPlaygroundPromptAttachment
],
"createdAt": "xyz789",
"updatedAt": "abc123"
}
]
}
}
upsertLlmManualEvaluationScores
Breaking changes may be introduced anytime in the future without prior notice.
Description
Upserts the LLM evaluation scores.
Response
Returns [LlmEvaluationAnswerScore!]!
Arguments
| Name | Description |
|---|---|
input - UpsertLlmManualEvaluationScoreInput!
|
Example
Query
mutation UpsertLlmManualEvaluationScores($input: UpsertLlmManualEvaluationScoreInput!) {
upsertLlmManualEvaluationScores(input: $input) {
id
llmEvaluationEvaluatorId
llmEvaluationGeneratedAnswerId
score
reason
alertExpression
createdAt
updatedAt
isDeleted
}
}
Variables
{"input": UpsertLlmManualEvaluationScoreInput}
Response
{
"data": {
"upsertLlmManualEvaluationScores": [
{
"id": "4",
"llmEvaluationEvaluatorId": "4",
"llmEvaluationGeneratedAnswerId": 4,
"score": 987.65,
"reason": "xyz789",
"alertExpression": "xyz789",
"createdAt": "abc123",
"updatedAt": "xyz789",
"isDeleted": true
}
]
}
}
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"
}
}
}
upsertLlmVectorStoreQuestions
Response
Returns [Question!]!
Arguments
| Name | Description |
|---|---|
input - UpsertLlmVectorStoreQuestionsInput!
|
Example
Query
mutation UpsertLlmVectorStoreQuestions($input: UpsertLlmVectorStoreQuestionsInput!) {
upsertLlmVectorStoreQuestions(input: $input) {
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
customScript {
...CustomScriptFragment
}
}
bindToColumn
activationConditionLogic
targetEntity
}
}
Variables
{"input": UpsertLlmVectorStoreQuestionsInput}
Response
{
"data": {
"upsertLlmVectorStoreQuestions": [
{
"id": 987,
"internalId": "xyz789",
"type": "DROPDOWN",
"name": "xyz789",
"label": "abc123",
"required": true,
"config": QuestionConfig,
"bindToColumn": "abc123",
"activationConditionLogic": "abc123",
"targetEntity": "abc123"
}
]
}
}
upsertLlmVectorStoreUrlSyncSchedule
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a LlmVectorStore!
Arguments
| Name | Description |
|---|---|
input - UpsertLlmVectorStoreUrlSyncScheduleInput!
|
Example
Query
mutation UpsertLlmVectorStoreUrlSyncSchedule($input: UpsertLlmVectorStoreUrlSyncScheduleInput!) {
upsertLlmVectorStoreUrlSyncSchedule(input: $input) {
id
teamId
createdByUser {
id
samlId
amazonCustomerId
username
name
email
package
profilePicture
allowedActions
displayName
teamPackage
emailVerified
totpAuthEnabled
companyName
createdAt
signUpParams {
...SignUpParamsFragment
}
}
llmEmbeddingModel {
id
teamId
provider
name
displayName
url
maxTokens
dimensions
deployableModelId
isModelDeployable
createdAt
updatedAt
variant
customDimension
}
provider
collectionId
name
status
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
targetEntity
}
jobId
chunkConfiguration
filePropertiesExtractorConfiguration {
type
configuration
syncedFilePropertiesJsonSchema
}
urlSyncScheduledCommandConfig {
id
cronPattern
repeatInterval
runImmediately
endTime
numberOfRepetition
isNeverEnding
isPeriodic
updatedAt
}
urlSyncNextSchedule
urlSyncLastSyncedAt
createdAt
updatedAt
dimension
}
}
Variables
{"input": UpsertLlmVectorStoreUrlSyncScheduleInput}
Response
{
"data": {
"upsertLlmVectorStoreUrlSyncSchedule": {
"id": 4,
"teamId": 4,
"createdByUser": User,
"llmEmbeddingModel": LlmEmbeddingModel,
"provider": "DATASAUR",
"collectionId": "xyz789",
"name": "xyz789",
"status": "CREATED",
"documents": [LlmVectorStoreDocumentScalar],
"documentStatusCount": LlmVectorStoreDocumentCountByStatus,
"sourceDocuments": [LlmVectorStoreSourceDocument],
"questions": [Question],
"jobId": "xyz789",
"chunkConfiguration": ChunkConfiguration,
"filePropertiesExtractorConfiguration": LlmVectorStoreFilePropertiesExtractorConfiguration,
"urlSyncScheduledCommandConfig": ScheduledCommandConfig,
"urlSyncNextSchedule": "xyz789",
"urlSyncLastSyncedAt": "xyz789",
"createdAt": "abc123",
"updatedAt": "abc123",
"dimension": 123
}
}
}
upsertOauthClient
Description
Updates the oauth client.
Response
Returns an UpsertOauthClientResult
Arguments
| Name | Description |
|---|---|
input - UpsertOauthClientInput
|
Example
Query
mutation UpsertOauthClient($input: UpsertOauthClientInput) {
upsertOauthClient(input: $input) {
id
secret
}
}
Variables
{"input": UpsertOauthClientInput}
Response
{
"data": {
"upsertOauthClient": {
"id": "abc123",
"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
azureAIClientId
azureAICertificate
azureAITenantId
azureAISubscriptionId
azureAIResourceGroupName
azureAIAccountName
awsSagemakerRegion
awsSagemakerExternalId
awsSagemakerRoleArn
awsBedrockRegion
awsBedrockExternalId
awsBedrockRoleArn
vertexAiClientEmail
vertexAiPrivateKey
vertexAiProjectId
vertexAiRegion
}
createdAt
updatedAt
}
}
Variables
{"input": TeamExternalApiKeyInput}
Response
{
"data": {
"upsertTeamExternalApiKey": {
"id": "4",
"teamId": 4,
"credentials": [TeamExternalApiKeyCredential],
"createdAt": "xyz789",
"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
counter
type
}
}
Variables
{"documentId": 4, "labels": [TimestampLabelInput]}
Response
{
"data": {
"upsertTimestampLabels": [
{
"id": "4",
"documentId": "4",
"layer": 987,
"position": TextRange,
"startTimestampMillis": 123,
"endTimestampMillis": 123,
"counter": 987,
"type": "AUDIO"
}
]
}
}
useRagConfigInSandbox
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns an ID!
Arguments
| Name | Description |
|---|---|
input - UseRagConfigInSandboxInput!
|
Example
Query
mutation UseRagConfigInSandbox($input: UseRagConfigInSandboxInput!) {
useRagConfigInSandbox(input: $input)
}
Variables
{"input": UseRagConfigInSandboxInput}
Response
{"data": {"useRagConfigInSandbox": 4}}
useVectorStoreInLlmApplication
Breaking changes may be introduced anytime in the future without prior notice.
Response
Returns a UseVectorStoreInLlmApplicationResult!
Arguments
| Name | Description |
|---|---|
input - UseVectorStoreInLlmApplicationInput!
|
Example
Query
mutation UseVectorStoreInLlmApplication($input: UseVectorStoreInLlmApplicationInput!) {
useVectorStoreInLlmApplication(input: $input) {
llmApplicationId
llmApplicationPlaygroundRagConfigIds
}
}
Variables
{"input": UseVectorStoreInLlmApplicationInput}
Response
{
"data": {
"useVectorStoreInLlmApplication": {
"llmApplicationId": "4",
"llmApplicationPlaygroundRagConfigIds": [4]
}
}
}
verifyTotp
Response
Returns a LoginSuccess!
Arguments
| Name | Description |
|---|---|
totpCode - TotpCodeInput!
|
Example
Query
mutation VerifyTotp($totpCode: TotpCodeInput!) {
verifyTotp(totpCode: $totpCode) {
user {
id
samlId
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": ["abc123"]}
Response
{"data": {"wipeProjects": ["xyz789"]}}
Types
ASRProvider
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"OPENAI_WHISPER"
AcceptAllPredictedLabelsInput
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
|
signature - String
|
|
labelType - LabelType!
|
|
layer - Int
|
|
isSuggestedLabels - Boolean
|
Example
{
"documentId": "4",
"signature": "abc123",
"labelType": "SPAN",
"layer": 123,
"isSuggestedLabels": false
}
AcceptTeamInvitationLinkInput
Fields
| Input Field | Description |
|---|---|
invitationKey - String!
|
Example
{"invitationKey": "abc123"}
Action
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AUTOMATED_TEST"
ActionRunDetailStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"SUCCESS"
ActionType
Values
| Enum Value | Description |
|---|---|
|
|
Create Project Action using Project Template |
Example
"CREATE_PROJECT"
ActivityAdditionalData
ActivityEvent
Fields
| Field Name | Description |
|---|---|
event - ActivityEventType!
|
|
visibility - ActivityEventVisibility!
|
|
teamId - ID!
|
|
userId - ID!
|
|
userDisplayName - String!
|
|
createdAt - String!
|
|
projectId - ID
|
|
projectName - String
|
|
documentId - ID
|
|
documentType - String
|
|
documentName - String
|
|
labelAddressHashCode - String
|
|
labelType - String
|
|
bulkId - ID
|
|
additionalData - [ActivityAdditionalData!]
|
Example
{
"event": "ANSWER_SET",
"visibility": "PUBLIC",
"teamId": "4",
"userId": "4",
"userDisplayName": "abc123",
"createdAt": "abc123",
"projectId": 4,
"projectName": "abc123",
"documentId": "4",
"documentType": "xyz789",
"documentName": "abc123",
"labelAddressHashCode": "abc123",
"labelType": "xyz789",
"bulkId": 4,
"additionalData": [ActivityAdditionalData]
}
ActivityEventType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ANSWER_SET"
ActivityEventVisibility
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PUBLIC"
ActivitySuggestion
Fields
| Field Name | Description |
|---|---|
displayName - String!
|
|
id - ID!
|
|
groupId - LabelerGroupId
|
Example
{
"displayName": "abc123",
"id": 4,
"groupId": "ALL"
}
ActivitySuggestionScope
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PROJECT"
AddActiveDurationInput
AddCustomEmbeddingModelInput
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": "abc123",
"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": "xyz789",
"defaultTemplateType": "WITH_SPECIFIC_TARGET_LABEL",
"content": "abc123",
"heuristicArgument": HeuristicArgumentScalar,
"annotatorArgument": AnnotatorArgumentScalar
}
AddLlmCustomModelInput
Example
{
"teamId": 4,
"name": "abc123",
"displayName": "abc123",
"url": "abc123",
"apiKey": "abc123",
"maxContextWindow": 987,
"maxTokens": 123,
"maxTemperature": 987.65,
"maxTopP": 987.65
}
AddProjectKindsInput
Description
Input for adding new project kinds to an existing project.
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
The ID of the project to update. |
kinds - [ProjectKind!]!
|
The list of project kinds to add. |
Example
{
"projectId": "4",
"kinds": ["DOCUMENT_BASED"]
}
AddUserHotkeyOverrideInput
Fields
| Input Field | Description |
|---|---|
platform - Platform!
|
|
overrides - [HotKeyOverrideInput!]!
|
Example
{"platform": "LINUX", "overrides": [HotKeyOverrideInput]}
AdditionalTeamSetting
Fields
| Field Name | Description |
|---|---|
customUploadSetting - CustomUploadSetting
|
|
enableGeneratedInvitationLink - Boolean
|
|
enablePerDocumentConflictableRecalculation - Boolean
|
Example
{
"customUploadSetting": CustomUploadSetting,
"enableGeneratedInvitationLink": false,
"enablePerDocumentConflictableRecalculation": true
}
AgentType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"LLM_LABS"
AnalyticsDashboardQueryInput
Example
{
"teamId": 4,
"projectId": "4",
"userId": 4,
"teamMemberId": "4",
"labelType": "TOKEN_OR_ROW_BASED",
"calendarDate": "xyz789",
"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. |
maskedColumnNames - [String!]
|
Optional. Row-based projects only. Restricts PII detection/masking to these column names (matched against this same request's customHeaderColumns). The backend resolves each name to its column's positional index/id — the caller never sends an id directly. When omitted or empty, all columns are scanned (default behavior). |
Example
{
"entityTypes": ["xyz789"],
"maskingMethod": "xyz789",
"regularExpressions": [RegularExpressionInput],
"maskedColumnNames": ["abc123"]
}
AnonymizedSpan
Description
Represents an anonymized span within a document line. Contains the token range and PII type for the anonymized content.
Fields
| Field Name | Description |
|---|---|
line - Int!
|
The line number (0-indexed) where the span is located. |
type - String!
|
The type of PII detected (e.g., 'PERSON', 'LOCATION', 'EMAIL'). |
startTokenIndex - Int!
|
The starting token index (inclusive) of the anonymized span. |
endTokenIndex - Int!
|
The ending token index (exclusive) of the anonymized span. |
Example
{
"line": 987,
"type": "abc123",
"startTokenIndex": 987,
"endTokenIndex": 987
}
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!
|
|
labeledByUserId - ID
|
|
createdAt - String
|
|
updatedAt - String
|
Example
{
"path": "abc123",
"labeledBy": "PRELABELED",
"labeledByUserId": 4,
"createdAt": "abc123",
"updatedAt": "abc123"
}
AnswerMetadataInput
Fields
| Input Field | Description |
|---|---|
path - String!
|
|
labeledBy - LabelPhase
|
Example
{
"path": "abc123",
"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": "abc123",
"tagItems": [AppendTagItemInput],
"arrowLabelRequired": false
}
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. |
allowCustomAttribute - Boolean
|
Optional. If true, labelers can add custom attributes to labels of this class. Defaults to false. |
Example
{
"tagName": "abc123",
"desc": "abc123",
"id": "4",
"color": "xyz789",
"type": "SPAN",
"arrowRules": [LabelClassArrowRuleInput],
"allowCustomAttribute": true
}
AssignProjectInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
assignees - [ProjectAssignmentInput!]!
|
Example
{"projectId": 4, "assignees": [ProjectAssignmentInput]}
AudioLabel
Description
A time-bounded label attached to an audio document.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
hashCode - String!
|
Hash of the label's content, used to identify identical candidates across labelers during conflict resolution. |
documentId - ID!
|
|
labelSetIndex - Int!
|
|
labelSetItemId - ID!
|
|
counter - Int!
|
|
startTimestampMillis - Int!
|
|
endTimestampMillis - Int!
|
|
customAttribute - String
|
|
labeledBy - LabelPhase
|
|
labeledByUserId - ID
|
|
status - LabelStatus
|
|
type - LabelEntityType!
|
Example
{
"id": 4,
"hashCode": "xyz789",
"documentId": "4",
"labelSetIndex": 123,
"labelSetItemId": "4",
"counter": 987,
"startTimestampMillis": 987,
"endTimestampMillis": 123,
"customAttribute": "xyz789",
"labeledBy": "PRELABELED",
"labeledByUserId": "4",
"status": "LABELED",
"type": "AUDIO"
}
AudioLabelConflict
Description
A reviewer-side audio label candidate produced by comparing labelers' submissions on the same timespan, together with whether it is resolved and who proposed it.
Fields
| Field Name | Description |
|---|---|
label - AudioLabel!
|
The candidate label. For an unresolved conflict this is the review document's CONFLICT row. |
resolved - Boolean!
|
True when all labelers agree on this candidate (no competing candidates remain for the timespan). |
labelers - [User!]!
|
Labelers who proposed this exact candidate. |
Example
{
"label": AudioLabel,
"resolved": false,
"labelers": [User]
}
AudioLabelInput
Example
{
"id": 4,
"labelSetIndex": 123,
"labelSetItemId": "4",
"counter": 123,
"startTimestampMillis": 987,
"endTimestampMillis": 987,
"customAttribute": "abc123",
"labeledBy": "PRELABELED"
}
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
|
|
providerRawResponse - LLMLabsResponse
|
Example
{
"id": "4",
"documentId": 4,
"bboxLabelClassId": "4",
"caption": "xyz789",
"shapes": [BBoxShape],
"confidenceScore": 987.65,
"error": AutoLabelError,
"providerRawResponse": LLMLabsResponse
}
AutoLabelDocBasedInput
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
Example
{"documentId": 4}
AutoLabelDocBasedOutput
Fields
| Field Name | Description |
|---|---|
documentId - ID!
|
|
answers - AnswerScalar!
|
|
providerRawResponse - LLMLabsResponse
|
Example
{
"documentId": 4,
"answers": AnswerScalar,
"providerRawResponse": LLMLabsResponse
}
AutoLabelDocBasedProjectInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
documentId - ID!
|
|
pageRange - RangeInput
|
|
role - Role!
|
Example
{
"projectId": "4",
"documentId": 4,
"pageRange": RangeInput,
"role": "REVIEWER"
}
AutoLabelError
AutoLabelModel
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
provider - GqlAutoLabelServiceProvider!
|
|
privacy - GqlAutoLabelModelPrivacy!
|
Example
{
"name": "xyz789",
"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
|
|
sentencesPerRequest - Int
|
|
layer - Int
|
Example
{
"serviceProvider": "CUSTOM",
"numberOfFilesPerRequest": 987,
"sentencesPerRequest": 987,
"layer": 123
}
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": [987],
"rowIdRange": RangeInput
}
AutoLabelRowBasedOutput
Fields
| Field Name | Description |
|---|---|
id - Int!
|
|
label - String!
|
|
error - AutoLabelError
|
|
providerRawResponse - LLMLabsResponse
|
Example
{
"id": 987,
"label": "xyz789",
"error": AutoLabelError,
"providerRawResponse": LLMLabsResponse
}
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
|
|
providerRawResponse - LLMLabsResponse
|
Example
{
"label": "xyz789",
"deleted": false,
"layer": 123,
"start": TextCursor,
"end": TextCursor,
"confidenceScore": 123.45,
"error": AutoLabelError,
"providerRawResponse": LLMLabsResponse
}
AutoLabelTokenBasedProjectInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
documentId - ID
|
|
labelerEmail - String
|
|
role - Role
|
|
targetAPI - TargetApiInput
|
|
options - AutoLabelProjectOptionsInput!
|
Example
{
"projectId": 4,
"documentId": "4",
"labelerEmail": "abc123",
"role": "REVIEWER",
"targetAPI": TargetApiInput,
"options": AutoLabelProjectOptionsInput
}
AwsMarketplaceNlpFreeTrialExpiration
AwsMarketplaceSubscriptionInput
BBoxArrowLabel
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
documentId - ID!
|
|
originBBoxLabelId - ID!
|
|
destinationBBoxLabelId - ID!
|
|
type - String!
|
|
arrowLabelClassId - ID
|
|
originShapeIndex - Int!
|
|
destinationShapeIndex - Int!
|
|
status - LabelStatus!
|
|
labeledBy - LabelPhase!
|
|
labeledByUserId - ID
|
|
acceptedByUserId - ID
|
|
rejectedByUserId - ID
|
|
updatedAt - String!
|
Example
{
"id": "4",
"documentId": "4",
"originBBoxLabelId": 4,
"destinationBBoxLabelId": "4",
"type": "xyz789",
"arrowLabelClassId": "4",
"originShapeIndex": 123,
"destinationShapeIndex": 123,
"status": "LABELED",
"labeledBy": "PRELABELED",
"labeledByUserId": 4,
"acceptedByUserId": "4",
"rejectedByUserId": "4",
"updatedAt": "abc123"
}
BBoxArrowLabelInput
Example
{
"id": "4",
"originBBoxLabelId": 4,
"destinationBBoxLabelId": 4,
"arrowLabelClassId": 4,
"originShapeIndex": 123,
"destinationShapeIndex": 123
}
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
|
|
labeledBy - LabelPhase
|
|
labeledByUserId - ID
|
Example
{
"id": "4",
"documentId": "4",
"bboxLabelClassId": 4,
"deleted": false,
"caption": "xyz789",
"shapes": [BBoxShape],
"answers": AnswerScalar,
"labeledBy": "PRELABELED",
"labeledByUserId": "4"
}
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": "abc123",
"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": 123, "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": "AUDIO",
"labeledBy": "PRELABELED"
}
BoundingBoxLabelInput
Fields
| Input Field | Description |
|---|---|
coordinates - [CoordinateInput!]!
|
|
counter - Int!
|
|
pageIndex - Int
|
|
layer - Int!
|
|
position - TextRangeInput!
|
|
labeledBy - LabelPhase
|
Example
{
"coordinates": [CoordinateInput],
"counter": 123,
"pageIndex": 987,
"layer": 987,
"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"
CancelAutoLabelProjectJobInput
CancelDatasaurPredictiveTrainingJobInput
Fields
| Input Field | Description |
|---|---|
projectId - ID!
|
|
provider - DatasaurPredictiveProvider!
|
Example
{"projectId": "4", "provider": "SETFIT"}
CancelRealTimeAssistedLabelingJobInput
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
Example
{"documentId": 4}
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": ["xyz789"],
"metadata": [CellMetadata],
"conversationalMetadata": ConversationalMetadata,
"status": "DISPLAYED",
"conflict": false,
"conflicts": [CellConflict],
"originCell": Cell
}
CellConflict
Fields
| Field Name | Description |
|---|---|
documentId - ID!
|
|
labelerId - Int!
|
|
labelerTeamMemberId - ID
|
|
cell - Cell!
|
|
labels - [TextLabel!]!
|
Example
{
"documentId": 4,
"labelerId": 123,
"labelerTeamMemberId": 4,
"cell": Cell,
"labels": [TextLabel]
}
CellMetadata
Fields
| Field Name | Description |
|---|---|
key - String!
|
|
value - String!
|
|
type - String
|
|
pinned - Boolean
|
|
config - TextMetadataConfig
|
Example
{
"key": "xyz789",
"value": "xyz789",
"type": "abc123",
"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": "abc123",
"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": "xyz789",
"description": "xyz789",
"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": "abc123",
"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"
CheckConnectionResult
Fields
| Field Name | Description |
|---|---|
readOnly - Boolean!
|
Example
{"readOnly": false}
ChunkConfiguration
Example
ChunkConfiguration
ClearAllLabelsOnTextDocumentResult
Fields
| Field Name | Description |
|---|---|
affectedChunkIds - [Int!]!
|
|
statistic - TextDocumentStatistic!
|
|
lastSavedAt - String!
|
Example
{
"affectedChunkIds": [987],
"statistic": TextDocumentStatistic,
"lastSavedAt": "xyz789"
}
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": "xyz789",
"resolved": false,
"resolvedAt": "xyz789",
"resolvedBy": User,
"repliesCount": 123,
"createdAt": "xyz789",
"updatedAt": "abc123",
"lastEditedAt": "abc123",
"hashCode": "xyz789",
"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
Fields
| Field Name | Description |
|---|---|
resolved - Boolean
|
|
value - String!
|
|
userIds - [ID!]!
|
|
users - [User!]!
|
|
contributorInfos - [ContributorInfo!]
|
|
labelPhase - LabelPhase!
|
|
acceptedByUserId - ID
|
|
rejectedByUserId - ID
|
Example
{
"resolved": false,
"value": "abc123",
"userIds": [4],
"users": [User],
"contributorInfos": [ContributorInfo],
"labelPhase": "PRELABELED",
"acceptedByUserId": "4",
"rejectedByUserId": "4"
}
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": true,
"hashCode": "xyz789",
"labelerIds": [987],
"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": 987}
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": "xyz789",
"labelerIds": [123],
"labelers": [User],
"resolved": false,
"text": "abc123",
"hashCode": "abc123",
"documentId": "xyz789",
"start": TextCursor,
"end": TextCursor,
"acceptedByUserId": 4,
"rejectedByUserId": 4,
"customAttribute": "xyz789"
}
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.
Example
{
"id": 4,
"labelPhase": "PRELABELED",
"acceptedByUserId": "4",
"rejectedByUserId": 4,
"userId": 4,
"teamMemberId": 4
}
ConversationalMetadata
Fields
| Field Name | Description |
|---|---|
speaker - String!
|
|
indent - Int!
|
|
alignment - ConversationalMetadataAlignment!
|
|
color - String
|
Example
{
"speaker": "xyz789",
"indent": 123,
"alignment": "LEFT",
"color": "xyz789"
}
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": "abc123",
"color": "abc123",
"captionAllowed": true,
"captionRequired": false,
"questions": [QuestionInput]
}
CreateBBoxLabelSetInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
classes - [CreateBBoxLabelClassInput!]!
|
|
autoLabelProvider - BBoxAutoLabelProvider
|
Example
{
"name": "abc123",
"classes": [CreateBBoxLabelClassInput],
"autoLabelProvider": "TESSERACT"
}
CreateChunkInput
CreateChunkResponse
Fields
| Field Name | Description |
|---|---|
createdChunk - DocumentChunk!
|
|
previousChunk - DocumentChunk
|
|
nextChunk - DocumentChunk
|
Example
{
"createdChunk": DocumentChunk,
"previousChunk": DocumentChunk,
"nextChunk": DocumentChunk
}
CreateCreateProjectActionInput
Description
Parameters for creating create project Action.
Fields
| Input Field | Description |
|---|---|
immutableInput - Boolean
|
If true, the action does not modify the input bucket. Required when input bucket is marked read-only. Cannot be combined with externalObjectStorageIdOutput. |
ingestMode - IngestMode
|
How document bytes should be ingested from the external object storage. Defaults to PRESIGNED. Opt-in via the Advanced panel. |
skipDeduplication - Boolean
|
If true, every run creates a project for every non-empty folder, even ones already processed by a prior run. Defaults to false. |
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. |
externalObjectStorageIdOutput - ID
|
ID of the external object storage used for writing action output. If not set, uses the same bucket as externalObjectStorageId. |
externalObjectStoragePathInput - String!
|
The path inside the external object storage to retrieve the documents from. |
externalObjectStoragePathResult - String!
|
The path inside the external object storage to write the output files 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
{
"immutableInput": true,
"ingestMode": "PRESIGNED",
"skipDeduplication": true,
"name": "xyz789",
"teamId": "4",
"externalObjectStorageId": 4,
"externalObjectStorageIdOutput": "4",
"externalObjectStoragePathInput": "xyz789",
"externalObjectStoragePathResult": "abc123",
"projectTemplateId": "4",
"assignments": [CreateProjectActionAssignmentInput],
"additionalTagNames": ["abc123"],
"numberOfLabelersPerProject": 987,
"numberOfReviewersPerProject": 987,
"numberOfLabelersPerDocument": 987,
"conflictResolutionMode": "MANUAL",
"consensus": 987
}
CreateCustomAPIInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
endpointURL - String!
|
|
purpose - CustomAPIPurpose!
|
|
secret - String!
|
Example
{
"name": "xyz789",
"endpointURL": "xyz789",
"purpose": "ASR_API",
"secret": "xyz789"
}
CreateDocumentChunkInput
Example
{
"llmVectorStoreId": "4",
"fileName": "abc123",
"objectKey": "abc123",
"chunkConfiguration": ChunkConfiguration,
"externalObjectStorageId": 4,
"filePath": "abc123"
}
CreateDocumentChunkResult
Fields
| Field Name | Description |
|---|---|
chunks - [DocumentChunk!]!
|
|
defaultChunkMetadata - DefaultChunkMetadata
|
Example
{
"chunks": [DocumentChunk],
"defaultChunkMetadata": DefaultChunkMetadata
}
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": "abc123"
}
CreateDomainClaimInput
CreateExternalObjectStorageInput
Fields
| Input Field | Description |
|---|---|
cloudService - ObjectStorageClientName!
|
|
bucketId - String
|
|
bucketName - String!
|
|
name - String
|
Optional display name. Defaults to the bucket name when blank. |
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!
|
|
readOnly - Boolean
|
If true, the bucket is treated as read-only by Datasaur. Defaults to false. |
Example
{
"cloudService": "AWS_S3",
"bucketId": "xyz789",
"bucketName": "xyz789",
"name": "xyz789",
"credentials": ExternalObjectStorageCredentialsInput,
"securityToken": "abc123",
"teamId": "4",
"readOnly": true
}
CreateFileTransformerInput
Fields
| Input Field | Description |
|---|---|
teamId - ID!
|
|
name - String!
|
|
purpose - FileTransformerPurpose!
|
Example
{
"teamId": 4,
"name": "abc123",
"purpose": "IMPORT"
}
CreateGroundTruthInput
CreateGroundTruthSetForFineTuningInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
teamId - ID!
|
|
items - [CreateGroundTruthInput!]!
|
Example
{
"name": "abc123",
"teamId": 4,
"items": [CreateGroundTruthInput]
}
CreateGroundTruthSetInput
CreateLLMApplicationDocBasedInput
CreateLLMApplicationDocBasedOutput
Fields
| Field Name | Description |
|---|---|
llmApplicationId - ID!
|
Example
{"llmApplicationId": "4"}
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. |
leafOnlyOption - Boolean
|
Optional. If true, the labelset will only allow leaf options to be selected. |
Example
{
"name": "abc123",
"index": 123,
"tagItems": [TagItemInput],
"arrowLabelRequired": false,
"leafOnlyOption": 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. |
leafOnlyOption - Boolean
|
Optional. If true, the labelset template will only allow leaf options to be selected. |
Example
{
"name": "xyz789",
"teamId": "4",
"questions": [LabelSetTemplateItemInput],
"leafOnlyOption": false
}
CreateLlmApplicationConfigurationInput
Example
{
"name": "abc123",
"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
|
|
collectionId - String
|
|
authenticationScheme - GqlLlmVectorStoreAuthenticationScheme
|
|
username - String
|
|
password - String
|
|
questions - [QuestionInput!]
|
Optional. Set the questions for LLM Vector Store. |
dimension - Int
|
|
chunkConfiguration - ChunkConfiguration
|
Optional. The chunk configuration for the llm vector store. |
filePropertiesExtractorConfiguration - LlmVectorStoreFilePropertiesExtractorConfigurationInput
|
Optional. The file properties extractor configuration for the llm vector store. |
Example
{
"name": "xyz789",
"teamId": "4",
"provider": "DATASAUR",
"llmEmbeddingModelId": "4",
"collectionId": "abc123",
"authenticationScheme": "BASIC",
"username": "xyz789",
"password": "abc123",
"questions": [QuestionInput],
"dimension": 987,
"chunkConfiguration": ChunkConfiguration,
"filePropertiesExtractorConfiguration": LlmVectorStoreFilePropertiesExtractorConfigurationInput
}
CreateNewPasswordInput
Fields
| Input Field | Description |
|---|---|
newPassword - String!
|
|
confirmNewPassword - String!
|
|
totpCode - TotpCodeInput
|
Example
{
"newPassword": "abc123",
"confirmNewPassword": "xyz789",
"totpCode": TotpCodeInput
}
CreateOauthApplicationInput
Fields
| Input Field | Description |
|---|---|
teamId - ID!
|
|
name - String!
|
|
redirectUris - [String!]!
|
|
allowedScopes - [String!]!
|
Example
{
"teamId": "4",
"name": "xyz789",
"redirectUris": ["abc123"],
"allowedScopes": ["xyz789"]
}
CreatePersonalTagInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
Example
{"name": "abc123"}
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. |
externalObjectStorageIdOutput - ID
|
ID of the external object storage used for writing action output. If not set, uses the same bucket as externalObjectStorageId. |
externalObjectStorageOutput - ExternalObjectStorage
|
External object storage object used for writing action output. |
externalObjectStoragePathInput - String!
|
The path inside the external object storage to retrieve the documents from. |
externalObjectStoragePathResult - String!
|
The path inside the external object storage to write the output files to. |
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. |
immutableInput - Boolean!
|
If true, the action does not modify the input bucket. Processed folders are tracked in the database and skipped on subsequent runs. |
ingestMode - IngestMode!
|
How document bytes are ingested from the external object storage. Defaults to PRESIGNED. |
skipDeduplication - Boolean!
|
If true, every run creates a project for every non-empty folder, even ones already processed by a prior run. Defaults to false. |
Example
{
"id": 4,
"name": "xyz789",
"teamId": "4",
"appVersion": "abc123",
"creatorId": "4",
"lastRunAt": "abc123",
"lastFinishedAt": "abc123",
"externalObjectStorageId": 4,
"externalObjectStorage": ExternalObjectStorage,
"externalObjectStorageIdOutput": 4,
"externalObjectStorageOutput": ExternalObjectStorage,
"externalObjectStoragePathInput": "xyz789",
"externalObjectStoragePathResult": "xyz789",
"projectTemplateId": 4,
"projectTemplate": ProjectTemplate,
"assignments": [CreateProjectActionAssignment],
"additionalTagNames": ["abc123"],
"numberOfLabelersPerProject": 123,
"numberOfReviewersPerProject": 987,
"numberOfLabelersPerDocument": 123,
"conflictResolutionMode": "MANUAL",
"consensus": 987,
"warnings": ["ASSIGNED_LABELER_NOT_MEET_CONSENSUS"],
"immutableInput": false,
"ingestMode": "PRESIGNED",
"skipDeduplication": false
}
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": 987,
"totalAssignedAsReviewer": 987
}
CreateProjectActionAssignmentInput
Description
Parameters for assigning a create project Action.
Fields
| Input Field | Description |
|---|---|
teamMemberId - String!
|
|
role - ProjectAssignmentRole!
|
Example
{
"teamMemberId": "abc123",
"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 |
totalWarnings - Int!
|
Total number of projects created with a warning (e.g. created but the source folder could not be cleaned up) |
totalFailure - Int!
|
Total number of projects unsuccessfully created |
error - DatasaurError
|
Run-level error / halt reason when the run stopped early. Null on clean runs. |
notice - DatasaurError
|
Run-level informational notice for a no-op finish that is NOT a failure: the input folder was empty (NO_FILES_FOUND), or every sub-folder already had a project from a prior run (CPA_NOTHING_NEW). The run still finishes; null whenever a project was created or the run failed. |
externalObjectStorageId - String!
|
ID of the external object storage used in this Action. |
externalObjectStorageIdOutput - String
|
ID of the external object storage used for writing action output. If not set, uses the same bucket as externalObjectStorageId. |
externalObjectStoragePathInput - String!
|
The path inside the external object storage to retrieve the documents from. |
externalObjectStoragePathResult - String!
|
The path inside the external object storage to write the output files 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": "abc123",
"triggeredByUserId": "4",
"triggeredBy": User,
"startAt": "xyz789",
"endAt": "abc123",
"totalSuccess": 123,
"totalWarnings": 987,
"totalFailure": 987,
"error": DatasaurError,
"notice": DatasaurError,
"externalObjectStorageId": "abc123",
"externalObjectStorageIdOutput": "xyz789",
"externalObjectStoragePathInput": "abc123",
"externalObjectStoragePathResult": "xyz789",
"projectTemplate": Snapshot,
"assignments": [Snapshot],
"numberOfLabelersPerProject": 987,
"numberOfReviewersPerProject": 123,
"numberOfLabelersPerDocument": 123,
"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!
|