Arize Phoenix TS
    Preparing search index...

    Function upsertOrDeleteSecrets

    • Atomically create, update, or delete a batch of Phoenix secrets.

      A non-null value creates or updates a secret, while null deletes it. Duplicate keys use the last occurrence in the batch. The result contains key names only; submitted values are never returned or logged.

      Parameters

      • params: UpsertOrDeleteSecretsParams

        The secrets update.

        Parameters for atomically updating secrets.

        • Optionalclient?: {
              config: PhoenixClientOptions;
              DELETE: ClientMethod<paths, "delete", `${string}/${string}`>;
              GET: ClientMethod<paths, "get", `${string}/${string}`>;
              getServerVersion: () => Promise<SemanticVersion>;
              HEAD: ClientMethod<paths, "head", `${string}/${string}`>;
              OPTIONS: ClientMethod<paths, "options", `${string}/${string}`>;
              PATCH: ClientMethod<paths, "patch", `${string}/${string}`>;
              POST: ClientMethod<paths, "post", `${string}/${string}`>;
              PUT: ClientMethod<paths, "put", `${string}/${string}`>;
              request: ClientRequestMethod<paths, `${string}/${string}`>;
              TRACE: ClientMethod<paths, "trace", `${string}/${string}`>;
              eject(...middleware: Middleware[]): void;
              use(...middleware: Middleware[]): void;
          }

          An instance of the Phoenix client. If not provided, the client will be created using the default configuration.

          • config: PhoenixClientOptions
          • DELETE: ClientMethod<paths, "delete", `${string}/${string}`>

            Call a DELETE endpoint

          • GET: ClientMethod<paths, "get", `${string}/${string}`>

            Call a GET endpoint

          • getServerVersion: () => Promise<SemanticVersion>

            Get the Phoenix server version, returning a cached value if available.

            The version is first populated from the x-phoenix-server-version response header on any API call. If no version has been seen yet, this method fetches GET /arize_phoenix_version to populate the cache.

            If the server version cannot be determined (e.g. the server is unreachable or returned an unparseable version string).

          • HEAD: ClientMethod<paths, "head", `${string}/${string}`>

            Call a HEAD endpoint

          • OPTIONS: ClientMethod<paths, "options", `${string}/${string}`>

            Call a OPTIONS endpoint

          • PATCH: ClientMethod<paths, "patch", `${string}/${string}`>

            Call a PATCH endpoint

          • POST: ClientMethod<paths, "post", `${string}/${string}`>

            Call a POST endpoint

          • PUT: ClientMethod<paths, "put", `${string}/${string}`>

            Call a PUT endpoint

          • request: ClientRequestMethod<paths, `${string}/${string}`>
          • TRACE: ClientMethod<paths, "trace", `${string}/${string}`>

            Call a TRACE endpoint

          • eject: function
            • eject(...middleware: Middleware[]): void

              Unregister middleware

              Parameters

              • ...middleware: Middleware[]

              Returns void

          • use: function
            • use(...middleware: Middleware[]): void

              Register middleware

              Parameters

              • ...middleware: Middleware[]

              Returns void

        • secrets: SecretInput[]

          Ordered secret updates. When a key occurs more than once, the server applies only its last occurrence.

      Returns Promise<UpsertOrDeleteSecretsResult>

      The names of the keys that were upserted and deleted.

      import { upsertOrDeleteSecrets } from "@arizeai/phoenix-client/secrets";

      const apiKey = process.env.OPENAI_API_KEY;
      if (!apiKey) throw new Error("OPENAI_API_KEY is required");

      const result = await upsertOrDeleteSecrets({
        secrets: [
          { key: "OPENAI_API_KEY", value: apiKey },
          { key: "OLD_PROVIDER_API_KEY", value: null },
        ],
      });

    Settings
    Member Visibility