Arize Phoenix TS
    Preparing search index...

    Function deletePromptVersionTag

    • Delete a tag from the prompt that owns the given prompt version.

      Tag names are unique within a prompt, so name identifies the tag across all versions of that prompt. The tag does not need to be attached to the selected version.

      Parameters

      • params: DeletePromptVersionTagParams

        The prompt version tag to delete.

        Parameters for deleting a prompt version tag.

        • 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

        • name: string

          The prompt-scoped tag name to delete.

        • prompt: GetPromptByVersionSelector

          A version belonging to the prompt that owns the tag.

      Returns Promise<void>

      A promise that resolves once the tag has been deleted.

      HttpError when Phoenix rejects the request.

      import { deletePromptVersionTag } from "@arizeai/phoenix-client/prompts";

      await deletePromptVersionTag({
        prompt: { versionId: "UHJvbXB0VmVyc2lvbjox" },
        name: "production",
      });

    Settings
    Member Visibility