Arize Phoenix TS
    Preparing search index...

    Function updateDatasetSplit

    • Partially update a dataset split and/or its example membership.

      Only provided fields change. Membership additions and removals are idempotent; if an example appears in both arrays, removal wins.

      Parameters

      • params: UpdateDatasetSplitParams

        The split fields and memberships to update.

        Parameters for partially updating a dataset split.

        • OptionaladdExampleIds?: string[]

          Dataset example GlobalIDs or user-provided IDs to add. Existing memberships are no-ops.

        • 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

        • Optionalcolor?: string | null

          A new hex color for the split.

        • dataset: DatasetIdentifier

          The dataset, selected by name or GlobalID.

        • Optionaldescription?: string | null

          A new description, or null to clear it.

        • Optionalmetadata?: { [key: string]: unknown } | null

          JSON metadata that replaces the existing metadata.

        • Optionalname?: string | null

          A new unique name for the split.

        • OptionalremoveExampleIds?: string[]

          Dataset example GlobalIDs or user-provided IDs to remove. Missing memberships are no-ops.

        • splitId: string

          The dataset split GlobalID.

      Returns Promise<
          {
              color: string;
              created_at: string;
              description: string
              | null;
              example_count: number;
              id: string;
              metadata: { [key: string]: unknown };
              name: string;
              updated_at: string;
          },
      >

      The updated dataset split.

      If the dataset, split, or an example does not exist, the name is already in use, or the request is invalid.

      Phoenix server >= 19.20.0

    Settings
    Member Visibility