Sign in

v2

latestSwagger 2.0raw.githubusercontent.com2019-10-08263978.4 KB
RunMetrics

Get all Run Metrics for the specific Experiment.

Get all Run Metrics for the specific Experiment with the specified query filters.

post/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/metrics:query

Path parameters

subscriptionIdstring uuid required

The Azure Subscription ID.

resourceGroupNamestring required

The Name of the resource group in which the workspace is located.

workspaceNamestring required

The name of the workspace.

experimentNamestring required

The experiment name.

Query parameters

MergeStrategyType'Default' | 'None' | 'MergeToVector'

The type of merge strategy. Currently supported strategies are: None - all logged values are returned as individual metrics. MergeToVector - merges multiple values into a vector of values. Default - the system determines the behavior.

MergeStrategyOptions'None' | 'ReportUnmergedMetricsValues'

Controls behavior of the merge strategy in certain cases; e.g. when a metric is not merged.

MergeStrategySettings.Versionstring

The strategy settings version.

MergeStrategySettings.SelectMetrics'SelectAll' | 'SelectByFirstValueSchema' | 'SelectByFirstValueSchemaMergeNumericValues'

Defines how to select metrics when merging them together.

Request body

filterstring

Allows for filtering the collection of resources. The expression specified is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. See https://docs.microsoft.com/en-us/azure/search/query-odata-filter-orderby-syntax for details on the expression syntax.

continuationTokenstring

The continuation token to use for getting the next set of resources.

orderBystring

The comma separated list of resource properties to use for sorting the requested resources. Optionally, can be followed by either 'asc' or 'desc'

topinteger

The maximum number of items in the resource collection to be included in the result. If not specified, all items are returned.

Example request

{
  "orderBy": "Color, Size desc"
}

Response

The Run Metrics are returned successfully.

continuationTokenstring

The token used in retrieving the next page. If null, there are no additional pages.

nextLinkstring

The link to the next page constructed using the continuationToken. If null, there are no additional pages.