From 5a82a59ef4f724d5c00e6df327a047be2c9f9012 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 18 Dec 2024 18:24:00 +0000 Subject: [PATCH] Update OpenAPI spec and generate new API docs --- website/docs/api/clone-dataset.api.mdx | 11 +- website/docs/api/create-dataset.api.mdx | 11 +- website/docs/api/create-project.api.mdx | 304 +++++++++++++++ website/docs/api/get-project.api.mdx | 286 +++++++++++++++ website/docs/api/list-datasets.api.mdx | 21 +- website/docs/api/list-projects.api.mdx | 346 ++++++++++++++++++ .../schemas/clonedatasetrequest.schema.mdx | 9 + .../schemas/createdatasetrequest.schema.mdx | 9 + .../schemas/createprojectrequest.schema.mdx | 58 +++ .../schemas/createprojectresponse.schema.mdx | 150 ++++++++ .../api/schemas/getprojectrequest.schema.mdx | 40 ++ .../api/schemas/getprojectresponse.schema.mdx | 150 ++++++++ .../schemas/listdatasetsrequest.schema.mdx | 19 +- .../listdatasetsrequestfilters.schema.mdx | 13 +- .../schemas/listprojectsrequest.schema.mdx | 79 ++++ .../listprojectsrequestfilters.schema.mdx | 49 +++ .../schemas/listprojectsresponse.schema.mdx | 171 +++++++++ website/docs/api/schemas/project.schema.mdx | 112 ++++++ website/docs/api/sidebar.ts | 72 ++++ website/static/open_api/2/model.json | 2 +- 20 files changed, 1904 insertions(+), 8 deletions(-) create mode 100644 website/docs/api/create-project.api.mdx create mode 100644 website/docs/api/get-project.api.mdx create mode 100644 website/docs/api/list-projects.api.mdx create mode 100644 website/docs/api/schemas/createprojectrequest.schema.mdx create mode 100644 website/docs/api/schemas/createprojectresponse.schema.mdx create mode 100644 website/docs/api/schemas/getprojectrequest.schema.mdx create mode 100644 website/docs/api/schemas/getprojectresponse.schema.mdx create mode 100644 website/docs/api/schemas/listprojectsrequest.schema.mdx create mode 100644 website/docs/api/schemas/listprojectsrequestfilters.schema.mdx create mode 100644 website/docs/api/schemas/listprojectsresponse.schema.mdx create mode 100644 website/docs/api/schemas/project.schema.mdx diff --git a/website/docs/api/clone-dataset.api.mdx b/website/docs/api/clone-dataset.api.mdx index e4e5079a..10823148 100644 --- a/website/docs/api/clone-dataset.api.mdx +++ b/website/docs/api/clone-dataset.api.mdx @@ -2,7 +2,7 @@ id: clone-dataset title: "Clone Dataset" description: "Clone a dataset into a new dataset containing the latest file contents" -api: eJy9V8Fy2zYQ/RUMzrSU8ZE3xUmm6qSpx1bag63JQORKhA0CCLC0rHL4750FSIkiJdtpm140FLG7eLt4u3yoOYqN5+kd/yBQeEC+TLix4ARKo+c5T/mVMhq61YTn4DMnLS13i0ywPK4zqdEwwTRs968yo1FILfWGYQFMCQSPbC0VhCXQ6HnCPWSVk7jj6V3N34Nw4GYVFjy9WzbLhDv4XoHH9ybf8bTmrSM9CmuVzALc6YMnUDX3WQGloCeUqGCQxE2MxROOO0uLZvUAGf23jlJHCZ582wSoCHVn6tFJvRmVoY3M0LCMduJNwrUo4XXPL71KkceEzddMG2TWmSeZQ56wrVSKVR5C+ciGmXV47vxWIPXmXsetc9r7aI/XIPxSlUJfOBC5WClgvcXBRpN7/U/R7bE18Sylg5xYd6jxsmniordG+3gCl+/ehYM4gntbZRl4v64U2xOVJ/+WEnHXt3KiH+fQGi+7yjfwaFEAm38Ylp1ONHMgEPIZngqyNq4UyFOCBxcoy0DAyuY/6vI2zg4IEw59bVwfc8LkmtFogGfp0U9+HilP7WS2GtxXD+4tvXtc88qDY9vCMLPVfnQKuipvzNb3gkqNsAHXLl4ZdWZRaolSKPlXoOUtCqz8GNvI8KNzxp20y4yqSt2PIZwTO55wiVD6cd9Qnq0Tsw48aBrX/ZncMvkTjeZ4ntJ36RO9jwl/FWLN9dr8POqHz8T/yH+pc3g+cYBDsHOy67DGorKtxKKt5wi9kghOqC9vai+qROtw3Ftxo9hLMcSIF4PxKnPeL12/Jl2yx+CWFEGJFSiiKJxmkaelLvuWO8GHBv2DWQ2HwZg7nw87vMadLvC5ljlVPR9sBwg3oENJrYcqNxcvAm4CitLiAkqr2kK8vK94FHF4dPtI7dFVGS17CginW3kYR3agW3htLtKzECCJXbmWoHJWil0nr5jQ0YCV4L3YwIgLg0KOMlz+EHn6I/YwFw9D8MzEO8yt5TDxWTd/uqlUGo9sJbzMmAftIWUloKAjYkLnLCDwhbQJW1VIqqQIGlNCfq9JiUmM02tyTnVEzdEkvAQsDGlda4IutIKUJ58KK6eXU1Gh+QZPQk1bv2nUeCRa3RM4HzRr5RRPeYFofTqdKuGxlAqEnOTwNDrka2fySA0WY7AL9ll4/I1G72zOSfJ2iviWlEvshb4u3vOItiQswYynfBWMeNI+fOoG3a9/LkIhSBHdHOT0x2dRWgUDwXtgZ5QE59ja/26tTV8W9dJhs+s5++Ny5Dw2SdmVKa3R7aWAihtNLyfvQlMaj6UI8qHFFS8gZ64nvYvCf3dTacuO8IxTq4TU4VtDp1+3xLnjwkqecMp4Tx7CtkcZCbRMeEGES+94Xa+Eh69ONQ29/l6Bo6vQMuFPwkmSQOEmlPACRA4uMO4RdpRXRHaxIFhkrqogBoYauEk6j1mWgcUXbZe9nrj+/XZBbGqvXqXJyceJLU/Cb8ppHNg459I6vqO5rTcVzaGUx5jEPXFM3QFVQ1admNG7HsK6jhYL8wi6aXjSpoL0nzfUx38DC1gm0Q== +api: eJy9V0tz2zYQ/isYnGkr4yNvjpNM1UlTj+20B1uTWZErCTYIIMDSsqrhf+8sQEoUKT/SNr1oKO578e3yw1YSLIPMb+UHIAhIcpZJ69ADKWumpczlhbYGO2kmSwyFV47FnVCAKJNcKENWgDC43r0qrCFQRpmloBUKDYSBxEJpjCI0FGQmAxa1V7SR+e1Wvkfw6M9rWsn8dtbMMunxe42B3ttyI/OtbA35EZzTqojpTu4DJ7WVoVhhBfxEijQOirhKvmQmaeNYaOf3WPB/57l0UhjYti2Am7DtVAN5ZZajNrSeBVlRcCTZZNJAha9bful1ii1OxXQhjCXhvH1UJZaZWCutRR0wto91hF3E585ujsos70wKXXLsgxivpfBLXYE58QglzDWKnnAQ6PTO/NPserk5b7ndb2nrzQpFq86thbJMUXo9IyubJuFDeSwZyftzmzVNEgZnTUinevbuXTzcg0DXdVFgCItaix34ZfZvYZaivhVnfT/7cXvZVL2xidMPw6Pkkyg8AmF5TsecLKyvgGTO6eEJqSqCunblj5q8bQ4GIIxAWljfzzkTaiF43eCTChROfx7Qj0Wya4P+a0D/VuDue14H9GK9ssKuTRidgqmrK7sOPafKEC7Rt8ILq58RKqNIgVZ/RVheE1AdxrmNFD96b/1RvcLqujJ9H+A9bGQmFWEVxnPDdbZGwnkMaPgT0N/zLZI/8bpP56lCVz7D+xDwF9HX1Czsz4N+/PT8j/hXpsSnIwc4THbKel2uqalirWjV9nOUvVaEHvSXN40Xd6I1OJytFCjNUnIxwsVgvapS9lvX70lX7GFyM/agYY6aIYrHURRY1FXfYifa8Mfj3s6Hy2CMnc/7CK9hp3P83Mgc616IuoMMl2hiS13AurQnLyacPn2VoxusnG4b8XJceIC0PLo4ygTydcHiwA7x+CgP/agu6Ta9thYVRHSQpalcKNSlqGDTUTYBJimICkOAJY6wMGjkqMLZD4Gnv2L3e3G/BJ/ZePu9NRsWft7tn24rVTaQmENQhQhoAuaiQgI+IgGmFDGDsFIuE/OamOmsIm9VWN4ZpiCK0vY6fY51JM7RZLJCWlnmz85GrumA2aycgFOTswnUZL/hI+hJazdJvJGJsH9EHyIPrr2WuVwRuZBPJhoCVUojqNMSH0eHfOltmaAhkg9xIj5DoN949Z5PJdPojmVfM3NJs9Dn2jsccUjOJarJXM6jkszah0/dovv1z5vYCGZEV3uK/vEJKqdxQKL36EyU4Dm07l73mOLBx2xh+1ypV6M4v5yKP85GHscqubiwlbOmvX1wx5Pq2em7OKk2UAWRU7TJppvOM/eg3o3kv7sStWdB+EQTp0GZ+AFiSGxbNN1KcEpmkiveIYpz22WZUDXL5IpRmN/K7XYOAb963TT8+nuNnu9cs0w+glfMi+KVK5MrhBJ9hOEDbriulNnJDafF6rqODGFIjJusszgvCnT0ou6sNyiXv1/fMMTaO15lS7bxsJZZ/M0l7wiXll++Te94mZtlzcspl8knAxIO8TzAb6yqYzhm08twu00aN/YBTdPIrC2F+L9seLj/Bn8ZS0U= sidebar_class_name: "post api-method" info_path: api/lastmile-ai-api-v-2 custom_edit_url: null @@ -105,6 +105,15 @@ Clone a dataset into a new dataset containing the latest file contents schema={{"type":"string","description":"Human-readable description of the dataset.\n If not provided, will use the name of the dataset being cloned"}} > + + diff --git a/website/docs/api/create-dataset.api.mdx b/website/docs/api/create-dataset.api.mdx index e10cce6a..a247206c 100644 --- a/website/docs/api/create-dataset.api.mdx +++ b/website/docs/api/create-dataset.api.mdx @@ -2,7 +2,7 @@ id: create-dataset title: "Create Dataset" description: "Create a new Dataset. Use UploadDatasetFile to upload files to the dataset." -api: eJzdWEtv2zgQ/isD7iEJoNhFji56cNMU627aBrWze4iNgJbGNluKVMlRHK+h/74YUrIVK2ka7OOwl9gmh8OZj9+8shUkl14MbsQ7SdIjiVkibIFOkrJmlImBOHcoCZvtRGToU6cK3t/tggSDa6iFenDtEa4LbWVWL71XGoEslGERFkqj59+0QsjqUyIRHtPSKdqIwc1WvEXp0A1LWonBzayaJcLh9xI9vbXZRgy2IrWG0BB/lUWhVRqM7n/1bNlW+HSFueRvpEjjoStfojKRCNoUvGvnXzHl34VjBEih58NG5hiURClPTpllB4dfy1yaU4cyk3ONwIdgYV3bwQTUAqxBwHvlyfdEdaDkhXe0NsEunrtJ+fe4Hq8sXdzLvNDRt/q+ubUapelceOWxzOylnKOGr3YOC4U6a9QNU1J3GDYf01UderenyrudlUaRklpvQBrAvKAN+BVqDaUhpUEGnoDyNW0wE1XFeh36whoffTh79Yo/Ht41LtMUvV+UGnZsFsnfZky89lnK1M/QVrSPnx8fVdnzPJisEEbvDt48vEoazM2G9JiShXW5JDFg8/CUVI58pCyylx75n0SEXRt01x7d6MWYlx4drFcW7Nr4ziuYMv9i1+2gUIZwia7ePLf6ic06INSfgZdjklT6rm0dwQvnrHtULrW6zE1bh3RObkQiFGHuu4HDftaHoHDo0RAoE1zUktATtDN6fE/lG/eZ3g8Jfx50jczC/nvUD2niP+S/MhneP/KAh8aOWK6xNYIKa0WrGs+O9VoROqk//VR4MRL1gYexFS+KsRRVdHhRxVKqHGZc+lUm2tC1MWmcfWjcjDVozvxMUXycRZ63Gu9r7oQzyixjNXmYDLrcudzf8Bx3GsVPhcxj6Pkge2DhEk2AtAil7/SHBlfBirygCeaFroH48b3ym4zJo7lHGU+uTHnbs0J8PJQP9ajG6Nq82hflIShIYlSGeg253AAXPqlMqLMsADl6L5fY4cIBkB0PZy8iTzvF7vPiPgk+kfH2eWt26PiwyT9NVsqtJ5hLr1LwaDwOIEeS/EQgTQbBAr9SRQLzksBYDr8lkMJsargDVRSzV68DRfPMsyp2Hfenqc1w3HRPN8w6sxQD8UHeyXGwkVtYW7o0ZIW8sI7gUnrKQ650NocjXf88ej01U5Na4wlSrTjNvgk9dCN/vJ0agHnogSf2G5oBFM5yU9NDc3dzdDkcTz6OLi9uh1ej28nn3y4+Hc0S6Pdhwi+v6qqEC1lqCkik0sAcweaKiJ2vToIJ0m9MCovSBA5CLpU5PoFwebSuSVNvQK6laqzt1cu+F9/+OGqLh6zGnrbL46Yo1p8sUrFUvOS1qJIdhlcbWoUW7RA/66cmQNcgBwfABhwbBHfosSkNfLfE+L2xATnlrOktkY6nogvhVJwkAL/8NIYnU7OH5ylgpqZwylAHDcEjTY60sjxmFTbMIoXkcUf0ZaH6Z31Zkr3FO6n79aF+VBpGJXeHLvKwdFoMxIqo8IN+vwFKql6Gd92m3tksJhyIOuA0wPaRsR2OglXNHDbmhjhm2PY0tstOfCXbEsS4+Q9CIqm/vG/K54c/JiG8uNH+sh/i6lFkP2U9le52y49MMeRK7M4jvBpK9cK22/CWozC8GsHvZ527uiIDOLd5YQ0a4tzEsEfRs96rUASsp1yalhv1qPPE0NyaXP/h+bl+FsJ76hdaKhM6HGbHtmbWjZCFEolgv3fsYgN3ptYMmyVixZQc3Ijtdi49XjtdVbz8vUTHE/osEXfSKe68w4CeiBXKDF2g5DfcsHfRz9MJ28Xiugw96OHsxYkgnhimKYY8+rRsO2quPo8nTLf6PwK5zfiMk2uRhL8DwVWoiOV1sI1rMemUXP4GIupkcsqH3D7gcvCq6aHNpmXhdtvK0lUlktqVkHVExeXjL8irEYI= +api: eJzdWEtv2zgQ/isD7iEJoNhFji56cNMUm27aBrWze4iNgJbGNluKVMlRHK+h/74YUrIVy2lS7OOwl8Qmh8OZj9+8vBEkF14MbsU7SdIjiWkibIFOkrLmMhMDce5QEjbbicjQp04VvL/dBQkGV1AL9eDGI9wU2sqsXnqvNAJZKMMizJVGz99piZDVp0QiPKalU7QWg9uNeIvSoRuWtBSD22k1TYTD7yV6emuztRhsRGoNoSH+KItCqzQY3f/q2bKN8OkSc8mfSJHGfVe+RGUiEbQueNfOvmLK3wvHCJBCz4eNzDEoiVKenDKLDg6/lrk0pw5lJmcagQ/B3Lq2gwmoOViDgA/Kk++Jak/JT97R2gQ7f+4m5d/jarS0dPEg80JH3+r7ZtZqlKZz4bXHMrNXcoYavtoZzBXqrFE3TEndY9g8pKsKODKizKLnXBsvEWpxpoXMsuAPk6r2CciKah+xHf3ebT03ipTUeg3SAOYFrcEvUWsoDSkNMnAPlK+piJmoKtbr0BfW+IjL2atX/O/xXaMyTdH7ealhGyEi+dssjNc+S8MahraiXUz++Kh64QNcvtvjUXjpNJibDemQkrl1uSQxYPPwlFSOfKQssp898j+JMrsy6G48upeSfod56dHBamnBrozvvIIp8y921Q40ZQgX6OrNc6uf2KwDQv0ZeDkiSaXv2tYRvHDOuoNyqdVlbto6pHNyLRKhCHPfDRz2sz4EhUOPhkCZ4KKWhJ6gXSXieyrfuM/0fkz486Dr0sztv0f9kCb+Q/4rk+HDgQfcN/aS5RpbI6iwUrSs8exYrxWhk/rTi8KLkagPPI6teFGMpaiiw4sqlmflMON2QmWiDV0bk8bZx8ZNWYPmasIUxcMs8rzVeF9zJ5xRZhEr1ONk0OXO1e6G57jTKH4qZA6h54PsnoULNAHSIpTT0x8aHMtmXtAY80LXQPz4XvlNxuTR3KOMJ1emvO1ZIR4O5X09qjG6Nq/2RXkICpIYlaEHgFyugQufVCbUWRaAHL2XC+xwYQ/IjofTnyJPO8Xu8uIuCT6R8XZ5a7rv+LDJP01Wyq0nmEmvUvBoPA4gR5L8RCBNBsECv1RFArOSwFgOvwWQwmxiuH1RFLNXrwNF88zTKnYdD6epzXDUdGS3zDqzEAPxQd7LUbCR22JbujRkhbywjuBKespDrnQ2hyNdfz16PTETk1rjCVKtOM2+CS1UI3+8mRiAWeirx/YbmgE3XdzU9NDc3x5dDUfjj5dXF3fD68u78effLj4dTRPo92HML6/qqoRzWWoKSKTSwAzB5oqIna9OggnSr00K89IEDkIulTk+gXB5tK5JU29ArqRqrO3Vy74X3/44aouHrMaetovjpijW/1mkYql4yWtRJVsMr9e0DC3aPn7WT0yArkEO9oANODYIbtFjUxr47ojxe2MDcspZ01sgHU9EF8KJOEkAfnkxhicTs4PnKWAmpnDKUAcNwWNSjrS0PLoVNsw3heQRSvRlofpnfVmSvcN7qfv1oX5UGsYvd48u8rB0WgzEkqjwg36/AUqqXob33UHB2SwmHIg64DTA9pGxHV4Gq5rZbsQNccyw7Qlvm534SrYliPFAEYREUn9435TPD3+MQ3hxo/1lNxjW481ucnsq3W2XD0xG5ErszjhxtTXVPGqe5rbdm7e8h+H1Jfx+1jGgKzKAc5sX1qAhTlj8FlH0rPcqVAbrKZem5Vs9/zwxnbdG5H94UK/fivCB+oWWKsx7gTKbmm63QhZKJIL93lKODdyaWtNumogl83RwKzabmfR443RV8fL3Eh3/FDBNxL10itvx8EtAIpYoM3SBp99wzd5FP0/HbBeL6zI0pvsDGWeHeGKYphiS69Oy7VC6/jwaMwfrnx5ym/EZJ1ciCX8HgktTEWvuYBPXYiYquSYORNTJjJWPCb9H8OBV01ibdcvCzaaVuqtKJLUrIRWJimvKX8xjNfY= sidebar_class_name: "post api-method" info_path: api/lastmile-ai-api-v-2 custom_edit_url: null @@ -114,6 +114,15 @@ Create a new Dataset. Use UploadDatasetFile to upload files to the dataset. schema={{"type":"boolean"}} > + + diff --git a/website/docs/api/create-project.api.mdx b/website/docs/api/create-project.api.mdx new file mode 100644 index 00000000..1261ea1f --- /dev/null +++ b/website/docs/api/create-project.api.mdx @@ -0,0 +1,304 @@ +--- +id: create-project +title: "Create Project" +description: "Create a new Project" +api: eJylVU1P20AQ/SurOS8YcfQtVK1K1RYEtD1EUTWxJ8mCvbvsjoHU8n+vZu0kbgKlqJfE9s73e/O2BcZlhHwKl8HdUsEw0+A8BWTj7HkJObwLhEybYw0lxSIYL+fbU4XK0qPaGUUqmmB4Dfm0hTPCQGHS8Ary6aybaQh031DkM1euIW+hcJbJsjyi95UpUvbsNkqKFmKxohrliQ1XtF/TVR8MNPDay6mbD1X4IK2woSjOFmtKQXqryMHY5UFDH5sa7VEgLHFekRIntXBB8YqU7xNqZRbKWVL0ZCLHY+j2grwxx+hQucVrmVxYojW/tgC9luxiZK/YKYzRFUZAGyVSj4ZXKdsAwLwi6Pb72qG9QbrrxChQ9M7GfsynJyfy96fjdVMUFOOiqdSWXaD/G/g+7avID02OA+2o+ndX88yEOw1FqqOc8HPzX7hQI0MOJTIdsalJXBpfvtWlpIre6JIKc+E5YnT6hRV4jb7/QLo9k6/P5+n6zTeBSpEcU8J4kuMRDaXO9l02SM66nnk18cqJSnmXFMCjiAxk6E12mmHD7ic9YJUNflmfLQlUeKAQkz41oYIcVsw+5llWYeTaVITmuKSHg3W6DK5sirRMfQx1pD5j5C+mIjU5B5G3jfpdC397Ho01cDsXSSm1JDPIYZ6MQA8PHzYIf/pxk4Yne3G1k873T1j7inba9pIEbD/vwziCz9iFGy/IqCc1uTxX308Pwh6a5Oqdq72zZDmCBplwb3p6fCJJBKUa7ajiQVFeuF5GV8NLN80wSqYnznyFxqZdE0TbgQ1TQG9AgzSwZUS/6EOMgRUzDSuhUT6Ftp1jpG+h6jr5fN9QkLtspuEBg0nqKFeZhhVhSSHR6I7WUmZf8NGN1CXmVSP1Hchbpzcek6Igz3+1nY2YfnlxfSMUGe7O2pXiE/ARdPrNQYBOA0zMS99aqNAuG1yKbR9TCIV/8nGPf6mr4QjtelRh2/YWN+6ObNeBHlpheYdOtvM3GhriVQ== +sidebar_class_name: "post api-method" +info_path: api/lastmile-ai-api-v-2 +custom_edit_url: null +show_extensions: true +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Heading from "@theme/Heading"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + + + + + + + + + + +Create a new Project + + + + + + +
+ +

+ Body +

+
+ +
    + + + + + + + +
+
+ +
+
+ + +
+ + + Successful operation + + +
+ + + + +
+ + + Schema + +
+ +
    + +
    + + + + project + + object + + + + required + + +
    + + + + + + + + + + + + + + + + + + + +
    +
    +     +
+
+ + + + + + + + +
+ + +
+
\ No newline at end of file diff --git a/website/docs/api/get-project.api.mdx b/website/docs/api/get-project.api.mdx new file mode 100644 index 00000000..2535361d --- /dev/null +++ b/website/docs/api/get-project.api.mdx @@ -0,0 +1,286 @@ +--- +id: get-project +title: "Get Project" +description: "Get a Project." +api: eJylVU1v2zAM/SsGz2pd5OhbWmxDhn0EbbYdAmNgbDZRa1uqRHfNDP/3gZKTOk22odslsUVSfCTfoztgXHvIljB35o4KhlyBseSQtWlmJWTwjnhnU1CSL5y2YoymBJPBeg4KPBWt07yFbNnBJaEjN215A9ky73MFjh5a8nxpyi1kHRSmYWpYHtHaShchaXrn5fIOfLGhGuWJNVd0AOU63gQKeGvFZFYDQusEPmvyEqnLEB99PDvdrKHvIxLtqJTKdQl538dTb03jY+jk4kL+Diu+aYuCvL9tq2TfJVD/V0nM+ddS7DCE0S3Pc/mHLigoHCFTOeVjq4Jb42pkyKBEpjPWNUlIa8vXhpRU0StDAjDjZqdhN1jTScPBqE7YjVtjo3/uqf0Xl0+n8xyzZ9zJcYsGqPnLkN0kA+t6BTXxxojUrAmUtiiSgRStTicptmy+0yNW6RCXromD1twjOR+k1roKMtgwW5+laYWea10R6vOSHo9UO3embAt5SeIdyVnyAT1/1BUl0xmIUndCvhHmRhKN5bxviqQULMENMlgFJ1DDw9vdeN9/W4TOiSKun7fAmyesbUU7jo4GoZtbM6b6CGAync+Sr5Ojuo5dsuTK1NY01LAHBdKu6Do5v5Ak0u8aA1kiqcJG+822G+2r48U3tIPpiVNboW6CWGQq3TDOJaDVoEBw70calTpkk7HmCjZCgmwJXbdCT19c1fdy/NCSk72aK3hEp3ElbVnmvYINYUku8OCetpDBVcR5thBQ4l61Au5oM/VqFzEtCrL8R998xNP555uFzHjY47UpJcbhD1DhNwOQr4hEB+qEsw4qbNYtrsU33imMwENCvSBQqGowYbMdIey66LEw99T0PaihFJZ36EVbvwA0GVhC +sidebar_class_name: "post api-method" +info_path: api/lastmile-ai-api-v-2 +custom_edit_url: null +show_extensions: true +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Heading from "@theme/Heading"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + + + + + + + + + + +Get a Project. + + + + + + +
+ +

+ Body +

+
+ +
    + + + +
+
+ +
+
+ + +
+ + + Successful operation + + +
+ + + + +
+ + + Schema + +
+ +
    + +
    + + + + project + + object + + + + required + + +
    + + + + + + + + + + + + + + + + + + + +
    +
    +     +
+
+ + + + + + + + +
+ + +
+
\ No newline at end of file diff --git a/website/docs/api/list-datasets.api.mdx b/website/docs/api/list-datasets.api.mdx index dc495423..7a0a7f98 100644 --- a/website/docs/api/list-datasets.api.mdx +++ b/website/docs/api/list-datasets.api.mdx @@ -2,7 +2,7 @@ id: list-datasets title: "List Datasets" description: "List Datasets." -api: eJy9V01v2zgQ/SsD7iEJoNhFjlr04KYp1t20DWp392AbAS2NLbYUqZKjOK7h/74YSooVyWkaLHZzSOxwOPP45nsnSK69iGfirSTpkcQiErZAJ0lZM05FLK6Vp/rQi0ik6BOnCj6uD6E5HYhIeExKp2gr4tlOvEHp0I1KykQ8W+wXkXD4vURPb2y6FfFOJNYQGuKPsii0SoLZ4VfPynfCJxnmkj+RIo0dMJ8rXSIStC340C6/YsLfC8dPIIWe766UJnT+GTXvaqnntH0v0QXstZgnp8y6R4xH6ZIMgjT4clmJQS4pyWBlHRiZI0iTQvvevv5honxhja9sXrx6xX8eW5iUSYLer0oNDw4T0b+ltLL6LAtpExAHIqRzcisioQjzR2Q3kfWcTpU+T+s0Qxi/BbsCyhBqFAOxj0TiUBKmIzqmZGVdLknEjBvPSeXIV8oifekV9trzKP8oc2nOHcpULjVWrmaftzBHoFZgDQLeK8+ps+8oeaGN1mGHnWOW7Mag++LRjV/MeenRwSazYDfG97xgyvyz3bTDQhnCNbr68NLqJw6VUaSkVj9CvE5IUun72HqCV85Zd1QusbrMzU8jtP/O+hIUDj0aAmXCE7UkPBS6d0o3/lS+eT6H9+OAvwy6xmZl/7vQh5XS+D/GvzIp3h9xYBfsmOUarBWpsFGU1Xz20GtF6KT++EvpxUzUFx7nVmWoyqVKRS8u9lUPUg5T7noqFW3q2pw0j30MbsEatFyi5hDF41Hk+ah5fR074Q63gK922S0G/di5Plh4LnYaxU+lzDH2fJDtIFyjCZQWHsvUnv8U8D6gyAuaYl7omoif25XfZFU8GjvKeHJlwseeFeLxVO7qUQ3oGl79FuUhKIiqrFwp1CnkcgvcEKUyIE0lADl6L9fYi4UOkb0XLl4UPO0Se6iLhyL4RMU71K1F9+Gjpv40VSm3nmApvUrAo/EYQ44k2UVhsAgIfKaKCJYlgbGcfmsghencAFlQVFWvQaCCLEl9aUtDv5DfUxaGhKU5ippxADaZSjJIpIEl56gnTEPeQz2LLDXODdQTWQQO19KlGn2IxUKuEbz60XdNepg/WzAX9ax0f57YFCcyLzSnxIxzwqxFLN7LOzkJqHkytaVLwpvywjqCa+kpD5Xc2RxOdP315Pe5mZvEGk+QaMVN4DUY3DzIn+7mBmAZRtup/YYmhsJZHsUGaO5mJ9ejyfTD+PrqdnQzvp1++vPq48kiguEQphyXqu6ZuJKlpuCnmi2bKyJ2zf4sQJB+axJYlSZkCORSmdMzCMYrdE0RfQ1yI1WDdtBwNWD6Tytd1RWrcaDt+rRp2I0ky+xZrLLxu9hHDxTebCkLc2WXPuvnJjDXEAcdXgONDYEP5DGWhr1bYvpe20CcctYM1kinc9FncC7OIoDffpnCs7k5sHOcl7kpnDLUJ0PwnpIjZZa3n8KGDaOQvMOIoSzU8GIoS7K3eCf1sL41ZJ1h+3F3YdWY7UTptIhFRlT4eDhsWJJqkOJdL59unE2rUgiVDjgPnH1gYkfjgKlZrSY8wle1v71gPeQsm2QsQUzEoiJbRPWHd01jf//3NCQarwafD3vZ1X1IpM7mVK897T6qeLJpLxIHvDC6GcNfF/11sScSw6XNC2vQhOxm9irRi8Gr0GWsp1yGebiavR+vnF0LrZWyv5vW/BDe07DQUpkwBLGbdrWDZ0IWSkSCkT84mW089Ong6EUkMo6LeCZ2u6X0+MXp/Z7/XdM0W0TiTjrF9S6svpHIUKboQmR8Q2bysgJ6PmVULK7LMKR2lzZOxurGKEkwlLKnZduhe/NpMmWv17t2blO+4+RGROF3LLhNFVX/jXfV/6rEL7k/xqLSyb6Wj0OsE1LhVc2QbbYthLtdq1Du9yKqnxIyX+y5gv8DL9/Daw== +api: eJy9WE1v2zgQ/SsD7iEJoNhFjlr04KYp1l23DWp392AbAS2NLbYUqZJUHNfwf18MKdmy5NQpFrs5JE44nI83b4Yz2TLHV5bFU/aWO27RsXnEdIGGO6HVMGUxGwnrqkPLIpaiTYwo6Lg6hPq0xyJmMSmNcBsWT7fsDXKDZlC6jMXT+W4eMYPfS7TujU43LN6yRCuHytFHXhRSJN5s/6sl5VtmkwxzTp+ccBJbznwOuljE3KagQ734ign9XhgKwQm0dHcppENjz6h5V0md0/a9RON9r8SsM0KtOsBY5CbJwEuDLRdBDHLukgyW2oDiOQJXKTTv7bw1skvQn7MRAoO0CgS4tToR3GEKa+EycBlCpY7tdu3bIWCQwtKFvZLFBgajEVSggS0wEUuBKdv5L0qhLbSyAY2bV6/ox7HmcZkkaO2ylLCnEov+bbKD1bP5qQNpwMeN4RsWMeEwP6JBzflzOsULkjHJEIZvQS897JUXPcpoYpByMnCnlCy1ybljMfmN107kSFfKIv3VK8Sn817+UeZcXRvkKV9IDCQkNjZ8jkAsQSsEfBKWirrNnF+00ThsoXPKkl4rNF8smpcUwDHmpUUD60yDXivbyYIq88963aSFUA5XaKrDWy2fORRKOMGl+OH5OnbclbbrW0fwzhhtTsolWpa5+ilDu3FWl6AwaFE5EMqHKLnDQwt+J2SdT2Hr8Inex4S/9bqGaqn/O+pTB8H/kf9Cpfh0IoFtZ4ckV/saQPXdssKz470UDg2XH19UXoREdeG4toKhUEtBRYcXu/A6CoMpvcciZU3ompjUwR47NycNki9QEkXxNIssHdXRV9zxd+hx+qoX7WbQ5c7oYOEcd2rFz5XMKfSsl215uELlIS0slqm+/qnD4QnNCzfBvJAVED+3y7/x0DxqO0JZZ8qEji0pxNOl3NYjaqcr96pYhAWvIApVuRQoU8j5BuhB5EIBV0EAcrSWr7DDhRaQnQjnv0SeZos99MVDE3ym4x361rwd+KDuP3VXyrV1sOBWJGBRWYwhR8cpRX7k8R7YTBQRLEoHSlP5rcAJTGcKnAbhQvfqeSicdlze6lK5F9T3hIQhIWli0X6uWWciySDhChZYDz1+SqpmkYXEmarHnggMrrhJJVrPxYKvEKz40U1NepiMG27Oq1np6TrRKY55XkgqiSnVhFqxmL3nj3zsvaaZWZcm8THlhTYORty63Hdyo3O4kNWvF7/P1EwlWlkHiRT0CLwGheu9/OV2pgAWfuie6G+oYhr/aBTroXqcXowG48mH4ejuYXA/fJh8+vPu48U8gn4fJsRLUb2ZuOSldD5PFVo6F85RanZX3gVuNyqBZal8hUDOhbq8Am88eFc30dfA11zU3vZqrHoE/2XQFa5oiT2pV5f1g11LksyOxIKN39ku2kN4v3GZnyvb8Gk7Ux65Gjho4ephrAHcg0e+1Og9OILvtfbACaNVb4Xucsa6CM7YVQTw24shvJqpAzqncZmpwgjlumAw2qBydJmmvazQfvcpOG1XrM8L0b/p89LpB3zksl/d6pNOv5eZR78ETbesNJLFLHOusHG/X6PERS/Fx0493RudhlYIQQdce8w+ELCDofepXvrGNMKH3t9c/fY1SybJFy/GYhbAZlH14V39sL//e+ILjVaDz4eN8e7JF1Jrp6sWskNTbmxQzcdV0LjT3C4OQcDgfgh/3XS3245IDLc6L7RC5UueIA2iN71X/unR1uXcD8lhID/ekNsWGhtwd5WuQHP45PqF5MKvhz532yrrU8YLwSJGnu8zTzb2j7fP/jxiGZElnrLtdsEtfjFyt6M/V9hN5xF75EZQE/SbesQy5CkaT5dvSPDeBkevJ+QVicvST67tTY4qNNwYJAn6/va8bJPP95/GE6JC9a+BXKd0x/A1i/z3mNHbVYRHOd6Gv4VuUNKjGbOgk3LNj3nX4pmPqp681abh4Xbb6J67HYuqUHw7YDtq6/8ATDUCGA== sidebar_class_name: "post api-method" info_path: api/lastmile-ai-api-v-2 custom_edit_url: null @@ -105,7 +105,15 @@ List Datasets.
- + + + Filter listed datasets by ALL filters specified + + +
+ + diff --git a/website/docs/api/list-projects.api.mdx b/website/docs/api/list-projects.api.mdx new file mode 100644 index 00000000..794a4439 --- /dev/null +++ b/website/docs/api/list-projects.api.mdx @@ -0,0 +1,346 @@ +--- +id: list-projects +title: "List Projects" +description: "List Projects." +api: eJylVU2P2zYQ/SvEnLnrxR51cxYNsEXaLLKb9uAaxZgaW0wokiGp3TiC/nsxFG3LH6gb1AdbMt8MZ948PvaQcBOhWsBTcF9IJVhKcJ4CJu3sYw0VfNAxlcUIEmqKKmjPy2VR7FZvQUIk1QWdtlAtenhHGCjMu9RAtVgOSwmBvnUU0ztXb6HqQTmbyCZ+RO+NVnnb2ZfIyXuIqqEW+SnpZOikmE9jLpCQtp4X3Sp3IMEHbiFpihy71iZRiFfSvC+oa9m+dRRy7QUWU9B2c0ZMJAyqERktYrcaYaLFpBqxdkFYbEmgrcU0bpDgwgat/rHn/z9u5KzZCl9aEhijUxoT1eJNp0ZET0qvtRLT7DCUD48lemfj2OH93R3/HG/z3ClFMa47I/byAPl/BzjuepXzXV8TNjAE3IIEnag9Gu1Ox9dy6gvcDhJUIKZtni4xv3ahxQQV1JjoJumWOKTz9c+G1GToJ0NyYS5cksQggdV0ceFoihfWr8ntBPL75X2G8WTrQDV7ia5hyuSUolLqkkOSS2geXGenNGibaEPhTOcvDBaK0cKtD1J/a7RqhEIrViSMjnvNFz2uDP1lRfEAKQJtMNSGYsxZcEMi6h901oI/ON6kzGU5Ly2lxrE5epcNyCNbHMzQ69n9DLvk/qZXNLOSZcZ1ZXMMr9mJFj10wUAFTUo+VrOZwZhabQj1bU2vZ80/BVd3il/EmEPciA8Y02/akJg/Alvrznmf+cyNGp/6755g3pJryTCoYJVBIMvD+536fv3zJbPCZ/nTwbZ/+Y6tN3RirMUVDyI+1dVUKtqu3ZEnHDoR86dH8cf9+T1zBqnEg2u9s2TzkJjXEXp/e8eq5cm0mEU/Ho7ju+p0h8lddH6pFeYSfU8zb1Bno84D7MvoF4BegwSufD/+0XOK+2QJLCU0rJhqAX2/wkifgxkG/rsQuFhKeMWgWbb5zpTQENYUsma+EnP8MBZ688JVMdx02RFP/XeQu4i5UuTTv2KXE1E/fXx+YT2US7p1NccEfAOZvyvgAWfi8vDzfz0YtJsON4wdc/Ks8Vh8J2LLXe0c3W4nFfb9iHhxX8kOA8jSSuJ3GPgg/gNpWAmm +sidebar_class_name: "post api-method" +info_path: api/lastmile-ai-api-v-2 +custom_edit_url: null +show_extensions: true +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Heading from "@theme/Heading"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + + + + + + + + + + +List Projects. + + + + + + +
+ +

+ Body +

+
+ +
    + +
    + + + + filters + + object + + +
    + + + + + +
    +
    +     +
+
+ +
+
+ + +
+ + + Successful operation + + +
+ + + + +
+ + + Schema + +
+ +
    + +
    + + + + projects + + object[] + + + + required + + +
    +
  • +
    + Array [ +
    +
    • + + + + + + + + + + + + + + + + + +
  • +
    + ] +
    +
    • +
    +
    +     + + +
+
+ + + + + + + + +
+ + +
+
\ No newline at end of file diff --git a/website/docs/api/schemas/clonedatasetrequest.schema.mdx b/website/docs/api/schemas/clonedatasetrequest.schema.mdx index 0337512b..4b88127b 100644 --- a/website/docs/api/schemas/clonedatasetrequest.schema.mdx +++ b/website/docs/api/schemas/clonedatasetrequest.schema.mdx @@ -53,6 +53,15 @@ import TabItem from "@theme/TabItem"; schema={{"type":"string","description":"Human-readable description of the dataset.\n If not provided, will use the name of the dataset being cloned"}} > + + \ No newline at end of file diff --git a/website/docs/api/schemas/createdatasetrequest.schema.mdx b/website/docs/api/schemas/createdatasetrequest.schema.mdx index 46e93ae2..9b854c8d 100644 --- a/website/docs/api/schemas/createdatasetrequest.schema.mdx +++ b/website/docs/api/schemas/createdatasetrequest.schema.mdx @@ -62,6 +62,15 @@ Create a Dataset, initially an empty shell until a file is uploaded schema={{"type":"boolean"}} > + + \ No newline at end of file diff --git a/website/docs/api/schemas/createprojectrequest.schema.mdx b/website/docs/api/schemas/createprojectrequest.schema.mdx new file mode 100644 index 00000000..beded079 --- /dev/null +++ b/website/docs/api/schemas/createprojectrequest.schema.mdx @@ -0,0 +1,58 @@ +--- +id: createprojectrequest +title: "CreateProjectRequest" +description: "Create a Project" +sidebar_label: "CreateProjectRequest" +hide_title: true +schema: true +custom_edit_url: null +--- + +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Heading from "@theme/Heading"; +import TabItem from "@theme/TabItem"; + + + + + + +Create a Project + + + \ No newline at end of file diff --git a/website/docs/api/schemas/createprojectresponse.schema.mdx b/website/docs/api/schemas/createprojectresponse.schema.mdx new file mode 100644 index 00000000..5c252fd7 --- /dev/null +++ b/website/docs/api/schemas/createprojectresponse.schema.mdx @@ -0,0 +1,150 @@ +--- +id: createprojectresponse +title: "CreateProjectResponse" +description: "" +sidebar_label: "CreateProjectResponse" +hide_title: true +schema: true +custom_edit_url: null +--- + +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Heading from "@theme/Heading"; +import TabItem from "@theme/TabItem"; + + + + + + + + + + \ No newline at end of file diff --git a/website/docs/api/schemas/getprojectrequest.schema.mdx b/website/docs/api/schemas/getprojectrequest.schema.mdx new file mode 100644 index 00000000..606ebe08 --- /dev/null +++ b/website/docs/api/schemas/getprojectrequest.schema.mdx @@ -0,0 +1,40 @@ +--- +id: getprojectrequest +title: "GetProjectRequest" +description: "" +sidebar_label: "GetProjectRequest" +hide_title: true +schema: true +custom_edit_url: null +--- + +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Heading from "@theme/Heading"; +import TabItem from "@theme/TabItem"; + + + + + + + + + + \ No newline at end of file diff --git a/website/docs/api/schemas/getprojectresponse.schema.mdx b/website/docs/api/schemas/getprojectresponse.schema.mdx new file mode 100644 index 00000000..b246da83 --- /dev/null +++ b/website/docs/api/schemas/getprojectresponse.schema.mdx @@ -0,0 +1,150 @@ +--- +id: getprojectresponse +title: "GetProjectResponse" +description: "" +sidebar_label: "GetProjectResponse" +hide_title: true +schema: true +custom_edit_url: null +--- + +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Heading from "@theme/Heading"; +import TabItem from "@theme/TabItem"; + + + + + + + + + + \ No newline at end of file diff --git a/website/docs/api/schemas/listdatasetsrequest.schema.mdx b/website/docs/api/schemas/listdatasetsrequest.schema.mdx index 5694f125..31ef9411 100644 --- a/website/docs/api/schemas/listdatasetsrequest.schema.mdx +++ b/website/docs/api/schemas/listdatasetsrequest.schema.mdx @@ -53,7 +53,15 @@ import TabItem from "@theme/TabItem";
- + + + Filter listed datasets by ALL filters specified + + +
+ + diff --git a/website/docs/api/schemas/listdatasetsrequestfilters.schema.mdx b/website/docs/api/schemas/listdatasetsrequestfilters.schema.mdx index 60dbeb91..dc2bba40 100644 --- a/website/docs/api/schemas/listdatasetsrequestfilters.schema.mdx +++ b/website/docs/api/schemas/listdatasetsrequestfilters.schema.mdx @@ -1,7 +1,7 @@ --- id: listdatasetsrequestfilters title: "ListDatasetsRequestFilters" -description: "" +description: "Filter listed datasets by ALL filters specified" sidebar_label: "ListDatasetsRequestFilters" hide_title: true schema: true @@ -23,7 +23,7 @@ import TabItem from "@theme/TabItem"; - +Filter listed datasets by ALL filters specified \ No newline at end of file diff --git a/website/docs/api/schemas/listprojectsrequest.schema.mdx b/website/docs/api/schemas/listprojectsrequest.schema.mdx new file mode 100644 index 00000000..19e36a73 --- /dev/null +++ b/website/docs/api/schemas/listprojectsrequest.schema.mdx @@ -0,0 +1,79 @@ +--- +id: listprojectsrequest +title: "ListProjectsRequest" +description: "" +sidebar_label: "ListProjectsRequest" +hide_title: true +schema: true +custom_edit_url: null +--- + +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Heading from "@theme/Heading"; +import TabItem from "@theme/TabItem"; + + + + + + + + + + \ No newline at end of file diff --git a/website/docs/api/schemas/listprojectsrequestfilters.schema.mdx b/website/docs/api/schemas/listprojectsrequestfilters.schema.mdx new file mode 100644 index 00000000..ea6032d2 --- /dev/null +++ b/website/docs/api/schemas/listprojectsrequestfilters.schema.mdx @@ -0,0 +1,49 @@ +--- +id: listprojectsrequestfilters +title: "ListProjectsRequestFilters" +description: "" +sidebar_label: "ListProjectsRequestFilters" +hide_title: true +schema: true +custom_edit_url: null +--- + +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Heading from "@theme/Heading"; +import TabItem from "@theme/TabItem"; + + + + + + + + + + \ No newline at end of file diff --git a/website/docs/api/schemas/listprojectsresponse.schema.mdx b/website/docs/api/schemas/listprojectsresponse.schema.mdx new file mode 100644 index 00000000..128d0405 --- /dev/null +++ b/website/docs/api/schemas/listprojectsresponse.schema.mdx @@ -0,0 +1,171 @@ +--- +id: listprojectsresponse +title: "ListProjectsResponse" +description: "" +sidebar_label: "ListProjectsResponse" +hide_title: true +schema: true +custom_edit_url: null +--- + +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Heading from "@theme/Heading"; +import TabItem from "@theme/TabItem"; + + + + + + + + + + \ No newline at end of file diff --git a/website/docs/api/schemas/project.schema.mdx b/website/docs/api/schemas/project.schema.mdx new file mode 100644 index 00000000..7883aee2 --- /dev/null +++ b/website/docs/api/schemas/project.schema.mdx @@ -0,0 +1,112 @@ +--- +id: project +title: "Project" +description: "" +sidebar_label: "Project" +hide_title: true +schema: true +custom_edit_url: null +--- + +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Heading from "@theme/Heading"; +import TabItem from "@theme/TabItem"; + + + + + + + + + + \ No newline at end of file diff --git a/website/docs/api/sidebar.ts b/website/docs/api/sidebar.ts index f2d071b6..aa0b3ab5 100644 --- a/website/docs/api/sidebar.ts +++ b/website/docs/api/sidebar.ts @@ -132,6 +132,30 @@ const sidebar: SidebarsConfig = { }, ], }, + { + type: "category", + label: "Project", + items: [ + { + type: "doc", + id: "api/create-project", + label: "Create Project", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-project", + label: "Get Project", + className: "api-method post", + }, + { + type: "doc", + id: "api/list-projects", + label: "List Projects", + className: "api-method post", + }, + ], + }, { type: "category", label: "Pseudo Label Job", @@ -262,6 +286,12 @@ const sidebar: SidebarsConfig = { label: "FineTuneJobResult", className: "schema", }, + { + type: "doc", + id: "api/schemas/project", + label: "Project", + className: "schema", + }, { type: "doc", id: "api/schemas/createdatasetrequest", @@ -508,6 +538,48 @@ const sidebar: SidebarsConfig = { label: "ListBaseModelsResponse", className: "schema", }, + { + type: "doc", + id: "api/schemas/createprojectrequest", + label: "CreateProjectRequest", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/createprojectresponse", + label: "CreateProjectResponse", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/getprojectrequest", + label: "GetProjectRequest", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/getprojectresponse", + label: "GetProjectResponse", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/listprojectsrequestfilters", + label: "ListProjectsRequestFilters", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/listprojectsrequest", + label: "ListProjectsRequest", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/listprojectsresponse", + label: "ListProjectsResponse", + className: "schema", + }, { type: "doc", id: "api/schemas/pseudolabeljobconfig", diff --git a/website/static/open_api/2/model.json b/website/static/open_api/2/model.json index 5ca3596c..d205863e 100644 --- a/website/static/open_api/2/model.json +++ b/website/static/open_api/2/model.json @@ -1 +1 @@ -{"openapi":"3.0.3","info":{"title":"LastMile AI API V2","description":"LastMile AI API V2: Components","version":"2.0"},"servers":[{"url":"https://lastmileai.dev","description":"Production server - LastMile AI"}],"security":[{"BearerAuth":[]}],"paths":{"/api/2/auto_eval/dataset/create":{"post":{"tags":["Dataset"],"summary":"Create Dataset","operationId":"CreateDataset","description":"Create a new Dataset. Use UploadDatasetFile to upload files to the dataset.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.CreateDatasetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.CreateDatasetResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const dataset = await client.datasets.create();\n\n console.log(dataset.dataset);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\ndataset = client.datasets.create()\nprint(dataset.dataset)"}]}},"/api/2/auto_eval/dataset/upload_file":{"post":{"tags":["Dataset"],"summary":"Upload Dataset File","operationId":"UploadDatasetFile","description":"Initiate a file upload to a Dataset. Call FinalizeSingleDatasetFileUpload\n to complete the upload with the presigned URL returned from this call.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.UploadDatasetFileRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.UploadDatasetFileResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.datasets.uploadFile({ datasetId: 'datasetId' });\n\n console.log(response.s3PresignedPost);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.datasets.upload_file(\n dataset_id=\"datasetId\",\n)\nprint(response.s3_presigned_post)"}]}},"/api/2/auto_eval/dataset/finalize_single_file_upload":{"post":{"tags":["Dataset"],"summary":"Finalize Single Dataset File Upload","operationId":"FinalizeSingleDatasetFileUpload","description":"Finalize a Dataset file upload. This call should be made after the file has\n been uploaded to the S3 URL returned from UploadDatasetFile.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.FinalizeSingleDatasetFileUploadRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.FinalizeSingleDatasetFileUploadResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.datasets.finalizeFileUpload({\n datasetId: 'datasetId',\n s3PresignedPost: { fields: { foo: 'string' }, url: 'url' },\n });\n\n console.log(response.datasetFile);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.datasets.finalize_file_upload(\n dataset_id=\"datasetId\",\n s3_presigned_post={\n \"fields\": {\n \"foo\": \"string\"\n },\n \"url\": \"url\",\n },\n)\nprint(response.dataset_file)"}]}},"/api/2/auto_eval/dataset/get":{"post":{"tags":["Dataset"],"summary":"Get Dataset","operationId":"GetDataset","description":"Get a Dataset.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetDatasetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetDatasetResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const dataset = await client.datasets.get({ id: 'id' });\n\n console.log(dataset.dataset);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\ndataset = client.datasets.get(\n id=\"id\",\n)\nprint(dataset.dataset)"}]}},"/api/2/auto_eval/dataset/get_download_url":{"post":{"tags":["Dataset"],"summary":"Get Dataset Download URL","operationId":"GetDatasetDownloadURL","description":"Get a download url for a Dataset.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetDatasetDownloadURLRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetDatasetDownloadURLResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.datasets.getDownloadURL({ datasetId: 'datasetId' });\n\n console.log(response.downloadUrl);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.datasets.get_download_url(\n dataset_id=\"datasetId\",\n)\nprint(response.download_url)"}]}},"/api/2/auto_eval/dataset/get_view":{"post":{"tags":["Dataset"],"summary":"Get Dataset View","operationId":"GetDatasetView","description":"Get a paginated view of the data within a Dataset.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetDatasetViewRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetDatasetViewResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.datasets.getView({ datasetFileId: 'datasetFileId', datasetId: 'datasetId' });\n\n console.log(response.datasetFileId);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.datasets.get_view(\n dataset_file_id=\"datasetFileId\",\n dataset_id=\"datasetId\",\n)\nprint(response.dataset_file_id)"}]}},"/api/2/auto_eval/dataset/list":{"post":{"tags":["Dataset"],"summary":"List Datasets","operationId":"ListDatasets","description":"List Datasets.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListDatasetsRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListDatasetsResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const dataset = await client.datasets.list();\n\n console.log(dataset.datasets);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\ndataset = client.datasets.list()\nprint(dataset.datasets)"}]}},"/api/2/auto_eval/dataset/clone":{"post":{"tags":["Dataset"],"summary":"Clone Dataset","operationId":"CloneDataset","description":"Clone a dataset into a new dataset containing the latest file contents","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.CloneDatasetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.CloneDatasetResponse"}}}}}}},"/api/2/auto_eval/evaluation/evaluate":{"post":{"tags":["Evaluation"],"summary":"Evaluate","operationId":"Evaluate","description":"Evaluate a metric on rows of data, returning scores for each row. Specify\n metric.id or metric.name to identify the metric.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.EvaluateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.EvaluateResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.evaluation.evaluate({\n groundTruth: ['string'],\n input: ['string'],\n metric: {},\n output: ['string'],\n });\n\n console.log(response.metric);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.evaluation.evaluate(\n ground_truth=[\"string\"],\n input=[\"string\"],\n metric={},\n output=[\"string\"],\n)\nprint(response.metric)"}]}},"/api/2/auto_eval/evaluation/evaluate_dataset":{"post":{"tags":["Evaluation"],"summary":"Evaluate Dataset","operationId":"EvaluateDataset","description":"Evaluate a metric on a dataset, returning scores for each example. Specify\n metric.id or metric.name to identify the metric.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.EvaluateDatasetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.EvaluateDatasetResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.evaluation.evaluateDataset({ datasetId: 'datasetId', metric: {} });\n\n console.log(response.metric);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.evaluation.evaluate_dataset(\n dataset_id=\"datasetId\",\n metric={},\n)\nprint(response.metric)"}]}},"/api/2/auto_eval/evaluation/list_metrics":{"post":{"tags":["Evaluation"],"summary":"List Metrics","operationId":"ListMetrics","description":"List all available evaluation metrics.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListMetricsRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListMetricsResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.evaluation.listMetrics();\n\n console.log(response.metrics);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.evaluation.list_metrics()\nprint(response.metrics)"}]}},"/api/2/auto_eval/evaluation/get_metric":{"post":{"tags":["Evaluation"],"summary":"Get Metric","operationId":"GetMetric","description":"Get a specific evaluation metric by id or name.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetMetricRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetMetricResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.evaluation.getMetric({ metric: {} });\n\n console.log(response.metric);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.evaluation.get_metric(\n metric={},\n)\nprint(response.metric)"}]}},"/api/2/auto_eval/fine_tune_job/create":{"post":{"tags":["Fine Tune Job"],"summary":"Create Fine Tune Job","operationId":"CreateFineTuneJob","description":"Step 1 of 2: Create a new job configuration for fine-tuning, to be\n subsequently submitted by calling SubmitFineTuneJob.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.CreateFineTuneJobRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.CreateFineTuneJobResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const fineTuneJob = await client.fineTuneJobs.create({\n fineTuneJobConfig: {\n baselineModelId: 'baselineModelId',\n selectedColumns: ['string'],\n testDatasetId: 'testDatasetId',\n trainDatasetId: 'trainDatasetId',\n },\n });\n\n console.log(fineTuneJob.jobId);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nfine_tune_job = client.fine_tune_jobs.create(\n fine_tune_job_config={\n \"baseline_model_id\": \"baselineModelId\",\n \"selected_columns\": [\"string\"],\n \"test_dataset_id\": \"testDatasetId\",\n \"train_dataset_id\": \"trainDatasetId\",\n },\n)\nprint(fine_tune_job.job_id)"}]}},"/api/2/auto_eval/fine_tune_job/submit":{"post":{"tags":["Fine Tune Job"],"summary":"Submit Fine Tune Job","operationId":"SubmitFineTuneJob","description":"Step 2 of 2: Submit the job configuration created by CreateFineTuneJob to\n initiate a job.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.SubmitFineTuneJobRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.SubmitFineTuneJobResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.fineTuneJobs.submit({\n fineTuneJobConfig: {\n baselineModelId: 'baselineModelId',\n selectedColumns: ['string'],\n testDatasetId: 'testDatasetId',\n trainDatasetId: 'trainDatasetId',\n },\n jobId: 'jobId',\n });\n\n console.log(response.jobId);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.fine_tune_jobs.submit(\n fine_tune_job_config={\n \"baseline_model_id\": \"baselineModelId\",\n \"selected_columns\": [\"string\"],\n \"test_dataset_id\": \"testDatasetId\",\n \"train_dataset_id\": \"trainDatasetId\",\n },\n job_id=\"jobId\",\n)\nprint(response.job_id)"}]}},"/api/2/auto_eval/fine_tune_job/get":{"post":{"tags":["Fine Tune Job"],"summary":"Get Fine Tune Job","operationId":"GetFineTuneJob","description":"Get the full job details","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetFineTuneJobRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetFineTuneJobResponse"}}}}}}},"/api/2/auto_eval/fine_tune_job/get_status":{"post":{"tags":["Fine Tune Job"],"summary":"Get Fine Tune Job Status","operationId":"GetFineTuneJobStatus","description":"Get the status of an existing job, including any results.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetFineTuneJobStatusRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetFineTuneJobStatusResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.fineTuneJobs.getStatus({ jobId: 'jobId' });\n\n console.log(response.fineTuneJobResult);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.fine_tune_jobs.get_status(\n job_id=\"jobId\",\n)\nprint(response.fine_tune_job_result)"}]}},"/api/2/auto_eval/fine_tune_job/list":{"post":{"tags":["Fine Tune Job"],"summary":"List Fine Tune Jobs","operationId":"ListFineTuneJobs","description":"List all fine-tune jobs with optional filters.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListFineTuneJobsRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListFineTuneJobsResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const fineTuneJob = await client.fineTuneJobs.list();\n\n console.log(fineTuneJob.jobs);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nfine_tune_job = client.fine_tune_jobs.list()\nprint(fine_tune_job.jobs)"}]}},"/api/2/auto_eval/fine_tune_job/list_base_models":{"post":{"tags":["Fine Tune Job"],"summary":"List Base Models","operationId":"ListBaseModels","description":"List all base models available for fine-tuning.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListBaseModelsRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListBaseModelsResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.fineTuneJobs.listBaseModels();\n\n console.log(response.models);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.fine_tune_jobs.list_base_models()\nprint(response.models)"}]}},"/api/2/auto_eval/pseudo_label_job/create":{"post":{"tags":["Pseudo Label Job"],"summary":"Create Pseudo Label Job","operationId":"CreatePseudoLabelJob","description":"Step 1 of 2: Create a new job configuration for LLM Judge labeling, to be\n subsequently submitted by calling SubmitPseudoLabelJob.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.CreatePseudoLabelJobRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.CreatePseudoLabelJobResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const labelDatasetJob = await client.labelDatasetJobs.create({\n pseudoLabelJobConfig: {\n baseEvaluationMetric: 'baseEvaluationMetric',\n datasetId: 'datasetId',\n promptTemplate: { id: 'id', template: 'template' },\n selectedColumns: ['string'],\n skipActiveLabeling: true,\n },\n });\n\n console.log(labelDatasetJob.jobId);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nlabel_dataset_job = client.label_dataset_jobs.create(\n pseudo_label_job_config={\n \"base_evaluation_metric\": \"baseEvaluationMetric\",\n \"dataset_id\": \"datasetId\",\n \"prompt_template\": {\n \"id\": \"id\",\n \"template\": \"template\",\n },\n \"selected_columns\": [\"string\"],\n \"skip_active_labeling\": True,\n },\n)\nprint(label_dataset_job.job_id)"}]}},"/api/2/auto_eval/pseudo_label_job/submit":{"post":{"tags":["Pseudo Label Job"],"summary":"Submit Pseudo Label Job","operationId":"SubmitPseudoLabelJob","description":"Step 2 of 2: Submit the job configuration created by CreatePseudoLabelJob\n to initiate an LLM Judge labeling job.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.SubmitPseudoLabelJobRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.SubmitPseudoLabelJobResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.labelDatasetJobs.submit({\n jobId: 'jobId',\n pseudoLabelJobConfig: {\n baseEvaluationMetric: 'baseEvaluationMetric',\n datasetId: 'datasetId',\n promptTemplate: { id: 'id', template: 'template' },\n selectedColumns: ['string'],\n skipActiveLabeling: true,\n },\n });\n\n console.log(response.jobId);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.label_dataset_jobs.submit(\n job_id=\"jobId\",\n pseudo_label_job_config={\n \"base_evaluation_metric\": \"baseEvaluationMetric\",\n \"dataset_id\": \"datasetId\",\n \"prompt_template\": {\n \"id\": \"id\",\n \"template\": \"template\",\n },\n \"selected_columns\": [\"string\"],\n \"skip_active_labeling\": True,\n },\n)\nprint(response.job_id)"}]}},"/api/2/auto_eval/pseudo_label_job/get_status":{"post":{"tags":["Pseudo Label Job"],"summary":"Get Pseudo Label Job Status","operationId":"GetPseudoLabelJobStatus","description":"Get the status of an existing job, including any results.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetPseudoLabelJobStatusRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetPseudoLabelJobStatusResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.labelDatasetJobs.getStatus({ jobId: 'jobId' });\n\n console.log(response.pseudoLabelJobResult);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.label_dataset_jobs.get_status(\n job_id=\"jobId\",\n)\nprint(response.pseudo_label_job_result)"}]}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"lmai.proto.model_fine_tuning.v1.MetricBaseModel":{"title":"MetricBaseModel","type":"object","properties":{"id":{"type":"string"},"modelId":{"type":"string"},"baseModelArchitecture":{"type":"string"},"baseEvaluationMetric":{"type":"string"}},"required":["id","modelId","baseModelArchitecture"],"description":"Information about a base model corresponding to a metric"},"lmai.proto.model_fine_tuning.v1.ModelCard":{"title":"ModelCard","type":"object","properties":{"modelId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"deploymentStatus":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"modelSize":{"type":"integer"},"purpose":{"type":"string"},"trainingProgress":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.TrainingProgress"},"baseModelArchitecture":{"type":"string"},"baseEvaluationMetric":{"type":"string"},"values":{"type":"object","additionalProperties":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"columns":{"type":"array","items":{"type":"string"}}},"required":["modelId","name","description","deploymentStatus","createdAt","updatedAt","modelSize","purpose","trainingProgress","baseModelArchitecture","values","tags","columns"]},"lmai.proto.model_fine_tuning.v1.ModelCard.ValuesEntry":{"title":"ValuesEntry","type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"]},"lmai.proto.model_fine_tuning.v1.Model":{"title":"Model","type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deletedAt":{"type":"string","format":"date-time"},"userId":{"type":"string"},"metricBaseModel":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.MetricBaseModel"},"modelCard":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.ModelCard"}},"required":["id","createdAt","updatedAt","metricBaseModel"],"description":"Definition for the model"},"lmai.proto.model_fine_tuning.v1.ModelFile":{"title":"ModelFile","type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"modelId":{"type":"string"},"contentMd5Hash":{"type":"string"},"fileSizeBytes":{"type":"integer"}},"required":["id","createdAt","updatedAt","modelId","contentMd5Hash","fileSizeBytes"],"description":"Actual file asset corresponding to a model"},"lmai.proto.model_fine_tuning.v1.TrainingProgress":{"title":"TrainingProgress","type":"object","properties":{"jobId":{"type":"string"},"epoch":{"type":"integer"},"loss":{"type":"number"},"accuracy":{"type":"number"},"progress":{"type":"number"},"timestamp":{"type":"string","format":"date-time"}},"required":["jobId","epoch","loss","accuracy","progress","timestamp"],"description":"Progress metrics from model training."},"lmai.proto.model_fine_tuning.v1.DataColumn":{"title":"DataColumn","type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"sourceOperationId":{"type":"string"}},"required":["name","type","sourceOperationId"]},"lmai.proto.model_fine_tuning.v1.Dataset":{"title":"Dataset","type":"object","properties":{"id":{"type":"string","description":"The ID of the dataset."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string","description":"Human-readable name for the dataset, if one exists."},"description":{"type":"string","description":"Human-readable description of the dataset, if one exists."},"ownerUserId":{"type":"string","description":"The ID of the user who owns the dataset."},"numRows":{"type":"integer"},"numCols":{"type":"integer"},"initializationStatus":{"type":"string"},"initializationError":{"type":"string"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.DatasetColumnInfo","description":"The columns present in the latest DatasetFile for this dataset"}},"labelState":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.DatasetLabelState","description":"The state of the latest labeling job for the dataset"}},"required":["id","createdAt","updatedAt","ownerUserId","numRows","numCols","initializationStatus","columns"],"description":"A Dataset in the most basic sense: metadata and ownership, but nothing tied\n to its data."},"lmai.proto.model_fine_tuning.v1.DatasetFileInfo":{"title":"DatasetFileInfo","type":"object","properties":{"id":{"type":"string","description":"The ID of the dataset file."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"datasetId":{"type":"string","description":"The ID of the corresponding dataset."},"contentMd5Hash":{"type":"string"},"fileSizeBytes":{"type":"integer"},"numRows":{"type":"integer"},"numCols":{"type":"integer"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.DatasetColumnInfo"}}},"required":["id","createdAt","updatedAt","datasetId","contentMd5Hash","fileSizeBytes","numRows","numCols","columns"]},"lmai.proto.model_fine_tuning.v1.DatasetColumnInfo":{"title":"DatasetColumnInfo","type":"object","properties":{"id":{"type":"string","description":"The ID of the dataset file."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"index":{"type":"integer","description":"Index of the column within the dataset file."},"literalName":{"type":"string","description":"The literal name for the column."},"dtype":{"type":"string"}},"required":["id","createdAt","updatedAt","index","literalName"]},"lmai.proto.model_fine_tuning.v1.DatasetView":{"title":"DatasetView","type":"object","properties":{"numRows":{"type":"integer"},"numCols":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.DataRow"}},"columns":{"type":"array","items":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.DatasetColumnInfo"}}},"required":["numRows","numCols","data","columns"]},"lmai.proto.model_fine_tuning.v1.DataRow":{"title":"DataRow","type":"object","properties":{"id":{"type":"string"},"rowValues":{"type":"array","items":{"description":"Ordered row values with length always equal to `num_rows` on the\n corresponding view.","type":"object","additionalProperties":true}}},"required":["id","rowValues"]},"lmai.proto.model_fine_tuning.v1.DatasetLabelState":{"title":"DatasetLabelState","type":"object","properties":{"labelingStatus":{"type":"string","description":"The status of the latest general pseudo-labeling job for the dataset"},"promptTemplate":{"type":"string","description":"aka user general instructions"},"error":{"type":"string","description":"if the labeling status is error, this field may contain an error message"}},"required":["labelingStatus","promptTemplate"]},"lmai.proto.model_fine_tuning.v1.PromptTemplate":{"title":"PromptTemplate","type":"object","properties":{"id":{"type":"string"},"template":{"type":"string","description":"The template string that defines the prompt"}},"required":["id","template"]},"lmai.proto.model_fine_tuning.v1.FineTuneJob":{"title":"FineTuneJob","type":"object","properties":{"id":{"type":"string","description":"The ID of the fine tune job."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string","description":"Name corresponding to the fine tuned model derived from this job"},"description":{"type":"string"},"status":{"type":"string"},"config":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.FineTuneJobConfig"},"result":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.FineTuneJobResult"}},"required":["id","createdAt","updatedAt","status","config","result"]},"lmai.proto.model_fine_tuning.v1.FineTuneJobConfig":{"title":"FineTuneJobConfig","type":"object","properties":{"name":{"type":"string","description":"Optional name for the job."},"description":{"type":"string","description":"Optional description for the job."},"baselineModelId":{"type":"string","description":"The ID for the model used as the starting point for training."},"trainDatasetId":{"type":"string","description":"The dataset to use for training, with splits baked in or to be\n derived dynamically"},"testDatasetId":{"type":"string","description":"The dataset to use for an unbiased evaluation of the model"},"selectedColumns":{"type":"array","items":{"type":"string","description":"Set of columns to be used in fine-tuning.\n Supported columns: input, output, ground_truth\n For example, a task similar to summarization might need output and\n ground_truth."}}},"required":["baselineModelId","trainDatasetId","testDatasetId","selectedColumns"]},"lmai.proto.model_fine_tuning.v1.FineTuneJobResult":{"title":"FineTuneJobResult","type":"object","properties":{"progress":{"type":"array","items":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.TrainingProgress","description":"Sequential snapshots of training metrics."}},"trainedModelFile":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.ModelFile","description":"The trained model, if it was created successfully."},"resultUrl":{"type":"string","description":"Url to view the full results and progress (e.g. external W&B url)"}},"required":["progress"],"description":"Result of a Fine-Tuning Job."},"lmai.proto.webserver.v2.CreateDatasetRequest":{"title":"CreateDatasetRequest","type":"object","properties":{"name":{"type":"string","description":"Human-readable name for the dataset, if one exists."},"description":{"type":"string","description":"Human-readable description of the dataset, if one exists."},"isFewShotExamples":{"type":"boolean","description":"PseudoLabel job fields."},"isActiveLabels":{"type":"boolean"}},"description":"Create a Dataset, initially an empty shell until a file is uploaded"},"lmai.proto.webserver.v2.CreateDatasetResponse":{"title":"CreateDatasetResponse","type":"object","properties":{"dataset":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.Dataset"}},"required":["dataset"]},"lmai.proto.webserver.v2.UploadDatasetFileRequest":{"title":"UploadDatasetFileRequest","type":"object","properties":{"datasetId":{"type":"string","description":"The ID of the dataset corresponding to the file."}},"required":["datasetId"],"description":"Initiate an upload by requesting a pre-signed S3 upload URL."},"lmai.proto.webserver.v2.UploadDatasetFileResponse":{"title":"UploadDatasetFileResponse","type":"object","properties":{"s3PresignedPost":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.S3PresignedPost"}},"required":["s3PresignedPost"]},"lmai.proto.webserver.v2.S3PresignedPost":{"title":"S3PresignedPost","type":"object","properties":{"url":{"type":"string"},"fields":{"type":"object","additionalProperties":{"type":"string"},"description":"Fields required for the S3 presigned POST request generated by s3 sdk."}},"required":["url","fields"]},"lmai.proto.webserver.v2.S3PresignedPost.FieldsEntry":{"title":"FieldsEntry","type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"]},"lmai.proto.webserver.v2.FinalizeSingleDatasetFileUploadRequest":{"title":"FinalizeSingleDatasetFileUploadRequest","type":"object","properties":{"datasetId":{"type":"string","description":"The ID of the dataset corresponding to the file"},"s3PresignedPost":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.S3PresignedPost","description":"The pre-signed S3 URL where the file was uploadeded"}},"required":["datasetId","s3PresignedPost"],"description":"Request to finalize a single dataset file upload"},"lmai.proto.webserver.v2.FinalizeSingleDatasetFileUploadResponse":{"title":"FinalizeSingleDatasetFileUploadResponse","type":"object","properties":{"datasetFile":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.DatasetFileInfo","description":"Information about the dataset file if the upload was successful"}},"description":"Response after finalizing a single dataset file upload"},"lmai.proto.webserver.v2.GetDatasetRequest":{"title":"GetDatasetRequest","type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"lmai.proto.webserver.v2.GetDatasetResponse":{"title":"GetDatasetResponse","type":"object","properties":{"dataset":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.Dataset"}},"required":["dataset"]},"lmai.proto.webserver.v2.GetDatasetViewRequest":{"title":"GetDatasetViewRequest","type":"object","properties":{"datasetId":{"type":"string","description":"The ID of the dataset from which to retrieve content. When specified,\n gets data from the current file in the dataset."},"datasetFileId":{"type":"string","description":"The ID of the (pinned) dataset file from which to retrieve content.\n Requests iterating over pages of results are recommended to use this\n pinned identifier after the first page in order to prevent any effects\n from a dataset changing between the queries."},"after":{"type":"integer","description":"Pagination: The index, by row-order, after which to query results."},"limit":{"type":"integer","description":"Pagination: The maximum number of results to return on this page."}},"required":["datasetId","datasetFileId"],"description":"Get a view of the data within a dataset."},"lmai.proto.webserver.v2.GetDatasetViewResponse":{"title":"GetDatasetViewResponse","type":"object","properties":{"datasetId":{"type":"string"},"datasetFileId":{"type":"string"},"datasetView":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.DatasetView"}},"required":["datasetId","datasetFileId","datasetView"]},"lmai.proto.webserver.v2.ListDatasetsRequestFilters":{"title":"ListDatasetsRequestFilters","type":"object","properties":{"query":{"type":"string","description":"search query substring match for name and description"}}},"lmai.proto.webserver.v2.ListDatasetsRequest":{"title":"ListDatasetsRequest","type":"object","properties":{"filters":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListDatasetsRequestFilters"}}},"lmai.proto.webserver.v2.ListDatasetsResponse":{"title":"ListDatasetsResponse","type":"object","properties":{"datasets":{"type":"array","items":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.Dataset"}},"totalCount":{"type":"integer","description":"Total count of datasets which can be listed with applicable\n filters, regardless of page size"}},"required":["datasets","totalCount"]},"lmai.proto.webserver.v2.GetDatasetDownloadURLRequest":{"title":"GetDatasetDownloadURLRequest","type":"object","properties":{"datasetId":{"type":"string"}},"required":["datasetId"]},"lmai.proto.webserver.v2.GetDatasetDownloadURLResponse":{"title":"GetDatasetDownloadURLResponse","type":"object","properties":{"downloadUrl":{"type":"string","description":"The S3 presigned URL to download the dataset file."}},"required":["downloadUrl"]},"lmai.proto.webserver.v2.CloneDatasetRequest":{"title":"CloneDatasetRequest","type":"object","properties":{"datasetId":{"type":"string","description":"Dataset to clone"},"name":{"type":"string","description":"New dataset name. If not provided, will use the name of the dataset being\n cloned"},"description":{"type":"string","description":"Human-readable description of the dataset.\n If not provided, will use the name of the dataset being cloned"}},"required":["datasetId"]},"lmai.proto.webserver.v2.CloneDatasetResponse":{"title":"CloneDatasetResponse","type":"object","properties":{"dataset":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.Dataset"}},"required":["dataset"]},"lmai.proto.webserver.v2.Metric":{"title":"Metric","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"deploymentStatus":{"type":"string"}}},"lmai.proto.webserver.v2.EvaluateRequest":{"title":"EvaluateRequest","type":"object","properties":{"metric":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.Metric"},"input":{"type":"array","items":{"type":"string"}},"output":{"type":"array","items":{"type":"string"}},"groundTruth":{"type":"array","items":{"type":"string"}}},"required":["metric","input","output","groundTruth"]},"lmai.proto.webserver.v2.EvaluateResponse":{"title":"EvaluateResponse","type":"object","properties":{"metric":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.Metric"},"scores":{"type":"array","items":{"type":"number"}}},"required":["metric","scores"],"description":"The index of the float value corresponds to that of\n the string combination sent in the request.\n Ex: scores.values[i] is taken from\n input[i], ground_truth[i], context[i], output[i] in EvaluateRequest"},"lmai.proto.webserver.v2.EvaluateDatasetRequest":{"title":"EvaluateDatasetRequest","type":"object","properties":{"metric":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.Metric"},"datasetId":{"type":"string"}},"required":["metric","datasetId"]},"lmai.proto.webserver.v2.EvaluateDatasetResponse":{"title":"EvaluateDatasetResponse","type":"object","properties":{"metric":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.Metric"},"scores":{"type":"array","items":{"type":"number"}}},"required":["metric","scores"],"description":"models and scores correspond in the same manner as in EvaluateResponse"},"lmai.proto.webserver.v2.ListMetricsRequest":{"title":"ListMetricsRequest","type":"object","properties":{},"additionalProperties":false,"x-stainless-empty-object":true},"lmai.proto.webserver.v2.ListMetricsResponse":{"title":"ListMetricsResponse","type":"object","properties":{"metrics":{"type":"array","items":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.Metric"}}},"required":["metrics"]},"lmai.proto.webserver.v2.GetMetricRequest":{"title":"GetMetricRequest","type":"object","properties":{"metric":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.Metric"}},"required":["metric"],"description":"Requested metric must have at least id or name set."},"lmai.proto.webserver.v2.GetMetricResponse":{"title":"GetMetricResponse","type":"object","properties":{"metric":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.Metric"}},"required":["metric"],"description":"Returns a full metric object with all fields set."},"lmai.proto.webserver.v2.CreateFineTuneJobRequest":{"title":"CreateFineTuneJobRequest","type":"object","properties":{"fineTuneJobConfig":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.FineTuneJobConfig","description":"Partial configuration with parameters for the fine-tune job."}},"required":["fineTuneJobConfig"],"description":"Create a new Fine Tune Job\n Initialized with the provided configuration parameters."},"lmai.proto.webserver.v2.CreateFineTuneJobResponse":{"title":"CreateFineTuneJobResponse","type":"object","properties":{"jobId":{"type":"string"}},"required":["jobId"]},"lmai.proto.webserver.v2.SubmitFineTuneJobRequest":{"title":"SubmitFineTuneJobRequest","type":"object","properties":{"jobId":{"type":"string"},"fineTuneJobConfig":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.FineTuneJobConfig","description":"The fine-tune job configuration."}},"required":["jobId","fineTuneJobConfig"]},"lmai.proto.webserver.v2.SubmitFineTuneJobResponse":{"title":"SubmitFineTuneJobResponse","type":"object","properties":{"jobId":{"type":"string"}},"required":["jobId"]},"lmai.proto.webserver.v2.GetFineTuneJobRequest":{"title":"GetFineTuneJobRequest","type":"object","properties":{"jobId":{"type":"string"}},"required":["jobId"]},"lmai.proto.webserver.v2.GetFineTuneJobResponse":{"title":"GetFineTuneJobResponse","type":"object","properties":{"job":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.FineTuneJob"}},"required":["job"]},"lmai.proto.webserver.v2.GetFineTuneJobStatusRequest":{"title":"GetFineTuneJobStatusRequest","type":"object","properties":{"jobId":{"type":"string"}},"required":["jobId"]},"lmai.proto.webserver.v2.GetFineTuneJobStatusResponse":{"title":"GetFineTuneJobStatusResponse","type":"object","properties":{"status":{"type":"string"},"fineTuneJobResult":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.FineTuneJobResult"}},"required":["status","fineTuneJobResult"]},"lmai.proto.webserver.v2.ListFineTuneJobsRequestFilters":{"title":"ListFineTuneJobsRequestFilters","type":"object","properties":{"query":{"type":"string","description":"search query substring match for name and description"},"status":{"type":"string"}}},"lmai.proto.webserver.v2.ListFineTuneJobsRequest":{"title":"ListFineTuneJobsRequest","type":"object","properties":{"filters":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListFineTuneJobsRequestFilters"}}},"lmai.proto.webserver.v2.ListFineTuneJobsResponse":{"title":"ListFineTuneJobsResponse","type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.FineTuneJob"}},"totalCount":{"type":"integer","description":"Total count of fine tune jobs which can be listed with applicable\n filters, regardless of page size"}},"required":["jobs","totalCount"]},"lmai.proto.webserver.v2.ListBaseModelsRequest":{"title":"ListBaseModelsRequest","type":"object","properties":{},"additionalProperties":false,"x-stainless-empty-object":true},"lmai.proto.webserver.v2.ListBaseModelsResponse":{"title":"ListBaseModelsResponse","type":"object","properties":{"models":{"type":"array","items":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.Model"}}},"required":["models"]},"lmai.proto.webserver.v2.PseudoLabelJobConfig":{"title":"PseudoLabelJobConfig","type":"object","properties":{"name":{"type":"string","description":"Optional name for the job."},"description":{"type":"string","description":"Optional description for the job."},"datasetId":{"type":"string","description":"ID of the main dataset to be pseudo-labeled"},"fewShotDatasetId":{"type":"string","description":"ID of the dataset containing few-shot examples. Optional."},"activeLabeledDatasetId":{"type":"string","description":"ID of the actively labeled dataset. Optional. If null, this job is for\n active learning."},"selectedColumns":{"type":"array","items":{"type":"string","description":"Subset of columns to be used in pseudo-labeling.\n Expected columns: input, output, ground_truth\n For example, a summarization task might not need an input column.\n By default, all columns are used."}},"promptTemplate":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.PromptTemplate"},"baseEvaluationMetric":{"type":"string","description":"Reserved field. Do not use at the moment."},"skipActiveLabeling":{"type":"boolean","description":"If true, skip active labeling, which involves an intermediate Dataset\n created for human labeling."}},"required":["datasetId","selectedColumns","promptTemplate","baseEvaluationMetric","skipActiveLabeling"],"description":"Configuration for LLM Judge labeling job."},"lmai.proto.webserver.v2.CreatePseudoLabelJobRequest":{"title":"CreatePseudoLabelJobRequest","type":"object","properties":{"pseudoLabelJobConfig":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.PseudoLabelJobConfig","description":"Partial configuration containing updates via its non-null fields."}},"required":["pseudoLabelJobConfig"]},"lmai.proto.webserver.v2.CreatePseudoLabelJobResponse":{"title":"CreatePseudoLabelJobResponse","type":"object","properties":{"jobId":{"type":"string"}},"required":["jobId"]},"lmai.proto.webserver.v2.SubmitPseudoLabelJobRequest":{"title":"SubmitPseudoLabelJobRequest","type":"object","properties":{"jobId":{"type":"string"},"pseudoLabelJobConfig":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.PseudoLabelJobConfig","description":"The pseudo-labeling job configuration."}},"required":["jobId","pseudoLabelJobConfig"]},"lmai.proto.webserver.v2.SubmitPseudoLabelJobResponse":{"title":"SubmitPseudoLabelJobResponse","type":"object","properties":{"jobId":{"type":"string"}},"required":["jobId"]},"lmai.proto.webserver.v2.GetPseudoLabelJobStatusRequest":{"title":"GetPseudoLabelJobStatusRequest","type":"object","properties":{"jobId":{"type":"string"}},"required":["jobId"]},"lmai.proto.webserver.v2.GetPseudoLabelJobStatusResponse":{"title":"GetPseudoLabelJobStatusResponse","type":"object","properties":{"status":{"type":"string"},"pseudoLabelJobResult":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.PseudoLabelJobConfig"}},"required":["status","pseudoLabelJobResult"]},"google.protobuf.Value":{"description":"Ordered row values with length always equal to `num_rows` on the\n corresponding view.","type":"object","additionalProperties":true}},"examples":{}}} \ No newline at end of file +{"openapi":"3.0.3","info":{"title":"LastMile AI API V2","description":"LastMile AI API V2: Components","version":"2.0"},"servers":[{"url":"https://lastmileai.dev","description":"Production server - LastMile AI"}],"security":[{"BearerAuth":[]}],"paths":{"/api/2/auto_eval/dataset/create":{"post":{"tags":["Dataset"],"summary":"Create Dataset","operationId":"CreateDataset","description":"Create a new Dataset. Use UploadDatasetFile to upload files to the dataset.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.CreateDatasetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.CreateDatasetResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const dataset = await client.datasets.create();\n\n console.log(dataset.dataset);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\ndataset = client.datasets.create()\nprint(dataset.dataset)"}]}},"/api/2/auto_eval/dataset/upload_file":{"post":{"tags":["Dataset"],"summary":"Upload Dataset File","operationId":"UploadDatasetFile","description":"Initiate a file upload to a Dataset. Call FinalizeSingleDatasetFileUpload\n to complete the upload with the presigned URL returned from this call.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.UploadDatasetFileRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.UploadDatasetFileResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.datasets.uploadFile({ datasetId: 'datasetId' });\n\n console.log(response.s3PresignedPost);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.datasets.upload_file(\n dataset_id=\"datasetId\",\n)\nprint(response.s3_presigned_post)"}]}},"/api/2/auto_eval/dataset/finalize_single_file_upload":{"post":{"tags":["Dataset"],"summary":"Finalize Single Dataset File Upload","operationId":"FinalizeSingleDatasetFileUpload","description":"Finalize a Dataset file upload. This call should be made after the file has\n been uploaded to the S3 URL returned from UploadDatasetFile.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.FinalizeSingleDatasetFileUploadRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.FinalizeSingleDatasetFileUploadResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.datasets.finalizeFileUpload({\n datasetId: 'datasetId',\n s3PresignedPost: { fields: { foo: 'string' }, url: 'url' },\n });\n\n console.log(response.datasetFile);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.datasets.finalize_file_upload(\n dataset_id=\"datasetId\",\n s3_presigned_post={\n \"fields\": {\n \"foo\": \"string\"\n },\n \"url\": \"url\",\n },\n)\nprint(response.dataset_file)"}]}},"/api/2/auto_eval/dataset/get":{"post":{"tags":["Dataset"],"summary":"Get Dataset","operationId":"GetDataset","description":"Get a Dataset.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetDatasetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetDatasetResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const dataset = await client.datasets.get({ id: 'id' });\n\n console.log(dataset.dataset);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\ndataset = client.datasets.get(\n id=\"id\",\n)\nprint(dataset.dataset)"}]}},"/api/2/auto_eval/dataset/get_download_url":{"post":{"tags":["Dataset"],"summary":"Get Dataset Download URL","operationId":"GetDatasetDownloadURL","description":"Get a download url for a Dataset.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetDatasetDownloadURLRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetDatasetDownloadURLResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.datasets.getDownloadURL({ datasetId: 'datasetId' });\n\n console.log(response.downloadUrl);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.datasets.get_download_url(\n dataset_id=\"datasetId\",\n)\nprint(response.download_url)"}]}},"/api/2/auto_eval/dataset/get_view":{"post":{"tags":["Dataset"],"summary":"Get Dataset View","operationId":"GetDatasetView","description":"Get a paginated view of the data within a Dataset.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetDatasetViewRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetDatasetViewResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.datasets.getView({ datasetFileId: 'datasetFileId', datasetId: 'datasetId' });\n\n console.log(response.datasetFileId);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.datasets.get_view(\n dataset_file_id=\"datasetFileId\",\n dataset_id=\"datasetId\",\n)\nprint(response.dataset_file_id)"}]}},"/api/2/auto_eval/dataset/list":{"post":{"tags":["Dataset"],"summary":"List Datasets","operationId":"ListDatasets","description":"List Datasets.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListDatasetsRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListDatasetsResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const dataset = await client.datasets.list();\n\n console.log(dataset.datasets);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\ndataset = client.datasets.list()\nprint(dataset.datasets)"}]}},"/api/2/auto_eval/dataset/clone":{"post":{"tags":["Dataset"],"summary":"Clone Dataset","operationId":"CloneDataset","description":"Clone a dataset into a new dataset containing the latest file contents","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.CloneDatasetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.CloneDatasetResponse"}}}}}}},"/api/2/auto_eval/evaluation/evaluate":{"post":{"tags":["Evaluation"],"summary":"Evaluate","operationId":"Evaluate","description":"Evaluate a metric on rows of data, returning scores for each row. Specify\n metric.id or metric.name to identify the metric.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.EvaluateRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.EvaluateResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.evaluation.evaluate({\n groundTruth: ['string'],\n input: ['string'],\n metric: {},\n output: ['string'],\n });\n\n console.log(response.metric);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.evaluation.evaluate(\n ground_truth=[\"string\"],\n input=[\"string\"],\n metric={},\n output=[\"string\"],\n)\nprint(response.metric)"}]}},"/api/2/auto_eval/evaluation/evaluate_dataset":{"post":{"tags":["Evaluation"],"summary":"Evaluate Dataset","operationId":"EvaluateDataset","description":"Evaluate a metric on a dataset, returning scores for each example. Specify\n metric.id or metric.name to identify the metric.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.EvaluateDatasetRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.EvaluateDatasetResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.evaluation.evaluateDataset({ datasetId: 'datasetId', metric: {} });\n\n console.log(response.metric);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.evaluation.evaluate_dataset(\n dataset_id=\"datasetId\",\n metric={},\n)\nprint(response.metric)"}]}},"/api/2/auto_eval/evaluation/list_metrics":{"post":{"tags":["Evaluation"],"summary":"List Metrics","operationId":"ListMetrics","description":"List all available evaluation metrics.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListMetricsRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListMetricsResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.evaluation.listMetrics();\n\n console.log(response.metrics);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.evaluation.list_metrics()\nprint(response.metrics)"}]}},"/api/2/auto_eval/evaluation/get_metric":{"post":{"tags":["Evaluation"],"summary":"Get Metric","operationId":"GetMetric","description":"Get a specific evaluation metric by id or name.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetMetricRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetMetricResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.evaluation.getMetric({ metric: {} });\n\n console.log(response.metric);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.evaluation.get_metric(\n metric={},\n)\nprint(response.metric)"}]}},"/api/2/auto_eval/fine_tune_job/create":{"post":{"tags":["Fine Tune Job"],"summary":"Create Fine Tune Job","operationId":"CreateFineTuneJob","description":"Step 1 of 2: Create a new job configuration for fine-tuning, to be\n subsequently submitted by calling SubmitFineTuneJob.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.CreateFineTuneJobRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.CreateFineTuneJobResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const fineTuneJob = await client.fineTuneJobs.create({\n fineTuneJobConfig: {\n baselineModelId: 'baselineModelId',\n selectedColumns: ['string'],\n testDatasetId: 'testDatasetId',\n trainDatasetId: 'trainDatasetId',\n },\n });\n\n console.log(fineTuneJob.jobId);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nfine_tune_job = client.fine_tune_jobs.create(\n fine_tune_job_config={\n \"baseline_model_id\": \"baselineModelId\",\n \"selected_columns\": [\"string\"],\n \"test_dataset_id\": \"testDatasetId\",\n \"train_dataset_id\": \"trainDatasetId\",\n },\n)\nprint(fine_tune_job.job_id)"}]}},"/api/2/auto_eval/fine_tune_job/submit":{"post":{"tags":["Fine Tune Job"],"summary":"Submit Fine Tune Job","operationId":"SubmitFineTuneJob","description":"Step 2 of 2: Submit the job configuration created by CreateFineTuneJob to\n initiate a job.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.SubmitFineTuneJobRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.SubmitFineTuneJobResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.fineTuneJobs.submit({\n fineTuneJobConfig: {\n baselineModelId: 'baselineModelId',\n selectedColumns: ['string'],\n testDatasetId: 'testDatasetId',\n trainDatasetId: 'trainDatasetId',\n },\n jobId: 'jobId',\n });\n\n console.log(response.jobId);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.fine_tune_jobs.submit(\n fine_tune_job_config={\n \"baseline_model_id\": \"baselineModelId\",\n \"selected_columns\": [\"string\"],\n \"test_dataset_id\": \"testDatasetId\",\n \"train_dataset_id\": \"trainDatasetId\",\n },\n job_id=\"jobId\",\n)\nprint(response.job_id)"}]}},"/api/2/auto_eval/fine_tune_job/get":{"post":{"tags":["Fine Tune Job"],"summary":"Get Fine Tune Job","operationId":"GetFineTuneJob","description":"Get the full job details","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetFineTuneJobRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetFineTuneJobResponse"}}}}}}},"/api/2/auto_eval/fine_tune_job/get_status":{"post":{"tags":["Fine Tune Job"],"summary":"Get Fine Tune Job Status","operationId":"GetFineTuneJobStatus","description":"Get the status of an existing job, including any results.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetFineTuneJobStatusRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetFineTuneJobStatusResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.fineTuneJobs.getStatus({ jobId: 'jobId' });\n\n console.log(response.fineTuneJobResult);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.fine_tune_jobs.get_status(\n job_id=\"jobId\",\n)\nprint(response.fine_tune_job_result)"}]}},"/api/2/auto_eval/fine_tune_job/list":{"post":{"tags":["Fine Tune Job"],"summary":"List Fine Tune Jobs","operationId":"ListFineTuneJobs","description":"List all fine-tune jobs with optional filters.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListFineTuneJobsRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListFineTuneJobsResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const fineTuneJob = await client.fineTuneJobs.list();\n\n console.log(fineTuneJob.jobs);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nfine_tune_job = client.fine_tune_jobs.list()\nprint(fine_tune_job.jobs)"}]}},"/api/2/auto_eval/fine_tune_job/list_base_models":{"post":{"tags":["Fine Tune Job"],"summary":"List Base Models","operationId":"ListBaseModels","description":"List all base models available for fine-tuning.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListBaseModelsRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListBaseModelsResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.fineTuneJobs.listBaseModels();\n\n console.log(response.models);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.fine_tune_jobs.list_base_models()\nprint(response.models)"}]}},"/api/2/auto_eval/project/create":{"post":{"tags":["Project"],"summary":"Create Project","operationId":"CreateProject","description":"Create a new Project","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.CreateProjectRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.CreateProjectResponse"}}}}}}},"/api/2/auto_eval/project/get":{"post":{"tags":["Project"],"summary":"Get Project","operationId":"GetProject","description":"Get a Project.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetProjectRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetProjectResponse"}}}}}}},"/api/2/auto_eval/project/list":{"post":{"tags":["Project"],"summary":"List Projects","operationId":"ListProjects","description":"List Projects.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListProjectsRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListProjectsResponse"}}}}}}},"/api/2/auto_eval/pseudo_label_job/create":{"post":{"tags":["Pseudo Label Job"],"summary":"Create Pseudo Label Job","operationId":"CreatePseudoLabelJob","description":"Step 1 of 2: Create a new job configuration for LLM Judge labeling, to be\n subsequently submitted by calling SubmitPseudoLabelJob.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.CreatePseudoLabelJobRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.CreatePseudoLabelJobResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const labelDatasetJob = await client.labelDatasetJobs.create({\n pseudoLabelJobConfig: {\n baseEvaluationMetric: 'baseEvaluationMetric',\n datasetId: 'datasetId',\n promptTemplate: { id: 'id', template: 'template' },\n selectedColumns: ['string'],\n skipActiveLabeling: true,\n },\n });\n\n console.log(labelDatasetJob.jobId);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nlabel_dataset_job = client.label_dataset_jobs.create(\n pseudo_label_job_config={\n \"base_evaluation_metric\": \"baseEvaluationMetric\",\n \"dataset_id\": \"datasetId\",\n \"prompt_template\": {\n \"id\": \"id\",\n \"template\": \"template\",\n },\n \"selected_columns\": [\"string\"],\n \"skip_active_labeling\": True,\n },\n)\nprint(label_dataset_job.job_id)"}]}},"/api/2/auto_eval/pseudo_label_job/submit":{"post":{"tags":["Pseudo Label Job"],"summary":"Submit Pseudo Label Job","operationId":"SubmitPseudoLabelJob","description":"Step 2 of 2: Submit the job configuration created by CreatePseudoLabelJob\n to initiate an LLM Judge labeling job.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.SubmitPseudoLabelJobRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.SubmitPseudoLabelJobResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.labelDatasetJobs.submit({\n jobId: 'jobId',\n pseudoLabelJobConfig: {\n baseEvaluationMetric: 'baseEvaluationMetric',\n datasetId: 'datasetId',\n promptTemplate: { id: 'id', template: 'template' },\n selectedColumns: ['string'],\n skipActiveLabeling: true,\n },\n });\n\n console.log(response.jobId);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.label_dataset_jobs.submit(\n job_id=\"jobId\",\n pseudo_label_job_config={\n \"base_evaluation_metric\": \"baseEvaluationMetric\",\n \"dataset_id\": \"datasetId\",\n \"prompt_template\": {\n \"id\": \"id\",\n \"template\": \"template\",\n },\n \"selected_columns\": [\"string\"],\n \"skip_active_labeling\": True,\n },\n)\nprint(response.job_id)"}]}},"/api/2/auto_eval/pseudo_label_job/get_status":{"post":{"tags":["Pseudo Label Job"],"summary":"Get Pseudo Label Job Status","operationId":"GetPseudoLabelJobStatus","description":"Get the status of an existing job, including any results.","security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetPseudoLabelJobStatusRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.GetPseudoLabelJobStatusResponse"}}}}},"x-codeSamples":[{"lang":"JavaScript","source":"import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n const response = await client.labelDatasetJobs.getStatus({ jobId: 'jobId' });\n\n console.log(response.pseudoLabelJobResult);\n}\n\nmain();"},{"lang":"Python","source":"import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.label_dataset_jobs.get_status(\n job_id=\"jobId\",\n)\nprint(response.pseudo_label_job_result)"}]}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"lmai.proto.model_fine_tuning.v1.MetricBaseModel":{"title":"MetricBaseModel","type":"object","properties":{"id":{"type":"string"},"modelId":{"type":"string"},"baseModelArchitecture":{"type":"string"},"baseEvaluationMetric":{"type":"string"}},"required":["id","modelId","baseModelArchitecture"],"description":"Information about a base model corresponding to a metric"},"lmai.proto.model_fine_tuning.v1.ModelCard":{"title":"ModelCard","type":"object","properties":{"modelId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"deploymentStatus":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"modelSize":{"type":"integer"},"purpose":{"type":"string"},"trainingProgress":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.TrainingProgress"},"baseModelArchitecture":{"type":"string"},"baseEvaluationMetric":{"type":"string"},"values":{"type":"object","additionalProperties":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"columns":{"type":"array","items":{"type":"string"}}},"required":["modelId","name","description","deploymentStatus","createdAt","updatedAt","modelSize","purpose","trainingProgress","baseModelArchitecture","values","tags","columns"]},"lmai.proto.model_fine_tuning.v1.ModelCard.ValuesEntry":{"title":"ValuesEntry","type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"]},"lmai.proto.model_fine_tuning.v1.Model":{"title":"Model","type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deletedAt":{"type":"string","format":"date-time"},"userId":{"type":"string"},"metricBaseModel":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.MetricBaseModel"},"modelCard":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.ModelCard"}},"required":["id","createdAt","updatedAt","metricBaseModel"],"description":"Definition for the model"},"lmai.proto.model_fine_tuning.v1.ModelFile":{"title":"ModelFile","type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"modelId":{"type":"string"},"contentMd5Hash":{"type":"string"},"fileSizeBytes":{"type":"integer"}},"required":["id","createdAt","updatedAt","modelId","contentMd5Hash","fileSizeBytes"],"description":"Actual file asset corresponding to a model"},"lmai.proto.model_fine_tuning.v1.TrainingProgress":{"title":"TrainingProgress","type":"object","properties":{"jobId":{"type":"string"},"epoch":{"type":"integer"},"loss":{"type":"number"},"accuracy":{"type":"number"},"progress":{"type":"number"},"timestamp":{"type":"string","format":"date-time"}},"required":["jobId","epoch","loss","accuracy","progress","timestamp"],"description":"Progress metrics from model training."},"lmai.proto.model_fine_tuning.v1.DataColumn":{"title":"DataColumn","type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"sourceOperationId":{"type":"string"}},"required":["name","type","sourceOperationId"]},"lmai.proto.model_fine_tuning.v1.Dataset":{"title":"Dataset","type":"object","properties":{"id":{"type":"string","description":"The ID of the dataset."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string","description":"Human-readable name for the dataset, if one exists."},"description":{"type":"string","description":"Human-readable description of the dataset, if one exists."},"ownerUserId":{"type":"string","description":"The ID of the user who owns the dataset."},"numRows":{"type":"integer"},"numCols":{"type":"integer"},"initializationStatus":{"type":"string"},"initializationError":{"type":"string"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.DatasetColumnInfo","description":"The columns present in the latest DatasetFile for this dataset"}},"labelState":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.DatasetLabelState","description":"The state of the latest labeling job for the dataset"}},"required":["id","createdAt","updatedAt","ownerUserId","numRows","numCols","initializationStatus","columns"],"description":"A Dataset in the most basic sense: metadata and ownership, but nothing tied\n to its data."},"lmai.proto.model_fine_tuning.v1.DatasetFileInfo":{"title":"DatasetFileInfo","type":"object","properties":{"id":{"type":"string","description":"The ID of the dataset file."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"datasetId":{"type":"string","description":"The ID of the corresponding dataset."},"contentMd5Hash":{"type":"string"},"fileSizeBytes":{"type":"integer"},"numRows":{"type":"integer"},"numCols":{"type":"integer"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.DatasetColumnInfo"}}},"required":["id","createdAt","updatedAt","datasetId","contentMd5Hash","fileSizeBytes","numRows","numCols","columns"]},"lmai.proto.model_fine_tuning.v1.DatasetColumnInfo":{"title":"DatasetColumnInfo","type":"object","properties":{"id":{"type":"string","description":"The ID of the dataset file."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"index":{"type":"integer","description":"Index of the column within the dataset file."},"literalName":{"type":"string","description":"The literal name for the column."},"dtype":{"type":"string"}},"required":["id","createdAt","updatedAt","index","literalName"]},"lmai.proto.model_fine_tuning.v1.DatasetView":{"title":"DatasetView","type":"object","properties":{"numRows":{"type":"integer"},"numCols":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.DataRow"}},"columns":{"type":"array","items":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.DatasetColumnInfo"}}},"required":["numRows","numCols","data","columns"]},"lmai.proto.model_fine_tuning.v1.DataRow":{"title":"DataRow","type":"object","properties":{"id":{"type":"string"},"rowValues":{"type":"array","items":{"description":"Ordered row values with length always equal to `num_rows` on the\n corresponding view.","type":"object","additionalProperties":true}}},"required":["id","rowValues"]},"lmai.proto.model_fine_tuning.v1.DatasetLabelState":{"title":"DatasetLabelState","type":"object","properties":{"labelingStatus":{"type":"string","description":"The status of the latest general pseudo-labeling job for the dataset"},"promptTemplate":{"type":"string","description":"aka user general instructions"},"error":{"type":"string","description":"if the labeling status is error, this field may contain an error message"}},"required":["labelingStatus","promptTemplate"]},"lmai.proto.model_fine_tuning.v1.PromptTemplate":{"title":"PromptTemplate","type":"object","properties":{"id":{"type":"string"},"template":{"type":"string","description":"The template string that defines the prompt"}},"required":["id","template"]},"lmai.proto.model_fine_tuning.v1.FineTuneJob":{"title":"FineTuneJob","type":"object","properties":{"id":{"type":"string","description":"The ID of the fine tune job."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string","description":"Name corresponding to the fine tuned model derived from this job"},"description":{"type":"string"},"status":{"type":"string"},"config":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.FineTuneJobConfig"},"result":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.FineTuneJobResult"}},"required":["id","createdAt","updatedAt","status","config","result"]},"lmai.proto.model_fine_tuning.v1.FineTuneJobConfig":{"title":"FineTuneJobConfig","type":"object","properties":{"name":{"type":"string","description":"Optional name for the job."},"description":{"type":"string","description":"Optional description for the job."},"baselineModelId":{"type":"string","description":"The ID for the model used as the starting point for training."},"trainDatasetId":{"type":"string","description":"The dataset to use for training, with splits baked in or to be\n derived dynamically"},"testDatasetId":{"type":"string","description":"The dataset to use for an unbiased evaluation of the model"},"selectedColumns":{"type":"array","items":{"type":"string","description":"Set of columns to be used in fine-tuning.\n Supported columns: input, output, ground_truth\n For example, a task similar to summarization might need output and\n ground_truth."}}},"required":["baselineModelId","trainDatasetId","testDatasetId","selectedColumns"]},"lmai.proto.model_fine_tuning.v1.FineTuneJobResult":{"title":"FineTuneJobResult","type":"object","properties":{"progress":{"type":"array","items":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.TrainingProgress","description":"Sequential snapshots of training metrics."}},"trainedModelFile":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.ModelFile","description":"The trained model, if it was created successfully."},"resultUrl":{"type":"string","description":"Url to view the full results and progress (e.g. external W&B url)"}},"required":["progress"],"description":"Result of a Fine-Tuning Job."},"lmai.proto.model_fine_tuning.v1.Project":{"title":"Project","type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deletedAt":{"type":"string","format":"date-time"},"creatorId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"organizationId":{"type":"string"},"organizationName":{"type":"string"}},"required":["id","createdAt","updatedAt","name"]},"lmai.proto.webserver.v2.CreateDatasetRequest":{"title":"CreateDatasetRequest","type":"object","properties":{"name":{"type":"string","description":"Human-readable name for the dataset, if one exists."},"description":{"type":"string","description":"Human-readable description of the dataset, if one exists."},"isFewShotExamples":{"type":"boolean","description":"PseudoLabel job fields."},"isActiveLabels":{"type":"boolean"},"projectId":{"type":"string","description":"The project to add the new dataset to"}},"description":"Create a Dataset, initially an empty shell until a file is uploaded"},"lmai.proto.webserver.v2.CreateDatasetResponse":{"title":"CreateDatasetResponse","type":"object","properties":{"dataset":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.Dataset"}},"required":["dataset"]},"lmai.proto.webserver.v2.UploadDatasetFileRequest":{"title":"UploadDatasetFileRequest","type":"object","properties":{"datasetId":{"type":"string","description":"The ID of the dataset corresponding to the file."}},"required":["datasetId"],"description":"Initiate an upload by requesting a pre-signed S3 upload URL."},"lmai.proto.webserver.v2.UploadDatasetFileResponse":{"title":"UploadDatasetFileResponse","type":"object","properties":{"s3PresignedPost":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.S3PresignedPost"}},"required":["s3PresignedPost"]},"lmai.proto.webserver.v2.S3PresignedPost":{"title":"S3PresignedPost","type":"object","properties":{"url":{"type":"string"},"fields":{"type":"object","additionalProperties":{"type":"string"},"description":"Fields required for the S3 presigned POST request generated by s3 sdk."}},"required":["url","fields"]},"lmai.proto.webserver.v2.S3PresignedPost.FieldsEntry":{"title":"FieldsEntry","type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"]},"lmai.proto.webserver.v2.FinalizeSingleDatasetFileUploadRequest":{"title":"FinalizeSingleDatasetFileUploadRequest","type":"object","properties":{"datasetId":{"type":"string","description":"The ID of the dataset corresponding to the file"},"s3PresignedPost":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.S3PresignedPost","description":"The pre-signed S3 URL where the file was uploadeded"}},"required":["datasetId","s3PresignedPost"],"description":"Request to finalize a single dataset file upload"},"lmai.proto.webserver.v2.FinalizeSingleDatasetFileUploadResponse":{"title":"FinalizeSingleDatasetFileUploadResponse","type":"object","properties":{"datasetFile":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.DatasetFileInfo","description":"Information about the dataset file if the upload was successful"}},"description":"Response after finalizing a single dataset file upload"},"lmai.proto.webserver.v2.GetDatasetRequest":{"title":"GetDatasetRequest","type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"lmai.proto.webserver.v2.GetDatasetResponse":{"title":"GetDatasetResponse","type":"object","properties":{"dataset":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.Dataset"}},"required":["dataset"]},"lmai.proto.webserver.v2.GetDatasetViewRequest":{"title":"GetDatasetViewRequest","type":"object","properties":{"datasetId":{"type":"string","description":"The ID of the dataset from which to retrieve content. When specified,\n gets data from the current file in the dataset."},"datasetFileId":{"type":"string","description":"The ID of the (pinned) dataset file from which to retrieve content.\n Requests iterating over pages of results are recommended to use this\n pinned identifier after the first page in order to prevent any effects\n from a dataset changing between the queries."},"after":{"type":"integer","description":"Pagination: The index, by row-order, after which to query results."},"limit":{"type":"integer","description":"Pagination: The maximum number of results to return on this page."}},"required":["datasetId","datasetFileId"],"description":"Get a view of the data within a dataset."},"lmai.proto.webserver.v2.GetDatasetViewResponse":{"title":"GetDatasetViewResponse","type":"object","properties":{"datasetId":{"type":"string"},"datasetFileId":{"type":"string"},"datasetView":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.DatasetView"}},"required":["datasetId","datasetFileId","datasetView"]},"lmai.proto.webserver.v2.ListDatasetsRequestFilters":{"title":"ListDatasetsRequestFilters","type":"object","properties":{"query":{"type":"string","description":"search query substring match for name and description"},"projectId":{"type":"string","description":"filter datasets associated with the project"}},"description":"Filter listed datasets by ALL filters specified"},"lmai.proto.webserver.v2.ListDatasetsRequest":{"title":"ListDatasetsRequest","type":"object","properties":{"filters":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListDatasetsRequestFilters"}}},"lmai.proto.webserver.v2.ListDatasetsResponse":{"title":"ListDatasetsResponse","type":"object","properties":{"datasets":{"type":"array","items":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.Dataset"}},"totalCount":{"type":"integer","description":"Total count of datasets which can be listed with applicable\n filters, regardless of page size"}},"required":["datasets","totalCount"]},"lmai.proto.webserver.v2.GetDatasetDownloadURLRequest":{"title":"GetDatasetDownloadURLRequest","type":"object","properties":{"datasetId":{"type":"string"}},"required":["datasetId"]},"lmai.proto.webserver.v2.GetDatasetDownloadURLResponse":{"title":"GetDatasetDownloadURLResponse","type":"object","properties":{"downloadUrl":{"type":"string","description":"The S3 presigned URL to download the dataset file."}},"required":["downloadUrl"]},"lmai.proto.webserver.v2.CloneDatasetRequest":{"title":"CloneDatasetRequest","type":"object","properties":{"datasetId":{"type":"string","description":"Dataset to clone"},"name":{"type":"string","description":"New dataset name. If not provided, will use the name of the dataset being\n cloned"},"description":{"type":"string","description":"Human-readable description of the dataset.\n If not provided, will use the name of the dataset being cloned"},"projectId":{"type":"string","description":"The project to add the new dataset to"}},"required":["datasetId"]},"lmai.proto.webserver.v2.CloneDatasetResponse":{"title":"CloneDatasetResponse","type":"object","properties":{"dataset":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.Dataset"}},"required":["dataset"]},"lmai.proto.webserver.v2.Metric":{"title":"Metric","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"deploymentStatus":{"type":"string"}}},"lmai.proto.webserver.v2.EvaluateRequest":{"title":"EvaluateRequest","type":"object","properties":{"metric":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.Metric"},"input":{"type":"array","items":{"type":"string"}},"output":{"type":"array","items":{"type":"string"}},"groundTruth":{"type":"array","items":{"type":"string"}}},"required":["metric","input","output","groundTruth"]},"lmai.proto.webserver.v2.EvaluateResponse":{"title":"EvaluateResponse","type":"object","properties":{"metric":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.Metric"},"scores":{"type":"array","items":{"type":"number"}}},"required":["metric","scores"],"description":"The index of the float value corresponds to that of\n the string combination sent in the request.\n Ex: scores.values[i] is taken from\n input[i], ground_truth[i], context[i], output[i] in EvaluateRequest"},"lmai.proto.webserver.v2.EvaluateDatasetRequest":{"title":"EvaluateDatasetRequest","type":"object","properties":{"metric":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.Metric"},"datasetId":{"type":"string"}},"required":["metric","datasetId"]},"lmai.proto.webserver.v2.EvaluateDatasetResponse":{"title":"EvaluateDatasetResponse","type":"object","properties":{"metric":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.Metric"},"scores":{"type":"array","items":{"type":"number"}}},"required":["metric","scores"],"description":"models and scores correspond in the same manner as in EvaluateResponse"},"lmai.proto.webserver.v2.ListMetricsRequest":{"title":"ListMetricsRequest","type":"object","properties":{},"additionalProperties":false,"x-stainless-empty-object":true},"lmai.proto.webserver.v2.ListMetricsResponse":{"title":"ListMetricsResponse","type":"object","properties":{"metrics":{"type":"array","items":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.Metric"}}},"required":["metrics"]},"lmai.proto.webserver.v2.GetMetricRequest":{"title":"GetMetricRequest","type":"object","properties":{"metric":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.Metric"}},"required":["metric"],"description":"Requested metric must have at least id or name set."},"lmai.proto.webserver.v2.GetMetricResponse":{"title":"GetMetricResponse","type":"object","properties":{"metric":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.Metric"}},"required":["metric"],"description":"Returns a full metric object with all fields set."},"lmai.proto.webserver.v2.CreateFineTuneJobRequest":{"title":"CreateFineTuneJobRequest","type":"object","properties":{"fineTuneJobConfig":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.FineTuneJobConfig","description":"Partial configuration with parameters for the fine-tune job."}},"required":["fineTuneJobConfig"],"description":"Create a new Fine Tune Job\n Initialized with the provided configuration parameters."},"lmai.proto.webserver.v2.CreateFineTuneJobResponse":{"title":"CreateFineTuneJobResponse","type":"object","properties":{"jobId":{"type":"string"}},"required":["jobId"]},"lmai.proto.webserver.v2.SubmitFineTuneJobRequest":{"title":"SubmitFineTuneJobRequest","type":"object","properties":{"jobId":{"type":"string"},"fineTuneJobConfig":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.FineTuneJobConfig","description":"The fine-tune job configuration."}},"required":["jobId","fineTuneJobConfig"]},"lmai.proto.webserver.v2.SubmitFineTuneJobResponse":{"title":"SubmitFineTuneJobResponse","type":"object","properties":{"jobId":{"type":"string"}},"required":["jobId"]},"lmai.proto.webserver.v2.GetFineTuneJobRequest":{"title":"GetFineTuneJobRequest","type":"object","properties":{"jobId":{"type":"string"}},"required":["jobId"]},"lmai.proto.webserver.v2.GetFineTuneJobResponse":{"title":"GetFineTuneJobResponse","type":"object","properties":{"job":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.FineTuneJob"}},"required":["job"]},"lmai.proto.webserver.v2.GetFineTuneJobStatusRequest":{"title":"GetFineTuneJobStatusRequest","type":"object","properties":{"jobId":{"type":"string"}},"required":["jobId"]},"lmai.proto.webserver.v2.GetFineTuneJobStatusResponse":{"title":"GetFineTuneJobStatusResponse","type":"object","properties":{"status":{"type":"string"},"fineTuneJobResult":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.FineTuneJobResult"}},"required":["status","fineTuneJobResult"]},"lmai.proto.webserver.v2.ListFineTuneJobsRequestFilters":{"title":"ListFineTuneJobsRequestFilters","type":"object","properties":{"query":{"type":"string","description":"search query substring match for name and description"},"status":{"type":"string"}}},"lmai.proto.webserver.v2.ListFineTuneJobsRequest":{"title":"ListFineTuneJobsRequest","type":"object","properties":{"filters":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListFineTuneJobsRequestFilters"}}},"lmai.proto.webserver.v2.ListFineTuneJobsResponse":{"title":"ListFineTuneJobsResponse","type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.FineTuneJob"}},"totalCount":{"type":"integer","description":"Total count of fine tune jobs which can be listed with applicable\n filters, regardless of page size"}},"required":["jobs","totalCount"]},"lmai.proto.webserver.v2.ListBaseModelsRequest":{"title":"ListBaseModelsRequest","type":"object","properties":{},"additionalProperties":false,"x-stainless-empty-object":true},"lmai.proto.webserver.v2.ListBaseModelsResponse":{"title":"ListBaseModelsResponse","type":"object","properties":{"models":{"type":"array","items":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.Model"}}},"required":["models"]},"lmai.proto.webserver.v2.CreateProjectRequest":{"title":"CreateProjectRequest","type":"object","properties":{"name":{"type":"string","description":"Human-readable name for the project, if one exists."},"description":{"type":"string","description":"Human-readable description of the project, if one exists."},"organizationId":{"type":"string","description":"Organization to associate the project with, if applicable"}},"description":"Create a Project"},"lmai.proto.webserver.v2.CreateProjectResponse":{"title":"CreateProjectResponse","type":"object","properties":{"project":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.Project"}},"required":["project"]},"lmai.proto.webserver.v2.GetProjectRequest":{"title":"GetProjectRequest","type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"lmai.proto.webserver.v2.GetProjectResponse":{"title":"GetProjectResponse","type":"object","properties":{"project":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.Project"}},"required":["project"]},"lmai.proto.webserver.v2.ListProjectsRequestFilters":{"title":"ListProjectsRequestFilters","type":"object","properties":{"query":{"type":"string","description":"search query substring match for name and description"},"organizationId":{"type":"string","description":"search only projects associated with specific organization"}}},"lmai.proto.webserver.v2.ListProjectsRequest":{"title":"ListProjectsRequest","type":"object","properties":{"filters":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.ListProjectsRequestFilters"}}},"lmai.proto.webserver.v2.ListProjectsResponse":{"title":"ListProjectsResponse","type":"object","properties":{"projects":{"type":"array","items":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.Project"}},"totalCount":{"type":"integer","description":"Total count of projects which can be listed with applicable\n filters, regardless of page size"}},"required":["projects","totalCount"]},"lmai.proto.webserver.v2.PseudoLabelJobConfig":{"title":"PseudoLabelJobConfig","type":"object","properties":{"name":{"type":"string","description":"Optional name for the job."},"description":{"type":"string","description":"Optional description for the job."},"datasetId":{"type":"string","description":"ID of the main dataset to be pseudo-labeled"},"fewShotDatasetId":{"type":"string","description":"ID of the dataset containing few-shot examples. Optional."},"activeLabeledDatasetId":{"type":"string","description":"ID of the actively labeled dataset. Optional. If null, this job is for\n active learning."},"selectedColumns":{"type":"array","items":{"type":"string","description":"Subset of columns to be used in pseudo-labeling.\n Expected columns: input, output, ground_truth\n For example, a summarization task might not need an input column.\n By default, all columns are used."}},"promptTemplate":{"$ref":"#/components/schemas/lmai.proto.model_fine_tuning.v1.PromptTemplate"},"baseEvaluationMetric":{"type":"string","description":"Reserved field. Do not use at the moment."},"skipActiveLabeling":{"type":"boolean","description":"If true, skip active labeling, which involves an intermediate Dataset\n created for human labeling."}},"required":["datasetId","selectedColumns","promptTemplate","baseEvaluationMetric","skipActiveLabeling"],"description":"Configuration for LLM Judge labeling job."},"lmai.proto.webserver.v2.CreatePseudoLabelJobRequest":{"title":"CreatePseudoLabelJobRequest","type":"object","properties":{"pseudoLabelJobConfig":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.PseudoLabelJobConfig","description":"Partial configuration containing updates via its non-null fields."}},"required":["pseudoLabelJobConfig"]},"lmai.proto.webserver.v2.CreatePseudoLabelJobResponse":{"title":"CreatePseudoLabelJobResponse","type":"object","properties":{"jobId":{"type":"string"}},"required":["jobId"]},"lmai.proto.webserver.v2.SubmitPseudoLabelJobRequest":{"title":"SubmitPseudoLabelJobRequest","type":"object","properties":{"jobId":{"type":"string"},"pseudoLabelJobConfig":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.PseudoLabelJobConfig","description":"The pseudo-labeling job configuration."}},"required":["jobId","pseudoLabelJobConfig"]},"lmai.proto.webserver.v2.SubmitPseudoLabelJobResponse":{"title":"SubmitPseudoLabelJobResponse","type":"object","properties":{"jobId":{"type":"string"}},"required":["jobId"]},"lmai.proto.webserver.v2.GetPseudoLabelJobStatusRequest":{"title":"GetPseudoLabelJobStatusRequest","type":"object","properties":{"jobId":{"type":"string"}},"required":["jobId"]},"lmai.proto.webserver.v2.GetPseudoLabelJobStatusResponse":{"title":"GetPseudoLabelJobStatusResponse","type":"object","properties":{"status":{"type":"string"},"pseudoLabelJobResult":{"$ref":"#/components/schemas/lmai.proto.webserver.v2.PseudoLabelJobConfig"}},"required":["status","pseudoLabelJobResult"]},"google.protobuf.Value":{"description":"Ordered row values with length always equal to `num_rows` on the\n corresponding view.","type":"object","additionalProperties":true}},"examples":{}}} \ No newline at end of file