{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-machinelearningservices-runhistory","description":"Run History APIs","version":"2019-09-30","base_url":"","endpoints":26,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Run History APIs\n@version 2019-09-30\n@auth OAuth2\n@common_fields {subscriptionId: any # The Azure Subscription ID., resourceGroupName: any # The Name of the resource group in which the workspace is located., workspaceName: any # The name of the workspace.}\n@endpoints 26\n@hint download_for_search\n@toc history(26)\n\n@endpoint POST /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/batch/events\n@desc Batch post event data.\n@required {experimentName: any # The experiment name.}\n@optional {batchEventCommand: map # The batch of Event details.}\n@returns(200) The batch of Events is posted successfully.\n\n@endpoint POST /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/events\n@desc Post event data.\n@required {experimentName: any # The experiment name., runId: any # The identifier of the Run.}\n@optional {eventMessage: map # The Event details.}\n@returns(200) The Event is posted successfully.\n\n@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}\n@desc Get details of an Experiment.\n@required {experimentName: any # The experiment name.}\n@returns(200) The details of the Experiment are returned successfully.\n\n@endpoint POST /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}\n@desc Create an Experiment.\n@required {experimentName: any # The experiment name.}\n@returns(200) The Experiment is created successfully.\n\n@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}\n@desc Get details of an Experiment.\n@required {experimentId: any # The identifier of the experiment.}\n@returns(200) Success\n\n@endpoint PATCH /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}\n@desc Update details of an Experiment.\n@required {experimentId: any # The identifier of the experiment.}\n@optional {modifyExperimentDto: map # Experiment details which needs to be updated.}\n@returns(200) Success\n\n@endpoint POST /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments:query\n@desc Get all Experiments in a specific workspace.\n@optional {queryParams: map # Query parameters for data sorting and filtering.}\n@returns(200) Success\n\n@endpoint DELETE /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/tags\n@desc Delete list of Tags in an Experiment.\n@required {experimentId: any # The identifier of the experiment.}\n@optional {tags: map # The requested tags list to be deleted.}\n@returns(200) Success\n\n@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/children\n@desc Get details of all child runs.\n@required {experimentName: any # The experiment name., runId: any # The identifier of the Run.}\n@optional {$filter: any # Allows for filtering the collection of resources.\r 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., $continuationtoken: any # The continuation token to use for getting the next set of resources., $orderby: any # The list of resource properties to use for sorting the requested resources., $sortorder: any # The sort order of the returned resources. Not used, specify asc or desc after each property name in the OrderBy parameter., $top: any # The maximum number of items in the resource collection to be included in the result.\r If not specified, all items are returned., $count: any # Whether to include a count of the matching resources along with the resources returned in the response.}\n@returns(200) The details of the child Runs are returned successfully.\n\n@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/details\n@desc Get Run Details.\n@required {experimentName: any # The experiment name., runId: any # The identifier of the Run.}\n@returns(200) The details of the Run are returned successfully.\n\n@endpoint PATCH /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/batch/runs\n@desc Add or Modify a batch of Runs.\n@required {experimentName: any # The experiment name.}\n@optional {requestDto: map # The list of requested Run Additions/modifications in an Experiment.}\n@returns(200) The Batch Runs are added/modified successfully.\n\n@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}\n@desc Get Run details.\n@required {experimentName: any # The experiment name., runId: any # The identifier of the Run.}\n@returns(200) The details of the Run are returned successfully.\n\n@endpoint PATCH /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}\n@desc Add or Modify a Run.\n@required {experimentName: any # The experiment name., runId: any # The identifier of the Run.}\n@optional {createRunDto: map # The requested Run parameter Additions/modifications.}\n@returns(200) The Run is added/modified successfully.\n\n@endpoint DELETE /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/tags\n@desc Delete list of Tags in a Run.\n@required {experimentName: any # The experiment name., runId: any # The identifier of the Run.}\n@optional {tags: [str] # The requested tags list to be deleted.}\n@returns(200) Success\n\n@endpoint POST /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs:query\n@desc Get all Runs for a specific Experiment.\n@required {experimentName: any # The experiment name.}\n@optional {queryParams: map # Query parameters for data sorting and filtering.}\n@returns(200) Success\n\n@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts\n@desc Get Artifacts in a container.\n@required {experimentName: any # The experiment name., runId: any # The identifier of the Run.}\n@optional {continuationToken: any # The Continuation Token.}\n@returns(200) The Artifacts in Container are returned successfully.\n\n@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/path\n@desc Get Artifacts in the provided path.\n@required {experimentName: any # The experiment name., runId: any # The identifier of the Run.}\n@optional {path: any # The Artifact Path., continuationToken: any # The Continuation Token.}\n@returns(200) Success\n\n@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/metadata\n@desc Get Artifact by Id.\n@required {experimentName: any # The experiment name., runId: any # The identifier of the Run.}\n@optional {path: any # The Artifact Path.}\n@returns(200) Success\n\n@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/contentinfo\n@desc Get Artifact content information.\n@required {experimentName: any # The experiment name., runId: any # The identifier of the Run.}\n@optional {path: any # The Artifact Path.}\n@returns(200) The Artifact content information is returned successfully.\n\n@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/artifacturi\n@desc Get URI of an Artifact.\n@required {experimentName: any # The experiment name., runId: any # The identifier of the Run.}\n@optional {path: any # The Artifact Path.}\n@returns(200) Success\n\n@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/prefix/contentinfo\n@desc Get SAS of an Artifact.\n@required {experimentName: any # The experiment name., runId: any # The identifier of the Run.}\n@optional {path: any # The Artifact Path., continuationToken: any # The Continuation Token.}\n@returns(200) Success\n\n@endpoint POST /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/batch/metadata\n@desc Create a batch of empty Artifacts.\n@required {experimentName: any # The experiment name., runId: any # The identifier of the Run.}\n@optional {artifactPaths: map # The list of artifact paths.}\n@returns(200) The Batch Artifacts are created successfully.\n\n@endpoint POST /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/metrics\n@desc Post Metric to a Run.\n@required {experimentName: any # The experiment name., runId: any # The identifier for a run.}\n@optional {metricDto: map # Details of the metric which will be added to the Run Id.}\n@returns(200) The Run Metric is posted successfully.\n\n@endpoint POST /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/batch/metrics\n@desc Post Metrics to a Run.\n@required {experimentName: any # The experiment name., runId: any # The identifier for a run.}\n@optional {batchMetricDto: map # Details of the Metrics which will be added to the Run Id.}\n@returns(200) The Run Metrics are posted successfully.\n\n@endpoint GET /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/metrics/{metricId}\n@desc Get Metric details.\n@required {experimentName: any # The experiment name., metricId: any # The identifier for a Metric.}\n@returns(200) Success\n\n@endpoint POST /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/metrics:query\n@desc Get all Run Metrics for the specific Experiment.\n@required {experimentName: any # The experiment name.}\n@optional {queryParams: map # Query Parameters for data sorting and filtering., MergeStrategyType: any # The type of merge strategy. Currently supported strategies are:\r None - all logged values are returned as individual metrics.\r MergeToVector - merges multiple values into a vector of values.\r Default - the system determines the behavior., MergeStrategyOptions: any # Controls behavior of the merge strategy in certain cases; e.g. when a metric is not merged., MergeStrategySettings.Version: any # The strategy settings version., MergeStrategySettings.SelectMetrics: any # Defines how to select metrics when merging them together.}\n@returns(200) The Run Metrics are returned successfully.\n\n@end\n"}