Skip to main content
Manage models and projects: baselines, tags, mappings, metrics, costs, filters. For task-oriented walkthroughs of these operations, see the Project and model guide. Every mutation below is sent as a POST to https://app.arize.com/graphql with an x-api-key header; see Forming calls.

Mutations in this page

Reference

deleteModel

deleteModel(input: DeleteModelMutationInput!): DeleteModelMutationPayload

Arguments

DeleteModelMutationInput!
required

Returns

Model
Space

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

deleteData

Delete data for a specific time period. Note that the deletion process may take up to an hour to complete. deleteData(input: DeleteDataMutationInput!): DeleteDataMutationPayload

Arguments

DeleteDataMutationInput!
required

Returns

Model
Space

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

setModelBaseline

Sets the primary baseline for a model setModelBaseline(input: SetModelBaselineMutationInput!): SetModelBaselineMutationPayload

Arguments

SetModelBaselineMutationInput!
required

Returns

ModelBaseline
Model

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

setModelAutoBaselineConfig

setModelAutoBaselineConfig(input: SetAutoBaselineConfigMutationInput!): SetAutoBaselineConfigMutationPayload

Arguments

SetAutoBaselineConfigMutationInput!
required

Returns

ModelAutoBaselineConfig!
Model!

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

addTagsToModel

addTagsToModel(input: AddTagsToModelInput!): AddTagsToModelPayload

Arguments

AddTagsToModelInput!
required

Returns

AddTagsToModelResult!
Union of TagAssociationSuccess, TagAssociationError. Use inline fragments (... on TypeName).

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

removeTagsFromModel

removeTagsFromModel(input: RemoveTagsFromModelInput!): RemoveTagsFromModelPayload

Arguments

RemoveTagsFromModelInput!
required

Returns

RemoveTagsFromModelResult!
Union of TagAssociationSuccess, TagAssociationError. Use inline fragments (... on TypeName).

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

updateModelColumnMappingConfig

Update column mapping configuration for a model updateModelColumnMappingConfig(input: UpdateModelColumnMappingConfigInput!): UpdateModelColumnMappingConfigPayload

Arguments

UpdateModelColumnMappingConfigInput!
required

Returns

Model

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

updateProjectSourceMappingConfig

Update source mapping configuration for a project. Maps target columns (input/output) to dot-notation attribute paths. updateProjectSourceMappingConfig(input: UpdateProjectSourceMappingConfigInput!): UpdateProjectSourceMappingConfigPayload

Arguments

UpdateProjectSourceMappingConfigInput!
required

Returns

Model

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

updateDimensionConfig

Updates an existing dimension config or creates a new one. updateDimensionConfig(input: UpdateDimensionConfigMutationInput!): UpdateDimensionConfigMutationPayload

Arguments

UpdateDimensionConfigMutationInput!
required

Returns

DimensionConfig
Model!
The model on which the dimension config was created.

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

createTraceFilter

Create a trace filter createTraceFilter(input: CreateTraceFilterInput!): CreateTraceFilterPayload

Arguments

CreateTraceFilterInput!
required

Returns

TraceFilter!
The created trace filter

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

updateTraceFilter

Updates a trace filter updateTraceFilter(input: UpdateTraceFilterInput!): UpdateTraceFilterPayload

Arguments

UpdateTraceFilterInput!
required

Returns

TraceFilter!
The updated trace filter

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

deleteTraceFilter

Deletes a traceFilter deleteTraceFilter(input: DeleteTraceFilterInput!): DeleteTraceFilterPayload

Arguments

DeleteTraceFilterInput!
required

Returns

Boolean!

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

createCustomMetric

Creates a new custom metric scoped to a space. createCustomMetric(input: CreateCustomMetricMutationInput!): CreateCustomMetricMutationPayload

Arguments

CreateCustomMetricMutationInput!
required

Returns

CustomMetric!
The newly created custom metric.

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

updateCustomMetric

Updates an existing custom metric. updateCustomMetric(input: UpdateCustomMetricMutationInput!): UpdateCustomMetricMutationPayload

Arguments

UpdateCustomMetricMutationInput!
required

Returns

CustomMetric!
The updated custom metric.

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

deleteCustomMetric

Deletes a custom metric. deleteCustomMetric(input: DeleteCustomMetricMutationInput!): DeleteCustomMetricMutationPayload

Arguments

DeleteCustomMetricMutationInput!
required

Returns

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

createCostConfig

Create a cost config createCostConfig(input: CreateCostConfigInput!): CreateCostConfigPayload

Arguments

CreateCostConfigInput!
required

Returns

Boolean!
Whether or not the cost config was successfully created or updated.
CostConfig!
The created cost config

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

updateCostConfig

Update a cost config updateCostConfig(input: UpdateCostConfigInput!): UpdateCostConfigPayload

Arguments

UpdateCostConfigInput!
required

Returns

CostConfig!
The updated cost config

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

deleteCostConfig

Deletes a cost config deleteCostConfig(input: DeleteCostConfigInput!): DeleteCostConfigPayload

Arguments

DeleteCostConfigInput!
required

Returns

Boolean!

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.