Skip to content

Commit 70b29e5

Browse files
piterclpitercl
committed
Update API to include searchLGlobalEntriesProto
1 parent cc5a80b commit 70b29e5

10 files changed

Lines changed: 685 additions & 89 deletions

File tree

‎codegen/proto/neptune_pb/ingest/v1/common.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ message Step {
2222
// ForkPoint is used to mark the parent and its last inherited state during Forking.
2323
message ForkPoint {
2424
// Optional. Parent project qualified name. If not set, it will default to the context project.
25-
string parent_project = 1;
25+
optional string parent_project = 1;
2626
// Required. The id of the parent run within the parent project.
2727
string parent_run_id = 2;
2828
// Fork Step, which is the last step that a new run will inherit from its parent.

‎codegen/redocly.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ apis:
1313
filter-in:
1414
property: operationId
1515
value: [
16+
searchLGlobalEntriesProto,
1617
getAttributesWithPathsFilterProto,
1718
getMultipleFloatSeriesValuesProto,
1819
getSeriesValuesProto,

‎codegen/swagger/retrieval.json‎

Lines changed: 214 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -303,6 +303,62 @@
303303
"deprecated" : false
304304
}
305305
},
306+
"/api/leaderboard/v1/attributes/listForRuns" : {
307+
"post" : {
308+
"summary" : "Get attributes for runs and experiments",
309+
"operationId" : "getAttributesForRunsAndExperiments",
310+
"consumes" : [ "application/json" ],
311+
"produces" : [ "application/json" ],
312+
"parameters" : [ {
313+
"name" : "X-Neptune-Client-Metadata",
314+
"in" : "header",
315+
"description" : "Custom metadata header for Neptune client information (max 200 characters)",
316+
"required" : false,
317+
"type" : "string"
318+
}, {
319+
"in" : "body",
320+
"name" : "attributeQuery",
321+
"description" : "attributeQuery",
322+
"required" : true,
323+
"schema" : {
324+
"$ref" : "#/definitions/RunsAttributesQueryDTO"
325+
}
326+
} ],
327+
"responses" : {
328+
"200" : {
329+
"description" : "OK",
330+
"schema" : {
331+
"$ref" : "#/definitions/RunsAttributesDTO"
332+
}
333+
},
334+
"400" : {
335+
"description" : "Bad Request"
336+
},
337+
"401" : {
338+
"description" : "Unauthorized"
339+
},
340+
"403" : {
341+
"description" : "Forbidden"
342+
},
343+
"404" : {
344+
"description" : "Not Found"
345+
},
346+
"408" : {
347+
"description" : "Request Timeout"
348+
},
349+
"409" : {
350+
"description" : "Conflict"
351+
},
352+
"422" : {
353+
"description" : "Unprocessable Entity"
354+
},
355+
"429" : {
356+
"description" : "Too Many Requests"
357+
}
358+
},
359+
"deprecated" : false
360+
}
361+
},
306362
"/api/leaderboard/v1/attributes/operations" : {
307363
"post" : {
308364
"summary" : "Execute operations",
@@ -3470,6 +3526,62 @@
34703526
"deprecated" : false
34713527
}
34723528
},
3529+
"/api/leaderboard/v1/proto/leaderboard/entries/global/search/" : {
3530+
"post" : {
3531+
"summary" : "Search global runs",
3532+
"operationId" : "searchLGlobalEntriesProto",
3533+
"consumes" : [ "application/json" ],
3534+
"produces" : [ "application/json", "application/x-protobuf" ],
3535+
"parameters" : [ {
3536+
"name" : "X-Neptune-Client-Metadata",
3537+
"in" : "header",
3538+
"description" : "Custom metadata header for Neptune client information (max 200 characters)",
3539+
"required" : false,
3540+
"type" : "string"
3541+
}, {
3542+
"in" : "body",
3543+
"name" : "params",
3544+
"description" : "params",
3545+
"required" : true,
3546+
"schema" : {
3547+
"$ref" : "#/definitions/GlobalSearchParamsDTO"
3548+
}
3549+
} ],
3550+
"responses" : {
3551+
"200" : {
3552+
"description" : "OK",
3553+
"schema" : {
3554+
"$ref" : "#/definitions/ProtoLeaderboardEntriesSearchResultDTO"
3555+
}
3556+
},
3557+
"400" : {
3558+
"description" : "Bad Request"
3559+
},
3560+
"401" : {
3561+
"description" : "Unauthorized"
3562+
},
3563+
"403" : {
3564+
"description" : "Forbidden"
3565+
},
3566+
"404" : {
3567+
"description" : "Not Found"
3568+
},
3569+
"408" : {
3570+
"description" : "Request Timeout"
3571+
},
3572+
"409" : {
3573+
"description" : "Conflict"
3574+
},
3575+
"422" : {
3576+
"description" : "Unprocessable Entity"
3577+
},
3578+
"429" : {
3579+
"description" : "Too Many Requests"
3580+
}
3581+
},
3582+
"deprecated" : false
3583+
}
3584+
},
34733585
"/api/leaderboard/v1/proto/leaderboard/entries/search/" : {
34743586
"post" : {
34753587
"summary" : "Get leaderboard",
@@ -5677,6 +5789,23 @@
56775789
},
56785790
"title" : "DoubleOrInfinity"
56795791
},
5792+
"EntryAttributesDTO" : {
5793+
"type" : "object",
5794+
"required" : [ "attributes", "experimentId" ],
5795+
"properties" : {
5796+
"attributes" : {
5797+
"type" : "array",
5798+
"items" : {
5799+
"$ref" : "#/definitions/AttributeDTO"
5800+
}
5801+
},
5802+
"experimentId" : {
5803+
"type" : "string",
5804+
"format" : "uuid"
5805+
}
5806+
},
5807+
"title" : "EntryAttributesDTO"
5808+
},
56805809
"EpochMillis" : {
56815810
"type" : "object",
56825811
"title" : "EpochMillis"
@@ -6087,6 +6216,24 @@
60876216
},
60886217
"title" : "GitInfoDTO"
60896218
},
6219+
"GlobalSearchParamsDTO" : {
6220+
"type" : "object",
6221+
"properties" : {
6222+
"experimentLeader" : {
6223+
"type" : "boolean"
6224+
},
6225+
"pagination" : {
6226+
"$ref" : "#/definitions/QueryLeaderboardParamsPaginationDTO"
6227+
},
6228+
"query" : {
6229+
"$ref" : "#/definitions/NqlQueryParamsDTO"
6230+
},
6231+
"sorting" : {
6232+
"$ref" : "#/definitions/QueryLeaderboardParamsSortingParamsDTO"
6233+
}
6234+
},
6235+
"title" : "GlobalSearchParamsDTO"
6236+
},
60906237
"HistogramDTO" : {
60916238
"type" : "object",
60926239
"properties" : {
@@ -7877,6 +8024,72 @@
78778024
},
78788025
"title" : "RunListDTO"
78798026
},
8027+
"RunsAttributesDTO" : {
8028+
"type" : "object",
8029+
"required" : [ "organizationId", "organizationName", "projectId", "projectName" ],
8030+
"properties" : {
8031+
"experimentsAttributes" : {
8032+
"type" : "object",
8033+
"description" : "Map of experiment name to its attributes",
8034+
"additionalProperties" : {
8035+
"$ref" : "#/definitions/EntryAttributesDTO"
8036+
}
8037+
},
8038+
"organizationId" : {
8039+
"type" : "string",
8040+
"format" : "uuid"
8041+
},
8042+
"organizationName" : {
8043+
"type" : "string"
8044+
},
8045+
"projectId" : {
8046+
"type" : "string",
8047+
"format" : "uuid"
8048+
},
8049+
"projectName" : {
8050+
"type" : "string"
8051+
},
8052+
"runsAttributes" : {
8053+
"type" : "object",
8054+
"description" : "Map of run id to its attributes",
8055+
"additionalProperties" : {
8056+
"$ref" : "#/definitions/EntryAttributesDTO"
8057+
}
8058+
}
8059+
},
8060+
"title" : "RunsAttributesDTO"
8061+
},
8062+
"RunsAttributesQueryDTO" : {
8063+
"type" : "object",
8064+
"required" : [ "attributePathsFilter", "projectIdentifier" ],
8065+
"properties" : {
8066+
"attributePathsFilter" : {
8067+
"type" : "array",
8068+
"description" : "Filter attribute paths",
8069+
"items" : {
8070+
"type" : "string"
8071+
}
8072+
},
8073+
"experimentNames" : {
8074+
"type" : "array",
8075+
"description" : "List of experiment names",
8076+
"items" : {
8077+
"type" : "string"
8078+
}
8079+
},
8080+
"projectIdentifier" : {
8081+
"type" : "string"
8082+
},
8083+
"runsIds" : {
8084+
"type" : "array",
8085+
"description" : "List of run ids",
8086+
"items" : {
8087+
"type" : "string"
8088+
}
8089+
}
8090+
},
8091+
"title" : "RunsAttributesQueryDTO"
8092+
},
78808093
"Scale" : {
78818094
"type" : "object",
78828095
"properties" : {
@@ -7956,7 +8169,6 @@
79568169
},
79578170
"SearchUserRunsParamsDTO" : {
79588171
"type" : "object",
7959-
"required" : [ "username" ],
79608172
"properties" : {
79618173
"experimentLeader" : {
79628174
"type" : "boolean"
@@ -8936,7 +9148,7 @@
89369148
},
89379149
"type" : {
89389150
"type" : "string",
8939-
"enum" : [ "chart", "valueList", "file", "fileSet", "image", "imageComparison", "interactiveTable", "gallery", "notebook", "scatterPlot", "singleValue", "table", "textNode", "section", "dynamicSection", "histogram", "fileSeries" ]
9151+
"enum" : [ "chart", "valueList", "file", "fileSet", "image", "imageComparison", "interactiveTable", "gallery", "notebook", "scatterPlot", "singleValue", "table", "textNode", "section", "dynamicSection", "histogram", "fileSeries", "userDefinedFunction" ]
89409152
}
89419153
},
89429154
"title" : "WidgetDTO"

0 commit comments

Comments
 (0)