API Reference

This page provides a comprehensive index of MLflow APIs used in GenAI applications, with direct links to the official MLflow documentation.

Official Documentation Links

• All MLflow Python APIs
• MLflow Core APIs
• MLflow GenAI Module
• MLflow Tracing APIs
• MLflow Client APIs
• MLflow Entities

Beta

Some of the APIs referenced on this page are currently in Beta.

Experiment Management

SDKs

• mlflow.search_runs()
• mlflow.set_experiment()
• mlflow.start_run()

Entities

• mlflow.entities.Experiment
• mlflow.entities.Run

Prompt Management

SDKs

• mlflow.genai.load_prompt()
• mlflow.genai.optimize_prompt()
• mlflow.genai.register_prompt()
• mlflow.genai.search_prompts()
• mlflow.genai.delete_prompt_alias()
• mlflow.genai.set_prompt_alias()

Entities

• mlflow.entities.Prompt

Evaluation

• mlflow.genai.evaluate()
• mlflow.genai.to_predict_fn()

Custom scorer class

• mlflow.genai.Scorer

Custom scorer decorator

• mlflow.genai.scorer()

Predefined scorers

• mlflow.genai.scorers.Correctness
• mlflow.genai.scorers.ExpectationsGuidelines
• mlflow.genai.scorers.Guidelines
• mlflow.genai.scorers.RelevanceToQuery
• mlflow.genai.scorers.RetrievalGroundedness
• mlflow.genai.scorers.RetrievalRelevance
• mlflow.genai.scorers.RetrievalSufficiency
• mlflow.genai.scorers.Safety

Scorer helpers

• mlflow.genai.scorers.get_all_scorers()

Judge SDKs

• mlflow.genai.judges.custom_prompt_judge()
• mlflow.genai.judges.is_context_relevant()
• mlflow.genai.judges.is_context_sufficient()
• mlflow.genai.judges.is_correct()
• mlflow.genai.judges.is_grounded()
• mlflow.genai.judges.is_safe()
• mlflow.genai.judges.meets_guidelines()

Judge output entities

• mlflow.genai.judges.CategoricalRating
  • mlflow.genai.judges.CategoricalRating.NO
  • mlflow.genai.judges.CategoricalRating.UNKNOWN
  • mlflow.genai.judges.CategoricalRating.YES

Evaluation Datasets

SDKs

• mlflow.genai.create_dataset()
• mlflow.genai.delete_dataset()
• mlflow.genai.get_dataset()

Entities

• mlflow.genai.datasets.EvaluationDataset
  • merge_records()
  • set_profile()
  • to_df()
  • to_evaluation_dataset()

Human Labeling & Review App

Entities

• mlflow.genai.Agent

• mlflow.genai.LabelingSession

  • add_dataset()
  • add_traces()
  • set_assigned_users()
  • sync()

• mlflow.genai.ReviewApp

  • add_agent()
  • remove_agent()

Labeling session SDKs

• mlflow.genai.create_labeling_session()
• mlflow.genai.delete_labeling_session()
• mlflow.genai.get_labeling_session()
• mlflow.genai.get_labeling_sessions()
• mlflow.genai.get_review_app()

Label Schema types

• mlflow.genai.label_schemas.InputCategorical
• mlflow.genai.label_schemas.InputCategoricalList
• mlflow.genai.label_schemas.InputNumeric
• mlflow.genai.label_schemas.InputText
• mlflow.genai.label_schemas.InputTextList
• mlflow.genai.label_schemas.LabelSchema
• mlflow.genai.label_schemas.LabelSchemaType
  • mlflow.genai.label_schemas.LabelSchemaType.EXPECTATION
  • mlflow.genai.label_schemas.LabelSchemaType.FEEDBACK

Label Schema SDKs

• mlflow.genai.label_schemas.create_label_schema()
• mlflow.genai.label_schemas.delete_label_schema()
• mlflow.genai.label_schemas.get_label_schema()

Prompt Optimization

Entities

• mlflow.genai.optimize.LLMParams
• mlflow.genai.optimize.OptimizerConfig
• mlflow.genai.optimize.PromptOptimizationResult

SDKs

• mlflow.genai.optimize.optimize_prompt()

Tracing

SDKs

• mlflow.delete_trace_tag()
• mlflow.get_current_active_span()
• mlflow.get_last_active_trace()
• mlflow.get_last_active_trace_id()
• mlflow.get_trace()
• mlflow.search_traces()
• mlflow.set_trace_tag()
• mlflow.start_span()
• mlflow.trace
• mlflow.traceName
• mlflow.traceOutputs
• mlflow.tracing
• mlflow.tracing.disable
• mlflow.tracing.disable_notebook_display()
• mlflow.tracing.enable
• mlflow.tracing.enable_notebook_display()
• mlflow.update_current_trace()

Entities

• mlflow.entities.Trace
• mlflow.entities.TraceData
• mlflow.entities.TraceInfo
• mlflow.entities.Span
• mlflow.entities.SpanEvent
• mlflow.entities.SpanType
• mlflow.entities.Document

Assessment (Feedback, Expectation) Entities

• mlflow.entities.Assessment
• mlflow.entities.AssessmentError
• mlflow.entities.AssessmentSource
• mlflow.entities.AssessmentSourceType
• mlflow.entities.Expectation
• mlflow.entities.Feedback

Tracing integrations

• mlflow.anthropic.autolog
• mlflow.autogen.autolog
• mlflow.bedrock.autolog
• mlflow.crewai.autolog
• mlflow.dspy.autolog
• mlflow.gemini.autolog
• mlflow.groq.autolog
• mlflow.langchain.autolog
• mlflow.litellm.autolog
• mlflow.llama_index.autolog
• mlflow.mistral.autolog
• mlflow.openai.autolog

Version Tracking

SDKs

• mlflow.set_active_model()
• mlflow.clear_active_model()
• mlflow.get_active_model_id()
• mlflow.create_external_model()
• mlflow.delete_logged_model_tag()
• mlflow.finalize_logged_model()
• mlflow.get_logged_model()
• mlflow.initialize_logged_model()
• mlflow.last_logged_model()
• mlflow.search_logged_models()
• mlflow.set_logged_model_tags()
• mlflow.log_model_params()

Entities

• mlflow.entities.LoggedModel
• mlflow.entities.LoggedModelStatus
• mlflow.ActiveModel