Skip to main content
Arize AX logo
  • Category: artificial intelligence
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 24
  • Triggers: 0
  • Slug: ARIZE_AX
  • Version: 20261101_00

Tools

Slug: ARIZE_AX_ADD_DATASET_EXAMPLESAppend arbitrary-field examples to an Arize dataset or a specified dataset version.

Input Parameters

array
required
Examples to append. Each object must have at least one arbitrary top-level field; do not include id, created_at, or updated_at.
string
required
Opaque, case-sensitive dataset ID; preserve any base64 padding.
string
Optional opaque dataset version ID to extend. Omit to use the latest version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_ADD_EXPERIMENT_RUNSAppend one or more runs to an existing Arize experiment.

Input Parameters

string
required
Opaque, case-sensitive experiment ID; preserve any base64 padding.
array
required
Runs to append. Each requires output and may include example_id plus arbitrary provider-supported top-level fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_CREATE_DATASETCreate an Arize dataset in a space with an explicit initial array of examples.

Input Parameters

string
required
Unique dataset name within the target space.
array
required
Initial examples. Each object must have at least one arbitrary top-level field; do not include id, created_at, or updated_at.
string
required
Opaque, case-sensitive ID of the space in which to create the dataset; preserve any base64 padding.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_CREATE_EXPERIMENTCreate an Arize experiment with initial runs, associated with exactly one dataset or space.

Input Parameters

string
required
Unique experiment name within the selected dataset or space.
string
Space-backed experiment source. Provide exactly one of space_id or dataset_id.
string
Dataset-backed experiment source. Provide exactly one of dataset_id or space_id.
array
required
Initial runs. Each requires output, may include example_id, and may include additional provider-supported top-level fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_CREATE_PROMPTCreate an Arize prompt and its initial version in a space.

Input Parameters

string
required
Unique prompt name within the target space.
object
required
Initial immutable prompt version, including its messages and provider configuration.
string
required
Opaque, case-sensitive ID of the space in which to create the prompt; preserve any base64 padding.
string
Human-readable prompt description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_CREATE_PROMPT_VERSIONCreate a new immutable version of an existing Arize prompt.

Input Parameters

string
Provider model name for this version.
array
required
Prompt messages. At least one message is required.
string ("OPEN_AI" | "AZURE_OPEN_AI" | "AWS_BEDROCK" | "VERTEX_AI" | "ANTHROPIC" | "CUSTOM")
required
Model provider used by this version.
string
required
Opaque, case-sensitive ID of the prompt to version; preserve any base64 padding.
string
required
Description of the version change.
object
Provider-specific Azure, Anthropic, Bedrock, or regional settings.
object
Model invocation settings.
string ("F_STRING" | "MUSTACHE" | "NONE")
Prompt variable syntax. Arize defaults to F_STRING when omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_GET_DATASETGet one Arize dataset and its versions by dataset ID.

Input Parameters

string
required
Opaque, case-sensitive dataset ID; preserve any base64 padding.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_GET_EXPERIMENTGet one Arize experiment by its ID, without its experiment runs.

Input Parameters

string
required
Opaque, case-sensitive experiment ID; preserve any base64 padding.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_GET_PROJECTGet one accessible Arize project by its ID.

Input Parameters

string
required
Opaque, case-sensitive project ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_GET_PROMPTGet an Arize prompt with its current, explicitly selected, or labeled version.

Input Parameters

string
Label whose target version to embed, such as production. Mutually exclusive with version_id.
string
required
Opaque, case-sensitive prompt ID; preserve any base64 padding.
string
Specific prompt version to embed. Mutually exclusive with label.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_GET_SPACEGet one accessible Arize space by its ID.

Input Parameters

string
required
Opaque, case-sensitive space ID; preserve any base64 padding.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_LIST_DATASET_EXAMPLESList one page of examples from an Arize dataset or a specific dataset version, preserving user-defined example fields.

Input Parameters

integer
Maximum examples to return in this page (1-500).
string
Opaque next_cursor from a previous page. Omit for the first page and pass it back unchanged.
string
required
Opaque, case-sensitive ID of the dataset whose examples to list.
string
Dataset version to read. Omit to use the current version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_LIST_DATASETSList one page of Arize datasets, optionally filtered by space or dataset name.

Input Parameters

string
Case-insensitive substring to match against dataset names.
integer
Maximum datasets to return in this page (1-100).
string
Opaque next_cursor from a previous page. Omit for the first page and pass it back unchanged.
string
Return only datasets in this space ID.
string
Case-insensitive substring to match against containing space names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_LIST_EXPERIMENT_RUNSList one page of runs and outputs for an Arize experiment, preserving additional run fields.

Input Parameters

integer
Maximum experiment runs to return in this page (1-500).
string
Opaque next_cursor from a previous page. Omit for the first page and pass it back unchanged.
string
required
Opaque, case-sensitive ID of the experiment whose runs to list; preserve any base64 padding.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_LIST_EXPERIMENTSList one page of Arize experiments, optionally filtered by dataset, space, or name.

Input Parameters

string
Case-insensitive substring to match against experiment names.
integer
Maximum experiments to return in this page (1-100).
string
Opaque next_cursor from a previous page; do not parse or construct it.
string
Return experiments in this space.
string
Return experiments associated with this dataset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_LIST_PROJECTSList one page of accessible Arize projects, optionally filtered by space or project name.

Input Parameters

string
Case-insensitive substring to match against project names.
integer
Maximum projects to return in this page.
string
Opaque next_cursor from a previous page. Omit for the first page and pass it back unchanged.
string
Return projects in this space ID.
string
Case-insensitive substring to match against containing space names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_LIST_PROMPTSList one page of Arize prompts, optionally filtered by space ID, space name, or prompt name. Name filters use case-insensitive substring matching.

Input Parameters

string
Case-insensitive substring to match against prompt names.
integer
Maximum prompts to return in this page (1-100).
string
Opaque next_cursor from a previous page. Omit for the first page and pass it back unchanged.
string
Return prompts in this space ID.
string
Case-insensitive substring to match against containing space names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_LIST_PROMPT_VERSIONSList one page of versions for an Arize prompt, newest first.

Input Parameters

integer
Maximum prompt versions to return in this page (1-100).
string
Opaque next_cursor from a previous page. Omit for the first page and pass it back unchanged.
string
required
Opaque, case-sensitive prompt ID; preserve any base64 padding.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_LIST_SPACESList one page of Arize spaces accessible to the connected API key, optionally filtered by organization or a case-insensitive substring of the space name.

Input Parameters

string
Case-insensitive substring to match against space names.
integer
Maximum spaces to return in this page (1-100).
string
Opaque next_cursor from a previous page; do not parse or construct it.
string
Return only spaces in this organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_LIST_SPANSRead one bounded page of spans for an Arize project using optional time and filter constraints.

Input Parameters

integer
Maximum spans to return in this page (1-500). Use a small value when attributes contain model inputs or outputs.
string
Opaque next_cursor from a previous page; do not parse or construct it.
string
Arize span filter expression.
string
Upper time bound in RFC 3339 format.
string
required
Project whose spans to query.
string
Inclusive lower time bound in RFC 3339 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_LIST_TRACESRead one bounded page of traces and nested spans for an Arize project using optional time and filter constraints. A filter selects traces containing at least one matching span; nested spans may be truncated per trace.

Input Parameters

integer
Maximum traces in this page (1-50). Each trace can contain many spans, so keep this small.
string
Opaque next_cursor from a previous page; do not parse or construct it.
string
Arize trace/span filter expression. A trace matches when any span in it matches the expression.
string
Upper time bound as an RFC 3339 timestamp with a timezone.
string
required
Opaque, case-sensitive ID of the project whose traces to query.
string
Inclusive lower time bound as an RFC 3339 timestamp with a timezone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_UPDATE_DATASETRename an existing Arize dataset.

Input Parameters

string
required
New unique name for the dataset within its space.
string
required
Opaque, case-sensitive dataset ID; preserve any base64 padding.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_UPDATE_DATASET_EXAMPLESUpdate existing Arize dataset examples by ID, optionally creating a named dataset version. IDs that do not match existing examples are ignored.

Input Parameters

array
required
Example updates. Every object requires an id and may contain arbitrary replacement fields; do not include created_at or updated_at.
string
required
Opaque, case-sensitive dataset ID; preserve any base64 padding.
string
Optional name for a new dataset version containing the updates.
string
Optional source dataset version to update; omit to update the latest version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARIZE_AX_UPDATE_PROMPTUpdate or clear an Arize prompt’s description.

Input Parameters

string
required
Opaque, case-sensitive prompt ID; preserve any base64 padding.
string
required
New human-readable prompt description, or null to clear it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not