unity_catalog_prompt_service.proto
1 syntax = "proto2"; 2 3 package mlflow.unitycatalog; 4 5 import "databricks.proto"; 6 import "google/protobuf/empty.proto"; 7 import "scalapb/scalapb.proto"; 8 import "unity_catalog_prompt_messages.proto"; 9 10 option java_generate_equals_and_hash = true; 11 option java_package = "com.databricks.api.proto.managedcatalog"; 12 option py_generic_services = true; 13 option (scalapb.options) = {flat_package: true}; 14 15 service UnityCatalogPromptService { 16 rpc CreatePrompt(CreatePromptRequest) returns (Prompt) { 17 option (rpc) = { 18 endpoints: [ 19 { 20 method: "POST" 21 path: "/mlflow/unity-catalog/prompts" 22 since: { 23 major: 2 24 minor: 0 25 } 26 } 27 ] 28 visibility: PUBLIC_UNDOCUMENTED 29 rpc_doc_title: "(Unity Catalog) Create Prompt" 30 }; 31 } 32 33 rpc UpdatePrompt(UpdatePromptRequest) returns (Prompt) { 34 option (rpc) = { 35 endpoints: [ 36 { 37 method: "PATCH" 38 path: "/mlflow/unity-catalog/prompts/{name}" 39 since: { 40 major: 2 41 minor: 0 42 } 43 } 44 ] 45 visibility: PUBLIC_UNDOCUMENTED 46 rpc_doc_title: "(Unity Catalog) Update Prompt" 47 }; 48 } 49 50 rpc DeletePrompt(DeletePromptRequest) returns (google.protobuf.Empty) { 51 option (rpc) = { 52 endpoints: [ 53 { 54 method: "DELETE" 55 path: "/mlflow/unity-catalog/prompts/{name}" 56 since: { 57 major: 2 58 minor: 0 59 } 60 } 61 ] 62 visibility: PUBLIC_UNDOCUMENTED 63 rpc_doc_title: "(Unity Catalog) Delete Prompt" 64 }; 65 } 66 67 rpc GetPrompt(GetPromptRequest) returns (Prompt) { 68 option (rpc) = { 69 endpoints: [ 70 { 71 method: "GET" 72 path: "/mlflow/unity-catalog/prompts/{name}" 73 since: { 74 major: 2 75 minor: 0 76 } 77 } 78 ] 79 visibility: PUBLIC_UNDOCUMENTED 80 rpc_doc_title: "(Unity Catalog) Get Prompt" 81 }; 82 } 83 84 rpc SearchPrompts(SearchPromptsRequest) returns (SearchPromptsResponse) { 85 option (rpc) = { 86 endpoints: [ 87 { 88 method: "POST" 89 path: "/mlflow/unity-catalog/prompts/search" 90 since: { 91 major: 2 92 minor: 0 93 } 94 } 95 ] 96 visibility: PUBLIC_UNDOCUMENTED 97 rpc_doc_title: "(Unity Catalog) Search Prompts" 98 }; 99 } 100 101 rpc CreatePromptVersion(CreatePromptVersionRequest) returns (PromptVersion) { 102 option (rpc) = { 103 endpoints: [ 104 { 105 method: "POST" 106 path: "/mlflow/unity-catalog/prompts/{name}/versions" 107 since: { 108 major: 2 109 minor: 0 110 } 111 } 112 ] 113 visibility: PUBLIC_UNDOCUMENTED 114 rpc_doc_title: "(Unity Catalog) Create Prompt Version" 115 }; 116 } 117 118 rpc UpdatePromptVersion(UpdatePromptVersionRequest) returns (PromptVersion) { 119 option (rpc) = { 120 endpoints: [ 121 { 122 method: "PATCH" 123 path: "/mlflow/unity-catalog/prompts/{name}/versions/{version}" 124 since: { 125 major: 2 126 minor: 0 127 } 128 } 129 ] 130 visibility: PUBLIC_UNDOCUMENTED 131 rpc_doc_title: "(Unity Catalog) Update Prompt Version" 132 }; 133 } 134 135 rpc DeletePromptVersion(DeletePromptVersionRequest) returns (google.protobuf.Empty) { 136 option (rpc) = { 137 endpoints: [ 138 { 139 method: "DELETE" 140 path: "/mlflow/unity-catalog/prompts/{name}/versions/{version}" 141 since: { 142 major: 2 143 minor: 0 144 } 145 } 146 ] 147 visibility: PUBLIC_UNDOCUMENTED 148 rpc_doc_title: "(Unity Catalog) Delete Prompt Version" 149 }; 150 } 151 152 rpc GetPromptVersion(GetPromptVersionRequest) returns (PromptVersion) { 153 option (rpc) = { 154 endpoints: [ 155 { 156 method: "GET" 157 path: "/mlflow/unity-catalog/prompts/{name}/versions/{version}" 158 since: { 159 major: 2 160 minor: 0 161 } 162 } 163 ] 164 visibility: PUBLIC_UNDOCUMENTED 165 rpc_doc_title: "(Unity Catalog) Get Prompt Version" 166 }; 167 } 168 169 rpc SearchPromptVersions(SearchPromptVersionsRequest) returns (SearchPromptVersionsResponse) { 170 option (rpc) = { 171 endpoints: [ 172 { 173 method: "POST" 174 path: "/mlflow/unity-catalog/prompts/{name}/versions/search" 175 since: { 176 major: 2 177 minor: 0 178 } 179 } 180 ] 181 error_codes: [ 182 INVALID_PARAMETER_VALUE, 183 PERMISSION_DENIED, 184 RESOURCE_DOES_NOT_EXIST, 185 INTERNAL_ERROR 186 ] 187 visibility: PUBLIC_UNDOCUMENTED 188 rpc_doc_title: "(Unity Catalog) Search Prompt Versions" 189 }; 190 } 191 192 rpc SetPromptAlias(SetPromptAliasRequest) returns (google.protobuf.Empty) { 193 option (rpc) = { 194 endpoints: [ 195 { 196 method: "POST" 197 path: "/mlflow/unity-catalog/prompts/{name}/aliases/{alias}" 198 since: { 199 major: 2 200 minor: 0 201 } 202 } 203 ] 204 visibility: PUBLIC_UNDOCUMENTED 205 rpc_doc_title: "(Unity Catalog) Set Prompt Alias" 206 }; 207 } 208 209 rpc DeletePromptAlias(DeletePromptAliasRequest) returns (google.protobuf.Empty) { 210 option (rpc) = { 211 endpoints: [ 212 { 213 method: "DELETE" 214 path: "/mlflow/unity-catalog/prompts/{name}/aliases/{alias}" 215 since: { 216 major: 2 217 minor: 0 218 } 219 } 220 ] 221 visibility: PUBLIC_UNDOCUMENTED 222 rpc_doc_title: "(Unity Catalog) Delete Prompt Alias" 223 }; 224 } 225 226 rpc GetPromptVersionByAlias(GetPromptVersionByAliasRequest) returns (PromptVersion) { 227 option (rpc) = { 228 endpoints: [ 229 { 230 method: "GET" 231 path: "/mlflow/unity-catalog/prompts/{name}/versions/by-alias/{alias}" 232 since: { 233 major: 2 234 minor: 0 235 } 236 } 237 ] 238 visibility: PUBLIC_UNDOCUMENTED 239 rpc_doc_title: "(Unity Catalog) Get Prompt Version By Alias" 240 }; 241 } 242 243 rpc SetPromptTag(SetPromptTagRequest) returns (google.protobuf.Empty) { 244 option (rpc) = { 245 endpoints: [ 246 { 247 method: "POST" 248 path: "/mlflow/unity-catalog/prompts/{name}/tags" 249 since: { 250 major: 2 251 minor: 0 252 } 253 } 254 ] 255 visibility: PUBLIC_UNDOCUMENTED 256 rpc_doc_title: "(Unity Catalog) Set Prompt Tag" 257 }; 258 } 259 260 rpc DeletePromptTag(DeletePromptTagRequest) returns (google.protobuf.Empty) { 261 option (rpc) = { 262 endpoints: [ 263 { 264 method: "DELETE" 265 path: "/mlflow/unity-catalog/prompts/{name}/tags/{key}" 266 since: { 267 major: 2 268 minor: 0 269 } 270 } 271 ] 272 visibility: PUBLIC_UNDOCUMENTED 273 rpc_doc_title: "(Unity Catalog) Delete Prompt Tag" 274 }; 275 } 276 277 rpc SetPromptVersionTag(SetPromptVersionTagRequest) returns (google.protobuf.Empty) { 278 option (rpc) = { 279 endpoints: [ 280 { 281 method: "POST" 282 path: "/mlflow/unity-catalog/prompts/{name}/versions/{version}/tags" 283 since: { 284 major: 2 285 minor: 0 286 } 287 } 288 ] 289 visibility: PUBLIC_UNDOCUMENTED 290 rpc_doc_title: "(Unity Catalog) Set Prompt Version Tag" 291 }; 292 } 293 294 rpc DeletePromptVersionTag(DeletePromptVersionTagRequest) returns (google.protobuf.Empty) { 295 option (rpc) = { 296 endpoints: [ 297 { 298 method: "DELETE" 299 path: "/mlflow/unity-catalog/prompts/{name}/versions/{version}/tags/{key}" 300 since: { 301 major: 2 302 minor: 0 303 } 304 } 305 ] 306 visibility: PUBLIC_UNDOCUMENTED 307 rpc_doc_title: "(Unity Catalog) Delete Prompt Version Tag" 308 }; 309 } 310 311 rpc LinkPromptVersionsToModels(LinkPromptVersionsToModelsRequest) returns (google.protobuf.Empty) { 312 option (rpc) = { 313 endpoints: [ 314 { 315 method: "POST" 316 path: "/mlflow/unity-catalog/prompt-versions/links-to-models" 317 since: { 318 major: 2 319 minor: 0 320 } 321 } 322 ] 323 visibility: PUBLIC_UNDOCUMENTED 324 rpc_doc_title: "(Unity Catalog) Link Prompt Versions to Models" 325 }; 326 } 327 328 rpc LinkPromptsToTraces(LinkPromptsToTracesRequest) returns (google.protobuf.Empty) { 329 option (rpc) = { 330 endpoints: [ 331 { 332 method: "POST" 333 path: "/mlflow/unity-catalog/prompt-versions/links-to-traces" 334 since: { 335 major: 2 336 minor: 0 337 } 338 } 339 ] 340 visibility: PUBLIC_UNDOCUMENTED 341 rpc_doc_title: "(Unity Catalog) Link Prompts to Traces" 342 }; 343 } 344 345 rpc LinkPromptVersionsToRuns(LinkPromptVersionsToRunsRequest) returns (google.protobuf.Empty) { 346 option (rpc) = { 347 endpoints: [ 348 { 349 method: "POST" 350 path: "/mlflow/unity-catalog/prompt-versions/links-to-runs" 351 since: { 352 major: 2 353 minor: 0 354 } 355 } 356 ] 357 visibility: PUBLIC_UNDOCUMENTED 358 rpc_doc_title: "(Unity Catalog) Link Prompt Versions to Runs" 359 }; 360 } 361 }