Pairing with mlflow==3.11.1

Author: pebeto

.github/workflows/CI.yml

@@ -14,9 +14,8 @@ jobs:
       max-parallel: 1
       matrix:
         version:
-          - '1.10'
-          - '1.11'
-          - '1' # automatically expands to the latest stable 1.x release of Julia.
+          - 'lts'
+          - '1'
         os:
           - ubuntu-latest
         arch:
@@ -27,7 +26,7 @@ jobs:
         if: hashFiles('**/requirements.txt', '**/pyproject.toml') == ''
         run: |
           touch ./requirements.txt
-          echo "mlflow[auth]==3.2.0" > ./requirements.txt
+          echo "mlflow[auth]==3.11.1" > ./requirements.txt
       - uses: actions/setup-python@v4
         with:
           python-version: '3.12.3'

Project.toml

@@ -15,7 +15,7 @@ UUIDs = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
 [compat]
 Base64 = "1.0"
 HTTP = "1.0"
-JSON = "0.21,1"
+JSON = "1.5.0"
 ShowCases = "0.1"
 URIs = "1.0"
 julia = "1.0"

README.md

@@ -4,12 +4,13 @@
 [![Build Status](https://github.com/JuliaAI/MLFlowClient.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JuliaAI/MLFlowClient.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/JuliaAI/MLFlowClient.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaAI/MLFlowClient.jl)
 
-Julia client for [MLFlow](https://www.mlflow.org/) `3.2.0`. Use with later versions at
-your own risk. For example, there is [this known
-issue](https://github.com/JuliaAI/MLFlowClient.jl/issues/76).
+Julia client for [MLFlow](https://www.mlflow.org/). Ensured compatibility with `mlflow==3.11.1`.
 
 - [x] Supports tracking of metrics, parameters, tags, artifacts, and models.
 - [x] Compatible with latest MLFlow server capabilities.
 - [x] Mirroring types from MLFlow API for easy use.
 - [x] Includes MLflow Authentication REST API interface.
-- [ ] Supports artifact download/upload.
+- [x] Supports artifact download/upload and multipart uploads.
+- [x] Supports Scorers API for evaluation.
+- [x] Supports Gateway API (secrets, model definitions, endpoints, budgets).
+- [x] Supports Prompt Optimization API.

docs/make.jl

@@ -13,6 +13,9 @@ makedocs(;
         "Run operations" => "reference/run.md",
         "Registered model operations" => "reference/registered_model.md",
         "Model version operations" => "reference/model_version.md",
-        "User operations" => "reference/user.md",]])
+        "User operations" => "reference/user.md",
+        "Scorer operations" => "reference/scorer.md",
+        "Gateway operations" => "reference/gateway.md",
+        "Prompt optimization operations" => "reference/prompt_optimization.md"]])
 
 deploydocs(; repo="github.com/JuliaAI/MLFlowClient.jl", devbranch="main")

docs/src/reference/artifact.md

@@ -1,4 +1,12 @@
 # Artifact operations
 ```@docs
 listartifacts
+listartifactsdirect
+downloadartifact
+uploadartifact
+deleteartifact
+createmultipartupload
+completemultipartupload
+abortmultipartupload
+getpresigneddownloadurl
 ```

docs/src/reference/gateway.md

@@ -0,0 +1,48 @@
+# Gateway operations
+## Secrets
+```@docs
+creategatewaysecret
+getgatewaysecretinfo
+updategatewaysecret
+deletegatewaysecret
+listgatewaysecretinfos
+```
+
+## Model Definitions
+```@docs
+creategatewaymodeldefinition
+getgatewaymodeldefinition
+listgatewaymodeldefinitions
+updategatewaymodeldefinition
+deletegatewaymodeldefinition
+```
+
+## Endpoints
+```@docs
+creategatewayendpoint
+getgatewayendpoint
+updategatewayendpoint
+deletegatewayendpoint
+listgatewayendpoints
+attachmodeltogatewayendpoint
+detachmodelfromgatewayendpoint
+setgatewayendpointtag
+deletegatewayendpointtag
+```
+
+## Endpoint Bindings
+```@docs
+creategatewayendpointbinding
+deletegatewayendpointbinding
+listgatewayendpointbindings
+```
+
+## Budgets
+```@docs
+creategatewaybudget
+getgatewaybudget
+updategatewaybudget
+deletegatewaybudget
+listgatewaybudgets
+listgatewaybudgetwindows
+```

docs/src/reference/prompt_optimization.md

@@ -0,0 +1,8 @@
+# Prompt optimization operations
+```@docs
+createpromptoptimizationjob
+getpromptoptimizationjob
+searchpromptoptimizationjobs
+cancelpromptoptimizationjob
+deletepromptoptimizationjob
+```

docs/src/reference/scorer.md

@@ -0,0 +1,8 @@
+# Scorer operations
+```@docs
+registerscorer
+listscorers
+listscorerversions
+getscorer
+deletescorer
+```

docs/src/reference/types.md

@@ -18,4 +18,25 @@ RunInputs
 User
 ExperimentPermission
 RegisteredModelPermission
+Scorer
+GatewaySecretInfo
+GatewayModelDefinition
+GatewayEndpoint
+GatewayEndpointConfig
+GatewayEndpointBinding
+GatewayEndpointModelConfig
+GatewayEndpointModelMapping
+GatewayEndpointTag
+GatewayBudgetWindow
+GatewayBudgetPolicy
+BudgetDuration
+FallbackConfig
+MultipartUploadCredential
+MultipartUploadPart
+PromptOptimizationJob
+PromptOptimizationJobConfig
+PromptOptimizationJobTag
+InitialEvalScoresEntry
+FinalEvalScoresEntry
+JobStateInfo
 ```

src/MLFlowClient.jl

@@ -5,7 +5,7 @@
 for working with [MLFlow](https://mlflow.org/) using the REST
 [API v2.0](https://www.mlflow.org/docs/latest/rest-api.html).
 
-`MLFlowClient` allows you to create and manage `MLFlow` experiments, runs, and log metrics
+`MLFlowClient` allows you to create and manage `MLFlow` experiments, runs, and log parameters, metrics,
 and artifacts. If you are not familiar with `MLFlow` and its concepts, please refer to
 [MLFlow documentation](https://mlflow.org/docs/latest/index.html).
 """
@@ -26,13 +26,16 @@ include("types/tag.jl")
 export Tag
 
 include("types/enums.jl")
-export ViewType, RunStatus, ModelVersionStatus, Permission, DeploymentJobRunState, State
+export ViewType, RunStatus, ModelVersionStatus, Permission, DeploymentJobRunState, State,
+    WebhookStatus, WebhookEvent, JobState, OptimizerType,
+    RoutingStrategy, FallbackStrategy, BudgetUnit, BudgetDurationUnit,
+    BudgetTargetScope, BudgetAction, GatewayModelLinkageType
 
 include("types/dataset.jl")
 export Dataset, DatasetInput
 
 include("types/artifact.jl")
-export FileInfo
+export FileInfo, MultipartUploadCredential, MultipartUploadPart
 
 include("types/model.jl")
 export ModelInput, ModelMetric, ModelOutput, ModelParam, ModelVersion,
@@ -45,17 +48,34 @@ include("types/experiment.jl")
 export Experiment, ExperimentPermission
 
 include("types/run.jl")
-export Run, Param, Metric, RunData, RunInfo, RunInputs
+export Run, Param, Metric, RunData, RunInfo, RunInputs, RunOutputs
 
 include("types/user.jl")
 export User
 
+include("types/webhook.jl")
+export Webhook, WebhookTestResult, WebhookEntity, WebhookAction, WebhookEvent
+
+include("types/scorer.jl")
+export Scorer
+
+include("types/gateway.jl")
+export GatewaySecretInfo, GatewayModelDefinition, GatewayEndpoint, GatewayEndpointConfig,
+    GatewayEndpointBinding, GatewayBudgetWindow,
+    FallbackConfig, BudgetDuration, GatewayEndpointModelConfig,
+    GatewayEndpointModelMapping, GatewayEndpointTag, GatewayBudgetPolicy
+
+include("types/prompt_optimization.jl")
+export PromptOptimizationJob, PromptOptimizationJobConfig, PromptOptimizationJobTag,
+    InitialEvalScoresEntry, FinalEvalScoresEntry, JobStateInfo
+
 include("api.jl")
 
 include("utils.jl")
 
 include("services/experiment.jl")
 export getexperiment, createexperiment, deleteexperiment, setexperimenttag,
+    deleteexperimenttag,
     updateexperiment, restoreexperiment, searchexperiments, getexperimentbyname,
     createexperimentpermission, getexperimentpermission, updateexperimentpermission,
     deleteexperimentpermission
@@ -68,7 +88,9 @@ include("services/logger.jl")
 export logbatch, loginputs, logmetric, logmodel, logparam
 
 include("services/artifact.jl")
-export listartifacts
+export listartifacts, downloadartifact, uploadartifact, listartifactsdirect,
+    deleteartifact, createmultipartupload, completemultipartupload,
+    abortmultipartupload, getpresigneddownloadurl
 
 include("services/misc.jl")
 export refresh, getmetrichistory
@@ -84,9 +106,32 @@ include("services/model_version.jl")
 export getlatestmodelversions, getmodelversion, createmodelversion, deletemodelversion,
     updatemodelversion, searchmodelversions, getdownloaduriformodelversionartifacts,
     transitionmodelversionstage, setmodelversiontag, deletemodelversiontag,
-    getmodelversionbyalias
+    getmodelversionbyalias, listmodelversionartifacts
 
 include("services/user.jl")
 export createuser, getuser, updateuserpassword, updateuseradmin, deleteuser
 
+include("services/webhook.jl")
+export createwebhook, getwebhook, listwebhooks, updatewebhook, deletewebhook, testwebhook
+
+include("services/scorer.jl")
+export registerscorer, listscorers, listscorerversions, getscorer, deletescorer
+
+include("services/gateway.jl")
+export creategatewaysecret, getgatewaysecretinfo, updategatewaysecret, deletegatewaysecret,
+    listgatewaysecretinfos,
+    creategatewaymodeldefinition, getgatewaymodeldefinition, listgatewaymodeldefinitions,
+    updategatewaymodeldefinition, deletegatewaymodeldefinition,
+    creategatewayendpoint, getgatewayendpoint, updategatewayendpoint, deletegatewayendpoint,
+    listgatewayendpoints,
+    attachmodeltogatewayendpoint, detachmodelfromgatewayendpoint,
+    creategatewayendpointbinding, deletegatewayendpointbinding, listgatewayendpointbindings,
+    setgatewayendpointtag, deletegatewayendpointtag,
+    creategatewaybudget, getgatewaybudget, updategatewaybudget, deletegatewaybudget,
+    listgatewaybudgets, listgatewaybudgetwindows
+
+include("services/prompt_optimization.jl")
+export createpromptoptimizationjob, getpromptoptimizationjob, searchpromptoptimizationjobs,
+    cancelpromptoptimizationjob, deletepromptoptimizationjob
+
 end