API リファレンス

このページでは、生成AI アプリケーションで使用される MLflow APIs の包括的なインデックスと、 MLflow の公式ドキュメントへの直接リンクを提供します。

公式ドキュメントリンク

• すべての MLflow Python APIs
• MLflow コア APIs
• MLflow 生成AI モジュール
• MLflow Tracing APIs
• MLflowクライアントAPI
• MLflow エンティティ

備考

ベータ版および実験的機能

このページで参照されている APIs の一部は、現在 ベータ版 または 実験版 の段階にあります。これらの APIs は、今後のリリースで変更または削除される可能性があります。 実験 APIs はすべての顧客が利用でき、ベータ APIs はほとんどの顧客が利用できます 自動的に。 ベータ API にアクセスできず、アクセスを要求する必要がある場合は、Databricks サポート担当者にお問い合わせください。

エクスペリメント マネジメント

SDK

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

エンティティ

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

迅速な管理

SDK

• 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()

エンティティ

• mlflow.entities.Prompt

スコアラーのライフサイクル管理

スコアラー インスタンス メソッド

• Scorer.register() - カスタムスコアラーをサーバーに登録する
• Scorer.start() - サンプリングによるオンライン評価の開始
• Scorer.update() - サンプリング構成の変更
• Scorer.stop() - オンライン評価の停止
• Scorer.delete() - スコアラーを完全に削除する

スコアラー レジストリ関数

• mlflow.genai.scorers.get_scorer() - 登録されたスコアラーを名前で取得する
• mlflow.genai.scorers.list_scorers() - 登録されているすべてのスコアラーを一覧表示
• mlflow.genai.scorers.delete_scorer() - 登録されたスコアラーを名前で削除

スコアラーのプロパティ

• Scorer.sample_rate - 電流サンプリングレート(0.0-1.0)
• Scorer.filter_string - 電流トレースフィルター

構成クラス

• mlflow.genai.ScorerSamplingConfig - サンプリング構成データクラス

評価

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

カスタムスコアラークラス

• mlflow.genai.Scorer

カスタムスコアラーデコレーター

• mlflow.genai.scorer()

事前定義されたスコアラー

• 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

スコアラーヘルパー

• mlflow.genai.scorers.get_all_scorers()

ジャッジSDK

• 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()

出力エンティティの判断

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

評価データセット

SDK

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

エンティティ

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

ヒューマンラベリング&レビューアプリ

エンティティ

• mlflow.genai.Agent

• mlflow.genai.LabelingSession

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

• mlflow.genai.ReviewApp

  • add_agent()
  • remove_agent()

セッション SDK のラベル付け

• 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()

ラベル スキーマの種類

• 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

ラベルスキーマSDK

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

プロンプト最適化

エンティティ

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

SDK

• mlflow.genai.optimize.optimize_prompt()

トレーシング

SDK

• 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()

エンティティ

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

評価 (フィードバック、期待) エンティティ

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

トレーシング統合

• 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

バージョン追跡

SDK

• 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()

エンティティ

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