Reference documentation for Job Methods.
Returns: list: A list of job details.
Parameters:
job_id
(str): The ID of the job to retrieve the status for.Returns: dict: The status of the job.
Parameters:
job_id
(str): The ID of the job to retrieve the results for.include_inputs
(bool, optional): Whether to include the inputs in the results. Defaults to False.include_cumulative_logprobs
(bool, optional): Whether to include the cumulative logprobs in the results. Defaults to False.with_original_df
(Union[pl.DataFrame, pd.DataFrame], optional): Original DataFrame to join results with. Defaults to None.output_column
(str, optional): Name of the column containing results. Defaults to “inference_result”.Returns: Union[pl.DataFrame, pd.DataFrame]: Results as a DataFrame.
with_original_df
is provided: Returns the same type as the input DataFrame with results added as a new columnwith_original_df
is None: Returns a polars DataFrame by defaultThe DataFrame will contain:
inputs
column (if include_inputs=True
). Each cell contains the input string given to the model.inference_result
column (or custom name via output_column
)cumulative_logprobs
column (if include_cumulative_logprobs=True
)Example:
Parameters:
job_id
(str): The ID of the job to cancel.Returns: dict: The status of the job cancellation.