> ## Documentation Index > Fetch the complete documentation index at: https://arize-ax.mintlify.site/docs/llms.txt > Use this file to discover all available pages before exploring further. # Data import mutations > Control file and table import jobs, integration keys and BYOB connectors. Arguments, return types and a validated example for each of the 24 mutations. Control file and table import jobs, integration keys and BYOB connectors. For task-oriented walkthroughs of these operations, see the [Data import guide](/docs/ax/graphql-reference/guides/data-import.md). Every mutation below is sent as a `POST` to `https://app.arize.com/graphql` with an `x-api-key` header; see [Forming calls](/docs/ax/graphql-reference/overview/how-to-use-graphql/forming-calls.md). ## Mutations in this page * [`createFileImportJob`](#createfileimportjob): Create a job that will import model inferences from a blob store * [`updateFileImportJob`](#updatefileimportjob): Update an existing job that has been imported from a blob store * [`startFileImportJob`](#startfileimportjob): Start an existing job that has been imported from a blob store * [`pauseFileImportJob`](#pausefileimportjob): Pause an existing job that has been imported from a blob store * [`deleteFileImportJob`](#deletefileimportjob): Delete an existing job that has been imported from a blob store * [`resetFileStatus`](#resetfilestatus): Reset the status of a file * [`createTableImportJob`](#createtableimportjob): Create a job that will import model inferences from a table * [`updateTableImportJob`](#updatetableimportjob): Update an existing job that has been imported from a table * [`updateTableIngestionParameters`](#updatetableingestionparameters): Update an existing job that has been imported from a table * [`startTableImportJob`](#starttableimportjob): Start an existing job that has been imported from a table * [`pauseTableImportJob`](#pausetableimportjob): Pause an existing job that has been imported from a table * [`deleteTableImportJob`](#deletetableimportjob): Delete an existing job that has been imported from a table * [`createTriggeredOngoingTableImportJob`](#createtriggeredongoingtableimportjob): Create a job that will import model inferences from a table * [`createTriggeredOngoingTableRun`](#createtriggeredongoingtablerun): Schedule a job run that will import model inferences from a table * [`createIntegrationKey`](#createintegrationkey): Create integration key. * [`patchIntegrationKey`](#patchintegrationkey): Patch integration key. * [`testIntegrationKey`](#testintegrationkey): Test integration key. * [`deleteIntegrationKey`](#deleteintegrationkey): Delete integration key. * [`validateByobConnector`](#validatebyobconnector): Validate a byob connector * [`createByobConnector`](#createbyobconnector): Create a byob connector * [`updateByobConnector`](#updatebyobconnector): Update a byob connector * [`deleteByobConnector`](#deletebyobconnector): Delete a byob connector * [`updateByobSyncedDatasource`](#updatebyobsynceddatasource): Update a byob synced datasource * [`deleteByobDatasource`](#deletebyobdatasource): Delete a byob datasource ## Reference ### createFileImportJob Create a job that will import model inferences from a blob store `createFileImportJob(input: CreateFileImportJobInput!): CreateFileImportJobPayload` #### Arguments **input** `CreateFileImportJobInput!` *required* **CreateFileImportJobInput fields** **spaceId** `ID!` *required* The space id for the space under which the model should be ingested **azureStorageIdentifier** `AzureStorageIdentifier` Additional information required to locate an Azure container. Required when running with an Azure service principal or managed identity. **AzureStorageIdentifier fields** **tenantId** `String!` *required* The Azure Active Directory Tenant ID associated with the Storage Account. **storageAccountName** `String!` *required* The Azure Storage Account name. **modelName** `String!` *required* The model identifier or name under which the model will be stored. **modelType** `ModelType!` *required* The type of model. This determines how the model will be analyzed One of: `numeric`, `score_categorical`, `ranking`, `object_detection`, `generative_llm`, `multi_class`. **modelEnvironmentName** `ModelEnvironmentName!` *required* The environment for which the inferences are being ingested One of: `production`, `validation`, `training`, `tracing`. **batchId** `String` A name for the ingestion batch. Only required if the environment is validation **modelVersion** `String` The model version. This will tag all the inferences as being for a specific version string. **blobStore** `BlobStoreType!` *required* The cloud storage solution where the files reside One of: `S3`, `GCS`, `Azure`. **bucketName** `String!` *required* The bucket where the files are stored. Arize must have access to this bucket **prefix** `String!` *required* The path to the files. Ex. cc\_model **schema** `FileImportSchemaInputType!` *required* The schema for the CSV or Parquet files. The schema describes a mapping from your column names to model dimensions **FileImportSchemaInputType fields** **predictionId** `String` The name of the predictionId column in the file **predictionGroupId** `String` The name of the predictionGroupId column in the file. Required if the model is type ranking **features** `String` A prefix capture group used to match feature columns **featuresList** `[String!]` A list of column names specifying features **timestamp** `String` The name of the timestamp column in the file **predictionLabel** `String` The name of the prediction label column in the file. Supported on model of type score\_categorical **predictionScore** `String` The name of the prediction score column in the file. Supported on models of type numeric and score\_categorical **predictionScores** `String` The name of the prediction scores column in the file. Supported on multi\_class models **actualLabel** `String` The name of the actual label column in the file. Supported on model of type score\_categorical **actualScore** `String` The name of the actual score column in the file. Supported on models of type numeric and score\_categorical **actualScores** `String` The name of the actual scores column in the file. Supported on multi\_class models **thresholdScores** `String` The name of the threshold scores column in the file. Supported on multi\_class models **relevanceLabel** `String` The name of the relevance label column in the file. Required if the model is type ranking **relevanceScore** `String` The name of the relevance score column in the file. Required if the model is type ranking **version** `String` The name of the model version column in the file **batchId** `String` The name of the validation batch id. Required if the model is type validation **tags** `String` A prefix capture group used to match tag column **tagsList** `[String!]` A list of column names specifying tags **shapValues** `String` A regex like capture group that should be used to match shap column **rank** `String` The name of the rank column in the file. Required if the model is type ranking **exclude** `[String!]` The names of fields to be excluded from data ingestion **embeddingFeatures** `[FileImportEmbeddingInputType!]` The embedding fields that will be ingested **FileImportEmbeddingInputType fields** **featureName** `String!` *required* The embedding feature name **vectorCol** `String!` *required* The name of the vector column **rawDataCol** `String` The name of the raw data column **linkToDataCol** `String` The name of the link to data column **prompt** `FileImportPromptResponseInputType` The columns which contain the prompt used in a generative LLM. Relevant if the model is generative\_llm **FileImportPromptResponseInputType fields** **vectorCol** `String` The name of the vector column **rawDataCol** `String!` *required* The name of the raw data column. Required if the prompt or response is specified **response** `FileImportPromptResponseInputType` The columns which contain the response from a generative LLM. Relevant if the model is generative\_llm **FileImportPromptResponseInputType fields** **vectorCol** `String` The name of the vector column **rawDataCol** `String!` *required* The name of the raw data column. Required if the prompt or response is specified **promptTemplate** `FileImportPromptTemplateInputType` The columns which contain the prompt template fields, such as the template and template version. Relevant if the model is generative\_llm **FileImportPromptTemplateInputType fields** **template** `String` The name of the column which contains the prompt template **templateVersion** `String` The name of the column which contains the prompt template version **llmConfig** `FileImportLlmConfigInputType` The columns which contain the llm config fields, such as the llm name and params. Relevant if the model is generative\_llm **FileImportLlmConfigInputType fields** **llmName** `String` The name of the column which contains the llm name **llmParams** `String` The name of the column which contains a map of llm params to values **runMetadata** `FileImportRunMetadataInputType` The columns which contain the metadata relevant to the llm call that was used to generate the response using the prompt. Relevant if the model is generative\_llm **FileImportRunMetadataInputType fields** **totalTokenCount** `String` The name of the column which contains the total number of tokens used in the llm call **promptTokenCount** `String` The name of the column which contains the number of prompt tokens in the llm call **responseTokenCount** `String` The name of the column which contains the number of response tokens in the llm call **responseLatencyMs** `String` The name of the column which contains the response latency in ms of the llm call **predictionObjectDetectionLabel** `FileImportObjectDetectionLabelInputType` The columns which contain the object detection prediction fields, such as the bounding box coordinates, categories, and scores. Relevant if the model is object\_detection **FileImportObjectDetectionLabelInputType fields** **boundingBoxesCoordinatesColumnName** `String!` *required* The name of the column which contains the bounding box coordinates **boundingBoxesCategoriesColumnName** `String!` *required* The name of the column which contains a map of bounding box categories **boundingBoxesScoresColumnName** `String` The name of the column which contains a map of bounding box scores **actualObjectDetectionLabel** `FileImportObjectDetectionLabelInputType` The columns which contain the object detection actual fields, such as the bounding box coordinates, categories, and scores. Relevant if the model is object\_detection **FileImportObjectDetectionLabelInputType fields** **boundingBoxesCoordinatesColumnName** `String!` *required* The name of the column which contains the bounding box coordinates **boundingBoxesCategoriesColumnName** `String!` *required* The name of the column which contains a map of bounding box categories **boundingBoxesScoresColumnName** `String` The name of the column which contains a map of bounding box scores **fileName** `String` The name of the file to perform a dry run on (ex. test-file.avro). If a file name is not selected, the dry run will be performed on the first file **dryRun** `Boolean` If true, the import job will be attempted but no changes will be written. The fileResult field may be requested to check the validation status. Default is false **clientMutationId** `String` #### Returns **space** `Space` **Space fields** Scalar fields: `id`, `name`, `description`, `uuid`, `createdAt`, `liveEnabled`, `isLLMOnlySpace`, `playgroundTracingModelId`, `evalTracingModelId`, `sandboxTracingModelId`, `mlModelsEnabled`, `private`, `gradientStartColor`, `gradientEndColor`, `hasDashboardsCreated`. Object fields (select subfields): `organization`, `models`, `monitors`, `dashboards`, `spaceUsers`, `byobConnectors`, `importJobs`, `tableJobs`, `sandboxJobs`, `signalInsightSummary`, `signalEnabledProjectSummary`, `signalIssues`, `agentIssues`, `automations`, `datasets`, `experiments`, `customMetrics`, `onlineTasks`, `prompts`, `tags`, `evaluators`, `annotationQueues`, `playgroundViews`, `annotationConfigs`, `traceFilters`, `llmIntegrations`, `defaultLlmIntegration`, `defaultAgentRuntime`, `gates`, `_access`. **validationResult** `JobValidationResult` **JobValidationResult fields** Scalar fields: `filePath`, `validationStatus`. Object fields (select subfields): `error`. **filePreview** `FilePreviewResult` **FilePreviewResult fields** Scalar fields: `filePath`. Object fields (select subfields): `columnMetadata`, `rows`, `errorCode`. **fileImportJob** `FileImportJob` **FileImportJob fields** Scalar fields: `id`, `jobId`, `bucketName`, `createdAt`, `modelName`, `modelId`, `jobUuid`, `modelType`, `modelVersion`, `modelEnvironmentName`, `batchId`, `blobStore`, `prefix`, `totalFilesSuccessCount`, `totalFilesFailedCount`, `totalFilesPendingCount`, `jobStatus`. Object fields (select subfields): `schema`, `files`. #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation CreateFileImportJob($input: CreateFileImportJobInput!) { createFileImportJob(input: $input) { space { id name } validationResult { filePath } filePreview { filePath } } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "spaceId": "", "modelName": "", "modelType": "numeric", "modelEnvironmentName": "production", "blobStore": "S3", "bucketName": "", "prefix": "", "schema": {} } } ``` ### updateFileImportJob Update an existing job that has been imported from a blob store `updateFileImportJob(input: UpdateFileImportJobInput!): UpdateFileImportJobPayload` #### Arguments **input** `UpdateFileImportJobInput!` *required* **UpdateFileImportJobInput fields** **jobId** `ID!` *required* The ID of an import job to delete **jobStatus** `JobStatus` The status of the imported job One of: `ONGOING_INACTIVE`, `ONGOING_DELETED`. **schema** `FileImportSchemaInputType!` *required* The schema for the CSV or Parquet files. The schema describes a mapping from your column names to model dimensions **FileImportSchemaInputType fields** **predictionId** `String` The name of the predictionId column in the file **predictionGroupId** `String` The name of the predictionGroupId column in the file. Required if the model is type ranking **features** `String` A prefix capture group used to match feature columns **featuresList** `[String!]` A list of column names specifying features **timestamp** `String` The name of the timestamp column in the file **predictionLabel** `String` The name of the prediction label column in the file. Supported on model of type score\_categorical **predictionScore** `String` The name of the prediction score column in the file. Supported on models of type numeric and score\_categorical **predictionScores** `String` The name of the prediction scores column in the file. Supported on multi\_class models **actualLabel** `String` The name of the actual label column in the file. Supported on model of type score\_categorical **actualScore** `String` The name of the actual score column in the file. Supported on models of type numeric and score\_categorical **actualScores** `String` The name of the actual scores column in the file. Supported on multi\_class models **thresholdScores** `String` The name of the threshold scores column in the file. Supported on multi\_class models **relevanceLabel** `String` The name of the relevance label column in the file. Required if the model is type ranking **relevanceScore** `String` The name of the relevance score column in the file. Required if the model is type ranking **version** `String` The name of the model version column in the file **batchId** `String` The name of the validation batch id. Required if the model is type validation **tags** `String` A prefix capture group used to match tag column **tagsList** `[String!]` A list of column names specifying tags **shapValues** `String` A regex like capture group that should be used to match shap column **rank** `String` The name of the rank column in the file. Required if the model is type ranking **exclude** `[String!]` The names of fields to be excluded from data ingestion **embeddingFeatures** `[FileImportEmbeddingInputType!]` The embedding fields that will be ingested **FileImportEmbeddingInputType fields** **featureName** `String!` *required* The embedding feature name **vectorCol** `String!` *required* The name of the vector column **rawDataCol** `String` The name of the raw data column **linkToDataCol** `String` The name of the link to data column **prompt** `FileImportPromptResponseInputType` The columns which contain the prompt used in a generative LLM. Relevant if the model is generative\_llm **FileImportPromptResponseInputType fields** **vectorCol** `String` The name of the vector column **rawDataCol** `String!` *required* The name of the raw data column. Required if the prompt or response is specified **response** `FileImportPromptResponseInputType` The columns which contain the response from a generative LLM. Relevant if the model is generative\_llm **FileImportPromptResponseInputType fields** **vectorCol** `String` The name of the vector column **rawDataCol** `String!` *required* The name of the raw data column. Required if the prompt or response is specified **promptTemplate** `FileImportPromptTemplateInputType` The columns which contain the prompt template fields, such as the template and template version. Relevant if the model is generative\_llm **FileImportPromptTemplateInputType fields** **template** `String` The name of the column which contains the prompt template **templateVersion** `String` The name of the column which contains the prompt template version **llmConfig** `FileImportLlmConfigInputType` The columns which contain the llm config fields, such as the llm name and params. Relevant if the model is generative\_llm **FileImportLlmConfigInputType fields** **llmName** `String` The name of the column which contains the llm name **llmParams** `String` The name of the column which contains a map of llm params to values **runMetadata** `FileImportRunMetadataInputType` The columns which contain the metadata relevant to the llm call that was used to generate the response using the prompt. Relevant if the model is generative\_llm **FileImportRunMetadataInputType fields** **totalTokenCount** `String` The name of the column which contains the total number of tokens used in the llm call **promptTokenCount** `String` The name of the column which contains the number of prompt tokens in the llm call **responseTokenCount** `String` The name of the column which contains the number of response tokens in the llm call **responseLatencyMs** `String` The name of the column which contains the response latency in ms of the llm call **predictionObjectDetectionLabel** `FileImportObjectDetectionLabelInputType` The columns which contain the object detection prediction fields, such as the bounding box coordinates, categories, and scores. Relevant if the model is object\_detection **FileImportObjectDetectionLabelInputType fields** **boundingBoxesCoordinatesColumnName** `String!` *required* The name of the column which contains the bounding box coordinates **boundingBoxesCategoriesColumnName** `String!` *required* The name of the column which contains a map of bounding box categories **boundingBoxesScoresColumnName** `String` The name of the column which contains a map of bounding box scores **actualObjectDetectionLabel** `FileImportObjectDetectionLabelInputType` The columns which contain the object detection actual fields, such as the bounding box coordinates, categories, and scores. Relevant if the model is object\_detection **FileImportObjectDetectionLabelInputType fields** **boundingBoxesCoordinatesColumnName** `String!` *required* The name of the column which contains the bounding box coordinates **boundingBoxesCategoriesColumnName** `String!` *required* The name of the column which contains a map of bounding box categories **boundingBoxesScoresColumnName** `String` The name of the column which contains a map of bounding box scores **clientMutationId** `String` #### Returns **fileImportJob** `FileImportJob!` The updated import job **FileImportJob fields** Scalar fields: `id`, `jobId`, `bucketName`, `createdAt`, `modelName`, `modelId`, `jobUuid`, `modelType`, `modelVersion`, `modelEnvironmentName`, `batchId`, `blobStore`, `prefix`, `totalFilesSuccessCount`, `totalFilesFailedCount`, `totalFilesPendingCount`, `jobStatus`. Object fields (select subfields): `schema`, `files`. **space** `Space!` **Space fields** Scalar fields: `id`, `name`, `description`, `uuid`, `createdAt`, `liveEnabled`, `isLLMOnlySpace`, `playgroundTracingModelId`, `evalTracingModelId`, `sandboxTracingModelId`, `mlModelsEnabled`, `private`, `gradientStartColor`, `gradientEndColor`, `hasDashboardsCreated`. Object fields (select subfields): `organization`, `models`, `monitors`, `dashboards`, `spaceUsers`, `byobConnectors`, `importJobs`, `tableJobs`, `sandboxJobs`, `signalInsightSummary`, `signalEnabledProjectSummary`, `signalIssues`, `agentIssues`, `automations`, `datasets`, `experiments`, `customMetrics`, `onlineTasks`, `prompts`, `tags`, `evaluators`, `annotationQueues`, `playgroundViews`, `annotationConfigs`, `traceFilters`, `llmIntegrations`, `defaultLlmIntegration`, `defaultAgentRuntime`, `gates`, `_access`. #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation UpdateFileImportJob($input: UpdateFileImportJobInput!) { updateFileImportJob(input: $input) { fileImportJob { id } space { id name } } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "jobId": "", "schema": {} } } ``` ### startFileImportJob Start an existing job that has been imported from a blob store `startFileImportJob(input: StartFileImportJobInput!): StartFileImportJobPayload` #### Arguments **input** `StartFileImportJobInput!` *required* **StartFileImportJobInput fields** **jobId** `ID!` *required* The ID of an import job to start **clientMutationId** `String` #### Returns **fileImportJob** `FileImportJob!` The import job which has been started **FileImportJob fields** Scalar fields: `id`, `jobId`, `bucketName`, `createdAt`, `modelName`, `modelId`, `jobUuid`, `modelType`, `modelVersion`, `modelEnvironmentName`, `batchId`, `blobStore`, `prefix`, `totalFilesSuccessCount`, `totalFilesFailedCount`, `totalFilesPendingCount`, `jobStatus`. Object fields (select subfields): `schema`, `files`. **space** `Space!` **Space fields** Scalar fields: `id`, `name`, `description`, `uuid`, `createdAt`, `liveEnabled`, `isLLMOnlySpace`, `playgroundTracingModelId`, `evalTracingModelId`, `sandboxTracingModelId`, `mlModelsEnabled`, `private`, `gradientStartColor`, `gradientEndColor`, `hasDashboardsCreated`. Object fields (select subfields): `organization`, `models`, `monitors`, `dashboards`, `spaceUsers`, `byobConnectors`, `importJobs`, `tableJobs`, `sandboxJobs`, `signalInsightSummary`, `signalEnabledProjectSummary`, `signalIssues`, `agentIssues`, `automations`, `datasets`, `experiments`, `customMetrics`, `onlineTasks`, `prompts`, `tags`, `evaluators`, `annotationQueues`, `playgroundViews`, `annotationConfigs`, `traceFilters`, `llmIntegrations`, `defaultLlmIntegration`, `defaultAgentRuntime`, `gates`, `_access`. #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation StartFileImportJob($input: StartFileImportJobInput!) { startFileImportJob(input: $input) { fileImportJob { id } space { id name } } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "jobId": "" } } ``` ### pauseFileImportJob Pause an existing job that has been imported from a blob store `pauseFileImportJob(input: PauseFileImportJobInput!): PauseFileImportJobPayload` #### Arguments **input** `PauseFileImportJobInput!` *required* **PauseFileImportJobInput fields** **jobId** `ID!` *required* The ID of an import job to pause **clientMutationId** `String` #### Returns **fileImportJob** `FileImportJob!` The paused import job **FileImportJob fields** Scalar fields: `id`, `jobId`, `bucketName`, `createdAt`, `modelName`, `modelId`, `jobUuid`, `modelType`, `modelVersion`, `modelEnvironmentName`, `batchId`, `blobStore`, `prefix`, `totalFilesSuccessCount`, `totalFilesFailedCount`, `totalFilesPendingCount`, `jobStatus`. Object fields (select subfields): `schema`, `files`. **space** `Space!` **Space fields** Scalar fields: `id`, `name`, `description`, `uuid`, `createdAt`, `liveEnabled`, `isLLMOnlySpace`, `playgroundTracingModelId`, `evalTracingModelId`, `sandboxTracingModelId`, `mlModelsEnabled`, `private`, `gradientStartColor`, `gradientEndColor`, `hasDashboardsCreated`. Object fields (select subfields): `organization`, `models`, `monitors`, `dashboards`, `spaceUsers`, `byobConnectors`, `importJobs`, `tableJobs`, `sandboxJobs`, `signalInsightSummary`, `signalEnabledProjectSummary`, `signalIssues`, `agentIssues`, `automations`, `datasets`, `experiments`, `customMetrics`, `onlineTasks`, `prompts`, `tags`, `evaluators`, `annotationQueues`, `playgroundViews`, `annotationConfigs`, `traceFilters`, `llmIntegrations`, `defaultLlmIntegration`, `defaultAgentRuntime`, `gates`, `_access`. #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation PauseFileImportJob($input: PauseFileImportJobInput!) { pauseFileImportJob(input: $input) { fileImportJob { id } space { id name } } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "jobId": "" } } ``` ### deleteFileImportJob Delete an existing job that has been imported from a blob store `deleteFileImportJob(input: DeleteFileImportJobInput!): DeleteFileImportJobPayload` #### Arguments **input** `DeleteFileImportJobInput!` *required* **DeleteFileImportJobInput fields** **jobId** `ID!` *required* The ID of an import job to delete **clientMutationId** `String` #### Returns **fileImportJob** `FileImportJob!` The deleted import job **FileImportJob fields** Scalar fields: `id`, `jobId`, `bucketName`, `createdAt`, `modelName`, `modelId`, `jobUuid`, `modelType`, `modelVersion`, `modelEnvironmentName`, `batchId`, `blobStore`, `prefix`, `totalFilesSuccessCount`, `totalFilesFailedCount`, `totalFilesPendingCount`, `jobStatus`. Object fields (select subfields): `schema`, `files`. **space** `Space!` **Space fields** Scalar fields: `id`, `name`, `description`, `uuid`, `createdAt`, `liveEnabled`, `isLLMOnlySpace`, `playgroundTracingModelId`, `evalTracingModelId`, `sandboxTracingModelId`, `mlModelsEnabled`, `private`, `gradientStartColor`, `gradientEndColor`, `hasDashboardsCreated`. Object fields (select subfields): `organization`, `models`, `monitors`, `dashboards`, `spaceUsers`, `byobConnectors`, `importJobs`, `tableJobs`, `sandboxJobs`, `signalInsightSummary`, `signalEnabledProjectSummary`, `signalIssues`, `agentIssues`, `automations`, `datasets`, `experiments`, `customMetrics`, `onlineTasks`, `prompts`, `tags`, `evaluators`, `annotationQueues`, `playgroundViews`, `annotationConfigs`, `traceFilters`, `llmIntegrations`, `defaultLlmIntegration`, `defaultAgentRuntime`, `gates`, `_access`. #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation DeleteFileImportJob($input: DeleteFileImportJobInput!) { deleteFileImportJob(input: $input) { fileImportJob { id } space { id name } } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "jobId": "" } } ``` ### resetFileStatus Reset the status of a file `resetFileStatus(input: ResetFileStatusInput!): ResetFileStatusPayload` #### Arguments **input** `ResetFileStatusInput!` *required* **ResetFileStatusInput fields** **jobId** `ID!` *required* The id of the job to reset the status of **fileId** `ID!` *required* The id of the file to reset the status of **clientMutationId** `String` #### Returns **job** `FileImportJob!` The updated import job **FileImportJob fields** Scalar fields: `id`, `jobId`, `bucketName`, `createdAt`, `modelName`, `modelId`, `jobUuid`, `modelType`, `modelVersion`, `modelEnvironmentName`, `batchId`, `blobStore`, `prefix`, `totalFilesSuccessCount`, `totalFilesFailedCount`, `totalFilesPendingCount`, `jobStatus`. Object fields (select subfields): `schema`, `files`. #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation ResetFileStatus($input: ResetFileStatusInput!) { resetFileStatus(input: $input) { job { id } } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "jobId": "", "fileId": "" } } ``` ### createTableImportJob Create a job that will import model inferences from a table `createTableImportJob(input: CreateTableImportJobInput!): CreateTableImportJobPayload` #### Arguments **input** `CreateTableImportJobInput!` *required* **CreateTableImportJobInput fields** **spaceId** `ID!` *required* The space id for the space under which the model should be ingested **modelName** `String!` *required* The model identifier or name under which the model will be stored. **modelType** `ModelType!` *required* The type of model. This determines how the model will be analyzed One of: `numeric`, `score_categorical`, `ranking`, `object_detection`, `generative_llm`, `multi_class`. **modelEnvironmentName** `ModelEnvironmentName!` *required* The environment for which the inferences are being ingested One of: `production`, `validation`, `training`, `tracing`. **batchId** `String` A name for the ingestion batch. Only required if the environment is validation **modelVersion** `String` The model version. This will tag all the inferences as being for a specific version string. **tableStore** `TableIntegrationType!` *required* The table solution where the inferences reside One of: `BigQuery`, `Snowflake`, `Databricks`. **bigQueryTableConfig** `BigQueryTableConfig` **BigQueryTableConfig fields** **projectId** `String!` *required* The unique string used to differentiate a Google Cloud project **dataset** `String!` *required* The dataset where the tables are stored. Arize must have access to this dataset **tableName** `String!` *required* The path to the table **snowflakeTableConfig** `SnowflakeTableConfig` **SnowflakeTableConfig fields** **accountID** `String!` *required* The account identifier assigned to the Snowflake account. **schema** `String!` *required* The schema which the target Table belongs to. Together, a database and schema comprise a namespace in Snowflake. **database** `String!` *required* The database which the schema of the target Table belongs to. **tableName** `String!` *required* The table which to import data from. **databricksTableConfig** `DatabricksTableConfig` **DatabricksTableConfig fields** **hostname** `String!` *required* The base URL of the workspace ex. databricks-hostname-example.databricks.com **endpoint** `String!` *required* The URL fragment that corresponds to the resource, either a Compute Cluster or SQL Warehouse ex. /sql/1.0/warehouses/example **port** `String!` *required* The port of the resource ex. 443 **token** `String` Personal access token (for a service principal) ex. dapi12392103129093021. Required if 'azureResourceId' is needed & not provided. **azureResourceId** `String` The Azure Resource Manager ID for the Azure Databricks workspace. Required only if not doing token-based authentication. **catalog** `String!` *required* If using Unity Catalog, this is the catalog name. If not, this will be hive\_metastore **databricksSchema** `String!` *required* A logical collection of tables **tableName** `String!` *required* The name of the table or view **schema** `TableImportSchemaInputType!` *required* The schema for the CSV or Parquet files. The schema describes a mapping from your column names to model dimensions **TableImportSchemaInputType fields** **predictionId** `String!` *required* The name of the predictionId column in the file **predictionGroupId** `String` The name of the predictionGroupId column in the file. Required if the model is type ranking **features** `String` A prefix capture group used to match feature columns **featuresList** `[String!]` A list of column names specifying features **timestamp** `String` The name of the timestamp column in the file **predictionLabel** `String` The name of the prediction label column in the file. Supported on model of type score\_categorical **predictionScore** `String` The name of the prediction score column in the file. Supported on models of type numeric and score\_categorical **predictionScores** `String` The name of the prediction scores column in the file. Supported on multi\_class models **actualLabel** `String` The name of the actual label column in the file. Supported on model of type score\_categorical **actualScore** `String` The name of the actual score column in the file. Supported on models of type numeric and score\_categorical **actualScores** `String` The name of the actual scores column in the file. Supported on multi\_class models **thresholdScores** `String` The name of the threshold scores column in the file. Supported on multi\_class models **relevanceLabel** `String` The name of the relevance label column in the file. Required if the model is type ranking **relevanceScore** `String` The name of the relevance score column in the file. Required if the model is type ranking **version** `String` The name of the model version column in the file **batchId** `String` The name of the validation batch id. Required if the model is type validation **tags** `String` A prefix capture group used to match tag column **tagsList** `[String!]` A list of column names specifying tags **shapValues** `String` A regex like capture group that should be used to match shap column **rank** `String` The name of the rank column in the file. Required if the model is type ranking **exclude** `[String!]` The names of fields to be excluded from data ingestion **embeddingFeatures** `[FileImportEmbeddingInputType!]` The embedding fields that will be ingested **FileImportEmbeddingInputType fields** **featureName** `String!` *required* The embedding feature name **vectorCol** `String!` *required* The name of the vector column **rawDataCol** `String` The name of the raw data column **linkToDataCol** `String` The name of the link to data column **prompt** `FileImportPromptResponseInputType` The columns which contain the prompt used in a generative LLM. Relevant if the model is generative\_llm **FileImportPromptResponseInputType fields** **vectorCol** `String` The name of the vector column **rawDataCol** `String!` *required* The name of the raw data column. Required if the prompt or response is specified **response** `FileImportPromptResponseInputType` The columns which contain the response from a generative LLM. Relevant if the model is generative\_llm **FileImportPromptResponseInputType fields** **vectorCol** `String` The name of the vector column **rawDataCol** `String!` *required* The name of the raw data column. Required if the prompt or response is specified **promptTemplate** `FileImportPromptTemplateInputType` The columns which contain the prompt template fields, such as the template and template version. Relevant if the model is generative\_llm **FileImportPromptTemplateInputType fields** **template** `String` The name of the column which contains the prompt template **templateVersion** `String` The name of the column which contains the prompt template version **llmConfig** `FileImportLlmConfigInputType` The columns which contain the llm config fields, such as the llm name and params. Relevant if the model is generative\_llm **FileImportLlmConfigInputType fields** **llmName** `String` The name of the column which contains the llm name **llmParams** `String` The name of the column which contains a map of llm params to values **runMetadata** `FileImportRunMetadataInputType` The columns which contain the metadata relevant to the llm call that was used to generate the response using the prompt. Relevant if the model is generative\_llm **FileImportRunMetadataInputType fields** **totalTokenCount** `String` The name of the column which contains the total number of tokens used in the llm call **promptTokenCount** `String` The name of the column which contains the number of prompt tokens in the llm call **responseTokenCount** `String` The name of the column which contains the number of response tokens in the llm call **responseLatencyMs** `String` The name of the column which contains the response latency in ms of the llm call **predictionObjectDetectionLabel** `FileImportObjectDetectionLabelInputType` The columns which contain the object detection prediction fields, such as the bounding box coordinates, categories, and scores. Relevant if the model is object\_detection **FileImportObjectDetectionLabelInputType fields** **boundingBoxesCoordinatesColumnName** `String!` *required* The name of the column which contains the bounding box coordinates **boundingBoxesCategoriesColumnName** `String!` *required* The name of the column which contains a map of bounding box categories **boundingBoxesScoresColumnName** `String` The name of the column which contains a map of bounding box scores **actualObjectDetectionLabel** `FileImportObjectDetectionLabelInputType` The columns which contain the object detection actual fields, such as the bounding box coordinates, categories, and scores. Relevant if the model is object\_detection **FileImportObjectDetectionLabelInputType fields** **boundingBoxesCoordinatesColumnName** `String!` *required* The name of the column which contains the bounding box coordinates **boundingBoxesCategoriesColumnName** `String!` *required* The name of the column which contains a map of bounding box categories **boundingBoxesScoresColumnName** `String` The name of the column which contains a map of bounding box scores **changeTimestamp** `String` The name of the change timestamp column in the file. **dryRun** `Boolean` If true, the import job will be attempted but no changes will be written. The fileResult field may be requested to check the validation status. Default is false **clientMutationId** `String` #### Returns **space** `Space` **Space fields** Scalar fields: `id`, `name`, `description`, `uuid`, `createdAt`, `liveEnabled`, `isLLMOnlySpace`, `playgroundTracingModelId`, `evalTracingModelId`, `sandboxTracingModelId`, `mlModelsEnabled`, `private`, `gradientStartColor`, `gradientEndColor`, `hasDashboardsCreated`. Object fields (select subfields): `organization`, `models`, `monitors`, `dashboards`, `spaceUsers`, `byobConnectors`, `importJobs`, `tableJobs`, `sandboxJobs`, `signalInsightSummary`, `signalEnabledProjectSummary`, `signalIssues`, `agentIssues`, `automations`, `datasets`, `experiments`, `customMetrics`, `onlineTasks`, `prompts`, `tags`, `evaluators`, `annotationQueues`, `playgroundViews`, `annotationConfigs`, `traceFilters`, `llmIntegrations`, `defaultLlmIntegration`, `defaultAgentRuntime`, `gates`, `_access`. **validationResult** `TableJobValidationResult` **TableJobValidationResult fields** Scalar fields: `jobId`, `tableQueryId`, `queryId`, `validationStatus`. Object fields (select subfields): `error`. **tableImportJob** `TableImportJob` **TableImportJob fields** Scalar fields: `id`, `jobId`, `jobStatus`, `tableStore`, `projectId`, `dataset`, `createdAt`, `modelName`, `modelId`, `modelType`, `modelVersion`, `modelEnvironmentName`, `batchId`, `table`, `totalQueriesSuccessCount`, `totalQueriesFailedCount`, `totalQueriesPendingCount`. Object fields (select subfields): `schema`, `tableIngestionParameters`, `queries`. #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation CreateTableImportJob($input: CreateTableImportJobInput!) { createTableImportJob(input: $input) { space { id name } validationResult { jobId } tableImportJob { id } } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "spaceId": "", "modelName": "", "modelType": "numeric", "modelEnvironmentName": "production", "tableStore": "BigQuery", "schema": { "predictionId": "" } } } ``` ### updateTableImportJob Update an existing job that has been imported from a table `updateTableImportJob(input: UpdateTableImportJobInput!): UpdateTableImportJobPayload` #### Arguments **input** `UpdateTableImportJobInput!` *required* **UpdateTableImportJobInput fields** **jobId** `ID!` *required* The ID of an import job to delete **jobStatus** `JobStatus` The status of the imported job One of: `ONGOING_INACTIVE`, `ONGOING_DELETED`. **modelVersion** `String` The model version set as a constant **schema** `TableImportSchemaInputType!` *required* The schema describes a mapping from your column names to model dimensions **TableImportSchemaInputType fields** **predictionId** `String!` *required* The name of the predictionId column in the file **predictionGroupId** `String` The name of the predictionGroupId column in the file. Required if the model is type ranking **features** `String` A prefix capture group used to match feature columns **featuresList** `[String!]` A list of column names specifying features **timestamp** `String` The name of the timestamp column in the file **predictionLabel** `String` The name of the prediction label column in the file. Supported on model of type score\_categorical **predictionScore** `String` The name of the prediction score column in the file. Supported on models of type numeric and score\_categorical **predictionScores** `String` The name of the prediction scores column in the file. Supported on multi\_class models **actualLabel** `String` The name of the actual label column in the file. Supported on model of type score\_categorical **actualScore** `String` The name of the actual score column in the file. Supported on models of type numeric and score\_categorical **actualScores** `String` The name of the actual scores column in the file. Supported on multi\_class models **thresholdScores** `String` The name of the threshold scores column in the file. Supported on multi\_class models **relevanceLabel** `String` The name of the relevance label column in the file. Required if the model is type ranking **relevanceScore** `String` The name of the relevance score column in the file. Required if the model is type ranking **version** `String` The name of the model version column in the file **batchId** `String` The name of the validation batch id. Required if the model is type validation **tags** `String` A prefix capture group used to match tag column **tagsList** `[String!]` A list of column names specifying tags **shapValues** `String` A regex like capture group that should be used to match shap column **rank** `String` The name of the rank column in the file. Required if the model is type ranking **exclude** `[String!]` The names of fields to be excluded from data ingestion **embeddingFeatures** `[FileImportEmbeddingInputType!]` The embedding fields that will be ingested **FileImportEmbeddingInputType fields** **featureName** `String!` *required* The embedding feature name **vectorCol** `String!` *required* The name of the vector column **rawDataCol** `String` The name of the raw data column **linkToDataCol** `String` The name of the link to data column **prompt** `FileImportPromptResponseInputType` The columns which contain the prompt used in a generative LLM. Relevant if the model is generative\_llm **FileImportPromptResponseInputType fields** **vectorCol** `String` The name of the vector column **rawDataCol** `String!` *required* The name of the raw data column. Required if the prompt or response is specified **response** `FileImportPromptResponseInputType` The columns which contain the response from a generative LLM. Relevant if the model is generative\_llm **FileImportPromptResponseInputType fields** **vectorCol** `String` The name of the vector column **rawDataCol** `String!` *required* The name of the raw data column. Required if the prompt or response is specified **promptTemplate** `FileImportPromptTemplateInputType` The columns which contain the prompt template fields, such as the template and template version. Relevant if the model is generative\_llm **FileImportPromptTemplateInputType fields** **template** `String` The name of the column which contains the prompt template **templateVersion** `String` The name of the column which contains the prompt template version **llmConfig** `FileImportLlmConfigInputType` The columns which contain the llm config fields, such as the llm name and params. Relevant if the model is generative\_llm **FileImportLlmConfigInputType fields** **llmName** `String` The name of the column which contains the llm name **llmParams** `String` The name of the column which contains a map of llm params to values **runMetadata** `FileImportRunMetadataInputType` The columns which contain the metadata relevant to the llm call that was used to generate the response using the prompt. Relevant if the model is generative\_llm **FileImportRunMetadataInputType fields** **totalTokenCount** `String` The name of the column which contains the total number of tokens used in the llm call **promptTokenCount** `String` The name of the column which contains the number of prompt tokens in the llm call **responseTokenCount** `String` The name of the column which contains the number of response tokens in the llm call **responseLatencyMs** `String` The name of the column which contains the response latency in ms of the llm call **predictionObjectDetectionLabel** `FileImportObjectDetectionLabelInputType` The columns which contain the object detection prediction fields, such as the bounding box coordinates, categories, and scores. Relevant if the model is object\_detection **FileImportObjectDetectionLabelInputType fields** **boundingBoxesCoordinatesColumnName** `String!` *required* The name of the column which contains the bounding box coordinates **boundingBoxesCategoriesColumnName** `String!` *required* The name of the column which contains a map of bounding box categories **boundingBoxesScoresColumnName** `String` The name of the column which contains a map of bounding box scores **actualObjectDetectionLabel** `FileImportObjectDetectionLabelInputType` The columns which contain the object detection actual fields, such as the bounding box coordinates, categories, and scores. Relevant if the model is object\_detection **FileImportObjectDetectionLabelInputType fields** **boundingBoxesCoordinatesColumnName** `String!` *required* The name of the column which contains the bounding box coordinates **boundingBoxesCategoriesColumnName** `String!` *required* The name of the column which contains a map of bounding box categories **boundingBoxesScoresColumnName** `String` The name of the column which contains a map of bounding box scores **changeTimestamp** `String` The name of the change timestamp column in the file. **tableIngestionParameters** `TableIngestionParametersInputType!` *required* Table ingestion parameters **TableIngestionParametersInputType fields** **refreshIntervalMinutes** `Int` How often a user wants to query data in minutes **queryWindowSizeHours** `Int` How large of a query window to use in hours **clientMutationId** `String` #### Returns **tableImportJob** `TableImportJob!` The updated table import job **TableImportJob fields** Scalar fields: `id`, `jobId`, `jobStatus`, `tableStore`, `projectId`, `dataset`, `createdAt`, `modelName`, `modelId`, `modelType`, `modelVersion`, `modelEnvironmentName`, `batchId`, `table`, `totalQueriesSuccessCount`, `totalQueriesFailedCount`, `totalQueriesPendingCount`. Object fields (select subfields): `schema`, `tableIngestionParameters`, `queries`. **space** `Space!` **Space fields** Scalar fields: `id`, `name`, `description`, `uuid`, `createdAt`, `liveEnabled`, `isLLMOnlySpace`, `playgroundTracingModelId`, `evalTracingModelId`, `sandboxTracingModelId`, `mlModelsEnabled`, `private`, `gradientStartColor`, `gradientEndColor`, `hasDashboardsCreated`. Object fields (select subfields): `organization`, `models`, `monitors`, `dashboards`, `spaceUsers`, `byobConnectors`, `importJobs`, `tableJobs`, `sandboxJobs`, `signalInsightSummary`, `signalEnabledProjectSummary`, `signalIssues`, `agentIssues`, `automations`, `datasets`, `experiments`, `customMetrics`, `onlineTasks`, `prompts`, `tags`, `evaluators`, `annotationQueues`, `playgroundViews`, `annotationConfigs`, `traceFilters`, `llmIntegrations`, `defaultLlmIntegration`, `defaultAgentRuntime`, `gates`, `_access`. #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation UpdateTableImportJob($input: UpdateTableImportJobInput!) { updateTableImportJob(input: $input) { tableImportJob { id } space { id name } } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "jobId": "", "schema": { "predictionId": "" }, "tableIngestionParameters": {} } } ``` ### updateTableIngestionParameters Update an existing job that has been imported from a table `updateTableIngestionParameters(input: UpdateTableIngestionParametersInput!): UpdateTableIngestionParametersPayload` #### Arguments **input** `UpdateTableIngestionParametersInput!` *required* **UpdateTableIngestionParametersInput fields** **jobId** `ID!` *required* The import job id **tableIngestionParameters** `TableIngestionParametersInputType!` *required* Table ingestion parameters **TableIngestionParametersInputType fields** **refreshIntervalMinutes** `Int` How often a user wants to query data in minutes **queryWindowSizeHours** `Int` How large of a query window to use in hours **clientMutationId** `String` #### Returns **tableImportJob** `TableImportJob!` The updated table import job **TableImportJob fields** Scalar fields: `id`, `jobId`, `jobStatus`, `tableStore`, `projectId`, `dataset`, `createdAt`, `modelName`, `modelId`, `modelType`, `modelVersion`, `modelEnvironmentName`, `batchId`, `table`, `totalQueriesSuccessCount`, `totalQueriesFailedCount`, `totalQueriesPendingCount`. Object fields (select subfields): `schema`, `tableIngestionParameters`, `queries`. **space** `Space!` **Space fields** Scalar fields: `id`, `name`, `description`, `uuid`, `createdAt`, `liveEnabled`, `isLLMOnlySpace`, `playgroundTracingModelId`, `evalTracingModelId`, `sandboxTracingModelId`, `mlModelsEnabled`, `private`, `gradientStartColor`, `gradientEndColor`, `hasDashboardsCreated`. Object fields (select subfields): `organization`, `models`, `monitors`, `dashboards`, `spaceUsers`, `byobConnectors`, `importJobs`, `tableJobs`, `sandboxJobs`, `signalInsightSummary`, `signalEnabledProjectSummary`, `signalIssues`, `agentIssues`, `automations`, `datasets`, `experiments`, `customMetrics`, `onlineTasks`, `prompts`, `tags`, `evaluators`, `annotationQueues`, `playgroundViews`, `annotationConfigs`, `traceFilters`, `llmIntegrations`, `defaultLlmIntegration`, `defaultAgentRuntime`, `gates`, `_access`. #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation UpdateTableIngestionParameters($input: UpdateTableIngestionParametersInput!) { updateTableIngestionParameters(input: $input) { tableImportJob { id } space { id name } } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "jobId": "", "tableIngestionParameters": {} } } ``` ### startTableImportJob Start an existing job that has been imported from a table `startTableImportJob(input: StartTableImportJobInput!): StartTableImportJobPayload` #### Arguments **input** `StartTableImportJobInput!` *required* **StartTableImportJobInput fields** **jobId** `ID!` *required* The ID of an import job to start **clientMutationId** `String` #### Returns **tableImportJob** `FileImportJob!` The import job which has been started **FileImportJob fields** Scalar fields: `id`, `jobId`, `bucketName`, `createdAt`, `modelName`, `modelId`, `jobUuid`, `modelType`, `modelVersion`, `modelEnvironmentName`, `batchId`, `blobStore`, `prefix`, `totalFilesSuccessCount`, `totalFilesFailedCount`, `totalFilesPendingCount`, `jobStatus`. Object fields (select subfields): `schema`, `files`. **space** `Space!` **Space fields** Scalar fields: `id`, `name`, `description`, `uuid`, `createdAt`, `liveEnabled`, `isLLMOnlySpace`, `playgroundTracingModelId`, `evalTracingModelId`, `sandboxTracingModelId`, `mlModelsEnabled`, `private`, `gradientStartColor`, `gradientEndColor`, `hasDashboardsCreated`. Object fields (select subfields): `organization`, `models`, `monitors`, `dashboards`, `spaceUsers`, `byobConnectors`, `importJobs`, `tableJobs`, `sandboxJobs`, `signalInsightSummary`, `signalEnabledProjectSummary`, `signalIssues`, `agentIssues`, `automations`, `datasets`, `experiments`, `customMetrics`, `onlineTasks`, `prompts`, `tags`, `evaluators`, `annotationQueues`, `playgroundViews`, `annotationConfigs`, `traceFilters`, `llmIntegrations`, `defaultLlmIntegration`, `defaultAgentRuntime`, `gates`, `_access`. #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation StartTableImportJob($input: StartTableImportJobInput!) { startTableImportJob(input: $input) { tableImportJob { id } space { id name } } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "jobId": "" } } ``` ### pauseTableImportJob Pause an existing job that has been imported from a table `pauseTableImportJob(input: PauseTableImportJobInput!): PauseTableImportJobPayload` #### Arguments **input** `PauseTableImportJobInput!` *required* **PauseTableImportJobInput fields** **jobId** `ID!` *required* The ID of an import job to pause **clientMutationId** `String` #### Returns **tableImportJob** `TableImportJob!` The paused import job **TableImportJob fields** Scalar fields: `id`, `jobId`, `jobStatus`, `tableStore`, `projectId`, `dataset`, `createdAt`, `modelName`, `modelId`, `modelType`, `modelVersion`, `modelEnvironmentName`, `batchId`, `table`, `totalQueriesSuccessCount`, `totalQueriesFailedCount`, `totalQueriesPendingCount`. Object fields (select subfields): `schema`, `tableIngestionParameters`, `queries`. **space** `Space!` **Space fields** Scalar fields: `id`, `name`, `description`, `uuid`, `createdAt`, `liveEnabled`, `isLLMOnlySpace`, `playgroundTracingModelId`, `evalTracingModelId`, `sandboxTracingModelId`, `mlModelsEnabled`, `private`, `gradientStartColor`, `gradientEndColor`, `hasDashboardsCreated`. Object fields (select subfields): `organization`, `models`, `monitors`, `dashboards`, `spaceUsers`, `byobConnectors`, `importJobs`, `tableJobs`, `sandboxJobs`, `signalInsightSummary`, `signalEnabledProjectSummary`, `signalIssues`, `agentIssues`, `automations`, `datasets`, `experiments`, `customMetrics`, `onlineTasks`, `prompts`, `tags`, `evaluators`, `annotationQueues`, `playgroundViews`, `annotationConfigs`, `traceFilters`, `llmIntegrations`, `defaultLlmIntegration`, `defaultAgentRuntime`, `gates`, `_access`. #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation PauseTableImportJob($input: PauseTableImportJobInput!) { pauseTableImportJob(input: $input) { tableImportJob { id } space { id name } } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "jobId": "" } } ``` ### deleteTableImportJob Delete an existing job that has been imported from a table `deleteTableImportJob(input: DeleteTableImportJobInput!): DeleteTableImportJobPayload` #### Arguments **input** `DeleteTableImportJobInput!` *required* **DeleteTableImportJobInput fields** **jobId** `ID!` *required* The ID of a table import job to delete **clientMutationId** `String` #### Returns **tableImportJob** `TableImportJob!` The deleted table import job **TableImportJob fields** Scalar fields: `id`, `jobId`, `jobStatus`, `tableStore`, `projectId`, `dataset`, `createdAt`, `modelName`, `modelId`, `modelType`, `modelVersion`, `modelEnvironmentName`, `batchId`, `table`, `totalQueriesSuccessCount`, `totalQueriesFailedCount`, `totalQueriesPendingCount`. Object fields (select subfields): `schema`, `tableIngestionParameters`, `queries`. **space** `Space!` **Space fields** Scalar fields: `id`, `name`, `description`, `uuid`, `createdAt`, `liveEnabled`, `isLLMOnlySpace`, `playgroundTracingModelId`, `evalTracingModelId`, `sandboxTracingModelId`, `mlModelsEnabled`, `private`, `gradientStartColor`, `gradientEndColor`, `hasDashboardsCreated`. Object fields (select subfields): `organization`, `models`, `monitors`, `dashboards`, `spaceUsers`, `byobConnectors`, `importJobs`, `tableJobs`, `sandboxJobs`, `signalInsightSummary`, `signalEnabledProjectSummary`, `signalIssues`, `agentIssues`, `automations`, `datasets`, `experiments`, `customMetrics`, `onlineTasks`, `prompts`, `tags`, `evaluators`, `annotationQueues`, `playgroundViews`, `annotationConfigs`, `traceFilters`, `llmIntegrations`, `defaultLlmIntegration`, `defaultAgentRuntime`, `gates`, `_access`. #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation DeleteTableImportJob($input: DeleteTableImportJobInput!) { deleteTableImportJob(input: $input) { tableImportJob { id } space { id name } } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "jobId": "" } } ``` ### createTriggeredOngoingTableImportJob Create a job that will import model inferences from a table `createTriggeredOngoingTableImportJob(input: CreateTriggeredOngoingTableImportJobInput!): CreateTriggeredOngoingTableImportJobPayload` #### Arguments **input** `CreateTriggeredOngoingTableImportJobInput!` *required* **CreateTriggeredOngoingTableImportJobInput fields** **spaceId** `ID!` *required* The space id for the space under which the model should be ingested **modelName** `String!` *required* The model identifier or name under which the model will be stored. **modelType** `ModelType!` *required* The type of model. This determines how the model will be analyzed One of: `numeric`, `score_categorical`, `ranking`, `object_detection`, `generative_llm`, `multi_class`. **modelEnvironmentName** `ModelEnvironmentName!` *required* The environment for which the inferences are being ingested One of: `production`, `validation`, `training`, `tracing`. **batchId** `String` A name for the ingestion batch. Only required if the environment is validation **modelVersion** `String` The model version. This will tag all the inferences as being for a specific version string. **tableStore** `TableIntegrationType!` *required* The table solution where the inferences reside One of: `BigQuery`, `Snowflake`, `Databricks`. **bigQueryTableConfig** `BigQueryTableConfig` **BigQueryTableConfig fields** **projectId** `String!` *required* The unique string used to differentiate a Google Cloud project **dataset** `String!` *required* The dataset where the tables are stored. Arize must have access to this dataset **tableName** `String!` *required* The path to the table **snowflakeTableConfig** `SnowflakeTableConfig` **SnowflakeTableConfig fields** **accountID** `String!` *required* The account identifier assigned to the Snowflake account. **schema** `String!` *required* The schema which the target Table belongs to. Together, a database and schema comprise a namespace in Snowflake. **database** `String!` *required* The database which the schema of the target Table belongs to. **tableName** `String!` *required* The table which to import data from. **databricksTableConfig** `DatabricksTableConfig` **DatabricksTableConfig fields** **hostname** `String!` *required* The base URL of the workspace ex. databricks-hostname-example.databricks.com **endpoint** `String!` *required* The URL fragment that corresponds to the resource, either a Compute Cluster or SQL Warehouse ex. /sql/1.0/warehouses/example **port** `String!` *required* The port of the resource ex. 443 **token** `String` Personal access token (for a service principal) ex. dapi12392103129093021. Required if 'azureResourceId' is needed & not provided. **azureResourceId** `String` The Azure Resource Manager ID for the Azure Databricks workspace. Required only if not doing token-based authentication. **catalog** `String!` *required* If using Unity Catalog, this is the catalog name. If not, this will be hive\_metastore **databricksSchema** `String!` *required* A logical collection of tables **tableName** `String!` *required* The name of the table or view **schema** `TableImportSchemaInputType!` *required* The schema for the CSV or Parquet files. The schema describes a mapping from your column names to model dimensions **TableImportSchemaInputType fields** **predictionId** `String!` *required* The name of the predictionId column in the file **predictionGroupId** `String` The name of the predictionGroupId column in the file. Required if the model is type ranking **features** `String` A prefix capture group used to match feature columns **featuresList** `[String!]` A list of column names specifying features **timestamp** `String` The name of the timestamp column in the file **predictionLabel** `String` The name of the prediction label column in the file. Supported on model of type score\_categorical **predictionScore** `String` The name of the prediction score column in the file. Supported on models of type numeric and score\_categorical **predictionScores** `String` The name of the prediction scores column in the file. Supported on multi\_class models **actualLabel** `String` The name of the actual label column in the file. Supported on model of type score\_categorical **actualScore** `String` The name of the actual score column in the file. Supported on models of type numeric and score\_categorical **actualScores** `String` The name of the actual scores column in the file. Supported on multi\_class models **thresholdScores** `String` The name of the threshold scores column in the file. Supported on multi\_class models **relevanceLabel** `String` The name of the relevance label column in the file. Required if the model is type ranking **relevanceScore** `String` The name of the relevance score column in the file. Required if the model is type ranking **version** `String` The name of the model version column in the file **batchId** `String` The name of the validation batch id. Required if the model is type validation **tags** `String` A prefix capture group used to match tag column **tagsList** `[String!]` A list of column names specifying tags **shapValues** `String` A regex like capture group that should be used to match shap column **rank** `String` The name of the rank column in the file. Required if the model is type ranking **exclude** `[String!]` The names of fields to be excluded from data ingestion **embeddingFeatures** `[FileImportEmbeddingInputType!]` The embedding fields that will be ingested **FileImportEmbeddingInputType fields** **featureName** `String!` *required* The embedding feature name **vectorCol** `String!` *required* The name of the vector column **rawDataCol** `String` The name of the raw data column **linkToDataCol** `String` The name of the link to data column **prompt** `FileImportPromptResponseInputType` The columns which contain the prompt used in a generative LLM. Relevant if the model is generative\_llm **FileImportPromptResponseInputType fields** **vectorCol** `String` The name of the vector column **rawDataCol** `String!` *required* The name of the raw data column. Required if the prompt or response is specified **response** `FileImportPromptResponseInputType` The columns which contain the response from a generative LLM. Relevant if the model is generative\_llm **FileImportPromptResponseInputType fields** **vectorCol** `String` The name of the vector column **rawDataCol** `String!` *required* The name of the raw data column. Required if the prompt or response is specified **promptTemplate** `FileImportPromptTemplateInputType` The columns which contain the prompt template fields, such as the template and template version. Relevant if the model is generative\_llm **FileImportPromptTemplateInputType fields** **template** `String` The name of the column which contains the prompt template **templateVersion** `String` The name of the column which contains the prompt template version **llmConfig** `FileImportLlmConfigInputType` The columns which contain the llm config fields, such as the llm name and params. Relevant if the model is generative\_llm **FileImportLlmConfigInputType fields** **llmName** `String` The name of the column which contains the llm name **llmParams** `String` The name of the column which contains a map of llm params to values **runMetadata** `FileImportRunMetadataInputType` The columns which contain the metadata relevant to the llm call that was used to generate the response using the prompt. Relevant if the model is generative\_llm **FileImportRunMetadataInputType fields** **totalTokenCount** `String` The name of the column which contains the total number of tokens used in the llm call **promptTokenCount** `String` The name of the column which contains the number of prompt tokens in the llm call **responseTokenCount** `String` The name of the column which contains the number of response tokens in the llm call **responseLatencyMs** `String` The name of the column which contains the response latency in ms of the llm call **predictionObjectDetectionLabel** `FileImportObjectDetectionLabelInputType` The columns which contain the object detection prediction fields, such as the bounding box coordinates, categories, and scores. Relevant if the model is object\_detection **FileImportObjectDetectionLabelInputType fields** **boundingBoxesCoordinatesColumnName** `String!` *required* The name of the column which contains the bounding box coordinates **boundingBoxesCategoriesColumnName** `String!` *required* The name of the column which contains a map of bounding box categories **boundingBoxesScoresColumnName** `String` The name of the column which contains a map of bounding box scores **actualObjectDetectionLabel** `FileImportObjectDetectionLabelInputType` The columns which contain the object detection actual fields, such as the bounding box coordinates, categories, and scores. Relevant if the model is object\_detection **FileImportObjectDetectionLabelInputType fields** **boundingBoxesCoordinatesColumnName** `String!` *required* The name of the column which contains the bounding box coordinates **boundingBoxesCategoriesColumnName** `String!` *required* The name of the column which contains a map of bounding box categories **boundingBoxesScoresColumnName** `String` The name of the column which contains a map of bounding box scores **changeTimestamp** `String` The name of the change timestamp column in the file. **clientMutationId** `String` #### Returns **space** `Space` **Space fields** Scalar fields: `id`, `name`, `description`, `uuid`, `createdAt`, `liveEnabled`, `isLLMOnlySpace`, `playgroundTracingModelId`, `evalTracingModelId`, `sandboxTracingModelId`, `mlModelsEnabled`, `private`, `gradientStartColor`, `gradientEndColor`, `hasDashboardsCreated`. Object fields (select subfields): `organization`, `models`, `monitors`, `dashboards`, `spaceUsers`, `byobConnectors`, `importJobs`, `tableJobs`, `sandboxJobs`, `signalInsightSummary`, `signalEnabledProjectSummary`, `signalIssues`, `agentIssues`, `automations`, `datasets`, `experiments`, `customMetrics`, `onlineTasks`, `prompts`, `tags`, `evaluators`, `annotationQueues`, `playgroundViews`, `annotationConfigs`, `traceFilters`, `llmIntegrations`, `defaultLlmIntegration`, `defaultAgentRuntime`, `gates`, `_access`. **validationResult** `TableJobValidationResult` **TableJobValidationResult fields** Scalar fields: `jobId`, `tableQueryId`, `queryId`, `validationStatus`. Object fields (select subfields): `error`. **tableImportJob** `TableImportJob` **TableImportJob fields** Scalar fields: `id`, `jobId`, `jobStatus`, `tableStore`, `projectId`, `dataset`, `createdAt`, `modelName`, `modelId`, `modelType`, `modelVersion`, `modelEnvironmentName`, `batchId`, `table`, `totalQueriesSuccessCount`, `totalQueriesFailedCount`, `totalQueriesPendingCount`. Object fields (select subfields): `schema`, `tableIngestionParameters`, `queries`. #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation CreateTriggeredOngoingTableImportJob($input: CreateTriggeredOngoingTableImportJobInput!) { createTriggeredOngoingTableImportJob(input: $input) { space { id name } validationResult { jobId } tableImportJob { id } } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "spaceId": "", "modelName": "", "modelType": "numeric", "modelEnvironmentName": "production", "tableStore": "BigQuery", "schema": { "predictionId": "" } } } ``` ### createTriggeredOngoingTableRun Schedule a job run that will import model inferences from a table `createTriggeredOngoingTableRun(input: CreateTriggeredOngoingTableRunInput!): CreateTriggeredOngoingTableRunPayload` #### Arguments **input** `CreateTriggeredOngoingTableRunInput!` *required* **CreateTriggeredOngoingTableRunInput fields** **jobId** `ID!` *required* The job id to schedule a table ingestion run for **queryStart** `DateTime!` *required* The start time for the query **queryEnd** `DateTime!` *required* The end time for the query **clientMutationId** `String` #### Returns #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation CreateTriggeredOngoingTableRun($input: CreateTriggeredOngoingTableRunInput!) { createTriggeredOngoingTableRun(input: $input) { clientMutationId } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "jobId": "", "queryStart": "2026-01-01T00:00:00Z", "queryEnd": "2026-01-01T00:00:00Z" } } ``` ### createIntegrationKey `createIntegrationKey(input: CreateIntegrationKeyInput!): CreateIntegrationKeyPayload` #### Arguments **input** `CreateIntegrationKeyInput!` *required* **CreateIntegrationKeyInput fields** **accountOrganizationId** `ID!` *required* The global relay id of the organization to create the integration key in. **providerName** `IntegrationProvider!` *required* The name of an integration provider e.g. opsgeneie, pagerduty, slack One of: `opsgenie`, `pagerduty`, `slack`. **serviceName** `String!` *required* The name of the integration, used to denote a target service or team e.x. ML Team Opsgenie. **apiKey** `String!` *required* The integration's api key **alertSeverity** `IntegrationAlertSeverity` The priority/severity level when sending alerts to the given integration provider. One of: `opsgenieP1`, `opsgenieP2`, `opsgenieP3`, `opsgenieP4`, `opsgenieP5`, `pagerdutycritical`, `pagerdutyerror`, `pagerdutywarning`, `pagerdutyinfo`. **clientMutationId** `String` #### Returns **integrationKey** `IntegrationKey!` The created integration key. **IntegrationKey fields** Scalar fields: `id`, `name`, `providerName`, `createdAt`, `alertSeverity`, `channelName`. Object fields (select subfields): `creator`. #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation CreateIntegrationKey($input: CreateIntegrationKeyInput!) { createIntegrationKey(input: $input) { integrationKey { id name } } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "accountOrganizationId": "", "providerName": "opsgenie", "serviceName": "", "apiKey": "" } } ``` ### patchIntegrationKey `patchIntegrationKey(input: PatchIntegrationKeyInput!): PatchIntegrationKeyPayload` #### Arguments **input** `PatchIntegrationKeyInput!` *required* **PatchIntegrationKeyInput fields** **integrationKeyId** `ID!` *required* The ID of the integration to patch **set** `IntegrationKeyPatchInput!` *required* Patch of the integration **IntegrationKeyPatchInput fields** **serviceName** `String` The name of the integration, used to denote a target service or team e.x. ML Team Opsgenie. **apiKey** `String` The integration's api key **alertSeverity** `IntegrationAlertSeverity` The priority/severity level when sending alerts to the given integration provider. One of: `opsgenieP1`, `opsgenieP2`, `opsgenieP3`, `opsgenieP4`, `opsgenieP5`, `pagerdutycritical`, `pagerdutyerror`, `pagerdutywarning`, `pagerdutyinfo`. **clientMutationId** `String` #### Returns **integrationKey** `IntegrationKey!` The updated integration. **IntegrationKey fields** Scalar fields: `id`, `name`, `providerName`, `createdAt`, `alertSeverity`, `channelName`. Object fields (select subfields): `creator`. #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation PatchIntegrationKey($input: PatchIntegrationKeyInput!) { patchIntegrationKey(input: $input) { integrationKey { id name } } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "integrationKeyId": "", "set": {} } } ``` ### testIntegrationKey `testIntegrationKey(input: TestIntegrationKeyInput!): TestIntegrationKeyPayload` #### Arguments **input** `TestIntegrationKeyInput!` *required* **TestIntegrationKeyInput fields** **integrationKeyId** `ID!` *required* The global relay id for the integration key to update **clientMutationId** `String` #### Returns **statusCode** `Int!` The http status code of the test integration endpoint response e.g. 201, 401, etc #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation TestIntegrationKey($input: TestIntegrationKeyInput!) { testIntegrationKey(input: $input) { statusCode } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "integrationKeyId": "" } } ``` ### deleteIntegrationKey `deleteIntegrationKey(input: DeleteIntegrationKeyInput!): DeleteIntegrationKeyPayload` #### Arguments **input** `DeleteIntegrationKeyInput!` *required* **DeleteIntegrationKeyInput fields** **integrationKeyId** `ID!` *required* The global relay id for the integration key to delete **clientMutationId** `String` #### Returns **integrationKey** `IntegrationKey!` The soft deleted integration key. **IntegrationKey fields** Scalar fields: `id`, `name`, `providerName`, `createdAt`, `alertSeverity`, `channelName`. Object fields (select subfields): `creator`. #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation DeleteIntegrationKey($input: DeleteIntegrationKeyInput!) { deleteIntegrationKey(input: $input) { integrationKey { id name } } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "integrationKeyId": "" } } ``` ### validateByobConnector Validate a byob connector `validateByobConnector(input: ValidateByobConnectorInput!): ValidateByobConnectorPayload` #### Arguments **input** `ValidateByobConnectorInput!` *required* **ValidateByobConnectorInput fields** **spaceId** `ID!` *required* The id of the space that the byob connector belongs to **connectorIdentifier** `ByobConnectorIdentifier!` *required* The object that identifies the byob connector **ByobConnectorIdentifier fields** **spaceId** `ID!` *required* The id of the space that the byob connector belongs to **cloudStorageProvider** `CloudStorageProvider!` *required* The cloud storage provider that the byob connector belongs to One of: `GCS`, `S3`, `AZURE`. **bucketAndPath** `String!` *required* The full path of the bucket that the byob connector belongs to **azureTenantId** `String` The Azure tenant ID for Azure Blob Storage connectors **clientMutationId** `String` #### Returns **isValid** `Boolean!` Whether the byob connector is valid **validationReason** `ValidationReason` The reason why the byob connector is valid One of: `UNKNOWN_INVALID_REASON`, `FAILED_BUCKET_OWNERSHIP_CHECK`, `FAILED_BUCKET_ACCESS`. **validationMessage** `String` The message that explains why the byob connector is valid #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation ValidateByobConnector($input: ValidateByobConnectorInput!) { validateByobConnector(input: $input) { isValid validationReason validationMessage } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "spaceId": "", "connectorIdentifier": { "spaceId": "", "cloudStorageProvider": "GCS", "bucketAndPath": "" } } } ``` ### createByobConnector Create a byob connector `createByobConnector(input: CreateByobConnectorInput!): CreateByobConnectorPayload` #### Arguments **input** `CreateByobConnectorInput!` *required* **CreateByobConnectorInput fields** **spaceId** `ID!` *required* The id of the space that the byob connector belongs to **connectorIdentifier** `ByobConnectorIdentifier!` *required* The identifier of the byob connector **ByobConnectorIdentifier fields** **spaceId** `ID!` *required* The id of the space that the byob connector belongs to **cloudStorageProvider** `CloudStorageProvider!` *required* The cloud storage provider that the byob connector belongs to One of: `GCS`, `S3`, `AZURE`. **bucketAndPath** `String!` *required* The full path of the bucket that the byob connector belongs to **name** `String!` *required* The name of the byob connector **externalModelIds** `[String]!` *required* The external model ids of the byob connector **tableFormat** `ByobTableFormat` The table format for the connector (defaults to ICEBERG) One of: `ICEBERG`, `DELTA`. **azureTenantId** `String` The Azure tenant ID for Azure Blob Storage connectors **clientMutationId** `String` #### Returns **id** `ID!` The id of the created byob connector #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation CreateByobConnector($input: CreateByobConnectorInput!) { createByobConnector(input: $input) { id } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "spaceId": "", "connectorIdentifier": { "spaceId": "", "cloudStorageProvider": "GCS", "bucketAndPath": "" }, "name": "", "externalModelIds": [ "" ] } } ``` ### updateByobConnector Update a byob connector `updateByobConnector(input: UpdateByobConnectorInput!): UpdateByobConnectorPayload` #### Arguments **input** `UpdateByobConnectorInput!` *required* **UpdateByobConnectorInput fields** **id** `ID!` *required* The id of the byob connector **spaceId** `ID!` *required* The id of the space that the byob connector belongs to **name** `String!` *required* The name of the byob connector **externalModelIds** `[String]!` *required* The external model ids of the byob connector **clientMutationId** `String` #### Returns **success** `Boolean` Whether the update was successful #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation UpdateByobConnector($input: UpdateByobConnectorInput!) { updateByobConnector(input: $input) { success } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "id": "", "spaceId": "", "name": "", "externalModelIds": [ "" ] } } ``` ### deleteByobConnector Delete a byob connector `deleteByobConnector(input: DeleteByobConnectorInput!): DeleteByobConnectorPayload` #### Arguments **input** `DeleteByobConnectorInput!` *required* **DeleteByobConnectorInput fields** **id** `ID!` *required* The id of the byob connector **spaceId** `ID!` *required* The id of the space that the byob connector belongs to **clientMutationId** `String` #### Returns **success** `Boolean` Whether the delete was successful #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation DeleteByobConnector($input: DeleteByobConnectorInput!) { deleteByobConnector(input: $input) { success } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "id": "", "spaceId": "" } } ``` ### updateByobSyncedDatasource Update a byob synced datasource `updateByobSyncedDatasource(input: UpdateByobSyncedDatasourceInput!): UpdateByobSyncedDatasourcePayload` #### Arguments **input** `UpdateByobSyncedDatasourceInput!` *required* **UpdateByobSyncedDatasourceInput fields** **id** `ID!` *required* The id of the byob synced datasource **spaceId** `ID!` *required* The id of the space **activeStatus** `ActiveStatus` The active status of the byob synced datasource One of: `active`, `paused`. **syncFrequencyMinutes** `Int` The sync frequency minutes of the byob synced datasource **clientMutationId** `String` #### Returns **success** `Boolean` Whether the update was successful #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation UpdateByobSyncedDatasource($input: UpdateByobSyncedDatasourceInput!) { updateByobSyncedDatasource(input: $input) { success } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "id": "", "spaceId": "" } } ``` ### deleteByobDatasource Delete a byob datasource `deleteByobDatasource(input: DeleteByobDatasourceInput!): DeleteByobDatasourcePayload` #### Arguments **input** `DeleteByobDatasourceInput!` *required* **DeleteByobDatasourceInput fields** **id** `ID!` *required* The id of the byob datasource **spaceId** `ID!` *required* The id of the space that the byob datasource belongs to **clientMutationId** `String` #### Returns **success** `Boolean` Whether the delete was successful #### Example Only required input fields are shown. Replace `` and `` placeholders with real values; the [object graph](/docs/ax/graphql-reference/queries/object-graph.md) page shows how to look IDs up. ```graphql Mutation theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} mutation DeleteByobDatasource($input: DeleteByobDatasourceInput!) { deleteByobDatasource(input: $input) { success } } ``` ```json Variables theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}} { "input": { "id": "", "spaceId": "" } } ```