Databricks SDK for JavaScript
    Preparing search index...
    interface SearchRunsRequest {
        experimentIds?: string[];
        filter?: string;
        maxResults?: number;
        orderBy?: string[];
        pageToken?: string;
        runViewType?: ViewType;
    }
    Index

    Properties

    experimentIds?: string[]

    List of experiment IDs to search over.

    filter?: string

    A filter expression over params, metrics, and tags, that allows returning a subset of runs. The syntax is a subset of SQL that supports ANDing together binary operations between a param, metric, or tag and a constant.

    Example: metrics.rmse < 1 and params.model_class = 'LogisticRegression'

    You can select columns with special characters (hyphen, space, period, etc.) by using double quotes: metrics."model class" = 'LinearRegression' and tags."user-name" = 'Tomas'

    Supported operators are =, !=, >, >=, <, and <=.

    maxResults?: number

    Maximum number of runs desired. Max threshold is 50000

    orderBy?: string[]

    List of columns to be ordered by, including attributes, params, metrics, and tags with an optional "DESC" or "ASC" annotation, where "ASC" is the default. Example: ["params.input DESC", "metrics.alpha ASC", "metrics.rmse"]. Tiebreaks are done by start_time DESC followed by run_id for runs with the same start time (and this is the default ordering criterion if order_by is not provided).

    pageToken?: string

    Token for the current page of runs.

    runViewType?: ViewType

    Whether to display only active, only deleted, or all runs. Defaults to only active runs.