Package org.mlflow.api.proto

Interface PromptOptimization.PromptOptimizationJobOrBuilder

    • Method Detail

      • hasJobId

        boolean hasJobId()
         Unique identifier for the optimization job.
 Used to poll job execution status (pending/running/completed/failed).
        optional string job_id = 1;
        Returns:
        Whether the jobId field is set.

      • getJobId

        java.lang.String getJobId()
         Unique identifier for the optimization job.
 Used to poll job execution status (pending/running/completed/failed).
        optional string job_id = 1;
        Returns:
        The jobId.

      • getJobIdBytes

        com.google.protobuf.ByteString getJobIdBytes()
         Unique identifier for the optimization job.
 Used to poll job execution status (pending/running/completed/failed).
        optional string job_id = 1;
        Returns:
        The bytes for jobId.

      • hasRunId

        boolean hasRunId()
         MLflow run ID where optimization metrics and results are stored.
 Use this to view results in MLflow UI. Only available after job starts running.
        optional string run_id = 2;
        Returns:
        Whether the runId field is set.

      • getRunId

        java.lang.String getRunId()
         MLflow run ID where optimization metrics and results are stored.
 Use this to view results in MLflow UI. Only available after job starts running.
        optional string run_id = 2;
        Returns:
        The runId.

      • getRunIdBytes

        com.google.protobuf.ByteString getRunIdBytes()
         MLflow run ID where optimization metrics and results are stored.
 Use this to view results in MLflow UI. Only available after job starts running.
        optional string run_id = 2;
        Returns:
        The bytes for runId.

      • hasState

        boolean hasState()
         Current state of the job (status + error message + metadata).
        optional .mlflow.JobState state = 3;
        Returns:
        Whether the state field is set.

      • getState

        Jobs.JobState getState()
         Current state of the job (status + error message + metadata).
        optional .mlflow.JobState state = 3;
        Returns:
        The state.

      • getStateOrBuilder

        Jobs.JobStateOrBuilder getStateOrBuilder()
         Current state of the job (status + error message + metadata).
        optional .mlflow.JobState state = 3;

      • hasExperimentId

        boolean hasExperimentId()
         ID of the MLflow experiment where this optimization job is tracked.
        optional string experiment_id = 4;
        Returns:
        Whether the experimentId field is set.

      • getExperimentId

        java.lang.String getExperimentId()
         ID of the MLflow experiment where this optimization job is tracked.
        optional string experiment_id = 4;
        Returns:
        The experimentId.

      • getExperimentIdBytes

        com.google.protobuf.ByteString getExperimentIdBytes()
         ID of the MLflow experiment where this optimization job is tracked.
        optional string experiment_id = 4;
        Returns:
        The bytes for experimentId.

      • hasSourcePromptUri

        boolean hasSourcePromptUri()
         URI of the source prompt that optimization started from (e.g., "prompts:/my-prompt/1").
        optional string source_prompt_uri = 5;
        Returns:
        Whether the sourcePromptUri field is set.

      • getSourcePromptUri

        java.lang.String getSourcePromptUri()
         URI of the source prompt that optimization started from (e.g., "prompts:/my-prompt/1").
        optional string source_prompt_uri = 5;
        Returns:
        The sourcePromptUri.

      • getSourcePromptUriBytes

        com.google.protobuf.ByteString getSourcePromptUriBytes()
         URI of the source prompt that optimization started from (e.g., "prompts:/my-prompt/1").
        optional string source_prompt_uri = 5;
        Returns:
        The bytes for sourcePromptUri.

      • hasOptimizedPromptUri

        boolean hasOptimizedPromptUri()
         URI of the optimized prompt (e.g., "prompts:/my-prompt/2").
 Only set if optimization completed successfully.
        optional string optimized_prompt_uri = 6;
        Returns:
        Whether the optimizedPromptUri field is set.

      • getOptimizedPromptUri

        java.lang.String getOptimizedPromptUri()
         URI of the optimized prompt (e.g., "prompts:/my-prompt/2").
 Only set if optimization completed successfully.
        optional string optimized_prompt_uri = 6;
        Returns:
        The optimizedPromptUri.

      • getOptimizedPromptUriBytes

        com.google.protobuf.ByteString getOptimizedPromptUriBytes()
         URI of the optimized prompt (e.g., "prompts:/my-prompt/2").
 Only set if optimization completed successfully.
        optional string optimized_prompt_uri = 6;
        Returns:
        The bytes for optimizedPromptUri.

      • hasConfig

        boolean hasConfig()
         Configuration for the optimization job.
        optional .mlflow.PromptOptimizationJobConfig config = 7;
        Returns:
        Whether the config field is set.

      • hasCreationTimestampMs

        boolean hasCreationTimestampMs()
         Timestamp when the job was created (milliseconds since epoch).
        optional int64 creation_timestamp_ms = 8;
        Returns:
        Whether the creationTimestampMs field is set.

      • getCreationTimestampMs

        long getCreationTimestampMs()
         Timestamp when the job was created (milliseconds since epoch).
        optional int64 creation_timestamp_ms = 8;
        Returns:
        The creationTimestampMs.

      • hasCompletionTimestampMs

        boolean hasCompletionTimestampMs()
         Timestamp when the job completed (milliseconds since epoch).
 Only set if status is COMPLETED, FAILED, or CANCELED.
        optional int64 completion_timestamp_ms = 9;
        Returns:
        Whether the completionTimestampMs field is set.

      • getCompletionTimestampMs

        long getCompletionTimestampMs()
         Timestamp when the job completed (milliseconds since epoch).
 Only set if status is COMPLETED, FAILED, or CANCELED.
        optional int64 completion_timestamp_ms = 9;
        Returns:
        The completionTimestampMs.

      • getTagsCount

        int getTagsCount()
         Tags associated with this job.
        repeated .mlflow.PromptOptimizationJobTag tags = 10;

      • getInitialEvalScoresCount

        int getInitialEvalScoresCount()
         Initial evaluation scores before optimization, keyed by scorer name.
 Example: {"Correctness": 0.65, "Safety": 0.80}
        map<string, double> initial_eval_scores = 11;

      • containsInitialEvalScores

        boolean containsInitialEvalScores​(java.lang.String key)
         Initial evaluation scores before optimization, keyed by scorer name.
 Example: {"Correctness": 0.65, "Safety": 0.80}
        map<string, double> initial_eval_scores = 11;

      • getInitialEvalScores

        @Deprecated
java.util.Map<java.lang.String,​java.lang.Double> getInitialEvalScores()
        Deprecated.
        Use getInitialEvalScoresMap() instead.

      • getInitialEvalScoresMap

        java.util.Map<java.lang.String,​java.lang.Double> getInitialEvalScoresMap()
         Initial evaluation scores before optimization, keyed by scorer name.
 Example: {"Correctness": 0.65, "Safety": 0.80}
        map<string, double> initial_eval_scores = 11;

      • getInitialEvalScoresOrDefault

        double getInitialEvalScoresOrDefault​(java.lang.String key,
                                     double defaultValue)
         Initial evaluation scores before optimization, keyed by scorer name.
 Example: {"Correctness": 0.65, "Safety": 0.80}
        map<string, double> initial_eval_scores = 11;

      • getInitialEvalScoresOrThrow

        double getInitialEvalScoresOrThrow​(java.lang.String key)
         Initial evaluation scores before optimization, keyed by scorer name.
 Example: {"Correctness": 0.65, "Safety": 0.80}
        map<string, double> initial_eval_scores = 11;

      • getFinalEvalScoresCount

        int getFinalEvalScoresCount()
         Final evaluation scores after optimization, keyed by scorer name.
 Example: {"Correctness": 0.89, "Safety": 0.95}
        map<string, double> final_eval_scores = 12;

      • containsFinalEvalScores

        boolean containsFinalEvalScores​(java.lang.String key)
         Final evaluation scores after optimization, keyed by scorer name.
 Example: {"Correctness": 0.89, "Safety": 0.95}
        map<string, double> final_eval_scores = 12;

      • getFinalEvalScores

        @Deprecated
java.util.Map<java.lang.String,​java.lang.Double> getFinalEvalScores()
        Deprecated.
        Use getFinalEvalScoresMap() instead.

      • getFinalEvalScoresMap

        java.util.Map<java.lang.String,​java.lang.Double> getFinalEvalScoresMap()
         Final evaluation scores after optimization, keyed by scorer name.
 Example: {"Correctness": 0.89, "Safety": 0.95}
        map<string, double> final_eval_scores = 12;

      • getFinalEvalScoresOrDefault

        double getFinalEvalScoresOrDefault​(java.lang.String key,
                                   double defaultValue)
         Final evaluation scores after optimization, keyed by scorer name.
 Example: {"Correctness": 0.89, "Safety": 0.95}
        map<string, double> final_eval_scores = 12;

      • getFinalEvalScoresOrThrow

        double getFinalEvalScoresOrThrow​(java.lang.String key)
         Final evaluation scores after optimization, keyed by scorer name.
 Example: {"Correctness": 0.89, "Safety": 0.95}
        map<string, double> final_eval_scores = 12;