Go SDK v2 - Arize AX Docs

Installation

This package is currently pre-release. Add the module to your project:

go get github.com/Arize-ai/client-go-v2

The module root contains no Go code; all packages live under arize/. Import the public arize package and any per-subclient packages you need:

import (
    "github.com/Arize-ai/client-go-v2/arize"
    "github.com/Arize-ai/client-go-v2/arize/resourcerestrictions"
)

Configuration

Authenticate using API keys obtained from the Arize Platform. The API key is required for all operations and can be provided via Config or the ARIZE_API_KEY environment variable. The API host is also configurable via Config.APIHost or the ARIZE_API_HOST environment variable. Refer to the API Hosts and Regions documentation for base URL configuration, which defaults to the global environment.

In Code
Environment Variables

package main

import (
    "log"

    "github.com/Arize-ai/client-go-v2/arize"
)

func main() {
    client, err := arize.NewClient(arize.Config{
        APIKey:  "your-api-key",
        APIHost: "api.arize.com",
    })
    if err != nil {
        log.Fatal(err)
    }
    _ = client
}

export ARIZE_API_KEY="your-api-key"
export ARIZE_API_HOST="api.arize.com"

package main

import (
    "log"

    "github.com/Arize-ai/client-go-v2/arize"
)

func main() {
    // Config fields default from ARIZE_* env vars during Resolve.
    client, err := arize.NewClient(arize.Config{})
    if err != nil {
        log.Fatal(err)
    }
    _ = client
}

Regions

Use Config.Region to point the client at a specific Arize deployment region. Setting Region overrides APIHost, OTLPHost, FlightHost, and FlightPort. Region is mutually exclusive with SingleHost/SinglePort and BaseDomain.

client, err := arize.NewClient(arize.Config{
    APIKey: "your-api-key",
    Region: arize.RegionUSCentral,
})

Region Constant	Identifier
`RegionUSCentral`	`us-central-1a`
`RegionEUWest`	`eu-west-1a`
`RegionCACentral`	`ca-central-1a`
`RegionUSEast`	`us-east-1b`

Error Handling

The SDK returns typed errors for non-2xx HTTP responses. Compare against typed errors with errors.As and against sentinel errors with errors.Is.

import (
    "context"
    "errors"
    "log"

    "github.com/Arize-ai/client-go-v2/arize"
    "github.com/Arize-ai/client-go-v2/arize/resourcerestrictions"
)

func main() {
    client, err := arize.NewClient(arize.Config{APIKey: "your-api-key"})
    if err != nil {
        if errors.Is(err, arize.ErrMissingAPIKey) {
            log.Fatal("API key is required")
        }
        log.Fatal(err)
    }

    _, err = client.ResourceRestrictions.Restrict(context.Background(), resourcerestrictions.RestrictRequest{
        ResourceID: "your-project-id",
    })

    var notFound *arize.NotFoundError
    var unauthorized *arize.UnauthorizedError
    switch {
    case errors.As(err, &notFound):
        log.Printf("resource not found: %v", notFound)
    case errors.As(err, &unauthorized):
        log.Printf("unauthorized: %v", unauthorized)
    case err != nil:
        log.Fatal(err)
    }
}

Available typed errors (re-exported from the public arize package):

arize.APIError
arize.BadRequestError
arize.UnauthorizedError
arize.ForbiddenError
arize.NotFoundError
arize.ConflictError
arize.UnprocessableEntityError
arize.RateLimitError
arize.ServerError
arize.ResourceNotFoundError
arize.AmbiguousNameError

Sentinel errors:

arize.ErrMissingAPIKey
arize.ErrMultipleEndpointOverrides

Subclients

The Client exposes typed subclients as exported fields. Each subclient lives in its own package and is documented on its own page:

AI Integrations - client.AIIntegrations
Annotation Configs - client.AnnotationConfigs
Annotation Queues - client.AnnotationQueues
API Keys - client.APIKeys
Audit Logs - client.AuditLogs
Datasets - client.Datasets
Evaluators - client.Evaluators
Experiments - client.Experiments
Organizations - client.Organizations
Projects - client.Projects
Prompts - client.Prompts
Resource Restrictions - client.ResourceRestrictions
Role Bindings - client.RoleBindings
Roles - client.Roles
Spaces - client.Spaces
Spans - client.Spans
Tasks - client.Tasks
Users - client.Users

Pre-Release API Warnings

Pre-release APIs (ALPHA and BETA) are actively evolving based on user feedback. The SDK emits a one-time warning via the standard library’s log/slog package the first time you call a pre-release endpoint:

client.ResourceRestrictions.Restrict(ctx, body)
// [BETA] resourcerestrictions.restrict is a beta API in Arize SDK v0.18.0 and may change without notice. If you experience unexpected failures, please upgrade to the most recent version of the package.

Subsequent calls to the same endpoint do not re-emit the warning.

For detailed information about API version stages, stability guarantees, and recommendations, see API Version Stages in the REST API reference.

​Installation

​Configuration

​Regions

​Error Handling

​Subclients

​Pre-Release API Warnings

Installation

Configuration

Regions

Error Handling

Subclients

Pre-Release API Warnings