Review queue operations

createreviewqueue(instance::MLFlow, experiment_id::String, name::String,
    queue_type::String; created_by::Union{String,Missing}=missing,
    users::Union{Array{String},Missing}=missing,
    schema_ids::Union{Array{String},Missing}=missing)

Create a ReviewQueue (user or custom) scoped to an experiment.

Arguments

• instance: MLFlow configuration.
• experiment_id: Parent experiment ID.
• name: Queue name (must be unique within the experiment).
• queue_type: Queue type (USER or CUSTOM, see ReviewQueueType). A USER queue must have exactly one user equal to its name and no schemas; a CUSTOM queue may not use the reserved name default.
• created_by: Optional owner of the queue (server-stamped on authenticated servers).
• users: Optional assigned-user pool.
• schema_ids: Optional attached label-schema IDs (for a CUSTOM queue).

Returns

An instance of type ReviewQueue.

getorcreateuserqueue(instance::MLFlow, experiment_id::String, user::String;
    created_by::Union{String,Missing}=missing)

Get-or-create a user's personal ReviewQueue for an experiment. This operation is atomic and idempotent on (experiment_id, user).

Arguments

• instance: MLFlow configuration.
• experiment_id: Parent experiment ID.
• user: The user identifier whose personal queue to get or create.
• created_by: Optional owner of the queue.

Returns

An instance of type ReviewQueue.

getreviewqueue(instance::MLFlow, queue_id::String)

Get a ReviewQueue by ID.

Arguments

• instance: MLFlow configuration.
• queue_id: The review queue ID.

Returns

An instance of type ReviewQueue.

getreviewqueuebyname(instance::MLFlow, experiment_id::String, name::String)

Get a ReviewQueue by (experiment_id, name).

Arguments

• instance: MLFlow configuration.
• experiment_id: Parent experiment ID.
• name: The review queue name.

Returns

An instance of type ReviewQueue.

listreviewqueues(instance::MLFlow, experiment_id::String;
    user::Union{String,Missing}=missing, item_id::Union{String,Missing}=missing,
    max_results::Union{Int,Missing}=missing,
    page_token::Union{String,Missing}=missing)

List an experiment's ReviewQueue entities, newest first.

Arguments

• instance: MLFlow configuration.
• experiment_id: Parent experiment ID.
• user: If set, return only queues that user is assigned to.
• item_id: If set, return only queues that already contain this item (a trace ID).
• max_results: Maximum number of queues to return.
• page_token: Token indicating the page of queues to fetch.

Returns

• Vector of ReviewQueue entities.
• The next page token if there are more results.

updatereviewqueue(instance::MLFlow, queue_id::String;
    name::Union{String,Missing}=missing,
    users::Union{Array{String},Missing}=missing,
    schema_ids::Union{Array{String},Missing}=missing,
    new_owner::Union{String,Missing}=missing)

Update a CUSTOM ReviewQueue's name, assigned users, attached schemas, and/or owner. The queue_type is immutable and USER queues reject this operation. Passing users or schema_ids replaces the corresponding set (passing an empty vector clears it).

Arguments

• instance: MLFlow configuration.
• queue_id: The review queue ID.
• name: Optional new queue name.
• users: Optional replacement assigned-user pool.
• schema_ids: Optional replacement attached label-schema IDs.
• new_owner: Optional new owner (reassigns created_by; requires MANAGE permission).

Returns

An instance of type ReviewQueue.

deletereviewqueue(instance::MLFlow, queue_id::String)

Delete a ReviewQueue and its user/item/schema associations. This is a no-op if the queue does not exist.

Arguments

• instance: MLFlow configuration.
• queue_id: The review queue ID.

Returns

true if successful. Otherwise, raises exception.

additemstoreviewqueue(instance::MLFlow, queue_id::String, item_ids::Array{String};
    item_type::String="TRACE")

Attach items to a ReviewQueue. This is idempotent per item (re-attaching preserves the existing status).

Arguments

• instance: MLFlow configuration.
• queue_id: The review queue ID.
• item_ids: IDs of the items to attach (trace IDs in v1).
• item_type: Type of the referenced objects (see ReviewItemType); defaults to TRACE, the only supported value.

Returns

Vector of ReviewQueueItem covering every requested item, in request order.

removeitemsfromreviewqueue(instance::MLFlow, queue_id::String, item_ids::Array{String})

Detach items from a ReviewQueue. This is a no-op for items that are not attached.

Arguments

• instance: MLFlow configuration.
• queue_id: The review queue ID.
• item_ids: IDs of the items to detach.

Returns

true if successful. Otherwise, raises exception.

listreviewqueueitems(instance::MLFlow, queue_id::String;
    status::Union{String,Missing}=missing,
    max_results::Union{Int,Missing}=missing,
    page_token::Union{String,Missing}=missing)

List a ReviewQueue's attached items, newest-attached first.

Arguments

• instance: MLFlow configuration.
• queue_id: The review queue ID.
• status: Optional filter by status (see ReviewStatus).
• max_results: Maximum number of items to return.
• page_token: Token indicating the page of items to fetch.

Returns

• Vector of ReviewQueueItem entities.
• The next page token if there are more results.

setreviewqueueitemstatus(instance::MLFlow, queue_id::String, item_id::String,
    status::String; completed_by::Union{String,Missing}=missing)

Set the shared-pool status of an attached ReviewQueueItem.

Arguments

• instance: MLFlow configuration.
• queue_id: The review queue ID.
• item_id: The item ID.
• status: New status (see ReviewStatus).
• completed_by: Required for COMPLETE/DECLINED; must be absent for PENDING (reopening an item clears attribution).

Returns

An instance of type ReviewQueueItem.